Home | History | Annotate | Download | only in coregrind
      1 
      2 /*--------------------------------------------------------------------*/
      3 /*--- Misc client state info                pub_core_clientstate.h ---*/
      4 /*--------------------------------------------------------------------*/
      5 
      6 /*
      7    This file is part of Valgrind, a dynamic binary instrumentation
      8    framework.
      9 
     10    Copyright (C) 2000-2013 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_CLIENTSTATE_H
     32 #define __PUB_CORE_CLIENTSTATE_H
     33 
     34 //--------------------------------------------------------------------
     35 // PURPOSE: This module holds various bits of client state which don't
     36 // live comfortably anywhere else.  Note that the ThreadStates for the
     37 // client don't live here; they instead live in m_threadstate.h.  Most
     38 // of these values are set once at startup and not changed later.
     39 //--------------------------------------------------------------------
     40 
     41 #include "pub_tool_clientstate.h"
     42 
     43 // Address space globals
     44 
     45 // client stack range
     46 extern Addr  VG_(clstk_start_base); // *Initial* lowest byte address
     47 extern Addr  VG_(clstk_end);        // Highest byte address
     48 extern UWord VG_(clstk_id);      // client stack id
     49 
     50 /* linux only: where is the client auxv ? */
     51 /* This is setup as part of setup_client_stack in initimg-linux.c. */
     52 extern UWord* VG_(client_auxv);
     53 
     54 extern Addr  VG_(brk_base);	 // start of brk
     55 extern Addr  VG_(brk_limit);	 // current brk
     56 
     57 /* A fd which refers to the client executable. */
     58 extern Int VG_(cl_exec_fd);
     59 
     60 /* A fd which refers to the fake /proc/<pid>/cmdline in /tmp.  The
     61    idea is: make up the /proc/<pid>/cmdline file the client would
     62    expect to see if it was running natively.  Copy into a file in
     63    /tmp.  When the client then does an open of /proc/<pid>/cmdline or
     64    /proc/self/cmdline, instead give it a file handle to the file in
     65    /tmp.  The problem of deleting said file when Valgrind exits is
     66    neatly sidestepped by unlinking it as soon as it has been created,
     67    but holding on to the file handle.  That causes the kernel to keep
     68    the file contents alive exactly until the process exits. */
     69 extern Int VG_(cl_cmdline_fd);
     70 
     71 /* Same as above, but for /proc/<pid>/auxv. */
     72 extern Int VG_(cl_auxv_fd);
     73 
     74 // Client's original rlimit data and rlimit stack
     75 extern struct vki_rlimit VG_(client_rlimit_data);
     76 extern struct vki_rlimit VG_(client_rlimit_stack);
     77 
     78 // Name of the launcher, as extracted from VALGRIND_LAUNCHER at
     79 // startup.
     80 extern HChar* VG_(name_of_launcher);
     81 
     82 /* Application-visible file descriptor limits */
     83 extern Int VG_(fd_soft_limit);
     84 extern Int VG_(fd_hard_limit);
     85 
     86 /* Useful addresses extracted from the client */
     87 /* Where is the __libc_freeres_wrapper routine we made? */
     88 extern Addr VG_(client___libc_freeres_wrapper);
     89 
     90 /* x86-linux only: where is ld.so's _dl_sysinfo_int80 function?
     91    Finding it isn't essential, but knowing where it is does sometimes
     92    help produce better back traces.  See big comment in
     93    VG_(get_StackTrace) in m_stacktrace.c for further info. */
     94 extern Addr VG_(client__dl_sysinfo_int80);
     95 
     96 
     97 /* glibc nptl pthread systems only, when no-nptl-pthread-stackcache
     98    was given in --sim-hints.
     99    Used for a (kludgy) way to disable the cache of stacks as implemented in
    100    nptl glibc.
    101    Based on internal knowledge of the pthread glibc nptl/allocatestack.c code:
    102    a huge value in stack_cache_actsize (bigger than the constant
    103    stack_cache_maxsize) makes glibc believes the cache is full
    104    and so stacks are always released when a pthread terminates.
    105    Several ugliness in this kludge:
    106     * hardcodes private glibc var name "stack_cache_maxsize"
    107     * based on knowledge of the code of the functions
    108       queue_stack and __free_stacks
    109     * static symbol for "stack_cache_maxsize" must be in
    110       the debug info.
    111    It would be much cleaner to have a documented and supported
    112    way to disable the pthread stack cache. */
    113 extern SizeT* VG_(client__stack_cache_actsize__addr);
    114 
    115 #endif   // __PUB_CORE_CLIENTSTATE_H
    116 
    117 /*--------------------------------------------------------------------*/
    118 /*--- end                                                          ---*/
    119 /*--------------------------------------------------------------------*/
    120