Fix bad paths in StackwalkerAPI public includes
[dyninst.git] / stackwalk / h / frame.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 FRAME_H_
33 #define FRAME_H_
34
35 #include "basetypes.h"
36 #include "Annotatable.h"
37 #include <string>
38
39 namespace Dyninst {
40 namespace Stackwalker {
41
42 class Walker;
43 class FrameStepper;
44
45 class SW_EXPORT Frame : public AnnotatableDense {
46   friend class Walker;
47 protected:
48   Dyninst::MachRegisterVal ra;
49   Dyninst::MachRegisterVal fp;
50   Dyninst::MachRegisterVal sp;
51         
52   location_t ra_loc;
53   location_t fp_loc;
54   location_t sp_loc;
55   
56   mutable std::string sym_name;
57   mutable void *sym_value;
58   mutable enum { nv_unset, nv_set, nv_err } name_val_set;
59   
60   bool top_frame;
61   bool bottom_frame;
62   bool frame_complete;
63   
64   const Frame *prev_frame;
65   FrameStepper *stepper;
66   FrameStepper *next_stepper;
67   Walker *walker;
68   THR_ID originating_thread;
69   
70   void setStepper(FrameStepper *newstep);
71   void setWalker(Walker *newwalk);
72   void markTopFrame();
73   void markBottomFrame();
74   
75   void setNameValue() const;
76   
77  public:
78   Frame();
79   Frame(Walker *walker);
80   static Frame *newFrame(Dyninst::MachRegisterVal ra, Dyninst::MachRegisterVal sp, Dyninst::MachRegisterVal fp, Walker *walker);
81
82   bool operator==(const Frame &F) const;
83
84   Dyninst::MachRegisterVal getRA() const;
85   Dyninst::MachRegisterVal getSP() const;
86   Dyninst::MachRegisterVal getFP() const;
87   
88   void setRA(Dyninst::MachRegisterVal);
89   void setSP(Dyninst::MachRegisterVal);
90   void setFP(Dyninst::MachRegisterVal);
91   void setThread(THR_ID);
92   
93   location_t getRALocation() const;
94   location_t getSPLocation() const;
95   location_t getFPLocation() const;
96   
97   void setRALocation(location_t newval);
98   void setSPLocation(location_t newval);
99   void setFPLocation(location_t newval);
100   
101   bool getName(std::string &str) const;
102   bool getObject(void* &obj) const;
103   bool getLibOffset(std::string &lib, Dyninst::Offset &offset, void* &symtab) const;
104   
105   bool isTopFrame() const;
106   bool isBottomFrame() const;
107   bool isFrameComplete() const;
108   
109   const Frame *getPrevFrame() const;
110   FrameStepper *getStepper() const;
111   FrameStepper *getNextStepper() const;
112   Walker *getWalker() const;
113   THR_ID getThread() const;
114
115   ~Frame();
116 };
117
118 }
119 }
120
121 #endif