Commiting Aishwarya's work in allowing StackwalkerAPI users to change the system...
[dyninst.git] / stackwalk / h / framestepper.h
1 /*
2  * Copyright (c) 1996-2011 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 #ifndef FRAMESTEPPER_H_
33 #define FRAMESTEPPER_H_
34
35 #include "basetypes.h"
36 #include "procstate.h"
37 #include <vector>
38
39 namespace Dyninst {
40
41 namespace SymtabAPI {
42    class Symtab;
43 }
44
45 namespace Stackwalker {
46
47 class Walker;
48 class Frame;
49 class ProcessState;
50 class StepperGroup;
51
52 typedef enum { gcf_success, gcf_stackbottom, gcf_not_me, gcf_error } gcframe_ret_t;
53
54 class FrameStepper {
55 protected:
56   Walker *walker;
57 public:
58   FrameStepper(Walker *w);
59   
60   virtual gcframe_ret_t getCallerFrame(const Frame &in, Frame &out) = 0;
61   virtual unsigned getPriority() const = 0;  
62
63   virtual ProcessState *getProcessState();
64   virtual Walker *getWalker();
65   
66   virtual void newLibraryNotification(LibAddrPair *libaddr, 
67                                       lib_change_t change);
68   virtual void registerStepperGroup(StepperGroup *group);
69   virtual const char *getName() const = 0;
70   
71   virtual ~FrameStepper();
72
73   //Default priorities for built in wanderers.
74   static const unsigned stackbottom_priority = 0x10000;
75   static const unsigned dyninstr_priority = 0x10010;
76   static const unsigned sighandler_priority = 0x10020;
77   static const unsigned debugstepper_priority = 0x10030;
78   static const unsigned frame_priority = 0x10040;
79   static const unsigned wanderer_priority = 0x10050;
80 };
81
82 class FrameFuncHelper
83 {
84  protected:
85    ProcessState *proc;
86  public:
87    typedef enum {
88       unknown_t=0,
89       no_frame,
90       standard_frame,
91       savefp_only_frame,
92    } frame_type;
93    typedef enum {
94       unknown_s=0,
95       unset_frame,
96       halfset_frame,
97       set_frame
98    } frame_state;
99    typedef std::pair<frame_type, frame_state> alloc_frame_t;
100    FrameFuncHelper(ProcessState *proc_);
101    virtual alloc_frame_t allocatesFrame(Address addr) = 0;
102    virtual ~FrameFuncHelper();
103 };
104
105 class FrameFuncStepperImpl;
106 class FrameFuncStepper : public FrameStepper {
107 private:
108    FrameFuncStepperImpl *impl;
109 public:
110   FrameFuncStepper(Walker *w, FrameFuncHelper *helper = NULL);
111   virtual gcframe_ret_t getCallerFrame(const Frame &in, Frame &out);
112   virtual unsigned getPriority() const;
113   virtual ~FrameFuncStepper();
114   virtual void registerStepperGroup(StepperGroup *group);
115   virtual const char *getName() const;
116 };
117
118 class DebugStepperImpl;
119 class DebugStepper : public FrameStepper {
120 private:
121    DebugStepperImpl *impl;
122 public:
123   DebugStepper(Walker *w);
124   virtual gcframe_ret_t getCallerFrame(const Frame &in, Frame &out);
125   virtual unsigned getPriority() const;
126   virtual void registerStepperGroup(StepperGroup *group);
127   virtual ~DebugStepper();  
128   virtual const char *getName() const;
129 };
130
131 class WandererHelper
132 {
133  private:
134    ProcessState *proc;
135  public:
136    WandererHelper(ProcessState *proc_);
137    virtual bool isPrevInstrACall(Address addr, Address &target);
138    virtual bool isPCInFunc(Address func_entry, Address pc);
139    virtual ~WandererHelper();
140 };
141
142 class StepperWandererImpl;
143 class StepperWanderer : public FrameStepper {
144  private:
145    StepperWandererImpl *impl;
146  public:
147    StepperWanderer(Walker *w, WandererHelper *whelper = NULL, 
148                    FrameFuncHelper *fhelper = NULL);
149    virtual gcframe_ret_t getCallerFrame(const Frame &in, Frame &out);
150    virtual unsigned getPriority() const;
151    virtual void registerStepperGroup(StepperGroup *group);
152    virtual ~StepperWanderer();
153    virtual const char *getName() const;
154 };
155
156 class SigHandlerStepperImpl;
157 class SigHandlerStepper : public FrameStepper {
158  private:
159    SigHandlerStepperImpl *impl;
160  public:
161    SigHandlerStepper(Walker *w);
162    virtual gcframe_ret_t getCallerFrame(const Frame &in, Frame &out);
163    virtual unsigned getPriority() const;
164    virtual void newLibraryNotification(LibAddrPair *la, lib_change_t change);
165    virtual void registerStepperGroup(StepperGroup *group);
166    virtual ~SigHandlerStepper();  
167    virtual const char *getName() const;
168 };
169
170 class BottomOfStackStepperImpl;
171 class BottomOfStackStepper : public FrameStepper {
172  private:
173    BottomOfStackStepperImpl *impl;
174  public:
175    BottomOfStackStepper(Walker *w);
176    virtual gcframe_ret_t getCallerFrame(const Frame &in, Frame &out);
177    virtual unsigned getPriority() const;
178    virtual void newLibraryNotification(LibAddrPair *la, lib_change_t change);
179    virtual void registerStepperGroup(StepperGroup *group);
180    virtual ~BottomOfStackStepper();
181    virtual const char *getName() const;
182 };
183
184 class DyninstInstrStepperImpl;
185 class DyninstInstrStepper : public FrameStepper {
186  private:
187    DyninstInstrStepperImpl *impl;
188  public:
189    DyninstInstrStepper(Walker *w);
190    virtual gcframe_ret_t getCallerFrame(const Frame &in, Frame &out);
191    virtual unsigned getPriority() const;
192    virtual void registerStepperGroup(StepperGroup *group);
193    virtual ~DyninstInstrStepper();
194    virtual const char *getName() const;
195 };
196
197 }
198 }
199
200 #endif