Update copyright to LGPL on all files
[dyninst.git] / dyninstAPI / 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 "InstructionAdapter.h"
36 #include "Instruction.h"
37 #include "InstructionDecoder.h"
38 #include <boost/tuple/tuple.hpp>
39
40 class IA_IAPI : public InstructionAdapter
41 {
42     public:
43         IA_IAPI(Dyninst::InstructionAPI::InstructionDecoder dec_,
44                 Address start_, image_func* f);
45         IA_IAPI(Dyninst::InstructionAPI::InstructionDecoder dec_,
46                 Address start_, image * im);
47         Dyninst::InstructionAPI::Instruction::Ptr getInstruction();
48     
49         virtual bool hasCFT() const;
50         virtual size_t getSize() const;
51         virtual bool isFrameSetupInsn() const;
52         virtual bool isAbortOrInvalidInsn() const;
53         virtual bool isAllocInsn() const;
54         virtual void
55                 getNewEdges(std::vector<std::pair< Address, EdgeTypeEnum> >&
56                 outEdges, image_basicBlock* currBlk,
57                 unsigned int num_insns,
58                 dictionary_hash<Address, std::string> *pltFuncs) const;
59         virtual InstrumentableLevel getInstLevel( unsigned int num_insns ) const;
60         virtual bool isDynamicCall() const;
61         virtual bool isAbsoluteCall() const;
62         virtual bool simulateJump() const;
63         virtual void advance();
64         virtual bool isNop() const;
65         virtual bool isLeave() const;
66         virtual bool isDelaySlot() const;
67         virtual bool isRelocatable(InstrumentableLevel lvl) const;
68         virtual bool isTailCall(unsigned int) const;
69         virtual bool checkEntry() const;
70         virtual Address getCFT() const;
71         virtual bool isStackFramePreamble(int& frameSize) const;
72         virtual bool savesFP() const;
73         virtual bool cleansStack() const;
74         virtual bool isConditional() const;
75         virtual bool isBranch() const;
76         virtual bool isInterruptOrSyscall() const;
77     private:
78         virtual bool isRealCall() const;
79         bool parseJumpTable(image_basicBlock* currBlk,
80                             std::vector<std::pair< Address, EdgeTypeEnum > >& outEdges) const;
81         bool isIPRelativeBranch() const;
82         bool isMovAPSTable(std::vector<std::pair< Address, EdgeTypeEnum > >& outEdges) const;
83         std::pair<Address, Address> findThunkAndOffset(image_basicBlock* start) const;
84         bool isTableInsn(Dyninst::InstructionAPI::Instruction::Ptr i) const;
85         std::map<Address, Dyninst::InstructionAPI::Instruction::Ptr>::const_iterator findTableInsn() const;
86         boost::tuple<Dyninst::InstructionAPI::Instruction::Ptr,
87         Dyninst::InstructionAPI::Instruction::Ptr,
88         bool> findMaxSwitchInsn(image_basicBlock *start) const;
89         Address findThunkInBlock(image_basicBlock* curBlock, Address& thunkOffset) const;
90         bool computeTableBounds(Dyninst::InstructionAPI::Instruction::Ptr maxSwitchInsn,
91                                 Dyninst::InstructionAPI::Instruction::Ptr branchInsn,
92                                 Dyninst::InstructionAPI::Instruction::Ptr tableInsn,
93                                 bool foundJCCAlongTaken,
94                                 unsigned& tableSize,
95                                 unsigned& tableStride) const;
96         bool fillTableEntries(Address thunkOffset,
97                               Address tableBase,
98                               unsigned tableSize,
99                               unsigned tableStride,
100                               std::vector<std::pair< Address, EdgeTypeEnum> >& outEdges) const;
101         Address getTableAddress(Dyninst::InstructionAPI::Instruction::Ptr tableInsn,
102                                 Address thunkOffset) const;
103         bool isFrameSetupInsn(Dyninst::InstructionAPI::Instruction::Ptr i) const;
104         virtual bool isReturn() const;
105         virtual bool isCall() const;
106
107
108
109
110         Dyninst::InstructionAPI::InstructionDecoder dec;
111         std::map<Address, Dyninst::InstructionAPI::Instruction::Ptr> allInsns;
112         Dyninst::InstructionAPI::Instruction::Ptr curInsn() const;
113         std::map<Address, Dyninst::InstructionAPI::Instruction::Ptr>::const_iterator curInsnIter;
114         mutable bool validCFT;
115         mutable Address cachedCFT;
116         mutable std::pair<bool, bool> hascftstatus;
117         mutable std::pair<bool, bool> tailCall;
118 };
119
120
121 #endif // !defined(IA_IAPI_H)