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