Initial commit of StackwalkerAPI
[dyninst.git] / stackwalk / h / frame.h
1 /*
2  * Copyright (c) 1996-2007 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 <string>
37
38 namespace Dyninst {
39 namespace Stackwalker {
40
41 class Walker;
42 class FrameStepper;
43
44 class Frame {
45   friend class Walker;
46 protected:
47   regval_t ra;
48   regval_t fp;
49   regval_t sp;
50         
51   location_t ra_loc;
52   location_t fp_loc;
53   location_t sp_loc;
54   
55   std::string sym_name;
56   void *sym_value;
57   
58   enum { nv_unset, nv_set, nv_err } name_val_set;
59   
60   bool bottom_frame;
61   bool frame_complete;
62   
63   FrameStepper *stepper;
64   Walker *walker;
65   
66   void setStepper(FrameStepper *newstep);
67   void setWalker(Walker *newwalk);
68   void markBottomFrame();
69   
70   void setNameValue();
71   
72  public:
73   Frame(Walker *walker);
74   static Frame *newFrame(regval_t ra, regval_t sp, regval_t fp, Walker *walker);
75   
76   regval_t getRA() const;
77   regval_t getSP() const;
78   regval_t getFP() const;
79   
80   void setRA(regval_t);
81   void setSP(regval_t);
82   void setFP(regval_t);
83   
84   location_t getRALocation() const;
85   location_t getSPLocation() const;
86   location_t getFPLocation() const;
87   
88   void setRALocation(location_t newval);
89   void setSPLocation(location_t newval);
90   void setFPLocation(location_t newval);
91   
92   bool getName(std::string &str);
93   bool getObject(void* &obj);
94   
95   bool isBottomFrame() const;
96   bool isFrameComplete() const;
97   
98   FrameStepper *getStepper() const;
99   Walker *getWalker() const;
100   
101   virtual ~Frame();
102 };
103
104 }
105 }
106
107 #endif