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