src/instr/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 "instr/instr.h"
  11 #include "instr/instr_interface.h"
  12 #include "simgrid_config.h"
  13
  14 #ifdef HAVE_TRACING
  15
  16 /* Need to define function drand48 for Windows */
  17 #ifdef _WIN32
  18 #  define drand48() (rand()/(RAND_MAX + 1.0))
  19 #endif
  20
  21 #define INSTR_DEFAULT_STR_SIZE 500
  22
  23 #include "xbt/graph.h"
  24 #include "xbt/dict.h"
  25 #include "simgrid/platf.h"
  26
  27 typedef enum {
  28   PAJE_DefineContainerType,
  29   PAJE_DefineVariableType,
  30   PAJE_DefineStateType,
  31   PAJE_DefineEventType,
  32   PAJE_DefineLinkType,
  33   PAJE_DefineEntityValue,
  34   PAJE_CreateContainer,
  35   PAJE_DestroyContainer,
  36   PAJE_SetVariable,
  37   PAJE_AddVariable,
  38   PAJE_SubVariable,
  39   PAJE_SetState,
  40   PAJE_PushState,
  41   PAJE_PopState,
  42   PAJE_ResetState,
  43   PAJE_StartLink,
  44   PAJE_EndLink,
  45   PAJE_NewEvent
  46 } e_event_type;
  47
  48 typedef enum {
  49   TYPE_VARIABLE,
  50   TYPE_LINK,
  51   TYPE_CONTAINER,
  52   TYPE_STATE,
  53   TYPE_EVENT
  54 } e_entity_types;
  55
  56 typedef struct s_type *type_t;
  57 typedef struct s_type {
  58   char *id;
  59   char *name;
  60   char *color;
  61   e_entity_types kind;
  62   struct s_type *father;
  63   xbt_dict_t children;
  64   xbt_dict_t values; //valid for all types except variable and container
  65 }s_type_t;
  66
  67 typedef struct s_val *val_t;
  68 typedef struct s_val {
  69   char *id;
  70   char *name;
  71   char *color;
  72   type_t father;
  73 }s_val_t;
  74
  75 typedef enum {
  76   INSTR_HOST,
  77   INSTR_LINK,
  78   INSTR_ROUTER,
  79   INSTR_AS,
  80   INSTR_SMPI,
  81   INSTR_MSG_VM,
  82   INSTR_MSG_PROCESS,
  83   INSTR_MSG_TASK
  84 } e_container_types;
  85
  86 typedef struct s_container *container_t;
  87 typedef struct s_container {
  88   sg_routing_edge_t net_elm;
  89   char *name;     /* Unique name of this container */
  90   char *id;       /* Unique id of this container */
  91   type_t type;    /* Type of this container */
  92   int level;      /* Level in the hierarchy, root level is 0 */
  93   e_container_types kind; /* This container is of what kind */
  94   struct s_container *father;
  95   xbt_dict_t children;
  96 }s_container_t;
  97
  98 extern xbt_dict_t created_categories;
  99 extern xbt_dict_t declared_marks;
 100 extern xbt_dict_t user_host_variables;
 101 extern xbt_dict_t user_vm_variables;
 102 extern xbt_dict_t user_link_variables;
 103 extern double TRACE_last_timestamp_to_dump;
 104
 105 /* instr_paje_header.c */
 106 void TRACE_header(int basic);
 107
 108 /* from paje.c */
 109 void TRACE_paje_start(void);
 110 void TRACE_paje_end(void);
 111 void TRACE_paje_dump_buffer (int force);
 112 void new_pajeDefineContainerType(type_t type);
 113 void new_pajeDefineVariableType(type_t type);
 114 void new_pajeDefineStateType(type_t type);
 115 void new_pajeDefineEventType(type_t type);
 116 void new_pajeDefineLinkType(type_t type, type_t source, type_t dest);
 117 void new_pajeDefineEntityValue (val_t type);
 118 void new_pajeCreateContainer (container_t container);
 119 void new_pajeDestroyContainer (container_t container);
 120 void new_pajeSetVariable (double timestamp, container_t container, type_t type, double value);
 121 void new_pajeAddVariable (double timestamp, container_t container, type_t type, double value);
 122 void new_pajeSubVariable (double timestamp, container_t container, type_t type, double value);
 123 void new_pajeSetState (double timestamp, container_t container, type_t type, val_t value);
 124 void new_pajePushState (double timestamp, container_t container, type_t type, val_t value);
 125 void new_pajePopState (double timestamp, container_t container, type_t type);
 126 void new_pajeResetState (double timestamp, container_t container, type_t type);
 127 void new_pajeStartLink (double timestamp, container_t container, type_t type, container_t sourceContainer, const char *value, const char *key);
 128 void new_pajeEndLink (double timestamp, container_t container, type_t type, container_t destContainer, const char *value, const char *key);
 129 void new_pajeNewEvent (double timestamp, container_t container, type_t type, val_t value);
 130
 131 /* declaration of instrumentation functions from msg_task_instr.c */
 132 void TRACE_msg_set_task_category(msg_task_t task, const char *category);
 133 void TRACE_msg_task_create(msg_task_t task);
 134 void TRACE_msg_task_execute_start(msg_task_t task);
 135 void TRACE_msg_task_execute_end(msg_task_t task);
 136 void TRACE_msg_task_destroy(msg_task_t task);
 137 void TRACE_msg_task_get_start(void);
 138 void TRACE_msg_task_get_end(double start_time, msg_task_t task);
 139 int TRACE_msg_task_put_start(msg_task_t task);    //returns TRUE if the task_put_end must be called
 140 void TRACE_msg_task_put_end(void);
 141
 142 /* declaration of instrumentation functions from msg_process_instr.c */
 143 char *instr_process_id (msg_process_t proc, char *str, int len);
 144 char *instr_process_id_2 (const char *process_name, int process_pid, char *str, int len);
 145 void TRACE_msg_process_change_host(msg_process_t process, msg_host_t old_host,
 146                                    msg_host_t new_host);
 147 void TRACE_msg_process_create (const char *process_name, int process_pid, msg_host_t host);
 148 void TRACE_msg_process_destroy (const char *process_name, int process_pid, msg_host_t host);
 149 void TRACE_msg_process_kill(msg_process_t process);
 150 void TRACE_msg_process_suspend(msg_process_t process);
 151 void TRACE_msg_process_resume(msg_process_t process);
 152 void TRACE_msg_process_sleep_in(msg_process_t process);   //called from msg/gos.c
 153 void TRACE_msg_process_sleep_out(msg_process_t process);
 154 void TRACE_msg_process_end(msg_process_t process);
 155
 156 /* declaration of instrumentation functions from instr_msg_vm.c */
 157 char *instr_vm_id (msg_vm_t vm, char *str, int len);
 158 char *instr_vm_id_2 (const char *vm_name, char *str, int len);
 159 void TRACE_msg_vm_change_host(msg_vm_t vm, msg_host_t old_host,
 160                                    msg_host_t new_host);
 161 void TRACE_msg_vm_create (const char *vm_name, msg_host_t host);
 162 void TRACE_msg_vm_kill(msg_vm_t process);
 163 void TRACE_msg_vm_suspend(msg_vm_t vm);
 164 void TRACE_msg_vm_resume(msg_vm_t vm);
 165 void TRACE_msg_vm_sleep_in(msg_vm_t vm);
 166 void TRACE_msg_vm_sleep_out(msg_vm_t vm);
 167 void TRACE_msg_vm_end(msg_vm_t vm);
 168
 169 /* from surf_instr.c */
 170 void TRACE_surf_alloc(void);
 171 void TRACE_surf_release(void);
 172 void TRACE_surf_host_set_power(double date, const char *resource, double power);
 173 void TRACE_surf_link_set_bandwidth(double date, const char *resource, double bandwidth);
 174 void TRACE_surf_link_set_latency(double date, const char *resource, double latency);
 175 void TRACE_surf_action(surf_action_t surf_action, const char *category);
 176
 177 //for tracing gtnets
 178 void TRACE_surf_gtnets_communicate(void *action, void *src, void *dst);
 179
 180 /* from instr_config.c */
 181 int TRACE_needs_platform (void);
 182 int TRACE_is_enabled(void);
 183 int TRACE_platform(void);
 184 int TRACE_platform_topology(void);
 185 int TRACE_is_configured(void);
 186 int TRACE_smpi_is_enabled(void);
 187 int TRACE_smpi_is_grouped(void);
 188 int TRACE_smpi_is_computing(void);
 189 int TRACE_categorized (void);
 190 int TRACE_uncategorized (void);
 191 int TRACE_msg_process_is_enabled(void);
 192 int TRACE_buffer (void);
 193 int TRACE_onelink_only (void);
 194 int TRACE_disable_destroy (void);
 195 int TRACE_basic (void);
 196 char *TRACE_get_comment (void);
 197 char *TRACE_get_comment_file (void);
 198 char *TRACE_get_filename(void);
 199 char *TRACE_get_viva_uncat_conf (void);
 200 char *TRACE_get_viva_cat_conf (void);
 201 void TRACE_generate_viva_uncat_conf (void);
 202 void TRACE_generate_viva_cat_conf (void);
 203 void instr_pause_tracing (void);
 204 void instr_resume_tracing (void);
 205
 206 /* from resource_utilization.c */
 207 void TRACE_surf_host_set_utilization(const char *resource,
 208                                      const char *category,
 209                                      double value,
 210                                      double now,
 211                                      double delta);
 212 void TRACE_surf_link_set_utilization(const char *resource,
 213                                      const char *category,
 214                                      double value,
 215                                      double now,
 216                                      double delta);
 217 void TRACE_surf_resource_utilization_alloc(void);
 218
 219 /* instr_paje.c */
 220 extern xbt_dict_t trivaNodeTypes;
 221 extern xbt_dict_t trivaEdgeTypes;
 222 long long int instr_new_paje_id (void);
 223 void PJ_container_alloc (void);
 224 void PJ_container_release (void);
 225 container_t PJ_container_new (const char *name, e_container_types kind, container_t father);
 226 container_t PJ_container_get (const char *name);
 227 container_t PJ_container_get_or_null (const char *name);
 228 container_t PJ_container_get_root (void);
 229 void PJ_container_set_root (container_t root);
 230 void PJ_container_free (container_t container);
 231 void PJ_container_free_all (void);
 232 void PJ_container_remove_from_parent (container_t container);
 233
 234 /* instr_paje_types.c */
 235 void PJ_type_alloc (void);
 236 void PJ_type_release (void);
 237 type_t PJ_type_get_root (void);
 238 type_t PJ_type_container_new (const char *name, type_t father);
 239 type_t PJ_type_event_new (const char *name, type_t father);
 240 type_t PJ_type_variable_new (const char *name, const char *color, type_t father);
 241 type_t PJ_type_link_new (const char *name, type_t father, type_t source, type_t dest);
 242 type_t PJ_type_state_new (const char *name, type_t father);
 243 type_t PJ_type_get (const char *name, const type_t father);
 244 type_t PJ_type_get_or_null (const char *name, type_t father);
 245 void PJ_type_free (type_t type);
 246 void PJ_type_free_all (void);
 247
 248 /* instr_paje_values.c */
 249 val_t PJ_value_new (const char *name, const char *color, type_t father);
 250 val_t PJ_value_get_or_new (const char *name, const char *color, type_t father);
 251 val_t PJ_value_get (const char *name, const type_t father);
 252 void PJ_value_free (val_t value);
 253
 254 #endif /* HAVE_TRACING */
 255
 256 #ifdef HAVE_JEDULE
 257 #include "instr/jedule/jedule_sd_binding.h"
 258 #endif
 259
 260 #endif /* INSTR_PRIVATE_H_ */