Initial revision
[dyninst.git] / rtinst / h / rtinst.h
1
2 /*
3  * This file contains the standard insrumentation functions that are provied
4  *   by the instrumentation layer.
5  *
6  */
7
8 #ifndef _RTINST_H
9 #define _RTINST_H
10
11 typedef void (*instFunc)(void *cdata, int type, char *eventData);
12
13 typedef struct intCounterRec intCounter;
14
15 struct _parameteters {
16     int arg1;
17     int arg2;
18     int arg3;
19     int arg4;
20     int arg5;
21     int arg6;
22     int arg7;
23     int arg8;
24     int arg9;
25     int arg10;
26     int arg11;
27     int arg12;
28     int arg13;
29     int arg14;
30     int arg15;
31 };
32
33 /* parameters to a instremented function */
34 typedef struct _parameteters parameters;
35 typedef enum { processTime, wallTime } timerType;
36
37 /* 64 bit time values */
38 typedef long long int time64;
39 struct sampleIdRec {
40     unsigned int aggregate:1;
41     unsigned int id:31;
42 };
43
44 typedef struct sampleIdRec sampleId;
45
46
47 struct intCounterRec {
48     intCounter *trigger;
49     int value;
50     sampleId id;
51 };
52
53
54 typedef struct floatCounterRec floatCounter;
55 struct floatCounterRec {
56     intCounter *trigger;
57     float value;
58     sampleId id;
59 };
60
61
62 typedef struct tTimerRec tTimer;
63 struct tTimerRec {
64     intCounter *trigger;
65     int counter;        /* must be 0 to start/stop */
66     time64      total;
67     time64      start;
68     time64      ni_start;
69     timerType type;
70     int         normalize;      /* value to divide total by to get seconds */
71     sampleId id;
72 };
73
74
75 /*
76  * standard inst. functions.
77  *
78  */
79
80 /*
81  * start a timer.
82  */
83 void DYNINSTstartTimer(tTimer *timer);
84
85 void DYNINSTstopTimer(tTimer *timer);
86
87 /*
88  * increment the passed counter by one.
89  *
90  */
91 void DYNINSTincremmentCounter(intCounter*);
92
93 /*
94  * decrement the passed counter by one.
95  *
96  */
97 void DYNINSTdecrementCounter(intCounter*);
98
99 /*
100  * Special purpose inst functiions that use trace type specific data.
101  *
102  */
103
104 /* add bytes field to passed counter */
105 void addBytesCounter(intCounter *data);
106
107 typedef struct {
108     void *filterData;           /* data to filter on */
109     instFunc toCall;            /* function to call if it passes filter */
110     void *callData;             /* data to pass to toCall if it is called */
111 } filterArgs;
112
113 /* check src/dest matched passed arg. */
114 void filterSrc(filterArgs, int type, void *eventData);
115 void filterDest(filterArgs, int type, void *eventData);
116
117 /* check message type field */
118 void filterMessageType(filterArgs, int type, void *eventData);
119
120 /* parse file name (using fd to fileName mapping as needed) */
121 void filterFileName(filterArgs, int type, void *eventData);
122
123 typedef traceStream;
124 /*
125  * timestamp and write the passed trace type, and event data to the passed
126  *   trace stream.
127  *
128  */
129 void DYNINSTgenerateTraceRecord(traceStream destination, 
130                                 short type, 
131                                 short length, 
132                                 void *eventData);
133
134 /*
135  * Define the size of the per process data area.
136  *
137  *  This should be a power of two to reduce paging and chacing shifts.
138  */
139 #define SYN_INST_BUF_SIZE       256*1024
140
141 #endif