ICorDebugInfo is almost standalone data structure.
This puts ICorDebugInfo into a new cordebuginfo.h.
This new header file is just included in corinfo.h
This way we could share this debug data structure
with ObjectWriter/LLILC by simply including this header.
install (FILES cfi.h
cor.h
+ cordebuginfo.h
corhdr.h
corinfo.h
corjit.h
gcinfoencoder.h
gcinfotypes.h
DESTINATION inc)
-install (TARGETS corguids DESTINATION lib)
\ No newline at end of file
+install (TARGETS corguids DESTINATION lib)
--- /dev/null
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+/**********************************************************************************/
+// DebugInfo types shared by JIT-EE interface and EE-Debugger interface
+
+class ICorDebugInfo
+{
+public:
+ /*----------------------------- Boundary-info ---------------------------*/
+
+ enum MappingTypes
+ {
+ NO_MAPPING = -1,
+ PROLOG = -2,
+ EPILOG = -3,
+ MAX_MAPPING_VALUE = -3 // Sentinal value. This should be set to the largest magnitude value in the enum
+ // so that the compression routines know the enum's range.
+ };
+
+ enum BoundaryTypes
+ {
+ NO_BOUNDARIES = 0x00, // No implicit boundaries
+ STACK_EMPTY_BOUNDARIES = 0x01, // Boundary whenever the IL evaluation stack is empty
+ NOP_BOUNDARIES = 0x02, // Before every CEE_NOP instruction
+ CALL_SITE_BOUNDARIES = 0x04, // Before every CEE_CALL, CEE_CALLVIRT, etc instruction
+
+ // Set of boundaries that debugger should always reasonably ask the JIT for.
+ DEFAULT_BOUNDARIES = STACK_EMPTY_BOUNDARIES | NOP_BOUNDARIES | CALL_SITE_BOUNDARIES
+ };
+
+ // Note that SourceTypes can be OR'd together - it's possible that
+ // a sequence point will also be a stack_empty point, and/or a call site.
+ // The debugger will check to see if a boundary offset's source field &
+ // SEQUENCE_POINT is true to determine if the boundary is a sequence point.
+
+ enum SourceTypes
+ {
+ SOURCE_TYPE_INVALID = 0x00, // To indicate that nothing else applies
+ SEQUENCE_POINT = 0x01, // The debugger asked for it.
+ STACK_EMPTY = 0x02, // The stack is empty here
+ CALL_SITE = 0x04, // This is a call site.
+ NATIVE_END_OFFSET_UNKNOWN = 0x08, // Indicates a epilog endpoint
+ CALL_INSTRUCTION = 0x10 // The actual instruction of a call.
+
+ };
+
+ struct OffsetMapping
+ {
+ DWORD nativeOffset;
+ DWORD ilOffset;
+ SourceTypes source; // The debugger needs this so that
+ // we don't put Edit and Continue breakpoints where
+ // the stack isn't empty. We can put regular breakpoints
+ // there, though, so we need a way to discriminate
+ // between offsets.
+ };
+
+ /*------------------------------ Var-info -------------------------------*/
+
+ // Note: The debugger needs to target register numbers on platforms other than which the debugger itself
+ // is running. To this end it maintains its own values for REGNUM_SP and REGNUM_AMBIENT_SP across multiple
+ // platforms. So any change here that may effect these values should be reflected in the definitions
+ // contained in debug/inc/DbgIPCEvents.h.
+ enum RegNum
+ {
+#ifdef _TARGET_X86_
+ REGNUM_EAX,
+ REGNUM_ECX,
+ REGNUM_EDX,
+ REGNUM_EBX,
+ REGNUM_ESP,
+ REGNUM_EBP,
+ REGNUM_ESI,
+ REGNUM_EDI,
+#elif _TARGET_ARM_
+ REGNUM_R0,
+ REGNUM_R1,
+ REGNUM_R2,
+ REGNUM_R3,
+ REGNUM_R4,
+ REGNUM_R5,
+ REGNUM_R6,
+ REGNUM_R7,
+ REGNUM_R8,
+ REGNUM_R9,
+ REGNUM_R10,
+ REGNUM_R11,
+ REGNUM_R12,
+ REGNUM_SP,
+ REGNUM_LR,
+ REGNUM_PC,
+#elif _TARGET_ARM64_
+ REGNUM_X0,
+ REGNUM_X1,
+ REGNUM_X2,
+ REGNUM_X3,
+ REGNUM_X4,
+ REGNUM_X5,
+ REGNUM_X6,
+ REGNUM_X7,
+ REGNUM_X8,
+ REGNUM_X9,
+ REGNUM_X10,
+ REGNUM_X11,
+ REGNUM_X12,
+ REGNUM_X13,
+ REGNUM_X14,
+ REGNUM_X15,
+ REGNUM_X16,
+ REGNUM_X17,
+ REGNUM_X18,
+ REGNUM_X19,
+ REGNUM_X20,
+ REGNUM_X21,
+ REGNUM_X22,
+ REGNUM_X23,
+ REGNUM_X24,
+ REGNUM_X25,
+ REGNUM_X26,
+ REGNUM_X27,
+ REGNUM_X28,
+ REGNUM_FP,
+ REGNUM_LR,
+ REGNUM_SP,
+ REGNUM_PC,
+#elif _TARGET_AMD64_
+ REGNUM_RAX,
+ REGNUM_RCX,
+ REGNUM_RDX,
+ REGNUM_RBX,
+ REGNUM_RSP,
+ REGNUM_RBP,
+ REGNUM_RSI,
+ REGNUM_RDI,
+ REGNUM_R8,
+ REGNUM_R9,
+ REGNUM_R10,
+ REGNUM_R11,
+ REGNUM_R12,
+ REGNUM_R13,
+ REGNUM_R14,
+ REGNUM_R15,
+#else
+ PORTABILITY_WARNING("Register numbers not defined on this platform")
+#endif
+ REGNUM_COUNT,
+ REGNUM_AMBIENT_SP, // ambient SP support. Ambient SP is the original SP in the non-BP based frame.
+ // Ambient SP should not change even if there are push/pop operations in the method.
+
+#ifdef _TARGET_X86_
+ REGNUM_FP = REGNUM_EBP,
+ REGNUM_SP = REGNUM_ESP,
+#elif _TARGET_AMD64_
+ REGNUM_SP = REGNUM_RSP,
+#elif _TARGET_ARM_
+#ifdef REDHAWK
+ REGNUM_FP = REGNUM_R7,
+#else
+ REGNUM_FP = REGNUM_R11,
+#endif //REDHAWK
+#elif _TARGET_ARM64_
+ //Nothing to do here. FP is already alloted.
+#else
+ // RegNum values should be properly defined for this platform
+ REGNUM_FP = 0,
+ REGNUM_SP = 1,
+#endif
+
+ };
+
+ // VarLoc describes the location of a native variable. Note that currently, VLT_REG_BYREF and VLT_STK_BYREF
+ // are only used for value types on X64.
+
+ enum VarLocType
+ {
+ VLT_REG, // variable is in a register
+ VLT_REG_BYREF, // address of the variable is in a register
+ VLT_REG_FP, // variable is in an fp register
+ VLT_STK, // variable is on the stack (memory addressed relative to the frame-pointer)
+ VLT_STK_BYREF, // address of the variable is on the stack (memory addressed relative to the frame-pointer)
+ VLT_REG_REG, // variable lives in two registers
+ VLT_REG_STK, // variable lives partly in a register and partly on the stack
+ VLT_STK_REG, // reverse of VLT_REG_STK
+ VLT_STK2, // variable lives in two slots on the stack
+ VLT_FPSTK, // variable lives on the floating-point stack
+ VLT_FIXED_VA, // variable is a fixed argument in a varargs function (relative to VARARGS_HANDLE)
+
+ VLT_COUNT,
+ VLT_INVALID,
+#ifdef MDIL
+ VLT_MDIL_SYMBOLIC = 0x20
+#endif
+
+ };
+
+ struct VarLoc
+ {
+ VarLocType vlType;
+
+ union
+ {
+ // VLT_REG/VLT_REG_FP -- Any pointer-sized enregistered value (TYP_INT, TYP_REF, etc)
+ // eg. EAX
+ // VLT_REG_BYREF -- the specified register contains the address of the variable
+ // eg. [EAX]
+
+ struct
+ {
+ RegNum vlrReg;
+ } vlReg;
+
+ // VLT_STK -- Any 32 bit value which is on the stack
+ // eg. [ESP+0x20], or [EBP-0x28]
+ // VLT_STK_BYREF -- the specified stack location contains the address of the variable
+ // eg. mov EAX, [ESP+0x20]; [EAX]
+
+ struct
+ {
+ RegNum vlsBaseReg;
+ signed vlsOffset;
+ } vlStk;
+
+ // VLT_REG_REG -- TYP_LONG with both DWords enregistred
+ // eg. RBM_EAXEDX
+
+ struct
+ {
+ RegNum vlrrReg1;
+ RegNum vlrrReg2;
+ } vlRegReg;
+
+ // VLT_REG_STK -- Partly enregistered TYP_LONG
+ // eg { LowerDWord=EAX UpperDWord=[ESP+0x8] }
+
+ struct
+ {
+ RegNum vlrsReg;
+ struct
+ {
+ RegNum vlrssBaseReg;
+ signed vlrssOffset;
+ } vlrsStk;
+ } vlRegStk;
+
+ // VLT_STK_REG -- Partly enregistered TYP_LONG
+ // eg { LowerDWord=[ESP+0x8] UpperDWord=EAX }
+
+ struct
+ {
+ struct
+ {
+ RegNum vlsrsBaseReg;
+ signed vlsrsOffset;
+ } vlsrStk;
+ RegNum vlsrReg;
+ } vlStkReg;
+
+ // VLT_STK2 -- Any 64 bit value which is on the stack,
+ // in 2 successsive DWords.
+ // eg 2 DWords at [ESP+0x10]
+
+ struct
+ {
+ RegNum vls2BaseReg;
+ signed vls2Offset;
+ } vlStk2;
+
+ // VLT_FPSTK -- enregisterd TYP_DOUBLE (on the FP stack)
+ // eg. ST(3). Actually it is ST("FPstkHeigth - vpFpStk")
+
+ struct
+ {
+ unsigned vlfReg;
+ } vlFPstk;
+
+ // VLT_FIXED_VA -- fixed argument of a varargs function.
+ // The argument location depends on the size of the variable
+ // arguments (...). Inspecting the VARARGS_HANDLE indicates the
+ // location of the first arg. This argument can then be accessed
+ // relative to the position of the first arg
+
+ struct
+ {
+ unsigned vlfvOffset;
+ } vlFixedVarArg;
+
+ // VLT_MEMORY
+
+ struct
+ {
+ void *rpValue; // pointer to the in-process
+ // location of the value.
+ } vlMemory;
+ };
+ };
+
+ // This is used to report implicit/hidden arguments
+
+ enum
+ {
+ VARARGS_HND_ILNUM = -1, // Value for the CORINFO_VARARGS_HANDLE varNumber
+ RETBUF_ILNUM = -2, // Pointer to the return-buffer
+ TYPECTXT_ILNUM = -3, // ParamTypeArg for CORINFO_GENERICS_CTXT_FROM_PARAMTYPEARG
+
+ UNKNOWN_ILNUM = -4, // Unknown variable
+
+ MAX_ILNUM = -4 // Sentinal value. This should be set to the largest magnitude value in th enum
+ // so that the compression routines know the enum's range.
+ };
+
+ struct ILVarInfo
+ {
+ DWORD startOffset;
+ DWORD endOffset;
+ DWORD varNumber;
+ };
+
+ struct NativeVarInfo
+ {
+ DWORD startOffset;
+ DWORD endOffset;
+ DWORD varNumber;
+ VarLoc loc;
+ };
+};
// Guard-stack cookie for preventing against stack buffer overruns
typedef SIZE_T GSCookie;
-/**********************************************************************************/
-// DebugInfo types shared by JIT-EE interface and EE-Debugger interface
-
-class ICorDebugInfo
-{
-public:
- /*----------------------------- Boundary-info ---------------------------*/
-
- enum MappingTypes
- {
- NO_MAPPING = -1,
- PROLOG = -2,
- EPILOG = -3,
- MAX_MAPPING_VALUE = -3 // Sentinal value. This should be set to the largest magnitude value in the enum
- // so that the compression routines know the enum's range.
- };
-
- enum BoundaryTypes
- {
- NO_BOUNDARIES = 0x00, // No implicit boundaries
- STACK_EMPTY_BOUNDARIES = 0x01, // Boundary whenever the IL evaluation stack is empty
- NOP_BOUNDARIES = 0x02, // Before every CEE_NOP instruction
- CALL_SITE_BOUNDARIES = 0x04, // Before every CEE_CALL, CEE_CALLVIRT, etc instruction
-
- // Set of boundaries that debugger should always reasonably ask the JIT for.
- DEFAULT_BOUNDARIES = STACK_EMPTY_BOUNDARIES | NOP_BOUNDARIES | CALL_SITE_BOUNDARIES
- };
-
- // Note that SourceTypes can be OR'd together - it's possible that
- // a sequence point will also be a stack_empty point, and/or a call site.
- // The debugger will check to see if a boundary offset's source field &
- // SEQUENCE_POINT is true to determine if the boundary is a sequence point.
-
- enum SourceTypes
- {
- SOURCE_TYPE_INVALID = 0x00, // To indicate that nothing else applies
- SEQUENCE_POINT = 0x01, // The debugger asked for it.
- STACK_EMPTY = 0x02, // The stack is empty here
- CALL_SITE = 0x04, // This is a call site.
- NATIVE_END_OFFSET_UNKNOWN = 0x08, // Indicates a epilog endpoint
- CALL_INSTRUCTION = 0x10 // The actual instruction of a call.
-
- };
-
- struct OffsetMapping
- {
- DWORD nativeOffset;
- DWORD ilOffset;
- SourceTypes source; // The debugger needs this so that
- // we don't put Edit and Continue breakpoints where
- // the stack isn't empty. We can put regular breakpoints
- // there, though, so we need a way to discriminate
- // between offsets.
- };
-
- /*------------------------------ Var-info -------------------------------*/
-
- // Note: The debugger needs to target register numbers on platforms other than which the debugger itself
- // is running. To this end it maintains its own values for REGNUM_SP and REGNUM_AMBIENT_SP across multiple
- // platforms. So any change here that may effect these values should be reflected in the definitions
- // contained in debug/inc/DbgIPCEvents.h.
- enum RegNum
- {
-#ifdef _TARGET_X86_
- REGNUM_EAX,
- REGNUM_ECX,
- REGNUM_EDX,
- REGNUM_EBX,
- REGNUM_ESP,
- REGNUM_EBP,
- REGNUM_ESI,
- REGNUM_EDI,
-#elif _TARGET_ARM_
- REGNUM_R0,
- REGNUM_R1,
- REGNUM_R2,
- REGNUM_R3,
- REGNUM_R4,
- REGNUM_R5,
- REGNUM_R6,
- REGNUM_R7,
- REGNUM_R8,
- REGNUM_R9,
- REGNUM_R10,
- REGNUM_R11,
- REGNUM_R12,
- REGNUM_SP,
- REGNUM_LR,
- REGNUM_PC,
-#elif _TARGET_ARM64_
- REGNUM_X0,
- REGNUM_X1,
- REGNUM_X2,
- REGNUM_X3,
- REGNUM_X4,
- REGNUM_X5,
- REGNUM_X6,
- REGNUM_X7,
- REGNUM_X8,
- REGNUM_X9,
- REGNUM_X10,
- REGNUM_X11,
- REGNUM_X12,
- REGNUM_X13,
- REGNUM_X14,
- REGNUM_X15,
- REGNUM_X16,
- REGNUM_X17,
- REGNUM_X18,
- REGNUM_X19,
- REGNUM_X20,
- REGNUM_X21,
- REGNUM_X22,
- REGNUM_X23,
- REGNUM_X24,
- REGNUM_X25,
- REGNUM_X26,
- REGNUM_X27,
- REGNUM_X28,
- REGNUM_FP,
- REGNUM_LR,
- REGNUM_SP,
- REGNUM_PC,
-#elif _TARGET_AMD64_
- REGNUM_RAX,
- REGNUM_RCX,
- REGNUM_RDX,
- REGNUM_RBX,
- REGNUM_RSP,
- REGNUM_RBP,
- REGNUM_RSI,
- REGNUM_RDI,
- REGNUM_R8,
- REGNUM_R9,
- REGNUM_R10,
- REGNUM_R11,
- REGNUM_R12,
- REGNUM_R13,
- REGNUM_R14,
- REGNUM_R15,
-#else
- PORTABILITY_WARNING("Register numbers not defined on this platform")
-#endif
- REGNUM_COUNT,
- REGNUM_AMBIENT_SP, // ambient SP support. Ambient SP is the original SP in the non-BP based frame.
- // Ambient SP should not change even if there are push/pop operations in the method.
-
-#ifdef _TARGET_X86_
- REGNUM_FP = REGNUM_EBP,
- REGNUM_SP = REGNUM_ESP,
-#elif _TARGET_AMD64_
- REGNUM_SP = REGNUM_RSP,
-#elif _TARGET_ARM_
-#ifdef REDHAWK
- REGNUM_FP = REGNUM_R7,
-#else
- REGNUM_FP = REGNUM_R11,
-#endif //REDHAWK
-#elif _TARGET_ARM64_
- //Nothing to do here. FP is already alloted.
-#else
- // RegNum values should be properly defined for this platform
- REGNUM_FP = 0,
- REGNUM_SP = 1,
-#endif
-
- };
-
- // VarLoc describes the location of a native variable. Note that currently, VLT_REG_BYREF and VLT_STK_BYREF
- // are only used for value types on X64.
-
- enum VarLocType
- {
- VLT_REG, // variable is in a register
- VLT_REG_BYREF, // address of the variable is in a register
- VLT_REG_FP, // variable is in an fp register
- VLT_STK, // variable is on the stack (memory addressed relative to the frame-pointer)
- VLT_STK_BYREF, // address of the variable is on the stack (memory addressed relative to the frame-pointer)
- VLT_REG_REG, // variable lives in two registers
- VLT_REG_STK, // variable lives partly in a register and partly on the stack
- VLT_STK_REG, // reverse of VLT_REG_STK
- VLT_STK2, // variable lives in two slots on the stack
- VLT_FPSTK, // variable lives on the floating-point stack
- VLT_FIXED_VA, // variable is a fixed argument in a varargs function (relative to VARARGS_HANDLE)
-
- VLT_COUNT,
- VLT_INVALID,
-#ifdef MDIL
- VLT_MDIL_SYMBOLIC = 0x20
-#endif
-
- };
-
- struct VarLoc
- {
- VarLocType vlType;
-
- union
- {
- // VLT_REG/VLT_REG_FP -- Any pointer-sized enregistered value (TYP_INT, TYP_REF, etc)
- // eg. EAX
- // VLT_REG_BYREF -- the specified register contains the address of the variable
- // eg. [EAX]
-
- struct
- {
- RegNum vlrReg;
- } vlReg;
-
- // VLT_STK -- Any 32 bit value which is on the stack
- // eg. [ESP+0x20], or [EBP-0x28]
- // VLT_STK_BYREF -- the specified stack location contains the address of the variable
- // eg. mov EAX, [ESP+0x20]; [EAX]
-
- struct
- {
- RegNum vlsBaseReg;
- signed vlsOffset;
- } vlStk;
-
- // VLT_REG_REG -- TYP_LONG with both DWords enregistred
- // eg. RBM_EAXEDX
-
- struct
- {
- RegNum vlrrReg1;
- RegNum vlrrReg2;
- } vlRegReg;
-
- // VLT_REG_STK -- Partly enregistered TYP_LONG
- // eg { LowerDWord=EAX UpperDWord=[ESP+0x8] }
-
- struct
- {
- RegNum vlrsReg;
- struct
- {
- RegNum vlrssBaseReg;
- signed vlrssOffset;
- } vlrsStk;
- } vlRegStk;
-
- // VLT_STK_REG -- Partly enregistered TYP_LONG
- // eg { LowerDWord=[ESP+0x8] UpperDWord=EAX }
-
- struct
- {
- struct
- {
- RegNum vlsrsBaseReg;
- signed vlsrsOffset;
- } vlsrStk;
- RegNum vlsrReg;
- } vlStkReg;
-
- // VLT_STK2 -- Any 64 bit value which is on the stack,
- // in 2 successsive DWords.
- // eg 2 DWords at [ESP+0x10]
-
- struct
- {
- RegNum vls2BaseReg;
- signed vls2Offset;
- } vlStk2;
-
- // VLT_FPSTK -- enregisterd TYP_DOUBLE (on the FP stack)
- // eg. ST(3). Actually it is ST("FPstkHeigth - vpFpStk")
-
- struct
- {
- unsigned vlfReg;
- } vlFPstk;
-
- // VLT_FIXED_VA -- fixed argument of a varargs function.
- // The argument location depends on the size of the variable
- // arguments (...). Inspecting the VARARGS_HANDLE indicates the
- // location of the first arg. This argument can then be accessed
- // relative to the position of the first arg
-
- struct
- {
- unsigned vlfvOffset;
- } vlFixedVarArg;
-
- // VLT_MEMORY
-
- struct
- {
- void *rpValue; // pointer to the in-process
- // location of the value.
- } vlMemory;
- };
- };
-
- // This is used to report implicit/hidden arguments
-
- enum
- {
- VARARGS_HND_ILNUM = -1, // Value for the CORINFO_VARARGS_HANDLE varNumber
- RETBUF_ILNUM = -2, // Pointer to the return-buffer
- TYPECTXT_ILNUM = -3, // ParamTypeArg for CORINFO_GENERICS_CTXT_FROM_PARAMTYPEARG
-
- UNKNOWN_ILNUM = -4, // Unknown variable
-
- MAX_ILNUM = -4 // Sentinal value. This should be set to the largest magnitude value in th enum
- // so that the compression routines know the enum's range.
- };
-
- struct ILVarInfo
- {
- DWORD startOffset;
- DWORD endOffset;
- DWORD varNumber;
- };
-
- struct NativeVarInfo
- {
- DWORD startOffset;
- DWORD endOffset;
- DWORD varNumber;
- VarLoc loc;
- };
-};
+#include "cordebuginfo.h"
/**********************************************************************************/
// Some compilers cannot arbitrarily allow the handler nesting level to grow
projects / platform / upstream / coreclr.git / commitdiff