Home | History | Annotate | Download | only in coregrind 
      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-2012 Julian Seward
     11       jseward (at) 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    Other headers to include
     44    ------------------------------------------------------------------ */
     45 
     46 // Might as well have the following two in here, their contents are used so
     47 // broadly (eg. in pub_core_threadstate.h).
     48 
     49 #include "libvex.h"
     50 
     51 #if defined(VGA_x86)
     52 #  include "libvex_guest_x86.h"
     53 #elif defined(VGA_amd64)
     54 #  include "libvex_guest_amd64.h"
     55 #elif defined(VGA_ppc32)
     56 #  include "libvex_guest_ppc32.h"
     57 #elif defined(VGA_ppc64)
     58 #  include "libvex_guest_ppc64.h"
     59 #elif defined(VGA_arm)
     60 #  include "libvex_guest_arm.h"
     61 #elif defined(VGA_s390x)
     62 #  include "libvex_guest_s390x.h"
     63 #elif defined(VGA_mips32)
     64 #  include "libvex_guest_mips32.h"
     65 #else
     66 #  error Unknown arch
     67 #endif
     68 
     69 
     70 /* ---------------------------------------------------------------------
     71    A struct to hold starting values for stack unwinding.
     72    ------------------------------------------------------------------ */
     73 
     74 /* This really shouldn't be here.  But putting it elsewhere leads to a
     75    veritable swamp of new module cycles. */
     76 
     77 /* To support CFA-based stack unwinding, and stack unwinding in
     78    general, we need to be able to get hold of the values of specific
     79    registers, in order to start the unwinding process.  This is
     80    unavoidably arch and platform dependent.  Here is a struct which
     81    holds the relevant values.  All platforms must have a program
     82    counter and a stack pointer register, but the other fields (frame
     83    pointer? link register? misc other regs?) are ad-hoc.  Note, the
     84    common fields are 64-bit, so as to make this host-independent. */
     85 
     86 typedef
     87    struct {
     88       ULong r_pc; /* x86:EIP, amd64:RIP, ppc:CIA, arm:R15, mips:pc */
     89       ULong r_sp; /* x86:ESP, amd64:RSP, ppc:R1,  arm:R13, mips:sp */
     90       union {
     91          struct {
     92             UInt r_ebp;
     93          } X86;
     94          struct {
     95             ULong r_rbp;
     96          } AMD64;
     97          struct {
     98             UInt r_lr;
     99          } PPC32;
    100          struct {
    101             ULong r_lr;
    102          } PPC64;
    103          struct {
    104             UInt r14;
    105             UInt r12;
    106             UInt r11;
    107             UInt r7;
    108          } ARM;
    109          struct {
    110             ULong r_fp;
    111             ULong r_lr;
    112          } S390X;
    113          struct {
    114             UInt r30;  /* Stack frame pointer or subroutine variable  */
    115             UInt r31;  /* Return address of the last subroutine call */
    116             UInt r28;
    117          } MIPS32;
    118       } misc;
    119    }
    120    UnwindStartRegs;
    121 
    122 
    123 #endif   // __PUB_CORE_BASICS_H
    124 
    125 /*--------------------------------------------------------------------*/
    126 /*--- end                                                          ---*/
    127 /*--------------------------------------------------------------------*/
    128