Merge branch 'master' into NewInstpoint
[dyninst.git] / parseAPI / h / InstructionAdapter.h
1 /*
2  * Copyright (c) 1996-2009 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(INSTRUCTION_ADAPTER_H)
33 #define INSTRUCTION_ADAPTER_H
34
35 #include "dynutil/h/dyntypes.h"
36
37 #include "parseAPI/h/CodeObject.h"
38 #include "parseAPI/h/CFG.h"
39
40 #if !defined(ESSENTIAL_PARSING_ENUMS)
41 #define ESSENTIAL_PARSING_ENUMS
42 // There are three levels of function-level "instrumentability":
43 // 1) The function can be instrumented normally with no problems (normal case)
44 // 2) The function contains unresolved indirect branches; we have to assume
45 //    these can go anywhere in the function to be safe, so we must instrument
46 //    safely (e.g., with traps)
47 // 3) The function is flatly uninstrumentable and must not be touched.
48 enum InstrumentableLevel {
49     NORMAL,
50     HAS_BR_INDIR,
51     UNINSTRUMENTABLE
52 };
53 #endif //!defined(ESSENTIAL_PARSING_ENUMS)
54
55 namespace Dyninst {
56 namespace InsnAdapter {
57
58 class InstructionAdapter
59 {
60     public:
61         InstructionAdapter(Address start, ParseAPI::CodeObject *o , 
62             ParseAPI::CodeRegion* r, InstructionSource * isrc,  ParseAPI::Block *);
63         virtual ~InstructionAdapter();
64
65     // Reset to just-constructed state
66     void reset(Address start, ParseAPI::CodeObject *o,
67         ParseAPI::CodeRegion *r, InstructionSource *isrc, ParseAPI::Block *);
68
69     // Implemented
70     virtual bool hasCFT() const = 0;
71     virtual size_t getSize() const = 0;
72     virtual bool isFrameSetupInsn() const = 0;
73     virtual bool isAbortOrInvalidInsn() const = 0;
74     virtual bool isGarbageInsn() const = 0; //true for insns indicative of bad parse, for defensive mode
75     virtual void
76             getNewEdges(std::vector<std::pair<Address,ParseAPI::EdgeTypeEnum> >&
77             outEdges, 
78             ParseAPI::Function* context,
79             ParseAPI::Block* currBlk,
80             unsigned int num_insns,
81             dyn_hash_map<Address, std::string> *pltFuncs) const =
82 0;
83     virtual bool isDynamicCall() const = 0;
84     virtual bool isAbsoluteCall() const = 0;
85     virtual InstrumentableLevel getInstLevel(ParseAPI::Function* context, unsigned int num_insns) const;
86     virtual ParseAPI::FuncReturnStatus getReturnStatus(ParseAPI::Function* context, unsigned int num_insns) const ;
87     virtual bool hasUnresolvedControlFlow(ParseAPI::Function* context, unsigned int num_insns)
88 const;
89     virtual bool isNopJump() const { return false; }
90     virtual bool simulateJump() const= 0;
91     virtual void advance() = 0;
92     virtual bool retreat() = 0;
93     virtual bool isNop() const = 0;
94     virtual bool isLeave() const = 0;
95     virtual bool isDelaySlot() const = 0;
96     virtual bool isRelocatable(InstrumentableLevel lvl) const = 0;
97     virtual Address getAddr() const;
98     virtual Address getPrevAddr() const;
99     virtual Address getNextAddr() const;
100     virtual std::pair<bool, Address>  getCFT() const = 0;
101     virtual bool isStackFramePreamble() const = 0;
102     virtual bool savesFP() const = 0;
103     virtual bool cleansStack() const = 0;
104     virtual bool isConditional() const = 0;
105     virtual bool isBranch() const = 0;
106     virtual bool isInterruptOrSyscall() const = 0;
107     virtual bool isCall() const = 0;
108     virtual bool isReturnAddrSave(Address &ret_addr) const = 0; // ret_addr holds the return address pushed in the stack using mflr at function entry 
109     virtual bool isTailCall(ParseAPI::Function *,unsigned int num_insns) const = 0;
110     protected:
111         // Uses pattern heuristics or backward slicing to determine if a blr instruction is a return or jump table
112         virtual bool isReturn(Dyninst::ParseAPI::Function * context, Dyninst::ParseAPI::Block* currBlk) const = 0;
113         virtual bool isRealCall() const = 0;
114         Address current;
115     Address previous;
116     mutable bool parsedJumpTable;
117     mutable bool successfullyParsedJumpTable;
118     mutable bool isDynamicCall_;
119     mutable bool checkedDynamicCall_;
120     mutable bool isInvalidCallTarget_;
121     mutable bool checkedInvalidCallTarget_;
122     ParseAPI::CodeObject * _obj;
123     ParseAPI::CodeRegion * _cr;
124     InstructionSource * _isrc;
125     // Block associated with the instruction adapter. This is required for powerpc slicing to determine the return address of a function
126     ParseAPI::Block * _curBlk;
127 };
128
129 } // Dyninst
130 } // InsnAdapter
131
132 #endif // !defined(INSTRUCTION_ADAPTER_H)