Update copyright
[dyninst.git] / symtabAPI / src / LinkMap.h
1 /*
2  * Copyright (c) 1996-2011 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as "Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * By your use of Paradyn, you understand and agree that we (or any
12  * other person or entity with proprietary rights in Paradyn) are
13  * under no obligation to provide either maintenance services,
14  * update services, notices of latent defects, or correction of
15  * defects for Paradyn.
16  * 
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  * 
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  * 
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30  */
31
32 #if !defined(_Link_Map_h_)
33 #define _Link_Map_h_
34
35 #include "Symtab.h"
36 #include "Region.h"
37 #include "Symbol.h"
38 #include "Function.h"
39
40 #include <deque>
41 #include <map>
42 #include <vector>
43 using namespace std;
44
45 namespace Dyninst{
46 namespace SymtabAPI{
47
48 /*
49  * A data structure that holds all the information necessary to perform a
50  * static link once all the relocatable files have been copied into a new data
51  * block
52  */
53 class LinkMap {
54     public:
55         LinkMap();
56         ~LinkMap();
57
58         // A pair representing an allocation for a Region
59         // The first Offset is the amount of padding before the Region
60         // The second Offset is the offset of the location in the allocatedData
61         typedef pair<Offset, Offset> AllocPair;
62
63         // prints the LinkMap (really for debugging purposes)
64         // uses globalOffset as the location of allocatedData in the target
65         void print(Offset globalOffset);
66         void printAll(ostream &os, Offset globalOffset);
67         void printBySymtab(ostream &os, vector<Symtab *> &symtabs, Offset globalOffset);
68         void printRegions(ostream &os, deque<Region *> &regions, Offset globalOffset);
69         void printRegion(ostream &os, Region *region, Offset globalOffset);
70         void printRegionFromInfo(ostream &os, Region *region, Offset regionOffset, Offset padding);
71         
72         friend ostream & operator<<(ostream &os, LinkMap &lm);
73
74         // Data Members
75         // all other members describe this block of data
76         char *allocatedData; 
77         Offset allocatedSize;
78
79         // map of Regions placed in allocatedData
80         map<Region *, AllocPair> regionAllocs;
81
82         // Keep track of the dynamically allocated COMMON symbol Region
83         Region *commonStorage;
84
85         // new Region info
86         // Offset -> offset in allocatedData
87         // Size -> size of Region
88         // Regions -> existing Regions which make up this Region
89
90         // new bss Region info
91         Offset bssRegionOffset;
92         Offset bssSize;
93         Offset bssRegionAlign;
94         deque<Region *> bssRegions;
95
96         // new data Region info
97         Offset dataRegionOffset;
98         Offset dataSize;
99         Offset dataRegionAlign;
100         deque<Region *> dataRegions;
101         
102         // new code Region info
103         Offset codeRegionOffset;
104         Offset codeSize;
105         Offset codeRegionAlign;
106         deque<Region *> codeRegions;
107         
108         // new TLS Region info
109         Offset tlsRegionOffset;
110         Offset tlsSize;
111         Offset tlsRegionAlign;
112         deque<Region *> tlsRegions;
113         vector<Symbol *> tlsSymbols;
114
115         // new GOT Region info
116         Offset gotRegionOffset;
117         Offset gotSize;
118         Offset gotRegionAlign;
119         map<Symbol *, Offset> gotSymbols;
120
121         Symtab *ctorDtorHandler;
122
123         // new constructor Region info
124         Offset ctorRegionOffset;
125         Offset ctorSize;
126         Offset ctorRegionAlign;
127         Region *originalCtorRegion;
128         vector<Region *> newCtorRegions;
129
130         // new destructor Region info
131         Offset dtorRegionOffset;
132         Offset dtorSize;
133         Offset dtorRegionAlign;
134         Region *originalDtorRegion;
135         vector<Region *> newDtorRegions;
136
137         // Keep track of changes made to symbols and relocations
138         vector< pair<Symbol *, Offset> > origSymbols;
139         vector< pair<relocationEntry *, Symbol *> > origRels;
140 };
141
142 } // SymtabAPI
143 } // Dyninst
144
145 #endif