[97] | 1 | /* |
---|
| 2 | This is part of the OTF library. Copyright by ZIH, TU Dresden 2005-2008. |
---|
| 3 | Authors: Andreas Knuepfer, Holger Brunst, Ronny Brendel, Thomas Kriebitzsch |
---|
| 4 | */ |
---|
| 5 | |
---|
| 6 | /** |
---|
| 7 | * @file OTF_Definitions.h |
---|
| 8 | * |
---|
| 9 | * @brief Provides many many macros for different purposes. |
---|
| 10 | * |
---|
| 11 | * \ingroup misc |
---|
| 12 | */ |
---|
| 13 | |
---|
| 14 | |
---|
| 15 | #ifndef OTF_DEFINITIONS_H |
---|
| 16 | #define OTF_DEFINITIONS_H |
---|
| 17 | |
---|
| 18 | |
---|
| 19 | /* version information */ |
---|
| 20 | |
---|
| 21 | #define OTF_VERSION_MAYOR 1 |
---|
| 22 | #define OTF_VERSION_MINOR 3 |
---|
| 23 | #define OTF_VERSION_SUB 12 |
---|
| 24 | #define OTF_VERSION_STRING "jellyfish" |
---|
| 25 | |
---|
| 26 | /* version history: |
---|
| 27 | |
---|
| 28 | 0.2.1 "octopussy" |
---|
| 29 | 0.3.1 "starfish" |
---|
| 30 | 0.3.2 "starfish" |
---|
| 31 | 0.4.0 "starfish" |
---|
| 32 | 0.4.1 "starfish" |
---|
| 33 | 0.5.0 "starfish" |
---|
| 34 | 1.0.* "starfish" |
---|
| 35 | 1.1.* "starfish" |
---|
| 36 | 1.2.* "pufferfish" |
---|
| 37 | 1.3.* "jellyfish" |
---|
| 38 | |
---|
| 39 | */ |
---|
| 40 | |
---|
| 41 | |
---|
| 42 | /* definitions of record type identifiers */ |
---|
| 43 | |
---|
| 44 | |
---|
| 45 | /* Event records*/ |
---|
| 46 | |
---|
| 47 | #define OTF_EVENTCOMMENT_RECORD 0 |
---|
| 48 | #define OTF_COUNTER_RECORD 1 |
---|
| 49 | #define OTF_ENTER_RECORD 2 |
---|
| 50 | |
---|
| 51 | #define OTF_COLLOP_RECORD 5 |
---|
| 52 | |
---|
| 53 | #define OTF_RECEIVE_RECORD 10 |
---|
| 54 | #define OTF_SEND_RECORD 11 |
---|
| 55 | #define OTF_LEAVE_RECORD 12 |
---|
| 56 | |
---|
| 57 | #define OTF_BEGINPROCESS_RECORD 35 |
---|
| 58 | #define OTF_ENDPROCESS_RECORD 36 |
---|
| 59 | |
---|
| 60 | #define OTF_FILEOPERATION_RECORD 42 |
---|
| 61 | |
---|
| 62 | /* Definition records*/ |
---|
| 63 | |
---|
| 64 | #define OTF_DEFTIMERRESOLUTION_RECORD 13 |
---|
| 65 | #define OTF_DEFPROCESS_RECORD 14 |
---|
| 66 | #define OTF_DEFPROCESSGROUP_RECORD 15 |
---|
| 67 | #define OTF_DEFFUNCTION_RECORD 16 |
---|
| 68 | #define OTF_DEFFUNCTIONGROUP_RECORD 17 |
---|
| 69 | #define OTF_DEFCOUNTER_RECORD 18 |
---|
| 70 | #define OTF_DEFCOUNTERGROUP_RECORD 19 |
---|
| 71 | #define OTF_DEFCOLLOP_RECORD 20 |
---|
| 72 | #define OTF_DEFSCL_RECORD 21 |
---|
| 73 | #define OTF_DEFSCLFILE_RECORD 22 |
---|
| 74 | #define OTF_DEFVERSION_RECORD 23 |
---|
| 75 | #define OTF_DEFCREATOR_RECORD 24 |
---|
| 76 | #define OTF_DEFFILE_RECORD 25 |
---|
| 77 | #define OTF_DEFFILEGROUP_RECORD 26 |
---|
| 78 | |
---|
| 79 | |
---|
| 80 | #define OTF_FUNCTIONSUMMARY_RECORD 28 |
---|
| 81 | #define OTF_FUNCTIONGROUPSUMMARY_RECORD 29 |
---|
| 82 | #define OTF_MESSAGESUMMARY_RECORD 30 |
---|
| 83 | #define OTF_FILEOPERATIONSUMMARY_RECORD 31 |
---|
| 84 | #define OTF_FILEGROUPOPERATIONSUMMARY_RECORD 32 |
---|
| 85 | |
---|
| 86 | #define OTF_DEFINITIONCOMMENT_RECORD 34 |
---|
| 87 | |
---|
| 88 | #define OTF_ENTERSNAPSHOT_RECORD 37 |
---|
| 89 | #define OTF_SENDSNAPSHOT_RECORD 38 |
---|
| 90 | |
---|
| 91 | #define OTF_SUMMARYCOMMENT_RECORD 39 |
---|
| 92 | #define OTF_SNAPSHOTCOMMENT_RECORD 40 |
---|
| 93 | #define OTF_OPENFILESNAPSHOT_RECORD 43 |
---|
| 94 | |
---|
| 95 | #define OTF_UNKNOWN_RECORD 41 |
---|
| 96 | |
---|
| 97 | |
---|
| 98 | /* Number of records */ |
---|
| 99 | #define OTF_NRECORDS 44 |
---|
| 100 | |
---|
| 101 | /* Stream format definition */ |
---|
| 102 | |
---|
| 103 | #define OTF_WSTREAM_FORMAT_SHORT 0 |
---|
| 104 | #define OTF_WSTREAM_FORMAT_LONG 1 |
---|
| 105 | |
---|
| 106 | |
---|
| 107 | /* Counter properties */ |
---|
| 108 | |
---|
| 109 | /* 1st-2nd bit */ |
---|
| 110 | #define OTF_COUNTER_TYPE_BITS 3 |
---|
| 111 | #define OTF_COUNTER_TYPE_ACC 0 |
---|
| 112 | #define OTF_COUNTER_TYPE_ABS 1 |
---|
| 113 | |
---|
| 114 | /* 3rd-4th bit */ |
---|
| 115 | #define OTF_COUNTER_SCOPE_BITS 12 |
---|
| 116 | #define OTF_COUNTER_SCOPE_START 0 |
---|
| 117 | #define OTF_COUNTER_SCOPE_POINT 4 |
---|
| 118 | #define OTF_COUNTER_SCOPE_LAST 8 |
---|
| 119 | #define OTF_COUNTER_SCOPE_NEXT 12 |
---|
| 120 | |
---|
| 121 | /* 6th-9th bit */ |
---|
| 122 | #define OTF_COUNTER_VARTYPE_ISINTEGER(x) (x < 256) |
---|
| 123 | #define OTF_COUNTER_VARTYPE_ISSIGNED(x) ((x&32) == 32) |
---|
| 124 | #define OTF_COUNTER_VARTYPE_ISUNSIGNED(x) ((x&32) == 0) |
---|
| 125 | |
---|
| 126 | #define OTF_COUNTER_VARTYPE_BITS 480 /* 1111xxxxx */ |
---|
| 127 | #define OTF_COUNTER_VARTYPE_UNSIGNED8 0 /* 0000 */ |
---|
| 128 | #define OTF_COUNTER_VARTYPE_SIGNED8 32 /* 00001 */ |
---|
| 129 | #define OTF_COUNTER_VARTYPE_UNSIGNED4 64 /* 0010 */ |
---|
| 130 | #define OTF_COUNTER_VARTYPE_SIGNED4 96 /* 0011 */ |
---|
| 131 | #define OTF_COUNTER_VARTYPE_UNSIGNED2 128 /* 0100 */ |
---|
| 132 | #define OTF_COUNTER_VARTYPE_SIGNED2 160 /* 0101 */ |
---|
| 133 | #define OTF_COUNTER_VARTYPE_FLOAT 256 /* 1000 */ |
---|
| 134 | #define OTF_COUNTER_VARTYPE_DOUBLE 288 /* 1001 */ |
---|
| 135 | |
---|
| 136 | |
---|
| 137 | |
---|
| 138 | #define OTF_COUNTER_PROP_DEFAULT 0 |
---|
| 139 | |
---|
| 140 | |
---|
| 141 | /* Types of collective operations */ |
---|
| 142 | |
---|
| 143 | #define OTF_COLLECTIVE_TYPE_UNKNOWN 0 |
---|
| 144 | #define OTF_COLLECTIVE_TYPE_BARRIER 1 |
---|
| 145 | #define OTF_COLLECTIVE_TYPE_ONE2ALL 2 |
---|
| 146 | #define OTF_COLLECTIVE_TYPE_ALL2ONE 3 |
---|
| 147 | #define OTF_COLLECTIVE_TYPE_ALL2ALL 4 |
---|
| 148 | |
---|
| 149 | |
---|
| 150 | /* File Operations */ |
---|
| 151 | #define OTF_FILEOP_OPEN 0 |
---|
| 152 | #define OTF_FILEOP_CLOSE 1 |
---|
| 153 | #define OTF_FILEOP_READ 2 |
---|
| 154 | #define OTF_FILEOP_WRITE 3 |
---|
| 155 | #define OTF_FILEOP_SEEK 4 |
---|
| 156 | |
---|
| 157 | |
---|
| 158 | /* return values for handlers. they are not yet evaluated!!! */ |
---|
| 159 | |
---|
| 160 | /** When writing an own handler, use these macros to tell OTF, what to do. |
---|
| 161 | if you return OTF_RETURN_OK OTF continues reading the trace and calling the |
---|
| 162 | appropriate handlers. If you return OTF_RETURN_BREAK or OTF_RETURN_ABORT OTF |
---|
| 163 | stops reading immediately */ |
---|
| 164 | #define OTF_RETURN_OK 0 |
---|
| 165 | /** @see OTF_RETURN_OK */ |
---|
| 166 | #define OTF_RETURN_BREAK 1 |
---|
| 167 | /** @see OTF_RETURN_OK */ |
---|
| 168 | #define OTF_RETURN_ABORT 1 |
---|
| 169 | |
---|
| 170 | #define OTF_READ_ERROR (uint64_t)-1 |
---|
| 171 | #define OTF_READ_MAXRECORDS (uint64_t)-2 |
---|
| 172 | |
---|
| 173 | #endif /* OTF_DEFINITIONS_H */ |
---|