Fix corruption bug copying IA_IAPI instruction adapters
[dyninst.git] / parseAPI / src / IA_IAPI.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(IA_IAPI_H)
33 #define IA_IAPI_H
34
35 #include <boost/tuple/tuple.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 {
50     friend class image_func;
51     friend class IA_platformDetails;
52     friend class IA_x86Details;
53     friend class IA_powerDetails;
54     public:
55         IA_IAPI(Dyninst::InstructionAPI::InstructionDecoder dec_,
56                 Address start_, 
57                 Dyninst::ParseAPI::CodeObject* o,
58                 Dyninst::ParseAPI::CodeRegion* r,
59                 Dyninst::InstructionSource *isrc,
60                 Dyninst::ParseAPI::Block * curBlk_);
61                 // Declarations that are purposefully not defined - DO NOT 
62                 // COPY THESE OBJECTS!
63                 IA_IAPI(const IA_IAPI &); 
64                 IA_IAPI &operator=(const IA_IAPI &);
65                 // End DO NOT COPY THESE OBJECTS
66                 virtual ~IA_IAPI() {
67         }
68         Dyninst::InstructionAPI::Instruction::Ptr getInstruction();
69     
70         virtual bool hasCFT() const;
71         virtual size_t getSize() const;
72         virtual bool isFrameSetupInsn() const;
73         virtual bool isAbortOrInvalidInsn() const;
74         virtual void
75                 getNewEdges(std::vector<std::pair< Address, 
76                                 Dyninst::ParseAPI::EdgeTypeEnum> >&outEdges, 
77                 Dyninst::ParseAPI::Function * context,
78                 Dyninst::ParseAPI::Block * currBlk,
79                 unsigned int num_insns,
80                 dyn_hash_map<Address, std::string> *pltFuncs) const;
81         virtual InstrumentableLevel getInstLevel(Dyninst::ParseAPI::Function *, unsigned int num_insns ) const;
82         virtual bool isDynamicCall() const;
83         virtual bool isAbsoluteCall() const;
84         virtual bool simulateJump() const;
85         virtual void advance();
86         virtual void retreat();
87         virtual bool isNop() const;
88         virtual bool isLeave() const;
89         virtual bool isDelaySlot() const;
90         virtual bool isRelocatable(InstrumentableLevel lvl) const;
91         virtual bool isTailCall(Dyninst::ParseAPI::Function *,unsigned int) const;
92         virtual Address getCFT() const;
93         virtual bool isStackFramePreamble() const;
94         virtual bool savesFP() const;
95         virtual bool cleansStack() const;
96         virtual bool isConditional() const;
97         virtual bool isBranch() const;
98         virtual bool isInterruptOrSyscall() const;
99         virtual bool isSyscall() const;
100         virtual bool isInterrupt() const;
101         virtual bool isCall() const;
102         virtual bool isReturnAddrSave(Address &) const;
103         virtual bool sliceReturn(ParseAPI::Block* bit, Address ret_addr, ParseAPI::Function * func) const;
104         virtual ParseAPI::StackTamper tampersStack(ParseAPI::Function *func, Address &retAddr) const;
105 private:
106         virtual bool isRealCall() const;
107         virtual bool isThunk() const;
108         bool parseJumpTable(Dyninst::ParseAPI::Block* currBlk,
109              std::vector<std::pair< Address, Dyninst::ParseAPI::EdgeTypeEnum > >& outEdges) const;
110         bool isIPRelativeBranch() const;
111         bool isFrameSetupInsn(Dyninst::InstructionAPI::Instruction::Ptr i) const;
112         virtual bool isReturn(Dyninst::ParseAPI::Function *, Dyninst::ParseAPI::Block* currBlk) const;
113         bool isFakeCall() const;
114         bool isIATcall() const;
115         bool isLinkerStub() const;
116
117
118         Dyninst::InstructionAPI::InstructionDecoder dec;
119         std::map<Address, Dyninst::InstructionAPI::Instruction::Ptr> allInsns;
120         Dyninst::InstructionAPI::Instruction::Ptr curInsn() const;
121         std::map<Address, Dyninst::InstructionAPI::Instruction::Ptr>::iterator curInsnIter;
122         mutable bool validCFT;
123         mutable Address cachedCFT;
124         mutable bool validLinkerStubState;
125         mutable bool cachedLinkerStubState;
126         mutable std::pair<bool, bool> hascftstatus;
127         mutable std::pair<bool, bool> tailCall;
128         static std::map<Architecture, Dyninst::InstructionAPI::RegisterAST::Ptr> framePtr;
129         static std::map<Architecture, Dyninst::InstructionAPI::RegisterAST::Ptr> stackPtr;
130         static std::map<Architecture, Dyninst::InstructionAPI::RegisterAST::Ptr> thePC;
131         static std::map<Address, bool> thunkAtTarget;
132         static void initASTs();
133 };
134
135 }
136 }
137
138
139 #endif // !defined(IA_IAPI_H)