Home | History | Annotate | Download | only in coregrind
      1 
      2 /*--------------------------------------------------------------------*/
      3 /*--- User-mode execve.                             pub_core_ume.h ---*/
      4 /*--------------------------------------------------------------------*/
      5 
      6 /*
      7    This file is part of Valgrind, a dynamic binary instrumentation
      8    framework.
      9 
     10    Copyright (C) 2000-2012 Julian Seward
     11       jseward (at) 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 
     31 #ifndef __PUB_CORE_UME_H
     32 #define __PUB_CORE_UME_H
     33 
     34 //--------------------------------------------------------------------
     35 // PURPOSE: This module implements user-mode execve, ie. program loading
     36 // and exec'ing.
     37 //--------------------------------------------------------------------
     38 
     39 /*------------------------------------------------------------*/
     40 /*--- Loading files                                        ---*/
     41 /*------------------------------------------------------------*/
     42 
     43 // Info needed to load and run a program.  IN/INOUT/OUT refers to the
     44 // inputs/outputs of do_exec().
     45 typedef
     46    struct {
     47       HChar** argv;       // IN: the original argv
     48 
     49       Addr exe_base;     // INOUT: lowest (allowed) address of exe
     50       Addr exe_end;      // INOUT: highest (allowed) address
     51 
     52 #if !defined(VGO_darwin)
     53       Addr phdr;         // OUT: address phdr was mapped at
     54       Int  phnum;        // OUT: number of phdrs
     55       Addr interp_base;  // OUT: where interpreter (ld.so) was mapped
     56 #else
     57       Addr  stack_start;      // OUT: address of start of stack segment (hot)
     58       Addr  stack_end;        // OUT: address of end of stack segment (cold)
     59       Addr  text;             // OUT: address of executable's Mach header
     60       Bool  dynamic;          // OUT: False iff executable is static
     61       char* executable_path;  // OUT: path passed to execve()
     62 #endif
     63 
     64       Addr entry;        // OUT: entrypoint in main executable
     65       Addr init_ip;      // OUT: address of first instruction to execute
     66       Addr brkbase;      // OUT: base address of brk segment
     67       Addr init_toc;     // OUT: address of table-of-contents, on
     68                          // platforms for which that makes sense
     69                          // (ppc64-linux only)
     70 
     71       // These are the extra args added by #! scripts
     72       HChar*  interp_name;  // OUT: the interpreter name
     73       HChar*  interp_args;  // OUT: the args for the interpreter
     74    }
     75    ExeInfo;
     76 
     77 // Do a number of appropriate checks to see if the file looks executable by
     78 // the kernel: ie. it's a file, it's readable and executable, and it's in
     79 // either binary or "#!" format.  On success, 'out_fd' gets the fd of the file
     80 // if it's non-NULL.  Otherwise the fd is closed.
     81 extern SysRes VG_(pre_exec_check)(const HChar* exe_name, Int* out_fd,
     82                                   Bool allow_setuid);
     83 
     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.
     88 extern Int VG_(do_exec)(const HChar* exe, ExeInfo* info);
     89 
     90 #endif /* __PUB_CORE_UME_H */
     91 
     92 /*--------------------------------------------------------------------*/
     93 /*--- end                                                          ---*/
     94 /*--------------------------------------------------------------------*/
     95