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