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