Update versions missed by previous commit.
[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 1
43 #define SW_BETA  0
44
45 #define SW_VERSION_8_1_0
46 #define SW_VERSION_8_0_0
47 #define SW_VERSION_2_1_1
48 #define SW_VERSION_2_1_0
49
50 namespace Dyninst {
51
52 class SymbolReaderFactory;
53
54 namespace Stackwalker {
55
56 class ProcessState;
57 class ProcDebug; 
58 class SymbolLookup;
59 class Frame;
60 class FrameStepper;
61 class StepperGroup;
62 class CallTree;
63 class int_walkerSet;
64
65 class SW_EXPORT Walker {
66  private:
67    //Object creation functions
68    Walker(ProcessState *p,
69           StepperGroup *grp,
70           SymbolLookup *sym, 
71           bool default_steppers,
72           std::string exec_name);
73    SymbolLookup *createDefaultSymLookup(std::string exec_name);
74    StepperGroup *createDefaultStepperGroup();
75    static ProcessState *createDefaultProcess(std::string exec_name = std::string(""));
76    static ProcessState *createDefaultProcess(Dyninst::PID pid, std::string exe);
77    static ProcessState *createDefaultProcess(Dyninst::ProcControlAPI::Process::ptr proc);
78    static bool createDefaultProcess(const std::vector<Dyninst::PID> &pids,
79                                     std::vector<ProcDebug *> &pds);
80    static ProcessState *createDefaultProcess(std::string exec_name, 
81                                              const std::vector<std::string> &argv);
82
83    bool createDefaultSteppers();
84
85    Dyninst::THR_ID getActualThread(Dyninst::THR_ID tid, 
86                                 bool &error);
87
88    bool checkValidFrame(const Frame &in, const Frame &out);
89    bool callPreStackwalk(THR_ID tid = NULL_THR_ID);
90    bool callPostStackwalk(THR_ID tid = NULL_THR_ID);
91  public:
92    static void version(int& major, int& minor, int& maintenance);
93    //Create an object that operates on the current process
94    static Walker *newWalker(std::string exec_name = std::string(""));
95
96    //Create an object that operates on the specified process
97    static Walker *newWalker(Dyninst::PID pid,
98                             std::string executable);
99    static Walker *newWalker(Dyninst::PID pid);
100    static Walker *newWalker(Dyninst::ProcControlAPI::Process::ptr proc);
101    static bool newWalker(const std::vector<Dyninst::PID> &pids,
102                          std::vector<Walker *> &walkers_out,
103                          std::string executable);
104    static bool newWalker(const std::vector<Dyninst::PID> &pids,
105                          std::vector<Walker *> &walkers_out);      
106
107    //Create an object that creates the specified process
108    static Walker *newWalker(std::string exec_name, 
109                             const std::vector<std::string> &argv);
110
111    //Create an object with custom backend classes
112    static Walker *newWalker(ProcessState *proc, 
113                             StepperGroup *grp = NULL,
114                             SymbolLookup *lookup = NULL,
115                             bool default_steppers = true);
116    
117    //Get the default symbol reader
118    static SymbolReaderFactory *getSymbolReader();
119
120    //Set the default symbol reader
121    static void setSymbolReader(SymbolReaderFactory *srf);
122
123    //Collect a stackwalk
124    bool walkStack(std::vector<Frame> &stackwalk, 
125                   Dyninst::THR_ID thread = NULL_THR_ID);
126
127    //Collect a stackwalk starting at a certain frame
128    bool walkStackFromFrame(std::vector<Frame> &stackwalk, 
129                            const Frame &frame);
130
131    //Walk a single frame
132    bool walkSingleFrame(const Frame &in, 
133                         Frame &out);
134
135    //Return the intitial frame in a stackwalk.
136    bool getInitialFrame(Frame &frame, 
137                         Dyninst::THR_ID thread = NULL_THR_ID);
138
139    //Return a list of threads available for stackwalking.
140    bool getAvailableThreads(std::vector<Dyninst::THR_ID> &threads) const;
141
142    //Return the ProcessState object
143    ProcessState *getProcessState() const;
144
145    //Return the symbolLookup object
146    SymbolLookup *getSymbolLookup() const;
147
148    //Return stepper group
149    StepperGroup *getStepperGroup() const;
150    
151    //Add frame steppers to the group
152    bool addStepper(FrameStepper *stepper);
153
154    virtual ~Walker();
155  private:
156    ProcessState *proc;
157    SymbolLookup *lookup;
158    bool creation_error;
159    StepperGroup *group;
160    unsigned call_count;
161    static SymbolReaderFactory *symrfact;
162 };
163
164 class WalkerSet {
165   private:
166    int_walkerSet *iwalkerset;
167    WalkerSet();
168   public:
169    //Create an object that operates on the specified process
170    static WalkerSet *newWalkerSet();
171    ~WalkerSet();
172    
173    typedef std::set<Walker *>::iterator iterator;
174    typedef std::set<Walker *>::const_iterator const_iterator;
175    
176    iterator begin();
177    iterator end();
178    iterator find(Walker *);
179    const_iterator begin() const;
180    const_iterator end() const;
181    const_iterator find(Walker *) const;
182    
183    std::pair<iterator, bool> insert(Walker *walker);
184    void erase(iterator i);
185    bool empty() const;
186    size_t size() const;
187
188    bool walkStacks(CallTree &tree, bool walk_initial_only = false) const;
189 };
190
191 }
192 }
193
194 #endif