pub_core_initimg.h revision ed07e00d438c74b7a23c01bfffde77e3968305e4
1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- Create initial process image on for the client ---*/ 4ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- pub_core_initimg.h ---*/ 5ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 6ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 7ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* 8ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This file is part of Valgrind, a dynamic binary instrumentation 9ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown framework. 10ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 11ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Copyright (C) 2006-2010 OpenWorks LLP 12ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown info@open-works.co.uk 13ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 14ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This program is free software; you can redistribute it and/or 15ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown modify it under the terms of the GNU General Public License as 16ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown published by the Free Software Foundation; either version 2 of the 17ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown License, or (at your option) any later version. 18ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 19ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This program is distributed in the hope that it will be useful, but 20ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown WITHOUT ANY WARRANTY; without even the implied warranty of 21ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 22ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown General Public License for more details. 23ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 24ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown You should have received a copy of the GNU General Public License 25ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown along with this program; if not, write to the Free Software 26ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 27ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 02111-1307, USA. 28ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 29ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown The GNU General Public License is contained in the file COPYING. 30ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/ 31ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#ifndef __PUB_CORE_INITIMG_H 33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __PUB_CORE_INITIMG_H 34ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 35ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//-------------------------------------------------------------------- 37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// PURPOSE: Map the client executable into memory, then set up its 38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// stack, environment and data section, ready for execution. Quite a 39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// lot of work on Linux (ELF) but nearly a no-op on AIX (XCOFF) since 40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// the AIX kernel does most of the work for us. 41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//-------------------------------------------------------------------- 42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* These are OS-specific and defined below. */ 44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef struct _IICreateImageInfo IICreateImageInfo; 45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef struct _IIFinaliseImageInfo IIFinaliseImageInfo; 46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* This is a two stage process. The first stage, which is most of the 48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown work, creates the initial image in memory to the extent possible. 49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown To do this it takes a bundle of information in an IICreateImageInfo 50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown structure, which is gathered in an OS-specific way at startup. 51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This returns an IIFinaliseImageInfo structure: */ 52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern 53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownIIFinaliseImageInfo VG_(ii_create_image)( IICreateImageInfo ); 54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Just before starting the client, we may need to make final 56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown adjustments to its initial image. Also we need to set up the VEX 57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown guest state for thread 1 (the root thread) and copy in essential 58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown starting values. This is handed the IIFinaliseImageInfo created by 59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_(ii_create_image). */ 60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern 61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid VG_(ii_finalise_image)( IIFinaliseImageInfo ); 62ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 63ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Note that both IICreateImageInfo and IIFinaliseImageInfo are 64ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown OS-specific. We now go on to give instantiations of them 65ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown for supported OSes. */ 66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 67ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* ------------------------- Linux ------------------------- */ 68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#if defined(VGO_linux) 70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 71ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstruct _IICreateImageInfo { 72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* ------ Mandatory fields ------ */ 73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown HChar* toolname; 74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr sp_at_startup; 75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr clstack_top; 76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* ------ Per-OS fields ------ */ 77ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown HChar** argv; 78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown HChar** envp; 79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown}; 80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 81ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstruct _IIFinaliseImageInfo { 82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* ------ Mandatory fields ------ */ 83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SizeT clstack_max_size; 84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr initial_client_SP; 85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* ------ Per-OS fields ------ */ 86ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr initial_client_IP; 87ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr initial_client_TOC; 88ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown UInt* client_auxv; 89ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown}; 90ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 91ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* ------------------------- AIX5 ------------------------- */ 93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 94ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGO_aix5) 95ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 96ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* First we need to define this auxiliary structure. */ 97ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef 98ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown struct { 99ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* NOTE: VG_(ppc32/64_aix5_do_preloads_then_start_client) has 100ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown these offsets hardwired in. Do not change them without 101ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown changing it too. */ 102ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* system call numbers */ 103ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 0 */ UInt nr_load; /* is __NR___loadx for 32-bit, 104ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown __NR_kload for 64 */ 105ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 4 */ UInt nr_kwrite; 106ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 8 */ UInt nr__exit; 107ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* offset/length of error message, if the preloads fail */ 108ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 12 */ UInt off_errmsg; 109ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 16 */ UInt len_errmsg; 110ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* offsets from start of this struct to the the preload file 111ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown names */ 112ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 20 */ UInt off_preloadcorename; 113ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 24 */ UInt off_preloadtoolname; 114ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 28 */ UInt off_ld_preloadname; 115ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Once the preloading is done, we'll need to restore the guest 116ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown state to what it needs to be at client startup. Here's the 117ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown relevant info. Are ULongs; for 32-bit the data is at the 118ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown lsb (high addressed) end. */ 119ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 32 */ ULong client_start; 120ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 40 */ ULong r2; 121ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 48 */ ULong r3; 122ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 56 */ ULong r4; 123ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 64 */ ULong r5; 124ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 72 */ ULong r6; 125ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 80 */ ULong r7; 126ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 88 */ ULong r8; 127ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 96 */ ULong r9; 128ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 104 */ ULong r10; 129ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* If the loading fails, we'll want to call a diagnostic 130ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown function in C to figure out what happened. Here's it's 131ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown function descriptor. Note, this runs on the simd cpu 132ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown (a kludge, and will segfault in 64-bit mode). */ 133ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* 112 */ void* p_diagnose_load_failure; 134ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown } 135ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown AIX5PreloadPage; 136ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 137ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstruct _IICreateImageInfo { 138ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* ------ Mandatory fields ------ */ 139ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown HChar* toolname; 140ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr sp_at_startup; /* Not used on AIX. */ 141ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr clstack_top; /* Not used on AIX. */ 142ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* ------ Per-OS fields ------ */ 143ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Initial values for guest int registers (GPR0 .. GPR31, PC, CR, 144ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown LR, CTR, XER). Passed to us from the launcher. */ 145ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ULong* intregs37; 146ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* AIX5Bootblock*, really */ 147ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown void* bootblock; 148ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Adler32 checksum of uncompressed data of compressed page. */ 149ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown UInt adler32_exp; 150ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown}; 151ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 152ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstruct _IIFinaliseImageInfo { 153ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* ------ Mandatory fields ------ */ 154ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SizeT clstack_max_size; 155ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Initial value for SP (which is merely a copy of r1's value, 156ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown intregs37[1]). */ 157ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr initial_client_SP; 158ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* ------ Per-OS fields ------ */ 159ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Pointer to the preload page. The preload page and this pointer 160ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown to it are set up by VG_(ii_create_image). */ 161ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown AIX5PreloadPage* preloadpage; 162ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Initial values for guest int registers (GPR0 .. GPR31, PC, 163ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown CR, LR, CTR, XER). Copied from the CII. */ 164ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ULong* intregs37; 165ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Address of the page compressed by the launcher. */ 166ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr compressed_page; 167ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* Adler32 checksum of uncompressed data of said page. */ 168ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown UInt adler32_exp; 169ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown}; 170ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 171ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 172ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* ------------------------- Darwin ------------------------- */ 173ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 174ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGO_darwin) 175ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 176ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstruct _IICreateImageInfo { 177ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* ------ Mandatory fields ------ */ 178ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown HChar* toolname; 179ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr sp_at_startup; 180ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr clstack_top; 181ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* ------ Per-OS fields ------ */ 182ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown HChar** argv; 183ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown HChar** envp; 184ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr entry; /* &_start */ 185ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr init_ip; /* &__dyld_start, or copy of entry */ 186ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr stack_start; /* stack segment hot */ 187ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr stack_end; /* stack segment cold */ 188ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr text; /* executable's Mach header */ 189ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Bool dynamic; /* False iff executable is static */ 190ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown HChar* executable_path; /* path passed to execve() */ 191ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown}; 192ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 193ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstruct _IIFinaliseImageInfo { 194ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* ------ Mandatory fields ------ */ 195ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SizeT clstack_max_size; 196ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr initial_client_SP; 197ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* ------ Per-OS fields ------ */ 198ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr initial_client_IP; 199ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown}; 200ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 201ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 202ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#else 203ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# error "Unknown OS" 204ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif 205ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 206ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 207ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif // __PUB_CORE_INITIMG_H 208ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 209ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 210ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end ---*/ 211ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 212