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 #include "simdag/simdag.h"
  17
  18 /* Trace error codes (used in exceptions) */
  19 #define TRACE_ERROR_COMPLEX_ROUTES 100
  20 #define TRACE_ERROR_TYPE_NOT_DEFINED 200
  21 #define TRACE_ERROR_TYPE_ALREADY_DEFINED 201
  22 #define TRACE_ERROR_CATEGORY_NOT_DEFINED 300
  23 #define TRACE_ERROR_CATEGORY_ALREADY_DEFINED 301
  24 #define TRACE_ERROR_MASK 400
  25 #define TRACE_ERROR_FILE_OPEN 401
  26 #define TRACE_ERROR_START 500
  27
  28 XBT_PUBLIC(int) TRACE_start(void);
  29 XBT_PUBLIC(int) TRACE_end(void);
  30 XBT_PUBLIC(int) TRACE_category(const char *category);
  31 XBT_PUBLIC(int) TRACE_category_with_color (const char *category, const char *color);
  32 XBT_PUBLIC(void) TRACE_define_type(const char *type,
  33                                    const char *parent_type, int final);
  34 XBT_PUBLIC(int) TRACE_create_category(const char *category,
  35                                       const char *type,
  36                                       const char *parent_category);
  37 XBT_PUBLIC(int) TRACE_create_category_with_color(const char *category,
  38                           const char *type,
  39                           const char *parent_category,
  40                           const char *color);
  41 XBT_PUBLIC(void) TRACE_msg_set_task_category(m_task_t task,
  42                                              const char *category);
  43 XBT_PUBLIC(void) TRACE_msg_set_process_category(m_process_t process,
  44                                                 const char *category);
  45 XBT_PUBLIC(void) TRACE_set_mask(int mask);
  46 XBT_PUBLIC(void) TRACE_user_host_variable(double time,
  47                                           const char *variable,
  48                                           double value, const char *what);
  49 XBT_PUBLIC(void) TRACE_user_link_variable(double time, const char *src,
  50                                           const char *dst,
  51                                           const char *variable,
  52                                           double value, const char *what);
  53 XBT_PUBLIC(void) TRACE_declare_mark(const char *mark_type);
  54 XBT_PUBLIC(void) TRACE_mark(const char *mark_type, const char *mark_value);
  55 XBT_PUBLIC(int) TRACE_smpi_set_category(const char *category);
  56 XBT_PUBLIC(void) TRACE_sd_set_task_category(SD_task_t task,
  57                                             const char *category);
  58
  59 #define TRACE_host_variable_declare(var) \
  60         TRACE_user_host_variable(0,var,0,"declare");
  61
  62 #define TRACE_host_variable_set_with_time(time,var,value) \
  63         TRACE_user_host_variable(time,var,value,"set");
  64
  65 #define TRACE_host_variable_add_with_time(time,var,value) \
  66         TRACE_user_host_variable(time,var,value,"add");
  67
  68 #define TRACE_host_variable_sub_with_time(time,var,value) \
  69         TRACE_user_host_variable(time,var,value,"sub");
  70
  71 #define TRACE_host_variable_set(var,value) \
  72         TRACE_user_host_variable(MSG_get_clock(),var,value,"set");
  73
  74 #define TRACE_host_variable_add(var,value) \
  75         TRACE_user_host_variable(MSG_get_clock(),var,value,"add");
  76
  77 #define TRACE_host_variable_sub(var,value) \
  78         TRACE_user_host_variable(MSG_get_clock(),var,value,"sub");
  79
  80 #define TRACE_link_variable_declare(var) \
  81         TRACE_user_link_variable(0,NULL,NULL,var,0,"declare");
  82
  83 #define TRACE_link_variable_set_with_time(time,src,dst,var,value) \
  84         TRACE_user_link_variable(time,src,dst,var,value,"set");
  85
  86 #define TRACE_link_variable_add_with_time(time,src,dst,var,value) \
  87         TRACE_user_link_variable(time,src,dst,var,value,"add");
  88
  89 #define TRACE_link_variable_sub_with_time(time,src,dst,var,value) \
  90         TRACE_user_link_variable(time,src,dst,var,value,"sub");
  91
  92 #define TRACE_link_variable_set(src,dst,var,value) \
  93         TRACE_user_link_variable(MSG_get_clock(),src,dst,var,value,"set");
  94
  95 #define TRACE_link_variable_add(src,dst,var,value) \
  96         TRACE_user_link_variable(MSG_get_clock(),src,dst,var,value,"add");
  97
  98 #define TRACE_link_variable_sub(src,dst,var,value) \
  99         TRACE_user_link_variable(MSG_get_clock(),src,dst,var,value,"sub");
 100
 101 #else                           /* HAVE_TRACING */
 102
 103 #define TRACE_start()
 104 #define TRACE_end()
 105 #define TRACE_category(cat)
 106 #define TRACE_define_type(cat,supercat,final)
 107 #define TRACE_create_category(inst,cat)
 108 #define TRACE_msg_set_task_category(task,cat)
 109 #define TRACE_msg_set_process_category(proc,cat)
 110 #define TRACE_set_mask(mask)
 111
 112 #define TRACE_host_variable_declare(var)
 113 #define TRACE_host_variable_set_with_time(time,var,value)
 114 #define TRACE_host_variable_add_with_time(time,var,value)
 115 #define TRACE_host_variable_sub_with_time(time,var,value)
 116 #define TRACE_host_variable_set(var,value)
 117 #define TRACE_host_variable_add(var,value)
 118 #define TRACE_host_variable_sub(var,value)
 119 #define TRACE_link_variable_declare(var)
 120 #define TRACE_link_variable_set_with_time(time,src,dst,var,value)
 121 #define TRACE_link_variable_add_with_time(time,src,dst,var,value)
 122 #define TRACE_link_variable_sub_with_time(time,src,dst,var,value)
 123 #define TRACE_link_variable_set(src,dst,var,value)
 124 #define TRACE_link_variable_add(src,dst,var,value)
 125 #define TRACE_link_variable_sub(src,dst,var,value)
 126 #define TRACE_declare_mark(type)
 127 #define TRACE_mark(type,value)
 128 #define TRACE_smpi_set_category(cat)
 129 #define TRACE_sd_set_task_category(task,cat)
 130
 131 #endif                          /* HAVE_TRACING */
 132
 133 #endif                          /* INSTR_H_ */