Fixes for StackwalkerAPI
[dyninst.git] / stackwalk / src / framestepper.C
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 #include "stackwalk/h/framestepper.h"
33 #include "stackwalk/h/walker.h"
34 #include "stackwalk/h/procstate.h"
35 #include "stackwalk/h/swk_errors.h"
36 #include "stackwalk/h/steppergroup.h"
37 #include "stackwalk/h/frame.h"
38
39 #include "stackwalk/src/sw.h"
40
41 #include <assert.h>
42
43 using namespace Dyninst;
44 using namespace Dyninst::Stackwalker;
45
46 FrameStepper::FrameStepper(Walker *w) :
47   walker(w)
48 {
49   sw_printf("[%s:%u] - Creating FrameStepper %p with walker %p\n", 
50             __FILE__, __LINE__, this, walker);
51   assert(walker);
52 }
53
54 FrameStepper::~FrameStepper() 
55 {
56   walker = NULL;
57   sw_printf("[%s:%u] - Deleting FrameStepper %p\n", __FILE__, __LINE__, this);
58 }
59
60 Walker *FrameStepper::getWalker()
61 {
62   assert(walker);
63   return walker;
64 }
65
66 ProcessState *FrameStepper::getProcessState() 
67 {
68   return getWalker()->getProcessState();
69 }
70
71 void FrameStepper::newLibraryNotification(LibAddrPair *, lib_change_t)
72 {
73 }
74
75 void FrameStepper::registerStepperGroup(StepperGroup *group)
76 {
77    unsigned addr_width = group->getWalker()->getProcessState()->getAddressWidth();
78    if (addr_width == 4)
79       group->addStepper(this, 0, 0xffffffff);
80 #if defined(arch_64bit)
81    else if (addr_width == 8)
82       group->addStepper(this, 0, 0xffffffffffffffff);
83 #endif
84    else
85       assert(0 && "Unknown architecture word size");
86 }
87
88 const char *FrameStepper::getName() const
89 {
90    return "<UNKNOWN>";
91 }
92
93 FrameFuncHelper::FrameFuncHelper(ProcessState *proc_) :
94    proc(proc_)
95 {
96 }
97
98 FrameFuncHelper::~FrameFuncHelper()
99 {
100 }
101
102 BottomOfStackStepperImpl::BottomOfStackStepperImpl(Walker *w, BottomOfStackStepper *p) :
103    FrameStepper(w),
104    parent(p),
105    libc_init(false),
106    aout_init(false),
107    libthread_init(false)
108 {
109    sw_printf("[%s:%u] - Constructing BottomOfStackStepperImpl at %p\n",
110              __FILE__, __LINE__, this);
111 }
112
113 gcframe_ret_t BottomOfStackStepperImpl::getCallerFrame(const Frame &in, Frame & /*out*/)
114 {
115    /**
116     * This stepper never actually returns an 'out' frame.  It simply 
117     * tries to tell if we've reached the top of a stack and returns 
118     * either gcf_stackbottom or gcf_not_me.
119     **/
120    std::vector<std::pair<Address, Address> >::iterator i;
121    for (i = ra_stack_tops.begin(); i != ra_stack_tops.end(); i++)
122    {
123       if (in.getRA() >= (*i).first && in.getRA() <= (*i).second)
124          return gcf_stackbottom;
125    }
126
127    for (i = sp_stack_tops.begin(); i != sp_stack_tops.end(); i++)
128    {
129       if (in.getSP() >= (*i).first && in.getSP() < (*i).second)
130          return gcf_stackbottom;
131    }
132
133    return gcf_not_me;
134 }
135
136 unsigned BottomOfStackStepperImpl::getPriority() const
137 {
138    //Highest priority, test for top of stack first.
139    return stackbottom_priority;
140 }
141
142 void BottomOfStackStepperImpl::registerStepperGroup(StepperGroup *group)
143 {
144    unsigned addr_width = group->getWalker()->getProcessState()->getAddressWidth();
145    if (addr_width == 4)
146       group->addStepper(parent, 0, 0xffffffff);
147 #if defined(arch_64bit)
148    else if (addr_width == 8)
149       group->addStepper(parent, 0, 0xffffffffffffffff);
150 #endif
151    else
152       assert(0 && "Unknown architecture word size");
153 }
154
155 BottomOfStackStepperImpl::~BottomOfStackStepperImpl()
156 {
157 }
158
159
160 //FrameFuncStepper defined here
161 #define PIMPL_IMPL_CLASS FrameFuncStepperImpl
162 #define PIMPL_CLASS FrameFuncStepper
163 #define PIMPL_NAME "FrameFuncStepper"
164 #define PIMPL_ARG1 FrameFuncHelper*
165 #include "framestepper_pimple.h"
166 #undef PIMPL_CLASS
167 #undef PIMPL_NAME
168 #undef PIMPL_IMPL_CLASS
169 #undef PIMPL_ARG1
170
171 //DyninstInstrStepper defined here
172 #if defined(cap_stackwalker_use_symtab) && (defined(arch_x86) || defined(arch_x86_64))
173 #include "stackwalk/src/symtab-swk.h"
174 #define PIMPL_IMPL_CLASS DyninstInstrStepperImpl
175 #endif
176 #define PIMPL_CLASS DyninstInstrStepper
177 #define PIMPL_NAME "DyninstInstrStepper"
178 #include "framestepper_pimple.h"
179 #undef PIMPL_CLASS
180 #undef PIMPL_IMPL_CLASS
181 #undef PIMPL_NAME
182
183 //BottomOfStackStepper defined here
184 #define OVERLOAD_NEWLIBRARY
185 #if defined(cap_stackwalker_use_symtab) && defined(os_linux)
186 #include "stackwalk/src/linux-swk.h"
187 #define PIMPL_IMPL_CLASS BottomOfStackStepperImpl
188 #endif
189 #define PIMPL_CLASS BottomOfStackStepper
190 #define PIMPL_NAME "BottomOfStackStepper"
191 #include "framestepper_pimple.h"
192 #undef PIMPL_CLASS
193 #undef PIMPL_IMPL_CLASS
194 #undef PIMPL_NAME
195 #undef OVERLOAD_NEWLIBRARY
196
197 //DebugStepper defined here
198 #if defined(os_linux) && (defined(arch_x86) || defined(arch_x86_64)) && defined(cap_stackwalker_use_symtab)
199 #include "stackwalk/src/dbgstepper-impl.h"
200 #define PIMPL_IMPL_CLASS DebugStepperImpl
201 #endif
202 #define PIMPL_CLASS DebugStepper
203 #define PIMPL_NAME "DebugStepper"
204 #include "framestepper_pimple.h"
205 #undef PIMPL_CLASS
206 #undef PIMPL_IMPL_CLASS
207 #undef PIMPL_NAME
208
209 //StepperWanderer defined here
210 #if defined(arch_x86) || defined(arch_x86_64)
211 #include "stackwalk/src/x86-swk.h"
212 #define PIMPL_IMPL_CLASS StepperWandererImpl
213 #endif
214 #define PIMPL_CLASS StepperWanderer
215 #define PIMPL_NAME "StepperWanderer"
216 #define PIMPL_ARG1 WandererHelper*
217 #define PIMPL_ARG2 FrameFuncHelper*
218 #include "framestepper_pimple.h"
219 #undef PIMPL_CLASS
220 #undef PIMPL_IMPL_CLASS
221 #undef PIMPL_NAME
222 #undef PIMPL_ARG1
223 #undef PIMPL_ARG2
224
225 //SigHandlerStepper defined here
226 #define OVERLOAD_NEWLIBRARY
227 #if defined(os_linux)
228 #include "stackwalk/src/linux-swk.h"
229 #define PIMPL_IMPL_CLASS SigHandlerStepperImpl
230 #endif
231 #define PIMPL_CLASS SigHandlerStepper
232 #define PIMPL_NAME "SigHandlerStepper"
233 #include "framestepper_pimple.h"
234 #undef PIMPL_CLASS
235 #undef PIMPL_IMPL_CLASS
236 #undef PIMPL_NAME
237 #undef OVERLOAD_NEWLIBRARY