include/instr/instr.h

   1 /* Copyright (c) 2010. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef INSTR_H_
   8 #define INSTR_H_
   9
  10 #include "simgrid_config.h"
  11
  12 #ifdef HAVE_TRACING
  13
  14 #include "xbt.h"
  15 #include "msg/msg.h"
  16
  17 /* Trace error codes (used in exceptions) */
  18 #define TRACE_ERROR_COMPLEX_ROUTES 100
  19 #define TRACE_ERROR_TYPE_NOT_DEFINED 200
  20 #define TRACE_ERROR_TYPE_ALREADY_DEFINED 201
  21 #define TRACE_ERROR_CATEGORY_NOT_DEFINED 300
  22 #define TRACE_ERROR_CATEGORY_ALREADY_DEFINED 301
  23 #define TRACE_ERROR_MASK 400
  24 #define TRACE_ERROR_FILE_OPEN 401
  25 #define TRACE_ERROR_START 500
  26
  27 XBT_PUBLIC(int) TRACE_start (void);
  28 XBT_PUBLIC(int) TRACE_end (void);
  29 XBT_PUBLIC(int) TRACE_category (const char *category);
  30 XBT_PUBLIC(void) TRACE_define_type (const char *type, const char *parent_type, int final);
  31 XBT_PUBLIC(int) TRACE_create_category (const char *category, const char *type, const char *parent_category);
  32 XBT_PUBLIC(void) TRACE_msg_set_task_category (m_task_t task, const char *category);
  33 XBT_PUBLIC(void) TRACE_msg_set_process_category (m_process_t process, const char *category);
  34 XBT_PUBLIC(void) TRACE_set_mask (int mask);
  35 XBT_PUBLIC(void) TRACE_user_host_variable (double time, const char *variable, double value, const char *what);
  36 XBT_PUBLIC(void) TRACE_user_link_variable (double time, const char *src, const char *dst, const char *variable, double value, const char *what);
  37 XBT_PUBLIC(void) TRACE_declare_mark (const char *mark_type);
  38 XBT_PUBLIC(void) TRACE_mark (const char *mark_type, const char *mark_value);
  39 XBT_PUBLIC(int) TRACE_smpi_set_category (const char *category);
  40
  41 #define TRACE_host_variable_declare(var) \
  42         TRACE_user_host_variable(0,var,0,"declare");
  43
  44 #define TRACE_host_variable_set_with_time(time,var,value) \
  45         TRACE_user_host_variable(time,var,value,"set");
  46
  47 #define TRACE_host_variable_add_with_time(time,var,value) \
  48         TRACE_user_host_variable(time,var,value,"add");
  49
  50 #define TRACE_host_variable_sub_with_time(time,var,value) \
  51         TRACE_user_host_variable(time,var,value,"sub");
  52
  53 #define TRACE_host_variable_set(var,value) \
  54         TRACE_user_host_variable(MSG_get_clock(),var,value,"set");
  55
  56 #define TRACE_host_variable_add(var,value) \
  57         TRACE_user_host_variable(MSG_get_clock(),var,value,"add");
  58
  59 #define TRACE_host_variable_sub(var,value) \
  60         TRACE_user_host_variable(MSG_get_clock(),var,value,"sub");
  61
  62 #define TRACE_link_variable_declare(var) \
  63         TRACE_user_link_variable(0,NULL,NULL,var,0,"declare");
  64
  65 #define TRACE_link_variable_set_with_time(time,src,dst,var,value) \
  66         TRACE_user_link_variable(time,src,dst,var,value,"set");
  67
  68 #define TRACE_link_variable_add_with_time(time,src,dst,var,value) \
  69         TRACE_user_link_variable(time,src,dst,var,value,"add");
  70
  71 #define TRACE_link_variable_sub_with_time(time,src,dst,var,value) \
  72         TRACE_user_link_variable(time,src,dst,var,value,"sub");
  73
  74 #define TRACE_link_variable_set(src,dst,var,value) \
  75         TRACE_user_link_variable(MSG_get_clock(),src,dst,var,value,"set");
  76
  77 #define TRACE_link_variable_add(src,dst,var,value) \
  78         TRACE_user_link_variable(MSG_get_clock(),src,dst,var,value,"add");
  79
  80 #define TRACE_link_variable_sub(src,dst,var,value) \
  81         TRACE_user_link_variable(MSG_get_clock(),src,dst,var,value,"sub");
  82
  83 #else /* HAVE_TRACING */
  84
  85 #define TRACE_start()
  86 #define TRACE_end()
  87 #define TRACE_category(cat)
  88 #define TRACE_define_type(cat,supercat,final)
  89 #define TRACE_create_category(inst,cat)
  90 #define TRACE_msg_set_task_category(task,cat)
  91 #define TRACE_msg_set_process_category(proc,cat)
  92 #define TRACE_set_mask(mask)
  93
  94 #define TRACE_host_variable_declare(var)
  95 #define TRACE_host_variable_set_with_time(time,var,value)
  96 #define TRACE_host_variable_add_with_time(time,var,value)
  97 #define TRACE_host_variable_sub_with_time(time,var,value)
  98 #define TRACE_host_variable_set(var,value)
  99 #define TRACE_host_variable_add(var,value)
 100 #define TRACE_host_variable_sub(var,value)
 101 #define TRACE_link_variable_declare(var)
 102 #define TRACE_link_variable_set_with_time(time,src,dst,var,value)
 103 #define TRACE_link_variable_add_with_time(time,src,dst,var,value)
 104 #define TRACE_link_variable_sub_with_time(time,src,dst,var,value)
 105 #define TRACE_link_variable_set(src,dst,var,value)
 106 #define TRACE_link_variable_add(src,dst,var,value)
 107 #define TRACE_link_variable_sub(src,dst,var,value)
 108 #define TRACE_declare_mark(type)
 109 #define TRACE_mark(type,value)
 110 #define TRACE_smpi_set_category(cat)
 111
 112 #endif /* HAVE_TRACING */
 113
 114 #endif /* INSTR_H_ */