Convert Dyninst to use StackwalkerAPI
[dyninst.git] / stackwalk / h / walker.h
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 #ifndef WALKER_H_
33 #define WALKER_H_
34
35 #include "basetypes.h"
36 #include "Process.h"
37 #include <vector>
38 #include <list>
39
40 #define SW_MAJOR 2
41 #define SW_MINOR 1
42 #define SW_BETA  0
43
44 namespace Dyninst {
45 namespace Stackwalker {
46
47 class ProcessState;
48 class ProcDebug; 
49 class SymbolLookup;
50 class Frame;
51 class FrameStepper;
52 class StepperGroup;
53
54 class Walker {
55  private:
56    //Object creation functions
57    Walker(ProcessState *p,
58           StepperGroup *grp,
59           SymbolLookup *sym, 
60           bool default_steppers,
61           std::string exec_name);
62    SymbolLookup *createDefaultSymLookup(std::string exec_name);
63    StepperGroup *createDefaultStepperGroup();
64    static ProcessState *createDefaultProcess(std::string exec_name = std::string(""));
65    static ProcessState *createDefaultProcess(Dyninst::PID pid, std::string exe);
66    static ProcessState *createDefaultProcess(Dyninst::ProcControlAPI::Process::ptr proc);
67    static bool createDefaultProcess(const std::vector<Dyninst::PID> &pids,
68                                     std::vector<ProcDebug *> &pds);
69    static ProcessState *createDefaultProcess(std::string exec_name, 
70                                              const std::vector<std::string> &argv);
71
72    bool createDefaultSteppers();
73
74    Dyninst::THR_ID getActualThread(Dyninst::THR_ID tid, 
75                                 bool &error);
76
77    bool checkValidFrame(const Frame &in, const Frame &out);
78    bool callPreStackwalk(THR_ID tid = NULL_THR_ID);
79    bool callPostStackwalk(THR_ID tid = NULL_THR_ID);
80  public:
81    static void version(int& major, int& minor, int& maintenance);
82    //Create an object that operates on the current process
83    static Walker *newWalker(std::string exec_name = std::string(""));
84
85    //Create an object that operates on the specified process
86    static Walker *newWalker(Dyninst::PID pid,
87                             std::string executable);
88    static Walker *newWalker(Dyninst::PID pid);
89    static Walker *newWalker(Dyninst::ProcControlAPI::Process::ptr proc);
90    static bool newWalker(const std::vector<Dyninst::PID> &pids,
91                          std::vector<Walker *> &walkers_out,
92                          std::string executable);
93    static bool newWalker(const std::vector<Dyninst::PID> &pids,
94                          std::vector<Walker *> &walkers_out);      
95
96    //Create an object that creates the specified process
97    static Walker *newWalker(std::string exec_name, 
98                             const std::vector<std::string> &argv);
99
100    //Create an object with custom backend classes
101    static Walker *newWalker(ProcessState *proc, 
102                             StepperGroup *grp = NULL,
103                             SymbolLookup *lookup = NULL,
104                             bool default_steppers = true);
105
106    //Collect a stackwalk
107    bool walkStack(std::vector<Frame> &stackwalk, 
108                   Dyninst::THR_ID thread = NULL_THR_ID);
109
110    //Collect a stackwalk starting at a certain frame
111    bool walkStackFromFrame(std::vector<Frame> &stackwalk, 
112                            const Frame &frame);
113
114    //Walk a single frame
115    bool walkSingleFrame(const Frame &in, 
116                         Frame &out);
117
118    //Return the intitial frame in a stackwalk.
119    bool getInitialFrame(Frame &frame, 
120                         Dyninst::THR_ID thread = NULL_THR_ID);
121
122    //Return a list of threads available for stackwalking.
123    bool getAvailableThreads(std::vector<Dyninst::THR_ID> &threads) const;
124
125    //Return the ProcessState object
126    ProcessState *getProcessState() const;
127
128    //Return the symbolLookup object
129    SymbolLookup *getSymbolLookup() const;
130
131    //Return stepper group
132    StepperGroup *getStepperGroup() const;
133    
134    //Add frame steppers to the group
135    bool addStepper(FrameStepper *stepper);
136
137
138    virtual ~Walker();
139  private:
140    ProcessState *proc;
141    SymbolLookup *lookup;
142    bool creation_error;
143    StepperGroup *group;
144    unsigned call_count;
145 };
146
147 }
148 }
149
150 #endif