1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- Address space manager.                  pub_tool_aspacemgr.h ---*/
4ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
5ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
6ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*
7ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This file is part of Valgrind, a dynamic binary instrumentation
8ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   framework.
9ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
10b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov   Copyright (C) 2000-2011 Julian Seward
11ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      jseward@acm.org
12ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
13ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This program is free software; you can redistribute it and/or
14ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   modify it under the terms of the GNU General Public License as
15ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   published by the Free Software Foundation; either version 2 of the
16ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   License, or (at your option) any later version.
17ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
18ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This program is distributed in the hope that it will be useful, but
19ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   WITHOUT ANY WARRANTY; without even the implied warranty of
20ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   General Public License for more details.
22ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
23ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   You should have received a copy of the GNU General Public License
24ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   along with this program; if not, write to the Free Software
25ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
26ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   02111-1307, USA.
27ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
28ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   The GNU General Public License is contained in the file COPYING.
29ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/
30ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
31ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#ifndef __PUB_TOOL_ASPACEMGR_H
32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __PUB_TOOL_ASPACEMGR_H
33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
34ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
35ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//--------------------------------------------------------------
36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Definition of address-space segments
37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Describes segment kinds. */
39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef
40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   enum {
41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      SkFree,   // unmapped space
42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      SkAnonC,  // anonymous mapping belonging to the client
43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      SkAnonV,  // anonymous mapping belonging to valgrind
44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      SkFileC,  // file mapping belonging to the client
45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      SkFileV,  // file mapping belonging to valgrind
46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      SkShmC,   // shared memory segment belonging to the client
47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      SkResvn   // reservation
48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   }
49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   SegKind;
50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Describes how a reservation segment can be resized. */
52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef
53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   enum {
54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      SmLower,  // lower end can move up
55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      SmFixed,  // cannot be shrunk
56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      SmUpper   // upper end can move down
57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   }
58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ShrinkMode;
59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Describes a segment.  Invariants:
61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
62ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown     kind == SkFree:
63ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown        // the only meaningful fields are .start and .end
64ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
65ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown     kind == SkAnon{C,V}:
66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown        // smode==SmFixed
67ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown        // there's no associated file:
68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown        dev==ino==foff = 0, fnidx == -1
69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown        // segment may have permissions
70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
71ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown     kind == SkFile{C,V}:
72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown        // smode==SmFixed
73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown        moveLo == moveHi == NotMovable, maxlen == 0
74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown        // there is an associated file
75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown        // segment may have permissions
76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
77ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown     kind == SkShmC:
78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown        // smode==SmFixed
79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown        // there's no associated file:
80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown        dev==ino==foff = 0, fnidx == -1
81ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown        // segment may have permissions
82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown     kind == SkResvn
84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown        // the segment may be resized if required
85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown        // there's no associated file:
86ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown        dev==ino==foff = 0, fnidx == -1
87ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown        // segment has no permissions
88ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown        hasR==hasW==hasX==anyTranslated == False
89ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
90ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown     Also: anyTranslated==True is only allowed in SkFileV and SkAnonV
91ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown           (viz, not allowed to make translations from non-client areas)
92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/
93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Browntypedef
94ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   struct {
95ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      SegKind kind;
96ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      /* Extent (SkFree, SkAnon{C,V}, SkFile{C,V}, SkResvn) */
97ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Addr    start;    // lowest address in range
98ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Addr    end;      // highest address in range
99ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      /* Shrinkable? (SkResvn only) */
100ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      ShrinkMode smode;
101ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      /* Associated file (SkFile{C,V} only) */
102ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      ULong   dev;
103ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      ULong   ino;
104ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Off64T  offset;
105ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      UInt    mode;
106ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Int     fnIdx;    // file name table index, if name is known
107ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      /* Permissions (SkAnon{C,V}, SkFile{C,V} only) */
108ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Bool    hasR;
109ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Bool    hasW;
110ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Bool    hasX;
111ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Bool    hasT;     // True --> translations have (or MAY have)
112ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                        // been taken from this segment
113ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Bool    isCH;     // True --> is client heap (SkAnonC ONLY)
114ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      /* Admin */
115ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      Bool    mark;
116ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   }
117ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   NSegment;
118ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
119ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
120ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Collect up the start addresses of all non-free, non-resvn segments.
121ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   The interface is a bit strange in order to avoid potential
122ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   segment-creation races caused by dynamic allocation of the result
123ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   buffer *starts.
124ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
125ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   The function first computes how many entries in the result
126ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   buffer *starts will be needed.  If this number <= nStarts,
127ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   they are placed in starts[0..], and the number is returned.
128ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   If nStarts is not large enough, nothing is written to
129ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   starts[0..], and the negation of the size is returned.
130ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
131ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   Correct use of this function may mean calling it multiple times in
132ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   order to establish a suitably-sized buffer. */
133ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(am_get_segment_starts)( Addr* starts, Int nStarts );
134ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
135ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
136ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// See pub_core_aspacemgr.h for description.
137ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern NSegment const * VG_(am_find_nsegment) ( Addr a );
138ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
139ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// See pub_core_aspacemgr.h for description.
140ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern HChar* VG_(am_get_filename)( NSegment const * );
141ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
142ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// See pub_core_aspacemgr.h for description.
143ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(am_is_valid_for_client) ( Addr start, SizeT len,
144ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                                          UInt prot );
145ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
146ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// See pub_core_aspacemgr.h for description.
147ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Really just a wrapper around VG_(am_mmap_anon_float_valgrind). */
148ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void* VG_(am_shadow_alloc)(SizeT size);
149ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
150ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Unmap the given address range and update the segment array
151ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   accordingly.  This fails if the range isn't valid for valgrind. */
152ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern SysRes VG_(am_munmap_valgrind)( Addr start, SizeT length );
153ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
154ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif   // __PUB_TOOL_ASPACEMGR_H
155ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
156ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
157ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end                                                          ---*/
158ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
159