Support for StackwalkerAPI on AIX
[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
89 FrameFuncHelper::FrameFuncHelper(ProcessState *proc_) :
90    proc(proc_)
91 {
92 }
93
94 FrameFuncHelper::~FrameFuncHelper()
95 {
96 }
97
98 BottomOfStackStepperImpl::BottomOfStackStepperImpl(Walker *w, BottomOfStackStepper *p) :
99    FrameStepper(w),
100    parent(p),
101    initialized(false)
102 {
103    sw_printf("[%s:%u] - Constructing BottomOfStackStepperImpl at %p\n",
104              __FILE__, __LINE__, this);
105 }
106
107 gcframe_ret_t BottomOfStackStepperImpl::getCallerFrame(const Frame &in, Frame & /*out*/)
108 {
109    /**
110     * This stepper never actually returns an 'out' frame.  It simply 
111     * tries to tell if we've reached the top of a stack and returns 
112     * either gcf_stackbottom or gcf_not_me.
113     **/
114    if (!initialized)
115       initialize();
116
117    std::vector<std::pair<Address, Address> >::iterator i;
118    for (i = ra_stack_tops.begin(); i != ra_stack_tops.end(); i++)
119    {
120       if (in.getRA() >= (*i).first && in.getRA() <= (*i).second)
121          return gcf_stackbottom;
122    }
123
124    for (i = sp_stack_tops.begin(); i != sp_stack_tops.end(); i++)
125    {
126       if (in.getSP() >= (*i).first && in.getSP() < (*i).second)
127          return gcf_stackbottom;
128    }
129
130    return gcf_not_me;
131 }
132
133 unsigned BottomOfStackStepperImpl::getPriority() const
134 {
135    //Highest priority, test for top of stack first.
136    return stackbottom_priority;
137 }
138
139 void BottomOfStackStepperImpl::registerStepperGroup(StepperGroup *group)
140 {
141    unsigned addr_width = group->getWalker()->getProcessState()->getAddressWidth();
142    if (addr_width == 4)
143       group->addStepper(parent, 0, 0xffffffff);
144 #if defined(arch_64bit)
145    else if (addr_width == 8)
146       group->addStepper(parent, 0, 0xffffffffffffffff);
147 #endif
148    else
149       assert(0 && "Unknown architecture word size");
150 }
151
152 BottomOfStackStepperImpl::~BottomOfStackStepperImpl()
153 {
154 }
155
156
157 //FrameFuncStepper defined here
158 #define PIMPL_IMPL_CLASS FrameFuncStepperImpl
159 #define PIMPL_CLASS FrameFuncStepper
160 #define PIMPL_NAME "FrameFuncStepper"
161 #define PIMPL_ARG1 FrameFuncHelper*
162 #include "framestepper_pimple.h"
163 #undef PIMPL_CLASS
164 #undef PIMPL_NAME
165 #undef PIMPL_IMPL_CLASS
166 #undef PIMPL_ARG1
167
168 //DyninstInstrStepper defined here
169 #if defined(cap_stackwalker_use_symtab) && (defined(arch_x86) || defined(arch_x86_64))
170 #include "stackwalk/src/symtab-swk.h"
171 #define PIMPL_IMPL_CLASS DyninstInstrStepperImpl
172 #endif
173 #define PIMPL_CLASS DyninstInstrStepper
174 #define PIMPL_NAME "DyninstInstrStepper"
175 #include "framestepper_pimple.h"
176 #undef PIMPL_CLASS
177 #undef PIMPL_IMPL_CLASS
178 #undef PIMPL_NAME
179
180 //BottomOfStackStepper defined here
181 #if defined(cap_stackwalker_use_symtab) && defined(os_linux)
182 #include "stackwalk/src/linux-swk.h"
183 #define PIMPL_IMPL_CLASS BottomOfStackStepperImpl
184 #endif
185 #define PIMPL_CLASS BottomOfStackStepper
186 #define PIMPL_NAME "BottomOfStackStepper"
187 #include "framestepper_pimple.h"
188 #undef PIMPL_CLASS
189 #undef PIMPL_IMPL_CLASS
190 #undef PIMPL_NAME
191
192 //DebugStepper defined here
193 #if defined(os_linux) && (defined(arch_x86) || defined(arch_x86_64)) && defined(cap_stackwalker_use_symtab)
194 #include "stackwalk/src/dbgstepper-impl.h"
195 #define PIMPL_IMPL_CLASS DebugStepperImpl
196 #endif
197 #define PIMPL_CLASS DebugStepper
198 #define PIMPL_NAME "DebugStepper"
199 #include "framestepper_pimple.h"
200 #undef PIMPL_CLASS
201 #undef PIMPL_IMPL_CLASS
202 #undef PIMPL_NAME
203
204 //StepperWanderer defined here
205 #if defined(arch_x86) || defined(arch_x86_64)
206 #include "stackwalk/src/x86-swk.h"
207 #define PIMPL_IMPL_CLASS StepperWandererImpl
208 #endif
209 #define PIMPL_CLASS StepperWanderer
210 #define PIMPL_NAME "StepperWanderer"
211 #define PIMPL_ARG1 WandererHelper*
212 #define PIMPL_ARG2 FrameFuncHelper*
213 #include "framestepper_pimple.h"
214 #undef PIMPL_CLASS
215 #undef PIMPL_IMPL_CLASS
216 #undef PIMPL_NAME
217 #undef PIMPL_ARG1
218 #undef PIMPL_ARG2
219
220 //SigHandlerStepper defined here
221 #if defined(os_linux)
222 #include "stackwalk/src/linux-swk.h"
223 #define PIMPL_IMPL_CLASS SigHandlerStepperImpl
224 #endif
225 #define PIMPL_CLASS SigHandlerStepper
226 #define PIMPL_NAME "SigHandlerStepper"
227 #include "framestepper_pimple.h"
228 #undef PIMPL_CLASS
229 #undef PIMPL_IMPL_CLASS
230 #undef PIMPL_NAME