Tracking commit. Will provide details in later e/m. :)
[dyninst.git] / dyninstAPI / src / inst-ia64.h
1 /*
2  * Copyright (c) 1996 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  * This license is for research uses.  For such uses, there is no
12  * charge. We define "research use" to mean you may freely use it
13  * inside your organization for whatever purposes you see fit. But you
14  * may not re-distribute Paradyn or parts of Paradyn, in any form
15  * source or binary (including derivatives), electronic or otherwise,
16  * to any other organization or entity without our permission.
17  * 
18  * (for other uses, please contact us at paradyn@cs.wisc.edu)
19  * 
20  * All warranties, including without limitation, any warranty of
21  * merchantability or fitness for a particular purpose, are hereby
22  * excluded.
23  * 
24  * By your use of Paradyn, you understand and agree that we (or any
25  * other person or entity with proprietary rights in Paradyn) are
26  * under no obligation to provide either maintenance services,
27  * update services, notices of latent defects, or correction of
28  * defects for Paradyn.
29  * 
30  * Even if advised of the possibility of such damages, under no
31  * circumstances shall we (or any other person or entity with
32  * proprietary rights in the software licensed hereunder) be liable
33  * to you or any third party for direct, indirect, or consequential
34  * damages of any character regardless of type of action, including,
35  * without limitation, loss of profits, loss of use, loss of good
36  * will, or computer failure or malfunction.  You agree to indemnify
37  * us (and any other person or entity with proprietary rights in the
38  * software licensed hereunder) for any and all liability it may
39  * incur to third parties resulting from your use of Paradyn.
40  */
41
42 // $Id: inst-ia64.h,v 1.6 2002/08/01 18:37:28 tlmiller Exp $
43
44 #ifndef INST_IA64_H
45 #define INST_IA64_H
46
47 #include "common/h/Types.h"     // Address
48 class process;
49 class IA64_bundle;
50 class IA64_instruction;
51
52 class InsnAddr {
53         public:
54                 /* prefix increment */
55                 InsnAddr operator++ ();
56
57                 /* prefix decrement */
58                 InsnAddr operator-- ();
59
60                 /* postfix increment */
61                 InsnAddr operator++ (int dummy);
62
63                 /* postfix decrement */
64                 InsnAddr operator-- (int dummy);
65
66                 /* sum of two InsnAddrs */
67                 friend InsnAddr operator + ( InsnAddr lhs, InsnAddr rhs );
68
69                 /* difference of two InsnAddrs */
70                 friend InsnAddr operator - ( InsnAddr lhs, InsnAddr rhs );
71
72                 /* Returns the left-aligned instruction at this address. */
73                 uint64_t operator * ();
74
75                 friend bool operator < ( InsnAddr lhs, InsnAddr rhs );
76                 friend bool operator <= ( InsnAddr lhs, InsnAddr rhs );
77                 friend bool operator > ( InsnAddr lhs, InsnAddr rhs );
78                 friend bool operator >= ( InsnAddr lhs, InsnAddr rhs );
79                 friend bool operator == ( InsnAddr lhs, InsnAddr rhs );
80                 friend bool operator != ( InsnAddr lhs, InsnAddr rhs );
81
82                 static InsnAddr generateFromAlignedDataAddress( Address addr, process * p );
83                 bool writeMyBundleFrom( const unsigned char * savedCodeBuffer );
84                 bool saveMyBundleTo( unsigned char * savedCodeBuffer );
85                 bool saveBundlesTo( unsigned char * savedCodeBuffer, unsigned int numberOfBundles );
86                 bool writeBundlesFrom( unsigned char * savedCodeBuffer, unsigned int numberOfBundles );
87                 bool replaceBundleWith( const IA64_bundle & bundle );
88                 bool replaceBundlesWith( const IA64_bundle * replacementBundles, unsigned int numberOfReplacementBundles );
89                 bool writeStringAtOffset( unsigned int offsetInBundles, const char * string, unsigned int length );
90
91         private:
92                 InsnAddr( Address addr, process * p ) : encodedAddress( addr ), myProc( p ) { }
93                 Address encodedAddress;
94                 process * myProc;
95 }; /* end class InsnAddr */
96
97 #include "arch-ia64.h"
98
99 class IA64_iterator {
100         /* FIXME: if/when InsnAddr and/or InstrucIter are implemented, move the
101            address-munging functionality here. */
102         public:
103                 IA64_iterator( Address addr );
104
105                 friend bool operator < ( IA64_iterator lhs, IA64_iterator rhs );
106
107                 /* Returns the left-aligned instruction at this address. */
108                 IA64_instruction operator * ();
109                 
110                 /* postfix increment */
111                 const IA64_iterator operator++ (int dummy);
112
113                 Address getEncodedAddress() { return encodedAddress; }
114
115         private:
116                 Address encodedAddress;
117                 IA64_bundle currentBundle;
118 }; /* end class IA64_iterator */
119
120 #endif