Merge branch 'dyninst-master' into dyn_pc_integration
[dyninst.git] / stackwalk / h / frame.h
1 /*
2  * Copyright (c) 1996-2009 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 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 bottom_frame;
61   bool frame_complete;
62   
63   const Frame *prev_frame;
64   FrameStepper *stepper;
65   FrameStepper *next_stepper;
66   Walker *walker;
67   THR_ID originating_thread;
68   
69   void setStepper(FrameStepper *newstep);
70   void setWalker(Walker *newwalk);
71   void markBottomFrame();
72   
73   void setNameValue() const;
74   
75  public:
76   Frame();
77   Frame(Walker *walker);
78   static Frame *newFrame(Dyninst::MachRegisterVal ra, Dyninst::MachRegisterVal sp, Dyninst::MachRegisterVal fp, Walker *walker);
79
80   bool operator==(const Frame &F) const;
81
82   Dyninst::MachRegisterVal getRA() const;
83   Dyninst::MachRegisterVal getSP() const;
84   Dyninst::MachRegisterVal getFP() const;
85   
86   void setRA(Dyninst::MachRegisterVal);
87   void setSP(Dyninst::MachRegisterVal);
88   void setFP(Dyninst::MachRegisterVal);
89   void setThread(THR_ID);
90   
91   location_t getRALocation() const;
92   location_t getSPLocation() const;
93   location_t getFPLocation() const;
94   
95   void setRALocation(location_t newval);
96   void setSPLocation(location_t newval);
97   void setFPLocation(location_t newval);
98   
99   bool getName(std::string &str) const;
100   bool getObject(void* &obj) const;
101   bool getLibOffset(std::string &lib, Dyninst::Offset &offset, void* &symtab) const;
102   
103   bool isBottomFrame() const;
104   bool isFrameComplete() const;
105   
106   const Frame *getPrevFrame() const;
107   FrameStepper *getStepper() const;
108   FrameStepper *getNextStepper() const;
109   Walker *getWalker() const;
110   THR_ID getThread() const;
111
112   ~Frame();
113 };
114
115 }
116 }
117
118 #endif