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