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 11436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov Copyright (C) 2006-2013 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 35436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov#include "pub_core_basics.h" // Addr 36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//-------------------------------------------------------------------- 38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// PURPOSE: Map the client executable into memory, then set up its 39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// stack, environment and data section, ready for execution. Quite a 40b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov// lot of work on Linux (ELF). 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 ------ */ 73436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov const 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/* ------------------------- Darwin ------------------------- */ 92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#elif defined(VGO_darwin) 94ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 95ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstruct _IICreateImageInfo { 96ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* ------ Mandatory fields ------ */ 97436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov const HChar* toolname; 98ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr sp_at_startup; 99ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr clstack_top; 100ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* ------ Per-OS fields ------ */ 101ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown HChar** argv; 102ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown HChar** envp; 103ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr entry; /* &_start */ 104ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr init_ip; /* &__dyld_start, or copy of entry */ 105ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr stack_start; /* stack segment hot */ 106ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr stack_end; /* stack segment cold */ 107ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr text; /* executable's Mach header */ 108ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Bool dynamic; /* False iff executable is static */ 109ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown HChar* executable_path; /* path passed to execve() */ 110ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown}; 111ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 112ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstruct _IIFinaliseImageInfo { 113ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* ------ Mandatory fields ------ */ 114ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown SizeT clstack_max_size; 115ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr initial_client_SP; 116ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown /* ------ Per-OS fields ------ */ 117ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Addr initial_client_IP; 118ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown}; 119ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 120ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 121ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#else 122ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown# error "Unknown OS" 123ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif 124ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 125ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 126ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif // __PUB_CORE_INITIMG_H 127ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 128ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 129ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end ---*/ 130ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 131