Update copyright disclaimer structure by outlining copyright notice. Add LLNL and...
[dyninst.git] / stackwalk / h / walker.h
1 /*
2  * See the dyninst/COPYRIGHT file for copyright information.
3  * 
4  * We provide the Paradyn Tools (below described as "Paradyn")
5  * on an AS IS basis, and do not warrant its validity or performance.
6  * We reserve the right to update, modify, or discontinue this
7  * software at any time.  We shall have no obligation to supply such
8  * updates or modifications or any other form of support to you.
9  * 
10  * By your use of Paradyn, you understand and agree that we (or any
11  * other person or entity with proprietary rights in Paradyn) are
12  * under no obligation to provide either maintenance services,
13  * update services, notices of latent defects, or correction of
14  * defects for Paradyn.
15  * 
16  * This library is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  * 
21  * This library is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  * 
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with this library; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29  */
30
31 #ifndef WALKER_H_
32 #define WALKER_H_
33
34 #include "basetypes.h"
35 #include "PCProcess.h"
36 #include <vector>
37 #include <list>
38 #include <string>
39 #include <utility>
40
41 #define SW_MAJOR 8
42 #define SW_MINOR 0
43 #define SW_BETA  0
44
45 #define SW_VERSION_8_0_0
46 #define SW_VERSION_2_1_1
47 #define SW_VERSION_2_1_0
48
49 namespace Dyninst {
50
51 class SymbolReaderFactory;
52
53 namespace Stackwalker {
54
55 class ProcessState;
56 class ProcDebug; 
57 class SymbolLookup;
58 class Frame;
59 class FrameStepper;
60 class StepperGroup;
61 class CallTree;
62 class int_walkerSet;
63
64 class SW_EXPORT Walker {
65  private:
66    //Object creation functions
67    Walker(ProcessState *p,
68           StepperGroup *grp,
69           SymbolLookup *sym, 
70           bool default_steppers,
71           std::string exec_name);
72    SymbolLookup *createDefaultSymLookup(std::string exec_name);
73    StepperGroup *createDefaultStepperGroup();
74    static ProcessState *createDefaultProcess(std::string exec_name = std::string(""));
75    static ProcessState *createDefaultProcess(Dyninst::PID pid, std::string exe);
76    static ProcessState *createDefaultProcess(Dyninst::ProcControlAPI::Process::ptr proc);
77    static bool createDefaultProcess(const std::vector<Dyninst::PID> &pids,
78                                     std::vector<ProcDebug *> &pds);
79    static ProcessState *createDefaultProcess(std::string exec_name, 
80                                              const std::vector<std::string> &argv);
81
82    bool createDefaultSteppers();
83
84    Dyninst::THR_ID getActualThread(Dyninst::THR_ID tid, 
85                                 bool &error);
86
87    bool checkValidFrame(const Frame &in, const Frame &out);
88    bool callPreStackwalk(THR_ID tid = NULL_THR_ID);
89    bool callPostStackwalk(THR_ID tid = NULL_THR_ID);
90  public:
91    static void version(int& major, int& minor, int& maintenance);
92    //Create an object that operates on the current process
93    static Walker *newWalker(std::string exec_name = std::string(""));
94
95    //Create an object that operates on the specified process
96    static Walker *newWalker(Dyninst::PID pid,
97                             std::string executable);
98    static Walker *newWalker(Dyninst::PID pid);
99    static Walker *newWalker(Dyninst::ProcControlAPI::Process::ptr proc);
100    static bool newWalker(const std::vector<Dyninst::PID> &pids,
101                          std::vector<Walker *> &walkers_out,
102                          std::string executable);
103    static bool newWalker(const std::vector<Dyninst::PID> &pids,
104                          std::vector<Walker *> &walkers_out);      
105
106    //Create an object that creates the specified process
107    static Walker *newWalker(std::string exec_name, 
108                             const std::vector<std::string> &argv);
109
110    //Create an object with custom backend classes
111    static Walker *newWalker(ProcessState *proc, 
112                             StepperGroup *grp = NULL,
113                             SymbolLookup *lookup = NULL,
114                             bool default_steppers = true);
115    
116    //Get the default symbol reader
117    static SymbolReaderFactory *getSymbolReader();
118
119    //Set the default symbol reader
120    static void setSymbolReader(SymbolReaderFactory *srf);
121
122    //Collect a stackwalk
123    bool walkStack(std::vector<Frame> &stackwalk, 
124                   Dyninst::THR_ID thread = NULL_THR_ID);
125
126    //Collect a stackwalk starting at a certain frame
127    bool walkStackFromFrame(std::vector<Frame> &stackwalk, 
128                            const Frame &frame);
129
130    //Walk a single frame
131    bool walkSingleFrame(const Frame &in, 
132                         Frame &out);
133
134    //Return the intitial frame in a stackwalk.
135    bool getInitialFrame(Frame &frame, 
136                         Dyninst::THR_ID thread = NULL_THR_ID);
137
138    //Return a list of threads available for stackwalking.
139    bool getAvailableThreads(std::vector<Dyninst::THR_ID> &threads) const;
140
141    //Return the ProcessState object
142    ProcessState *getProcessState() const;
143
144    //Return the symbolLookup object
145    SymbolLookup *getSymbolLookup() const;
146
147    //Return stepper group
148    StepperGroup *getStepperGroup() const;
149    
150    //Add frame steppers to the group
151    bool addStepper(FrameStepper *stepper);
152
153    virtual ~Walker();
154  private:
155    ProcessState *proc;
156    SymbolLookup *lookup;
157    bool creation_error;
158    StepperGroup *group;
159    unsigned call_count;
160    static SymbolReaderFactory *symrfact;
161 };
162
163 class WalkerSet {
164   private:
165    int_walkerSet *iwalkerset;
166    WalkerSet();
167   public:
168    //Create an object that operates on the specified process
169    static WalkerSet *newWalkerSet();
170    ~WalkerSet();
171    
172    typedef std::set<Walker *>::iterator iterator;
173    typedef std::set<Walker *>::const_iterator const_iterator;
174    
175    iterator begin();
176    iterator end();
177    iterator find(Walker *);
178    const_iterator begin() const;
179    const_iterator end() const;
180    const_iterator find(Walker *) const;
181    
182    std::pair<iterator, bool> insert(Walker *walker);
183    void erase(iterator i);
184    bool empty() const;
185    size_t size() const;
186
187    bool walkStacks(CallTree &tree) const;
188 };
189
190 }
191 }
192
193 #endif