1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- User-mode execve.                             pub_core_ume.h ---*/
4ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
5ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
6ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*
7ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This file is part of Valgrind, a dynamic binary instrumentation
8ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   framework.
9ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
10436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov   Copyright (C) 2000-2013 Julian Seward
11ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      jseward@acm.org
12ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
13ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This program is free software; you can redistribute it and/or
14ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   modify it under the terms of the GNU General Public License as
15ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   published by the Free Software Foundation; either version 2 of the
16ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   License, or (at your option) any later version.
17ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
18ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This program is distributed in the hope that it will be useful, but
19ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   WITHOUT ANY WARRANTY; without even the implied warranty of
20ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   General Public License for more details.
22ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
23ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   You should have received a copy of the GNU General Public License
24ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   along with this program; if not, write to the Free Software
25ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
26ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   02111-1307, USA.
27ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
28ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   The GNU General Public License is contained in the file COPYING.
29ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/
30ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
31ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#ifndef __PUB_CORE_UME_H
32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __PUB_CORE_UME_H
33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
34436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov#include "pub_core_basics.h"   // VG_ macro
35436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov
36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//--------------------------------------------------------------------
37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// PURPOSE: This module implements user-mode execve, ie. program loading
38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// and exec'ing.
39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//--------------------------------------------------------------------
40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*------------------------------------------------------------*/
42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- Loading files                                        ---*/
43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*------------------------------------------------------------*/
44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Info needed to load and run a program.  IN/INOUT/OUT refers to the
46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// inputs/outputs of do_exec().
47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef
48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   struct {
49436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov      const HChar** argv;   // IN: the original argv
50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Addr exe_base;     // INOUT: lowest (allowed) address of exe
52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Addr exe_end;      // INOUT: highest (allowed) address
53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#if !defined(VGO_darwin)
55436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov      Addr     phdr;          // OUT: address phdr was mapped at
56436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov      Int      phnum;         // OUT: number of phdrs
57436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov      UInt     stack_prot;    // OUT: stack permissions
58436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov      PtrdiffT interp_offset; // OUT: relocation offset for ld.so
59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#else
60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Addr  stack_start;      // OUT: address of start of stack segment (hot)
61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Addr  stack_end;        // OUT: address of end of stack segment (cold)
62ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Addr  text;             // OUT: address of executable's Mach header
63ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Bool  dynamic;          // OUT: False iff executable is static
64ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      char* executable_path;  // OUT: path passed to execve()
65ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif
66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
67ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Addr entry;        // OUT: entrypoint in main executable
68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Addr init_ip;      // OUT: address of first instruction to execute
69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Addr brkbase;      // OUT: base address of brk segment
70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Addr init_toc;     // OUT: address of table-of-contents, on
71ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                         // platforms for which that makes sense
72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                         // (ppc64-linux only)
73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      // These are the extra args added by #! scripts
75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      HChar*  interp_name;  // OUT: the interpreter name
76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      HChar*  interp_args;  // OUT: the args for the interpreter
77ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   }
78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ExeInfo;
79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Do a number of appropriate checks to see if the file looks executable by
81ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// the kernel: ie. it's a file, it's readable and executable, and it's in
82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// either binary or "#!" format.  On success, 'out_fd' gets the fd of the file
83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// if it's non-NULL.  Otherwise the fd is closed.
84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern SysRes VG_(pre_exec_check)(const HChar* exe_name, Int* out_fd,
85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                                  Bool allow_setuid);
86ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
87ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Does everything short of actually running 'exe': finds the file,
88ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// checks execute permissions, sets up interpreter if program is a script,
89ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// reads headers, maps file into memory, and returns important info about
90ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// the program.
91ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(do_exec)(const HChar* exe, ExeInfo* info);
92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif /* __PUB_CORE_UME_H */
94ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
95ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
96ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end                                                          ---*/
97ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
98