Fix #23, build failure on PPC64le
[dyninst.git] / dyninstAPI / src / Parsing.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 #ifndef _PARSING_H_
31 #define _PARSING_H_
32
33 #include "parseAPI/h/CFGFactory.h"
34 #include "parseAPI/h/CodeSource.h"
35 #include "parseAPI/h/InstructionSource.h"
36 #include "parseAPI/h/CFG.h"
37 #include "parseAPI/h/ParseCallback.h"
38
39 // some useful types
40 using ParseAPI::EdgeTypeEnum;
41 using ParseAPI::FuncReturnStatus;
42 using ParseAPI::FuncSource;
43
44 /*** The image_* object factory ***/
45 class image;
46
47 namespace Dyninst {
48 namespace ParseAPI {
49    class CodeObject;
50 };
51 };
52
53 class DynCFGFactory : public Dyninst::ParseAPI::CFGFactory {
54   public:
55     DynCFGFactory(image * im);
56     ~DynCFGFactory() {};
57     
58     ParseAPI::Function * mkfunc(Address addr, FuncSource src, std::string name,
59             ParseAPI::CodeObject * obj, ParseAPI::CodeRegion * reg,
60             InstructionSource * isrc);
61     ParseAPI::Block * mkblock(ParseAPI::Function * f, ParseAPI::CodeRegion * r,
62             Address addr);
63     ParseAPI::Edge * mkedge(ParseAPI::Block * src, ParseAPI::Block * trg, 
64             EdgeTypeEnum type);
65
66     ParseAPI::Block * mksink(ParseAPI::CodeObject *obj, ParseAPI::CodeRegion*r);
67
68     // leaving default atm    
69     //void free_func(ParseAPI::Function * f);
70     //void free_block(ParseAPI::Block * b);
71     //void free_edge(ParseAPI::Edge * e);
72
73     //void free_all();
74     void dump_stats();
75
76   private:
77     image * _img;     
78     std::vector<int> _func_allocs;
79     std::vector<int> _edge_allocs;
80     int _block_allocs;
81     int _sink_block_allocs;
82     //int _sink_edge_allocs; FIXME can't determine
83
84     void _record_func_alloc(ParseAPI::FuncSource fs)
85     {
86         assert(fs < ParseAPI::_funcsource_end_);
87         ++_func_allocs[fs];
88     }
89     void _record_edge_alloc(ParseAPI::EdgeTypeEnum et,bool /* sink */)
90     {
91         assert(et < ParseAPI::_edgetype_end_);
92         ++_edge_allocs[et];
93
94         //if(sink)
95             //++_sink_block_allocs;
96     }
97     void _record_block_alloc(bool sink)
98     {
99         ++_block_allocs;
100         if(sink)
101             ++_sink_block_allocs;
102     }
103 };
104
105 class image;
106 class DynParseCallback : public ParseAPI::ParseCallback {
107  public:
108   DynParseCallback(image * img) : ParseAPI::ParseCallback(), _img(img) { }
109   ~DynParseCallback() { }
110
111   protected:
112   // defensive and exploratory mode callbacks
113   virtual void abruptEnd_cf(Address,ParseAPI::Block *,default_details*);
114   virtual void newfunction_retstatus(ParseAPI::Function*);
115   virtual void patch_nop_jump(Address);
116   virtual bool hasWeirdInsns(const ParseAPI::Function*) const;
117   virtual void foundWeirdInsns(ParseAPI::Function*);
118
119   // other callbacks
120   virtual void interproc_cf(ParseAPI::Function*,ParseAPI::Block*,Address,interproc_details*);
121   virtual void overlapping_blocks(ParseAPI::Block*,ParseAPI::Block*);
122   virtual bool updateCodeBytes(Address target); // updates if needed
123   virtual void split_block_cb(ParseAPI::Block *, ParseAPI::Block *); // needed for defensive mode
124
125   virtual void destroy_cb(ParseAPI::Block *);
126   virtual void destroy_cb(ParseAPI::Edge *);
127   virtual void destroy_cb(ParseAPI::Function *);
128
129   virtual void remove_edge_cb(ParseAPI::Block *, ParseAPI::Edge *, edge_type_t);
130   virtual void remove_block_cb(ParseAPI::Function *, ParseAPI::Block *);
131
132 #if defined(arch_power)
133   void instruction_cb(ParseAPI::Function*, ParseAPI::Block *, Address, insn_details*);
134 #endif
135  private:
136     image * _img;
137 };
138
139
140 #endif