jseward | 2886b0e | 2004-01-04 03:46:11 +0000 | [diff] [blame] | 1 | |
nethercote | 1fe5450 | 2004-07-26 15:28:33 +0000 | [diff] [blame] | 2 | /*--------------------------------------------------------------------*/ |
njn | 08a2e17 | 2005-06-21 22:47:54 +0000 | [diff] [blame] | 3 | /*--- User-mode execve. pub_core_ume.h ---*/ |
nethercote | 1fe5450 | 2004-07-26 15:28:33 +0000 | [diff] [blame] | 4 | /*--------------------------------------------------------------------*/ |
| 5 | |
jseward | 2886b0e | 2004-01-04 03:46:11 +0000 | [diff] [blame] | 6 | /* |
njn | b9c427c | 2004-12-01 14:14:42 +0000 | [diff] [blame] | 7 | This file is part of Valgrind, a dynamic binary instrumentation |
| 8 | framework. |
jseward | 2886b0e | 2004-01-04 03:46:11 +0000 | [diff] [blame] | 9 | |
sewardj | b3a1e4b | 2015-08-21 11:32:26 +0000 | [diff] [blame] | 10 | Copyright (C) 2000-2015 Julian Seward |
jseward | 2886b0e | 2004-01-04 03:46:11 +0000 | [diff] [blame] | 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 | |
njn | 08a2e17 | 2005-06-21 22:47:54 +0000 | [diff] [blame] | 31 | #ifndef __PUB_CORE_UME_H |
| 32 | #define __PUB_CORE_UME_H |
| 33 | |
florian | 535fb1b | 2013-09-15 13:54:34 +0000 | [diff] [blame] | 34 | #include "pub_core_basics.h" // VG_ macro |
| 35 | |
njn | 08a2e17 | 2005-06-21 22:47:54 +0000 | [diff] [blame] | 36 | //-------------------------------------------------------------------- |
| 37 | // PURPOSE: This module implements user-mode execve, ie. program loading |
sewardj | ec7be9c | 2006-10-17 01:59:30 +0000 | [diff] [blame] | 38 | // and exec'ing. |
njn | 08a2e17 | 2005-06-21 22:47:54 +0000 | [diff] [blame] | 39 | //-------------------------------------------------------------------- |
fitzhardinge | 7e343cd | 2003-12-16 02:14:00 +0000 | [diff] [blame] | 40 | |
nethercote | 107e1c0 | 2004-10-13 17:55:31 +0000 | [diff] [blame] | 41 | /*------------------------------------------------------------*/ |
njn | 91772d1 | 2009-01-21 02:26:56 +0000 | [diff] [blame] | 42 | /*--- Loading files ---*/ |
nethercote | 107e1c0 | 2004-10-13 17:55:31 +0000 | [diff] [blame] | 43 | /*------------------------------------------------------------*/ |
| 44 | |
nethercote | ea147e7 | 2004-07-26 15:43:57 +0000 | [diff] [blame] | 45 | // Info needed to load and run a program. IN/INOUT/OUT refers to the |
| 46 | // inputs/outputs of do_exec(). |
sewardj | 13247ca | 2005-12-30 22:52:20 +0000 | [diff] [blame] | 47 | typedef |
| 48 | struct { |
florian | 3e79863 | 2012-11-24 19:41:54 +0000 | [diff] [blame] | 49 | const HChar** argv; // IN: the original argv |
fitzhardinge | 7e343cd | 2003-12-16 02:14:00 +0000 | [diff] [blame] | 50 | |
sewardj | 13247ca | 2005-12-30 22:52:20 +0000 | [diff] [blame] | 51 | Addr exe_base; // INOUT: lowest (allowed) address of exe |
| 52 | Addr exe_end; // INOUT: highest (allowed) address |
fitzhardinge | 7e343cd | 2003-12-16 02:14:00 +0000 | [diff] [blame] | 53 | |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 54 | #if !defined(VGO_darwin) |
tom | 3d24135 | 2014-01-07 22:27:57 +0000 | [diff] [blame] | 55 | Addr phdr; // OUT: address phdr was mapped at |
| 56 | Int phnum; // OUT: number of phdrs |
| 57 | UInt stack_prot; // OUT: stack permissions |
| 58 | PtrdiffT interp_offset; // OUT: relocation offset for ld.so |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 59 | #else |
| 60 | Addr stack_start; // OUT: address of start of stack segment (hot) |
| 61 | Addr stack_end; // OUT: address of end of stack segment (cold) |
| 62 | Addr text; // OUT: address of executable's Mach header |
| 63 | Bool dynamic; // OUT: False iff executable is static |
florian | dc240c8 | 2014-08-09 16:55:59 +0000 | [diff] [blame] | 64 | HChar* executable_path; // OUT: path passed to execve() |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 65 | #endif |
| 66 | |
sewardj | 8eb8bab | 2015-07-21 14:44:28 +0000 | [diff] [blame] | 67 | #if defined(VGO_solaris) |
iraisr | 358f27c | 2015-08-17 19:13:12 +0000 | [diff] [blame] | 68 | Addr init_thrptr; // OUT: architecture-specific user per-thread location |
| 69 | Bool real_phdr_present; // OUT: PT_PHDR found, include phdr in auxv |
iraisr | bcfaeed | 2015-08-22 22:08:43 +0000 | [diff] [blame] | 70 | Bool ldsoexec; // OUT: the program is the runtime linker itself |
sewardj | 8eb8bab | 2015-07-21 14:44:28 +0000 | [diff] [blame] | 71 | #endif |
| 72 | |
Elliott Hughes | a0664b9 | 2017-04-18 17:46:52 -0700 | [diff] [blame^] | 73 | #if defined(VGO_linux) |
| 74 | // INOUT: architecture-specific ELF loading state |
| 75 | struct vki_arch_elf_state *arch_elf_state; |
| 76 | #endif |
| 77 | |
sewardj | 13247ca | 2005-12-30 22:52:20 +0000 | [diff] [blame] | 78 | Addr entry; // OUT: entrypoint in main executable |
| 79 | Addr init_ip; // OUT: address of first instruction to execute |
| 80 | Addr brkbase; // OUT: base address of brk segment |
| 81 | Addr init_toc; // OUT: address of table-of-contents, on |
| 82 | // platforms for which that makes sense |
| 83 | // (ppc64-linux only) |
fitzhardinge | 7e343cd | 2003-12-16 02:14:00 +0000 | [diff] [blame] | 84 | |
sewardj | 13247ca | 2005-12-30 22:52:20 +0000 | [diff] [blame] | 85 | // These are the extra args added by #! scripts |
| 86 | HChar* interp_name; // OUT: the interpreter name |
| 87 | HChar* interp_args; // OUT: the args for the interpreter |
| 88 | } |
| 89 | ExeInfo; |
fitzhardinge | 7e343cd | 2003-12-16 02:14:00 +0000 | [diff] [blame] | 90 | |
njn | 7375061 | 2005-10-14 03:11:30 +0000 | [diff] [blame] | 91 | // Do a number of appropriate checks to see if the file looks executable by |
| 92 | // the kernel: ie. it's a file, it's readable and executable, and it's in |
njn | 91772d1 | 2009-01-21 02:26:56 +0000 | [diff] [blame] | 93 | // either binary or "#!" format. On success, 'out_fd' gets the fd of the file |
njn | 7375061 | 2005-10-14 03:11:30 +0000 | [diff] [blame] | 94 | // if it's non-NULL. Otherwise the fd is closed. |
sewardj | c74b3ba | 2007-11-17 21:11:57 +0000 | [diff] [blame] | 95 | extern SysRes VG_(pre_exec_check)(const HChar* exe_name, Int* out_fd, |
| 96 | Bool allow_setuid); |
njn | 7375061 | 2005-10-14 03:11:30 +0000 | [diff] [blame] | 97 | |
nethercote | ea147e7 | 2004-07-26 15:43:57 +0000 | [diff] [blame] | 98 | // Does everything short of actually running 'exe': finds the file, |
| 99 | // checks execute permissions, sets up interpreter if program is a script, |
| 100 | // reads headers, maps file into memory, and returns important info about |
| 101 | // the program. |
sewardj | 13247ca | 2005-12-30 22:52:20 +0000 | [diff] [blame] | 102 | extern Int VG_(do_exec)(const HChar* exe, ExeInfo* info); |
fitzhardinge | 7e343cd | 2003-12-16 02:14:00 +0000 | [diff] [blame] | 103 | |
njn | 08a2e17 | 2005-06-21 22:47:54 +0000 | [diff] [blame] | 104 | #endif /* __PUB_CORE_UME_H */ |
nethercote | 1fe5450 | 2004-07-26 15:28:33 +0000 | [diff] [blame] | 105 | |
| 106 | /*--------------------------------------------------------------------*/ |
njn | 08a2e17 | 2005-06-21 22:47:54 +0000 | [diff] [blame] | 107 | /*--- end ---*/ |
nethercote | 1fe5450 | 2004-07-26 15:28:33 +0000 | [diff] [blame] | 108 | /*--------------------------------------------------------------------*/ |