remove unnecessary assertion for unknown phdr_type (#757)
[dyninst.git] / symtabAPI / h / Aggregate.h
1 /*
2  * See the dyninst/COPYRIGHT file for copyright information.
3  * 
4  * We provide the Paradyn Tools (below described as "Paradyn")
5  * on an AS IS basis, and do not warrant its validity or performance.
6  * We reserve the right to update, modify, or discontinue this
7  * software at any time.  We shall have no obligation to supply such
8  * updates or modifications or any other form of support to you.
9  * 
10  * By your use of Paradyn, you understand and agree that we (or any
11  * other person or entity with proprietary rights in Paradyn) are
12  * under no obligation to provide either maintenance services,
13  * update services, notices of latent defects, or correction of
14  * defects for Paradyn.
15  * 
16  * This library is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  * 
21  * This library is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  * 
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with this library; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29  */
30
31 /************************************************************************
32  * $Id: Symbol.h,v 1.20 2008/11/03 15:19:24 jaw Exp $
33
34 ************************************************************************/
35
36 // Present a common superclass for all Symbol aggregates. 
37 // We never create an Aggregate directly, but only via a child class.
38
39 #if !defined(_Aggregate_h_)
40 #define _Aggregate_h_
41
42 #include <iostream>
43 #include "Annotatable.h"
44 #include <boost/iterator/transform_iterator.hpp>
45 #include <functional>
46 #include "concurrent.h"
47 SYMTAB_EXPORT std::ostream &operator<<(std::ostream &os, const Dyninst::SymtabAPI::Aggregate &);
48
49 namespace Dyninst{
50 namespace SymtabAPI{
51
52 class Symbol;
53 class Module;
54 class Symtab; 
55 class Region; 
56 class Aggregate; 
57 class DwarfWalker;
58
59 struct SymbolCompareByAddr;
60
61 class SYMTAB_EXPORT Aggregate
62 {
63    friend class Symtab;
64    friend struct SymbolCompareByAddr;
65         friend std::ostream &::operator<<(std::ostream &os, const Dyninst::SymtabAPI::Aggregate &);
66    friend class DwarfWalker;
67   protected:
68       Aggregate();
69       Aggregate(Symbol *sym);
70       Aggregate(Module *m);      
71   public:
72
73       
74       virtual ~Aggregate() {};
75
76       virtual Offset   getOffset() const;
77       virtual unsigned getSize() const;
78       Module * getModule() const { return module_; }
79       Region * getRegion() const;
80
81       /***** Symbol Collection Management *****/
82       bool addSymbol(Symbol *sym);
83       virtual bool removeSymbol(Symbol *sym) = 0;
84       bool getSymbols(std::vector<Symbol *> &syms) const;
85       Symbol *getFirstSymbol() const;
86
87       /***** Symbol naming *****/
88       //std::vector<std::string> getAllMangledNames();
89       //std::vector<std::string> getAllPrettyNames();
90       //std::vector<std::string> getAllTypedNames();
91       typedef boost::transform_iterator<std::const_mem_fun_t<std::string, Symbol>, std::vector<Symbol*>::const_iterator> name_iter;
92       name_iter mangled_names_begin() const;
93       name_iter mangled_names_end() const;
94       name_iter pretty_names_begin() const;
95       name_iter pretty_names_end() const;
96       name_iter typed_names_begin() const;
97       name_iter typed_names_end() const;
98       
99      /***** Aggregate updating *****/
100       virtual bool addMangledName(std::string name, bool isPrimary, bool isDebug=false);
101       virtual bool addPrettyName(std::string name, bool isPrimary, bool isDebug=false);
102       virtual bool addTypedName(std::string name, bool isPrimary, bool isDebug=false);
103
104       bool setModule(Module *mod);
105       bool setSize(unsigned size);
106       bool setOffset(unsigned offset);
107       
108           bool operator==(const Aggregate &a);
109
110
111    protected:
112       bool removeSymbolInt(Symbol *sym);
113       virtual bool changeSymbolOffset(Symbol *sym);
114
115       // Offset comes from a symbol
116       // Module we keep here so we can have the correct "primary"
117       // (AKA 'not DEFAULT_MODULE') module
118       Module *module_;
119
120       mutable dyn_mutex lock_;
121       std::vector<Symbol *> symbols_;
122       Symbol *firstSymbol;  // cached for speed
123       Offset offset_;       // cached for speed
124
125
126       void restore_type_by_id(SerializerBase *, Type *&, unsigned) THROW_SPEC (SerializerError);
127       void restore_module_by_name(SerializerBase *, std::string &) THROW_SPEC (SerializerError);
128       //void rebuild_symbol_vector(SerializerBase *, std::vector<Offset> *) THROW_SPEC (SerializerError);
129       void rebuild_symbol_vector(SerializerBase *, std::vector<Address> &) THROW_SPEC (SerializerError);
130       void serialize_aggregate(SerializerBase *, const char * = "Aggregate") THROW_SPEC (SerializerError);
131       bool addMangledNameInternal(std::string name, bool isPrimary, bool demangle);
132 };
133
134 }
135 }
136
137 #endif