windows build fixes and some more work on symtab serialization
[dyninst.git] / symtabAPI / h / Collections.h
1 /*
2  * Copyright (c) 1996-2007 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 #ifndef _Collections_h_
33 #define _Collections_h_
34
35 #include "Type.h"
36 #include "Variable.h"
37
38 using namespace std;
39 namespace Dyninst {
40
41 namespace SymtabAPI {
42
43 class Module;
44 class Symtab;
45 class localVar;
46
47 /*
48  * This class contains a collection of local variables.
49  * Each function will have one of these objects associated with it.
50  * This object will store all the local variables within this function.
51  * Note: This class is unaware of scope.
52  */
53 class localVarCollection : public Serializable, public AnnotatableSparse {
54   
55   dyn_hash_map<std::string, localVar *> localVariablesByName;
56   vector<localVar *> localVars;
57
58 public:
59   SYMTAB_EXPORT localVarCollection(){}
60   SYMTAB_EXPORT ~localVarCollection();
61
62   SYMTAB_EXPORT void addLocalVar(localVar * var);
63   SYMTAB_EXPORT localVar * findLocalVar(std::string &name);
64   SYMTAB_EXPORT vector<localVar *> *getAllVars();  
65
66   SYMTAB_EXPORT void serialize(SerializerBase *, const char * = "localVarCollection") THROW_SPEC (SerializerError);
67 };
68   
69
70
71 /*
72  * Due to DWARF weirdness, this can be shared between multiple BPatch_modules.
73  * So we reference-count to make life easier.
74  */
75 class typeCollection : public Serializable, public AnnotatableSparse {
76     friend class Symtab;
77     friend class Object;
78     friend class Module;
79     friend class SymtabTranslatorBase;
80     friend class SymtabTranslatorBin;
81
82     dyn_hash_map<std::string, Type *> typesByName;
83     dyn_hash_map<std::string, Type *> globalVarsByName;
84     dyn_hash_map<int, Type *> typesByID;
85
86     SYMTAB_EXPORT ~typeCollection();
87
88     unsigned refcount;
89     SYMTAB_EXPORT typeCollection();
90
91     // DWARF:
92     /* Cache type collections on a per-image basis.  (Since
93        BPatch_functions are solitons, we don't have to cache them.) */
94     static dyn_hash_map< std::string, typeCollection * > fileToTypesMap;
95
96     // DWARF...
97     bool dwarfParsed_;
98
99 public:
100     SYMTAB_EXPORT void serialize(SerializerBase *, const char * = "typeCollection") THROW_SPEC (SerializerError);
101     SYMTAB_EXPORT static typeCollection *getGlobalTypeCollection();
102     SYMTAB_EXPORT static typeCollection *getModTypeCollection(Module *mod);
103     SYMTAB_EXPORT static void freeTypeCollection(typeCollection *tc);
104
105     // DWARF...
106     SYMTAB_EXPORT bool dwarfParsed() { return dwarfParsed_; }
107     SYMTAB_EXPORT void setDwarfParsed() { dwarfParsed_ = true; }
108
109     SYMTAB_EXPORT Type  *findType(std::string name);
110     SYMTAB_EXPORT Type  *findType(const int ID);
111     SYMTAB_EXPORT Type  *findTypeLocal(std::string name);
112     SYMTAB_EXPORT Type  *findTypeLocal(const int ID);
113     SYMTAB_EXPORT void  addType(Type *type);
114     SYMTAB_EXPORT void        addGlobalVariable(std::string &name, Type *type);
115
116     /* Some debug formats allow forward references.  Rather than
117        fill in forward in a second pass, generate placeholder
118        types, and fill them in as we go.  Because we require
119        One True Pointer for each type (in parseStab.C), when
120        updating a type, return that One True Pointer. */
121     SYMTAB_EXPORT Type * findOrCreateType( const int ID );
122     template<class T>
123     SYMTAB_EXPORT T* addOrUpdateType(T* type);
124
125     SYMTAB_EXPORT Type *findVariableType(std::string &name);
126
127     SYMTAB_EXPORT std::vector<Type *> *getAllTypes();
128     SYMTAB_EXPORT std::vector<std::pair<std::string, Type *> > *getAllGlobalVariables();
129     SYMTAB_EXPORT void clearNumberedTypes();
130 };
131
132 /*
133  * This class defines the collection for the built-in Types
134  * gnu ( and AIX??) use negative numbers to define other types
135  * in terms of these built-in types.
136  * This collection is global and built in the BPatch_image constructor.
137  * This means that only one collection of built-in types is made
138  * per image.  jdd 4/21/99
139  *
140  */
141
142 class SYMTAB_EXPORT builtInTypeCollection {
143    
144     dyn_hash_map<std::string, Type *> builtInTypesByName;
145     dyn_hash_map<int, Type *> builtInTypesByID;
146 public:
147
148     builtInTypeCollection();
149     ~builtInTypeCollection();
150
151     Type        *findBuiltInType(std::string &name);
152     Type        *findBuiltInType(const int ID);
153     void        addBuiltInType(Type *type);
154     std::vector<Type *> *getAllBuiltInTypes();
155    
156 };
157
158 }// namespace SymtabAPI
159 }// namespace Dyninst
160
161 #endif /* _Collections_h_ */
162
163
164