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-2010 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   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#else
62#  error Unknown arch
63#endif
64
65// For jmp_buf
66#include <setjmp.h>
67
68
69/* ---------------------------------------------------------------------
70   A struct to hold starting values for stack unwinding.
71   ------------------------------------------------------------------ */
72
73/* This really shouldn't be here.  But putting it elsewhere leads to a
74   veritable swamp of new module cycles. */
75
76/* To support CFA-based stack unwinding, and stack unwinding in
77   general, we need to be able to get hold of the values of specific
78   registers, in order to start the unwinding process.  This is
79   unavoidably arch and platform dependent.  Here is a struct which
80   holds the relevant values.  All platforms must have a program
81   counter and a stack pointer register, but the other fields (frame
82   pointer? link register? misc other regs?) are ad-hoc.  Note, the
83   common fields are 64-bit, so as to make this host-independent. */
84
85typedef
86   struct {
87      ULong r_pc; /* x86:EIP, amd64:RIP, ppc:CIA, arm:R15 */
88      ULong r_sp; /* x86:ESP, amd64:RSP, ppc:R1,  arm:R13 */
89      union {
90         struct {
91            UInt r_ebp;
92         } X86;
93         struct {
94            ULong r_rbp;
95         } AMD64;
96         struct {
97            UInt r_lr;
98         } PPC32;
99         struct {
100            ULong r_lr;
101         } PPC64;
102         struct {
103            UInt r14;
104            UInt r12;
105            UInt r11;
106            UInt r7;
107         } ARM;
108      } misc;
109   }
110   UnwindStartRegs;
111
112
113#endif   // __PUB_CORE_BASICS_H
114
115/*--------------------------------------------------------------------*/
116/*--- end                                                          ---*/
117/*--------------------------------------------------------------------*/
118