src/inc/regdisp.h

   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.
   4
   5 #ifndef __REGDISP_H
   6 #define __REGDISP_H
   7
   8
   9 #ifdef DEBUG_REGDISPLAY
  10 class Thread;
  11 struct REGDISPLAY;
  12 void CheckRegDisplaySP (REGDISPLAY *pRD);
  13 #endif // DEBUG_REGDISPLAY
  14
  15 struct REGDISPLAY_BASE {
  16     PT_CONTEXT pContext;    // This is the context of the active call frame;
  17                             // either returned by GetContext or provided at
  18                             // exception time.
  19                             //
  20                             // This will be used to resume execution, so
  21                             // do NOT trash it! But DO update any static
  22                             // registers here.
  23
  24 #ifdef WIN64EXCEPTIONS
  25     PT_CONTEXT pCurrentContext;   // [trashed] points to current Context of stackwalk
  26     PT_CONTEXT pCallerContext;    // [trashed] points to the Context of the caller during stackwalk -- used for GC crawls
  27
  28     // [trashed] points to current context pointers of stackwalk
  29     T_KNONVOLATILE_CONTEXT_POINTERS *pCurrentContextPointers;
  30     // [trashed] points to the context pointers of the caller during stackwalk -- used for GC crawls
  31     T_KNONVOLATILE_CONTEXT_POINTERS *pCallerContextPointers;
  32
  33     BOOL IsCallerContextValid;  // TRUE if pCallerContext really contains the caller's context
  34     BOOL IsCallerSPValid;       // Don't add usage of this field.  This is only temporary.
  35
  36     T_CONTEXT  ctxOne;    // used by stackwalk
  37     T_CONTEXT  ctxTwo;    // used by stackwalk
  38
  39     T_KNONVOLATILE_CONTEXT_POINTERS ctxPtrsOne;  // used by stackwalk
  40     T_KNONVOLATILE_CONTEXT_POINTERS ctxPtrsTwo;  // used by stackwalk
  41 #endif // WIN64EXCEPTIONS
  42
  43 #ifdef DEBUG_REGDISPLAY
  44     Thread *_pThread;
  45 #endif // DEBUG_REGDISPLAY
  46
  47     TADDR SP;
  48     TADDR ControlPC;
  49 };
  50
  51 inline PCODE GetControlPC(REGDISPLAY_BASE *pRD) {
  52     LIMITED_METHOD_DAC_CONTRACT;
  53     return (PCODE)(pRD->ControlPC);
  54 }
  55
  56 inline TADDR GetRegdisplaySP(REGDISPLAY_BASE *pRD) {
  57     LIMITED_METHOD_DAC_CONTRACT;
  58
  59     return pRD->SP;
  60 }
  61
  62 inline void SetRegdisplaySP(REGDISPLAY_BASE *pRD, LPVOID sp) {
  63     LIMITED_METHOD_DAC_CONTRACT;
  64
  65     pRD->SP = (TADDR)sp;
  66 }
  67
  68 #if defined(_TARGET_X86_)
  69
  70 struct REGDISPLAY : public REGDISPLAY_BASE {
  71
  72 #ifndef WIN64EXCEPTIONS
  73     // TODO: Unify with pCurrentContext / pCallerContext used on 64-bit
  74     PCONTEXT pContextForUnwind; // scratch context for unwinding
  75                                 // used to preserve context saved in the frame that
  76                                 // could be otherwise wiped by the unwinding
  77
  78     DWORD * pEdi;
  79     DWORD * pEsi;
  80     DWORD * pEbx;
  81     DWORD * pEdx;
  82     DWORD * pEcx;
  83     DWORD * pEax;
  84
  85     DWORD * pEbp;
  86 #endif // !WIN64EXCEPTIONS
  87
  88 #ifndef WIN64EXCEPTIONS
  89
  90 #define REG_METHODS(reg) \
  91     inline PDWORD Get##reg##Location(void) { return p##reg;  } \
  92     inline void   Set##reg##Location(PDWORD p##reg) { this->p##reg = p##reg; }
  93
  94 #else // !WIN64EXCEPTIONS
  95
  96 #define REG_METHODS(reg) \
  97     inline PDWORD Get##reg##Location(void) { return pCurrentContextPointers->reg; } \
  98     inline void   Set##reg##Location(PDWORD p##reg) { pCurrentContextPointers->reg = p##reg; }
  99
 100 #endif // WIN64EXCEPTIONS
 101
 102     REG_METHODS(Eax)
 103     REG_METHODS(Ecx)
 104     REG_METHODS(Edx)
 105
 106     REG_METHODS(Ebx)
 107     REG_METHODS(Esi)
 108     REG_METHODS(Edi)
 109     REG_METHODS(Ebp)
 110
 111 #undef REG_METHODS
 112
 113     TADDR   PCTAddr;
 114 };
 115
 116 inline TADDR GetRegdisplayFP(REGDISPLAY *display) {
 117     LIMITED_METHOD_DAC_CONTRACT;
 118
 119     return (TADDR)*display->GetEbpLocation();
 120 }
 121
 122 inline LPVOID GetRegdisplayFPAddress(REGDISPLAY *display) {
 123     LIMITED_METHOD_CONTRACT;
 124
 125     return (LPVOID)display->GetEbpLocation();
 126 }
 127
 128
 129 // This function tells us if the given stack pointer is in one of the frames of the functions called by the given frame
 130 inline BOOL IsInCalleesFrames(REGDISPLAY *display, LPVOID stackPointer) {
 131     LIMITED_METHOD_CONTRACT;
 132
 133 #ifdef WIN64EXCEPTIONS
 134     return stackPointer < ((LPVOID)(display->SP));
 135 #else
 136     return (TADDR)stackPointer < display->PCTAddr;
 137 #endif
 138 }
 139 inline TADDR GetRegdisplayStackMark(REGDISPLAY *display) {
 140     LIMITED_METHOD_DAC_CONTRACT;
 141
 142 #ifdef WIN64EXCEPTIONS
 143     _ASSERTE(GetRegdisplaySP(display) == GetSP(display->pCurrentContext));
 144     return GetRegdisplaySP(display);
 145 #else
 146     return display->PCTAddr;
 147 #endif
 148 }
 149
 150 #elif defined(_WIN64)
 151
 152 #if defined(_TARGET_ARM64_)
 153 typedef struct _Arm64VolatileContextPointer
 154 {
 155     union {
 156         struct {
 157             PDWORD64 X0;
 158             PDWORD64 X1;
 159             PDWORD64 X2;
 160             PDWORD64 X3;
 161             PDWORD64 X4;
 162             PDWORD64 X5;
 163             PDWORD64 X6;
 164             PDWORD64 X7;
 165             PDWORD64 X8;
 166             PDWORD64 X9;
 167             PDWORD64 X10;
 168             PDWORD64 X11;
 169             PDWORD64 X12;
 170             PDWORD64 X13;
 171             PDWORD64 X14;
 172             PDWORD64 X15;
 173             PDWORD64 X16;
 174             PDWORD64 X17;
 175             //X18 is reserved by OS, in userspace it represents TEB
 176         };
 177         PDWORD64 X[18];
 178     };
 179 } Arm64VolatileContextPointer;
 180 #endif //_TARGET_ARM64_
 181 struct REGDISPLAY : public REGDISPLAY_BASE {
 182 #ifdef _TARGET_ARM64_
 183     Arm64VolatileContextPointer     volatileCurrContextPointers;
 184 #endif
 185
 186     REGDISPLAY()
 187     {
 188         // Initialize
 189         memset(this, 0, sizeof(REGDISPLAY));
 190     }
 191 };
 192
 193
 194 inline TADDR GetRegdisplayFP(REGDISPLAY *display) {
 195     LIMITED_METHOD_CONTRACT;
 196     return NULL;
 197 }
 198
 199 inline TADDR GetRegdisplayFPAddress(REGDISPLAY *display) {
 200     LIMITED_METHOD_CONTRACT;
 201     return NULL;
 202 }
 203
 204 // This function tells us if the given stack pointer is in one of the frames of the functions called by the given frame
 205 inline BOOL IsInCalleesFrames(REGDISPLAY *display, LPVOID stackPointer)
 206 {
 207     LIMITED_METHOD_CONTRACT;
 208     return stackPointer < ((LPVOID)(display->SP));
 209 }
 210
 211 inline TADDR GetRegdisplayStackMark(REGDISPLAY *display)
 212 {
 213 #if defined(_TARGET_AMD64_)
 214     // On AMD64, the MemoryStackFp value is the current sp (i.e. the sp value when calling another method).
 215     _ASSERTE(GetRegdisplaySP(display) == GetSP(display->pCurrentContext));
 216     return GetRegdisplaySP(display);
 217
 218 #elif defined(_TARGET_ARM64_)
 219
 220     _ASSERTE(display->IsCallerContextValid);
 221     return GetSP(display->pCallerContext);
 222
 223 #else  // _TARGET_AMD64_
 224     PORTABILITY_ASSERT("GetRegdisplayStackMark NYI for this platform (Regdisp.h)");
 225     return NULL;
 226 #endif // _TARGET_AMD64_
 227 }
 228
 229 #elif defined(_TARGET_ARM_)
 230
 231 // ResumableFrame is pushed on the stack before
 232 // starting the GC. registers r0-r3 in ResumableFrame can
 233 // contain roots which might need to be updated if they are
 234 // relocated. On Stack walking the addresses of the registers in the
 235 // resumable Frame are passed to GC using pCurrentContextPointers
 236 // member in _REGDISPLAY. However On ARM KNONVOLATILE_CONTEXT_POINTERS
 237 // does not contain pointers for volatile registers. Therefore creating
 238 // this structure to store pointers to volatile registers and adding an object
 239 // as member in _REGDISPLAY
 240 typedef struct _ArmVolatileContextPointer
 241 {
 242     PDWORD R0;
 243     PDWORD R1;
 244     PDWORD R2;
 245     PDWORD R3;
 246     PDWORD R12;
 247 } ArmVolatileContextPointer;
 248
 249 struct REGDISPLAY : public REGDISPLAY_BASE {
 250     ArmVolatileContextPointer     volatileCurrContextPointers;
 251
 252     DWORD *  pPC;                // processor neutral name
 253
 254     REGDISPLAY()
 255     {
 256         // Initialize regdisplay
 257         memset(this, 0, sizeof(REGDISPLAY));
 258
 259         // Setup the pointer to ControlPC field
 260         pPC = &ControlPC;
 261     }
 262 };
 263
 264 // This function tells us if the given stack pointer is in one of the frames of the functions called by the given frame
 265 inline BOOL IsInCalleesFrames(REGDISPLAY *display, LPVOID stackPointer) {
 266     LIMITED_METHOD_CONTRACT;
 267     return stackPointer < ((LPVOID)(TADDR)(display->SP));
 268 }
 269
 270 inline TADDR GetRegdisplayStackMark(REGDISPLAY *display) {
 271     LIMITED_METHOD_CONTRACT;
 272     // ARM uses the establisher frame as the marker
 273     _ASSERTE(display->IsCallerContextValid);
 274     return GetSP(display->pCallerContext);
 275 }
 276
 277 #else // none of the above processors
 278 #error "RegDisplay functions are not implemented on this platform."
 279 #endif
 280
 281 #if defined(_WIN64) || defined(_TARGET_ARM_) || (defined(_TARGET_X86_) && defined(WIN64EXCEPTIONS))
 282 // This needs to be implemented for platforms that have funclets.
 283 inline LPVOID GetRegdisplayReturnValue(REGDISPLAY *display)
 284 {
 285     LIMITED_METHOD_CONTRACT;
 286
 287 #if defined(_TARGET_AMD64_)
 288     return (LPVOID)display->pCurrentContext->Rax;
 289 #elif defined(_TARGET_ARM64_)
 290     return (LPVOID)display->pCurrentContext->X0;
 291 #elif defined(_TARGET_ARM_)
 292     return (LPVOID)display->pCurrentContext->R0;
 293 #elif defined(_TARGET_X86_)
 294     return (LPVOID)display->pCurrentContext->Eax;
 295 #else
 296     PORTABILITY_ASSERT("GetRegdisplayReturnValue NYI for this platform (Regdisp.h)");
 297     return NULL;
 298 #endif
 299 }
 300
 301 inline void SyncRegDisplayToCurrentContext(REGDISPLAY* pRD)
 302 {
 303     LIMITED_METHOD_CONTRACT;
 304
 305 #if defined(_WIN64)
 306     pRD->SP         = (INT_PTR)GetSP(pRD->pCurrentContext);
 307     pRD->ControlPC  = INT_PTR(GetIP(pRD->pCurrentContext));
 308 #elif defined(_TARGET_ARM_) // _WIN64
 309     pRD->SP         = (DWORD)GetSP(pRD->pCurrentContext);
 310     pRD->ControlPC  = (DWORD)GetIP(pRD->pCurrentContext);
 311 #elif defined(_TARGET_X86_) // _TARGET_ARM_
 312     pRD->SP         = (DWORD)GetSP(pRD->pCurrentContext);
 313     pRD->ControlPC  = (DWORD)GetIP(pRD->pCurrentContext);
 314 #else // _TARGET_X86_
 315     PORTABILITY_ASSERT("SyncRegDisplayToCurrentContext");
 316 #endif // _TARGET_ARM_ || _TARGET_X86_
 317
 318 #ifdef DEBUG_REGDISPLAY
 319     CheckRegDisplaySP(pRD);
 320 #endif // DEBUG_REGDISPLAY
 321 }
 322 #endif // _WIN64 || _TARGET_ARM_ || (_TARGET_X86_ && WIN64EXCEPTIONS)
 323
 324 typedef REGDISPLAY *PREGDISPLAY;
 325
 326 #ifdef WIN64EXCEPTIONS
 327 inline void FillContextPointers(PT_KNONVOLATILE_CONTEXT_POINTERS pCtxPtrs, PT_CONTEXT pCtx)
 328 {
 329 #ifdef _TARGET_AMD64_
 330     for (int i = 0; i < 16; i++)
 331     {
 332         *(&pCtxPtrs->Rax + i) = (&pCtx->Rax + i);
 333     }
 334 #elif defined(_TARGET_ARM64_) // _TARGET_AMD64_
 335     for (int i = 0; i < 12; i++)
 336     {
 337         *(&pCtxPtrs->X19 + i) = (&pCtx->X19 + i);
 338     }
 339 #elif defined(_TARGET_ARM_) // _TARGET_ARM64_
 340     // Copy over the nonvolatile integer registers (R4-R11)
 341     for (int i = 0; i < 8; i++)
 342     {
 343         *(&pCtxPtrs->R4 + i) = (&pCtx->R4 + i);
 344     }
 345 #elif defined(_TARGET_X86_) // _TARGET_ARM_
 346     for (int i = 0; i < 7; i++)
 347     {
 348         *(&pCtxPtrs->Edi + i) = (&pCtx->Edi + i);
 349     }
 350 #else // _TARGET_X86_
 351     PORTABILITY_ASSERT("FillContextPointers");
 352 #endif // _TARGET_???_ (ELSE)
 353 }
 354 #endif // WIN64EXCEPTIONS
 355
 356 inline void FillRegDisplay(const PREGDISPLAY pRD, PT_CONTEXT pctx, PT_CONTEXT pCallerCtx = NULL)
 357 {
 358     WRAPPER_NO_CONTRACT;
 359
 360     SUPPORTS_DAC;
 361
 362 #ifndef WIN64EXCEPTIONS
 363 #ifdef _TARGET_X86_
 364     pRD->pContext = pctx;
 365     pRD->pContextForUnwind = NULL;
 366     pRD->pEdi = &(pctx->Edi);
 367     pRD->pEsi = &(pctx->Esi);
 368     pRD->pEbx = &(pctx->Ebx);
 369     pRD->pEbp = &(pctx->Ebp);
 370     pRD->pEax = &(pctx->Eax);
 371     pRD->pEcx = &(pctx->Ecx);
 372     pRD->pEdx = &(pctx->Edx);
 373     pRD->SP   = pctx->Esp;
 374     pRD->ControlPC = (PCODE)(pctx->Eip);
 375     pRD->PCTAddr = (UINT_PTR)&(pctx->Eip);
 376 #else // _TARGET_X86_
 377     PORTABILITY_ASSERT("FillRegDisplay");
 378 #endif // _TARGET_???_ (ELSE)
 379
 380 #else // !WIN64EXCEPTIONS
 381     pRD->pContext   = pctx;
 382
 383     // Setup the references
 384     pRD->pCurrentContextPointers = &pRD->ctxPtrsOne;
 385     pRD->pCallerContextPointers = &pRD->ctxPtrsTwo;
 386
 387     pRD->pCurrentContext = &(pRD->ctxOne);
 388     pRD->pCallerContext  = &(pRD->ctxTwo);
 389
 390     // copy the active context to initialize our stackwalk
 391     *(pRD->pCurrentContext)     = *(pctx);
 392
 393     // copy the caller context as well if it's specified
 394     if (pCallerCtx == NULL)
 395     {
 396         pRD->IsCallerContextValid = FALSE;
 397         pRD->IsCallerSPValid      = FALSE;        // Don't add usage of this field.  This is only temporary.
 398     }
 399     else
 400     {
 401         *(pRD->pCallerContext)    = *(pCallerCtx);
 402         pRD->IsCallerContextValid = TRUE;
 403         pRD->IsCallerSPValid      = TRUE;        // Don't add usage of this field.  This is only temporary.
 404     }
 405
 406     FillContextPointers(&pRD->ctxPtrsOne, pctx);
 407
 408 #if defined(_TARGET_ARM_)
 409     pRD->ctxPtrsOne.Lr = &pctx->Lr;
 410     pRD->pPC = &pRD->pCurrentContext->Pc;
 411 #endif // _TARGET_ARM_
 412
 413 #ifdef DEBUG_REGDISPLAY
 414     pRD->_pThread = NULL;
 415 #endif // DEBUG_REGDISPLAY
 416
 417     // This will setup the PC and SP
 418     SyncRegDisplayToCurrentContext(pRD);
 419 #endif // !WIN64EXCEPTIONS
 420 }
 421
 422 // Initialize a new REGDISPLAY/CONTEXT pair from an existing valid REGDISPLAY.
 423 inline void CopyRegDisplay(const PREGDISPLAY pInRD, PREGDISPLAY pOutRD, T_CONTEXT *pOutCtx)
 424 {
 425     WRAPPER_NO_CONTRACT;
 426
 427     // The general strategy is to extract the register state from the input REGDISPLAY
 428     // into the new CONTEXT then simply call FillRegDisplay.
 429
 430     T_CONTEXT* pOutCallerCtx = NULL;
 431
 432 #ifndef WIN64EXCEPTIONS
 433
 434 #if defined(_TARGET_X86_)
 435     if (pInRD->pEdi != NULL) {pOutCtx->Edi = *pInRD->pEdi;} else {pInRD->pEdi = NULL;}
 436     if (pInRD->pEsi != NULL) {pOutCtx->Esi = *pInRD->pEsi;} else {pInRD->pEsi = NULL;}
 437     if (pInRD->pEbx != NULL) {pOutCtx->Ebx = *pInRD->pEbx;} else {pInRD->pEbx = NULL;}
 438     if (pInRD->pEbp != NULL) {pOutCtx->Ebp = *pInRD->pEbp;} else {pInRD->pEbp = NULL;}
 439     if (pInRD->pEax != NULL) {pOutCtx->Eax = *pInRD->pEax;} else {pInRD->pEax = NULL;}
 440     if (pInRD->pEcx != NULL) {pOutCtx->Ecx = *pInRD->pEcx;} else {pInRD->pEcx = NULL;}
 441     if (pInRD->pEdx != NULL) {pOutCtx->Edx = *pInRD->pEdx;} else {pInRD->pEdx = NULL;}
 442     pOutCtx->Esp = pInRD->SP;
 443     pOutCtx->Eip = pInRD->ControlPC;
 444 #else // _TARGET_X86_
 445     PORTABILITY_ASSERT("CopyRegDisplay");
 446 #endif // _TARGET_???_
 447
 448 #else // WIN64EXCEPTIONS
 449
 450     *pOutCtx = *(pInRD->pCurrentContext);
 451     if (pInRD->IsCallerContextValid)
 452     {
 453         pOutCallerCtx = pInRD->pCallerContext;
 454     }
 455
 456 #endif // WIN64EXCEPTIONS
 457
 458     if (pOutRD)
 459         FillRegDisplay(pOutRD, pOutCtx, pOutCallerCtx);
 460 }
 461
 462 // Get address of a register in a CONTEXT given the reg number. For X86,
 463 // the reg number is the R/M number from ModR/M byte or base in SIB byte
 464 inline size_t * getRegAddr (unsigned regNum, PTR_CONTEXT regs)
 465 {
 466 #ifdef _TARGET_X86_
 467     _ASSERTE(regNum < 8);
 468
 469     static const SIZE_T OFFSET_OF_REGISTERS[] =
 470     {
 471         offsetof(CONTEXT, Eax),
 472         offsetof(CONTEXT, Ecx),
 473         offsetof(CONTEXT, Edx),
 474         offsetof(CONTEXT, Ebx),
 475         offsetof(CONTEXT, Esp),
 476         offsetof(CONTEXT, Ebp),
 477         offsetof(CONTEXT, Esi),
 478         offsetof(CONTEXT, Edi),
 479     };
 480
 481     return (PTR_size_t)(PTR_BYTE(regs) + OFFSET_OF_REGISTERS[regNum]);
 482 #elif defined(_TARGET_AMD64_)
 483     _ASSERTE(regNum < 16);
 484     return &regs->Rax + regNum;
 485 #elif defined(_TARGET_ARM_)
 486         _ASSERTE(regNum < 16);
 487         return (size_t *)&regs->R0 + regNum;
 488 #elif defined(_TARGET_ARM64_)
 489     _ASSERTE(regNum < 31);
 490     return (size_t *)&regs->X0 + regNum;
 491 #else
 492     _ASSERTE(!"@TODO Port - getRegAddr (Regdisp.h)");
 493 #endif
 494     return(0);
 495 }
 496
 497 //---------------------------------------------------------------------------------------
 498 //
 499 // This is just a simpler helper function to convert a REGDISPLAY to a CONTEXT.
 500 //
 501 // Arguments:
 502 //    pRegDisp - the REGDISPLAY to be converted
 503 //    pContext - the buffer for storing the converted CONTEXT
 504 //
 505 inline void UpdateContextFromRegDisp(PREGDISPLAY pRegDisp, PT_CONTEXT pContext)
 506 {
 507     _ASSERTE((pRegDisp != NULL) && (pContext != NULL));
 508
 509 #ifndef WIN64EXCEPTIONS
 510
 511 #if defined(_TARGET_X86_)
 512     pContext->ContextFlags = (CONTEXT_INTEGER | CONTEXT_CONTROL);
 513     pContext->Edi = *pRegDisp->pEdi;
 514     pContext->Esi = *pRegDisp->pEsi;
 515     pContext->Ebx = *pRegDisp->pEbx;
 516     pContext->Ebp = *pRegDisp->pEbp;
 517     pContext->Eax = *pRegDisp->pEax;
 518     pContext->Ecx = *pRegDisp->pEcx;
 519     pContext->Edx = *pRegDisp->pEdx;
 520     pContext->Esp = pRegDisp->SP;
 521     pContext->Eip = pRegDisp->ControlPC;
 522 #else // _TARGET_X86_
 523     PORTABILITY_ASSERT("UpdateContextFromRegDisp");
 524 #endif // _TARGET_???_
 525
 526 #else // WIN64EXCEPTIONS
 527
 528     *pContext = *pRegDisp->pCurrentContext;
 529
 530 #endif // WIN64EXCEPTIONS
 531 }
 532
 533
 534 #endif  // __REGDISP_H
 535
 536