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