/usr/include/GTGPaje_Basic.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 467 468 469 470 471 | /**
* \file GTGPaje_Basic.h
* \version 0.1
* \brief
* paje_GTGBasic1 is the Paje implementation of the basic interface to generate traces (GTGBasic1).
*
* \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
*
*/
#ifndef _GTG_PAJE_BASIC_H_
#define _GTG_PAJE_BASIC_H_
#include "GTGBasic.h"
/**
* \brief Constant to create a paje trace
*/
#define FMT_PAJE 0
/**
* \brief Constant to create a vite trace
*/
#define FMT_VITE 1
/**
* \defgroup cpaje Paje interface in C of the GTGBasic1 API
*/
/**
* \ingroup cpaje
* \fn trace_return_t pajeInitTrace (const char* filename, int rank, gtg_flag_t flags, int fmt)
* \brief Initialize a VITE trace ( *.ept)
* \param filename Root name of the file to create
* \param rank Rank of the processor
* \param flags One of GTG_FLAG_NONE, GTG_FLAG_USE_MPI, GTG_FLAG_NOTBUF.
* \param fmt Format, paje or vite
* \return 0 if success
* An error code otherwise
*/
trace_return_t pajeInitTrace (const char* filename, int rank, gtg_flag_t flags, int fmt);
/**
* \ingroup cpaje
* \fn char* pajeGetName (int rk)
* \param rk Rank of the proc you want the filename containing it
* \brief Function to get the name of the file containing all the data for the proc of rank rk
* \return Name of the file.
*/
char* pajeGetName (int rk);
/**
* \ingroup cpaje
* \fn trace_return_t pajeSetCompress(int val)
* \brief Enable trace compression.
* \param val 0 means no compression, otherwize the output files will be compressed.
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajeSetCompress(int val);
/**
* \ingroup cpaje
* \fn trace_return_t pajeAddContType (const char* alias,
* const char* contType,
* const char* name)
* \brief Add a Container Type.
* \param alias Alias on the container
* \param contType Type of container
* \param name Name of the container type
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajeAddContType (const char* alias, const char* contType,
const char* name);
/**
* \ingroup cpaje
* \fn trace_return_t pajeAddStateType (const char* alias,
* const char* contType,
* const char* name)
* \brief Add a State Type.
* \param alias Alias on the state type
* \param contType Type of container
* \param name Name of the state type
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajeAddStateType (const char* alias, const char* contType,
const char* name);
/**
* \ingroup cpaje
* \fn trace_return_t pajeAddEventType (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
* \param name Name of the event type
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajeAddEventType (const char* alias, const char* contType,
const char* name);
/**
* \ingroup cpaje
* \fn trace_return_t pajeAddLinkType (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 Name of the link type
* \param contType Type of container
* \param srcContType Type of the source container
* \param destContType Type of the destination container
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajeAddLinkType (const char* alias , const char* name,
const char* contType, const char* srcContType,
const char* destContType);
/**
* \ingroup cpaje
* \fn trace_return_t pajeAddVarType (const char* alias,
* const char* contType,
* const char* name)
* \brief Add a Variable Type.
* \param alias Alias on the variable type
* \param contType Type of container
* \param name Name of the variable type
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajeAddVarType (const char* alias , const char* contType,
const char* name);
/**
* \ingroup cpaje
* \fn trace_return_t pajeAddEntityValue (const char* alias,
* const char* entType,
* const char* name,
* const char* color)
* \brief Add an Entity Value.
* \param alias Alias on the entity value
* \param entType Type of the entity
* \param name Name of the variable type
* \param color Color of the entity
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajeAddEntityValue (const char* alias, const char* entType,
const char* name , const char* color);
/**
* \ingroup cpaje
* \fn trace_return_t pajeAddContainer (varPrec time,
* const char * alias,
* const char * type,
* const char * container,
* const char * name,
* const char * file)
* \brief Add a Container (VITE format).
* \param time Time at which the container is added
* \param alias Alias on the new container
* \param type Type of the container
* \param container Container parent
* \param name Name of the variable type
* \param file File containing the container trace
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajeAddContainer (varPrec time, const char* alias ,
const char* type, const char* container,
const char* name, const char* file);
/**
* \ingroup cpaje
* \fn trace_return_t pajeSeqAddContainer (varPrec time,
* const char * alias,
* const char * type,
* const char * container,
* const char * name)
* \brief Add a Container (PAJE format).
* \param time Time at which the container is added
* \param alias Alias on the new container
* \param type Type of the container
* \param container Container parent
* \param name Name of the variable type
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajeSeqAddContainer (varPrec time, const char* alias ,
const char* type, const char* container,
const char* name);
/**
* \ingroup cpaje
* \fn trace_return_t pajeDestroyContainer (varPrec time,
* const char * name,
* const char * type)
* \brief Destroy a Container.
* \param time Time at which the container is destroyed
* \param name Name on the container to destroy
* \param type Type of the container
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajeDestroyContainer (varPrec time, const char* name,
const char* type);
/**
* \ingroup cpaje
* \fn trace_return_t pajeSetState (varPrec time,
* const char * type,
* const char * cont,
* const char * val)
* \brief Set the State of a Container.
* \param time Time at which the state is set
* \param type Type of the state
* \param cont Container in this state
* \param val Entity value of the state of the container
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajeSetState (varPrec time, const char* type,
const char* cont, const char* val);
/**
* \ingroup cpaje
* \fn trace_return_t pajePushState (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 at which the state is pushed
* \param type Type of the state
* \param cont Container in this state
* \param val Entity value of the state of the container
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajePushState (varPrec time, const char* type,
const char* cont, const char* val);
/**
* \ingroup cpaje
* \fn trace_return_t pajePopState (varPrec time,
* const char * type,
* const char * cont)
* \brief Revert the State of a Container to its previous value.
* \param time Time at which the state is poped
* \param type Type of the state
* \param cont Container in this state
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajePopState (varPrec time, const char* type,
const char* cont);
/**
* \ingroup cpaje
* \fn trace_return_t pajeAddEvent (varPrec time,
* const char * type,
* const char * cont,
* const char * val)
* \brief Add an Event.
* \param time Time at which the event happens
* \param type Type of the event
* \param cont Container in this event
* \param val Entity value of the event of the container
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajeAddEvent (varPrec time, const char* type,
const char* cont, const char* val);
/**
* \ingroup cpaje
* \fn trace_return_t pajeStartLink (varPrec time,
* const char * type,
* const char * cont,
* const char * src,
* const char * val,
* const char * key)
* \brief Start a link
* \param time Time at which the link starts
* \param type Type of the link
* \param cont Container parent of the source and destination containers containing the link
* \param src Source container
* \param val Value of the link
* \param key Key used to match start link with end link
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajeStartLink (varPrec time, const char* type,
const char* cont, const char* src,
const char* val , const char* key);
/**
* \ingroup cpaje
* \fn trace_return_t pajeEndLink (varPrec time,
* const char * type,
* const char * cont,
* const char * dest,
* const char * val,
* const char * key)
* \brief Start a link
* \param time Time at which the link starts
* \param type Type of the link
* \param cont Container parent of the source and destination containers containing the link
* \param dest Source container
* \param val Value of the link
* \param key Key used to match start link with end link
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajeEndLink (varPrec time, const char* type,
const char* cont, const char* dest,
const char* val , const char* key);
/**
* \ingroup cpaje
* \fn trace_return_t pajeSetVar (varPrec time,
* const char * type,
* const char * cont,
* varPrec val)
* \brief Set a Variable value
* \param time Time at which the variable is set
* \param type Type of the variable
* \param cont Container containing the variable
* \param val Value of the variable
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajeSetVar (varPrec time, const char* type,
const char* cont, varPrec val);
/**
* \ingroup cpaje
* \fn trace_return_t pajeAddVar (varPrec time,
* const char * type,
* const char * cont,
* varPrec val)
* \brief Add a value to a Variable.
* \param time Time at which the variable is incremented
* \param type Type of the variable
* \param cont Container containing the variable
* \param val Value added
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajeAddVar (varPrec time, const char* type,
const char* cont, varPrec val);
/**
* \ingroup cpaje
* \fn trace_return_t pajeSubVar (varPrec time,
* const char * type,
* const char * cont,
* varPrec val)
* \brief Substract a value from a Variable.
* \param time Time at which the variable is incremented
* \param type Type of the variable
* \param cont Container containing the variable
* \param val Value substracted
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajeSubVar (varPrec time, const char* type,
const char* cont, varPrec val);
/**
* \ingroup cpaje
* \fn trace_return_t pajeAddComment (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 pajeAddComment (const char* comment);
/**
* \ingroup cpaje
* \fn pajeEndTrace ()
* \brief Finalize a PAJE trace.
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t pajeEndTrace ();
/**
* \ingroup cpaje
* \fn viteEndTrace ()
* \brief Finalize a VITE trace.
* \return 0 if success \n
* An error code otherwise
*/
trace_return_t viteEndTrace ();
/*
* Functions to handle extra-parameters in the Paje Definitions
* This will need to be cleaned to be closer to OTF interface
*/
enum gtg_paje_evtdef_e {
GTG_PAJE_EVTDEF_DefineContainerType,
GTG_PAJE_EVTDEF_DefineStateType,
GTG_PAJE_EVTDEF_DefineEventType,
GTG_PAJE_EVTDEF_DefineVariableType,
GTG_PAJE_EVTDEF_DefineLinkType,
GTG_PAJE_EVTDEF_DefineEntityValue,
GTG_PAJE_EVTDEF_CreateContainer,
GTG_PAJE_EVTDEF_DestroyContainer,
GTG_PAJE_EVTDEF_SetState,
GTG_PAJE_EVTDEF_PushState,
GTG_PAJE_EVTDEF_PopState,
GTG_PAJE_EVTDEF_ResetState,
GTG_PAJE_EVTDEF_NewEvent,
GTG_PAJE_EVTDEF_SetVariable,
GTG_PAJE_EVTDEF_AddVariable,
GTG_PAJE_EVTDEF_SubVariable,
GTG_PAJE_EVTDEF_StartLink,
GTG_PAJE_EVTDEF_EndLink,
GTG_PAJE_EVTDEF_NBR
};
enum gtg_paje_fieldtype_e {
GTG_PAJE_FIELDTYPE_Int,
GTG_PAJE_FIELDTYPE_Hex,
GTG_PAJE_FIELDTYPE_Date,
GTG_PAJE_FIELDTYPE_Double,
GTG_PAJE_FIELDTYPE_String,
GTG_PAJE_FIELDTYPE_Color,
GTG_PAJE_FIELDTYPE_NBR
};
struct gtg_paje_edp_s {
struct gtg_paje_edp_s *next;
char *name;
enum gtg_paje_fieldtype_e type;
};
typedef struct gtg_paje_edp_s gtg_paje_edp_t;
struct gtg_paje_eventdef_s {
char *name;
int id;
gtg_paje_edp_t *first;
gtg_paje_edp_t *last;
};
typedef struct gtg_paje_eventdef_s gtg_paje_eventdef_t;
extern gtg_paje_eventdef_t paje_eventdefs[GTG_PAJE_EVTDEF_NBR];
void pajeEventDefAddParam( enum gtg_paje_evtdef_e event, const char *name,
enum gtg_paje_fieldtype_e type );
#endif /* _GTG_PAJE_BASIC_H_ */
|