coregrind/pub_core_basics.h

   1
   2 /*--------------------------------------------------------------------*/
   3 /*--- Header included by every core C file.      pub_core_basics.h ---*/
   4 /*--------------------------------------------------------------------*/
   5
   6 /*
   7    This file is part of Valgrind, a dynamic binary instrumentation
   8    framework.
   9
  10    Copyright (C) 2000-2017 Julian Seward
  11       jseward@acm.org
  12
  13    This program is free software; you can redistribute it and/or
  14    modify it under the terms of the GNU General Public License as
  15    published by the Free Software Foundation; either version 2 of the
  16    License, or (at your option) any later version.
  17
  18    This program is distributed in the hope that it will be useful, but
  19    WITHOUT ANY WARRANTY; without even the implied warranty of
  20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21    General Public License for more details.
  22
  23    You should have received a copy of the GNU General Public License
  24    along with this program; if not, write to the Free Software
  25    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  26    02111-1307, USA.
  27
  28    The GNU General Public License is contained in the file COPYING.
  29 */
  30
  31 #ifndef __PUB_CORE_BASICS_H
  32 #define __PUB_CORE_BASICS_H
  33
  34 //--------------------------------------------------------------------
  35 // PURPOSE: This header should be imported by every single C file
  36 // in the core.  It contains the basic types and other things needed
  37 // everywhere.
  38 //--------------------------------------------------------------------
  39
  40 #include "pub_tool_basics.h"
  41
  42 /* ---------------------------------------------------------------------
  43    A struct to hold starting values for stack unwinding.
  44    ------------------------------------------------------------------ */
  45
  46 /* This really shouldn't be here.  But putting it elsewhere leads to a
  47    veritable swamp of new module cycles. */
  48
  49 /* To support CFA-based stack unwinding, and stack unwinding in
  50    general, we need to be able to get hold of the values of specific
  51    registers, in order to start the unwinding process.  This is
  52    unavoidably arch and platform dependent.  Here is a struct which
  53    holds the relevant values.  All platforms must have a program
  54    counter and a stack pointer register, but the other fields (frame
  55    pointer? link register? misc other regs?) are ad-hoc.  Note, the
  56    common fields are 64-bit, so as to make this host-independent. */
  57
  58 typedef
  59    struct {
  60       ULong r_pc; /* x86:EIP, amd64:RIP, ppc:CIA, arm:R15, mips:pc */
  61       ULong r_sp; /* x86:ESP, amd64:RSP, ppc:R1,  arm:R13, mips:sp */
  62       union {
  63          struct {
  64             UInt r_ebp;
  65          } X86;
  66          struct {
  67             ULong r_rbp;
  68          } AMD64;
  69          struct {
  70             UInt r_lr;
  71          } PPC32;
  72          struct {
  73             ULong r_lr;
  74          } PPC64;
  75          struct {
  76             UInt r14;
  77             UInt r12;
  78             UInt r11;
  79             UInt r7;
  80          } ARM;
  81          struct {
  82             ULong x29; /* FP */
  83             ULong x30; /* LR */
  84          } ARM64;
  85          struct {
  86             ULong r_fp;
  87             ULong r_lr;
  88             ULong r_f0;
  89             ULong r_f1;
  90             ULong r_f2;
  91             ULong r_f3;
  92             ULong r_f4;
  93             ULong r_f5;
  94             ULong r_f6;
  95             ULong r_f7;
  96          } S390X;
  97          struct {
  98             UInt r30;  /* Stack frame pointer or subroutine variable  */
  99             UInt r31;  /* Return address of the last subroutine call */
 100             UInt r28;
 101          } MIPS32;
 102          struct {
 103             ULong r30;  /* Stack frame pointer or subroutine variable */
 104             ULong r31;  /* Return address of the last subroutine call */
 105             ULong r28;
 106          } MIPS64;
 107       } misc;
 108    }
 109    UnwindStartRegs;
 110
 111
 112 #endif   // __PUB_CORE_BASICS_H
 113
 114 /*--------------------------------------------------------------------*/
 115 /*--- end                                                          ---*/
 116 /*--------------------------------------------------------------------*/