1 /* Copyright (c) 2010-2017. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #ifndef INSTR_PRIVATE_H_
7 #define INSTR_PRIVATE_H_
11 #include "instr/instr_interface.h"
12 #include "simgrid/instr.h"
13 #include "simgrid_config.h"
14 #include "src/internal_config.h"
19 /* Need to define function drand48 for Windows */
20 /* FIXME: use _drand48() defined in src/surf/random_mgr.c instead */
22 # define drand48() (rand()/(RAND_MAX + 1.0))
25 #define INSTR_DEFAULT_STR_SIZE 500
27 #include "xbt/graph.h"
31 PAJE_DefineContainerType,
32 PAJE_DefineVariableType,
36 PAJE_DefineEntityValue,
38 PAJE_DestroyContainer,
59 //--------------------------------------------------
69 typedef s_type *type_t;
70 class s_type : public ess_type {
75 xbt_dict_t values; //valid for all types except variable and container
76 s_type (const char *typeNameBuff, const char *key, const char *color, e_entity_types kind, type_t father);
77 static type_t s_type_get_or_null (const char *name, type_t father);
78 static type_t s_type_container_new (const char *name, type_t father);
79 static type_t s_type_event_new (const char *name, type_t father);
80 static type_t s_type_variable_new (const char *name, const char *color, type_t father);
81 static type_t s_type_link_new (const char *name, type_t father, type_t source, type_t dest);
82 static type_t s_type_state_new (const char *name, type_t father);
85 //--------------------------------------------------
86 class value : public ess_type{
90 value(const char* name, const char* color, type_t father);
92 static value* get_or_new(const char* name, const char* color, type_t father);
93 static value* get(const char* name, type_t father);
97 //--------------------------------------------------
109 //--------------------------------------------------
111 typedef s_container *container_t;
115 sg_netpoint_t netpoint;
116 char *name; /* Unique name of this container */
117 char *id; /* Unique id of this container */
118 type_t type; /* Type of this container */
119 int level; /* Level in the hierarchy, root level is 0 */
120 e_container_types kind; /* This container is of what kind */
125 //--------------------------------------------------
129 e_event_type event_type;
130 virtual void print() = 0;
132 virtual ~PajeEvent();
135 //--------------------------------------------------
137 class DefineVariableTypeEvent : public PajeEvent
141 DefineVariableTypeEvent(type_t type);
142 void print() override;
144 //--------------------------------------------------
146 class DefineStateTypeEvent : public PajeEvent {
149 DefineStateTypeEvent(type_t type);
150 void print() override;
154 class SetVariableEvent : public PajeEvent {
156 container_t container;
160 SetVariableEvent (double timestamp, container_t container, type_t type, double value);
161 void print() override;
165 class AddVariableEvent:public PajeEvent {
167 container_t container;
171 AddVariableEvent (double timestamp, container_t container, type_t type, double value);
172 void print() override;
175 //--------------------------------------------------
178 class SubVariableEvent : public PajeEvent {
180 container_t container;
184 SubVariableEvent(double timestamp, container_t container, type_t type, double value);
185 void print() override;
187 //--------------------------------------------------
189 class SetStateEvent : public PajeEvent {
191 container_t container;
194 const char* filename;
197 SetStateEvent(double timestamp, container_t container, type_t type, value* val);
198 void print() override;
202 class PushStateEvent : public PajeEvent {
204 container_t container;
208 const char* filename;
212 PushStateEvent(double timestamp, container_t container, type_t type, value* val);
213 PushStateEvent(double timestamp, container_t container, type_t type, value* val, void* extra);
214 void print() override;
217 class PopStateEvent : public PajeEvent {
218 container_t container;
221 PopStateEvent (double timestamp, container_t container, type_t type);
222 void print() override;
225 class ResetStateEvent : public PajeEvent {
226 container_t container;
229 ResetStateEvent (double timestamp, container_t container, type_t type);
230 void print() override;
233 class StartLinkEvent : public PajeEvent {
235 container_t container;
237 container_t sourceContainer;
243 StartLinkEvent(double timestamp, container_t container, type_t type, container_t sourceContainer, const char* value,
245 StartLinkEvent(double timestamp, container_t container, type_t type, container_t sourceContainer, const char* value,
246 const char* key, int size);
247 void print() override;
250 class EndLinkEvent : public PajeEvent {
251 container_t container;
253 container_t destContainer;
257 EndLinkEvent (double timestamp, container_t container, type_t type, container_t destContainer,
258 const char *value, const char *key);
260 void print() override;
264 class NewEvent : public PajeEvent {
266 container_t container;
271 NewEvent(double timestamp, container_t container, type_t type, value* val);
272 void print() override;
276 extern XBT_PRIVATE std::set<std::string> created_categories;
277 extern XBT_PRIVATE std::set<std::string> declared_marks;
278 extern XBT_PRIVATE std::set<std::string> user_host_variables;
279 extern XBT_PRIVATE std::set<std::string> user_vm_variables;
280 extern XBT_PRIVATE std::set<std::string> user_link_variables;
281 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
283 /* instr_paje_header.c */
284 XBT_PRIVATE void TRACE_header(int basic, int size);
287 XBT_PRIVATE void TRACE_paje_start();
288 XBT_PRIVATE void TRACE_paje_end();
289 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
292 /* from instr_config.c */
293 XBT_PRIVATE bool TRACE_needs_platform ();
294 XBT_PRIVATE bool TRACE_is_enabled();
295 XBT_PRIVATE bool TRACE_platform();
296 XBT_PRIVATE bool TRACE_platform_topology();
297 XBT_PRIVATE bool TRACE_is_configured();
298 XBT_PRIVATE bool TRACE_categorized ();
299 XBT_PRIVATE bool TRACE_uncategorized ();
300 XBT_PRIVATE bool TRACE_msg_process_is_enabled();
301 XBT_PRIVATE bool TRACE_msg_vm_is_enabled();
302 XBT_PRIVATE bool TRACE_buffer ();
303 XBT_PRIVATE bool TRACE_disable_link();
304 XBT_PRIVATE bool TRACE_disable_speed();
305 XBT_PRIVATE bool TRACE_onelink_only ();
306 XBT_PRIVATE bool TRACE_disable_destroy ();
307 XBT_PRIVATE bool TRACE_basic ();
308 XBT_PRIVATE bool TRACE_display_sizes ();
309 XBT_PRIVATE char *TRACE_get_comment ();
310 XBT_PRIVATE char *TRACE_get_comment_file ();
311 XBT_PRIVATE int TRACE_precision ();
312 XBT_PRIVATE char *TRACE_get_filename();
313 XBT_PRIVATE char *TRACE_get_viva_uncat_conf ();
314 XBT_PRIVATE char *TRACE_get_viva_cat_conf ();
315 XBT_PRIVATE void TRACE_generate_viva_uncat_conf ();
316 XBT_PRIVATE void TRACE_generate_viva_cat_conf ();
317 XBT_PRIVATE void instr_pause_tracing ();
318 XBT_PRIVATE void instr_resume_tracing ();
320 /* Public functions used in SMPI */
321 XBT_PUBLIC(bool) TRACE_smpi_is_enabled();
322 XBT_PUBLIC(bool) TRACE_smpi_is_grouped();
323 XBT_PUBLIC(bool) TRACE_smpi_is_computing();
324 XBT_PUBLIC(bool) TRACE_smpi_is_sleeping();
325 XBT_PUBLIC(bool) TRACE_smpi_view_internals();
327 /* from resource_utilization.c */
328 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char *resource, const char *category, double value, double now,
330 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char *resource,const char *category, double value, double now,
332 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
335 extern XBT_PRIVATE std::set<std::string> trivaNodeTypes;
336 extern XBT_PRIVATE std::set<std::string> trivaEdgeTypes;
337 XBT_PRIVATE long long int instr_new_paje_id ();
338 XBT_PRIVATE void PJ_container_alloc ();
339 XBT_PRIVATE void PJ_container_release ();
340 XBT_PUBLIC(container_t) PJ_container_new (const char *name, e_container_types kind, container_t father);
341 XBT_PUBLIC(container_t) PJ_container_get (const char *name);
342 XBT_PUBLIC(container_t) PJ_container_get_or_null (const char *name);
343 XBT_PUBLIC(container_t) PJ_container_get_root ();
344 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
345 XBT_PUBLIC(void) PJ_container_free (container_t container);
346 XBT_PUBLIC(void) PJ_container_free_all (void);
347 XBT_PUBLIC(void) PJ_container_remove_from_parent (container_t container);
349 /* instr_paje_types.c */
350 XBT_PRIVATE void PJ_type_release ();
351 XBT_PUBLIC(type_t) PJ_type_get_root ();
352 XBT_PUBLIC(type_t) PJ_type_get (const char *name, const type_t father);
353 XBT_PRIVATE XBT_PRIVATE void PJ_type_free (type_t type);
356 XBT_PRIVATE void recursiveDestroyType (type_t type);
358 XBT_PRIVATE void TRACE_TI_start();
359 XBT_PRIVATE void TRACE_TI_end();
361 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
362 XBT_PRIVATE void dump_comment_file (const char *filename);
363 XBT_PRIVATE void dump_comment (const char *comment);
365 struct s_instr_extra_data;
366 typedef struct s_instr_extra_data *instr_extra_data;
397 TRACING_REDUCE_SCATTER,
404 typedef struct s_instr_extra_data {
409 double sleep_duration;
413 const char* datatype1;
414 const char* datatype2;
418 } s_instr_extra_data_t;
420 /* Format of TRACING output.
421 * - paje is the regular format, that we all know
422 * - TI is a trick to reuse the tracing functions to generate a time independent trace during the execution. Such trace can easily be replayed with smpi_replay afterward.
423 * This trick should be removed and replaced by some code using the signal that we will create to cleanup the TRACING
425 typedef enum { instr_fmt_paje, instr_fmt_TI } instr_fmt_type_t;
426 extern instr_fmt_type_t instr_fmt_type;
430 void DefineContainerEvent(type_t type);
431 void LogVariableTypeDefinition(type_t type);
432 void LogStateTypeDefinition(type_t type);
433 void LogLinkTypeDefinition(type_t type, type_t source, type_t dest);
434 void LogEntityValue(value* val);
435 void LogContainerCreation (container_t container);
436 void LogContainerDestruction (container_t container);
437 void LogDefineEventType(type_t type);