/usr/include/GTGBasic.h is in libgtg-dev 0.2-2+dfsg-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 | /**
* \file GTGBasic.h
* \version 0.1
* \brief
*
* GTGBasic is a basic interface to generate trace in various formats.
*
* \authors
* Developers are : \n
* Francois Rue - francois.rue@labri.fr \n
* Francois Trahay - francois.trahay@labri.fr \n
* Johnny Jazeix - jazeix@enseirb-matmeca.fr \n
* Kevin Coulomb - kevin.coulomb@gmail.com \n
* Mathieu Faverge - faverge@labri.fr \n
* Olivier Lagrasse - lagrasse@enseirb-matmeca.fr \n
*
* It has been initiated in 2010 by *eztrace* and *ViTE* projects
* that both needs a good library to generate traces.
*
*/
#ifndef _GTG_BASIC_H_
#define _GTG_BASIC_H_
#include <stdlib.h>
#include <string.h>
#include "GTGColor.h"
#include "GTGTypes.h"
/**
* \brief No flag specified.
*/
#define GTG_FLAG_NONE 0
/**
* \brief Several MPI processes are currently using GTG.
*/
#define GTG_FLAG_USE_MPI 1
/**
* \brief For writing the traces in a non-buffered mode.
*/
#define GTG_FLAG_NOTBUF 2
/**
* \brief Allow the application to record events out of order
*/
#define GTG_FLAG_OUTOFORDER 4
/**
* \brief Flags that can be specified to GTG.
*/
typedef uint8_t gtg_flag_t;
/**
* \defgroup traceType Trace type handler
*/
/**
* \ingroup traceType
* \enum traceType
* \brief The type of the output trace.
*
*/
typedef enum traceType{
PAJE, /*!< Paje trace format. */
VITE, /*!< ViTE-specific trace format. */
OTF, /*!< OTF trace format. */
TAU /*!< TAU Trace format. */
}traceType_t;
/**
* \ingroup traceType
* \fn void setTraceType (traceType_t type)
* \brief Set the type of output trace.
* \param type Type of trace to generate
*/
void setTraceType (traceType_t type);
/**
* \ingroup traceType
* \fn traceType_t getTraceType ()
* \brief Get the type of the output trace.
* \return The type of the trace
*/
traceType_t getTraceType ();
/**
* \ingroup traceType
* \fn traceType_t getName (int procRk)
* \param procRk Rank of the proc to get the file containing it
* \brief To get the name of the file to give to the addCont function for processors
* \return The name of the file to give for a proc
*/
char* getName (int procRk);
/**
* \ingroup traceType
* \fn int bufferedModeActivated()
* \brief Check wether the buffered-mode is activated.
* \return 1 is the buffered-mode is activate.\n
* 0 otherwise.
*/
int bufferedModeActivated();
/**
* \defgroup init To init the generated trace file(s)
*/
/**
* \ingroup init
* \fn int initTrace (const char* filename, int rank, gtg_flag_t flags)
* \brief Initialize a trace.
* \param filename Root name of the file to create
* \param rank Process number of the file to create
* \param flags One of GTG_FLAG_NONE, GTG_FLAG_USE_MPI, GTG_FLAG_NOTBUF.
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t initTrace (const char* filename, int rank, gtg_flag_t flags);
/**
* \ingroup init
* \fn trace_return_t endTrace ()
* \brief Finalize a trace.
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t endTrace ();
/**
* \ingroup init
* \fn trace_return_t setCompress (int val)
* \brief Enable trace compression (only available for OTF traces).
* \param val 0 means no compression, otherwize the output files will be compressed
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t setCompress (int val);
/**
* \defgroup procf Functions related to the containers
*/
/**
* \ingroup procf
* \fn trace_return_t addContType (const char* alias,
* const char* contType,
* const char* name)
* \brief Add a Container Type.
* \param alias Alias on the container added
* \param contType Type of the parent container
* \param name Alternative name of the new container type
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t addContType (const char* alias, const char* contType,
const char* name);
/**
* \defgroup statef Functions related to the states
*/
/**
* \ingroup statef
* \fn trace_return_t addStateType (const char* alias,
* const char* contType,
* const char* name)
* \brief Add a State Type.
* \param alias Alias on the state type added
* \param contType Type of container of these states
* \param name Alternative name of the state type
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t addStateType (const char* alias, const char* contType,
const char* name);
/**
* \defgroup eventf Functions related to the events
*/
/**
* \ingroup eventf
* \fn trace_return_t addEventType (const char* alias,
* const char* contType,
* const char* name)
* \brief Add an Event Type.
* \param alias Alias on the event type
* \param contType Type of container of these events
* \param name Alternative name of the event type
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t addEventType (const char* alias, const char* contType,
const char* name);
/**
* \defgroup linkf Functions related to links
*/
/**
* \ingroup linkf
* \fn trace_return_t addLinkType (const char* alias,
* const char* name,
* const char* contType,
* const char* srcContType,
* const char* destContType);
* \brief Add a Link Type.
* \param alias Alias on the link type
* \param name Alternative name of the link type
* \param contType Type of common ancestral container
* \param srcContType Type of the source container
* \param destContType Type of the destination container
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t addLinkType (const char* alias , const char* name,
const char* contType, const char* srcContType,
const char* destContType);
/**
* \defgroup varf Functions related to variables
*/
/**
* \ingroup varf
* \fn trace_return_t addVarType (const char* alias,
* const char* name,
* const char* contType)
* \brief Add a Variable Type.
* \param alias Alias on the variable type
* \param contType Type of container
* \param name Alternative name of the variable type
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t addVarType (const char* alias , const char* name,
const char* contType);
/**
* \ingroup init
* \fn trace_return_t addEntityValue (const char* alias,
* const char* entType,
* const char* name,
* gtg_color_t p_color)
* \brief Add an Entity Value.
* \param alias Alias on the entity value
* \param entType Type of the entity that can have the value
* \param name Alternative name of the variable type
* \param p_color Color of the entity
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t addEntityValue (const char* alias, const char* entType,
const char* name , gtg_color_t p_color);
/**
* \ingroup procf
* \fn trace_return_t addContainer (varPrec time,
* const char * alias,
* const char * type,
* const char * container,
* const char * name,
* const char * file)
* \brief Add a Container.
* \param time Time at which the container is added
* \param alias Alias of the new container
* \param type Type of the new container
* \param container Container parent
* \param name Alternative name of the variable type
* \param file File containing the container for vite format. Use "0" or "" chains for other formats.
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t addContainer (varPrec time, const char* alias ,
const char* type, const char* container,
const char* name, const char* file);
/**
* \ingroup procf
* \fn trace_return_t destroyContainer (varPrec time,
* const char * name,
* const char * type)
* \brief Destroy a Container.
* \param time Time at which the container is destroyed
* \param name Name of the container
* \param type Type of the container
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t destroyContainer (varPrec time, const char* name,
const char* type);
/**
* \ingroup statef
* \fn trace_return_t setState (varPrec time,
* const char * type,
* const char * cont,
* const char * val)
* \brief Set the State of a Container.
* \param time Time the state changes
* \param type Type of the state
* \param cont Container whose state changes
* \param val Value of new state of container
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t setState (varPrec time, const char* type,
const char* cont, const char* val);
/**
* \ingroup statef
* \fn trace_return_t pushState (varPrec time,
* const char * type,
* const char * cont,
* const char * val)
* \brief Save the current State on a stack and change the State of a Container.
* \param time Time the state changes
* \param type Type of the state
* \param cont Container whose state changes
* \param val Value of state of container
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t pushState (varPrec time, const char* type,
const char* cont, const char* val);
/**
* \ingroup statef
* \fn trace_return_t popState (varPrec time,
* const char * type,
* const char * cont)
* \brief Revert the State of a Container to its previous value.
* \param time Time the state changes
* \param type Type of the state
* \param cont Container whose state changes
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t popState (varPrec time, const char* type,
const char* cont);
/**
* \ingroup eventf
* \fn trace_return_t addEvent (varPrec time,
* const char * type,
* const char * cont,
* const char * val)
* \brief Add an Event.
* \param time Time the event happens
* \param type Type of the event
* \param cont Container that produced the event
* \param val Value of the new event
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t addEvent (varPrec time, const char* type,
const char* cont, const char* val);
/**
* \ingroup linkf
* \fn trace_return_t startLink (varPrec time,
* const char * type,
* const char * cont,
* const char * src,
* const char * dest,
* const char * val,
* const char * key)
* \brief Start a Link.
* \param time Time the link starts
* \param type Type of the link
* \param cont Container containing the link (an ancestor of source and destination container)
* \param src Source container
* \param dest Destination container
* \param val Value of the link
* \param key Key to match the end link
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t startLink (varPrec time, const char* type,
const char* cont, const char* src,
const char* dest, const char* val,
const char* key);
/**
* \ingroup linkf
* \fn trace_return_t endLink (varPrec time,
* const char * type,
* const char * cont,
* const char * src,
* const char * dest,
* const char * val,
* const char * key)
* \brief End a Link.
* \param time Time the link ends
* \param type Type of the link
* \param cont Container containing the link (an ancestor of source and destination container)
* \param src Source container
* \param dest Destination container
* \param val Value of the link
* \param key Key to match the start link
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t endLink (varPrec time, const char* type,
const char* cont, const char* src,
const char* dest, const char* val,
const char* key);
/**
* \ingroup varf
* \fn trace_return_t setVar (varPrec time,
* const char * type,
* const char * cont,
* varPrec val)
* \brief Set a Variable value.
* \param time Time the variable changes
* \param type Type of the variable
* \param cont Container containing the variable
* \param val New value of the variable
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t setVar (varPrec time, const char* type,
const char* cont, varPrec val);
/**
* \ingroup varf
* \fn trace_return_t addVar (varPrec time,
* const char * type,
* const char * cont,
* varPrec val)
* \brief Add a value to a Variable.
* \param time Time the variable is incremented
* \param type Type of the variable
* \param cont Container containing the variable
* \param val Value added
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t addVar (varPrec time, const char* type,
const char* cont, varPrec val);
/**
* \ingroup varf
* \fn trace_return_t subVar (varPrec time,
* const char * type,
* const char * cont,
* varPrec val)
* \brief Substract a value from a Variable.
* \param time Time the variable is incremented
* \param type Type of the variable
* \param cont Container containing the variable
* \param val Value substracted
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t subVar (varPrec time, const char* type,
const char* cont, varPrec val);
/**
* \ingroup procf
* \fn trace_return_t AddComment (const char* comment)
*
* \brief Add some Comment in Trace file.
* \param comment Comment to be added
* \return TRACE_SUCCESS on success \n
* An error code otherwise
*/
trace_return_t AddComment (const char* comment);
#endif /* _GTG_BASIC_H_ */
|