Commiting Aishwarya's work in allowing StackwalkerAPI users to change the system...
[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 <vector>
37 #include <list>
38 #include <string>
39
40 #define SW_MAJOR 2
41 #define SW_MINOR 1
42 #define SW_BETA  0
43
44 namespace Dyninst {
45
46 class SymbolReaderFactory;
47
48 namespace Stackwalker {
49
50 class ProcessState;
51 class ProcDebug; 
52 class SymbolLookup;
53 class Frame;
54 class FrameStepper;
55 class StepperGroup;
56
57 class Walker {
58    friend SymbolReaderFactory *getDefaultSymbolReader();
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 bool createDefaultProcess(const std::vector<Dyninst::PID> &pids,
71                                     std::vector<ProcDebug *> &pds);
72    static ProcessState *createDefaultProcess(std::string exec_name, 
73                                              const std::vector<std::string> &argv);
74
75    bool createDefaultSteppers();
76
77    Dyninst::THR_ID getActualThread(Dyninst::THR_ID tid, 
78                                 bool &error);
79
80    bool checkValidFrame(const Frame &in, const Frame &out);
81    bool callPreStackwalk(THR_ID tid = NULL_THR_ID);
82    bool callPostStackwalk(THR_ID tid = NULL_THR_ID);
83  public:
84    static void version(int& major, int& minor, int& maintenance);
85    //Create an object that operates on the current process
86    static Walker *newWalker(std::string exec_name = std::string(""));
87
88    //Create an object that operates on the specified process
89    static Walker *newWalker(Dyninst::PID pid,
90                             std::string executable);
91    static Walker *newWalker(Dyninst::PID pid);
92    static bool newWalker(const std::vector<Dyninst::PID> &pids,
93                          std::vector<Walker *> &walkers_out,
94                          std::string executable);
95    static bool newWalker(const std::vector<Dyninst::PID> &pids,
96                          std::vector<Walker *> &walkers_out);      
97
98    //Create an object that creates the specified process
99    static Walker *newWalker(std::string exec_name, 
100                             const std::vector<std::string> &argv);
101
102    //Create an object with custom backend classes
103    static Walker *newWalker(ProcessState *proc, 
104                             StepperGroup *grp = NULL,
105                             SymbolLookup *lookup = NULL,
106                             bool default_steppers = true);
107
108    //Collect a stackwalk
109    bool walkStack(std::vector<Frame> &stackwalk, 
110                   Dyninst::THR_ID thread = NULL_THR_ID);
111
112    //Collect a stackwalk starting at a certain frame
113    bool walkStackFromFrame(std::vector<Frame> &stackwalk, 
114                            const Frame &frame);
115
116    //Walk a single frame
117    bool walkSingleFrame(const Frame &in, 
118                         Frame &out);
119
120    //Return the intitial frame in a stackwalk.
121    bool getInitialFrame(Frame &frame, 
122                         Dyninst::THR_ID thread = NULL_THR_ID);
123
124    //Return a list of threads available for stackwalking.
125    bool getAvailableThreads(std::vector<Dyninst::THR_ID> &threads) const;
126
127    //Return the ProcessState object
128    ProcessState *getProcessState() const;
129
130    //Return the symbolLookup object
131    SymbolLookup *getSymbolLookup() const;
132
133    //Return stepper group
134    StepperGroup *getStepperGroup() const;
135    
136    //Add frame steppers to the group
137    bool addStepper(FrameStepper *stepper);
138
139    //Manage SymbolReader
140    static SymbolReaderFactory* getSymbolReader();
141    static void setSymbolReader(SymbolReaderFactory*);
142
143    virtual ~Walker();
144  private:
145    ProcessState *proc;
146    SymbolLookup *lookup;
147    bool creation_error;
148    StepperGroup *group;
149    unsigned call_count;
150    static SymbolReaderFactory *symrfact;
151 };
152
153 }
154 }
155
156 #endif