Implement Stackwalker frame stepper helpers for Dyninst
[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 FrameFuncHelper::FrameFuncHelper(ProcessState *proc_) :
89    proc(proc_)
90 {
91 }
92
93 FrameFuncHelper::~FrameFuncHelper()
94 {
95 }
96
97 DyninstInstrHelper::~DyninstInstrHelper()
98 {
99 }
100
101 std::map<SymReader*, bool> DyninstInstrStepperImpl::isRewritten;
102
103 DyninstInstrStepperImpl::DyninstInstrStepperImpl(Walker *w, DyninstInstrStepper *p,
104                                                  DyninstInstrHelper *h) :
105   FrameStepper(w),
106   parent(p),
107   helper(h),
108   prevEntryExit(false)
109 {
110 }
111
112 gcframe_ret_t DyninstInstrStepperImpl::getCallerFrame(const Frame &in, Frame &out)
113 {
114    LibAddrPair lib;
115    bool result;
116    unsigned stack_height = 0;
117    Address orig_ra = 0x0;
118    bool entryExit = false;
119
120    // Handle dynamic instrumentation
121    if (helper)
122    {
123        bool instResult = helper->isInstrumentation(in.getRA(), &orig_ra, &stack_height, &entryExit);
124        bool pEntryExit = prevEntryExit;
125        
126        // remember that this frame was entry/exit instrumentation
127        prevEntryExit = entryExit;
128
129        if (pEntryExit || instResult) return getCallerFrameArch(in, out, 0, 0, 0, stack_height, orig_ra, pEntryExit);
130    }
131
132    result = getProcessState()->getLibraryTracker()->getLibraryAtAddr(in.getRA(), lib);
133    if (!result) {
134       sw_printf("[%s:%u] - Stackwalking through an invalid PC at %lx\n",
135                  __FILE__, __LINE__, in.getRA());
136       return gcf_stackbottom;
137    }
138
139    SymReader *reader = LibraryWrapper::getLibrary(lib.first);
140    if (!reader) {
141       sw_printf("[%s:%u] - Could not open file %s\n",
142                  __FILE__, __LINE__, lib.first.c_str());
143       setLastError(err_nofile, "Could not open file for Debugging stackwalker\n");
144       return gcf_error;
145    }
146
147    std::map<SymReader *, bool>::iterator i = isRewritten.find(reader);
148    bool is_rewritten_binary;
149    if (i == isRewritten.end()) {
150       Section_t sec = reader->getSectionByName(".dyninstInst");
151       is_rewritten_binary = reader->isValidSection(sec);
152       isRewritten[reader] = is_rewritten_binary;
153    }
154    else {
155      is_rewritten_binary = (*i).second;
156    }
157    if (!is_rewritten_binary) {
158      sw_printf("[%s:u] - Decided that current binary is not rewritten, "
159                "DyninstInstrStepper returning gcf_not_me at %lx\n",
160                __FILE__, __LINE__, in.getRA());
161      return gcf_not_me;
162    }
163
164    std::string name;
165    in.getName(name);
166    const char *s = name.c_str();
167    if (strstr(s, "dyninst") != s)
168    {
169      sw_printf("[%s:%u] - Current function %s not dyninst generated\n",
170                 __FILE__, __LINE__, s);
171      return gcf_not_me;
172    }
173
174    if (strstr(s, "dyninstBT") != s)
175    {
176      sw_printf("[%s:%u] - Dyninst, but don't know how to read non-tramp %s\n",
177                 __FILE__, __LINE__, s);
178      return gcf_not_me;
179    }
180     
181    sw_printf("[%s:%u] - Current function %s is baseTramp\n",
182               __FILE__, __LINE__, s);
183    Address base;
184    unsigned size;
185    int num_read = sscanf(s, "dyninstBT_%lx_%u_%x", &base, &size, &stack_height);
186    bool has_stack_frame = (num_read == 3);
187    if (!has_stack_frame) {
188      sw_printf("[%s:%u] - Don't know how to walk through instrumentation without a stack frame\n"
189                 __FILE__, __LINE__);
190      return gcf_not_me;
191    }
192      
193    return getCallerFrameArch(in, out, base, lib.second, size, stack_height);
194 }
195
196 unsigned DyninstInstrStepperImpl::getPriority() const
197 {
198   return dyninstr_priority;
199 }
200
201 void DyninstInstrStepperImpl::registerStepperGroup(StepperGroup *group)
202 {
203   unsigned addr_width = group->getWalker()->getProcessState()->getAddressWidth();
204   if (addr_width == 4)
205     group->addStepper(parent, 0, 0xffffffff);
206 #if defined(arch_64bit)
207   else if (addr_width == 8)
208     group->addStepper(parent, 0, 0xffffffffffffffff);
209 #endif
210   else
211     assert(0 && "Unknown architecture word size");
212 }
213
214 DyninstInstrStepperImpl::~DyninstInstrStepperImpl()
215 {
216 }
217
218 BottomOfStackStepperImpl::BottomOfStackStepperImpl(Walker *w, BottomOfStackStepper *p) :
219    FrameStepper(w),
220    parent(p),
221    libc_init(false),
222    aout_init(false),
223    libthread_init(false)
224 {
225    sw_printf("[%s:%u] - Constructing BottomOfStackStepperImpl at %p\n",
226              __FILE__, __LINE__, this);
227    initialize();
228 }
229
230 gcframe_ret_t BottomOfStackStepperImpl::getCallerFrame(const Frame &in, Frame & /*out*/)
231 {
232    /**
233     * This stepper never actually returns an 'out' frame.  It simply 
234     * tries to tell if we've reached the top of a stack and returns 
235     * either gcf_stackbottom or gcf_not_me.
236     **/
237    std::vector<std::pair<Address, Address> >::iterator i;
238    for (i = ra_stack_tops.begin(); i != ra_stack_tops.end(); i++)
239    {
240       if (in.getRA() >= (*i).first && in.getRA() <= (*i).second)
241          return gcf_stackbottom;
242    }
243
244    for (i = sp_stack_tops.begin(); i != sp_stack_tops.end(); i++)
245    {
246       if (in.getSP() >= (*i).first && in.getSP() < (*i).second)
247          return gcf_stackbottom;
248    }
249
250    return gcf_not_me;
251 }
252
253 unsigned BottomOfStackStepperImpl::getPriority() const
254 {
255    //Highest priority, test for top of stack first.
256    return stackbottom_priority;
257 }
258
259 void BottomOfStackStepperImpl::registerStepperGroup(StepperGroup *group)
260 {
261    unsigned addr_width = group->getWalker()->getProcessState()->getAddressWidth();
262    if (addr_width == 4)
263       group->addStepper(parent, 0, 0xffffffff);
264 #if defined(arch_64bit)
265    else if (addr_width == 8)
266       group->addStepper(parent, 0, 0xffffffffffffffff);
267 #endif
268    else
269       assert(0 && "Unknown architecture word size");
270 }
271
272 BottomOfStackStepperImpl::~BottomOfStackStepperImpl()
273 {
274 }
275
276
277 //FrameFuncStepper defined here
278 #define PIMPL_IMPL_CLASS FrameFuncStepperImpl
279 #define PIMPL_CLASS FrameFuncStepper
280 #define PIMPL_NAME "FrameFuncStepper"
281 #define PIMPL_ARG1 FrameFuncHelper*
282 #include "framestepper_pimple.h"
283 #undef PIMPL_CLASS
284 #undef PIMPL_NAME
285 #undef PIMPL_IMPL_CLASS
286 #undef PIMPL_ARG1
287
288 //DyninstInstrStepper defined here
289 #define PIMPL_IMPL_CLASS DyninstInstrStepperImpl
290 #define PIMPL_CLASS DyninstInstrStepper
291 #define PIMPL_NAME "DyninstInstrStepper"
292 #define PIMPL_ARG1 DyninstInstrHelper*
293 #include "framestepper_pimple.h"
294 #undef PIMPL_CLASS
295 #undef PIMPL_IMPL_CLASS
296 #undef PIMPL_NAME
297 #undef PIMPL_ARG1
298
299 //BottomOfStackStepper defined here
300 #if defined(os_linux) || defined(os_bg)
301 #include "stackwalk/src/linux-swk.h"
302 #define OVERLOAD_NEWLIBRARY
303 #define PIMPL_IMPL_CLASS BottomOfStackStepperImpl
304 #endif
305 #define PIMPL_CLASS BottomOfStackStepper
306 #define PIMPL_NAME "BottomOfStackStepper"
307 #include "framestepper_pimple.h"
308 #undef PIMPL_CLASS
309 #undef PIMPL_IMPL_CLASS
310 #undef PIMPL_NAME
311 #undef OVERLOAD_NEWLIBRARY
312
313 //DebugStepper defined here
314 #if defined(os_linux) && (defined(arch_x86) || defined(arch_x86_64))
315 #include "stackwalk/src/dbgstepper-impl.h"
316 #define PIMPL_IMPL_CLASS DebugStepperImpl
317 #endif
318 #define PIMPL_CLASS DebugStepper
319 #define PIMPL_NAME "DebugStepper"
320 #include "framestepper_pimple.h"
321 #undef PIMPL_CLASS
322 #undef PIMPL_IMPL_CLASS
323 #undef PIMPL_NAME
324
325 //StepperWanderer defined here
326 #if defined(arch_x86) || defined(arch_x86_64)
327 #include "stackwalk/src/x86-swk.h"
328 #define PIMPL_IMPL_CLASS StepperWandererImpl
329 #endif
330 #define PIMPL_CLASS StepperWanderer
331 #define PIMPL_NAME "StepperWanderer"
332 #define PIMPL_ARG1 WandererHelper*
333 #define PIMPL_ARG2 FrameFuncHelper*
334 #include "framestepper_pimple.h"
335 #undef PIMPL_CLASS
336 #undef PIMPL_IMPL_CLASS
337 #undef PIMPL_NAME
338 #undef PIMPL_ARG1
339 #undef PIMPL_ARG2
340
341 //SigHandlerStepper defined here
342 #define OVERLOAD_NEWLIBRARY
343 #if defined(os_linux)
344 #include "stackwalk/src/linux-swk.h"
345 #define PIMPL_IMPL_CLASS SigHandlerStepperImpl
346 #endif
347 #define PIMPL_CLASS SigHandlerStepper
348 #define PIMPL_NAME "SigHandlerStepper"
349 #include "framestepper_pimple.h"
350 #undef PIMPL_CLASS
351 #undef PIMPL_IMPL_CLASS
352 #undef PIMPL_NAME
353 #undef OVERLOAD_NEWLIBRARY
354
355 //AnalysisStepper defined here
356 #if defined(arch_x86) || defined(arch_x86_64)
357 #include "stackwalk/src/analysis_stepper.h"
358 #define PIMPL_IMPL_CLASS AnalysisStepperImpl
359 #endif
360 #define PIMPL_CLASS AnalysisStepper
361 #define PIMPL_NAME "AnalysisStepper"
362 #include "framestepper_pimple.h"
363 #undef PIMPL_CLASS
364 #undef PIMPL_IMPL_CLASS
365 #undef PIMPL_NAME