removed cvs log lines;
[dyninst.git] / dyninstAPI_RT / h / dyninstAPI_RT.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 /*
43  * $Id: dyninstAPI_RT.h,v 1.10 2001/08/07 20:49:01 chadd Exp $
44  * This file contains the standard instrumentation functions that are provided
45  *   by the run-time instrumentation layer.
46  */
47
48 #ifndef _DYNINSTAPI_RT_H
49 #define _DYNINSTAPI_RT_H
50
51 /*
52  * Define the size of the per process data area.
53  *
54  *  This should be a power of two to reduce paging and caching shifts.
55  *  Note that larger sizes may result in requiring longjumps within
56  *  mini-trampolines to reach within this area.
57  */
58
59 #define SYN_INST_BUF_SIZE (1024*1024*4)
60
61 /* We sometimes include this into assembly files, so guard the struct defs. */
62 #if !defined(__ASSEMBLER__)
63
64 #include <stdio.h>
65 #include "common/h/Types.h"
66
67 /* If we must make up a boolean type, we should make it unique */
68 typedef unsigned char RT_Boolean;
69 static const RT_Boolean RT_TRUE=1;
70 static const RT_Boolean RT_FALSE=0;
71
72 struct DYNINST_bootstrapStruct {
73    int event; /* "event" values:
74                  0 --> nothing
75                  1 --> end of DYNINSTinit (normal)
76                  2 --> end of DYNINSTinit (forked process)
77                  3 --> start of DYNINSTexec (before exec) 
78               */
79    int pid;
80    int ppid; /* parent of forked process */
81
82    char path[512]; /* only used in exec */
83 };
84
85 #if defined(i386_unknown_solaris2_5) || defined(i386_unknown_linux2_0) \
86  || defined(i386_unknown_nt4_0)  || defined(mips_unknown_ce2_11) /*ccw 26 july 2000 : 29 mar 2001*/
87 /*
88    The tramp table is used when we need to insert traps in instrumentation
89    points. It is used by the trap handler to lookup the base tramp for
90    an address (point).
91
92    The table is updated by the paradyn daemon.
93 */
94
95 #define TRAMPTABLESZ (4096)
96
97 #define HASH1(x) ((x) % TRAMPTABLESZ)
98 #define HASH2(x) (((x) % TRAMPTABLESZ-1) | 1)
99
100 typedef struct trampTableEntryStruct trampTableEntry;
101 struct trampTableEntryStruct {
102   unsigned key;
103   unsigned val;
104 };
105
106 #endif
107
108 struct rpcInfoStruct {
109   int runningInferiorRPC;  /* 1 running irpc, 0 not running */
110   unsigned begRPCAddr;
111   unsigned endRPCAddr;
112 };
113 typedef struct rpcInfoStruct rpcInfo;
114 extern rpcInfo curRPC;
115 extern unsigned pcAtLastIRPC;
116 extern int trapNotHandled;  /* 1 a trap hasn't been handled, 0 traps handled */
117
118 extern int DYNINSTdebugPrintRT; /* control run-time lib debug/trace prints */
119 #define RTprintf                if (DYNINSTdebugPrintRT) printf
120                                 /* Yes, this is crude, but this is plain C */
121
122
123 #endif /* !defined(__ASSEMBLER__) */
124
125 #endif /* _DYNINSTAPI_RT_H */