New walker to walk out of Instrimentation Frames FP
[dyninst.git] / stackwalk / src / sw.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 #ifndef SW_INTERNAL_H_
32 #define SW_INTERNAL_H_
33
34 #include <set>
35 #include "common/src/addrRange.h"
36 #include "stackwalk/h/framestepper.h"
37 #include "stackwalk/h/procstate.h"
38 #include "stackwalk/h/walker.h"
39 #include "stackwalk/h/frame.h"
40 #include "stackwalk/src/libstate.h"
41
42 namespace Dyninst {
43 namespace Stackwalker {
44
45 struct ltstepper
46 {
47    bool operator()(const FrameStepper *a, const FrameStepper *b) const
48    {
49       return a->getPriority() < b->getPriority();
50    }
51 };
52
53 typedef std::set<FrameStepper *, ltstepper> StepperSet;
54
55 class AddrRangeStepper : public addrRange
56 {
57 public:
58    Address start;
59    Address end;
60    StepperSet steppers;
61
62    AddrRangeStepper() { }
63    AddrRangeStepper(Address s, Address e) { start = s; end = e; }
64
65    virtual Address get_address() const { return start; } 
66    virtual unsigned long get_size() const { return end - start; }
67    virtual ~AddrRangeStepper() { }
68 };
69
70 class FrameFuncStepperImpl : public FrameStepper
71 {
72  private:
73    FrameStepper *parent;
74    FrameFuncHelper *helper;
75  public:
76    FrameFuncStepperImpl(Walker *w, 
77                         FrameStepper *parent_,
78                         FrameFuncHelper *helper_);
79    virtual ~FrameFuncStepperImpl();
80    virtual gcframe_ret_t getCallerFrame(const Frame &in, 
81                                         Frame &out);
82    static gcframe_ret_t getBasicCallerFrame(const Frame &in, 
83                                             Frame &out);
84    virtual unsigned getPriority() const;
85    virtual const char *getName() const;
86 };
87
88 class BottomOfStackStepperImpl : public FrameStepper {
89 private:
90    BottomOfStackStepper *parent;
91    std::vector<std::pair<Address, Address> > ra_stack_tops;
92    std::vector<std::pair<Address, Address> > sp_stack_tops;
93    bool libc_init;
94    bool aout_init;
95    bool libthread_init;
96    void initialize();
97 public:
98    BottomOfStackStepperImpl(Walker *w, BottomOfStackStepper *parent);
99    virtual gcframe_ret_t getCallerFrame(const Frame &in, Frame &out);
100    virtual unsigned getPriority() const;
101    virtual void registerStepperGroup(StepperGroup *group);
102    virtual void newLibraryNotification(LibAddrPair *la, lib_change_t change);
103    virtual ~BottomOfStackStepperImpl();
104    virtual const char *getName() const;  
105 };
106
107 class DyninstInstrStepperImpl : public FrameStepper {
108  private:
109    static std::map<SymReader *, bool> isRewritten;
110    DyninstInstrStepper *parent;
111
112  public:
113    DyninstInstrStepperImpl(Walker *w, DyninstInstrStepper *p);
114    virtual gcframe_ret_t getCallerFrame(const Frame &in, Frame &out);
115    gcframe_ret_t getCallerFrameArch(const Frame &in, Frame &out, 
116                                     Address base, Address lib_base, 
117                                     unsigned size, unsigned stack_height);
118    virtual unsigned getPriority() const;
119    virtual void registerStepperGroup(StepperGroup *group);
120    virtual const char *getName() const;
121    virtual ~DyninstInstrStepperImpl();
122 };
123
124 class DyninstDynamicStepperImpl : public FrameStepper {
125  private:
126    DyninstDynamicStepper *parent;
127    DyninstDynamicHelper *helper;
128    bool prevEntryExit; // remember if the previous frame was entry/exit instrumentation
129   
130  public:
131    DyninstDynamicStepperImpl(Walker *w, DyninstDynamicStepper *p, DyninstDynamicHelper *h);
132    virtual gcframe_ret_t getCallerFrame(const Frame &in, Frame &out);
133    gcframe_ret_t getCallerFrameArch(const Frame &in, Frame &out, 
134                                     Address base, Address lib_base, 
135                                     unsigned size, unsigned stack_height,
136                                     bool aligned,
137                                     Address orig_ra, bool pEntryExit);
138    virtual unsigned getPriority() const;
139    virtual void registerStepperGroup(StepperGroup *group);
140    virtual const char *getName() const;
141    virtual ~DyninstDynamicStepperImpl();
142 };
143
144 class DyninstInstFrameStepperImpl : public FrameStepper {
145  private:
146    DyninstInstFrameStepper *parent;
147    bool getWord(Address &words, Address start);  
148  public:
149    DyninstInstFrameStepperImpl(Walker *w, DyninstInstFrameStepper *p = NULL);
150    virtual gcframe_ret_t getCallerFrame(const Frame &in, Frame &out);
151    virtual unsigned getPriority() const;
152    virtual void registerStepperGroup(StepperGroup *group);
153    virtual const char *getName() const;
154    virtual ~DyninstInstFrameStepperImpl();
155 };
156
157
158 class CallChecker {
159   private:
160    ProcessState * proc;
161   public:
162    CallChecker(ProcessState * proc_);
163    ~CallChecker();
164    bool isPrevInstrACall(Address addr, Address & target); 
165 };
166
167 class int_walkerSet {
168    friend class Dyninst::Stackwalker::WalkerSet;
169 public:
170    int_walkerSet();
171    ~int_walkerSet();
172
173    pair<set<Walker *>::iterator, bool> insert(Walker *w);
174    void erase(set<Walker *>::iterator i);
175 private:
176    void addToProcSet(ProcDebug *);
177    void eraseFromProcSet(ProcDebug *);
178    void clearProcSet();
179    void initProcSet();
180    bool walkStacksProcSet(CallTree &tree, bool &bad_plat, bool walk_iniital_only);
181
182    unsigned non_pd_walkers;
183    set<Walker *> walkers;
184    void *procset; //Opaque pointer, will refer to a ProcControl::ProcessSet in some situations
185 };
186
187 }
188 }
189
190 #endif