Expose endianness from Elf_X.
[dyninst.git] / dyninstAPI / h / BPatch_frame.h
1 /*
2  * See the dyninst/COPYRIGHT file for copyright information.
3  * 
4  * We provide the Paradyn Tools (below described as "Paradyn")
5  * on an AS IS basis, and do not warrant its validity or performance.
6  * We reserve the right to update, modify, or discontinue this
7  * software at any time.  We shall have no obligation to supply such
8  * updates or modifications or any other form of support to you.
9  * 
10  * By your use of Paradyn, you understand and agree that we (or any
11  * other person or entity with proprietary rights in Paradyn) are
12  * under no obligation to provide either maintenance services,
13  * update services, notices of latent defects, or correction of
14  * defects for Paradyn.
15  * 
16  * This library is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  * 
21  * This library is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  * 
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with this library; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29  */
30
31 #ifndef _BPatch_frame_h_
32 #define _BPatch_frame_h_
33
34 #include "BPatch_Vector.h"
35
36 /*
37  * Frame information needed for stack walking
38  */
39 typedef enum {
40     BPatch_frameNormal,
41     BPatch_frameSignal,
42     BPatch_frameTrampoline
43 } BPatch_frameType;
44
45 class BPatch_function;
46 class BPatch_thread;
47
48 class BPATCH_DLL_EXPORT BPatch_frame {
49     friend class BPatch_thread;
50     friend class BPatch_Vector<BPatch_frame>;
51     BPatch_thread *thread;
52
53     void *pc;
54     void *fp;
55     bool isSignalFrame;
56     bool isTrampFrame;
57     // BPatch defines that a trampoline is effectively a "function call" and
58     // puts an extra tramp on the stack. Various people (frex, Paradyn) really
59     // don't want to see this frame. To make life simpler for everyone, we
60     // add a "only call if you know what you're doing" flag.
61     bool isSynthFrame;
62
63     // This is _so_ much easier than looking it up later. If we're
64     // in instrumentation, stash the point
65     BPatch_point *point_;
66
67 public:
68     BPatch_frame();
69     BPatch_frame(BPatch_thread *_thread, 
70                  void *_pc, void *_fp, 
71                  bool isf = false, 
72                  bool istr = false, BPatch_point *point = NULL,
73                  bool isSynth = false);
74
75
76     //  BPatch_frame::getFrameType
77     //  Returns type of frame: BPatch_frameNormal for a stack frame for a 
78     //  function, BPatch_frameSignal for the stack frame created when a signal 
79     //  is delivered, or BPatch_frameTrampoline for a stack frame created by 
80     //  internal Dyninst instrumentation.
81     BPatch_frameType getFrameType();
82
83     //  Only call if you know what you are doing; per-frame method for determining
84     //  how the frame was created.
85     bool isSynthesized();
86
87     //  BPatch_frame::getThread
88     //  Returns:  value of program counter
89
90     BPatch_thread * getThread(); 
91
92     //  BPatch_frame::getThread
93     //  Returns:  value of program counter
94
95     BPatch_point * getPoint(); 
96
97     //  BPatch_frame::getPC
98     //  Returns:  value of program counter
99
100     void * getPC(); 
101
102     //  BPatch_frame::getFP
103
104     void * getFP(); 
105
106     //  BPatch_frame::findFunction
107     //  Returns:  the function corresponding to this stack frame, NULL 
108     //   if there is none
109
110     BPatch_function * findFunction();
111    
112     // The following are planned but no yet implemented:
113     // int getSignalNumber();
114
115     BPatch_point * findPoint();
116
117     friend std::ostream & operator << ( std::ostream & s, BPatch_frame & m );
118
119 };
120
121 #endif