coregrind/m_aspacemgr/priv_aspacemgr.h

   1
   2 /*--------------------------------------------------------------------*/
   3 /*--- Module-local header file for m_aspacemgr.                    ---*/
   4 /*---                                             priv_aspacemgr.h ---*/
   5 /*--------------------------------------------------------------------*/
   6
   7 /*
   8    This file is part of Valgrind, a dynamic binary instrumentation
   9    framework.
  10
  11    Copyright (C) 2006-2017 OpenWorks LLP
  12       info@open-works.co.uk
  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, see <http://www.gnu.org/licenses/>.
  26
  27    The GNU General Public License is contained in the file COPYING.
  28 */
  29
  30 #ifndef __PRIV_ASPACEMGR_H
  31 #define __PRIV_ASPACEMGR_H
  32
  33 /* One of the important design goals of the address space manager is
  34    to minimise dependence on other modules.  Hence the following
  35    minimal set of imports. */
  36
  37 #include "pub_core_basics.h"     // types
  38 #include "pub_core_vkiscnums.h"  // system call numbers
  39 #include "pub_core_vki.h"        // VKI_PAGE_SIZE, VKI_MREMAP_MAYMOVE,
  40                                  // VKI_MREMAP_FIXED, vki_stat64
  41
  42 #include "pub_core_debuglog.h"   // VG_(debugLog)
  43
  44 #include "pub_core_libcbase.h"   // VG_(strlen), VG_(strcmp), VG_(strncpy)
  45                                  // VG_IS_PAGE_ALIGNED
  46                                  // VG_PGROUNDDN, VG_PGROUNDUP
  47
  48 #include "pub_core_libcassert.h" // VG_(exit_now)
  49
  50 #include "pub_core_syscall.h"    // VG_(do_syscallN)
  51                                  // VG_(mk_SysRes_Error)
  52                                  // VG_(mk_SysRes_Success)
  53
  54 #include "pub_core_options.h"    // VG_(clo_sanity_level)
  55
  56 #if defined(VGO_freebsd)
  57 #include "pub_core_libcproc.h"   // VG_(sysctlbyname)
  58 #endif
  59
  60 #include "pub_core_aspacemgr.h"  // self
  61
  62
  63 /* --------------- Implemented in aspacemgr-common.c ---------------*/
  64
  65 /* Simple assert-like, file I/O and syscall facilities, which avoid
  66    dependence on m_libcassert, and hence on the entire module graph.
  67    This is important since most of the system itself depends on
  68    aspacem, so we have to do this to avoid a circular dependency. */
  69
  70 __attribute__ ((noreturn))
  71 extern void   ML_(am_exit) ( Int status );
  72 __attribute__ ((noreturn))
  73 extern void   ML_(am_barf) ( const HChar* what );
  74 __attribute__ ((noreturn))
  75 extern void   ML_(am_barf_toolow) ( const HChar* what );
  76
  77 __attribute__ ((noreturn))
  78 extern void   ML_(am_assert_fail) ( const HChar* expr,
  79                                     const HChar* file,
  80                                     Int line,
  81                                     const HChar* fn );
  82
  83 #define aspacem_assert(expr)                              \
  84   ((void) (LIKELY(expr) ? (void)0 :                             \
  85            (ML_(am_assert_fail)(#expr,                    \
  86                                 __FILE__, __LINE__,       \
  87                                 __PRETTY_FUNCTION__))))
  88
  89 /* Dude, what's my process ID ? */
  90 extern Int    ML_(am_getpid)( void );
  91
  92 /* A simple, self-contained sprintf implementation. */
  93 extern UInt   ML_(am_sprintf) ( HChar* buf, const HChar *format, ... );
  94
  95 /* mmap et al wrappers */
  96 /* wrapper for munmap */
  97 extern SysRes ML_(am_do_munmap_NO_NOTIFY)(Addr start, SizeT length);
  98
  99 /* wrapper for the ghastly 'mremap' syscall */
 100 extern SysRes ML_(am_do_extend_mapping_NO_NOTIFY)(
 101                  Addr  old_addr,
 102                  SizeT old_len,
 103                  SizeT new_len
 104               );
 105 /* ditto */
 106 extern SysRes ML_(am_do_relocate_nooverlap_mapping_NO_NOTIFY)(
 107                  Addr old_addr, Addr old_len,
 108                  Addr new_addr, Addr new_len
 109               );
 110
 111 /* There is also VG_(do_mmap_NO_NOTIFY), but that's not declared
 112    here (obviously). */
 113
 114 extern SysRes ML_(am_open)  ( const HChar* pathname, Int flags, Int mode );
 115 extern void   ML_(am_close) ( Int fd );
 116 extern Int    ML_(am_read)  ( Int fd, void* buf, Int count);
 117 extern Int    ML_(am_readlink) ( const HChar* path, HChar* buf, UInt bufsiz );
 118 extern Int    ML_(am_fcntl) ( Int fd, Int cmd, Addr arg );
 119
 120 /* Get the dev, inode and mode info for a file descriptor, if
 121    possible.  Returns True on success. */
 122 extern
 123 Bool ML_(am_get_fd_d_i_m)( Int fd,
 124                            /*OUT*/ULong* dev,
 125                            /*OUT*/ULong* ino, /*OUT*/UInt* mode );
 126
 127 extern
 128 Bool ML_(am_resolve_filename) ( Int fd, /*OUT*/HChar* buf, Int nbuf );
 129
 130 /* ------ Implemented separately in aspacemgr-linux.c ------ */
 131
 132 /* Do a sanity check (/proc/self/maps sync check) */
 133 extern void ML_(am_do_sanity_check)( void );
 134
 135
 136 /* ------ Implemented in aspacemgr-segnames.c ------ */
 137 void ML_(am_segnames_init)(void);
 138 void ML_(am_show_segnames)(Int logLevel, const HChar *prefix);
 139
 140 /* Put NAME into the string table of segment names. Return index for
 141    future reference. A return value of -1 indicates that the segment name
 142    could not be stored. Basically an out-of-memory situation. */
 143 Int ML_(am_allocate_segname)(const HChar *name);
 144
 145 /* Increment / decrement the reference counter for this segment name. */
 146 void ML_(am_inc_refcount)(Int);
 147 void ML_(am_dec_refcount)(Int);
 148
 149 /* Check whether the segname index is sane. */
 150 Bool ML_(am_sane_segname)(Int fnIdx);
 151
 152 /* Return the segment name for the given index. Maybe return NULL, if the
 153    segment does not have a name. */
 154 const HChar *ML_(am_get_segname)(Int fnIdx);
 155
 156 /* Return the sequence number of the segment name */
 157 Int ML_(am_segname_get_seqnr)(Int fnIdx);
 158
 159 #endif   // __PRIV_ASPACEMGR_H
 160
 161 /*--------------------------------------------------------------------*/
 162 /*--- end                                                          ---*/
 163 /*--------------------------------------------------------------------*/