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      snapShot;       /* used to get consistant value during st/stp */
  69     int         normalize;      /* value to divide total by to get seconds */
  70     timerType   type;
  71     sampleId    id;
  72     volatile int mutex;
  73 };
  74
  75
  76 /*
  77  * standard inst. functions.
  78  *
  79  */
  80
  81 /*
  82  * start a timer.
  83  */
  84 void DYNINSTstartTimer(tTimer *timer);
  85
  86 void DYNINSTstopTimer(tTimer *timer);
  87
  88 /*
  89  * increment the passed counter by one.
  90  *
  91  */
  92 void DYNINSTincremmentCounter(intCounter*);
  93
  94 /*
  95  * decrement the passed counter by one.
  96  *
  97  */
  98 void DYNINSTdecrementCounter(intCounter*);
  99
 100 /*
 101  * Special purpose inst functiions that use trace type specific data.
 102  *
 103  */
 104
 105 /* add bytes field to passed counter */
 106 void addBytesCounter(intCounter *data);
 107
 108 typedef struct {
 109     void *filterData;           /* data to filter on */
 110     instFunc toCall;            /* function to call if it passes filter */
 111     void *callData;             /* data to pass to toCall if it is called */
 112 } filterArgs;
 113
 114 /* check src/dest matched passed arg. */
 115 void filterSrc(filterArgs, int type, void *eventData);
 116 void filterDest(filterArgs, int type, void *eventData);
 117
 118 /* check message type field */
 119 void filterMessageType(filterArgs, int type, void *eventData);
 120
 121 /* parse file name (using fd to fileName mapping as needed) */
 122 void filterFileName(filterArgs, int type, void *eventData);
 123
 124 typedef traceStream;
 125 /*
 126  * timestamp and write the passed trace type, and event data to the passed
 127  *   trace stream.
 128  *
 129  */
 130 void DYNINSTgenerateTraceRecord(traceStream destination,
 131                                 short type,
 132                                 short length,
 133                                 void *eventData);
 134
 135 /*
 136  * Define the size of the per process data area.
 137  *
 138  *  This should be a power of two to reduce paging and chacing shifts.
 139  */
 140 #define SYN_INST_BUF_SIZE       256*1024
 141
 142 #endif