1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- Module-local header file for m_aspacemgr.                    ---*/
4ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*---                                             priv_aspacemgr.h ---*/
5ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
6ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
7ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*
8ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This file is part of Valgrind, a dynamic binary instrumentation
9ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   framework.
10ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
11b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov   Copyright (C) 2006-2011 OpenWorks LLP
12ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      info@open-works.co.uk
13ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
14ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This program is free software; you can redistribute it and/or
15ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   modify it under the terms of the GNU General Public License as
16ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   published by the Free Software Foundation; either version 2 of the
17ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   License, or (at your option) any later version.
18ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
19ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This program is distributed in the hope that it will be useful, but
20ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   WITHOUT ANY WARRANTY; without even the implied warranty of
21ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
22ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   General Public License for more details.
23ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
24ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   You should have received a copy of the GNU General Public License
25ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   along with this program; if not, write to the Free Software
26ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
27ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   02111-1307, USA.
28ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
29ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   The GNU General Public License is contained in the file COPYING.
30ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/
31ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#ifndef __PRIV_ASPACEMGR_H
33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __PRIV_ASPACEMGR_H
34ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
35ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* One of the important design goals of the address space manager is
36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   to minimise dependence on other modules.  Hence the following
37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   minimal set of imports. */
38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_core_basics.h"     // types
40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_core_vkiscnums.h"  // system call numbers
41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_core_vki.h"        // VKI_PAGE_SIZE, VKI_MREMAP_MAYMOVE,
42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                                 // VKI_MREMAP_FIXED, vki_stat64
43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_core_debuglog.h"   // VG_(debugLog)
45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_core_libcbase.h"   // VG_(strlen), VG_(strcmp), VG_(strncpy)
47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                                 // VG_IS_PAGE_ALIGNED
48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                                 // VG_PGROUNDDN, VG_PGROUNDUP
49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_core_syscall.h"    // VG_(do_syscallN)
51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                                 // VG_(mk_SysRes_Error)
52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                                 // VG_(mk_SysRes_Success)
53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_core_options.h"    // VG_(clo_sanity_level)
55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_core_aspacemgr.h"  // self
57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* --------------- Implemented in aspacemgr-common.c ---------------*/
60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Simple assert-like, file I/O and syscall facilities, which avoid
62ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   dependence on m_libcassert, and hence on the entire module graph.
63ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This is important since most of the system itself depends on
64ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   aspacem, so we have to do this to avoid a circular dependency. */
65ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown__attribute__ ((noreturn))
67ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void   ML_(am_exit) ( Int status );
68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void   ML_(am_barf) ( HChar* what );
69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void   ML_(am_barf_toolow) ( HChar* what );
70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
71ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown__attribute__ ((noreturn))
72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void   ML_(am_assert_fail) ( const HChar* expr,
73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                                    const Char* file,
74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                                    Int line,
75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                                    const Char* fn );
76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
77ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define aspacem_assert(expr)                              \
78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown  ((void) ((expr) ? 0 :                                   \
79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown           (ML_(am_assert_fail)(#expr,                    \
80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                                __FILE__, __LINE__,       \
81ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                                __PRETTY_FUNCTION__))))
82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Dude, what's my process ID ? */
84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int    ML_(am_getpid)( void );
85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
86ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* A simple, self-contained sprintf implementation. */
87ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern UInt   ML_(am_sprintf) ( HChar* buf, const HChar *format, ... );
88ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
89ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* mmap et al wrappers */
90ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* wrapper for munmap */
91ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern SysRes ML_(am_do_munmap_NO_NOTIFY)(Addr start, SizeT length);
92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* wrapper for the ghastly 'mremap' syscall */
94ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern SysRes ML_(am_do_extend_mapping_NO_NOTIFY)(
95ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                 Addr  old_addr,
96ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                 SizeT old_len,
97ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                 SizeT new_len
98ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown              );
99ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* ditto */
100ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern SysRes ML_(am_do_relocate_nooverlap_mapping_NO_NOTIFY)(
101ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                 Addr old_addr, Addr old_len,
102ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                 Addr new_addr, Addr new_len
103ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown              );
104ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
105ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* There is also VG_(do_mmap_NO_NOTIFY), but that's not declared
106ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   here (obviously). */
107ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
108ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern SysRes ML_(am_open)  ( const Char* pathname, Int flags, Int mode );
109ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void   ML_(am_close) ( Int fd );
110ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int    ML_(am_read)  ( Int fd, void* buf, Int count);
111ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int    ML_(am_readlink) ( HChar* path, HChar* buf, UInt bufsiz );
112ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int    ML_(am_fcntl) ( Int fd, Int cmd, Addr arg );
113ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
114ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Get the dev, inode and mode info for a file descriptor, if
115ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   possible.  Returns True on success. */
116ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern
117ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownBool ML_(am_get_fd_d_i_m)( Int fd,
118ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                           /*OUT*/ULong* dev,
119ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                           /*OUT*/ULong* ino, /*OUT*/UInt* mode );
120ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
121ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern
122ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownBool ML_(am_resolve_filename) ( Int fd, /*OUT*/HChar* buf, Int nbuf );
123ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
124b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov/* ------ Implemented separately in aspacemgr-linux.c ------ */
125ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
126ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Do a sanity check (/proc/self/maps sync check) */
127ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void ML_(am_do_sanity_check)( void );
128ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
129ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
130ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif   // __PRIV_ASPACEMGR_H
131ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
132ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
133ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end                                                          ---*/
134ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
135