1 // Licensed to the .NET Foundation under one or more agreements.
2 // The .NET Foundation licenses this file to you under the MIT license.
3 // See the LICENSE file in the project root for more information.
7 /*****************************************************************************\
9 * CorInfo.h - EE / Code generator interface *
11 *******************************************************************************
13 * This file exposes CLR runtime functionality. It can be used by compilers,
14 * both Just-in-time and ahead-of-time, to generate native code which
15 * executes in the runtime environment.
16 *******************************************************************************
18 //////////////////////////////////////////////////////////////////////////////////////////////////////////
20 // NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE
22 // The JIT/EE interface is versioned. By "interface", we mean mean any and all communication between the
23 // JIT and the EE. Any time a change is made to the interface, the JIT/EE interface version identifier
24 // must be updated. See code:JITEEVersionIdentifier for more information.
26 // NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE
28 //////////////////////////////////////////////////////////////////////////////////////////////////////////
32 The semantic contract between the EE and the JIT should be documented here It is incomplete, but as time goes
33 on, that hopefully will change
35 See file:../../doc/BookOfTheRuntime/JIT/JIT%20Design.doc for details on the JIT compiler. See
36 code:EEStartup#TableOfContents for information on the runtime as a whole.
38 -------------------------------------------------------------------------------
41 The tokens in IL stream needs to be resolved to EE handles (CORINFO_CLASS/METHOD/FIELD_HANDLE) that
42 the runtime operates with. ICorStaticInfo::resolveToken is the method that resolves the found in IL stream
43 to set of EE handles (CORINFO_RESOLVED_TOKEN). All other APIs take resolved token as input. This design
44 avoids redundant token resolutions.
46 The token validation is done as part of token resolution. The JIT is not required to do explicit upfront
49 -------------------------------------------------------------------------------
52 First of all class contruction comes in two flavors precise and 'beforeFieldInit'. In C# you get the former
53 if you declare an explicit class constructor method and the later if you declaratively initialize static
54 fields. Precise class construction guarentees that the .cctor is run precisely before the first access to any
55 method or field of the class. 'beforeFieldInit' semantics guarentees only that the .cctor will be run some
56 time before the first static field access (note that calling methods (static or insance) or accessing
57 instance fields does not cause .cctors to be run).
59 Next you need to know that there are two kinds of code generation that can happen in the JIT: appdomain
60 neutral and appdomain specialized. The difference between these two kinds of code is how statics are handled.
61 For appdomain specific code, the address of a particular static variable is embeded in the code. This makes
62 it usable only for one appdomain (since every appdomain gets a own copy of its statics). Appdomain neutral
63 code calls a helper that looks up static variables off of a thread local variable. Thus the same code can be
64 used by mulitple appdomains in the same process.
66 Generics also introduce a similar issue. Code for generic classes might be specialised for a particular set
67 of type arguments, or it could use helpers to access data that depends on type parameters and thus be shared
68 across several instantiations of the generic type.
72 * BeforeFieldInitCCtor - Unshared code. Cctors are only called when static fields are fetched. At the
73 time the method that touches the static field is JITed (or fixed up in the case of NGENed code), the
75 * BeforeFieldInitCCtor - Shared code. Since the same code is used for multiple classes, the act of JITing
76 the code can not be used as a hook. However, it is also the case that since the code is shared, it
77 can not wire in a particular address for the static and thus needs to use a helper that looks up the
78 correct address based on the thread ID. This helper does the .cctor check, and thus no additional
79 cctor logic is needed.
80 * PreciseCCtor - Unshared code. Any time a method is JITTed (or fixed up in the case of NGEN), a cctor
81 check for the class of the method being JITTed is done. In addition the JIT inserts explicit checks
82 before any static field accesses. Instance methods and fields do NOT have hooks because a .ctor
83 method must be called before the instance can be created.
84 * PreciseCctor - Shared code .cctor checks are placed in the prolog of every .ctor and static method. All
85 methods that access static fields have an explicit .cctor check before use. Again instance methods
86 don't have hooks because a .ctor would have to be called first.
88 Technically speaking, however the optimization of avoiding checks on instance methods is flawed. It requires
89 that a .ctor always preceed a call to an instance methods. This break down when
91 * A NULL is passed to an instance method.
92 * A .ctor does not call its superclasses .ctor. This allows an instance to be created without necessarily
93 calling all the .cctors of all the superclasses. A virtual call can then be made to a instance of a
94 superclass without necessarily calling the superclass's .cctor.
95 * The class is a value class (which exists without a .ctor being called)
97 Nevertheless, the cost of plugging these holes is considered to high and the benefit is low.
99 ----------------------------------------------------------------------
101 #ClassConstructionFlags
103 Thus the JIT's cctor responsibilities require it to check with the EE on every static field access using
104 initClass and before jitting any method to see if a .cctor check must be placed in the prolog.
106 * CORINFO_FLG_BEFOREFIELDINIT indicate the class has beforeFieldInit semantics. The jit does not strictly
107 need this information however, it is valuable in optimizing static field fetch helper calls. Helper
108 call for classes with BeforeFieldInit semantics can be hoisted before other side effects where
109 classes with precise .cctor semantics do not allow this optimization.
111 Inlining also complicates things. Because the class could have precise semantics it is also required that the
112 inlining of any constructor or static method must also do the initClass check. The inliner has the option of
113 inserting any required runtime check or simply not inlining the function.
115 -------------------------------------------------------------------------------
119 The first 4 options are mutially exclusive
121 * CORINFO_FLG_HELPER If the field has this set, then the JIT must call getFieldHelper and call the
122 returned helper with the object ref (for an instance field) and a fieldDesc. Note that this should be
123 able to handle ANY field so to get a JIT up quickly, it has the option of using helper calls for all
124 field access (and skip the complexity below). Note that for statics it is assumed that you will
125 alwasy ask for the ADDRESSS helper and to the fetch in the JIT.
127 * CORINFO_FLG_SHARED_HELPER This is currently only used for static fields. If this bit is set it means
128 that the field is feched by a helper call that takes a module identifier (see getModuleDomainID) and
129 a class identifier (see getClassDomainID) as arguments. The exact helper to call is determined by
130 getSharedStaticBaseHelper. The return value is of this function is the base of all statics in the
131 module. The offset from getFieldOffset must be added to this value to get the address of the field
132 itself. (see also CORINFO_FLG_STATIC_IN_HEAP).
135 * CORINFO_FLG_GENERICS_STATIC This is currently only used for static fields (of generic type). This
136 function is intended to be called with a Generic handle as a argument (from embedGenericHandle). The
137 exact helper to call is determined by getSharedStaticBaseHelper. The returned value is the base of
138 all statics in the class. The offset from getFieldOffset must be added to this value to get the
139 address of the (see also CORINFO_FLG_STATIC_IN_HEAP).
141 * CORINFO_FLG_TLS This indicate that the static field is a Windows style Thread Local Static. (We also
142 have managed thread local statics, which work through the HELPER. Support for this is considered
143 legacy, and going forward, the EE should
145 * <NONE> This is a normal static field. Its address in in memory is determined by getFieldAddress. (see
146 also CORINFO_FLG_STATIC_IN_HEAP).
149 This last field can modify any of the cases above except CORINFO_FLG_HELPER
151 CORINFO_FLG_STATIC_IN_HEAP This is currently only used for static fields of value classes. If the field has
152 this set then after computing what would normally be the field, what you actually get is a object pointer
153 (that must be reported to the GC) to a boxed version of the value. Thus the actual field address is computed
154 by addr = (*addr+sizeof(OBJECTREF))
158 * CORINFO_FLG_HELPER This is used if the class is MarshalByRef, which means that the object might be a
159 proxyt to the real object in some other appdomain or process. If the field has this set, then the JIT
160 must call getFieldHelper and call the returned helper with the object ref. If the helper returned is
161 helpers that are for structures the args are as follows
163 * CORINFO_HELP_GETFIELDSTRUCT - args are: retBuff, object, fieldDesc
164 * CORINFO_HELP_SETFIELDSTRUCT - args are object fieldDesc value
166 The other GET helpers take an object fieldDesc and return the value The other SET helpers take an object
169 Note that unlike static fields there is no helper to take the address of a field because in general there
170 is no address for proxies (LDFLDA is illegal on proxies).
172 CORINFO_FLG_EnC This is to support adding new field for edit and continue. This field also indicates that
173 a helper is needed to access this field. However this helper is always CORINFO_HELP_GETFIELDADDR, and
174 this helper always takes the object and field handle and returns the address of the field. It is the
175 JIT's responcibility to do the fetch or set.
177 -------------------------------------------------------------------------------
179 TODO: Talk about initializing strutures before use
182 *******************************************************************************
189 #include <specstrings.h>
191 //////////////////////////////////////////////////////////////////////////////////////////////////////////
193 // NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE
195 // #JITEEVersionIdentifier
197 // This GUID represents the version of the JIT/EE interface. Any time the interface between the JIT and
198 // the EE changes (by adding or removing methods to any interface shared between them), this GUID should
199 // be changed. This is the identifier verified by ICorJitCompiler::getVersionIdentifier().
201 // You can use "uuidgen.exe -s" to generate this value.
203 // **** NOTE TO INTEGRATORS:
205 // If there is a merge conflict here, because the version changed in two different places, you must
206 // create a **NEW** GUID, not simply choose one or the other!
208 // NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE
210 //////////////////////////////////////////////////////////////////////////////////////////////////////////
212 #if !defined(SELECTANY)
213 #define SELECTANY extern __declspec(selectany)
216 SELECTANY const GUID JITEEVersionIdentifier = { /* 45aafd4d-1d23-4647-9ce1-cf09a2677ca0 */
220 {0x9c, 0xe1, 0xcf, 0x09, 0xa2, 0x67, 0x7c, 0xa0}
223 //////////////////////////////////////////////////////////////////////////////////////////////////////////
225 // END JITEEVersionIdentifier
227 //////////////////////////////////////////////////////////////////////////////////////////////////////////
229 // For System V on the CLR type system number of registers to pass in and return a struct is the same.
230 // The CLR type system allows only up to 2 eightbytes to be passed in registers. There is no SSEUP classification types.
231 #define CLR_SYSTEMV_MAX_EIGHTBYTES_COUNT_TO_PASS_IN_REGISTERS 2
232 #define CLR_SYSTEMV_MAX_EIGHTBYTES_COUNT_TO_RETURN_IN_REGISTERS 2
233 #define CLR_SYSTEMV_MAX_STRUCT_BYTES_TO_PASS_IN_REGISTERS 16
235 // System V struct passing
236 // The Classification types are described in the ABI spec at http://www.x86-64.org/documentation/abi.pdf
237 enum SystemVClassificationType : unsigned __int8
239 SystemVClassificationTypeUnknown = 0,
240 SystemVClassificationTypeStruct = 1,
241 SystemVClassificationTypeNoClass = 2,
242 SystemVClassificationTypeMemory = 3,
243 SystemVClassificationTypeInteger = 4,
244 SystemVClassificationTypeIntegerReference = 5,
245 SystemVClassificationTypeIntegerByRef = 6,
246 SystemVClassificationTypeSSE = 7,
247 // SystemVClassificationTypeSSEUp = Unused, // Not supported by the CLR.
248 // SystemVClassificationTypeX87 = Unused, // Not supported by the CLR.
249 // SystemVClassificationTypeX87Up = Unused, // Not supported by the CLR.
250 // SystemVClassificationTypeComplexX87 = Unused, // Not supported by the CLR.
252 // Internal flags - never returned outside of the classification implementation.
254 // This value represents a very special type with two eightbytes.
255 // First ByRef, second Integer (platform int).
256 // The VM has a special Elem type for this type - ELEMENT_TYPE_TYPEDBYREF.
257 // This is the classification counterpart for that element type. It is used to detect
258 // the special TypedReference type and specialize its classification.
259 // This type is represented as a struct with two fields. The classification needs to do
260 // special handling of it since the source/methadata type of the fieds is IntPtr.
261 // The VM changes the first to ByRef. The second is left as IntPtr (TYP_I_IMPL really). The classification needs to match this and
262 // special handling is warranted (similar thing is done in the getGCLayout function for this type).
263 SystemVClassificationTypeTypedReference = 8,
264 SystemVClassificationTypeMAX = 9,
267 // Represents classification information for a struct.
268 struct SYSTEMV_AMD64_CORINFO_STRUCT_REG_PASSING_DESCRIPTOR
270 SYSTEMV_AMD64_CORINFO_STRUCT_REG_PASSING_DESCRIPTOR()
275 bool passedInRegisters; // Whether the struct is passable/passed (this includes struct returning) in registers.
276 unsigned __int8 eightByteCount; // Number of eightbytes for this struct.
277 SystemVClassificationType eightByteClassifications[CLR_SYSTEMV_MAX_EIGHTBYTES_COUNT_TO_PASS_IN_REGISTERS]; // The eightbytes type classification.
278 unsigned __int8 eightByteSizes[CLR_SYSTEMV_MAX_EIGHTBYTES_COUNT_TO_PASS_IN_REGISTERS]; // The size of the eightbytes (an eightbyte could include padding. This represents the no padding size of the eightbyte).
279 unsigned __int8 eightByteOffsets[CLR_SYSTEMV_MAX_EIGHTBYTES_COUNT_TO_PASS_IN_REGISTERS]; // The start offset of the eightbytes (in bytes).
283 //------------------------------------------------------------------------
284 // CopyFrom: Copies a struct classification into this one.
287 // 'copyFrom' the struct classification to copy from.
289 void CopyFrom(const SYSTEMV_AMD64_CORINFO_STRUCT_REG_PASSING_DESCRIPTOR& copyFrom)
291 passedInRegisters = copyFrom.passedInRegisters;
292 eightByteCount = copyFrom.eightByteCount;
294 for (int i = 0; i < CLR_SYSTEMV_MAX_EIGHTBYTES_COUNT_TO_PASS_IN_REGISTERS; i++)
296 eightByteClassifications[i] = copyFrom.eightByteClassifications[i];
297 eightByteSizes[i] = copyFrom.eightByteSizes[i];
298 eightByteOffsets[i] = copyFrom.eightByteOffsets[i];
302 //------------------------------------------------------------------------
303 // IsIntegralSlot: Returns whether the eightbyte at slotIndex is of integral type.
306 // 'slotIndex' the slot number we are determining if it is of integral type.
309 // returns true if we the eightbyte at index slotIndex is of integral type.
312 bool IsIntegralSlot(unsigned slotIndex) const
314 return ((eightByteClassifications[slotIndex] == SystemVClassificationTypeInteger) ||
315 (eightByteClassifications[slotIndex] == SystemVClassificationTypeIntegerReference) ||
316 (eightByteClassifications[slotIndex] == SystemVClassificationTypeIntegerByRef));
319 //------------------------------------------------------------------------
320 // IsSseSlot: Returns whether the eightbyte at slotIndex is SSE type.
323 // 'slotIndex' the slot number we are determining if it is of SSE type.
326 // returns true if we the eightbyte at index slotIndex is of SSE type.
328 // Follows the rules of the AMD64 System V ABI specification at www.x86-64.org/documentation/abi.pdf.
329 // Please reffer to it for definitions/examples.
331 bool IsSseSlot(unsigned slotIndex) const
333 return (eightByteClassifications[slotIndex] == SystemVClassificationTypeSSE);
339 passedInRegisters = false;
342 for (int i = 0; i < CLR_SYSTEMV_MAX_EIGHTBYTES_COUNT_TO_PASS_IN_REGISTERS; i++)
344 eightByteClassifications[i] = SystemVClassificationTypeUnknown;
345 eightByteSizes[i] = 0;
346 eightByteOffsets[i] = 0;
351 // CorInfoHelpFunc defines the set of helpers (accessed via the ICorDynamicInfo::getHelperFtn())
352 // These helpers can be called by native code which executes in the runtime.
353 // Compilers can emit calls to these helpers.
355 // The signatures of the helpers are below (see RuntimeHelperArgumentCheck)
359 CORINFO_HELP_UNDEF, // invalid value. This should never be used
361 /* Arithmetic helpers */
363 CORINFO_HELP_DIV, // For the ARM 32-bit integer divide uses a helper call :-(
372 CORINFO_HELP_LMUL_OVF,
373 CORINFO_HELP_ULMUL_OVF,
378 CORINFO_HELP_LNG2DBL, // Convert a signed int64 to a double
379 CORINFO_HELP_ULNG2DBL, // Convert a unsigned int64 to a double
380 CORINFO_HELP_DBL2INT,
381 CORINFO_HELP_DBL2INT_OVF,
382 CORINFO_HELP_DBL2LNG,
383 CORINFO_HELP_DBL2LNG_OVF,
384 CORINFO_HELP_DBL2UINT,
385 CORINFO_HELP_DBL2UINT_OVF,
386 CORINFO_HELP_DBL2ULNG,
387 CORINFO_HELP_DBL2ULNG_OVF,
390 CORINFO_HELP_FLTROUND,
391 CORINFO_HELP_DBLROUND,
393 /* Allocating a new object. Always use ICorClassInfo::getNewHelper() to decide
394 which is the right helper to use to allocate an object of a given type. */
396 CORINFO_HELP_NEW_CROSSCONTEXT, // cross context new object
397 CORINFO_HELP_NEWFAST,
398 CORINFO_HELP_NEWSFAST, // allocator for small, non-finalizer, non-array object
399 CORINFO_HELP_NEWSFAST_ALIGN8, // allocator for small, non-finalizer, non-array object, 8 byte aligned
400 CORINFO_HELP_NEW_MDARR, // multi-dim array helper (with or without lower bounds - dimensions passed in as vararg)
401 CORINFO_HELP_NEW_MDARR_NONVARARG,// multi-dim array helper (with or without lower bounds - dimensions passed in as unmanaged array)
402 CORINFO_HELP_NEWARR_1_DIRECT, // helper for any one dimensional array creation
403 CORINFO_HELP_NEWARR_1_R2R_DIRECT, // wrapper for R2R direct call, which extracts method table from ArrayTypeDesc
404 CORINFO_HELP_NEWARR_1_OBJ, // optimized 1-D object arrays
405 CORINFO_HELP_NEWARR_1_VC, // optimized 1-D value class arrays
406 CORINFO_HELP_NEWARR_1_ALIGN8, // like VC, but aligns the array start
408 CORINFO_HELP_STRCNS, // create a new string literal
409 CORINFO_HELP_STRCNS_CURRENT_MODULE, // create a new string literal from the current module (used by NGen code)
413 CORINFO_HELP_INITCLASS, // Initialize class if not already initialized
414 CORINFO_HELP_INITINSTCLASS, // Initialize class for instantiated type
416 // Use ICorClassInfo::getCastingHelper to determine
417 // the right helper to use
419 CORINFO_HELP_ISINSTANCEOFINTERFACE, // Optimized helper for interfaces
420 CORINFO_HELP_ISINSTANCEOFARRAY, // Optimized helper for arrays
421 CORINFO_HELP_ISINSTANCEOFCLASS, // Optimized helper for classes
422 CORINFO_HELP_ISINSTANCEOFANY, // Slow helper for any type
424 CORINFO_HELP_CHKCASTINTERFACE,
425 CORINFO_HELP_CHKCASTARRAY,
426 CORINFO_HELP_CHKCASTCLASS,
427 CORINFO_HELP_CHKCASTANY,
428 CORINFO_HELP_CHKCASTCLASS_SPECIAL, // Optimized helper for classes. Assumes that the trivial cases
429 // has been taken care of by the inlined check
432 CORINFO_HELP_BOX_NULLABLE, // special form of boxing for Nullable<T>
434 CORINFO_HELP_UNBOX_NULLABLE, // special form of unboxing for Nullable<T>
435 CORINFO_HELP_GETREFANY, // Extract the byref from a TypedReference, checking that it is the expected type
437 CORINFO_HELP_ARRADDR_ST, // assign to element of object array with type-checking
438 CORINFO_HELP_LDELEMA_REF, // does a precise type comparision and returns address
442 CORINFO_HELP_THROW, // Throw an exception object
443 CORINFO_HELP_RETHROW, // Rethrow the currently active exception
444 CORINFO_HELP_USER_BREAKPOINT, // For a user program to break to the debugger
445 CORINFO_HELP_RNGCHKFAIL, // array bounds check failed
446 CORINFO_HELP_OVERFLOW, // throw an overflow exception
447 CORINFO_HELP_THROWDIVZERO, // throw a divide by zero exception
448 CORINFO_HELP_THROWNULLREF, // throw a null reference exception
450 CORINFO_HELP_INTERNALTHROW, // Support for really fast jit
451 CORINFO_HELP_VERIFICATION, // Throw a VerificationException
452 CORINFO_HELP_SEC_UNMGDCODE_EXCPT, // throw a security unmanaged code exception
453 CORINFO_HELP_FAIL_FAST, // Kill the process avoiding any exceptions or stack and data dependencies (use for GuardStack unsafe buffer checks)
455 CORINFO_HELP_METHOD_ACCESS_EXCEPTION,//Throw an access exception due to a failed member/class access check.
456 CORINFO_HELP_FIELD_ACCESS_EXCEPTION,
457 CORINFO_HELP_CLASS_ACCESS_EXCEPTION,
459 CORINFO_HELP_ENDCATCH, // call back into the EE at the end of a catch block
461 /* Synchronization */
463 CORINFO_HELP_MON_ENTER,
464 CORINFO_HELP_MON_EXIT,
465 CORINFO_HELP_MON_ENTER_STATIC,
466 CORINFO_HELP_MON_EXIT_STATIC,
468 CORINFO_HELP_GETCLASSFROMMETHODPARAM, // Given a generics method handle, returns a class handle
469 CORINFO_HELP_GETSYNCFROMCLASSHANDLE, // Given a generics class handle, returns the sync monitor
470 // in its ManagedClassObject
472 /* Security callout support */
474 CORINFO_HELP_SECURITY_PROLOG, // Required if CORINFO_FLG_SECURITYCHECK is set, or CORINFO_FLG_NOSECURITYWRAP is not set
475 CORINFO_HELP_SECURITY_PROLOG_FRAMED, // Slow version of CORINFO_HELP_SECURITY_PROLOG. Used for instrumentation.
477 CORINFO_HELP_METHOD_ACCESS_CHECK, // Callouts to runtime security access checks
478 CORINFO_HELP_FIELD_ACCESS_CHECK,
479 CORINFO_HELP_CLASS_ACCESS_CHECK,
481 CORINFO_HELP_DELEGATE_SECURITY_CHECK, // Callout to delegate security transparency check
483 /* Verification runtime callout support */
485 CORINFO_HELP_VERIFICATION_RUNTIME_CHECK, // Do a Demand for UnmanagedCode permission at runtime
489 CORINFO_HELP_STOP_FOR_GC, // Call GC (force a GC)
490 CORINFO_HELP_POLL_GC, // Ask GC if it wants to collect
492 CORINFO_HELP_STRESS_GC, // Force a GC, but then update the JITTED code to be a noop call
493 CORINFO_HELP_CHECK_OBJ, // confirm that ECX is a valid object pointer (debugging only)
495 /* GC Write barrier support */
497 CORINFO_HELP_ASSIGN_REF, // universal helpers with F_CALL_CONV calling convention
498 CORINFO_HELP_CHECKED_ASSIGN_REF,
499 CORINFO_HELP_ASSIGN_REF_ENSURE_NONHEAP, // Do the store, and ensure that the target was not in the heap.
501 CORINFO_HELP_ASSIGN_BYREF,
502 CORINFO_HELP_ASSIGN_STRUCT,
505 /* Accessing fields */
507 // For COM object support (using COM get/set routines to update object)
508 // and EnC and cross-context support
509 CORINFO_HELP_GETFIELD8,
510 CORINFO_HELP_SETFIELD8,
511 CORINFO_HELP_GETFIELD16,
512 CORINFO_HELP_SETFIELD16,
513 CORINFO_HELP_GETFIELD32,
514 CORINFO_HELP_SETFIELD32,
515 CORINFO_HELP_GETFIELD64,
516 CORINFO_HELP_SETFIELD64,
517 CORINFO_HELP_GETFIELDOBJ,
518 CORINFO_HELP_SETFIELDOBJ,
519 CORINFO_HELP_GETFIELDSTRUCT,
520 CORINFO_HELP_SETFIELDSTRUCT,
521 CORINFO_HELP_GETFIELDFLOAT,
522 CORINFO_HELP_SETFIELDFLOAT,
523 CORINFO_HELP_GETFIELDDOUBLE,
524 CORINFO_HELP_SETFIELDDOUBLE,
526 CORINFO_HELP_GETFIELDADDR,
528 CORINFO_HELP_GETSTATICFIELDADDR_CONTEXT, // Helper for context-static fields
529 CORINFO_HELP_GETSTATICFIELDADDR_TLS, // Helper for PE TLS fields
531 // There are a variety of specialized helpers for accessing static fields. The JIT should use
532 // ICorClassInfo::getSharedStaticsOrCCtorHelper to determine which helper to use
534 // Helpers for regular statics
535 CORINFO_HELP_GETGENERICS_GCSTATIC_BASE,
536 CORINFO_HELP_GETGENERICS_NONGCSTATIC_BASE,
537 CORINFO_HELP_GETSHARED_GCSTATIC_BASE,
538 CORINFO_HELP_GETSHARED_NONGCSTATIC_BASE,
539 CORINFO_HELP_GETSHARED_GCSTATIC_BASE_NOCTOR,
540 CORINFO_HELP_GETSHARED_NONGCSTATIC_BASE_NOCTOR,
541 CORINFO_HELP_GETSHARED_GCSTATIC_BASE_DYNAMICCLASS,
542 CORINFO_HELP_GETSHARED_NONGCSTATIC_BASE_DYNAMICCLASS,
543 // Helper to class initialize shared generic with dynamicclass, but not get static field address
544 CORINFO_HELP_CLASSINIT_SHARED_DYNAMICCLASS,
546 // Helpers for thread statics
547 CORINFO_HELP_GETGENERICS_GCTHREADSTATIC_BASE,
548 CORINFO_HELP_GETGENERICS_NONGCTHREADSTATIC_BASE,
549 CORINFO_HELP_GETSHARED_GCTHREADSTATIC_BASE,
550 CORINFO_HELP_GETSHARED_NONGCTHREADSTATIC_BASE,
551 CORINFO_HELP_GETSHARED_GCTHREADSTATIC_BASE_NOCTOR,
552 CORINFO_HELP_GETSHARED_NONGCTHREADSTATIC_BASE_NOCTOR,
553 CORINFO_HELP_GETSHARED_GCTHREADSTATIC_BASE_DYNAMICCLASS,
554 CORINFO_HELP_GETSHARED_NONGCTHREADSTATIC_BASE_DYNAMICCLASS,
558 CORINFO_HELP_DBG_IS_JUST_MY_CODE, // Check if this is "JustMyCode" and needs to be stepped through.
560 /* Profiling enter/leave probe addresses */
561 CORINFO_HELP_PROF_FCN_ENTER, // record the entry to a method (caller)
562 CORINFO_HELP_PROF_FCN_LEAVE, // record the completion of current method (caller)
563 CORINFO_HELP_PROF_FCN_TAILCALL, // record the completionof current method through tailcall (caller)
567 CORINFO_HELP_BBT_FCN_ENTER, // record the entry to a method for collecting Tuning data
569 CORINFO_HELP_PINVOKE_CALLI, // Indirect pinvoke call
570 CORINFO_HELP_TAILCALL, // Perform a tail call
572 CORINFO_HELP_GETCURRENTMANAGEDTHREADID,
574 CORINFO_HELP_INIT_PINVOKE_FRAME, // initialize an inlined PInvoke Frame for the JIT-compiler
576 CORINFO_HELP_MEMSET, // Init block of memory
577 CORINFO_HELP_MEMCPY, // Copy block of memory
579 CORINFO_HELP_RUNTIMEHANDLE_METHOD, // determine a type/field/method handle at run-time
580 CORINFO_HELP_RUNTIMEHANDLE_METHOD_LOG, // determine a type/field/method handle at run-time, with IBC logging
581 CORINFO_HELP_RUNTIMEHANDLE_CLASS, // determine a type/field/method handle at run-time
582 CORINFO_HELP_RUNTIMEHANDLE_CLASS_LOG, // determine a type/field/method handle at run-time, with IBC logging
584 // These helpers are required for MDIL backward compatibility only. They are not used by current JITed code.
585 CORINFO_HELP_TYPEHANDLE_TO_RUNTIMETYPEHANDLE_OBSOLETE, // Convert from a TypeHandle (native structure pointer) to RuntimeTypeHandle at run-time
586 CORINFO_HELP_METHODDESC_TO_RUNTIMEMETHODHANDLE_OBSOLETE, // Convert from a MethodDesc (native structure pointer) to RuntimeMethodHandle at run-time
587 CORINFO_HELP_FIELDDESC_TO_RUNTIMEFIELDHANDLE_OBSOLETE, // Convert from a FieldDesc (native structure pointer) to RuntimeFieldHandle at run-time
589 CORINFO_HELP_TYPEHANDLE_TO_RUNTIMETYPE, // Convert from a TypeHandle (native structure pointer) to RuntimeType at run-time
590 CORINFO_HELP_TYPEHANDLE_TO_RUNTIMETYPE_MAYBENULL, // Convert from a TypeHandle (native structure pointer) to RuntimeType at run-time, the type may be null
591 CORINFO_HELP_METHODDESC_TO_STUBRUNTIMEMETHOD, // Convert from a MethodDesc (native structure pointer) to RuntimeMethodHandle at run-time
592 CORINFO_HELP_FIELDDESC_TO_STUBRUNTIMEFIELD, // Convert from a FieldDesc (native structure pointer) to RuntimeFieldHandle at run-time
594 CORINFO_HELP_VIRTUAL_FUNC_PTR, // look up a virtual method at run-time
595 //CORINFO_HELP_VIRTUAL_FUNC_PTR_LOG, // look up a virtual method at run-time, with IBC logging
597 // Not a real helpers. Instead of taking handle arguments, these helpers point to a small stub that loads the handle argument and calls the static helper.
598 CORINFO_HELP_READYTORUN_NEW,
599 CORINFO_HELP_READYTORUN_NEWARR_1,
600 CORINFO_HELP_READYTORUN_ISINSTANCEOF,
601 CORINFO_HELP_READYTORUN_CHKCAST,
602 CORINFO_HELP_READYTORUN_STATIC_BASE,
603 CORINFO_HELP_READYTORUN_VIRTUAL_FUNC_PTR,
604 CORINFO_HELP_READYTORUN_GENERIC_HANDLE,
605 CORINFO_HELP_READYTORUN_DELEGATE_CTOR,
606 CORINFO_HELP_READYTORUN_GENERIC_STATIC_BASE,
608 CORINFO_HELP_EE_PRESTUB, // Not real JIT helper. Used in native images.
610 CORINFO_HELP_EE_PRECODE_FIXUP, // Not real JIT helper. Used for Precode fixup in native images.
611 CORINFO_HELP_EE_PINVOKE_FIXUP, // Not real JIT helper. Used for PInvoke target fixup in native images.
612 CORINFO_HELP_EE_VSD_FIXUP, // Not real JIT helper. Used for VSD cell fixup in native images.
613 CORINFO_HELP_EE_EXTERNAL_FIXUP, // Not real JIT helper. Used for to fixup external method thunks in native images.
614 CORINFO_HELP_EE_VTABLE_FIXUP, // Not real JIT helper. Used for inherited vtable slot fixup in native images.
616 CORINFO_HELP_EE_REMOTING_THUNK, // Not real JIT helper. Used for remoting precode in native images.
618 CORINFO_HELP_EE_PERSONALITY_ROUTINE,// Not real JIT helper. Used in native images.
619 CORINFO_HELP_EE_PERSONALITY_ROUTINE_FILTER_FUNCLET,// Not real JIT helper. Used in native images to detect filter funclets.
621 // ASSIGN_REF_EAX - CHECKED_ASSIGN_REF_EBP: NOGC_WRITE_BARRIERS JIT helper calls
623 // For unchecked versions EDX is required to point into GC heap.
625 // NOTE: these helpers are only used for x86.
626 CORINFO_HELP_ASSIGN_REF_EAX, // EAX holds GC ptr, do a 'mov [EDX], EAX' and inform GC
627 CORINFO_HELP_ASSIGN_REF_EBX, // EBX holds GC ptr, do a 'mov [EDX], EBX' and inform GC
628 CORINFO_HELP_ASSIGN_REF_ECX, // ECX holds GC ptr, do a 'mov [EDX], ECX' and inform GC
629 CORINFO_HELP_ASSIGN_REF_ESI, // ESI holds GC ptr, do a 'mov [EDX], ESI' and inform GC
630 CORINFO_HELP_ASSIGN_REF_EDI, // EDI holds GC ptr, do a 'mov [EDX], EDI' and inform GC
631 CORINFO_HELP_ASSIGN_REF_EBP, // EBP holds GC ptr, do a 'mov [EDX], EBP' and inform GC
633 CORINFO_HELP_CHECKED_ASSIGN_REF_EAX, // These are the same as ASSIGN_REF above ...
634 CORINFO_HELP_CHECKED_ASSIGN_REF_EBX, // ... but also check if EDX points into heap.
635 CORINFO_HELP_CHECKED_ASSIGN_REF_ECX,
636 CORINFO_HELP_CHECKED_ASSIGN_REF_ESI,
637 CORINFO_HELP_CHECKED_ASSIGN_REF_EDI,
638 CORINFO_HELP_CHECKED_ASSIGN_REF_EBP,
640 CORINFO_HELP_LOOP_CLONE_CHOICE_ADDR, // Return the reference to a counter to decide to take cloned path in debug stress.
641 CORINFO_HELP_DEBUG_LOG_LOOP_CLONING, // Print a message that a loop cloning optimization has occurred in debug mode.
643 CORINFO_HELP_THROW_ARGUMENTEXCEPTION, // throw ArgumentException
644 CORINFO_HELP_THROW_ARGUMENTOUTOFRANGEEXCEPTION, // throw ArgumentOutOfRangeException
645 CORINFO_HELP_THROW_PLATFORM_NOT_SUPPORTED, // throw PlatformNotSupportedException
646 CORINFO_HELP_THROW_TYPE_NOT_SUPPORTED, // throw TypeNotSupportedException
648 CORINFO_HELP_JIT_PINVOKE_BEGIN, // Transition to preemptive mode before a P/Invoke, frame is the first argument
649 CORINFO_HELP_JIT_PINVOKE_END, // Transition to cooperative mode after a P/Invoke, frame is the first argument
651 CORINFO_HELP_JIT_REVERSE_PINVOKE_ENTER, // Transition to cooperative mode in reverse P/Invoke prolog, frame is the first argument
652 CORINFO_HELP_JIT_REVERSE_PINVOKE_EXIT, // Transition to preemptive mode in reverse P/Invoke epilog, frame is the first argument
654 CORINFO_HELP_GVMLOOKUP_FOR_SLOT, // Resolve a generic virtual method target from this pointer and runtime method handle
659 #define CORINFO_HELP_READYTORUN_ATYPICAL_CALLSITE 0x40000000
661 //This describes the signature for a helper method.
664 CORINFO_HELP_SIG_UNDEF,
665 CORINFO_HELP_SIG_NO_ALIGN_STUB,
666 CORINFO_HELP_SIG_NO_UNWIND_STUB,
667 CORINFO_HELP_SIG_REG_ONLY,
668 CORINFO_HELP_SIG_4_STACK,
669 CORINFO_HELP_SIG_8_STACK,
670 CORINFO_HELP_SIG_12_STACK,
671 CORINFO_HELP_SIG_16_STACK,
672 CORINFO_HELP_SIG_8_VA, //2 arguments plus varargs
674 CORINFO_HELP_SIG_EBPCALL, //special calling convention that uses EDX and
677 CORINFO_HELP_SIG_CANNOT_USE_ALIGN_STUB,
679 CORINFO_HELP_SIG_COUNT
682 // The enumeration is returned in 'getSig','getType', getArgType methods
685 CORINFO_TYPE_UNDEF = 0x0,
686 CORINFO_TYPE_VOID = 0x1,
687 CORINFO_TYPE_BOOL = 0x2,
688 CORINFO_TYPE_CHAR = 0x3,
689 CORINFO_TYPE_BYTE = 0x4,
690 CORINFO_TYPE_UBYTE = 0x5,
691 CORINFO_TYPE_SHORT = 0x6,
692 CORINFO_TYPE_USHORT = 0x7,
693 CORINFO_TYPE_INT = 0x8,
694 CORINFO_TYPE_UINT = 0x9,
695 CORINFO_TYPE_LONG = 0xa,
696 CORINFO_TYPE_ULONG = 0xb,
697 CORINFO_TYPE_NATIVEINT = 0xc,
698 CORINFO_TYPE_NATIVEUINT = 0xd,
699 CORINFO_TYPE_FLOAT = 0xe,
700 CORINFO_TYPE_DOUBLE = 0xf,
701 CORINFO_TYPE_STRING = 0x10, // Not used, should remove
702 CORINFO_TYPE_PTR = 0x11,
703 CORINFO_TYPE_BYREF = 0x12,
704 CORINFO_TYPE_VALUECLASS = 0x13,
705 CORINFO_TYPE_CLASS = 0x14,
706 CORINFO_TYPE_REFANY = 0x15,
708 // CORINFO_TYPE_VAR is for a generic type variable.
709 // Generic type variables only appear when the JIT is doing
710 // verification (not NOT compilation) of generic code
711 // for the EE, in which case we're running
712 // the JIT in "import only" mode.
714 CORINFO_TYPE_VAR = 0x16,
715 CORINFO_TYPE_COUNT, // number of jit types
718 enum CorInfoTypeWithMod
720 CORINFO_TYPE_MASK = 0x3F, // lower 6 bits are type mask
721 CORINFO_TYPE_MOD_PINNED = 0x40, // can be applied to CLASS, or BYREF to indiate pinned
724 inline CorInfoType strip(CorInfoTypeWithMod val) {
725 return CorInfoType(val & CORINFO_TYPE_MASK);
728 // The enumeration is returned in 'getSig'
732 // These correspond to CorCallingConvention
734 CORINFO_CALLCONV_DEFAULT = 0x0,
735 CORINFO_CALLCONV_C = 0x1,
736 CORINFO_CALLCONV_STDCALL = 0x2,
737 CORINFO_CALLCONV_THISCALL = 0x3,
738 CORINFO_CALLCONV_FASTCALL = 0x4,
739 CORINFO_CALLCONV_VARARG = 0x5,
740 CORINFO_CALLCONV_FIELD = 0x6,
741 CORINFO_CALLCONV_LOCAL_SIG = 0x7,
742 CORINFO_CALLCONV_PROPERTY = 0x8,
743 CORINFO_CALLCONV_NATIVEVARARG = 0xb, // used ONLY for IL stub PInvoke vararg calls
745 CORINFO_CALLCONV_MASK = 0x0f, // Calling convention is bottom 4 bits
746 CORINFO_CALLCONV_GENERIC = 0x10,
747 CORINFO_CALLCONV_HASTHIS = 0x20,
748 CORINFO_CALLCONV_EXPLICITTHIS=0x40,
749 CORINFO_CALLCONV_PARAMTYPE = 0x80, // Passed last. Same as CORINFO_GENERICS_CTXT_FROM_PARAMTYPEARG
753 inline bool IsCallerPop(CorInfoCallConv callConv)
755 unsigned int umask = CORINFO_CALLCONV_STDCALL
756 | CORINFO_CALLCONV_THISCALL
757 | CORINFO_CALLCONV_FASTCALL;
759 return !(callConv & umask);
761 #endif // UNIX_X86_ABI
763 enum CorInfoUnmanagedCallConv
765 // These correspond to CorUnmanagedCallingConvention
767 CORINFO_UNMANAGED_CALLCONV_UNKNOWN,
768 CORINFO_UNMANAGED_CALLCONV_C,
769 CORINFO_UNMANAGED_CALLCONV_STDCALL,
770 CORINFO_UNMANAGED_CALLCONV_THISCALL,
771 CORINFO_UNMANAGED_CALLCONV_FASTCALL
774 // These are returned from getMethodOptions
777 CORINFO_OPT_INIT_LOCALS = 0x00000010, // zero initialize all variables
779 CORINFO_GENERICS_CTXT_FROM_THIS = 0x00000020, // is this shared generic code that access the generic context from the this pointer? If so, then if the method has SEH then the 'this' pointer must always be reported and kept alive.
780 CORINFO_GENERICS_CTXT_FROM_METHODDESC = 0x00000040, // is this shared generic code that access the generic context from the ParamTypeArg(that is a MethodDesc)? If so, then if the method has SEH then the 'ParamTypeArg' must always be reported and kept alive. Same as CORINFO_CALLCONV_PARAMTYPE
781 CORINFO_GENERICS_CTXT_FROM_METHODTABLE = 0x00000080, // is this shared generic code that access the generic context from the ParamTypeArg(that is a MethodTable)? If so, then if the method has SEH then the 'ParamTypeArg' must always be reported and kept alive. Same as CORINFO_CALLCONV_PARAMTYPE
782 CORINFO_GENERICS_CTXT_MASK = (CORINFO_GENERICS_CTXT_FROM_THIS |
783 CORINFO_GENERICS_CTXT_FROM_METHODDESC |
784 CORINFO_GENERICS_CTXT_FROM_METHODTABLE),
785 CORINFO_GENERICS_CTXT_KEEP_ALIVE = 0x00000100, // Keep the generics context alive throughout the method even if there is no explicit use, and report its location to the CLR
790 // what type of code region we are in
792 enum CorInfoRegionKind
801 // these are the attribute flags for fields and methods (getMethodAttribs)
804 // CORINFO_FLG_UNUSED = 0x00000001,
805 // CORINFO_FLG_UNUSED = 0x00000002,
806 CORINFO_FLG_PROTECTED = 0x00000004,
807 CORINFO_FLG_STATIC = 0x00000008,
808 CORINFO_FLG_FINAL = 0x00000010,
809 CORINFO_FLG_SYNCH = 0x00000020,
810 CORINFO_FLG_VIRTUAL = 0x00000040,
811 // CORINFO_FLG_UNUSED = 0x00000080,
812 CORINFO_FLG_NATIVE = 0x00000100,
813 CORINFO_FLG_INTRINSIC_TYPE = 0x00000200, // This type is marked by [Intrinsic]
814 CORINFO_FLG_ABSTRACT = 0x00000400,
816 CORINFO_FLG_EnC = 0x00000800, // member was added by Edit'n'Continue
818 // These are internal flags that can only be on methods
819 CORINFO_FLG_FORCEINLINE = 0x00010000, // The method should be inlined if possible.
820 CORINFO_FLG_SHAREDINST = 0x00020000, // the code for this method is shared between different generic instantiations (also set on classes/types)
821 CORINFO_FLG_DELEGATE_INVOKE = 0x00040000, // "Delegate
822 CORINFO_FLG_PINVOKE = 0x00080000, // Is a P/Invoke call
823 CORINFO_FLG_SECURITYCHECK = 0x00100000, // Is one of the security routines that does a stackwalk (e.g. Assert, Demand)
824 CORINFO_FLG_NOGCCHECK = 0x00200000, // This method is FCALL that has no GC check. Don't put alone in loops
825 CORINFO_FLG_INTRINSIC = 0x00400000, // This method MAY have an intrinsic ID
826 CORINFO_FLG_CONSTRUCTOR = 0x00800000, // This method is an instance or type initializer
827 // CORINFO_FLG_UNUSED = 0x01000000,
828 // CORINFO_FLG_UNUSED = 0x02000000,
829 CORINFO_FLG_NOSECURITYWRAP = 0x04000000, // The method requires no security checks
830 CORINFO_FLG_DONT_INLINE = 0x10000000, // The method should not be inlined
831 CORINFO_FLG_DONT_INLINE_CALLER = 0x20000000, // The method should not be inlined, nor should its callers. It cannot be tail called.
832 CORINFO_FLG_JIT_INTRINSIC = 0x40000000, // Method is a potential jit intrinsic; verify identity by name check
834 // These are internal flags that can only be on Classes
835 CORINFO_FLG_VALUECLASS = 0x00010000, // is the class a value class
836 // This flag is define din the Methods section, but is also valid on classes.
837 // CORINFO_FLG_SHAREDINST = 0x00020000, // This class is satisfies TypeHandle::IsCanonicalSubtype
838 CORINFO_FLG_VAROBJSIZE = 0x00040000, // the object size varies depending of constructor args
839 CORINFO_FLG_ARRAY = 0x00080000, // class is an array class (initialized differently)
840 CORINFO_FLG_OVERLAPPING_FIELDS = 0x00100000, // struct or class has fields that overlap (aka union)
841 CORINFO_FLG_INTERFACE = 0x00200000, // it is an interface
842 CORINFO_FLG_CONTEXTFUL = 0x00400000, // is this a contextful class?
843 CORINFO_FLG_CUSTOMLAYOUT = 0x00800000, // does this struct have custom layout?
844 CORINFO_FLG_CONTAINS_GC_PTR = 0x01000000, // does the class contain a gc ptr ?
845 CORINFO_FLG_DELEGATE = 0x02000000, // is this a subclass of delegate or multicast delegate ?
846 CORINFO_FLG_MARSHAL_BYREF = 0x04000000, // is this a subclass of MarshalByRef ?
847 CORINFO_FLG_CONTAINS_STACK_PTR = 0x08000000, // This class has a stack pointer inside it
848 CORINFO_FLG_VARIANCE = 0x10000000, // MethodTable::HasVariance (sealed does *not* mean uncast-able)
849 CORINFO_FLG_BEFOREFIELDINIT = 0x20000000, // Additional flexibility for when to run .cctor (see code:#ClassConstructionFlags)
850 CORINFO_FLG_GENERIC_TYPE_VARIABLE = 0x40000000, // This is really a handle for a variable type
851 CORINFO_FLG_UNSAFE_VALUECLASS = 0x80000000, // Unsafe (C++'s /GS) value type
854 // Flags computed by a runtime compiler
855 enum CorInfoMethodRuntimeFlags
857 CORINFO_FLG_BAD_INLINEE = 0x00000001, // The method is not suitable for inlining
858 CORINFO_FLG_VERIFIABLE = 0x00000002, // The method has verifiable code
859 CORINFO_FLG_UNVERIFIABLE = 0x00000004, // The method has unverifiable code
863 enum CORINFO_ACCESS_FLAGS
865 CORINFO_ACCESS_ANY = 0x0000, // Normal access
866 CORINFO_ACCESS_THIS = 0x0001, // Accessed via the this reference
867 CORINFO_ACCESS_UNWRAP = 0x0002, // Accessed via an unwrap reference
869 CORINFO_ACCESS_NONNULL = 0x0004, // Instance is guaranteed non-null
871 CORINFO_ACCESS_LDFTN = 0x0010, // Accessed via ldftn
873 // Field access flags
874 CORINFO_ACCESS_GET = 0x0100, // Field get (ldfld)
875 CORINFO_ACCESS_SET = 0x0200, // Field set (stfld)
876 CORINFO_ACCESS_ADDRESS = 0x0400, // Field address (ldflda)
877 CORINFO_ACCESS_INIT_ARRAY = 0x0800, // Field use for InitializeArray
878 CORINFO_ACCESS_ATYPICAL_CALLSITE = 0x4000, // Atypical callsite that cannot be disassembled by delay loading helper
879 CORINFO_ACCESS_INLINECHECK= 0x8000, // Return fieldFlags and fieldAccessor only. Used by JIT64 during inlining.
882 // These are the flags set on an CORINFO_EH_CLAUSE
883 enum CORINFO_EH_CLAUSE_FLAGS
885 CORINFO_EH_CLAUSE_NONE = 0,
886 CORINFO_EH_CLAUSE_FILTER = 0x0001, // If this bit is on, then this EH entry is for a filter
887 CORINFO_EH_CLAUSE_FINALLY = 0x0002, // This clause is a finally clause
888 CORINFO_EH_CLAUSE_FAULT = 0x0004, // This clause is a fault clause
889 CORINFO_EH_CLAUSE_DUPLICATE = 0x0008, // Duplicated clause. This clause was duplicated to a funclet which was pulled out of line
890 CORINFO_EH_CLAUSE_SAMETRY = 0x0010, // This clause covers same try block as the previous one. (Used by CoreRT ABI.)
893 // This enumeration is passed to InternalThrow
894 enum CorInfoException
896 CORINFO_NullReferenceException,
897 CORINFO_DivideByZeroException,
898 CORINFO_InvalidCastException,
899 CORINFO_IndexOutOfRangeException,
900 CORINFO_OverflowException,
901 CORINFO_SynchronizationLockException,
902 CORINFO_ArrayTypeMismatchException,
903 CORINFO_RankException,
904 CORINFO_ArgumentNullException,
905 CORINFO_ArgumentException,
906 CORINFO_Exception_Count,
910 // This enumeration is returned by getIntrinsicID. Methods corresponding to
911 // these values will have "well-known" specified behavior. Calls to these
912 // methods could be replaced with inlined code corresponding to the
913 // specified behavior (without having to examine the IL beforehand).
915 enum CorInfoIntrinsics
917 CORINFO_INTRINSIC_Sin,
918 CORINFO_INTRINSIC_Cos,
919 CORINFO_INTRINSIC_Cbrt,
920 CORINFO_INTRINSIC_Sqrt,
921 CORINFO_INTRINSIC_Abs,
922 CORINFO_INTRINSIC_Round,
923 CORINFO_INTRINSIC_Cosh,
924 CORINFO_INTRINSIC_Sinh,
925 CORINFO_INTRINSIC_Tan,
926 CORINFO_INTRINSIC_Tanh,
927 CORINFO_INTRINSIC_Asin,
928 CORINFO_INTRINSIC_Asinh,
929 CORINFO_INTRINSIC_Acos,
930 CORINFO_INTRINSIC_Acosh,
931 CORINFO_INTRINSIC_Atan,
932 CORINFO_INTRINSIC_Atan2,
933 CORINFO_INTRINSIC_Atanh,
934 CORINFO_INTRINSIC_Log10,
935 CORINFO_INTRINSIC_Pow,
936 CORINFO_INTRINSIC_Exp,
937 CORINFO_INTRINSIC_Ceiling,
938 CORINFO_INTRINSIC_Floor,
939 CORINFO_INTRINSIC_GetChar, // fetch character out of string
940 CORINFO_INTRINSIC_Array_GetDimLength, // Get number of elements in a given dimension of an array
941 CORINFO_INTRINSIC_Array_Get, // Get the value of an element in an array
942 CORINFO_INTRINSIC_Array_Address, // Get the address of an element in an array
943 CORINFO_INTRINSIC_Array_Set, // Set the value of an element in an array
944 CORINFO_INTRINSIC_StringGetChar, // fetch character out of string
945 CORINFO_INTRINSIC_StringLength, // get the length
946 CORINFO_INTRINSIC_InitializeArray, // initialize an array from static data
947 CORINFO_INTRINSIC_GetTypeFromHandle,
948 CORINFO_INTRINSIC_RTH_GetValueInternal,
949 CORINFO_INTRINSIC_TypeEQ,
950 CORINFO_INTRINSIC_TypeNEQ,
951 CORINFO_INTRINSIC_Object_GetType,
952 CORINFO_INTRINSIC_StubHelpers_GetStubContext,
953 CORINFO_INTRINSIC_StubHelpers_GetStubContextAddr,
954 CORINFO_INTRINSIC_StubHelpers_GetNDirectTarget,
955 CORINFO_INTRINSIC_InterlockedAdd32,
956 CORINFO_INTRINSIC_InterlockedAdd64,
957 CORINFO_INTRINSIC_InterlockedXAdd32,
958 CORINFO_INTRINSIC_InterlockedXAdd64,
959 CORINFO_INTRINSIC_InterlockedXchg32,
960 CORINFO_INTRINSIC_InterlockedXchg64,
961 CORINFO_INTRINSIC_InterlockedCmpXchg32,
962 CORINFO_INTRINSIC_InterlockedCmpXchg64,
963 CORINFO_INTRINSIC_MemoryBarrier,
964 CORINFO_INTRINSIC_GetCurrentManagedThread,
965 CORINFO_INTRINSIC_GetManagedThreadId,
966 CORINFO_INTRINSIC_ByReference_Ctor,
967 CORINFO_INTRINSIC_ByReference_Value,
968 CORINFO_INTRINSIC_Span_GetItem,
969 CORINFO_INTRINSIC_ReadOnlySpan_GetItem,
970 CORINFO_INTRINSIC_GetRawHandle,
972 CORINFO_INTRINSIC_Count,
973 CORINFO_INTRINSIC_Illegal = -1, // Not a true intrinsic,
976 // Can a value be accessed directly from JITed code.
979 IAT_VALUE, // The info value is directly available
980 IAT_PVALUE, // The value needs to be accessed via an indirection
981 IAT_PPVALUE, // The value needs to be accessed via a double indirection
982 IAT_RELPVALUE // The value needs to be accessed via a relative indirection
987 TYPE_GC_NONE, // no embedded objectrefs
988 TYPE_GC_REF, // Is an object ref
989 TYPE_GC_BYREF, // Is an interior pointer - promote it but don't scan it
990 TYPE_GC_OTHER // requires type-specific treatment
995 CLASSID_SYSTEM_OBJECT,
998 CLASSID_FIELD_HANDLE,
999 CLASSID_METHOD_HANDLE,
1001 CLASSID_ARGUMENT_HANDLE,
1002 CLASSID_RUNTIME_TYPE,
1007 INLINE_PASS = 0, // Inlining OK
1009 // failures are negative
1010 INLINE_FAIL = -1, // Inlining not OK for this case only
1011 INLINE_NEVER = -2, // This method should never be inlined, regardless of context
1014 enum CorInfoInlineRestrictions
1016 INLINE_RESPECT_BOUNDARY = 0x00000001, // You can inline if there are no calls from the method being inlined
1017 INLINE_NO_CALLEE_LDSTR = 0x00000002, // You can inline only if you guarantee that if inlinee does an ldstr
1018 // inlinee's module will never see that string (by any means).
1019 // This is due to how we implement the NoStringInterningAttribute
1020 // (by reusing the fixup table).
1021 INLINE_SAME_THIS = 0x00000004, // You can inline only if the callee is on the same this reference as caller
1025 // If you add more values here, keep it in sync with TailCallTypeMap in ..\vm\ClrEtwAll.man
1026 // and the string enum in CEEInfo::reportTailCallDecision in ..\vm\JITInterface.cpp
1027 enum CorInfoTailCall
1029 TAILCALL_OPTIMIZED = 0, // Optimized tail call (epilog + jmp)
1030 TAILCALL_RECURSIVE = 1, // Optimized into a loop (only when a method tail calls itself)
1031 TAILCALL_HELPER = 2, // Helper assisted tail call (call to JIT_TailCall)
1033 // failures are negative
1034 TAILCALL_FAIL = -1, // Couldn't do a tail call
1037 enum CorInfoCanSkipVerificationResult
1039 CORINFO_VERIFICATION_CANNOT_SKIP = 0, // Cannot skip verification during jit time.
1040 CORINFO_VERIFICATION_CAN_SKIP = 1, // Can skip verification during jit time.
1041 CORINFO_VERIFICATION_RUNTIME_CHECK = 2, // Cannot skip verification during jit time,
1042 // but need to insert a callout to the VM to ask during runtime
1043 // whether to raise a verification or not (if the method is unverifiable).
1044 CORINFO_VERIFICATION_DONT_JIT = 3, // Cannot skip verification during jit time,
1045 // but do not jit the method if is is unverifiable.
1048 enum CorInfoInitClassResult
1050 CORINFO_INITCLASS_NOT_REQUIRED = 0x00, // No class initialization required, but the class is not actually initialized yet
1051 // (e.g. we are guaranteed to run the static constructor in method prolog)
1052 CORINFO_INITCLASS_INITIALIZED = 0x01, // Class initialized
1053 CORINFO_INITCLASS_SPECULATIVE = 0x02, // Class may be initialized speculatively
1054 CORINFO_INITCLASS_USE_HELPER = 0x04, // The JIT must insert class initialization helper call.
1055 CORINFO_INITCLASS_DONT_INLINE = 0x08, // The JIT should not inline the method requesting the class initialization. The class
1056 // initialization requires helper class now, but will not require initialization
1057 // if the method is compiled standalone. Or the method cannot be inlined due to some
1058 // requirement around class initialization such as shared generics.
1061 // Reason codes for making indirect calls
1062 #define INDIRECT_CALL_REASONS() \
1063 INDIRECT_CALL_REASON_FUNC(CORINFO_INDIRECT_CALL_UNKNOWN) \
1064 INDIRECT_CALL_REASON_FUNC(CORINFO_INDIRECT_CALL_EXOTIC) \
1065 INDIRECT_CALL_REASON_FUNC(CORINFO_INDIRECT_CALL_PINVOKE) \
1066 INDIRECT_CALL_REASON_FUNC(CORINFO_INDIRECT_CALL_GENERIC) \
1067 INDIRECT_CALL_REASON_FUNC(CORINFO_INDIRECT_CALL_NO_CODE) \
1068 INDIRECT_CALL_REASON_FUNC(CORINFO_INDIRECT_CALL_FIXUPS) \
1069 INDIRECT_CALL_REASON_FUNC(CORINFO_INDIRECT_CALL_STUB) \
1070 INDIRECT_CALL_REASON_FUNC(CORINFO_INDIRECT_CALL_REMOTING) \
1071 INDIRECT_CALL_REASON_FUNC(CORINFO_INDIRECT_CALL_CER) \
1072 INDIRECT_CALL_REASON_FUNC(CORINFO_INDIRECT_CALL_RESTORE_METHOD) \
1073 INDIRECT_CALL_REASON_FUNC(CORINFO_INDIRECT_CALL_RESTORE_FIRST_CALL) \
1074 INDIRECT_CALL_REASON_FUNC(CORINFO_INDIRECT_CALL_RESTORE_VALUE_TYPE) \
1075 INDIRECT_CALL_REASON_FUNC(CORINFO_INDIRECT_CALL_RESTORE) \
1076 INDIRECT_CALL_REASON_FUNC(CORINFO_INDIRECT_CALL_CANT_PATCH) \
1077 INDIRECT_CALL_REASON_FUNC(CORINFO_INDIRECT_CALL_PROFILING) \
1078 INDIRECT_CALL_REASON_FUNC(CORINFO_INDIRECT_CALL_OTHER_LOADER_MODULE) \
1080 enum CorInfoIndirectCallReason
1082 #undef INDIRECT_CALL_REASON_FUNC
1083 #define INDIRECT_CALL_REASON_FUNC(x) x,
1084 INDIRECT_CALL_REASONS()
1086 #undef INDIRECT_CALL_REASON_FUNC
1088 CORINFO_INDIRECT_CALL_COUNT
1091 // This is for use when the JIT is compiling an instantiation
1092 // of generic code. The JIT needs to know if the generic code itself
1093 // (which can be verified once and for all independently of the
1094 // instantiations) passed verification.
1095 enum CorInfoInstantiationVerification
1097 // The method is NOT a concrete instantiation (eg. List<int>.Add()) of a method
1098 // in a generic class or a generic method. It is either the typical instantiation
1099 // (eg. List<T>.Add()) or entirely non-generic.
1100 INSTVER_NOT_INSTANTIATION = 0,
1102 // The method is an instantiation of a method in a generic class or a generic method,
1103 // and the generic class was successfully verified
1104 INSTVER_GENERIC_PASSED_VERIFICATION = 1,
1106 // The method is an instantiation of a method in a generic class or a generic method,
1107 // and the generic class failed verification
1108 INSTVER_GENERIC_FAILED_VERIFICATION = 2,
1111 // When using CORINFO_HELPER_TAILCALL, the JIT needs to pass certain special
1112 // calling convention/argument passing/handling details to the helper
1113 enum CorInfoHelperTailCallSpecialHandling
1115 CORINFO_TAILCALL_NORMAL = 0x00000000,
1116 CORINFO_TAILCALL_STUB_DISPATCH_ARG = 0x00000001,
1120 inline bool dontInline(CorInfoInline val) {
1124 // Cookie types consumed by the code generator (these are opaque values
1125 // not inspected by the code generator):
1127 typedef struct CORINFO_ASSEMBLY_STRUCT_* CORINFO_ASSEMBLY_HANDLE;
1128 typedef struct CORINFO_MODULE_STRUCT_* CORINFO_MODULE_HANDLE;
1129 typedef struct CORINFO_DEPENDENCY_STRUCT_* CORINFO_DEPENDENCY_HANDLE;
1130 typedef struct CORINFO_CLASS_STRUCT_* CORINFO_CLASS_HANDLE;
1131 typedef struct CORINFO_METHOD_STRUCT_* CORINFO_METHOD_HANDLE;
1132 typedef struct CORINFO_FIELD_STRUCT_* CORINFO_FIELD_HANDLE;
1133 typedef struct CORINFO_ARG_LIST_STRUCT_* CORINFO_ARG_LIST_HANDLE; // represents a list of argument types
1134 typedef struct CORINFO_JUST_MY_CODE_HANDLE_*CORINFO_JUST_MY_CODE_HANDLE;
1135 typedef struct CORINFO_PROFILING_STRUCT_* CORINFO_PROFILING_HANDLE; // a handle guaranteed to be unique per process
1136 typedef struct CORINFO_GENERIC_STRUCT_* CORINFO_GENERIC_HANDLE; // a generic handle (could be any of the above)
1138 // what is actually passed on the varargs call
1139 typedef struct CORINFO_VarArgInfo * CORINFO_VARARGS_HANDLE;
1141 // Generic tokens are resolved with respect to a context, which is usually the method
1142 // being compiled. The CORINFO_CONTEXT_HANDLE indicates which exact instantiation
1143 // (or the open instantiation) is being referred to.
1144 // CORINFO_CONTEXT_HANDLE is more tightly scoped than CORINFO_MODULE_HANDLE. For cases
1145 // where the exact instantiation does not matter, CORINFO_MODULE_HANDLE is used.
1146 typedef CORINFO_METHOD_HANDLE CORINFO_CONTEXT_HANDLE;
1148 typedef struct CORINFO_DEPENDENCY_STRUCT_
1150 CORINFO_MODULE_HANDLE moduleFrom;
1151 CORINFO_MODULE_HANDLE moduleTo;
1152 } CORINFO_DEPENDENCY;
1154 // Bit-twiddling of contexts assumes word-alignment of method handles and type handles
1155 // If this ever changes, some other encoding will be needed
1156 enum CorInfoContextFlags
1158 CORINFO_CONTEXTFLAGS_METHOD = 0x00, // CORINFO_CONTEXT_HANDLE is really a CORINFO_METHOD_HANDLE
1159 CORINFO_CONTEXTFLAGS_CLASS = 0x01, // CORINFO_CONTEXT_HANDLE is really a CORINFO_CLASS_HANDLE
1160 CORINFO_CONTEXTFLAGS_MASK = 0x01
1163 #define MAKE_CLASSCONTEXT(c) (CORINFO_CONTEXT_HANDLE((size_t) (c) | CORINFO_CONTEXTFLAGS_CLASS))
1164 #define MAKE_METHODCONTEXT(m) (CORINFO_CONTEXT_HANDLE((size_t) (m) | CORINFO_CONTEXTFLAGS_METHOD))
1166 enum CorInfoSigInfoFlags
1168 CORINFO_SIGFLAG_IS_LOCAL_SIG = 0x01,
1169 CORINFO_SIGFLAG_IL_STUB = 0x02,
1172 struct CORINFO_SIG_INST
1174 unsigned classInstCount;
1175 CORINFO_CLASS_HANDLE * classInst; // (representative, not exact) instantiation for class type variables in signature
1176 unsigned methInstCount;
1177 CORINFO_CLASS_HANDLE * methInst; // (representative, not exact) instantiation for method type variables in signature
1180 struct CORINFO_SIG_INFO
1182 CorInfoCallConv callConv;
1183 CORINFO_CLASS_HANDLE retTypeClass; // if the return type is a value class, this is its handle (enums are normalized)
1184 CORINFO_CLASS_HANDLE retTypeSigClass;// returns the value class as it is in the sig (enums are not converted to primitives)
1185 CorInfoType retType : 8;
1186 unsigned flags : 8; // used by IL stubs code
1187 unsigned numArgs : 16;
1188 struct CORINFO_SIG_INST sigInst; // information about how type variables are being instantiated in generic code
1189 CORINFO_ARG_LIST_HANDLE args;
1190 PCCOR_SIGNATURE pSig;
1192 CORINFO_MODULE_HANDLE scope; // passed to getArgClass
1195 CorInfoCallConv getCallConv() { return CorInfoCallConv((callConv & CORINFO_CALLCONV_MASK)); }
1196 bool hasThis() { return ((callConv & CORINFO_CALLCONV_HASTHIS) != 0); }
1197 bool hasExplicitThis() { return ((callConv & CORINFO_CALLCONV_EXPLICITTHIS) != 0); }
1198 unsigned totalILArgs() { return (numArgs + hasThis()); }
1199 bool isVarArg() { return ((getCallConv() == CORINFO_CALLCONV_VARARG) || (getCallConv() == CORINFO_CALLCONV_NATIVEVARARG)); }
1200 bool hasTypeArg() { return ((callConv & CORINFO_CALLCONV_PARAMTYPE) != 0); }
1203 struct CORINFO_METHOD_INFO
1205 CORINFO_METHOD_HANDLE ftn;
1206 CORINFO_MODULE_HANDLE scope;
1208 unsigned ILCodeSize;
1211 CorInfoOptions options;
1212 CorInfoRegionKind regionKind;
1213 CORINFO_SIG_INFO args;
1214 CORINFO_SIG_INFO locals;
1217 //----------------------------------------------------------------------------
1218 // Looking up handles and addresses.
1220 // When the JIT requests a handle, the EE may direct the JIT that it must
1221 // access the handle in a variety of ways. These are packed as
1222 // CORINFO_CONST_LOOKUP
1223 // or CORINFO_LOOKUP (contains either a CORINFO_CONST_LOOKUP or a CORINFO_RUNTIME_LOOKUP)
1225 // Constant Lookups v. Runtime Lookups (i.e. when will Runtime Lookups be generated?)
1226 // -----------------------------------------------------------------------------------
1228 // CORINFO_LOOKUP_KIND is part of the result type of embedGenericHandle,
1229 // getVirtualCallInfo and any other functions that may require a
1230 // runtime lookup when compiling shared generic code.
1232 // CORINFO_LOOKUP_KIND indicates whether a particular token in the instruction stream can be:
1233 // (a) Mapped to a handle (type, field or method) at compile-time (!needsRuntimeLookup)
1234 // (b) Must be looked up at run-time, and if so which runtime lookup technique should be used (see below)
1236 // If the JIT or EE does not support code sharing for generic code, then
1237 // all CORINFO_LOOKUP results will be "constant lookups", i.e.
1238 // the needsRuntimeLookup of CORINFO_LOOKUP.lookupKind.needsRuntimeLookup
1244 // Constant Lookups are either:
1245 // IAT_VALUE: immediate (relocatable) values,
1246 // IAT_PVALUE: immediate values access via an indirection through an immediate (relocatable) address
1247 // IAT_RELPVALUE: immediate values access via a relative indirection through an immediate offset
1248 // IAT_PPVALUE: immediate values access via a double indirection through an immediate (relocatable) address
1253 // CORINFO_LOOKUP_KIND is part of the result type of embedGenericHandle,
1254 // getVirtualCallInfo and any other functions that may require a
1255 // runtime lookup when compiling shared generic code.
1257 // CORINFO_LOOKUP_KIND indicates whether a particular token in the instruction stream can be:
1258 // (a) Mapped to a handle (type, field or method) at compile-time (!needsRuntimeLookup)
1259 // (b) Must be looked up at run-time using the class dictionary
1260 // stored in the vtable of the this pointer (needsRuntimeLookup && THISOBJ)
1261 // (c) Must be looked up at run-time using the method dictionary
1262 // stored in the method descriptor parameter passed to a generic
1263 // method (needsRuntimeLookup && METHODPARAM)
1264 // (d) Must be looked up at run-time using the class dictionary stored
1265 // in the vtable parameter passed to a method in a generic
1266 // struct (needsRuntimeLookup && CLASSPARAM)
1268 struct CORINFO_CONST_LOOKUP
1270 // If the handle is obtained at compile-time, then this handle is the "exact" handle (class, method, or field)
1271 // Otherwise, it's a representative...
1273 // IAT_VALUE --> "handle" stores the real handle or "addr " stores the computed address
1274 // IAT_PVALUE --> "addr" stores a pointer to a location which will hold the real handle
1275 // IAT_RELPVALUE --> "addr" stores a relative pointer to a location which will hold the real handle
1276 // IAT_PPVALUE --> "addr" stores a double indirection to a location which will hold the real handle
1278 InfoAccessType accessType;
1281 CORINFO_GENERIC_HANDLE handle;
1286 enum CORINFO_RUNTIME_LOOKUP_KIND
1288 CORINFO_LOOKUP_THISOBJ,
1289 CORINFO_LOOKUP_METHODPARAM,
1290 CORINFO_LOOKUP_CLASSPARAM,
1293 struct CORINFO_LOOKUP_KIND
1295 bool needsRuntimeLookup;
1296 CORINFO_RUNTIME_LOOKUP_KIND runtimeLookupKind;
1298 // The 'runtimeLookupFlags' and 'runtimeLookupArgs' fields
1299 // are just for internal VM / ZAP communication, not to be used by the JIT.
1300 WORD runtimeLookupFlags;
1301 void * runtimeLookupArgs;
1305 // CORINFO_RUNTIME_LOOKUP indicates the details of the runtime lookup
1306 // operation to be performed.
1308 // CORINFO_MAXINDIRECTIONS is the maximum number of
1309 // indirections used by runtime lookups.
1310 // This accounts for up to 2 indirections to get at a dictionary followed by a possible spill slot
1312 #define CORINFO_MAXINDIRECTIONS 4
1313 #define CORINFO_USEHELPER ((WORD) 0xffff)
1315 struct CORINFO_RUNTIME_LOOKUP
1317 // This is signature you must pass back to the runtime lookup helper
1320 // Here is the helper you must call. It is one of CORINFO_HELP_RUNTIMEHANDLE_* helpers.
1321 CorInfoHelpFunc helper;
1323 // Number of indirections to get there
1324 // CORINFO_USEHELPER = don't know how to get it, so use helper function at run-time instead
1325 // 0 = use the this pointer itself (e.g. token is C<!0> inside code in sealed class C)
1326 // or method desc itself (e.g. token is method void M::mymeth<!!0>() inside code in M::mymeth)
1327 // Otherwise, follow each byte-offset stored in the "offsets[]" array (may be negative)
1330 // If set, test for null and branch to helper if null
1333 // If set, test the lowest bit and dereference if set (see code:FixupPointer)
1336 SIZE_T offsets[CORINFO_MAXINDIRECTIONS];
1338 // If set, first offset is indirect.
1339 // 0 means that value stored at first offset (offsets[0]) from pointer is next pointer, to which the next offset
1340 // (offsets[1]) is added and so on.
1341 // 1 means that value stored at first offset (offsets[0]) from pointer is offset1, and the next pointer is
1342 // stored at pointer+offsets[0]+offset1.
1343 bool indirectFirstOffset;
1345 // If set, second offset is indirect.
1346 // 0 means that value stored at second offset (offsets[1]) from pointer is next pointer, to which the next offset
1347 // (offsets[2]) is added and so on.
1348 // 1 means that value stored at second offset (offsets[1]) from pointer is offset2, and the next pointer is
1349 // stored at pointer+offsets[1]+offset2.
1350 bool indirectSecondOffset;
1353 // Result of calling embedGenericHandle
1354 struct CORINFO_LOOKUP
1356 CORINFO_LOOKUP_KIND lookupKind;
1360 // If kind.needsRuntimeLookup then this indicates how to do the lookup
1361 CORINFO_RUNTIME_LOOKUP runtimeLookup;
1363 // If the handle is obtained at compile-time, then this handle is the "exact" handle (class, method, or field)
1364 // Otherwise, it's a representative... If accessType is
1365 // IAT_VALUE --> "handle" stores the real handle or "addr " stores the computed address
1366 // IAT_PVALUE --> "addr" stores a pointer to a location which will hold the real handle
1367 // IAT_RELPVALUE --> "addr" stores a relative pointer to a location which will hold the real handle
1368 // IAT_PPVALUE --> "addr" stores a double indirection to a location which will hold the real handle
1369 CORINFO_CONST_LOOKUP constLookup;
1373 enum CorInfoGenericHandleType
1375 CORINFO_HANDLETYPE_UNKNOWN,
1376 CORINFO_HANDLETYPE_CLASS,
1377 CORINFO_HANDLETYPE_METHOD,
1378 CORINFO_HANDLETYPE_FIELD
1381 //----------------------------------------------------------------------------
1382 // Embedding type, method and field handles (for "ldtoken" or to pass back to helpers)
1384 // Result of calling embedGenericHandle
1385 struct CORINFO_GENERICHANDLE_RESULT
1387 CORINFO_LOOKUP lookup;
1389 // compileTimeHandle is guaranteed to be either NULL or a handle that is usable during compile time.
1390 // It must not be embedded in the code because it might not be valid at run-time.
1391 CORINFO_GENERIC_HANDLE compileTimeHandle;
1393 // Type of the result
1394 CorInfoGenericHandleType handleType;
1397 #define CORINFO_ACCESS_ALLOWED_MAX_ARGS 4
1399 enum CorInfoAccessAllowedHelperArgType
1401 CORINFO_HELPER_ARG_TYPE_Invalid = 0,
1402 CORINFO_HELPER_ARG_TYPE_Field = 1,
1403 CORINFO_HELPER_ARG_TYPE_Method = 2,
1404 CORINFO_HELPER_ARG_TYPE_Class = 3,
1405 CORINFO_HELPER_ARG_TYPE_Module = 4,
1406 CORINFO_HELPER_ARG_TYPE_Const = 5,
1408 struct CORINFO_HELPER_ARG
1412 CORINFO_FIELD_HANDLE fieldHandle;
1413 CORINFO_METHOD_HANDLE methodHandle;
1414 CORINFO_CLASS_HANDLE classHandle;
1415 CORINFO_MODULE_HANDLE moduleHandle;
1418 CorInfoAccessAllowedHelperArgType argType;
1420 void Set(CORINFO_METHOD_HANDLE handle)
1422 argType = CORINFO_HELPER_ARG_TYPE_Method;
1423 methodHandle = handle;
1426 void Set(CORINFO_FIELD_HANDLE handle)
1428 argType = CORINFO_HELPER_ARG_TYPE_Field;
1429 fieldHandle = handle;
1432 void Set(CORINFO_CLASS_HANDLE handle)
1434 argType = CORINFO_HELPER_ARG_TYPE_Class;
1435 classHandle = handle;
1438 void Set(size_t value)
1440 argType = CORINFO_HELPER_ARG_TYPE_Const;
1445 struct CORINFO_HELPER_DESC
1447 CorInfoHelpFunc helperNum;
1449 CORINFO_HELPER_ARG args[CORINFO_ACCESS_ALLOWED_MAX_ARGS];
1452 //----------------------------------------------------------------------------
1453 // getCallInfo and CORINFO_CALL_INFO: The EE instructs the JIT about how to make a call
1459 // Indicates that the JIT can use getFunctionEntryPoint to make a call,
1460 // i.e. there is nothing abnormal about the call. The JITs know what to do if they get this.
1461 // Except in the case of constraint calls (see below), [targetMethodHandle] will hold
1462 // the CORINFO_METHOD_HANDLE that a call to findMethod would
1464 // This flag may be combined with nullInstanceCheck=TRUE for uses of callvirt on methods that can
1465 // be resolved at compile-time (non-virtual, final or sealed).
1467 // CORINFO_CALL_CODE_POINTER (shared generic code only) :
1468 // Indicates that the JIT should do an indirect call to the entrypoint given by address, which may be specified
1469 // as a runtime lookup by CORINFO_CALL_INFO::codePointerLookup.
1470 // [targetMethodHandle] will not hold a valid value.
1471 // This flag may be combined with nullInstanceCheck=TRUE for uses of callvirt on methods whose target method can
1472 // be resolved at compile-time but whose instantiation can be resolved only through runtime lookup.
1474 // CORINFO_VIRTUALCALL_STUB (interface calls) :
1475 // Indicates that the EE supports "stub dispatch" and request the JIT to make a
1476 // "stub dispatch" call (an indirect call through CORINFO_CALL_INFO::stubLookup,
1477 // similar to CORINFO_CALL_CODE_POINTER).
1478 // "Stub dispatch" is a specialized calling sequence (that may require use of NOPs)
1479 // which allow the runtime to determine the call-site after the call has been dispatched.
1480 // If the call is too complex for the JIT (e.g. because
1481 // fetching the dispatch stub requires a runtime lookup, i.e. lookupKind.needsRuntimeLookup
1482 // is set) then the JIT is allowed to implement the call as if it were CORINFO_VIRTUALCALL_LDVIRTFTN
1483 // [targetMethodHandle] will hold the CORINFO_METHOD_HANDLE that a call to findMethod would
1485 // This flag is always accompanied by nullInstanceCheck=TRUE.
1487 // CORINFO_VIRTUALCALL_LDVIRTFTN (virtual generic methods) :
1488 // Indicates that the EE provides no way to implement the call directly and
1489 // that the JIT should use a LDVIRTFTN sequence (as implemented by CORINFO_HELP_VIRTUAL_FUNC_PTR)
1490 // followed by an indirect call.
1491 // [targetMethodHandle] will hold the CORINFO_METHOD_HANDLE that a call to findMethod would
1493 // This flag is always accompanied by nullInstanceCheck=TRUE though typically the null check will
1494 // be implicit in the access through the instance pointer.
1496 // CORINFO_VIRTUALCALL_VTABLE (regular virtual methods) :
1497 // Indicates that the EE supports vtable dispatch and that the JIT should use getVTableOffset etc.
1498 // to implement the call.
1499 // [targetMethodHandle] will hold the CORINFO_METHOD_HANDLE that a call to findMethod would
1501 // This flag is always accompanied by nullInstanceCheck=TRUE though typically the null check will
1502 // be implicit in the access through the instance pointer.
1504 // thisTransform and constraint calls
1505 // ----------------------------------
1507 // For evertyhing besides "constrained." calls "thisTransform" is set to
1508 // CORINFO_NO_THIS_TRANSFORM.
1510 // For "constrained." calls the EE attempts to resolve the call at compile
1511 // time to a more specific method, or (shared generic code only) to a runtime lookup
1512 // for a code pointer for the more specific method.
1514 // In order to permit this, the "this" pointer supplied for a "constrained." call
1515 // is a byref to an arbitrary type (see the IL spec). The "thisTransform" field
1516 // will indicate how the JIT must transform the "this" pointer in order
1517 // to be able to call the resolved method:
1519 // CORINFO_NO_THIS_TRANSFORM --> Leave it as a byref to an unboxed value type
1520 // CORINFO_BOX_THIS --> Box it to produce an object
1521 // CORINFO_DEREF_THIS --> Deref the byref to get an object reference
1523 // In addition, the "kind" field will be set as follows for constraint calls:
1525 // CORINFO_CALL --> the call was resolved at compile time, and
1526 // can be compiled like a normal call.
1527 // CORINFO_CALL_CODE_POINTER --> the call was resolved, but the target address will be
1528 // computed at runtime. Only returned for shared generic code.
1529 // CORINFO_VIRTUALCALL_STUB,
1530 // CORINFO_VIRTUALCALL_LDVIRTFTN,
1531 // CORINFO_VIRTUALCALL_VTABLE --> usual values indicating that a virtual call must be made
1533 enum CORINFO_CALL_KIND
1536 CORINFO_CALL_CODE_POINTER,
1537 CORINFO_VIRTUALCALL_STUB,
1538 CORINFO_VIRTUALCALL_LDVIRTFTN,
1539 CORINFO_VIRTUALCALL_VTABLE
1542 // Indicates that the CORINFO_VIRTUALCALL_VTABLE lookup needn't do a chunk indirection
1543 #define CORINFO_VIRTUALCALL_NO_CHUNK 0xFFFFFFFF
1545 enum CORINFO_THIS_TRANSFORM
1547 CORINFO_NO_THIS_TRANSFORM,
1552 enum CORINFO_CALLINFO_FLAGS
1554 CORINFO_CALLINFO_NONE = 0x0000,
1555 CORINFO_CALLINFO_ALLOWINSTPARAM = 0x0001, // Can the compiler generate code to pass an instantiation parameters? Simple compilers should not use this flag
1556 CORINFO_CALLINFO_CALLVIRT = 0x0002, // Is it a virtual call?
1557 CORINFO_CALLINFO_KINDONLY = 0x0004, // This is set to only query the kind of call to perform, without getting any other information
1558 CORINFO_CALLINFO_VERIFICATION = 0x0008, // Gets extra verification information.
1559 CORINFO_CALLINFO_SECURITYCHECKS = 0x0010, // Perform security checks.
1560 CORINFO_CALLINFO_LDFTN = 0x0020, // Resolving target of LDFTN
1561 CORINFO_CALLINFO_ATYPICAL_CALLSITE = 0x0040, // Atypical callsite that cannot be disassembled by delay loading helper
1564 enum CorInfoIsAccessAllowedResult
1566 CORINFO_ACCESS_ALLOWED = 0, // Call allowed
1567 CORINFO_ACCESS_ILLEGAL = 1, // Call not allowed
1568 CORINFO_ACCESS_RUNTIME_CHECK = 2, // Ask at runtime whether to allow the call or not
1572 // This enum is used for JIT to tell EE where this token comes from.
1573 // E.g. Depending on different opcodes, we might allow/disallow certain types of tokens or
1574 // return different types of handles (e.g. boxed vs. regular entrypoints)
1575 enum CorInfoTokenKind
1577 CORINFO_TOKENKIND_Class = 0x01,
1578 CORINFO_TOKENKIND_Method = 0x02,
1579 CORINFO_TOKENKIND_Field = 0x04,
1580 CORINFO_TOKENKIND_Mask = 0x07,
1582 // token comes from CEE_LDTOKEN
1583 CORINFO_TOKENKIND_Ldtoken = 0x10 | CORINFO_TOKENKIND_Class | CORINFO_TOKENKIND_Method | CORINFO_TOKENKIND_Field,
1585 // token comes from CEE_CASTCLASS or CEE_ISINST
1586 CORINFO_TOKENKIND_Casting = 0x20 | CORINFO_TOKENKIND_Class,
1588 // token comes from CEE_NEWARR
1589 CORINFO_TOKENKIND_Newarr = 0x40 | CORINFO_TOKENKIND_Class,
1591 // token comes from CEE_BOX
1592 CORINFO_TOKENKIND_Box = 0x80 | CORINFO_TOKENKIND_Class,
1594 // token comes from CEE_CONSTRAINED
1595 CORINFO_TOKENKIND_Constrained = 0x100 | CORINFO_TOKENKIND_Class,
1597 // token comes from CEE_NEWOBJ
1598 CORINFO_TOKENKIND_NewObj = 0x200 | CORINFO_TOKENKIND_Method,
1600 // token comes from CEE_LDVIRTFTN
1601 CORINFO_TOKENKIND_Ldvirtftn = 0x400 | CORINFO_TOKENKIND_Method,
1604 struct CORINFO_RESOLVED_TOKEN
1607 // [In] arguments of resolveToken
1609 CORINFO_CONTEXT_HANDLE tokenContext; //Context for resolution of generic arguments
1610 CORINFO_MODULE_HANDLE tokenScope;
1611 mdToken token; //The source token
1612 CorInfoTokenKind tokenType;
1615 // [Out] arguments of resolveToken.
1616 // - Type handle is always non-NULL.
1617 // - At most one of method and field handles is non-NULL (according to the token type).
1618 // - Method handle is an instantiating stub only for generic methods. Type handle
1619 // is required to provide the full context for methods in generic types.
1621 CORINFO_CLASS_HANDLE hClass;
1622 CORINFO_METHOD_HANDLE hMethod;
1623 CORINFO_FIELD_HANDLE hField;
1626 // [Out] TypeSpec and MethodSpec signatures for generics. NULL otherwise.
1628 PCCOR_SIGNATURE pTypeSpec;
1630 PCCOR_SIGNATURE pMethodSpec;
1634 struct CORINFO_CALL_INFO
1636 CORINFO_METHOD_HANDLE hMethod; //target method handle
1637 unsigned methodFlags; //flags for the target method
1639 unsigned classFlags; //flags for CORINFO_RESOLVED_TOKEN::hClass
1641 CORINFO_SIG_INFO sig;
1643 //Verification information
1644 unsigned verMethodFlags; // flags for CORINFO_RESOLVED_TOKEN::hMethod
1645 CORINFO_SIG_INFO verSig;
1646 //All of the regular method data is the same... hMethod might not be the same as CORINFO_RESOLVED_TOKEN::hMethod
1650 // - CORINFO_ACCESS_ALLOWED - The access is allowed.
1651 // - CORINFO_ACCESS_ILLEGAL - This access cannot be allowed (i.e. it is public calling private). The
1652 // JIT may either insert the callsiteCalloutHelper into the code (as per a verification error) or
1653 // call throwExceptionFromHelper on the callsiteCalloutHelper. In this case callsiteCalloutHelper
1654 // is guaranteed not to return.
1655 // - CORINFO_ACCESS_RUNTIME_CHECK - The jit must insert the callsiteCalloutHelper at the call site.
1656 // the helper may return
1657 CorInfoIsAccessAllowedResult accessAllowed;
1658 CORINFO_HELPER_DESC callsiteCalloutHelper;
1660 // See above section on constraintCalls to understand when these are set to unusual values.
1661 CORINFO_THIS_TRANSFORM thisTransform;
1663 CORINFO_CALL_KIND kind;
1664 BOOL nullInstanceCheck;
1666 // Context for inlining and hidden arg
1667 CORINFO_CONTEXT_HANDLE contextHandle;
1668 BOOL exactContextNeedsRuntimeLookup; // Set if contextHandle is approx handle. Runtime lookup is required to get the exact handle.
1670 // If kind.CORINFO_VIRTUALCALL_STUB then stubLookup will be set.
1671 // If kind.CORINFO_CALL_CODE_POINTER then entryPointLookup will be set.
1674 CORINFO_LOOKUP stubLookup;
1676 CORINFO_LOOKUP codePointerLookup;
1679 CORINFO_CONST_LOOKUP instParamLookup; // Used by Ready-to-Run
1681 BOOL secureDelegateInvoke;
1684 //----------------------------------------------------------------------------
1685 // getFieldInfo and CORINFO_FIELD_INFO: The EE instructs the JIT about how to access a field
1687 enum CORINFO_FIELD_ACCESSOR
1689 CORINFO_FIELD_INSTANCE, // regular instance field at given offset from this-ptr
1690 CORINFO_FIELD_INSTANCE_WITH_BASE, // instance field with base offset (used by Ready-to-Run)
1691 CORINFO_FIELD_INSTANCE_HELPER, // instance field accessed using helper (arguments are this, FieldDesc * and the value)
1692 CORINFO_FIELD_INSTANCE_ADDR_HELPER, // instance field accessed using address-of helper (arguments are this and FieldDesc *)
1694 CORINFO_FIELD_STATIC_ADDRESS, // field at given address
1695 CORINFO_FIELD_STATIC_RVA_ADDRESS, // RVA field at given address
1696 CORINFO_FIELD_STATIC_SHARED_STATIC_HELPER, // static field accessed using the "shared static" helper (arguments are ModuleID + ClassID)
1697 CORINFO_FIELD_STATIC_GENERICS_STATIC_HELPER, // static field access using the "generic static" helper (argument is MethodTable *)
1698 CORINFO_FIELD_STATIC_ADDR_HELPER, // static field accessed using address-of helper (argument is FieldDesc *)
1699 CORINFO_FIELD_STATIC_TLS, // unmanaged TLS access
1700 CORINFO_FIELD_STATIC_READYTORUN_HELPER, // static field access using a runtime lookup helper
1702 CORINFO_FIELD_INTRINSIC_ZERO, // intrinsic zero (IntPtr.Zero, UIntPtr.Zero)
1703 CORINFO_FIELD_INTRINSIC_EMPTY_STRING, // intrinsic emptry string (String.Empty)
1704 CORINFO_FIELD_INTRINSIC_ISLITTLEENDIAN, // intrinsic BitConverter.IsLittleEndian
1707 // Set of flags returned in CORINFO_FIELD_INFO::fieldFlags
1708 enum CORINFO_FIELD_FLAGS
1710 CORINFO_FLG_FIELD_STATIC = 0x00000001,
1711 CORINFO_FLG_FIELD_UNMANAGED = 0x00000002, // RVA field
1712 CORINFO_FLG_FIELD_FINAL = 0x00000004,
1713 CORINFO_FLG_FIELD_STATIC_IN_HEAP = 0x00000008, // See code:#StaticFields. This static field is in the GC heap as a boxed object
1714 CORINFO_FLG_FIELD_SAFESTATIC_BYREF_RETURN = 0x00000010, // Field can be returned safely (has GC heap lifetime)
1715 CORINFO_FLG_FIELD_INITCLASS = 0x00000020, // initClass has to be called before accessing the field
1716 CORINFO_FLG_FIELD_PROTECTED = 0x00000040,
1719 struct CORINFO_FIELD_INFO
1721 CORINFO_FIELD_ACCESSOR fieldAccessor;
1722 unsigned fieldFlags;
1724 // Helper to use if the field access requires it
1725 CorInfoHelpFunc helper;
1727 // Field offset if there is one
1730 CorInfoType fieldType;
1731 CORINFO_CLASS_HANDLE structType; //possibly null
1733 //See CORINFO_CALL_INFO.accessAllowed
1734 CorInfoIsAccessAllowedResult accessAllowed;
1735 CORINFO_HELPER_DESC accessCalloutHelper;
1737 CORINFO_CONST_LOOKUP fieldLookup; // Used by Ready-to-Run
1740 //----------------------------------------------------------------------------
1741 // Exception handling
1743 struct CORINFO_EH_CLAUSE
1745 CORINFO_EH_CLAUSE_FLAGS Flags;
1748 DWORD HandlerOffset;
1749 DWORD HandlerLength;
1752 DWORD ClassToken; // use for type-based exception handlers
1753 DWORD FilterOffset; // use for filter-based exception handlers (COR_ILEXCEPTION_FILTER is set)
1767 DWORD dwExtendedFeatures;
1770 enum CORINFO_RUNTIME_ABI
1772 CORINFO_DESKTOP_ABI = 0x100,
1773 CORINFO_CORECLR_ABI = 0x200,
1774 CORINFO_CORERT_ABI = 0x300,
1777 // For some highly optimized paths, the JIT must generate code that directly
1778 // manipulates internal EE data structures. The getEEInfo() helper returns
1779 // this structure containing the needed offsets and values.
1780 struct CORINFO_EE_INFO
1782 // Information about the InlinedCallFrame structure layout
1783 struct InlinedCallFrameInfo
1785 // Size of the Frame structure
1788 unsigned offsetOfGSCookie;
1789 unsigned offsetOfFrameVptr;
1790 unsigned offsetOfFrameLink;
1791 unsigned offsetOfCallSiteSP;
1792 unsigned offsetOfCalleeSavedFP;
1793 unsigned offsetOfCallTarget;
1794 unsigned offsetOfReturnAddress;
1796 inlinedCallFrameInfo;
1798 // Offsets into the Thread structure
1799 unsigned offsetOfThreadFrame; // offset of the current Frame
1800 unsigned offsetOfGCState; // offset of the preemptive/cooperative state of the Thread
1803 unsigned offsetOfDelegateInstance;
1804 unsigned offsetOfDelegateFirstTarget;
1806 // Secure delegate offsets
1807 unsigned offsetOfSecureDelegateIndirectCell;
1810 unsigned offsetOfTransparentProxyRP;
1811 unsigned offsetOfRealProxyServer;
1814 unsigned offsetOfObjArrayData;
1816 // Reverse PInvoke offsets
1817 unsigned sizeOfReversePInvokeFrame;
1822 // Null object offset
1823 size_t maxUncheckedOffsetForNullObject;
1825 // Target ABI. Combined with target architecture and OS to determine
1826 // GC, EH, and unwind styles.
1827 CORINFO_RUNTIME_ABI targetAbi;
1835 // This is used to indicate that a finally has been called
1836 // "locally" by the try block
1837 enum { LCL_FINALLY_MARK = 0xFC }; // FC = "Finally Call"
1839 /**********************************************************************************
1840 * The following is the internal structure of an object that the compiler knows about
1841 * when it generates code
1842 **********************************************************************************/
1844 #include <pshpack4.h>
1846 typedef void* CORINFO_MethodPtr; // a generic method pointer
1848 struct CORINFO_Object
1850 CORINFO_MethodPtr *methTable; // the vtable for the object
1853 struct CORINFO_String : public CORINFO_Object
1856 wchar_t chars[1]; // actually of variable size
1859 struct CORINFO_Array : public CORINFO_Object
1867 /* Multi-dimensional arrays have the lengths and bounds here */
1868 unsigned dimLength[length];
1869 unsigned dimBound[length];
1874 __int8 i1Elems[1]; // actually of variable size
1875 unsigned __int8 u1Elems[1];
1877 unsigned __int16 u2Elems[1];
1879 unsigned __int32 u4Elems[1];
1884 #include <pshpack4.h>
1885 struct CORINFO_Array8 : public CORINFO_Object
1896 unsigned __int64 u8Elems[1];
1900 #include <poppack.h>
1902 struct CORINFO_RefArray : public CORINFO_Object
1910 /* Multi-dimensional arrays have the lengths and bounds here */
1911 unsigned dimLength[length];
1912 unsigned dimBound[length];
1915 CORINFO_Object* refElems[1]; // actually of variable size;
1918 struct CORINFO_RefAny
1921 CORINFO_CLASS_HANDLE type;
1924 // The jit assumes the CORINFO_VARARGS_HANDLE is a pointer to a subclass of this
1925 struct CORINFO_VarArgInfo
1927 unsigned argBytes; // number of bytes the arguments take up.
1928 // (The CORINFO_VARARGS_HANDLE counts as an arg)
1931 #include <poppack.h>
1933 #define SIZEOF__CORINFO_Object TARGET_POINTER_SIZE /* methTable */
1935 #define OFFSETOF__CORINFO_Array__length SIZEOF__CORINFO_Object
1936 #ifdef _TARGET_64BIT_
1937 #define OFFSETOF__CORINFO_Array__data (OFFSETOF__CORINFO_Array__length + sizeof(unsigned __int32) /* length */ + sizeof(unsigned __int32) /* alignpad */)
1939 #define OFFSETOF__CORINFO_Array__data (OFFSETOF__CORINFO_Array__length + sizeof(unsigned __int32) /* length */)
1942 #define OFFSETOF__CORINFO_TypedReference__dataPtr 0
1943 #define OFFSETOF__CORINFO_TypedReference__type (OFFSETOF__CORINFO_TypedReference__dataPtr + TARGET_POINTER_SIZE /* dataPtr */)
1945 #define OFFSETOF__CORINFO_String__stringLen SIZEOF__CORINFO_Object
1946 #define OFFSETOF__CORINFO_String__chars (OFFSETOF__CORINFO_String__stringLen + sizeof(unsigned __int32) /* stringLen */)
1948 enum CorInfoSecurityRuntimeChecks
1950 CORINFO_ACCESS_SECURITY_NONE = 0,
1951 CORINFO_ACCESS_SECURITY_TRANSPARENCY = 0x0001 // check that transparency rules are enforced between the caller and callee
1955 /* data to optimize delegate construction */
1956 struct DelegateCtorArgs
1964 // use offsetof to get the offset of the fields above
1965 #include <stddef.h> // offsetof
1967 #define offsetof(s,m) ((size_t)&(((s *)0)->m))
1970 // Guard-stack cookie for preventing against stack buffer overruns
1971 typedef SIZE_T GSCookie;
1973 #include "cordebuginfo.h"
1975 /**********************************************************************************/
1976 // Some compilers cannot arbitrarily allow the handler nesting level to grow
1977 // arbitrarily during Edit'n'Continue.
1978 // This is the maximum nesting level that a compiler needs to support for EnC
1980 const int MAX_EnC_HANDLER_NESTING_LEVEL = 6;
1982 // Results from type comparison queries
1983 enum class TypeCompareState
1985 MustNot = -1, // types are not equal
1986 May = 0, // types may be equal (must test at runtime)
1987 Must = 1, // type are equal
1991 // This interface is logically split into sections for each class of information
1992 // (ICorMethodInfo, ICorModuleInfo, etc.). This split used to exist physically as well
1993 // using virtual inheritance, but was eliminated to improve efficiency of the JIT-EE
1996 class ICorStaticInfo
1999 /**********************************************************************************/
2003 /**********************************************************************************/
2005 // return flags (defined above, CORINFO_FLG_PUBLIC ...)
2006 virtual DWORD getMethodAttribs (
2007 CORINFO_METHOD_HANDLE ftn /* IN */
2010 // sets private JIT flags, which can be, retrieved using getAttrib.
2011 virtual void setMethodAttribs (
2012 CORINFO_METHOD_HANDLE ftn, /* IN */
2013 CorInfoMethodRuntimeFlags attribs /* IN */
2016 // Given a method descriptor ftnHnd, extract signature information into sigInfo
2018 // 'memberParent' is typically only set when verifying. It should be the
2019 // result of calling getMemberParent.
2020 virtual void getMethodSig (
2021 CORINFO_METHOD_HANDLE ftn, /* IN */
2022 CORINFO_SIG_INFO *sig, /* OUT */
2023 CORINFO_CLASS_HANDLE memberParent = NULL /* IN */
2026 /*********************************************************************
2027 * Note the following methods can only be used on functions known
2028 * to be IL. This includes the method being compiled and any method
2029 * that 'getMethodInfo' returns true for
2030 *********************************************************************/
2032 // return information about a method private to the implementation
2033 // returns false if method is not IL, or is otherwise unavailable.
2034 // This method is used to fetch data needed to inline functions
2035 virtual bool getMethodInfo (
2036 CORINFO_METHOD_HANDLE ftn, /* IN */
2037 CORINFO_METHOD_INFO* info /* OUT */
2040 // Decides if you have any limitations for inlining. If everything's OK, it will return
2041 // INLINE_PASS and will fill out pRestrictions with a mask of restrictions the caller of this
2042 // function must respect. If caller passes pRestrictions = NULL, if there are any restrictions
2043 // INLINE_FAIL will be returned
2045 // The callerHnd must be the immediate caller (i.e. when we have a chain of inlined calls)
2047 // The inlined method need not be verified
2049 virtual CorInfoInline canInline (
2050 CORINFO_METHOD_HANDLE callerHnd, /* IN */
2051 CORINFO_METHOD_HANDLE calleeHnd, /* IN */
2052 DWORD* pRestrictions /* OUT */
2055 // Reports whether or not a method can be inlined, and why. canInline is responsible for reporting all
2056 // inlining results when it returns INLINE_FAIL and INLINE_NEVER. All other results are reported by the
2058 virtual void reportInliningDecision (CORINFO_METHOD_HANDLE inlinerHnd,
2059 CORINFO_METHOD_HANDLE inlineeHnd,
2060 CorInfoInline inlineResult,
2061 const char * reason) = 0;
2064 // Returns false if the call is across security boundaries thus we cannot tailcall
2066 // The callerHnd must be the immediate caller (i.e. when we have a chain of inlined calls)
2067 virtual bool canTailCall (
2068 CORINFO_METHOD_HANDLE callerHnd, /* IN */
2069 CORINFO_METHOD_HANDLE declaredCalleeHnd, /* IN */
2070 CORINFO_METHOD_HANDLE exactCalleeHnd, /* IN */
2071 bool fIsTailPrefix /* IN */
2074 // Reports whether or not a method can be tail called, and why.
2075 // canTailCall is responsible for reporting all results when it returns
2076 // false. All other results are reported by the JIT.
2077 virtual void reportTailCallDecision (CORINFO_METHOD_HANDLE callerHnd,
2078 CORINFO_METHOD_HANDLE calleeHnd,
2080 CorInfoTailCall tailCallResult,
2081 const char * reason) = 0;
2083 // get individual exception handler
2084 virtual void getEHinfo(
2085 CORINFO_METHOD_HANDLE ftn, /* IN */
2086 unsigned EHnumber, /* IN */
2087 CORINFO_EH_CLAUSE* clause /* OUT */
2090 // return class it belongs to
2091 virtual CORINFO_CLASS_HANDLE getMethodClass (
2092 CORINFO_METHOD_HANDLE method
2095 // return module it belongs to
2096 virtual CORINFO_MODULE_HANDLE getMethodModule (
2097 CORINFO_METHOD_HANDLE method
2100 // This function returns the offset of the specified method in the
2101 // vtable of it's owning class or interface.
2102 virtual void getMethodVTableOffset (
2103 CORINFO_METHOD_HANDLE method, /* IN */
2104 unsigned* offsetOfIndirection, /* OUT */
2105 unsigned* offsetAfterIndirection, /* OUT */
2106 bool* isRelative /* OUT */
2109 // Find the virtual method in implementingClass that overrides virtualMethod,
2110 // or the method in implementingClass that implements the interface method
2111 // represented by virtualMethod.
2113 // Return null if devirtualization is not possible. Owner type is optional
2114 // and provides additional context for shared interface devirtualization.
2115 virtual CORINFO_METHOD_HANDLE resolveVirtualMethod(
2116 CORINFO_METHOD_HANDLE virtualMethod, /* IN */
2117 CORINFO_CLASS_HANDLE implementingClass, /* IN */
2118 CORINFO_CONTEXT_HANDLE ownerType = NULL /* IN */
2121 // Get the unboxed entry point for a method, if possible.
2122 virtual CORINFO_METHOD_HANDLE getUnboxedEntry(
2123 CORINFO_METHOD_HANDLE ftn,
2124 bool* requiresInstMethodTableArg = NULL /* OUT */
2127 // Given T, return the type of the default EqualityComparer<T>.
2128 // Returns null if the type can't be determined exactly.
2129 virtual CORINFO_CLASS_HANDLE getDefaultEqualityComparerClass(
2130 CORINFO_CLASS_HANDLE elemType
2133 // Given resolved token that corresponds to an intrinsic classified as
2134 // a CORINFO_INTRINSIC_GetRawHandle intrinsic, fetch the handle associated
2135 // with the token. If this is not possible at compile-time (because the current method's
2136 // code is shared and the token contains generic parameters) then indicate
2137 // how the handle should be looked up at runtime.
2138 virtual void expandRawHandleIntrinsic(
2139 CORINFO_RESOLVED_TOKEN * pResolvedToken,
2140 CORINFO_GENERICHANDLE_RESULT * pResult) = 0;
2142 // If a method's attributes have (getMethodAttribs) CORINFO_FLG_INTRINSIC set,
2143 // getIntrinsicID() returns the intrinsic ID.
2144 // *pMustExpand tells whether or not JIT must expand the intrinsic.
2145 virtual CorInfoIntrinsics getIntrinsicID(
2146 CORINFO_METHOD_HANDLE method,
2147 bool* pMustExpand = NULL /* OUT */
2150 // Is the given module the System.Numerics.Vectors module?
2151 // This defaults to false.
2152 virtual bool isInSIMDModule(
2153 CORINFO_CLASS_HANDLE classHnd
2156 // return the unmanaged calling convention for a PInvoke
2157 virtual CorInfoUnmanagedCallConv getUnmanagedCallConv(
2158 CORINFO_METHOD_HANDLE method
2161 // return if any marshaling is required for PInvoke methods. Note that
2162 // method == 0 => calli. The call site sig is only needed for the varargs or calli case
2163 virtual BOOL pInvokeMarshalingRequired(
2164 CORINFO_METHOD_HANDLE method,
2165 CORINFO_SIG_INFO* callSiteSig
2168 // Check constraints on method type arguments (only).
2169 // The parent class should be checked separately using satisfiesClassConstraints(parent).
2170 virtual BOOL satisfiesMethodConstraints(
2171 CORINFO_CLASS_HANDLE parent, // the exact parent of the method
2172 CORINFO_METHOD_HANDLE method
2175 // Given a delegate target class, a target method parent class, a target method,
2176 // a delegate class, check if the method signature is compatible with the Invoke method of the delegate
2177 // (under the typical instantiation of any free type variables in the memberref signatures).
2178 virtual BOOL isCompatibleDelegate(
2179 CORINFO_CLASS_HANDLE objCls, /* type of the delegate target, if any */
2180 CORINFO_CLASS_HANDLE methodParentCls, /* exact parent of the target method, if any */
2181 CORINFO_METHOD_HANDLE method, /* (representative) target method, if any */
2182 CORINFO_CLASS_HANDLE delegateCls, /* exact type of the delegate */
2183 BOOL *pfIsOpenDelegate /* is the delegate open */
2186 // Indicates if the method is an instance of the generic
2187 // method that passes (or has passed) verification
2188 virtual CorInfoInstantiationVerification isInstantiationOfVerifiedGeneric (
2189 CORINFO_METHOD_HANDLE method /* IN */
2192 // Loads the constraints on a typical method definition, detecting cycles;
2193 // for use in verification.
2194 virtual void initConstraintsForVerification(
2195 CORINFO_METHOD_HANDLE method, /* IN */
2196 BOOL *pfHasCircularClassConstraints, /* OUT */
2197 BOOL *pfHasCircularMethodConstraint /* OUT */
2200 // Returns enum whether the method does not require verification
2201 // Also see ICorModuleInfo::canSkipVerification
2202 virtual CorInfoCanSkipVerificationResult canSkipMethodVerification (
2203 CORINFO_METHOD_HANDLE ftnHandle
2206 // load and restore the method
2207 virtual void methodMustBeLoadedBeforeCodeIsRun(
2208 CORINFO_METHOD_HANDLE method
2211 virtual CORINFO_METHOD_HANDLE mapMethodDeclToMethodImpl(
2212 CORINFO_METHOD_HANDLE method
2215 // Returns the global cookie for the /GS unsafe buffer checks
2216 // The cookie might be a constant value (JIT), or a handle to memory location (Ngen)
2217 virtual void getGSCookie(
2218 GSCookie * pCookieVal, // OUT
2219 GSCookie ** ppCookieVal // OUT
2222 /**********************************************************************************/
2226 /**********************************************************************************/
2228 // Resolve metadata token into runtime method handles. This function may not
2229 // return normally (e.g. it may throw) if it encounters invalid metadata or other
2230 // failures during token resolution.
2231 virtual void resolveToken(/* IN, OUT */ CORINFO_RESOLVED_TOKEN * pResolvedToken) = 0;
2233 // Attempt to resolve a metadata token into a runtime method handle. Returns true
2234 // if resolution succeeded and false otherwise (e.g. if it encounters invalid metadata
2235 // during token reoslution). This method should be used instead of `resolveToken` in
2236 // situations that need to be resilient to invalid metadata.
2237 virtual bool tryResolveToken(/* IN, OUT */ CORINFO_RESOLVED_TOKEN * pResolvedToken) = 0;
2239 // Signature information about the call sig
2240 virtual void findSig (
2241 CORINFO_MODULE_HANDLE module, /* IN */
2242 unsigned sigTOK, /* IN */
2243 CORINFO_CONTEXT_HANDLE context, /* IN */
2244 CORINFO_SIG_INFO *sig /* OUT */
2247 // for Varargs, the signature at the call site may differ from
2248 // the signature at the definition. Thus we need a way of
2249 // fetching the call site information
2250 virtual void findCallSiteSig (
2251 CORINFO_MODULE_HANDLE module, /* IN */
2252 unsigned methTOK, /* IN */
2253 CORINFO_CONTEXT_HANDLE context, /* IN */
2254 CORINFO_SIG_INFO *sig /* OUT */
2257 virtual CORINFO_CLASS_HANDLE getTokenTypeAsHandle (
2258 CORINFO_RESOLVED_TOKEN * pResolvedToken /* IN */) = 0;
2260 // Returns true if the module does not require verification
2262 // If fQuickCheckOnlyWithoutCommit=TRUE, the function only checks that the
2263 // module does not currently require verification in the current AppDomain.
2264 // This decision could change in the future, and so should not be cached.
2265 // If it is cached, it should only be used as a hint.
2266 // This is only used by ngen for calculating certain hints.
2269 // Returns enum whether the module does not require verification
2270 // Also see ICorMethodInfo::canSkipMethodVerification();
2271 virtual CorInfoCanSkipVerificationResult canSkipVerification (
2272 CORINFO_MODULE_HANDLE module /* IN */
2275 // Checks if the given metadata token is valid
2276 virtual BOOL isValidToken (
2277 CORINFO_MODULE_HANDLE module, /* IN */
2278 unsigned metaTOK /* IN */
2281 // Checks if the given metadata token is valid StringRef
2282 virtual BOOL isValidStringRef (
2283 CORINFO_MODULE_HANDLE module, /* IN */
2284 unsigned metaTOK /* IN */
2287 virtual BOOL shouldEnforceCallvirtRestriction(
2288 CORINFO_MODULE_HANDLE scope
2291 /**********************************************************************************/
2295 /**********************************************************************************/
2297 // If the value class 'cls' is isomorphic to a primitive type it will
2298 // return that type, otherwise it will return CORINFO_TYPE_VALUECLASS
2299 virtual CorInfoType asCorInfoType (
2300 CORINFO_CLASS_HANDLE cls
2304 virtual const char* getClassName (
2305 CORINFO_CLASS_HANDLE cls
2308 // Return class name as in metadata, or nullptr if there is none.
2309 // Suitable for non-debugging use.
2310 virtual const char* getClassNameFromMetadata (
2311 CORINFO_CLASS_HANDLE cls,
2312 const char **namespaceName /* OUT */
2315 // Return the type argument of the instantiated generic class,
2316 // which is specified by the index
2317 virtual CORINFO_CLASS_HANDLE getTypeInstantiationArgument(
2318 CORINFO_CLASS_HANDLE cls,
2323 // Append a (possibly truncated) representation of the type cls to the preallocated buffer ppBuf of length pnBufLen
2324 // If fNamespace=TRUE, include the namespace/enclosing classes
2325 // If fFullInst=TRUE (regardless of fNamespace and fAssembly), include namespace and assembly for any type parameters
2326 // If fAssembly=TRUE, suffix with a comma and the full assembly qualification
2327 // return size of representation
2328 virtual int appendClassName(
2329 __deref_inout_ecount(*pnBufLen) WCHAR** ppBuf,
2331 CORINFO_CLASS_HANDLE cls,
2337 // Quick check whether the type is a value class. Returns the same value as getClassAttribs(cls) & CORINFO_FLG_VALUECLASS, except faster.
2338 virtual BOOL isValueClass(CORINFO_CLASS_HANDLE cls) = 0;
2340 // If this method returns true, JIT will do optimization to inline the check for
2341 // GetTypeFromHandle(handle) == obj.GetType()
2342 virtual BOOL canInlineTypeCheckWithObjectVTable(CORINFO_CLASS_HANDLE cls) = 0;
2344 // return flags (defined above, CORINFO_FLG_PUBLIC ...)
2345 virtual DWORD getClassAttribs (
2346 CORINFO_CLASS_HANDLE cls
2349 // Returns "TRUE" iff "cls" is a struct type such that return buffers used for returning a value
2350 // of this type must be stack-allocated. This will generally be true only if the struct
2351 // contains GC pointers, and does not exceed some size limit. Maintaining this as an invariant allows
2352 // an optimization: the JIT may assume that return buffer pointers for return types for which this predicate
2353 // returns TRUE are always stack allocated, and thus, that stores to the GC-pointer fields of such return
2354 // buffers do not require GC write barriers.
2355 virtual BOOL isStructRequiringStackAllocRetBuf(CORINFO_CLASS_HANDLE cls) = 0;
2357 virtual CORINFO_MODULE_HANDLE getClassModule (
2358 CORINFO_CLASS_HANDLE cls
2361 // Returns the assembly that contains the module "mod".
2362 virtual CORINFO_ASSEMBLY_HANDLE getModuleAssembly (
2363 CORINFO_MODULE_HANDLE mod
2366 // Returns the name of the assembly "assem".
2367 virtual const char* getAssemblyName (
2368 CORINFO_ASSEMBLY_HANDLE assem
2371 // Allocate and delete process-lifetime objects. Should only be
2372 // referred to from static fields, lest a leak occur.
2373 // Note that "LongLifetimeFree" does not execute destructors, if "obj"
2374 // is an array of a struct type with a destructor.
2375 virtual void* LongLifetimeMalloc(size_t sz) = 0;
2376 virtual void LongLifetimeFree(void* obj) = 0;
2378 virtual size_t getClassModuleIdForStatics (
2379 CORINFO_CLASS_HANDLE cls,
2380 CORINFO_MODULE_HANDLE *pModule,
2381 void **ppIndirection
2384 // return the number of bytes needed by an instance of the class
2385 virtual unsigned getClassSize (
2386 CORINFO_CLASS_HANDLE cls
2389 virtual unsigned getClassAlignmentRequirement (
2390 CORINFO_CLASS_HANDLE cls,
2391 BOOL fDoubleAlignHint = FALSE
2394 // This is only called for Value classes. It returns a boolean array
2395 // in representing of 'cls' from a GC perspective. The class is
2396 // assumed to be an array of machine words
2397 // (of length // getClassSize(cls) / TARGET_POINTER_SIZE),
2398 // 'gcPtrs' is a pointer to an array of BYTEs of this length.
2399 // getClassGClayout fills in this array so that gcPtrs[i] is set
2400 // to one of the CorInfoGCType values which is the GC type of
2401 // the i-th machine word of an object of type 'cls'
2402 // returns the number of GC pointers in the array
2403 virtual unsigned getClassGClayout (
2404 CORINFO_CLASS_HANDLE cls, /* IN */
2405 BYTE *gcPtrs /* OUT */
2408 // returns the number of instance fields in a class
2409 virtual unsigned getClassNumInstanceFields (
2410 CORINFO_CLASS_HANDLE cls /* IN */
2413 virtual CORINFO_FIELD_HANDLE getFieldInClass(
2414 CORINFO_CLASS_HANDLE clsHnd,
2418 virtual BOOL checkMethodModifier(
2419 CORINFO_METHOD_HANDLE hMethod,
2424 // returns the "NEW" helper optimized for "newCls."
2425 virtual CorInfoHelpFunc getNewHelper(
2426 CORINFO_RESOLVED_TOKEN * pResolvedToken,
2427 CORINFO_METHOD_HANDLE callerHandle
2430 // returns the newArr (1-Dim array) helper optimized for "arrayCls."
2431 virtual CorInfoHelpFunc getNewArrHelper(
2432 CORINFO_CLASS_HANDLE arrayCls
2435 // returns the optimized "IsInstanceOf" or "ChkCast" helper
2436 virtual CorInfoHelpFunc getCastingHelper(
2437 CORINFO_RESOLVED_TOKEN * pResolvedToken,
2441 // returns helper to trigger static constructor
2442 virtual CorInfoHelpFunc getSharedCCtorHelper(
2443 CORINFO_CLASS_HANDLE clsHnd
2446 virtual CorInfoHelpFunc getSecurityPrologHelper(
2447 CORINFO_METHOD_HANDLE ftn
2450 // This is not pretty. Boxing nullable<T> actually returns
2451 // a boxed<T> not a boxed Nullable<T>. This call allows the verifier
2452 // to call back to the EE on the 'box' instruction and get the transformed
2453 // type to use for verification.
2454 virtual CORINFO_CLASS_HANDLE getTypeForBox(
2455 CORINFO_CLASS_HANDLE cls
2458 // returns the correct box helper for a particular class. Note
2459 // that if this returns CORINFO_HELP_BOX, the JIT can assume
2460 // 'standard' boxing (allocate object and copy), and optimize
2461 virtual CorInfoHelpFunc getBoxHelper(
2462 CORINFO_CLASS_HANDLE cls
2465 // returns the unbox helper. If 'helperCopies' points to a true
2466 // value it means the JIT is requesting a helper that unboxes the
2467 // value into a particular location and thus has the signature
2468 // void unboxHelper(void* dest, CORINFO_CLASS_HANDLE cls, Object* obj)
2469 // Otherwise (it is null or points at a FALSE value) it is requesting
2470 // a helper that returns a pointer to the unboxed data
2471 // void* unboxHelper(CORINFO_CLASS_HANDLE cls, Object* obj)
2472 // The EE has the option of NOT returning the copy style helper
2473 // (But must be able to always honor the non-copy style helper)
2474 // The EE set 'helperCopies' on return to indicate what kind of
2475 // helper has been created.
2477 virtual CorInfoHelpFunc getUnBoxHelper(
2478 CORINFO_CLASS_HANDLE cls
2481 virtual bool getReadyToRunHelper(
2482 CORINFO_RESOLVED_TOKEN * pResolvedToken,
2483 CORINFO_LOOKUP_KIND * pGenericLookupKind,
2485 CORINFO_CONST_LOOKUP * pLookup
2488 virtual void getReadyToRunDelegateCtorHelper(
2489 CORINFO_RESOLVED_TOKEN * pTargetMethod,
2490 CORINFO_CLASS_HANDLE delegateType,
2491 CORINFO_LOOKUP * pLookup
2494 virtual const char* getHelperName(
2498 // This function tries to initialize the class (run the class constructor).
2499 // this function returns whether the JIT must insert helper calls before
2500 // accessing static field or method.
2502 // See code:ICorClassInfo#ClassConstruction.
2503 virtual CorInfoInitClassResult initClass(
2504 CORINFO_FIELD_HANDLE field, // Non-NULL - inquire about cctor trigger before static field access
2505 // NULL - inquire about cctor trigger in method prolog
2506 CORINFO_METHOD_HANDLE method, // Method referencing the field or prolog
2507 CORINFO_CONTEXT_HANDLE context, // Exact context of method
2508 BOOL speculative = FALSE // TRUE means don't actually run it
2511 // This used to be called "loadClass". This records the fact
2512 // that the class must be loaded (including restored if necessary) before we execute the
2513 // code that we are currently generating. When jitting code
2514 // the function loads the class immediately. When zapping code
2515 // the zapper will if necessary use the call to record the fact that we have
2516 // to do a fixup/restore before running the method currently being generated.
2518 // This is typically used to ensure value types are loaded before zapped
2519 // code that manipulates them is executed, so that the GC can access information
2520 // about those value types.
2521 virtual void classMustBeLoadedBeforeCodeIsRun(
2522 CORINFO_CLASS_HANDLE cls
2525 // returns the class handle for the special builtin classes
2526 virtual CORINFO_CLASS_HANDLE getBuiltinClass (
2527 CorInfoClassId classId
2530 // "System.Int32" ==> CORINFO_TYPE_INT..
2531 virtual CorInfoType getTypeForPrimitiveValueClass(
2532 CORINFO_CLASS_HANDLE cls
2535 // "System.Int32" ==> CORINFO_TYPE_INT..
2536 // "System.UInt32" ==> CORINFO_TYPE_UINT..
2537 virtual CorInfoType getTypeForPrimitiveNumericClass(
2538 CORINFO_CLASS_HANDLE cls
2541 // TRUE if child is a subtype of parent
2542 // if parent is an interface, then does child implement / extend parent
2543 virtual BOOL canCast(
2544 CORINFO_CLASS_HANDLE child, // subtype (extends parent)
2545 CORINFO_CLASS_HANDLE parent // base type
2548 // TRUE if cls1 and cls2 are considered equivalent types.
2549 virtual BOOL areTypesEquivalent(
2550 CORINFO_CLASS_HANDLE cls1,
2551 CORINFO_CLASS_HANDLE cls2
2554 // See if a cast from fromClass to toClass will succeed, fail, or needs
2555 // to be resolved at runtime.
2556 virtual TypeCompareState compareTypesForCast(
2557 CORINFO_CLASS_HANDLE fromClass,
2558 CORINFO_CLASS_HANDLE toClass
2561 // See if types represented by cls1 and cls2 compare equal, not
2562 // equal, or the comparison needs to be resolved at runtime.
2563 virtual TypeCompareState compareTypesForEquality(
2564 CORINFO_CLASS_HANDLE cls1,
2565 CORINFO_CLASS_HANDLE cls2
2568 // returns is the intersection of cls1 and cls2.
2569 virtual CORINFO_CLASS_HANDLE mergeClasses(
2570 CORINFO_CLASS_HANDLE cls1,
2571 CORINFO_CLASS_HANDLE cls2
2574 // Given a class handle, returns the Parent type.
2575 // For COMObjectType, it returns Class Handle of System.Object.
2576 // Returns 0 if System.Object is passed in.
2577 virtual CORINFO_CLASS_HANDLE getParentType (
2578 CORINFO_CLASS_HANDLE cls
2581 // Returns the CorInfoType of the "child type". If the child type is
2582 // not a primitive type, *clsRet will be set.
2583 // Given an Array of Type Foo, returns Foo.
2584 // Given BYREF Foo, returns Foo
2585 virtual CorInfoType getChildType (
2586 CORINFO_CLASS_HANDLE clsHnd,
2587 CORINFO_CLASS_HANDLE *clsRet
2590 // Check constraints on type arguments of this class and parent classes
2591 virtual BOOL satisfiesClassConstraints(
2592 CORINFO_CLASS_HANDLE cls
2595 // Check if this is a single dimensional array type
2596 virtual BOOL isSDArray(
2597 CORINFO_CLASS_HANDLE cls
2600 // Get the numbmer of dimensions in an array
2601 virtual unsigned getArrayRank(
2602 CORINFO_CLASS_HANDLE cls
2605 // Get static field data for an array
2606 virtual void * getArrayInitializationData(
2607 CORINFO_FIELD_HANDLE field,
2611 // Check Visibility rules.
2612 virtual CorInfoIsAccessAllowedResult canAccessClass(
2613 CORINFO_RESOLVED_TOKEN * pResolvedToken,
2614 CORINFO_METHOD_HANDLE callerHandle,
2615 CORINFO_HELPER_DESC *pAccessHelper /* If canAccessMethod returns something other
2616 than ALLOWED, then this is filled in. */
2619 /**********************************************************************************/
2623 /**********************************************************************************/
2625 // this function is for debugging only. It returns the field name
2626 // and if 'moduleName' is non-null, it sets it to something that will
2627 // says which method (a class name, or a module name)
2628 virtual const char* getFieldName (
2629 CORINFO_FIELD_HANDLE ftn, /* IN */
2630 const char **moduleName /* OUT */
2633 // return class it belongs to
2634 virtual CORINFO_CLASS_HANDLE getFieldClass (
2635 CORINFO_FIELD_HANDLE field
2638 // Return the field's type, if it is CORINFO_TYPE_VALUECLASS 'structType' is set
2639 // the field's value class (if 'structType' == 0, then don't bother
2640 // the structure info).
2642 // 'memberParent' is typically only set when verifying. It should be the
2643 // result of calling getMemberParent.
2644 virtual CorInfoType getFieldType(
2645 CORINFO_FIELD_HANDLE field,
2646 CORINFO_CLASS_HANDLE *structType,
2647 CORINFO_CLASS_HANDLE memberParent = NULL /* IN */
2650 // return the data member's instance offset
2651 virtual unsigned getFieldOffset(
2652 CORINFO_FIELD_HANDLE field
2655 // TODO: jit64 should be switched to the same plan as the i386 jits - use
2656 // getClassGClayout to figure out the need for writebarrier helper, and inline the copying.
2657 // The interpretted value class copy is slow. Once this happens, USE_WRITE_BARRIER_HELPERS
2658 virtual bool isWriteBarrierHelperRequired(
2659 CORINFO_FIELD_HANDLE field) = 0;
2661 virtual void getFieldInfo (CORINFO_RESOLVED_TOKEN * pResolvedToken,
2662 CORINFO_METHOD_HANDLE callerHandle,
2663 CORINFO_ACCESS_FLAGS flags,
2664 CORINFO_FIELD_INFO *pResult
2667 // Returns true iff "fldHnd" represents a static field.
2668 virtual bool isFieldStatic(CORINFO_FIELD_HANDLE fldHnd) = 0;
2670 /*********************************************************************************/
2674 /*********************************************************************************/
2676 // Query the EE to find out where interesting break points
2677 // in the code are. The native compiler will ensure that these places
2678 // have a corresponding break point in native code.
2680 // Note that unless CORJIT_FLAG_DEBUG_CODE is specified, this function will
2681 // be used only as a hint and the native compiler should not change its
2683 virtual void getBoundaries(
2684 CORINFO_METHOD_HANDLE ftn, // [IN] method of interest
2685 unsigned int *cILOffsets, // [OUT] size of pILOffsets
2686 DWORD **pILOffsets, // [OUT] IL offsets of interest
2687 // jit MUST free with freeArray!
2688 ICorDebugInfo::BoundaryTypes *implictBoundaries // [OUT] tell jit, all boundries of this type
2691 // Report back the mapping from IL to native code,
2692 // this map should include all boundaries that 'getBoundaries'
2693 // reported as interesting to the debugger.
2695 // Note that debugger (and profiler) is assuming that all of the
2696 // offsets form a contiguous block of memory, and that the
2697 // OffsetMapping is sorted in order of increasing native offset.
2698 virtual void setBoundaries(
2699 CORINFO_METHOD_HANDLE ftn, // [IN] method of interest
2700 ULONG32 cMap, // [IN] size of pMap
2701 ICorDebugInfo::OffsetMapping *pMap // [IN] map including all points of interest.
2702 // jit allocated with allocateArray, EE frees
2705 // Query the EE to find out the scope of local varables.
2706 // normally the JIT would trash variables after last use, but
2707 // under debugging, the JIT needs to keep them live over their
2708 // entire scope so that they can be inspected.
2710 // Note that unless CORJIT_FLAG_DEBUG_CODE is specified, this function will
2711 // be used only as a hint and the native compiler should not change its
2713 virtual void getVars(
2714 CORINFO_METHOD_HANDLE ftn, // [IN] method of interest
2715 ULONG32 *cVars, // [OUT] size of 'vars'
2716 ICorDebugInfo::ILVarInfo **vars, // [OUT] scopes of variables of interest
2717 // jit MUST free with freeArray!
2718 bool *extendOthers // [OUT] it TRUE, then assume the scope
2719 // of unmentioned vars is entire method
2722 // Report back to the EE the location of every variable.
2723 // note that the JIT might split lifetimes into different
2726 virtual void setVars(
2727 CORINFO_METHOD_HANDLE ftn, // [IN] method of interest
2728 ULONG32 cVars, // [IN] size of 'vars'
2729 ICorDebugInfo::NativeVarInfo *vars // [IN] map telling where local vars are stored at what points
2730 // jit allocated with allocateArray, EE frees
2733 /*-------------------------- Misc ---------------------------------------*/
2735 // Used to allocate memory that needs to handed to the EE.
2736 // For eg, use this to allocated memory for reporting debug info,
2737 // which will be handed to the EE by setVars() and setBoundaries()
2738 virtual void * allocateArray(
2742 // JitCompiler will free arrays passed by the EE using this
2743 // For eg, The EE returns memory in getVars() and getBoundaries()
2744 // to the JitCompiler, which the JitCompiler should release using
2746 virtual void freeArray(
2750 /*********************************************************************************/
2754 /*********************************************************************************/
2756 // advance the pointer to the argument list.
2757 // a ptr of 0, is special and always means the first argument
2758 virtual CORINFO_ARG_LIST_HANDLE getArgNext (
2759 CORINFO_ARG_LIST_HANDLE args /* IN */
2762 // Get the type of a particular argument
2763 // CORINFO_TYPE_UNDEF is returned when there are no more arguments
2764 // If the type returned is a primitive type (or an enum) *vcTypeRet set to NULL
2765 // otherwise it is set to the TypeHandle associted with the type
2766 // Enumerations will always look their underlying type (probably should fix this)
2767 // Otherwise vcTypeRet is the type as would be seen by the IL,
2768 // The return value is the type that is used for calling convention purposes
2769 // (Thus if the EE wants a value class to be passed like an int, then it will
2770 // return CORINFO_TYPE_INT
2771 virtual CorInfoTypeWithMod getArgType (
2772 CORINFO_SIG_INFO* sig, /* IN */
2773 CORINFO_ARG_LIST_HANDLE args, /* IN */
2774 CORINFO_CLASS_HANDLE *vcTypeRet /* OUT */
2777 // If the Arg is a CORINFO_TYPE_CLASS fetch the class handle associated with it
2778 virtual CORINFO_CLASS_HANDLE getArgClass (
2779 CORINFO_SIG_INFO* sig, /* IN */
2780 CORINFO_ARG_LIST_HANDLE args /* IN */
2783 // Returns type of HFA for valuetype
2784 virtual CorInfoType getHFAType (
2785 CORINFO_CLASS_HANDLE hClass
2788 /*****************************************************************************
2789 * ICorErrorInfo contains methods to deal with SEH exceptions being thrown
2790 * from the corinfo interface. These methods may be called when an exception
2791 * with code EXCEPTION_COMPLUS is caught.
2792 *****************************************************************************/
2794 // Returns the HRESULT of the current exception
2795 virtual HRESULT GetErrorHRESULT(
2796 struct _EXCEPTION_POINTERS *pExceptionPointers
2799 // Fetches the message of the current exception
2800 // Returns the size of the message (including terminating null). This can be
2801 // greater than bufferLength if the buffer is insufficient.
2802 virtual ULONG GetErrorMessage(
2803 __inout_ecount(bufferLength) LPWSTR buffer,
2807 // returns EXCEPTION_EXECUTE_HANDLER if it is OK for the compile to handle the
2808 // exception, abort some work (like the inlining) and continue compilation
2809 // returns EXCEPTION_CONTINUE_SEARCH if exception must always be handled by the EE
2810 // things like ThreadStoppedException ...
2811 // returns EXCEPTION_CONTINUE_EXECUTION if exception is fixed up by the EE
2813 virtual int FilterException(
2814 struct _EXCEPTION_POINTERS *pExceptionPointers
2817 // Cleans up internal EE tracking when an exception is caught.
2818 virtual void HandleException(
2819 struct _EXCEPTION_POINTERS *pExceptionPointers
2822 virtual void ThrowExceptionForJitResult(
2823 HRESULT result) = 0;
2825 //Throws an exception defined by the given throw helper.
2826 virtual void ThrowExceptionForHelper(
2827 const CORINFO_HELPER_DESC * throwHelper) = 0;
2829 // Runs the given function under an error trap. This allows the JIT to make calls
2830 // to interface functions that may throw exceptions without needing to be aware of
2831 // the EH ABI, exception types, etc. Returns true if the given function completed
2832 // successfully and false otherwise.
2833 virtual bool runWithErrorTrap(
2834 void (*function)(void*), // The function to run
2835 void* parameter // The context parameter that will be passed to the function and the handler
2838 /*****************************************************************************
2839 * ICorStaticInfo contains EE interface methods which return values that are
2840 * constant from invocation to invocation. Thus they may be embedded in
2841 * persisted information like statically generated code. (This is of course
2842 * assuming that all code versions are identical each time.)
2843 *****************************************************************************/
2845 // Return details about EE internal data structures
2846 virtual void getEEInfo(
2847 CORINFO_EE_INFO *pEEInfoOut
2850 // Returns name of the JIT timer log
2851 virtual LPCWSTR getJitTimeLogFilename() = 0;
2853 /*********************************************************************************/
2855 // Diagnostic methods
2857 /*********************************************************************************/
2859 // this function is for debugging only. Returns method token.
2860 // Returns mdMethodDefNil for dynamic methods.
2861 virtual mdMethodDef getMethodDefFromMethod(
2862 CORINFO_METHOD_HANDLE hMethod
2865 // this function is for debugging only. It returns the method name
2866 // and if 'moduleName' is non-null, it sets it to something that will
2867 // says which method (a class name, or a module name)
2868 virtual const char* getMethodName (
2869 CORINFO_METHOD_HANDLE ftn, /* IN */
2870 const char **moduleName /* OUT */
2873 // Return method name as in metadata, or nullptr if there is none,
2874 // and optionally return the class and namespace names as in metadata.
2875 // Suitable for non-debugging use.
2876 virtual const char* getMethodNameFromMetadata(
2877 CORINFO_METHOD_HANDLE ftn, /* IN */
2878 const char **className, /* OUT */
2879 const char **namespaceName /* OUT */
2882 // this function is for debugging only. It returns a value that
2883 // is will always be the same for a given method. It is used
2884 // to implement the 'jitRange' functionality
2885 virtual unsigned getMethodHash (
2886 CORINFO_METHOD_HANDLE ftn /* IN */
2889 // this function is for debugging only.
2890 virtual size_t findNameOfToken (
2891 CORINFO_MODULE_HANDLE module, /* IN */
2892 mdToken metaTOK, /* IN */
2893 __out_ecount (FQNameCapacity) char * szFQName, /* OUT */
2894 size_t FQNameCapacity /* IN */
2897 // returns whether the struct is enregisterable. Only valid on a System V VM. Returns true on success, false on failure.
2898 virtual bool getSystemVAmd64PassStructInRegisterDescriptor(
2899 /* IN */ CORINFO_CLASS_HANDLE structHnd,
2900 /* OUT */ SYSTEMV_AMD64_CORINFO_STRUCT_REG_PASSING_DESCRIPTOR* structPassInRegDescPtr
2905 /*****************************************************************************
2906 * ICorDynamicInfo contains EE interface methods which return values that may
2907 * change from invocation to invocation. They cannot be embedded in persisted
2908 * data; they must be requeried each time the EE is run.
2909 *****************************************************************************/
2911 class ICorDynamicInfo : public ICorStaticInfo
2916 // These methods return values to the JIT which are not constant
2917 // from session to session.
2919 // These methods take an extra parameter : void **ppIndirection.
2920 // If a JIT supports generation of prejit code (install-o-jit), it
2921 // must pass a non-null value for this parameter, and check the
2922 // resulting value. If *ppIndirection is NULL, code should be
2923 // generated normally. If non-null, then the value of
2924 // *ppIndirection is an address in the cookie table, and the code
2925 // generator needs to generate an indirection through the table to
2926 // get the resulting value. In this case, the return result of the
2927 // function must NOT be directly embedded in the generated code.
2929 // Note that if a JIT does not support prejit code generation, it
2930 // may ignore the extra parameter & pass the default of NULL - the
2931 // prejit ICorDynamicInfo implementation will see this & generate
2932 // an error if the jitter is used in a prejit scenario.
2935 // Return details about EE internal data structures
2937 virtual DWORD getThreadTLSIndex(
2938 void **ppIndirection = NULL
2941 virtual const void * getInlinedCallFrameVptr(
2942 void **ppIndirection = NULL
2945 virtual LONG * getAddrOfCaptureThreadGlobal(
2946 void **ppIndirection = NULL
2949 // return the native entry point to an EE helper (see CorInfoHelpFunc)
2950 virtual void* getHelperFtn (
2951 CorInfoHelpFunc ftnNum,
2952 void **ppIndirection = NULL
2955 // return a callable address of the function (native code). This function
2956 // may return a different value (depending on whether the method has
2957 // been JITed or not.
2958 virtual void getFunctionEntryPoint(
2959 CORINFO_METHOD_HANDLE ftn, /* IN */
2960 CORINFO_CONST_LOOKUP * pResult, /* OUT */
2961 CORINFO_ACCESS_FLAGS accessFlags = CORINFO_ACCESS_ANY) = 0;
2963 // return a directly callable address. This can be used similarly to the
2964 // value returned by getFunctionEntryPoint() except that it is
2965 // guaranteed to be multi callable entrypoint.
2966 virtual void getFunctionFixedEntryPoint(
2967 CORINFO_METHOD_HANDLE ftn,
2968 CORINFO_CONST_LOOKUP * pResult) = 0;
2970 // get the synchronization handle that is passed to monXstatic function
2971 virtual void* getMethodSync(
2972 CORINFO_METHOD_HANDLE ftn,
2973 void **ppIndirection = NULL
2976 // get slow lazy string literal helper to use (CORINFO_HELP_STRCNS*).
2977 // Returns CORINFO_HELP_UNDEF if lazy string literal helper cannot be used.
2978 virtual CorInfoHelpFunc getLazyStringLiteralHelper(
2979 CORINFO_MODULE_HANDLE handle
2982 virtual CORINFO_MODULE_HANDLE embedModuleHandle(
2983 CORINFO_MODULE_HANDLE handle,
2984 void **ppIndirection = NULL
2987 virtual CORINFO_CLASS_HANDLE embedClassHandle(
2988 CORINFO_CLASS_HANDLE handle,
2989 void **ppIndirection = NULL
2992 virtual CORINFO_METHOD_HANDLE embedMethodHandle(
2993 CORINFO_METHOD_HANDLE handle,
2994 void **ppIndirection = NULL
2997 virtual CORINFO_FIELD_HANDLE embedFieldHandle(
2998 CORINFO_FIELD_HANDLE handle,
2999 void **ppIndirection = NULL
3002 // Given a module scope (module), a method handle (context) and
3003 // a metadata token (metaTOK), fetch the handle
3004 // (type, field or method) associated with the token.
3005 // If this is not possible at compile-time (because the current method's
3006 // code is shared and the token contains generic parameters)
3007 // then indicate how the handle should be looked up at run-time.
3009 virtual void embedGenericHandle(
3010 CORINFO_RESOLVED_TOKEN * pResolvedToken,
3011 BOOL fEmbedParent, // TRUE - embeds parent type handle of the field/method handle
3012 CORINFO_GENERICHANDLE_RESULT * pResult) = 0;
3014 // Return information used to locate the exact enclosing type of the current method.
3015 // Used only to invoke .cctor method from code shared across generic instantiations
3016 // !needsRuntimeLookup statically known (enclosing type of method itself)
3017 // needsRuntimeLookup:
3018 // CORINFO_LOOKUP_THISOBJ use vtable pointer of 'this' param
3019 // CORINFO_LOOKUP_CLASSPARAM use vtable hidden param
3020 // CORINFO_LOOKUP_METHODPARAM use enclosing type of method-desc hidden param
3021 virtual CORINFO_LOOKUP_KIND getLocationOfThisType(
3022 CORINFO_METHOD_HANDLE context
3025 // NOTE: the two methods below--getPInvokeUnmanagedTarget and getAddressOfPInvokeFixup--are
3026 // deprecated. New code should instead use getAddressOfPInvokeTarget, which subsumes the
3027 // functionality of these methods.
3029 // return the unmanaged target *if method has already been prelinked.*
3030 virtual void* getPInvokeUnmanagedTarget(
3031 CORINFO_METHOD_HANDLE method,
3032 void **ppIndirection = NULL
3035 // return address of fixup area for late-bound PInvoke calls.
3036 virtual void* getAddressOfPInvokeFixup(
3037 CORINFO_METHOD_HANDLE method,
3038 void **ppIndirection = NULL
3041 // return the address of the PInvoke target. May be a fixup area in the
3042 // case of late-bound PInvoke calls.
3043 virtual void getAddressOfPInvokeTarget(
3044 CORINFO_METHOD_HANDLE method,
3045 CORINFO_CONST_LOOKUP *pLookup
3048 // Generate a cookie based on the signature that would needs to be passed
3049 // to CORINFO_HELP_PINVOKE_CALLI
3050 virtual LPVOID GetCookieForPInvokeCalliSig(
3051 CORINFO_SIG_INFO* szMetaSig,
3052 void ** ppIndirection = NULL
3055 // returns true if a VM cookie can be generated for it (might be false due to cross-module
3056 // inlining, in which case the inlining should be aborted)
3057 virtual bool canGetCookieForPInvokeCalliSig(
3058 CORINFO_SIG_INFO* szMetaSig
3061 // Gets a handle that is checked to see if the current method is
3062 // included in "JustMyCode"
3063 virtual CORINFO_JUST_MY_CODE_HANDLE getJustMyCodeHandle(
3064 CORINFO_METHOD_HANDLE method,
3065 CORINFO_JUST_MY_CODE_HANDLE**ppIndirection = NULL
3068 // Gets a method handle that can be used to correlate profiling data.
3069 // This is the IP of a native method, or the address of the descriptor struct
3070 // for IL. Always guaranteed to be unique per process, and not to move. */
3071 virtual void GetProfilingHandle(
3072 BOOL *pbHookFunction,
3073 void **pProfilerHandle,
3074 BOOL *pbIndirectedHandles
3077 // Returns instructions on how to make the call. See code:CORINFO_CALL_INFO for possible return values.
3078 virtual void getCallInfo(
3080 CORINFO_RESOLVED_TOKEN * pResolvedToken,
3083 CORINFO_RESOLVED_TOKEN * pConstrainedResolvedToken,
3086 CORINFO_METHOD_HANDLE callerHandle,
3089 CORINFO_CALLINFO_FLAGS flags,
3092 CORINFO_CALL_INFO *pResult
3095 virtual BOOL canAccessFamily(CORINFO_METHOD_HANDLE hCaller,
3096 CORINFO_CLASS_HANDLE hInstanceType) = 0;
3098 // Returns TRUE if the Class Domain ID is the RID of the class (currently true for every class
3099 // except reflection emitted classes and generics)
3100 virtual BOOL isRIDClassDomainID(CORINFO_CLASS_HANDLE cls) = 0;
3102 // returns the class's domain ID for accessing shared statics
3103 virtual unsigned getClassDomainID (
3104 CORINFO_CLASS_HANDLE cls,
3105 void **ppIndirection = NULL
3109 // return the data's address (for static fields only)
3110 virtual void* getFieldAddress(
3111 CORINFO_FIELD_HANDLE field,
3112 void **ppIndirection = NULL
3115 // registers a vararg sig & returns a VM cookie for it (which can contain other stuff)
3116 virtual CORINFO_VARARGS_HANDLE getVarArgsHandle(
3117 CORINFO_SIG_INFO *pSig,
3118 void **ppIndirection = NULL
3121 // returns true if a VM cookie can be generated for it (might be false due to cross-module
3122 // inlining, in which case the inlining should be aborted)
3123 virtual bool canGetVarArgsHandle(
3124 CORINFO_SIG_INFO *pSig
3127 // Allocate a string literal on the heap and return a handle to it
3128 virtual InfoAccessType constructStringLiteral(
3129 CORINFO_MODULE_HANDLE module,
3134 virtual InfoAccessType emptyStringLiteral(
3138 // (static fields only) given that 'field' refers to thread local store,
3139 // return the ID (TLS index), which is used to find the begining of the
3140 // TLS data area for the particular DLL 'field' is associated with.
3141 virtual DWORD getFieldThreadLocalStoreID (
3142 CORINFO_FIELD_HANDLE field,
3143 void **ppIndirection = NULL
3146 // Sets another object to intercept calls to "self" and current method being compiled
3147 virtual void setOverride(
3148 ICorDynamicInfo *pOverride,
3149 CORINFO_METHOD_HANDLE currentMethod
3152 // Adds an active dependency from the context method's module to the given module
3153 // This is internal callback for the EE. JIT should not call it directly.
3154 virtual void addActiveDependency(
3155 CORINFO_MODULE_HANDLE moduleFrom,
3156 CORINFO_MODULE_HANDLE moduleTo
3159 virtual CORINFO_METHOD_HANDLE GetDelegateCtor(
3160 CORINFO_METHOD_HANDLE methHnd,
3161 CORINFO_CLASS_HANDLE clsHnd,
3162 CORINFO_METHOD_HANDLE targetMethodHnd,
3163 DelegateCtorArgs * pCtorData
3166 virtual void MethodCompileComplete(
3167 CORINFO_METHOD_HANDLE methHnd
3170 // return a thunk that will copy the arguments for the given signature.
3171 virtual void* getTailCallCopyArgsThunk (
3172 CORINFO_SIG_INFO *pSig,
3173 CorInfoHelperTailCallSpecialHandling flags
3176 // Optionally, convert calli to regular method call. This is for PInvoke argument marshalling.
3177 virtual bool convertPInvokeCalliToCall(
3178 CORINFO_RESOLVED_TOKEN * pResolvedToken,
3183 /**********************************************************************************/
3185 // It would be nicer to use existing IMAGE_REL_XXX constants instead of defining our own here...
3186 #define IMAGE_REL_BASED_REL32 0x10
3187 #define IMAGE_REL_BASED_THUMB_BRANCH24 0x13
3189 // The identifier for ARM32-specific PC-relative address
3190 // computation corresponds to the following instruction
3192 // l0: movw rX, #imm_lo // 4 byte
3193 // l4: movt rX, #imm_hi // 4 byte
3194 // l8: add rX, pc <- after this instruction rX = relocTarget
3196 // Program counter at l8 is address of l8 + 4
3197 // Address of relocated movw/movt is l0
3198 // So, imm should be calculated as the following:
3199 // imm = relocTarget - (l8 + 4) = relocTarget - (l0 + 8 + 4) = relocTarget - (l_0 + 12)
3200 // So, the value of offset correction is 12
3202 #define IMAGE_REL_BASED_REL_THUMB_MOV32_PCREL 0x14
3204 #endif // _COR_INFO_H_