src/instr/private.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_PRIVATE_H_
   8 #define INSTR_PRIVATE_H_
   9
  10 #include "simgrid_config.h"
  11
  12 #ifdef HAVE_TRACING
  13
  14 extern int tracing_active;      /* declared in paje.c */
  15
  16 #define IS_TRACING                        (tracing_active)
  17 #define IS_TRACED(n)          (n->category)
  18 #define IS_TRACING_TASKS      (TRACE_msg_task_is_enabled())
  19 #define IS_TRACING_PLATFORM   (TRACE_platform_is_enabled())
  20 #define IS_TRACING_PROCESSES  (TRACE_msg_process_is_enabled())
  21 #define IS_TRACING_VOLUME     (TRACE_msg_volume_is_enabled())
  22 #define IS_TRACING_SMPI       (TRACE_smpi_is_enabled())
  23
  24 #define INSTR_DEFAULT_STR_SIZE 500
  25
  26 #include "instr/instr.h"
  27 #include "msg/msg.h"
  28 #include "simdag/private.h"
  29 #include "simix/private.h"
  30
  31 /* from paje.c */
  32 void TRACE_paje_create_header(void);
  33 void TRACE_paje_start(FILE * file);
  34 FILE *TRACE_paje_end(void);
  35 void pajeDefineContainerType(const char *alias, const char *containerType,
  36                              const char *name);
  37 void pajeDefineStateType(const char *alias, const char *containerType,
  38                          const char *name);
  39 void pajeDefineEventType(const char *alias, const char *containerType,
  40                          const char *name);
  41 void pajeDefineLinkType(const char *alias, const char *containerType,
  42                         const char *sourceContainerType,
  43                         const char *destContainerType, const char *name);
  44 void pajeCreateContainer(double time, const char *alias, const char *type,
  45                          const char *container, const char *name);
  46 void pajeDestroyContainer(double time, const char *type,
  47                           const char *container);
  48 void pajeSetState(double time, const char *entityType,
  49                   const char *container, const char *value);
  50 void pajePushState(double time, const char *entityType,
  51                    const char *container, const char *value);
  52 void pajePopState(double time, const char *entityType,
  53                   const char *container);
  54 void pajeStartLink(double time, const char *entityType,
  55                    const char *container, const char *value,
  56                    const char *sourceContainer, const char *key);
  57 void pajeStartLinkWithVolume(double time, const char *entityType,
  58                              const char *container, const char *value,
  59                              const char *sourceContainer, const char *key,
  60                              double volume);
  61 void pajeEndLink(double time, const char *entityType,
  62                  const char *container, const char *value,
  63                  const char *destContainer, const char *key);
  64 void pajeDefineVariableType(const char *alias, const char *containerType,
  65                             const char *name);
  66 void pajeDefineVariableTypeWithColor(const char *alias, const char *containerType,
  67                             const char *name, const char *color);
  68 void pajeSetVariable(double time, const char *entityType,
  69                      const char *container, const char *value);
  70 void pajeAddVariable(double time, const char *entityType,
  71                      const char *container, const char *value);
  72 void pajeSubVariable(double time, const char *entityType,
  73                      const char *container, const char *value);
  74 void pajeNewEvent(double time, const char *entityType,
  75                   const char *container, const char *value);
  76
  77 /* from general.c */
  78 char *TRACE_host_container(m_host_t host, char *output, int len);
  79 char *TRACE_task_container(m_task_t task, char *output, int len);
  80 char *TRACE_process_container(m_process_t process, char *output, int len);
  81 char *TRACE_process_alias_container(m_process_t process, m_host_t host,
  82                                     char *output, int len);
  83 char *TRACE_task_alias_container(m_task_t task, m_process_t process,
  84                                  m_host_t host, char *output, int len);
  85
  86 /* from categories.c */
  87 void TRACE_category_alloc(void);
  88 void TRACE_category_release(void);
  89 void TRACE_category_set(smx_process_t proc, const char *category);
  90 char *TRACE_category_get(smx_process_t proc);
  91 void TRACE_category_unset(smx_process_t proc);
  92 void TRACE_msg_category_set(smx_process_t proc, m_task_t task);
  93
  94 /* declaration of instrumentation functions from msg_task_instr.c */
  95 void TRACE_msg_task_alloc(void);
  96 void TRACE_msg_task_release(void);
  97 void TRACE_msg_task_create(m_task_t task);
  98 void TRACE_msg_task_execute_start(m_task_t task);
  99 void TRACE_msg_task_execute_end(m_task_t task);
 100 void TRACE_msg_task_destroy(m_task_t task);
 101 void TRACE_msg_task_get_start(void);
 102 void TRACE_msg_task_get_end(double start_time, m_task_t task);
 103 int TRACE_msg_task_put_start(m_task_t task);    //returns TRUE if the task_put_end must be called
 104 void TRACE_msg_task_put_end(void);
 105
 106 /* declaration of instrumentation functions from msg_process_instr.c */
 107 void TRACE_msg_process_alloc(void);
 108 void TRACE_msg_process_release(void);
 109 void TRACE_msg_process_change_host(m_process_t process, m_host_t old_host,
 110                                    m_host_t new_host);
 111 void TRACE_msg_process_kill(m_process_t process);
 112 void TRACE_msg_process_suspend(m_process_t process);
 113 void TRACE_msg_process_resume(m_process_t process);
 114 void TRACE_msg_process_sleep_in(m_process_t process);   //called from msg/gos.c
 115 void TRACE_msg_process_sleep_out(m_process_t process);
 116 void TRACE_msg_process_end(m_process_t process);
 117
 118 /* declaration of instrumentation functions from msg_volume.c */
 119 void TRACE_msg_volume_start(m_task_t task);
 120 void TRACE_msg_volume_finish(m_task_t task);
 121
 122 /* from smx.c */
 123 void TRACE_smx_host_execute(smx_action_t act);
 124 void TRACE_smx_action_communicate(smx_action_t act, smx_process_t proc);
 125 void TRACE_smx_action_destroy(smx_action_t act);
 126
 127 /* from surf_instr.c */
 128 void TRACE_surf_alloc(void);
 129 void TRACE_surf_release(void);
 130 void TRACE_surf_host_declaration(const char *name, double power);
 131 void TRACE_surf_host_set_power(double date, const char *resource,
 132                                double power);
 133 void TRACE_surf_host_define_id(const char *name, int host_id);
 134 void TRACE_surf_host_vivaldi_parse(char *host, double x, double y,
 135                                    double h);
 136 void TRACE_surf_link_declaration(void *link, char *name, double bw,
 137                                  double lat);
 138 void TRACE_surf_link_set_bandwidth(double date, void *link,
 139                                    double bandwidth);
 140 void TRACE_surf_link_set_latency(double date, void *link, double latency);
 141 void TRACE_surf_save_onelink(void);
 142 int TRACE_surf_link_is_traced(void *link);
 143 void TRACE_surf_action(surf_action_t surf_action, const char *category);
 144
 145 //for tracing gtnets
 146 void TRACE_surf_gtnets_communicate(void *action, int src, int dst);
 147 int TRACE_surf_gtnets_get_src(void *action);
 148 int TRACE_surf_gtnets_get_dst(void *action);
 149 void TRACE_surf_gtnets_destroy(void *action);
 150
 151 /* from smpi_instr.c */
 152 void TRACE_smpi_alloc(void);
 153 void TRACE_smpi_release(void);
 154 void TRACE_smpi_init(int rank);
 155 void TRACE_smpi_finalize(int rank);
 156 void TRACE_smpi_start(void);
 157 void TRACE_smpi_collective_in(int rank, int root, const char *operation);
 158 void TRACE_smpi_collective_out(int rank, int root, const char *operation);
 159 void TRACE_smpi_ptp_in(int rank, int src, int dst, const char *operation);
 160 void TRACE_smpi_ptp_out(int rank, int src, int dst, const char *operation);
 161 void TRACE_smpi_send(int rank, int src, int dst);
 162 void TRACE_smpi_recv(int rank, int src, int dst);
 163
 164 /* from instr_config.c */
 165 int TRACE_is_enabled(void);
 166 int TRACE_is_configured(void);
 167 int TRACE_smpi_is_enabled(void);
 168 int TRACE_smpi_is_grouped(void);
 169 int TRACE_platform_is_enabled(void);
 170 int TRACE_uncategorized (void);
 171 int TRACE_msg_task_is_enabled(void);
 172 int TRACE_msg_process_is_enabled(void);
 173 int TRACE_msg_volume_is_enabled(void);
 174 char *TRACE_get_filename(void);
 175 char *TRACE_get_platform_method(void);
 176 void TRACE_global_init(int *argc, char **argv);
 177 void TRACE_help(int detailed);
 178
 179 /* from resource_utilization.c */
 180 void TRACE_surf_host_set_utilization(const char *name,
 181                                      smx_action_t smx_action,
 182                                      surf_action_t surf_action,
 183                                      double value, double now,
 184                                      double delta);
 185 void TRACE_surf_link_set_utilization(void *link, smx_action_t smx_action,
 186                                      surf_action_t surf_action,
 187                                      double value, double now,
 188                                      double delta);
 189 void TRACE_surf_resource_utilization_start(smx_action_t action);
 190 void TRACE_surf_resource_utilization_event(smx_action_t action, double now,
 191                                            double delta,
 192                                            const char *variable,
 193                                            const char *resource,
 194                                            double value);
 195 void TRACE_surf_resource_utilization_end(smx_action_t action);
 196 void TRACE_surf_resource_utilization_alloc(void);
 197 void TRACE_surf_resource_utilization_release(void);
 198
 199 /* sd_instr.c */
 200 void TRACE_sd_task_create(SD_task_t task);
 201 void TRACE_sd_task_destroy(SD_task_t task);
 202
 203 #endif
 204
 205 #endif                          /* PRIVATE_H_ */