Update copyright to LGPL on all files
[dyninst.git] / dyninstAPI / h / BPatch_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 _BPatch_frame_h_
33 #define _BPatch_frame_h_
34
35 #include "BPatch_Vector.h"
36
37 /*
38  * Frame information needed for stack walking
39  */
40 typedef enum {
41     BPatch_frameNormal,
42     BPatch_frameSignal,
43     BPatch_frameTrampoline
44 } BPatch_frameType;
45
46 class BPatch_function;
47 class BPatch_thread;
48
49 #ifdef DYNINST_CLASS_NAME
50 #undef DYNINST_CLASS_NAME
51 #endif
52 #define DYNINST_CLASS_NAME BPatch_frame
53
54 class BPATCH_DLL_EXPORT BPatch_frame : public BPatch_eventLock{
55     friend class BPatch_thread;
56     friend class BPatch_Vector<BPatch_frame>;
57     BPatch_thread *thread;
58
59     void *pc;
60     void *fp;
61     bool isSignalFrame;
62     bool isTrampFrame;
63     // BPatch defines that a trampoline is effectively a "function call" and
64     // puts an extra tramp on the stack. Various people (frex, Paradyn) really
65     // don't want to see this frame. To make life simpler for everyone, we
66     // add a "only call if you know what you're doing" flag.
67     bool isSynthFrame;
68
69     // This is _so_ much easier than looking it up later. If we're
70     // in instrumentation, stash the point
71     BPatch_point *point_;
72
73 public:
74     BPatch_frame();
75     BPatch_frame(BPatch_thread *_thread, 
76                  void *_pc, void *_fp, 
77                  bool isf = false, 
78                  bool istr = false, BPatch_point *point = NULL,
79                  bool isSynth = false);
80
81
82     //  BPatch_frame::getFrameType
83     //  Returns type of frame: BPatch_frameNormal for a stack frame for a 
84     //  function, BPatch_frameSignal for the stack frame created when a signal 
85     //  is delivered, or BPatch_frameTrampoline for a stack frame created by 
86     //  internal Dyninst instrumentation.
87     API_EXPORT(Int, (),
88
89     BPatch_frameType,getFrameType,());
90
91     //  Only call if you know what you are doing; per-frame method for determining
92     //  how the frame was created.
93     API_EXPORT(Int, (),
94     bool, isSynthesized, ());
95
96     //  BPatch_frame::getThread
97     //  Returns:  value of program counter
98     API_EXPORT(Int, (),
99
100     BPatch_thread *,getThread,()); 
101
102     //  BPatch_frame::getThread
103     //  Returns:  value of program counter
104     API_EXPORT(Int, (),
105
106     BPatch_point *,getPoint,()); 
107
108     //  BPatch_frame::getPC
109     //  Returns:  value of program counter
110     API_EXPORT(Int, (),
111
112     void *,getPC,()); 
113
114     //  BPatch_frame::getFP
115     API_EXPORT(Int, (),
116
117     void *,getFP,()); 
118
119     //  BPatch_frame::findFunction
120     //  Returns:  the function corresponding to this stack frame, NULL 
121     //   if there is none
122     API_EXPORT(Int, (),
123
124     BPatch_function *,findFunction,());
125    
126     // The following are planned but no yet implemented:
127     // int getSignalNumber();
128
129     API_EXPORT(Int, (), 
130     BPatch_point *,findPoint,());
131
132     friend std::ostream & operator << ( std::ostream & s, BPatch_frame & m );
133
134 };
135
136 #endif