Initial gcc5 support (force old ABI for compatiblity with existing libelf/libdwarf...
[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 //FrameFuncStepper defined here
325 #define PIMPL_IMPL_CLASS FrameFuncStepperImpl
326 #define PIMPL_CLASS FrameFuncStepper
327 #define PIMPL_NAME "FrameFuncStepper"
328 #define PIMPL_ARG1 FrameFuncHelper*
329 #include "framestepper_pimple.h"
330 #undef PIMPL_CLASS
331 #undef PIMPL_NAME
332 #undef PIMPL_IMPL_CLASS
333 #undef PIMPL_ARG1
334
335 //DyninstInstrStepper defined here
336 #define PIMPL_IMPL_CLASS DyninstInstrStepperImpl
337 #define PIMPL_CLASS DyninstInstrStepper
338 #define PIMPL_NAME "DyninstInstrStepper"
339 #include "framestepper_pimple.h"
340 #undef PIMPL_CLASS
341 #undef PIMPL_IMPL_CLASS
342 #undef PIMPL_NAME
343
344 //BottomOfStackStepper defined here
345 #if defined(os_linux) || defined(os_bg) || defined(os_freebsd) || defined(os_windows)
346 #define OVERLOAD_NEWLIBRARY
347 #define PIMPL_IMPL_CLASS BottomOfStackStepperImpl
348 #endif
349 #define PIMPL_CLASS BottomOfStackStepper
350 #define PIMPL_NAME "BottomOfStackStepper"
351 #include "framestepper_pimple.h"
352 #undef PIMPL_CLASS
353 #undef PIMPL_IMPL_CLASS
354 #undef PIMPL_NAME
355 #undef OVERLOAD_NEWLIBRARY
356
357 //DebugStepper defined here
358 //#if (defined(os_linux) || defined(os_freebsd)) && (defined(arch_x86) || defined(arch_x86_64))
359 #if (defined(os_linux) || defined(os_freebsd)) && (defined(arch_x86) || defined(arch_x86_64) || defined(arch_aarch64) )
360 #include "stackwalk/src/dbgstepper-impl.h"
361 #define PIMPL_IMPL_CLASS DebugStepperImpl
362 #endif
363 #define PIMPL_CLASS DebugStepper
364 #define PIMPL_NAME "DebugStepper"
365 #include "framestepper_pimple.h"
366 #undef PIMPL_CLASS
367 #undef PIMPL_IMPL_CLASS
368 #undef PIMPL_NAME
369
370 //StepperWanderer defined here
371 #if defined(arch_x86) || defined(arch_x86_64)
372 #include "stackwalk/src/x86-swk.h"
373 #define PIMPL_IMPL_CLASS StepperWandererImpl
374 #endif
375 #define PIMPL_CLASS StepperWanderer
376 #define PIMPL_NAME "StepperWanderer"
377 #define PIMPL_ARG1 WandererHelper*
378 #define PIMPL_ARG2 FrameFuncHelper*
379 #include "framestepper_pimple.h"
380 #undef PIMPL_CLASS
381 #undef PIMPL_IMPL_CLASS
382 #undef PIMPL_NAME
383 #undef PIMPL_ARG1
384 #undef PIMPL_ARG2
385
386 //SigHandlerStepper defined here
387 #define OVERLOAD_NEWLIBRARY
388 #if defined(os_linux) || defined(os_freebsd) || defined(os_bgq)
389 #include "stackwalk/src/linuxbsd-swk.h"
390 #define PIMPL_IMPL_CLASS SigHandlerStepperImpl
391 #endif
392 #define PIMPL_CLASS SigHandlerStepper
393 #define PIMPL_NAME "SigHandlerStepper"
394 #include "framestepper_pimple.h"
395 #undef PIMPL_CLASS
396 #undef PIMPL_IMPL_CLASS
397 #undef PIMPL_NAME
398 #undef OVERLOAD_NEWLIBRARY
399
400 //AnalysisStepper defined here
401 #ifdef USE_PARSE_API
402 #include "stackwalk/src/analysis_stepper.h"
403 #define PIMPL_IMPL_CLASS AnalysisStepperImpl
404 #endif
405 #define PIMPL_CLASS AnalysisStepper
406 #define PIMPL_NAME "AnalysisStepper"
407 #include "framestepper_pimple.h"
408 #undef PIMPL_CLASS
409 #undef PIMPL_IMPL_CLASS
410 #undef PIMPL_NAME
411
412
413 //DyninstDynamicStepper defined here
414 #define PIMPL_IMPL_CLASS DyninstDynamicStepperImpl
415 #define PIMPL_CLASS DyninstDynamicStepper
416 #define PIMPL_NAME "DyninstDynamicStepper"
417 #define PIMPL_ARG1 DyninstDynamicHelper*
418 #include "framestepper_pimple.h"
419 #undef PIMPL_CLASS
420 #undef PIMPL_IMPL_CLASS
421 #undef PIMPL_NAME
422 #undef PIMPL_ARG1
423