New walker to walk out of Instrimentation Frames FP
[dyninst.git] / stackwalk / src / framestepper.C
1 /*
2  * See the dyninst/COPYRIGHT file for copyright information.
3  *
4  * We provide the Paradyn Tools (below described as "Paradyn")
5  * on an AS IS basis, and do not warrant its validity or performance.
6  * We reserve the right to update, modify, or discontinue this
7  * software at any time.  We shall have no obligation to supply such
8  * updates or modifications or any other form of support to you.
9  *
10  * By your use of Paradyn, you understand and agree that we (or any
11  * other person or entity with proprietary rights in Paradyn) are
12  * under no obligation to provide either maintenance services,
13  * update services, notices of latent defects, or correction of
14  * defects for Paradyn.
15  *
16  * This library is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  *
21  * This library is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  *
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with this library; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29  */
30
31 #include "stackwalk/h/framestepper.h"
32 #include "stackwalk/h/walker.h"
33 #include "stackwalk/h/procstate.h"
34 #include "stackwalk/h/swk_errors.h"
35 #include "stackwalk/h/steppergroup.h"
36 #include "stackwalk/h/frame.h"
37
38 #include "stackwalk/src/sw.h"
39
40 #include <assert.h>
41
42 using namespace Dyninst;
43 using namespace Dyninst::Stackwalker;
44
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_error;
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 BottomOfStackStepperImpl::BottomOfStackStepperImpl(Walker *w, BottomOfStackStepper *p) :
197    FrameStepper(w),
198    parent(p),
199    libc_init(false),
200    aout_init(false),
201    libthread_init(false)
202 {
203    sw_printf("[%s:%u] - Constructing BottomOfStackStepperImpl at %p\n",
204              FILE__, __LINE__, this);
205    initialize();
206 }
207
208 gcframe_ret_t BottomOfStackStepperImpl::getCallerFrame(const Frame &in, Frame & /*out*/)
209 {
210    /**
211     * This stepper never actually returns an 'out' frame.  It simply
212     * tries to tell if we've reached the top of a stack and returns
213     * either gcf_stackbottom or gcf_not_me.
214     **/
215    std::vector<std::pair<Address, Address> >::iterator i;
216    for (i = ra_stack_tops.begin(); i != ra_stack_tops.end(); i++)
217    {
218       if (in.getRA() >= (*i).first && in.getRA() <= (*i).second)
219          return gcf_stackbottom;
220    }
221
222    for (i = sp_stack_tops.begin(); i != sp_stack_tops.end(); i++)
223    {
224       if (in.getSP() >= (*i).first && in.getSP() < (*i).second)
225          return gcf_stackbottom;
226    }
227    // So we would really like to do error checking here
228    // but we can't. Specifically, the (generic) bottom of stack
229    // stepper has no idea that instrumentation may have been overlaid
230    // on the regular address space, because it knows nothing of instrumentation
231    // at all.
232    // Which, in turn, means that we delegate down to every other stepper
233    // the responsibility to check for whether an RA is out of bounds
234    // and error out accordingly--any one of them might be first
235    // in a custom stepper group.
236    // This is sub-optimal.
237
238    return gcf_not_me;
239 }
240
241 unsigned BottomOfStackStepperImpl::getPriority() const
242 {
243    //Highest priority, test for top of stack first.
244    return stackbottom_priority;
245 }
246
247 void BottomOfStackStepperImpl::registerStepperGroup(StepperGroup *group)
248 {
249    unsigned addr_width = group->getWalker()->getProcessState()->getAddressWidth();
250    if (addr_width == 4)
251       group->addStepper(parent, 0, 0xffffffff);
252 #if defined(arch_64bit)
253    else if (addr_width == 8)
254       group->addStepper(parent, 0, 0xffffffffffffffff);
255 #endif
256    else
257       assert(0 && "Unknown architecture word size");
258 }
259
260 BottomOfStackStepperImpl::~BottomOfStackStepperImpl()
261 {
262 }
263
264 DyninstDynamicHelper::~DyninstDynamicHelper()
265 {
266 }
267
268 DyninstDynamicStepperImpl::DyninstDynamicStepperImpl(Walker *w, DyninstDynamicStepper *p,
269                                                      DyninstDynamicHelper *h) :
270   FrameStepper(w),
271   parent(p),
272   helper(h),
273   prevEntryExit(false)
274 {
275 }
276
277 gcframe_ret_t DyninstDynamicStepperImpl::getCallerFrame(const Frame &in, Frame &out)
278 {
279    unsigned stack_height = 0;
280    Address orig_ra = 0x0;
281    bool entryExit = false;
282    bool aligned = false;
283
284    // Handle dynamic instrumentation
285    if (helper)
286    {
287       bool instResult = helper->isInstrumentation(in.getRA(), &orig_ra, &stack_height, &aligned, &entryExit);
288       bool pEntryExit = prevEntryExit;
289
290       // remember that this frame was entry/exit instrumentation
291       prevEntryExit = entryExit;
292
293       if (pEntryExit || instResult) {
294          out.setNonCall();
295          return getCallerFrameArch(in, out, 0, 0, 0, stack_height, aligned, orig_ra, pEntryExit);
296       }
297    }
298
299    return gcf_not_me;
300 }
301
302 unsigned DyninstDynamicStepperImpl::getPriority() const
303 {
304   return dyninstr_priority;
305 }
306
307 void DyninstDynamicStepperImpl::registerStepperGroup(StepperGroup *group)
308 {
309   unsigned addr_width = group->getWalker()->getProcessState()->getAddressWidth();
310   if (addr_width == 4)
311     group->addStepper(parent, 0, 0xffffffff);
312 #if defined(arch_64bit)
313   else if (addr_width == 8)
314     group->addStepper(parent, 0, 0xffffffffffffffff);
315 #endif
316   else
317     assert(0 && "Unknown architecture word size");
318 }
319
320 DyninstDynamicStepperImpl::~DyninstDynamicStepperImpl()
321 {
322 }
323
324 DyninstInstFrameStepperImpl::DyninstInstFrameStepperImpl(Walker *w, DyninstInstFrameStepper *p) :
325   FrameStepper(w),
326   parent(p)
327 {
328 }
329
330 gcframe_ret_t DyninstInstFrameStepperImpl::getCallerFrame(const Frame &in, Frame &out)
331 {
332     // Magic word inserted into the stack by dyninst instrimentation frame creation.
333     // If the magic word is present at in.getFP()[1], accept this frame
334     uint64_t magicWord = 0xBEEFDEAD;
335
336     Address ret;
337     Address framePtr = in.getFP();
338     Address stackPtr = in.getSP();
339     uint64_t diff = uint64_t(framePtr) - uint64_t(stackPtr);
340
341     // Get the address width for the architecture
342     const unsigned addr_width = getProcessState()->getAddressWidth();
343
344     // Check if the FP is close to the SP. If it is not, the FP is likely invalid and this
345     // isn't an instrimentation frame. This check is required to prevent a deref of an invalid FP. 
346     if ( diff >= (addr_width * 500) ) {
347       sw_printf("[%s:%u] - I am Rejecting frame because (FP - stackPtr) > 500 stack positions - FP: %lx , SP: %lx, DIFF: %llu, Check: %u\n",
348           FILE__, __LINE__, framePtr, stackPtr, diff,  (addr_width * 500));          
349       return gcf_not_me;
350     }
351
352     sw_printf("[%s:%u] - %lx reading from memory at location %lx with framePtr %lx\n",
353         FILE__, __LINE__, ret, framePtr + addr_width);    
354
355     // Read the location in the stack where the Special Value should be.
356     // This value was inserted into the stack at inst frame creation. 
357     if (getWord(ret, framePtr + addr_width)) {    
358         // check the return 
359         sw_printf("[%s:%u] - %lx read from memory at location %lx\n",
360             FILE__, __LINE__, ret, framePtr + addr_width);
361         // Check if that value is equal to the magic word, if its not we are not in 
362         // an instrimentation frame
363         if ((uint64_t)ret == magicWord) {
364             // Accept the frame
365             Address sp, ra, fp;
366             // Read SP and FP for the next frame.
367             if (!getWord(fp, framePtr) || !getWord(sp, framePtr + (addr_width * 2))){
368                 sw_printf("[%s:%u] - unable to read SP or FP from frame\n",
369                     FILE__, __LINE__);           
370                 return gcf_not_me;
371             }
372             // Get the return address by reading the SP.
373             if (!getWord(ra, sp)) {
374                 sw_printf("[%s:%u] - unable to read return address from %lx\n",
375                     FILE__, __LINE__, sp);           
376                 return gcf_not_me;
377             }
378             // Offset sp by addr_width to account for where the frame truely ends
379             // without this, debugsteppers will not function on the out frame.
380             sp = sp + addr_width;
381             out.setRA(ra);
382             out.setFP(fp);
383             out.setSP(sp);
384             sw_printf("[%s:%u] - Accepted frame, output new frame with SP: %lx\n",
385                     FILE__, __LINE__, sp);           
386             return gcf_success;
387         }
388     } 
389     return gcf_not_me;
390 }
391
392 bool DyninstInstFrameStepperImpl::getWord(Address &word_out, Address start)
393 {
394    const unsigned addr_width = getProcessState()->getAddressWidth();
395    if (start < 1024) {
396       sw_printf("[%s:%u] - %lx too low to be valid memory\n",
397                 FILE__, __LINE__, start);
398       return false;
399    }
400    word_out = 0x0;
401    bool result = getProcessState()->readMem(&word_out, start, addr_width);
402    if (!result) {
403       sw_printf("[%s:%u] - DyninstInstFrameStepperImpl couldn't read from stack at 0x%lx\n",
404                 FILE__, __LINE__, start);
405       return false;
406    }
407
408    return true;
409 }
410
411 unsigned DyninstInstFrameStepperImpl::getPriority() const
412 {
413   return dyninstr_priority;
414 }
415
416 void DyninstInstFrameStepperImpl::registerStepperGroup(StepperGroup *group)
417 {
418   unsigned addr_width = group->getWalker()->getProcessState()->getAddressWidth();
419   if (addr_width == 4)
420     group->addStepper(parent, 0, 0xffffffff);
421 #if defined(arch_64bit)
422   else if (addr_width == 8)
423     group->addStepper(parent, 0, 0xffffffffffffffff);
424 #endif
425   else
426     assert(0 && "Unknown architecture word size");
427 }
428
429 DyninstInstFrameStepperImpl::~DyninstInstFrameStepperImpl()
430 {
431 }
432
433
434 //FrameFuncStepper defined here
435 #define PIMPL_IMPL_CLASS FrameFuncStepperImpl
436 #define PIMPL_CLASS FrameFuncStepper
437 #define PIMPL_NAME "FrameFuncStepper"
438 #define PIMPL_ARG1 FrameFuncHelper*
439 #include "framestepper_pimple.h"
440 #undef PIMPL_CLASS
441 #undef PIMPL_NAME
442 #undef PIMPL_IMPL_CLASS
443 #undef PIMPL_ARG1
444
445 //DyninstInstrStepper defined here
446 #define PIMPL_IMPL_CLASS DyninstInstrStepperImpl
447 #define PIMPL_CLASS DyninstInstrStepper
448 #define PIMPL_NAME "DyninstInstrStepper"
449 #include "framestepper_pimple.h"
450 #undef PIMPL_CLASS
451 #undef PIMPL_IMPL_CLASS
452 #undef PIMPL_NAME
453
454 //BottomOfStackStepper defined here
455 #if defined(os_linux) || defined(os_bg) || defined(os_freebsd) || defined(os_windows)
456 #define OVERLOAD_NEWLIBRARY
457 #define PIMPL_IMPL_CLASS BottomOfStackStepperImpl
458 #endif
459 #define PIMPL_CLASS BottomOfStackStepper
460 #define PIMPL_NAME "BottomOfStackStepper"
461 #include "framestepper_pimple.h"
462 #undef PIMPL_CLASS
463 #undef PIMPL_IMPL_CLASS
464 #undef PIMPL_NAME
465 #undef OVERLOAD_NEWLIBRARY
466
467 //DebugStepper defined here
468 //#if (defined(os_linux) || defined(os_freebsd)) && (defined(arch_x86) || defined(arch_x86_64))
469 #if (defined(os_linux) || defined(os_freebsd)) && (defined(arch_x86) || defined(arch_x86_64) || defined(arch_aarch64) )
470 #include "stackwalk/src/dbgstepper-impl.h"
471 #define PIMPL_IMPL_CLASS DebugStepperImpl
472 #endif
473 #define PIMPL_CLASS DebugStepper
474 #define PIMPL_NAME "DebugStepper"
475 #include "framestepper_pimple.h"
476 #undef PIMPL_CLASS
477 #undef PIMPL_IMPL_CLASS
478 #undef PIMPL_NAME
479
480 //StepperWanderer defined here
481 #if defined(arch_x86) || defined(arch_x86_64)
482 #include "stackwalk/src/x86-swk.h"
483 #define PIMPL_IMPL_CLASS StepperWandererImpl
484 #endif
485 #define PIMPL_CLASS StepperWanderer
486 #define PIMPL_NAME "StepperWanderer"
487 #define PIMPL_ARG1 WandererHelper*
488 #define PIMPL_ARG2 FrameFuncHelper*
489 #include "framestepper_pimple.h"
490 #undef PIMPL_CLASS
491 #undef PIMPL_IMPL_CLASS
492 #undef PIMPL_NAME
493 #undef PIMPL_ARG1
494 #undef PIMPL_ARG2
495
496 //SigHandlerStepper defined here
497 #define OVERLOAD_NEWLIBRARY
498 #if defined(os_linux) || defined(os_freebsd) || defined(os_bgq)
499 #include "stackwalk/src/linuxbsd-swk.h"
500 #define PIMPL_IMPL_CLASS SigHandlerStepperImpl
501 #endif
502 #define PIMPL_CLASS SigHandlerStepper
503 #define PIMPL_NAME "SigHandlerStepper"
504 #include "framestepper_pimple.h"
505 #undef PIMPL_CLASS
506 #undef PIMPL_IMPL_CLASS
507 #undef PIMPL_NAME
508 #undef OVERLOAD_NEWLIBRARY
509
510 //AnalysisStepper defined here
511 #ifdef USE_PARSE_API
512 #include "stackwalk/src/analysis_stepper.h"
513 #define PIMPL_IMPL_CLASS AnalysisStepperImpl
514 #endif
515 #define PIMPL_CLASS AnalysisStepper
516 #define PIMPL_NAME "AnalysisStepper"
517 #include "framestepper_pimple.h"
518 #undef PIMPL_CLASS
519 #undef PIMPL_IMPL_CLASS
520 #undef PIMPL_NAME
521
522
523 //DyninstDynamicStepper defined here
524 #define PIMPL_IMPL_CLASS DyninstDynamicStepperImpl
525 #define PIMPL_CLASS DyninstDynamicStepper
526 #define PIMPL_NAME "DyninstDynamicStepper"
527 #define PIMPL_ARG1 DyninstDynamicHelper*
528 #include "framestepper_pimple.h"
529 #undef PIMPL_CLASS
530 #undef PIMPL_IMPL_CLASS
531 #undef PIMPL_NAME
532 #undef PIMPL_ARG1
533
534 //DyninstInstFrameStepper defined here
535 #define PIMPL_IMPL_CLASS DyninstInstFrameStepperImpl
536 #define PIMPL_CLASS DyninstInstFrameStepper
537 #define PIMPL_NAME "DyninstInstFrameStepper"
538 #include "framestepper_pimple.h"
539 #undef PIMPL_CLASS
540 #undef PIMPL_IMPL_CLASS
541 #undef PIMPL_NAME