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 //--------------------------------------------------
72 xbt_dict_t values; //valid for all types except variable and container
73 Type (const char *typeNameBuff, const char *key, const char *color, e_entity_types kind, type_t father);
74 static type_t getOrNull (const char *name, type_t father);
75 static type_t containerNew (const char *name, type_t father);
76 static type_t eventNew (const char *name, type_t father);
77 static type_t variableNew (const char *name, const char *color, type_t father);
78 static type_t linkNew (const char *name, type_t father, type_t source, type_t dest);
79 static type_t stateNew (const char *name, type_t father);
82 //--------------------------------------------------
91 value(const char* name, const char* color, type_t father);
93 static value* get_or_new(const char* name, const char* color, type_t father);
94 static value* get(const char* name, type_t father);
98 //--------------------------------------------------
110 //--------------------------------------------------
112 typedef s_container *container_t;
116 sg_netpoint_t netpoint;
117 char *name; /* Unique name of this container */
118 char *id; /* Unique id of this container */
119 type_t type; /* Type of this container */
120 int level; /* Level in the hierarchy, root level is 0 */
121 e_container_types kind; /* This container is of what kind */
126 //--------------------------------------------------
130 e_event_type event_type;
131 virtual void print() = 0;
133 virtual ~PajeEvent();
136 //--------------------------------------------------
138 class DefineVariableTypeEvent : public PajeEvent
142 DefineVariableTypeEvent(type_t type);
143 void print() override;
145 //--------------------------------------------------
147 class DefineStateTypeEvent : public PajeEvent {
150 DefineStateTypeEvent(type_t type);
151 void print() override;
155 class SetVariableEvent : public PajeEvent {
157 container_t container;
161 SetVariableEvent (double timestamp, container_t container, type_t type, double value);
162 void print() override;
166 class AddVariableEvent:public PajeEvent {
168 container_t container;
172 AddVariableEvent (double timestamp, container_t container, type_t type, double value);
173 void print() override;
176 //--------------------------------------------------
179 class SubVariableEvent : public PajeEvent {
181 container_t container;
185 SubVariableEvent(double timestamp, container_t container, type_t type, double value);
186 void print() override;
188 //--------------------------------------------------
190 class SetStateEvent : public PajeEvent {
192 container_t container;
195 const char* filename;
198 SetStateEvent(double timestamp, container_t container, type_t type, value* val);
199 void print() override;
203 class PushStateEvent : public PajeEvent {
205 container_t container;
209 const char* filename;
213 PushStateEvent(double timestamp, container_t container, type_t type, value* val);
214 PushStateEvent(double timestamp, container_t container, type_t type, value* val, void* extra);
215 void print() override;
218 class PopStateEvent : public PajeEvent {
219 container_t container;
222 PopStateEvent (double timestamp, container_t container, type_t type);
223 void print() override;
226 class ResetStateEvent : public PajeEvent {
227 container_t container;
230 ResetStateEvent (double timestamp, container_t container, type_t type);
231 void print() override;
234 class StartLinkEvent : public PajeEvent {
236 container_t container;
238 container_t sourceContainer;
244 StartLinkEvent(double timestamp, container_t container, type_t type, container_t sourceContainer, const char* value,
246 StartLinkEvent(double timestamp, container_t container, type_t type, container_t sourceContainer, const char* value,
247 const char* key, int size);
248 void print() override;
251 class EndLinkEvent : public PajeEvent {
252 container_t container;
254 container_t destContainer;
258 EndLinkEvent (double timestamp, container_t container, type_t type, container_t destContainer,
259 const char *value, const char *key);
261 void print() override;
265 class NewEvent : public PajeEvent {
267 container_t container;
272 NewEvent(double timestamp, container_t container, type_t type, value* val);
273 void print() override;
277 extern XBT_PRIVATE std::set<std::string> created_categories;
278 extern XBT_PRIVATE std::set<std::string> declared_marks;
279 extern XBT_PRIVATE std::set<std::string> user_host_variables;
280 extern XBT_PRIVATE std::set<std::string> user_vm_variables;
281 extern XBT_PRIVATE std::set<std::string> user_link_variables;
282 extern XBT_PRIVATE double TRACE_last_timestamp_to_dump;
284 /* instr_paje_header.c */
285 XBT_PRIVATE void TRACE_header(int basic, int size);
288 XBT_PRIVATE void TRACE_paje_start();
289 XBT_PRIVATE void TRACE_paje_end();
290 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
293 /* from instr_config.c */
294 XBT_PRIVATE bool TRACE_needs_platform ();
295 XBT_PRIVATE bool TRACE_is_enabled();
296 XBT_PRIVATE bool TRACE_platform();
297 XBT_PRIVATE bool TRACE_platform_topology();
298 XBT_PRIVATE bool TRACE_is_configured();
299 XBT_PRIVATE bool TRACE_categorized ();
300 XBT_PRIVATE bool TRACE_uncategorized ();
301 XBT_PRIVATE bool TRACE_msg_process_is_enabled();
302 XBT_PRIVATE bool TRACE_msg_vm_is_enabled();
303 XBT_PRIVATE bool TRACE_buffer ();
304 XBT_PRIVATE bool TRACE_disable_link();
305 XBT_PRIVATE bool TRACE_disable_speed();
306 XBT_PRIVATE bool TRACE_onelink_only ();
307 XBT_PRIVATE bool TRACE_disable_destroy ();
308 XBT_PRIVATE bool TRACE_basic ();
309 XBT_PRIVATE bool TRACE_display_sizes ();
310 XBT_PRIVATE char *TRACE_get_comment ();
311 XBT_PRIVATE char *TRACE_get_comment_file ();
312 XBT_PRIVATE int TRACE_precision ();
313 XBT_PRIVATE char *TRACE_get_filename();
314 XBT_PRIVATE char *TRACE_get_viva_uncat_conf ();
315 XBT_PRIVATE char *TRACE_get_viva_cat_conf ();
316 XBT_PRIVATE void TRACE_generate_viva_uncat_conf ();
317 XBT_PRIVATE void TRACE_generate_viva_cat_conf ();
318 XBT_PRIVATE void instr_pause_tracing ();
319 XBT_PRIVATE void instr_resume_tracing ();
321 /* Public functions used in SMPI */
322 XBT_PUBLIC(bool) TRACE_smpi_is_enabled();
323 XBT_PUBLIC(bool) TRACE_smpi_is_grouped();
324 XBT_PUBLIC(bool) TRACE_smpi_is_computing();
325 XBT_PUBLIC(bool) TRACE_smpi_is_sleeping();
326 XBT_PUBLIC(bool) TRACE_smpi_view_internals();
328 /* from resource_utilization.c */
329 XBT_PRIVATE void TRACE_surf_host_set_utilization(const char *resource, const char *category, double value, double now,
331 XBT_PRIVATE void TRACE_surf_link_set_utilization(const char *resource,const char *category, double value, double now,
333 XBT_PUBLIC(void) TRACE_surf_resource_utilization_alloc();
336 extern XBT_PRIVATE std::set<std::string> trivaNodeTypes;
337 extern XBT_PRIVATE std::set<std::string> trivaEdgeTypes;
338 XBT_PRIVATE long long int instr_new_paje_id ();
339 XBT_PRIVATE void PJ_container_alloc ();
340 XBT_PRIVATE void PJ_container_release ();
341 XBT_PUBLIC(container_t) PJ_container_new (const char *name, e_container_types kind, container_t father);
342 XBT_PUBLIC(container_t) PJ_container_get (const char *name);
343 XBT_PUBLIC(container_t) PJ_container_get_or_null (const char *name);
344 XBT_PUBLIC(container_t) PJ_container_get_root ();
345 XBT_PUBLIC(void) PJ_container_set_root (container_t root);
346 XBT_PUBLIC(void) PJ_container_free (container_t container);
347 XBT_PUBLIC(void) PJ_container_free_all (void);
348 XBT_PUBLIC(void) PJ_container_remove_from_parent (container_t container);
350 /* instr_paje_types.c */
351 XBT_PRIVATE void PJ_type_release ();
352 XBT_PUBLIC(type_t) PJ_type_get_root ();
353 XBT_PUBLIC(type_t) PJ_type_get (const char *name, const type_t father);
354 XBT_PRIVATE XBT_PRIVATE void PJ_type_free (type_t type);
357 XBT_PRIVATE void recursiveDestroyType (type_t type);
359 XBT_PRIVATE void TRACE_TI_start();
360 XBT_PRIVATE void TRACE_TI_end();
362 XBT_PRIVATE void TRACE_paje_dump_buffer (int force);
363 XBT_PRIVATE void dump_comment_file (const char *filename);
364 XBT_PRIVATE void dump_comment (const char *comment);
366 struct s_instr_extra_data;
367 typedef struct s_instr_extra_data *instr_extra_data;
398 TRACING_REDUCE_SCATTER,
405 typedef struct s_instr_extra_data {
410 double sleep_duration;
414 const char* datatype1;
415 const char* datatype2;
419 } s_instr_extra_data_t;
421 /* Format of TRACING output.
422 * - paje is the regular format, that we all know
423 * - 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.
424 * This trick should be removed and replaced by some code using the signal that we will create to cleanup the TRACING
426 typedef enum { instr_fmt_paje, instr_fmt_TI } instr_fmt_type_t;
427 extern instr_fmt_type_t instr_fmt_type;
431 void DefineContainerEvent(type_t type);
432 void LogVariableTypeDefinition(type_t type);
433 void LogStateTypeDefinition(type_t type);
434 void LogLinkTypeDefinition(type_t type, type_t source, type_t dest);
435 void LogEntityValue(value* val);
436 void LogContainerCreation (container_t container);
437 void LogContainerDestruction (container_t container);
438 void LogDefineEventType(type_t type);