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