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