Fix our tailcall parsing; we've observed conditional tailcalls in the wild and weren...
[dyninst.git] / parseAPI / src / IA_IAPI.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 #if !defined(IA_IAPI_H)
32 #define IA_IAPI_H
33
34 #include <boost/tuple/tuple.hpp>
35 #include <boost/static_assert.hpp>
36
37 #include "InstructionAdapter.h"
38 #include "InstructionDecoder.h"
39 #include "Instruction.h"
40
41 #include "dyntypes.h"
42
43 #include "CFG.h"
44
45 namespace Dyninst {
46 namespace InsnAdapter {
47
48 class IA_IAPI : public InstructionAdapter {
49     friend class image_func;
50     friend class IA_platformDetails;
51     friend class IA_x86Details;
52     friend class IA_powerDetails;
53     public:
54         IA_IAPI(Dyninst::InstructionAPI::InstructionDecoder dec_,
55                 Address start_, 
56                 Dyninst::ParseAPI::CodeObject* o,
57                 Dyninst::ParseAPI::CodeRegion* r,
58                 Dyninst::InstructionSource *isrc,
59                 Dyninst::ParseAPI::Block * curBlk_);
60                 // We have a iterator, and so can't use the implicit copiers
61                 IA_IAPI(const IA_IAPI &); 
62                 IA_IAPI &operator=(const IA_IAPI &r);
63
64                 virtual ~IA_IAPI() {
65         }
66         void reset(Dyninst::InstructionAPI::InstructionDecoder dec_,
67           Address start, ParseAPI::CodeObject *o,
68           ParseAPI::CodeRegion *r, InstructionSource *isrc, ParseAPI::Block *);
69
70         virtual Dyninst::InstructionAPI::Instruction::Ptr getInstruction() const;
71     
72         virtual bool hasCFT() const;
73         virtual size_t getSize() const;
74         virtual bool isFrameSetupInsn() const;
75         virtual bool isAbort() const;
76         virtual bool isInvalidInsn() const;
77         virtual bool isGarbageInsn() const; //true for insns indicative of bad parse, for defensive mode
78         virtual void
79                 getNewEdges(std::vector<std::pair< Address, 
80                                 Dyninst::ParseAPI::EdgeTypeEnum> >&outEdges, 
81                 Dyninst::ParseAPI::Function * context,
82                 Dyninst::ParseAPI::Block * currBlk,
83                 unsigned int num_insns,
84                 dyn_hash_map<Address, std::string> *pltFuncs) const;
85         virtual InstrumentableLevel getInstLevel(Dyninst::ParseAPI::Function *, unsigned int num_insns ) const;
86         virtual bool isDynamicCall() const;
87         virtual bool isAbsoluteCall() const;
88         virtual bool simulateJump() const;
89         virtual void advance();
90         virtual bool retreat();
91         virtual bool isNop() const;
92         virtual bool isLeave() const;
93         virtual bool isDelaySlot() const;
94         virtual bool isRelocatable(InstrumentableLevel lvl) const;
95         virtual bool isTailCall(Dyninst::ParseAPI::Function *, Dyninst::ParseAPI::EdgeTypeEnum, unsigned int) const;
96         virtual std::pair<bool, Address> getCFT() const;
97         virtual bool isStackFramePreamble() const;
98         virtual bool savesFP() const;
99         virtual bool cleansStack() const;
100         virtual bool isConditional() const;
101         virtual bool isBranch() const;
102         virtual bool isInterruptOrSyscall() const;
103         virtual bool isSyscall() const;
104         virtual bool isInterrupt() const;
105         virtual bool isCall() const;
106         virtual bool isReturnAddrSave(Address &ret_addr) const;
107         virtual bool isNopJump() const;
108         virtual bool sliceReturn(ParseAPI::Block* bit, Address ret_addr, ParseAPI::Function * func) const;
109         bool isIATcall(std::string &calleeName) const;
110 private:
111         virtual bool isRealCall() const;
112         virtual bool isThunk() const;
113         bool parseJumpTable(Dyninst::ParseAPI::Block* currBlk,
114              std::vector<std::pair< Address, Dyninst::ParseAPI::EdgeTypeEnum > >& outEdges) const;
115         bool isIPRelativeBranch() const;
116         bool isFrameSetupInsn(Dyninst::InstructionAPI::Instruction::Ptr i) const;
117         virtual bool isReturn(Dyninst::ParseAPI::Function *, Dyninst::ParseAPI::Block* currBlk) const;
118         bool isFakeCall() const;
119         bool isLinkerStub() const;
120         bool isSysEnter() const;
121         void parseSysEnter(std::vector<std::pair<Address, Dyninst::ParseAPI::EdgeTypeEnum> >& outEdges) const;
122         std::pair<bool, Address> getFallthrough() const;
123
124         Dyninst::InstructionAPI::InstructionDecoder dec;
125
126         /*
127          * Decoded instruction cache: contains the linear
128          * sequence of instructions decoded by the decoder
129          * underlying this adapter.
130          * 
131          * - curInsnIter == *(allInsns.end()-1)
132          * - (super)->current = curInsnIter->first
133          */
134 public:
135         typedef std::vector< 
136             std::pair<Address, 
137             Dyninst::InstructionAPI::Instruction::Ptr> 
138         > allInsns_t;
139 private:
140         allInsns_t allInsns;
141         Dyninst::InstructionAPI::Instruction::Ptr curInsn() const;
142         allInsns_t::iterator curInsnIter;
143
144         mutable bool validCFT;
145         mutable std::pair<bool, Address> cachedCFT;
146         mutable bool validLinkerStubState;
147         mutable bool cachedLinkerStubState;
148         mutable std::pair<bool, bool> hascftstatus;
149
150         mutable std::map<ParseAPI::EdgeTypeEnum, bool> tailCalls;
151
152         static std::map<Architecture, Dyninst::InstructionAPI::RegisterAST::Ptr> framePtr;
153         static std::map<Architecture, Dyninst::InstructionAPI::RegisterAST::Ptr> stackPtr;
154         static std::map<Architecture, Dyninst::InstructionAPI::RegisterAST::Ptr> thePC;
155         static std::map<Address, bool> thunkAtTarget;
156         static void initASTs();
157 };
158
159 }
160 }
161
162
163 #endif // !defined(IA_IAPI_H)