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