Build fixes for UMD compilers
[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 #include <string>
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 bool createDefaultProcess(const std::vector<Dyninst::PID> &pids,
67                                     std::vector<ProcDebug *> &pds);
68    static ProcessState *createDefaultProcess(std::string exec_name, 
69                                              const std::vector<std::string> &argv);
70
71    bool createDefaultSteppers();
72
73    Dyninst::THR_ID getActualThread(Dyninst::THR_ID tid, 
74                                 bool &error);
75
76    bool checkValidFrame(const Frame &in, const Frame &out);
77    bool callPreStackwalk(THR_ID tid = NULL_THR_ID);
78    bool callPostStackwalk(THR_ID tid = NULL_THR_ID);
79  public:
80    static void version(int& major, int& minor, int& maintenance);
81    //Create an object that operates on the current process
82    static Walker *newWalker(std::string exec_name = std::string(""));
83
84    //Create an object that operates on the specified process
85    static Walker *newWalker(Dyninst::PID pid,
86                             std::string executable);
87    static Walker *newWalker(Dyninst::PID pid);
88    static bool newWalker(const std::vector<Dyninst::PID> &pids,
89                          std::vector<Walker *> &walkers_out,
90                          std::string executable);
91    static bool newWalker(const std::vector<Dyninst::PID> &pids,
92                          std::vector<Walker *> &walkers_out);      
93
94    //Create an object that creates the specified process
95    static Walker *newWalker(std::string exec_name, 
96                             const std::vector<std::string> &argv);
97
98    //Create an object with custom backend classes
99    static Walker *newWalker(ProcessState *proc, 
100                             StepperGroup *grp = NULL,
101                             SymbolLookup *lookup = NULL,
102                             bool default_steppers = true);
103
104    //Collect a stackwalk
105    bool walkStack(std::vector<Frame> &stackwalk, 
106                   Dyninst::THR_ID thread = NULL_THR_ID);
107
108    //Collect a stackwalk starting at a certain frame
109    bool walkStackFromFrame(std::vector<Frame> &stackwalk, 
110                            const Frame &frame);
111
112    //Walk a single frame
113    bool walkSingleFrame(const Frame &in, 
114                         Frame &out);
115
116    //Return the intitial frame in a stackwalk.
117    bool getInitialFrame(Frame &frame, 
118                         Dyninst::THR_ID thread = NULL_THR_ID);
119
120    //Return a list of threads available for stackwalking.
121    bool getAvailableThreads(std::vector<Dyninst::THR_ID> &threads) const;
122
123    //Return the ProcessState object
124    ProcessState *getProcessState() const;
125
126    //Return the symbolLookup object
127    SymbolLookup *getSymbolLookup() const;
128
129    //Return stepper group
130    StepperGroup *getStepperGroup() const;
131    
132    //Add frame steppers to the group
133    bool addStepper(FrameStepper *stepper);
134
135
136    virtual ~Walker();
137  private:
138    ProcessState *proc;
139    SymbolLookup *lookup;
140    bool creation_error;
141    StepperGroup *group;
142    unsigned call_count;
143 };
144
145 }
146 }
147
148 #endif