-
Notifications
You must be signed in to change notification settings - Fork 3k
/
extra-data.h
1625 lines (1364 loc) · 44.9 KB
/
extra-data.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
+----------------------------------------------------------------------+
| HipHop for PHP |
+----------------------------------------------------------------------+
| Copyright (c) 2010-present Facebook, Inc. (http://www.facebook.com) |
+----------------------------------------------------------------------+
| This source file is subject to version 3.01 of the PHP license, |
| that is bundled with this package in the file LICENSE, and is |
| available through the world-wide-web at the following url: |
| http://www.php.net/license/3_01.txt |
| If you did not receive a copy of the PHP license and are unable to |
| obtain it through the world-wide-web, please send a note to |
| license@php.net so we can mail you a copy immediately. |
+----------------------------------------------------------------------+
*/
#ifndef incl_HPHP_VM_EXTRADATA_H_
#define incl_HPHP_VM_EXTRADATA_H_
#include "hphp/runtime/base/collections.h"
#include "hphp/runtime/base/typed-value.h"
#include "hphp/runtime/vm/bytecode.h"
#include "hphp/runtime/vm/srckey.h"
#include "hphp/runtime/vm/jit/types.h"
#include "hphp/runtime/vm/jit/ir-opcode.h"
#include "hphp/runtime/vm/jit/stack-offsets.h"
#include "hphp/runtime/ext/generator/ext_generator.h"
#include "hphp/util/arena.h"
#include "hphp/util/ringbuffer.h"
#include "hphp/util/safe-cast.h"
#include <folly/Conv.h>
#include <folly/Optional.h>
#include <algorithm>
#include <string>
namespace HPHP { namespace jit {
//////////////////////////////////////////////////////////////////////
/*
* Some IRInstructions with compile-time-only constants may carry along extra
* data in the form of one of these structures.
*
* Note that this isn't really appropriate for compile-time constants that are
* actually representing user values (we want them to be visible to
* optimization passes, allocatable to registers, etc), just compile-time
* metadata.
*
* These types must:
*
* - Derive from IRExtraData (for overloading purposes).
* - Be arena-allocatable (no non-trivial destructors).
* - Either CopyConstructible, or implement a clone member function that
* takes an arena to clone to.
*
* In addition, extra data belonging to IRInstructions that may be hashed in
* IRInstrTables must:
*
* - Implement an equals() member that indicates equality.
* - Implement a hash() method.
*
* Finally, optionally they may implement a show() method for use in debug
* printouts.
*/
/*
* Traits that returns the type of the extra C++ data structure for a
* given instruction, if it has one, along with some other information
* about the type.
*/
template<Opcode op> struct OpHasExtraData { enum { value = 0 }; };
template<Opcode op> struct IRExtraDataType;
//////////////////////////////////////////////////////////////////////
struct IRExtraData {};
//////////////////////////////////////////////////////////////////////
/*
* Shared IRExtraData classes.
*
* These subtypes represent common parameters (e.g., statically known Func,
* local variable ID, stack offset, etc.) that are useful for a variety of HHIR
* instructions.
*
* These are kept separate from the one-off IRExtraDatas to make it easier to
* find existing common parameters.
*/
/*
* Offset in bytes from a base pointer---e.g., to a object property from an
* ObjectData*.
*/
struct ByteOffsetData : IRExtraData {
explicit ByteOffsetData(ptrdiff_t offset) : offsetBytes(offset) {}
std::string show() const { return folly::to<std::string>(offsetBytes); }
bool equals(ByteOffsetData o) const { return offsetBytes == o.offsetBytes; }
size_t hash() const { return std::hash<ptrdiff_t>()(offsetBytes); }
ptrdiff_t offsetBytes;
};
/*
* Class pointer.
*
* Required to be non-null.
*/
struct ClassData : IRExtraData {
explicit ClassData(const Class* cls)
: cls(cls)
{
assert(cls != nullptr);
}
std::string show() const {
return folly::to<std::string>(cls->name()->data());
}
bool equals(const ClassData& o) const {
return cls == o.cls;
}
size_t hash() const {
return hash_int64(reinterpret_cast<intptr_t>(cls));
}
const Class* cls;
};
/*
* ExtendsClass.
*/
struct ExtendsClassData : IRExtraData {
explicit ExtendsClassData(const Class* cls, bool strictLikely = false)
: cls(cls), strictLikely(strictLikely)
{
assert(cls != nullptr);
}
std::string show() const {
return folly::sformat("{}{}",
cls->name(), strictLikely ? ":strictLikely" : "");
}
bool equals(const ExtendsClassData& o) const {
return cls == o.cls && strictLikely == o.strictLikely;
}
size_t hash() const {
return pointer_hash<Class>()(cls);
}
const Class* cls;
bool strictLikely;
};
/*
* Class with method name.
*/
struct ClsMethodData : IRExtraData {
ClsMethodData(const StringData* cls, const StringData* method,
const NamedEntity* ne = nullptr)
: clsName(cls)
, methodName(method)
, namedEntity(ne)
{}
std::string show() const {
return folly::format("{}::{}", clsName, methodName).str();
}
bool equals(const ClsMethodData& o) const {
// The strings are static so we can use pointer equality.
return clsName == o.clsName && methodName == o.methodName;
}
size_t hash() const {
return hash_int64_pair((intptr_t)clsName, (intptr_t)methodName);
}
const StringData* clsName;
const StringData* methodName;
const NamedEntity* namedEntity;
};
struct IfaceMethodData : IRExtraData {
IfaceMethodData(Slot vtableIdx, Slot methodIdx)
: vtableIdx(vtableIdx)
, methodIdx(methodIdx)
{}
std::string show() const {
return folly::sformat("{}, {}", vtableIdx, methodIdx);
}
bool equals(const IfaceMethodData& o) const {
return vtableIdx == o.vtableIdx && methodIdx == o.methodIdx;
}
size_t hash() const {
return hash_int64((int64_t)vtableIdx << 32 | methodIdx);
}
Slot vtableIdx;
Slot methodIdx;
};
/*
* Func with argument index.
*/
struct FuncArgData : IRExtraData {
explicit FuncArgData(const Func* f, int64_t arg)
: func(f)
, argNum(arg)
{}
std::string show() const {
return folly::format("{},{}", func->name(), argNum).str();
}
const Func* func;
int64_t argNum;
};
/*
* Local variable ID.
*/
struct LocalId : IRExtraData {
explicit LocalId(uint32_t id) : locId(id) {}
std::string show() const { return folly::to<std::string>(locId); }
bool equals(LocalId o) const { return locId == o.locId; }
size_t hash() const { return std::hash<uint32_t>()(locId); }
uint32_t locId;
};
struct ClsRefSlotData : IRExtraData {
explicit ClsRefSlotData(uint32_t slot) : slot{slot} {}
std::string show() const { return folly::to<std::string>(slot); }
bool equals(ClsRefSlotData o) const { return slot == o.slot; }
size_t hash() const { return std::hash<uint32_t>()(slot); }
uint32_t slot;
};
/*
* Index into, e.g., an array.
*/
struct IndexData : IRExtraData {
explicit IndexData(uint32_t index) : index(index) {}
std::string show() const { return folly::format("{}", index).str(); }
uint32_t index;
};
/*
* Iterator ID.
*/
struct IterId : IRExtraData {
explicit IterId(uint32_t id)
: iterId(id)
{}
std::string show() const { return folly::to<std::string>(iterId); }
bool equals(IterId o) const { return iterId == o.iterId; }
size_t hash() const { return std::hash<uint32_t>()(iterId); }
uint32_t iterId;
};
/*
* Iter instruction data.
*
* `iterId' is the iterator ID; `keyId' and `valId' are the IDs of the iterator
* locals $key => $value. For keyless iterators, we still use this class, with
* `keyId` set to -1u.
*/
struct IterData : IRExtraData {
explicit IterData(uint32_t iter, uint32_t key, uint32_t val)
: iterId(iter)
, keyId(key)
, valId(val)
{}
std::string show() const {
if (keyId == -1) return folly::format("{}::{}", iterId, valId).str();
return folly::format("{}::{}::{}", iterId, keyId, valId).str();
}
uint32_t iterId;
uint32_t keyId;
uint32_t valId;
};
/*
* RDS handle.
*/
struct RDSHandleData : IRExtraData {
explicit RDSHandleData(rds::Handle handle) : handle(handle) {}
std::string show() const { return folly::to<std::string>(handle); }
bool equals(RDSHandleData o) const { return handle == o.handle; }
size_t hash() const { return std::hash<uint32_t>()(handle); }
rds::Handle handle;
};
/*
* Translation ID.
*
* Used with profiling-related instructions.
*/
struct TransIDData : IRExtraData {
explicit TransIDData(TransID transId) : transId(transId) {}
std::string show() const { return folly::to<std::string>(transId); }
TransID transId;
};
/*
* FP-relative offset.
*/
struct FPRelOffsetData : IRExtraData {
explicit FPRelOffsetData(FPRelOffset offset) : offset(offset) {}
std::string show() const {
return folly::to<std::string>("FPRelOff ", offset.offset);
}
bool equals(FPRelOffsetData o) const { return offset == o.offset; }
size_t hash() const { return std::hash<int32_t>()(offset.offset); }
FPRelOffset offset;
};
/*
* Stack pointer offset.
*/
struct FPInvOffsetData : IRExtraData {
explicit FPInvOffsetData(FPInvOffset offset) : offset(offset) {}
std::string show() const {
return folly::to<std::string>("FPInvOff ", offset.offset);
}
bool equals(FPInvOffsetData o) const { return offset == o.offset; }
size_t hash() const { return std::hash<int32_t>()(offset.offset); }
FPInvOffset offset;
};
/*
* Stack offset.
*/
struct IRSPRelOffsetData : IRExtraData {
explicit IRSPRelOffsetData(IRSPRelOffset offset) : offset(offset) {}
std::string show() const {
return folly::to<std::string>("IRSPOff ", offset.offset);
}
bool equals(IRSPRelOffsetData o) const { return offset == o.offset; }
size_t hash() const { return std::hash<int32_t>()(offset.offset); }
IRSPRelOffset offset;
};
///////////////////////////////////////////////////////////////////////////////
/*
* One-off IRExtraData classes.
*
* These are used for only one or two instructions and are in no particular
* order. Add new IRExtraData types here.
*/
struct IsAsyncData : IRExtraData {
explicit IsAsyncData(bool isAsync) : isAsync(isAsync) {}
std::string show() const { return folly::to<std::string>(isAsync); }
bool equals(IsAsyncData d) const { return isAsync == d.isAsync; }
size_t hash() const { return std::hash<int32_t>()(isAsync); }
bool isAsync;
};
struct LdBindAddrData : IRExtraData {
explicit LdBindAddrData(SrcKey sk, FPInvOffset bcSPOff)
: sk(sk)
, bcSPOff(bcSPOff)
{}
std::string show() const { return showShort(sk); }
SrcKey sk;
FPInvOffset bcSPOff;
};
struct LdSSwitchData : IRExtraData {
struct Elm {
const StringData* str;
SrcKey dest;
};
explicit LdSSwitchData() = default;
LdSSwitchData(const LdSSwitchData&) = delete;
LdSSwitchData& operator=(const LdSSwitchData&) = delete;
LdSSwitchData* clone(Arena& arena) const {
LdSSwitchData* target = new (arena) LdSSwitchData;
target->numCases = numCases;
target->defaultSk = defaultSk;
target->cases = new (arena) Elm[numCases];
target->bcSPOff = bcSPOff;
std::copy(cases, cases + numCases, const_cast<Elm*>(target->cases));
return target;
}
std::string show() const {
return folly::to<std::string>(bcSPOff.offset);
}
int64_t numCases;
const Elm* cases;
SrcKey defaultSk;
FPInvOffset bcSPOff;
};
struct ProfileSwitchData : IRExtraData {
ProfileSwitchData(rds::Handle handle, int32_t cases, int64_t base)
: handle(handle)
, cases(cases)
, base(base)
{}
std::string show() const {
return folly::sformat("handle {}, {} cases, base {}", handle, cases, base);
}
rds::Handle handle;
int32_t cases;
int64_t base;
};
struct JmpSwitchData : IRExtraData {
JmpSwitchData* clone(Arena& arena) const {
JmpSwitchData* sd = new (arena) JmpSwitchData;
sd->cases = cases;
sd->targets = new (arena) SrcKey[cases];
sd->spOffBCFromFP = spOffBCFromFP;
sd->spOffBCFromIRSP = spOffBCFromIRSP;
std::copy(targets, targets + cases, const_cast<SrcKey*>(sd->targets));
return sd;
}
std::string show() const {
return folly::sformat("{} cases", cases);
}
int32_t cases; // number of cases
SrcKey* targets; // srckeys for all targets
FPInvOffset spOffBCFromFP;
IRSPRelOffset spOffBCFromIRSP;
};
struct LdTVAuxData : IRExtraData {
explicit LdTVAuxData(int32_t v = -1) : valid(v) {}
std::string show() const {
return folly::sformat("{:x}", valid);
}
int32_t valid;
};
struct ReqBindJmpData : IRExtraData {
explicit ReqBindJmpData(const SrcKey& target,
FPInvOffset invSPOff,
IRSPRelOffset irSPOff,
TransFlags trflags)
: target(target)
, invSPOff(invSPOff)
, irSPOff(irSPOff)
, trflags(trflags)
{}
std::string show() const {
return folly::sformat(
"{}, FPInv {}, IRSP {}, Flags {}",
target.offset(), invSPOff.offset, irSPOff.offset, trflags.packed
);
}
SrcKey target;
FPInvOffset invSPOff;
IRSPRelOffset irSPOff;
TransFlags trflags;
};
struct ReqRetranslateData : IRExtraData {
explicit ReqRetranslateData(IRSPRelOffset irSPOff,
TransFlags trflags)
: irSPOff(irSPOff)
, trflags{trflags}
{}
std::string show() const {
return folly::to<std::string>(irSPOff.offset, ',', trflags.packed);
}
IRSPRelOffset irSPOff;
TransFlags trflags;
};
/*
* Compile-time metadata about an ActRec allocation.
*/
struct ActRecInfo : IRExtraData {
IRSPRelOffset spOffset;
int32_t numArgs;
std::string show() const {
return folly::to<std::string>(spOffset.offset, ',', numArgs);
}
};
/*
* DefInlineFP is present when we need to create a frame for inlining. This
* instruction also carries some metadata used by IRBuilder to track state
* during an inlined call.
*/
struct DefInlineFPData : IRExtraData {
std::string show() const {
return folly::to<std::string>(
target->fullName()->data(), "(),",
retBCOff, ',',
retSPOff.offset, ',',
spOffset.offset
);
}
const Func* target;
SSATmp* ctx; // Ctx, Cls or Nullptr.
Offset retBCOff;
FPInvOffset retSPOff;
IRSPRelOffset spOffset; // offset from caller SP to bottom of callee's ActRec
uint32_t numNonDefault;
};
struct SyncReturnBCData : IRExtraData {
SyncReturnBCData(Offset bcOff, IRSPRelOffset spOff)
: bcOffset(bcOff)
, spOffset(spOff)
{}
std::string show() const {
return folly::to<std::string>(bcOffset, ",", spOffset.offset);
}
Offset bcOffset;
IRSPRelOffset spOffset;
};
struct CallArrayData : IRExtraData {
explicit CallArrayData(IRSPRelOffset spOffset,
uint32_t numParams,
uint32_t numOut,
Offset pcOffset,
Offset after,
const Func* callee,
bool writeLocals,
bool readLocals)
: spOffset(spOffset)
, numParams(numParams)
, numOut(numOut)
, pc(pcOffset)
, after(after)
, callee(callee)
, writeLocals(writeLocals)
, readLocals(readLocals)
{}
std::string show() const {
return folly::to<std::string>(
pc, ",",
after,
callee
? folly::sformat(",{}", callee->fullName())
: std::string{},
writeLocals ? ",writeLocals" : "",
readLocals ? ",readLocals" : "");
}
IRSPRelOffset spOffset; // offset from StkPtr to bottom of call's ActRec+args
uint32_t numParams;
uint32_t numOut;
Offset pc; // XXX why isn't this available in the marker?
Offset after; // offset from unit m_bc (unlike m_soff in ActRec)
const Func* callee; // nullptr if not statically known
bool writeLocals;
bool readLocals;
};
struct CallBuiltinData : IRExtraData {
explicit CallBuiltinData(IRSPRelOffset spOffset,
const Func* callee,
int32_t numNonDefault,
bool writeLocals,
bool readLocals,
bool needsFrame)
: spOffset(spOffset)
, callee{callee}
, numNonDefault{numNonDefault}
, writeLocals{writeLocals}
, readLocals{readLocals}
, needsCallerFrame{needsFrame}
{}
std::string show() const {
return folly::to<std::string>(
spOffset.offset, ',',
callee->fullName()->data(),
writeLocals ? ",writeLocals" : "",
readLocals ? ",readLocals" : "",
needsCallerFrame ? ",needsCallerFrame" : ""
);
}
IRSPRelOffset spOffset; // offset from StkPtr to last passed arg
const Func* callee;
int32_t numNonDefault;
bool writeLocals;
bool readLocals;
bool needsCallerFrame;
};
struct CallData : IRExtraData {
explicit CallData(IRSPRelOffset spOffset,
uint32_t numParams,
uint32_t numOut,
Offset after,
const Func* callee,
bool writeLocals,
bool readLocals,
bool needsFrame,
bool fcallAwait)
: spOffset(spOffset)
, numParams(numParams)
, numOut(numOut)
, after(after)
, callee(callee)
, writeLocals(writeLocals)
, readLocals(readLocals)
, needsCallerFrame(needsFrame)
, fcallAwait(fcallAwait)
{}
std::string show() const {
return folly::to<std::string>(
spOffset.offset, ',', numParams, ',', after,
callee
? folly::format(",{}", callee->fullName()).str()
: std::string{},
writeLocals ? ",writeLocals" : "",
readLocals ? ",readLocals" : "",
needsCallerFrame ? ",needsCallerFrame" : "",
fcallAwait ? ",fcallAwait" : ""
);
}
IRSPRelOffset spOffset; // offset from StkPtr to bottom of call's ActRec+args
uint32_t numParams;
uint32_t numOut; // number of values returned via stack from the callee
Offset after; // m_soff style: offset from func->base()
const Func* callee; // nullptr if not statically known
bool writeLocals;
bool readLocals;
bool needsCallerFrame;
bool fcallAwait;
};
struct RetCtrlData : IRExtraData {
explicit RetCtrlData(IRSPRelOffset offset, bool suspendingResumed,
folly::Optional<AuxUnion> aux = folly::none)
: offset(offset)
, suspendingResumed(suspendingResumed)
, aux(aux)
{}
std::string show() const {
return folly::to<std::string>(
offset.offset,
suspendingResumed ? ",suspendingResumed" : ""
);
}
// Adjustment we need to make to the stack pointer (for cross-tracelet ABI
// purposes) before returning.
IRSPRelOffset offset;
// Indicates that the current resumable frame is being suspended without
// decrefing locals. Used by refcount optimizer.
bool suspendingResumed;
// Optional TV aux value to attach to the function's return value.
folly::Optional<AuxUnion> aux;
};
/*
* Name of a class constant in a known class
*/
struct ClsCnsName : IRExtraData {
explicit ClsCnsName(const StringData* cls, const StringData* cns)
: clsName(cls)
, cnsName(cns)
{}
std::string show() const {
return folly::to<std::string>(clsName->data(), "::", cnsName->data());
}
const StringData* clsName;
const StringData* cnsName;
};
/*
* Name of a class constant in an unknown class.
*/
struct LdSubClsCnsData : IRExtraData {
explicit LdSubClsCnsData(const StringData* cns, Slot s)
: cnsName(cns)
, slot(s)
{}
std::string show() const {
return folly::sformat("<cls>::{}({})", cnsName, slot);
}
const StringData* cnsName;
Slot slot;
};
/*
* Name and handle of profiled class constant
*/
struct ProfileSubClsCnsData : IRExtraData {
explicit ProfileSubClsCnsData(const StringData* cns, rds::Handle h)
: cnsName(cns)
, handle(h)
{}
std::string show() const {
return folly::to<std::string>("<cls>::", cnsName->data());
}
const StringData* cnsName;
rds::Handle handle;
};
/*
* The name of a static local in a function.
*/
struct StaticLocName : IRExtraData {
StaticLocName(const Func* func, const StringData* name)
: func(func)
, name(name)
{}
std::string show() const {
return folly::to<std::string>(
func->fullName()->data(), "$", name->data()
);
}
bool equals(const StaticLocName& o) const {
return func == o.func && name == o.name;
}
size_t hash() const {
return hash_int64_pair((intptr_t)func, (intptr_t)name);
}
const Func* func;
const StringData* name;
};
struct LdFuncCachedData : IRExtraData {
explicit LdFuncCachedData(const StringData* name)
: name(name)
{}
std::string show() const {
return folly::to<std::string>(name->data());
}
size_t hash() const { return name->hash(); }
bool equals(const LdFuncCachedData& o) const {
return name == o.name;
}
const StringData* name;
};
struct LdObjMethodData : IRExtraData {
explicit LdObjMethodData(IRSPRelOffset offset,
const StringData* method,
bool fatal)
: offset(offset)
, method(method)
, fatal(fatal)
{}
std::string show() const {
return folly::to<std::string>(offset.offset, ',', method->data(), ',',
fatal ? "fatal" : "warn");
}
IRSPRelOffset offset;
const StringData* method;
bool fatal;
};
struct LdFuncCachedUData : IRExtraData {
explicit LdFuncCachedUData(const StringData* name,
const StringData* fallback)
: name(name)
, fallback(fallback)
{}
std::string show() const {
return folly::to<std::string>(name->data(), ',', fallback->data());
}
size_t hash() const {
return hash_int64_pair((uint32_t)name->hash(), (uint32_t)fallback->hash());
}
bool equals(const LdFuncCachedUData& o) const {
return name == o.name && fallback == o.fallback;
}
const StringData* name;
const StringData* fallback;
};
/*
* Offset and stack deltas for InterpOne.
*/
struct InterpOneData : IRExtraData {
struct LocalType {
explicit LocalType(uint32_t id = 0, Type type = TBottom)
: id(id)
, type(type)
{}
uint32_t id;
Type type;
};
struct ClsRefSlot {
explicit ClsRefSlot(uint32_t id = 0, bool write = false)
: id{id}
, write{write}
{}
uint32_t id;
bool write;
};
explicit InterpOneData(IRSPRelOffset spOffset)
: spOffset(spOffset)
, nChangedLocals(0)
, changedLocals(nullptr)
, nChangedClsRefSlots(0)
, changedClsRefSlots(nullptr)
, smashesAllLocals(false)
{}
// Offset of the BC stack top relative to the current IR stack pointer.
IRSPRelOffset spOffset;
// Offset of the instruction to interpret, in the Unit indicated by the
// current Marker.
Offset bcOff;
// The number of eval stack cells consumed and produced by the instruction,
// respectively. Includes ActRecs.
int64_t cellsPopped;
int64_t cellsPushed;
// Opcode, in case we need to fix the stack differently. Some bytecode
// instructions modify things below the top of the stack.
Op opcode;
uint32_t nChangedLocals;
LocalType* changedLocals;
uint32_t nChangedClsRefSlots;
ClsRefSlot* changedClsRefSlots;
bool smashesAllLocals;
InterpOneData* clone(Arena& arena) const {
auto* id = new (arena) InterpOneData(spOffset);
id->bcOff = bcOff;
id->cellsPopped = cellsPopped;
id->cellsPushed = cellsPushed;
id->opcode = opcode;
id->nChangedLocals = nChangedLocals;
id->changedLocals = new (arena) LocalType[nChangedLocals];
id->nChangedClsRefSlots = nChangedClsRefSlots;
id->changedClsRefSlots = new (arena) ClsRefSlot[nChangedClsRefSlots];
id->smashesAllLocals = smashesAllLocals;
std::copy(changedLocals, changedLocals + nChangedLocals, id->changedLocals);
std::copy(changedClsRefSlots, changedClsRefSlots + nChangedClsRefSlots,
id->changedClsRefSlots);
return id;
}
std::string show() const {
auto ret = folly::sformat(
"{}: spOff:{}, bcOff:{}, popped:{}, pushed:{}",
opcodeToName(opcode),
spOffset.offset,
bcOff,
cellsPopped,
cellsPushed
);
assertx(!smashesAllLocals || !nChangedLocals);
if (smashesAllLocals) ret += ", smashes all locals";
if (nChangedLocals) {
for (auto i = 0; i < nChangedLocals; ++i) {
ret += folly::sformat(", Local {} -> {}",
changedLocals[i].id,
changedLocals[i].type);
}
}
if (nChangedClsRefSlots) {
for (auto i = 0; i < nChangedClsRefSlots; ++i) {
ret += folly::sformat(", Slot {}{}",
changedClsRefSlots[i].id,
changedClsRefSlots[i].write ? "W" : "R");
}
}
return ret;
}
};
struct CoerceStkData : IRExtraData {
explicit CoerceStkData(IRSPRelOffset off, const Func* f, int64_t arg_num)
: offset(off), callee(f), argNum(arg_num) {}
std::string show() const {
return folly::sformat(
"IRSP {},{},{}",
offset.offset,
callee->name(),
argNum
);
}
IRSPRelOffset offset;
const Func* callee;
int32_t argNum;
};
struct CoerceMemData : IRExtraData {
explicit CoerceMemData(const Func* f, int64_t arg_num)
: callee(f), argNum(arg_num) {}
std::string show() const {
return folly::sformat("{},{}", callee->name(), argNum);
}
const Func* callee;
int32_t argNum;
};
struct RBEntryData : IRExtraData {
RBEntryData(Trace::RingBufferType t, SrcKey sk)
: type(t)
, sk(sk)
{}
std::string show() const {
return folly::sformat("{}: {}", ringbufferName(type), showShort(sk));
}