jseward | 2886b0e | 2004-01-04 03:46:11 +0000 | [diff] [blame] | 1 | |
nethercote | 1fe5450 | 2004-07-26 15:28:33 +0000 | [diff] [blame] | 2 | /*--------------------------------------------------------------------*/ |
| 3 | /*--- A header file used by both stage1 and stage2. ---*/ |
| 4 | /*--- ume.h ---*/ |
| 5 | /*--------------------------------------------------------------------*/ |
| 6 | |
jseward | 2886b0e | 2004-01-04 03:46:11 +0000 | [diff] [blame] | 7 | /* |
| 8 | This file is part of Valgrind, an extensible x86 protected-mode |
| 9 | emulator for monitoring program execution on x86-Unixes. |
| 10 | |
| 11 | Copyright (C) 2000-2004 Julian Seward |
| 12 | jseward@acm.org |
| 13 | |
| 14 | This program is free software; you can redistribute it and/or |
| 15 | modify it under the terms of the GNU General Public License as |
| 16 | published by the Free Software Foundation; either version 2 of the |
| 17 | License, or (at your option) any later version. |
| 18 | |
| 19 | This program is distributed in the hope that it will be useful, but |
| 20 | WITHOUT ANY WARRANTY; without even the implied warranty of |
| 21 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 22 | General Public License for more details. |
| 23 | |
| 24 | You should have received a copy of the GNU General Public License |
| 25 | along with this program; if not, write to the Free Software |
| 26 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
| 27 | 02111-1307, USA. |
| 28 | |
| 29 | The GNU General Public License is contained in the file COPYING. |
| 30 | */ |
| 31 | |
fitzhardinge | 7e343cd | 2003-12-16 02:14:00 +0000 | [diff] [blame] | 32 | #ifndef _COREGRIND_UME_H |
| 33 | #define _COREGRIND_UME_H |
| 34 | |
| 35 | #include <elf.h> |
| 36 | #include <sys/types.h> |
| 37 | |
nethercote | 1fe5450 | 2004-07-26 15:28:33 +0000 | [diff] [blame] | 38 | /*------------------------------------------------------------*/ |
| 39 | /*--- General stuff ---*/ |
| 40 | /*------------------------------------------------------------*/ |
| 41 | |
nethercote | 969ecf1 | 2004-10-13 17:29:01 +0000 | [diff] [blame^] | 42 | void foreach_map(int (*fn)(char *start, char *end, |
| 43 | const char *perm, off_t offset, |
| 44 | int maj, int min, int ino, void* extra), |
| 45 | void* extra); |
| 46 | |
| 47 | /*------------------------------------------------------------*/ |
| 48 | /*--- Loading ELF files ---*/ |
| 49 | /*------------------------------------------------------------*/ |
| 50 | |
fitzhardinge | 7e343cd | 2003-12-16 02:14:00 +0000 | [diff] [blame] | 51 | #if ELFSZ == 64 |
| 52 | #define ESZ(x) Elf64_##x |
| 53 | #elif ELFSZ == 32 |
| 54 | #define ESZ(x) Elf32_##x |
| 55 | #else |
| 56 | #error ELFSZ needs to ==32 or ==64 |
| 57 | #endif |
| 58 | |
| 59 | /* Integer type the same size as a pointer */ |
| 60 | typedef ESZ(Addr) addr_t; |
| 61 | |
nethercote | ea147e7 | 2004-07-26 15:43:57 +0000 | [diff] [blame] | 62 | // Info needed to load and run a program. IN/INOUT/OUT refers to the |
| 63 | // inputs/outputs of do_exec(). |
fitzhardinge | 7e343cd | 2003-12-16 02:14:00 +0000 | [diff] [blame] | 64 | struct exeinfo |
| 65 | { |
nethercote | ea147e7 | 2004-07-26 15:43:57 +0000 | [diff] [blame] | 66 | addr_t map_base; // IN: if non-zero, base address of mappings |
| 67 | char** argv; // IN: the original argv |
fitzhardinge | 7e343cd | 2003-12-16 02:14:00 +0000 | [diff] [blame] | 68 | |
nethercote | 1fe5450 | 2004-07-26 15:28:33 +0000 | [diff] [blame] | 69 | addr_t exe_base; // INOUT: lowest (allowed) address of exe |
| 70 | addr_t exe_end; // INOUT: highest (allowed) address |
fitzhardinge | 7e343cd | 2003-12-16 02:14:00 +0000 | [diff] [blame] | 71 | |
nethercote | ea147e7 | 2004-07-26 15:43:57 +0000 | [diff] [blame] | 72 | addr_t phdr; // OUT: address phdr was mapped at |
| 73 | int phnum; // OUT: number of phdrs |
| 74 | addr_t interp_base; // OUT: where interpreter (ld.so) was mapped |
| 75 | addr_t entry; // OUT: entrypoint in main executable |
| 76 | addr_t init_eip; // OUT: initial eip |
| 77 | addr_t brkbase; // OUT: base address of brk segment |
fitzhardinge | 7e343cd | 2003-12-16 02:14:00 +0000 | [diff] [blame] | 78 | |
nethercote | 1fe5450 | 2004-07-26 15:28:33 +0000 | [diff] [blame] | 79 | // These are the extra args added by #! scripts |
nethercote | ea147e7 | 2004-07-26 15:43:57 +0000 | [diff] [blame] | 80 | char* interp_name; // OUT: the interpreter name |
| 81 | char* interp_args; // OUT: the args for the interpreter |
fitzhardinge | 7e343cd | 2003-12-16 02:14:00 +0000 | [diff] [blame] | 82 | }; |
| 83 | |
nethercote | ea147e7 | 2004-07-26 15:43:57 +0000 | [diff] [blame] | 84 | // Does everything short of actually running 'exe': finds the file, |
| 85 | // checks execute permissions, sets up interpreter if program is a script, |
| 86 | // reads headers, maps file into memory, and returns important info about |
| 87 | // the program. |
fitzhardinge | 7e343cd | 2003-12-16 02:14:00 +0000 | [diff] [blame] | 88 | int do_exec(const char *exe, struct exeinfo *info); |
| 89 | |
nethercote | 1fe5450 | 2004-07-26 15:28:33 +0000 | [diff] [blame] | 90 | /*------------------------------------------------------------*/ |
nethercote | 1fe5450 | 2004-07-26 15:28:33 +0000 | [diff] [blame] | 91 | /*--- Finding and dealing with auxv ---*/ |
| 92 | /*------------------------------------------------------------*/ |
fitzhardinge | 7e343cd | 2003-12-16 02:14:00 +0000 | [diff] [blame] | 93 | |
| 94 | struct ume_auxv |
| 95 | { |
| 96 | int a_type; |
| 97 | union { |
| 98 | void *a_ptr; |
| 99 | int a_val; |
| 100 | void (*a_fcn)(void); |
mueller | 5ed88f2 | 2004-01-06 16:02:29 +0000 | [diff] [blame] | 101 | } u; |
fitzhardinge | 7e343cd | 2003-12-16 02:14:00 +0000 | [diff] [blame] | 102 | }; |
| 103 | |
| 104 | struct ume_auxv *find_auxv(int *orig_esp); |
| 105 | |
| 106 | /* Our private auxv entries */ |
| 107 | #define AT_UME_PADFD 0xff01 /* padding file fd */ |
| 108 | #define AT_UME_EXECFD 0xff02 /* stage1 executable fd */ |
| 109 | |
| 110 | #endif /* _COREGRIND_UME_H */ |
nethercote | 1fe5450 | 2004-07-26 15:28:33 +0000 | [diff] [blame] | 111 | |
| 112 | /*--------------------------------------------------------------------*/ |
| 113 | /*--- end ume.h ---*/ |
| 114 | /*--------------------------------------------------------------------*/ |