forked from dotnet/runtime
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathjit.h
934 lines (799 loc) · 33.2 KB
/
jit.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
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
/*****************************************************************************/
#ifndef _JIT_H_
#define _JIT_H_
/*****************************************************************************/
//
// clr.sln only defines _DEBUG
// The jit uses DEBUG rather than _DEBUG
// So we make sure that _DEBUG implies DEBUG
//
#ifdef _DEBUG
#ifndef DEBUG
#define DEBUG 1
#endif
#endif
// Clang-format messes with the indentation of comments if they directly precede an
// ifdef. This macro allows us to anchor the comments to the regular flow of code.
#define CLANG_FORMAT_COMMENT_ANCHOR ;
// Clang-tidy replaces 0 with nullptr in some templated functions, causing a build
// break. Replacing those instances with ZERO avoids this change
#define ZERO 0
#ifdef _MSC_VER
#define CHECK_STRUCT_PADDING 0 // Set this to '1' to enable warning C4820 "'bytes' bytes padding added after
// construct 'member_name'" on interesting structs/classes
#else
#define CHECK_STRUCT_PADDING 0 // Never enable it for non-MSFT compilers
#endif
#if defined(HOST_X86)
#if defined(HOST_ARM)
#error Cannot define both HOST_X86 and HOST_ARM
#endif
#if defined(HOST_AMD64)
#error Cannot define both HOST_X86 and HOST_AMD64
#endif
#if defined(HOST_ARM64)
#error Cannot define both HOST_X86 and HOST_ARM64
#endif
#if defined(HOST_LOONGARCH64)
#error Cannot define both HOST_X86 and HOST_LOONGARCH64
#endif
#if defined(HOST_RISCV64)
#error Cannot define both HOST_X86 and HOST_RISCV64
#endif
#elif defined(HOST_AMD64)
#if defined(HOST_X86)
#error Cannot define both HOST_AMD64 and HOST_X86
#endif
#if defined(HOST_ARM)
#error Cannot define both HOST_AMD64 and HOST_ARM
#endif
#if defined(HOST_ARM64)
#error Cannot define both HOST_AMD64 and HOST_ARM64
#endif
#if defined(HOST_LOONGARCH64)
#error Cannot define both HOST_AMD64 and HOST_LOONGARCH64
#endif
#if defined(HOST_RISCV64)
#error Cannot define both HOST_AMD64 and HOST_RISCV64
#endif
#elif defined(HOST_ARM)
#if defined(HOST_X86)
#error Cannot define both HOST_ARM and HOST_X86
#endif
#if defined(HOST_AMD64)
#error Cannot define both HOST_ARM and HOST_AMD64
#endif
#if defined(HOST_ARM64)
#error Cannot define both HOST_ARM and HOST_ARM64
#endif
#if defined(HOST_LOONGARCH64)
#error Cannot define both HOST_ARM and HOST_LOONGARCH64
#endif
#if defined(HOST_RISCV64)
#error Cannot define both HOST_ARM and HOST_RISCV64
#endif
#elif defined(HOST_ARM64)
#if defined(HOST_X86)
#error Cannot define both HOST_ARM64 and HOST_X86
#endif
#if defined(HOST_AMD64)
#error Cannot define both HOST_ARM64 and HOST_AMD64
#endif
#if defined(HOST_ARM)
#error Cannot define both HOST_ARM64 and HOST_ARM
#endif
#if defined(HOST_LOONGARCH64)
#error Cannot define both HOST_ARM64 and HOST_LOONGARCH64
#endif
#if defined(HOST_RISCV64)
#error Cannot define both HOST_ARM64 and HOST_RISCV64
#endif
#elif defined(HOST_LOONGARCH64)
#if defined(HOST_X86)
#error Cannot define both HOST_LOONGARCH64 and HOST_X86
#endif
#if defined(HOST_AMD64)
#error Cannot define both HOST_LOONGARCH64 and HOST_AMD64
#endif
#if defined(HOST_ARM)
#error Cannot define both HOST_LOONGARCH64 and HOST_ARM
#endif
#if defined(HOST_ARM64)
#error Cannot define both HOST_LOONGARCH64 and HOST_ARM64
#endif
#if defined(HOST_RISCV64)
#error Cannot define both HOST_LOONGARCH64 and HOST_RISCV64
#endif
#elif defined(HOST_RISCV64)
#if defined(HOST_X86)
#error Cannot define both HOST_RISCV64 and HOST_X86
#endif
#if defined(HOST_AMD64)
#error Cannot define both HOST_RISCV64 and HOST_AMD64
#endif
#if defined(HOST_ARM)
#error Cannot define both HOST_RISCV64 and HOST_ARM
#endif
#if defined(HOST_ARM64)
#error Cannot define both HOST_RISCV64 and HOST_ARM64
#endif
#if defined(HOST_LOONGARCH64)
#error Cannot define both HOST_RISCV64 and HOST_LOONGARCH64
#endif
#else
#error Unsupported or unset host architecture
#endif
#if defined(TARGET_X86)
#if defined(TARGET_ARM)
#error Cannot define both TARGET_X86 and TARGET_ARM
#endif
#if defined(TARGET_AMD64)
#error Cannot define both TARGET_X86 and TARGET_AMD64
#endif
#if defined(TARGET_ARM64)
#error Cannot define both TARGET_X86 and TARGET_ARM64
#endif
#if defined(TARGET_LOONGARCH64)
#error Cannot define both TARGET_X86 and TARGET_LOONGARCH64
#endif
#if defined(TARGET_RISCV64)
#error Cannot define both TARGET_X86 and TARGET_RISCV64
#endif
#elif defined(TARGET_AMD64)
#if defined(TARGET_X86)
#error Cannot define both TARGET_AMD64 and TARGET_X86
#endif
#if defined(TARGET_ARM)
#error Cannot define both TARGET_AMD64 and TARGET_ARM
#endif
#if defined(TARGET_ARM64)
#error Cannot define both TARGET_AMD64 and TARGET_ARM64
#endif
#if defined(TARGET_LOONGARCH64)
#error Cannot define both TARGET_AMD64 and TARGET_LOONGARCH64
#endif
#if defined(TARGET_RISCV64)
#error Cannot define both TARGET_AMD64 and TARGET_RISCV64
#endif
#elif defined(TARGET_ARM)
#if defined(TARGET_X86)
#error Cannot define both TARGET_ARM and TARGET_X86
#endif
#if defined(TARGET_AMD64)
#error Cannot define both TARGET_ARM and TARGET_AMD64
#endif
#if defined(TARGET_ARM64)
#error Cannot define both TARGET_ARM and TARGET_ARM64
#endif
#if defined(TARGET_LOONGARCH64)
#error Cannot define both TARGET_ARM and TARGET_LOONGARCH64
#endif
#if defined(TARGET_RISCV64)
#error Cannot define both TARGET_ARM and TARGET_RISCV64
#endif
#elif defined(TARGET_ARM64)
#if defined(TARGET_X86)
#error Cannot define both TARGET_ARM64 and TARGET_X86
#endif
#if defined(TARGET_AMD64)
#error Cannot define both TARGET_ARM64 and TARGET_AMD64
#endif
#if defined(TARGET_ARM)
#error Cannot define both TARGET_ARM64 and TARGET_ARM
#endif
#if defined(TARGET_LOONGARCH64)
#error Cannot define both TARGET_ARM64 and TARGET_LOONGARCH64
#endif
#if defined(TARGET_RISCV64)
#error Cannot define both TARGET_ARM64 and TARGET_RISCV64
#endif
#elif defined(TARGET_LOONGARCH64)
#if defined(TARGET_X86)
#error Cannot define both TARGET_LOONGARCH64 and TARGET_X86
#endif
#if defined(TARGET_AMD64)
#error Cannot define both TARGET_LOONGARCH64 and TARGET_AMD64
#endif
#if defined(TARGET_ARM)
#error Cannot define both TARGET_LOONGARCH64 and TARGET_ARM
#endif
#if defined(TARGET_ARM64)
#error Cannot define both TARGET_LOONGARCH64 and TARGET_ARM64
#endif
#if defined(TARGET_RISCV64)
#error Cannot define both TARGET_LOONGARCH64 and TARGET_RISCV64
#endif
#elif defined(TARGET_RISCV64)
#if defined(TARGET_X86)
#error Cannot define both TARGET_RISCV64 and TARGET_X86
#endif
#if defined(TARGET_AMD64)
#error Cannot define both TARGET_RISCV64 and TARGET_AMD64
#endif
#if defined(TARGET_ARM)
#error Cannot define both TARGET_RISCV64 and TARGET_ARM
#endif
#if defined(TARGET_ARM64)
#error Cannot define both TARGET_RISCV64 and TARGET_ARM64
#endif
#if defined(TARGET_LOONGARCH64)
#error Cannot define both TARGET_RISCV64 and TARGET_LOONGARCH64
#endif
#else
#error Unsupported or unset target architecture
#endif
#ifdef TARGET_64BIT
#ifdef TARGET_X86
#error Cannot define both TARGET_X86 and TARGET_64BIT
#endif // TARGET_X86
#ifdef TARGET_ARM
#error Cannot define both TARGET_ARM and TARGET_64BIT
#endif // TARGET_ARM
#endif // TARGET_64BIT
#if defined(TARGET_X86) || defined(TARGET_AMD64)
#define TARGET_XARCH
#endif
#if defined(TARGET_ARM) || defined(TARGET_ARM64)
#define TARGET_ARMARCH
#endif
// If the UNIX_AMD64_ABI is defined make sure that TARGET_AMD64 is also defined.
#if defined(UNIX_AMD64_ABI)
#if !defined(TARGET_AMD64)
#error When UNIX_AMD64_ABI is defined you must define TARGET_AMD64 defined as well.
#endif
#endif
// If the UNIX_X86_ABI is defined make sure that TARGET_X86 is also defined.
#if defined(UNIX_X86_ABI)
#if !defined(TARGET_X86)
#error When UNIX_X86_ABI is defined you must define TARGET_X86 defined as well.
#endif
#endif
// --------------------------------------------------------------------------------
// IMAGE_FILE_MACHINE_TARGET
// --------------------------------------------------------------------------------
#if defined(TARGET_X86)
#define IMAGE_FILE_MACHINE_TARGET IMAGE_FILE_MACHINE_I386
#elif defined(TARGET_AMD64)
#define IMAGE_FILE_MACHINE_TARGET IMAGE_FILE_MACHINE_AMD64
#elif defined(TARGET_ARM)
#define IMAGE_FILE_MACHINE_TARGET IMAGE_FILE_MACHINE_ARMNT
#elif defined(TARGET_ARM64)
#define IMAGE_FILE_MACHINE_TARGET IMAGE_FILE_MACHINE_ARM64 // 0xAA64
#elif defined(TARGET_LOONGARCH64)
#define IMAGE_FILE_MACHINE_TARGET IMAGE_FILE_MACHINE_LOONGARCH64 // 0x6264
#elif defined(TARGET_RISCV64)
#define IMAGE_FILE_MACHINE_TARGET IMAGE_FILE_MACHINE_RISCV64 // 0x5064
#else
#error Unsupported or unset target architecture
#endif
typedef ptrdiff_t ssize_t;
// Include the AMD64 unwind codes when appropriate.
#if defined(TARGET_AMD64)
#include "win64unwind.h"
#endif
#include "corhdr.h"
#include "corjit.h"
#include "jitee.h"
#define __OPERATOR_NEW_INLINE 1 // indicate that I will define these
#define __PLACEMENT_NEW_INLINE // don't bring in the global placement new, it is easy to make a mistake
// with our new(compiler*) pattern.
#include "utilcode.h" // this defines assert as _ASSERTE
#include "host.h" // this redefines assert for the JIT to use assertAbort
#include "utils.h"
#include "targetosarch.h"
// The late disassembler is built in for certain platforms, for DEBUG builds. It is enabled by using
// DOTNET_JitLateDisasm. It can be built in for non-DEBUG builds if desired.
#if defined(TARGET_ARM64) || defined(TARGET_ARM) || defined(TARGET_X86) || defined(TARGET_AMD64)
#ifdef DEBUG
#define LATE_DISASM 1
#define USE_COREDISTOOLS
#endif // DEBUG
#endif // platforms
#if defined(LATE_DISASM) && (LATE_DISASM == 0)
#undef LATE_DISASM
#endif
#ifdef DEBUG
#define INDEBUG(x) x
#define DEBUGARG(x) , x
#else
#define INDEBUG(x)
#define DEBUGARG(x)
#endif
#if defined(DEBUG) || defined(LATE_DISASM)
#define INDEBUG_LDISASM_COMMA(x) x,
#else
#define INDEBUG_LDISASM_COMMA(x)
#endif
#if defined(UNIX_AMD64_ABI)
#define UNIX_AMD64_ABI_ONLY_ARG(x) , x
#define UNIX_AMD64_ABI_ONLY(x) x
#else // !defined(UNIX_AMD64_ABI)
#define UNIX_AMD64_ABI_ONLY_ARG(x)
#define UNIX_AMD64_ABI_ONLY(x)
#endif // defined(UNIX_AMD64_ABI)
#if defined(TARGET_LOONGARCH64)
#define UNIX_LOONGARCH64_ONLY_ARG(x) , x
#define UNIX_LOONGARCH64_ONLY(x) x
#else // !TARGET_LOONGARCH64
#define UNIX_LOONGARCH64_ONLY_ARG(x)
#define UNIX_LOONGARCH64_ONLY(x)
#endif // TARGET_LOONGARCH64
#if defined(UNIX_AMD64_ABI) || !defined(TARGET_64BIT) || defined(TARGET_ARM64) || defined(TARGET_LOONGARCH64) || \
defined(TARGET_RISCV64)
#define FEATURE_PUT_STRUCT_ARG_STK 1
#endif
#if defined(UNIX_AMD64_ABI)
#define UNIX_AMD64_ABI_ONLY_ARG(x) , x
#define UNIX_AMD64_ABI_ONLY(x) x
#else // !defined(UNIX_AMD64_ABI)
#define UNIX_AMD64_ABI_ONLY_ARG(x)
#define UNIX_AMD64_ABI_ONLY(x)
#endif // defined(UNIX_AMD64_ABI)
#if defined(UNIX_AMD64_ABI) || defined(TARGET_ARM64) || defined(TARGET_LOONGARCH64) || defined(TARGET_RISCV64)
#define MULTIREG_HAS_SECOND_GC_RET 1
#define MULTIREG_HAS_SECOND_GC_RET_ONLY_ARG(x) , x
#define MULTIREG_HAS_SECOND_GC_RET_ONLY(x) x
#else // !defined(UNIX_AMD64_ABI)
#define MULTIREG_HAS_SECOND_GC_RET 0
#define MULTIREG_HAS_SECOND_GC_RET_ONLY_ARG(x)
#define MULTIREG_HAS_SECOND_GC_RET_ONLY(x)
#endif // defined(UNIX_AMD64_ABI)
// Arm64 Windows supports FEATURE_ARG_SPLIT, note this is different from
// the official Arm64 ABI.
// Case: splitting 16 byte struct between x7 and stack
// LoongArch64's ABI supports FEATURE_ARG_SPLIT which splitting 16 byte struct between a7 and stack.
#if defined(TARGET_ARM) || defined(TARGET_ARM64) || defined(TARGET_LOONGARCH64) || defined(TARGET_RISCV64)
#define FEATURE_ARG_SPLIT 1
#else
#define FEATURE_ARG_SPLIT 0
#endif
// To get rid of warning 4701 : local variable may be used without being initialized
#define DUMMY_INIT(x) (x)
#define REGEN_SHORTCUTS 0
#define REGEN_CALLPAT 0
/*XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XX XX
XX jit.h XX
XX XX
XX Interface of the JIT with jit.cpp XX
XX XX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
*/
/*****************************************************************************/
#if defined(DEBUG)
#include "log.h"
#define INFO6 LL_INFO10000 // Did Jit or Inline succeeded?
#define INFO7 LL_INFO100000 // NYI stuff
#define INFO8 LL_INFO1000000 // Weird failures
#endif // DEBUG
typedef class ICorJitInfo* COMP_HANDLE;
const CORINFO_OBJECT_HANDLE NO_OBJECT_HANDLE = nullptr;
const CORINFO_CLASS_HANDLE NO_CLASS_HANDLE = nullptr;
const CORINFO_FIELD_HANDLE NO_FIELD_HANDLE = nullptr;
const CORINFO_METHOD_HANDLE NO_METHOD_HANDLE = nullptr;
/*****************************************************************************/
typedef unsigned IL_OFFSET;
const IL_OFFSET BAD_IL_OFFSET = 0xffffffff;
const unsigned BAD_VAR_NUM = UINT_MAX;
const uint16_t BAD_LCL_OFFSET = UINT16_MAX;
// Code can't be more than 2^31 in any direction. This is signed, so it should be used for anything that is
// relative to something else.
typedef int NATIVE_OFFSET;
// This is the same as the above, but it's used in absolute contexts (i.e. offset from the start). Also,
// this is used for native code sizes.
typedef unsigned UNATIVE_OFFSET;
// Type used for weights (e.g. block and edge weights)
typedef double weight_t;
// For the following specially handled FIELD_HANDLES we need
// values that are negative and have the low two bits zero
// See eeFindJitDataOffs and eeGetJitDataOffs in Compiler.hpp
#define FLD_GLOBAL_DS ((CORINFO_FIELD_HANDLE)-4)
#define FLD_GLOBAL_FS ((CORINFO_FIELD_HANDLE)-8)
#define FLD_GLOBAL_GS ((CORINFO_FIELD_HANDLE)-12)
class GlobalJitOptions
{
public:
#ifdef FEATURE_HFA
#define FEATURE_HFA_FIELDS_PRESENT
#ifdef CONFIGURABLE_ARM_ABI
// These are safe to have globals as they cannot change once initialized within the process.
static LONG compUseSoftFPConfigured;
static bool compFeatureHfa;
#else // !CONFIGURABLE_ARM_ABI
static const bool compFeatureHfa = true;
#endif // CONFIGURABLE_ARM_ABI
#else // !FEATURE_HFA
static const bool compFeatureHfa = false;
#endif // FEATURE_HFA
#ifdef FEATURE_HFA
#undef FEATURE_HFA
#endif
};
/*****************************************************************************/
#include "vartype.h"
/*****************************************************************************/
/*****************************************************************************/
/*****************************************************************************/
#define CSE_INTO_HANDLERS 0
#define DUMP_FLOWGRAPHS DEBUG // Support for creating Xml Flowgraph reports in *.fgx files
#define HANDLER_ENTRY_MUST_BE_IN_HOT_SECTION 0 // if 1 we must have all handler entry points in the Hot code section
/*****************************************************************************/
#define VPTR_OFFS 0 // offset of vtable pointer from obj ptr
/*****************************************************************************/
#define DUMP_GC_TABLES DEBUG
#define VERIFY_GC_TABLES 0
#define REARRANGE_ADDS 1
#define FUNC_INFO_LOGGING 1 // Support dumping function info to a file. In retail, only NYIs, with no function name,
// are dumped.
/*****************************************************************************/
/*****************************************************************************/
/* Set these to 1 to collect and output various statistics about the JIT */
#define CALL_ARG_STATS 0 // Collect stats about calls and call arguments.
#define COUNT_BASIC_BLOCKS 0 // Create a histogram of basic block sizes, and a histogram of IL sizes in the simple
// case of single block methods.
#define COUNT_LOOPS 0 // Collect stats about loops, such as the total number of natural loops, a histogram of
// the number of loop exits, etc.
#define DISPLAY_SIZES 0 // Display generated code, data, and GC information sizes.
#define MEASURE_BLOCK_SIZE 0 // Collect stats about basic block and FlowEdge node sizes and memory allocations.
#define MEASURE_FATAL 0 // Count the number of calls to fatal(), including NYIs and noway_asserts.
#define MEASURE_NODE_SIZE 0 // Collect stats about GenTree node allocations.
#define MEASURE_PTRTAB_SIZE 0 // Collect stats about GC pointer table allocations.
#define EMITTER_STATS 0 // Collect stats on the emitter.
#define NODEBASH_STATS 0 // Collect stats on changed gtOper values in GenTree's.
#define COUNT_AST_OPERS 0 // Display use counts for GenTree operators.
#ifdef DEBUG
#define MEASURE_MEM_ALLOC 1 // Collect memory allocation stats.
#define LOOP_HOIST_STATS 1 // Collect loop hoisting stats.
#define TRACK_LSRA_STATS 1 // Collect LSRA stats
#define TRACK_ENREG_STATS 1 // Collect enregistration stats
#else
#define MEASURE_MEM_ALLOC 0 // You can set this to 1 to get memory stats in retail, as well
#define LOOP_HOIST_STATS 0 // You can set this to 1 to get loop hoist stats in retail, as well
#define TRACK_LSRA_STATS 0 // You can set this to 1 to get LSRA stats in retail, as well
#define TRACK_ENREG_STATS 0
#endif
// Timing calls to clr.dll is only available under certain conditions.
#ifndef FEATURE_JIT_METHOD_PERF
#define MEASURE_CLRAPI_CALLS 0 // Can't time these calls without METHOD_PERF.
#endif
#ifdef DEBUG
#define MEASURE_CLRAPI_CALLS 0 // No point in measuring DEBUG code.
#endif
#if !defined(HOST_X86) && !defined(HOST_AMD64)
#define MEASURE_CLRAPI_CALLS 0 // Cycle counters only hooked up on x86/x64.
#endif
#if !defined(_MSC_VER) && !defined(__GNUC__)
#define MEASURE_CLRAPI_CALLS 0 // Only know how to do this with VC and Clang.
#endif
// If none of the above set the flag to 0, it's available.
#ifndef MEASURE_CLRAPI_CALLS
#define MEASURE_CLRAPI_CALLS 0 // Set to 1 to measure time in ICorJitInfo calls.
#endif
/*****************************************************************************/
/* Portability Defines */
/*****************************************************************************/
#ifdef TARGET_X86
#define JIT32_GCENCODER
#endif
/*****************************************************************************/
#if !defined(DEBUG)
#if DUMP_GC_TABLES
#pragma message("NOTE: this non-debug build has GC ptr table dumping always enabled!")
const bool dspGCtbls = true;
#endif
#endif // !DEBUG
/*****************************************************************************/
#ifdef DEBUG
#define JITDUMP(...) \
{ \
if (JitTls::GetCompiler()->verbose) \
logf(__VA_ARGS__); \
}
#define JITDUMPEXEC(x) \
{ \
if (JitTls::GetCompiler()->verbose) \
x; \
}
#define JITLOG(x) \
{ \
JitLogEE x; \
}
#define JITLOG_THIS(t, x) \
{ \
(t)->JitLogEE x; \
}
#define DBEXEC(flg, expr) \
if (flg) \
{ \
expr; \
}
#define DISPNODE(t) \
if (JitTls::GetCompiler()->verbose) \
JitTls::GetCompiler()->gtDispTree(t, nullptr, nullptr, true);
#define DISPTREE(t) \
if (JitTls::GetCompiler()->verbose) \
JitTls::GetCompiler()->gtDispTree(t);
#define DISPSTMT(t) \
if (JitTls::GetCompiler()->verbose) \
JitTls::GetCompiler()->gtDispStmt(t);
#define DISPRANGE(range) \
if (JitTls::GetCompiler()->verbose) \
JitTls::GetCompiler()->gtDispRange(range);
#define DISPTREERANGE(range, t) \
if (JitTls::GetCompiler()->verbose) \
JitTls::GetCompiler()->gtDispTreeRange(range, t);
#define DISPBLOCK(b) \
if (JitTls::GetCompiler()->verbose) \
JitTls::GetCompiler()->fgTableDispBasicBlock(b);
#define VERBOSE JitTls::GetCompiler()->verbose
// Development-time only macros, simplify guards for specified IL methods one wants to debug/add log messages for
#define ISMETHOD(name) (strcmp(JitTls::GetCompiler()->impInlineRoot()->info.compMethodName, name) == 0)
#define ISMETHODHASH(hash) (JitTls::GetCompiler()->impInlineRoot()->info.compMethodHash() == hash)
#else // !DEBUG
#define JITDUMP(...)
#define JITDUMPEXEC(x)
#define JITLOG(x)
#define JITLOG_THIS(t, x)
#define DBEXEC(flg, expr)
#define DISPNODE(t)
#define DISPTREE(t)
#define DISPSTMT(t)
#define DISPRANGE(range)
#define DISPTREERANGE(range, t)
#define DISPBLOCK(b)
#define VERBOSE 0
#endif // !DEBUG
/*****************************************************************************
*
* Double alignment. This aligns ESP to 0 mod 8 in function prolog, then uses ESP
* to reference locals, EBP to reference parameters.
* It only makes sense if frameless method support is on.
* (frameless method support is now always on)
*/
#ifdef TARGET_X86
#define DOUBLE_ALIGN 1 // permit the double alignment of ESP in prolog,
// and permit the double alignment of local offsets
#else
#define DOUBLE_ALIGN 0 // no special handling for double alignment
#endif
#ifdef DEBUG
// Forward declarations for UninitializedWord and IsUninitialized are needed by alloc.h
template <typename T>
inline T UninitializedWord(Compiler* comp);
template <typename T>
inline bool IsUninitialized(T data);
#endif // DEBUG
/*****************************************************************************/
#define castto(var, typ) (*(typ*)&var)
/*****************************************************************************/
#ifdef NO_MISALIGNED_ACCESS
#define MISALIGNED_RD_I2(src) (*castto(src, char*) | *castto(src + 1, char*) << 8)
#define MISALIGNED_RD_U2(src) (*castto(src, char*) | *castto(src + 1, char*) << 8)
#define MISALIGNED_WR_I2(dst, val) \
*castto(dst, char*) = val; \
*castto(dst + 1, char*) = val >> 8;
#define MISALIGNED_WR_I4(dst, val) \
*castto(dst, char*) = val; \
*castto(dst + 1, char*) = val >> 8; \
*castto(dst + 2, char*) = val >> 16; \
*castto(dst + 3, char*) = val >> 24;
#else
#define MISALIGNED_RD_I2(src) (*castto(src, short*))
#define MISALIGNED_RD_U2(src) (*castto(src, unsigned short*))
#define MISALIGNED_WR_I2(dst, val) *castto(dst, short*) = val;
#define MISALIGNED_WR_I4(dst, val) *castto(dst, int*) = val;
#define MISALIGNED_WR_ST(dst, val) *castto(dst, ssize_t*) = val;
#endif
/*****************************************************************************/
inline size_t roundUp(size_t size, size_t mult = sizeof(size_t))
{
assert(mult && ((mult & (mult - 1)) == 0)); // power of two test
return (size + (mult - 1)) & ~(mult - 1);
}
#ifdef HOST_64BIT
inline unsigned int roundUp(unsigned size, unsigned mult)
{
return (unsigned int)roundUp((size_t)size, (size_t)mult);
}
#endif // HOST_64BIT
inline unsigned int unsigned_abs(int x)
{
return ((unsigned int)abs(x));
}
#ifdef TARGET_64BIT
inline size_t unsigned_abs(ssize_t x)
{
return ((size_t)abs((__int64)x));
}
#ifdef __APPLE__
inline size_t unsigned_abs(__int64 x)
{
return ((size_t)abs(x));
}
#endif // __APPLE__
#endif // TARGET_64BIT
/*****************************************************************************/
#include "error.h"
/*****************************************************************************/
#if CHECK_STRUCT_PADDING
#pragma warning(push)
#pragma warning(default : 4820) // 'bytes' bytes padding added after construct 'member_name'
#endif // CHECK_STRUCT_PADDING
#include "alloc.h"
#include "target.h"
#if FEATURE_TAILCALL_OPT
// Enable tail call opt for the following IL pattern
//
// call someFunc
// jmp/jcc RetBlock
// ...
// RetBlock:
// ret
#define FEATURE_TAILCALL_OPT_SHARED_RETURN 1
#else // !FEATURE_TAILCALL_OPT
#define FEATURE_TAILCALL_OPT_SHARED_RETURN 0
#endif // !FEATURE_TAILCALL_OPT
#define CLFLG_CODESIZE 0x00001
#define CLFLG_CODESPEED 0x00002
#define CLFLG_CSE 0x00004
#define CLFLG_REGVAR 0x00008
#define CLFLG_RNGCHKOPT 0x00010
#define CLFLG_DEADSTORE 0x00020
#define CLFLG_CODEMOTION 0x00040
#define CLFLG_QMARK 0x00080
#define CLFLG_TREETRANS 0x00100
#define CLFLG_INLINING 0x00200
#if FEATURE_STRUCTPROMOTE
#define CLFLG_STRUCTPROMOTE 0x00400
#else
#define CLFLG_STRUCTPROMOTE 0x00000
#endif
#if defined(TARGET_XARCH) || defined(TARGET_ARM64)
#define FEATURE_LOOP_ALIGN 1
#else
#define FEATURE_LOOP_ALIGN 0
#endif
#define CLFLG_MAXOPT \
(CLFLG_CSE | CLFLG_REGVAR | CLFLG_RNGCHKOPT | CLFLG_DEADSTORE | CLFLG_CODEMOTION | CLFLG_QMARK | CLFLG_TREETRANS | \
CLFLG_INLINING | CLFLG_STRUCTPROMOTE)
#define CLFLG_MINOPT (CLFLG_TREETRANS)
/*****************************************************************************/
extern void dumpILBytes(const BYTE* const codeAddr, unsigned codeSize, unsigned alignSize);
extern unsigned dumpSingleInstr(const BYTE* const codeAddr, IL_OFFSET offs, const char* prefix = nullptr);
extern void dumpILRange(const BYTE* const codeAddr, unsigned codeSize); // in bytes
/*****************************************************************************/
extern int jitNativeCode(CORINFO_METHOD_HANDLE methodHnd,
CORINFO_MODULE_HANDLE classHnd,
COMP_HANDLE compHnd,
CORINFO_METHOD_INFO* methodInfo,
void** methodCodePtr,
uint32_t* methodCodeSize,
JitFlags* compileFlags,
void* inlineInfoPtr);
// Constants for making sure size_t fit into smaller types.
const size_t MAX_USHORT_SIZE_T = static_cast<size_t>(static_cast<unsigned short>(-1));
const size_t MAX_UNSIGNED_SIZE_T = static_cast<size_t>(static_cast<unsigned>(-1));
/*****************************************************************************/
class Compiler;
class JitTls
{
#ifdef DEBUG
Compiler* m_compiler;
LogEnv m_logEnv;
JitTls* m_next;
#endif
public:
JitTls(ICorJitInfo* jitInfo);
~JitTls();
#ifdef DEBUG
static LogEnv* GetLogEnv();
#endif
static Compiler* GetCompiler();
static void SetCompiler(Compiler* compiler);
};
#if defined(DEBUG)
// Include the definition of Compiler for use by these template functions
//
#include "compiler.h"
//****************************************************************************
//
// Returns a word filled with the JITs allocator default fill value.
//
template <typename T>
inline T UninitializedWord(Compiler* comp)
{
unsigned char defaultFill = 0xdd;
if (comp == nullptr)
{
comp = JitTls::GetCompiler();
}
defaultFill = Compiler::compGetJitDefaultFill(comp);
assert(defaultFill <= 0xff);
__int64 word = 0x0101010101010101LL * defaultFill;
return (T)word;
}
//****************************************************************************
//
// Tries to determine if this value is coming from uninitialized JIT memory
// - Returns true if the value matches what we initialized the memory to.
//
// Notes:
// - Asserts that use this are assuming that the UninitializedWord value
// isn't a legal value for 'data'. Thus using a default fill value of
// 0x00 will often trigger such asserts.
//
template <typename T>
inline bool IsUninitialized(T data)
{
return data == UninitializedWord<T>(JitTls::GetCompiler());
}
#pragma warning(push)
#pragma warning(disable : 4312)
//****************************************************************************
//
// Debug template definitions for dspPtr, dspOffset
// - Used to format pointer/offset values for diffable Disasm
//
template <typename T>
T dspPtr(T p)
{
return (p == ZERO) ? ZERO : (JitTls::GetCompiler()->opts.dspDiffable ? T(0xD1FFAB1E) : p);
}
template <typename T>
T dspOffset(T o)
{
return (o == ZERO) ? ZERO : (JitTls::GetCompiler()->opts.dspDiffable ? T(0xD1FFAB1E) : o);
}
#pragma warning(pop)
#else // !defined(DEBUG)
//****************************************************************************
//
// Non-Debug template definitions for dspPtr, dspOffset
// - This is a nop in non-Debug builds
//
template <typename T>
T dspPtr(T p)
{
return p;
}
template <typename T>
T dspOffset(T o)
{
return o;
}
#endif // !defined(DEBUG)
struct LikelyClassMethodRecord
{
intptr_t handle;
UINT32 likelihood;
};
struct LikelyValueRecord
{
ssize_t value;
UINT32 likelihood;
};
extern "C" UINT32 WINAPI getLikelyValues(LikelyValueRecord* pLikelyValues,
UINT32 maxLikelyValues,
ICorJitInfo::PgoInstrumentationSchema* schema,
UINT32 countSchemaItems,
BYTE* pInstrumentationData,
int32_t ilOffset);
extern "C" UINT32 WINAPI getLikelyClasses(LikelyClassMethodRecord* pLikelyClasses,
UINT32 maxLikelyClasses,
ICorJitInfo::PgoInstrumentationSchema* schema,
UINT32 countSchemaItems,
BYTE* pInstrumentationData,
int32_t ilOffset);
extern "C" UINT32 WINAPI getLikelyMethods(LikelyClassMethodRecord* pLikelyMethods,
UINT32 maxLikelyMethods,
ICorJitInfo::PgoInstrumentationSchema* schema,
UINT32 countSchemaItems,
BYTE* pInstrumentationData,
int32_t ilOffset);
/*****************************************************************************/
#endif //_JIT_H_
/*****************************************************************************/