Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix compilation with tracing and new network_element_t
[simgrid.git] / 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 "simgrid_config.h"
11
12 #ifdef HAVE_TRACING
13
14 /* Need to define function drand48 for Windows */
15 #ifdef _WIN32
16 #  define drand48() (rand()/(RAND_MAX + 1.0))
17 #endif
18
19 #define INSTR_DEFAULT_STR_SIZE 500
20
21 #include "instr/instr.h"
22 #include "msg/msg.h"
23 #include "simdag/private.h"
24 #include "simix/smx_private.h"
25 #include "xbt/graph_private.h"
26
27 typedef enum {
28   TYPE_VARIABLE,
29   TYPE_LINK,
30   TYPE_CONTAINER,
31   TYPE_STATE,
32   TYPE_EVENT
33 } e_entity_types;
34
35 typedef struct s_type *type_t;
36 typedef struct s_type {
37   char *id;
38   char *name;
39   char *color;
40   e_entity_types kind;
41   struct s_type *father;
42   xbt_dict_t children;
43   xbt_dict_t values; //valid for all types except variable and container
44 }s_type_t;
45
46 typedef struct s_val *val_t;
47 typedef struct s_val {
48   char *id;
49   char *name;
50   char *color;
51   type_t father;
52 }s_val_t;
53
54 typedef enum {
55   INSTR_HOST,
56   INSTR_LINK,
57   INSTR_ROUTER,
58   INSTR_AS,
59   INSTR_SMPI,
60   INSTR_MSG_PROCESS,
61   INSTR_MSG_TASK
62 } e_container_types;
63
64 typedef struct s_container *container_t;
65 typedef struct s_container {
66   void *net_elm;  /* network_element_t */
67   char *name;     /* Unique name of this container */
68   char *id;       /* Unique id of this container */
69   type_t type;    /* Type of this container */
70   int level;      /* Level in the hierarchy, root level is 0 */
71   e_container_types kind; /* This container is of what kind */
72   struct s_container *father;
73   xbt_dict_t children;
74 }s_container_t;
75
76 extern xbt_dict_t created_categories;
77 extern double TRACE_last_timestamp_to_dump;
78
79 /* from paje.c */
80 void TRACE_paje_create_header(void);
81 void TRACE_paje_start(void);
82 void TRACE_paje_end(void);
83 void TRACE_paje_dump_buffer (int force);
84 void new_pajeDefineContainerType(type_t type);
85 void new_pajeDefineVariableType(type_t type);
86 void new_pajeDefineStateType(type_t type);
87 void new_pajeDefineEventType(type_t type);
88 void new_pajeDefineLinkType(type_t type, type_t source, type_t dest);
89 void new_pajeDefineEntityValue (val_t type);
90 void new_pajeCreateContainer (container_t container);
91 void new_pajeDestroyContainer (container_t container);
92 void new_pajeSetVariable (double timestamp, container_t container, type_t type, double value);
93 void new_pajeAddVariable (double timestamp, container_t container, type_t type, double value);
94 void new_pajeSubVariable (double timestamp, container_t container, type_t type, double value);
95 void new_pajeSetState (double timestamp, container_t container, type_t type, val_t value);
96 void new_pajePushState (double timestamp, container_t container, type_t type, val_t value);
97 void new_pajePopState (double timestamp, container_t container, type_t type);
98 void new_pajeStartLink (double timestamp, container_t container, type_t type, container_t sourceContainer, const char *value, const char *key);
99 void new_pajeEndLink (double timestamp, container_t container, type_t type, container_t destContainer, const char *value, const char *key);
100 void new_pajeNewEvent (double timestamp, container_t container, type_t type, val_t value);
101
102 /* declaration of instrumentation functions from msg_task_instr.c */
103 char *TRACE_task_container(m_task_t task, char *output, int len);
104 void TRACE_msg_task_create(m_task_t task);
105 void TRACE_msg_task_execute_start(m_task_t task);
106 void TRACE_msg_task_execute_end(m_task_t task);
107 void TRACE_msg_task_destroy(m_task_t task);
108 void TRACE_msg_task_get_start(void);
109 void TRACE_msg_task_get_end(double start_time, m_task_t task);
110 int TRACE_msg_task_put_start(m_task_t task);    //returns TRUE if the task_put_end must be called
111 void TRACE_msg_task_put_end(void);
112
113 /* declaration of instrumentation functions from msg_process_instr.c */
114 char *instr_process_id (m_process_t proc, char *str, int len);
115 char *instr_process_id_2 (const char *process_name, int process_pid, char *str, int len);
116 void TRACE_msg_process_change_host(m_process_t process, m_host_t old_host,
117                                    m_host_t new_host);
118 void TRACE_msg_process_create (const char *process_name, int process_pid, m_host_t host);
119 void TRACE_msg_process_kill(m_process_t process);
120 void TRACE_msg_process_suspend(m_process_t process);
121 void TRACE_msg_process_resume(m_process_t process);
122 void TRACE_msg_process_sleep_in(m_process_t process);   //called from msg/gos.c
123 void TRACE_msg_process_sleep_out(m_process_t process);
124 void TRACE_msg_process_end(m_process_t process);
125
126 /* from surf_instr.c */
127 void TRACE_surf_alloc(void);
128 void TRACE_surf_release(void);
129 void TRACE_surf_host_set_power(double date, const char *resource, double power);
130 void TRACE_surf_link_set_bandwidth(double date, const char *resource, double bandwidth);
131 void TRACE_surf_link_set_latency(double date, const char *resource, double latency);
132 void TRACE_surf_action(surf_action_t surf_action, const char *category);
133
134 //for tracing gtnets
135 void TRACE_surf_gtnets_communicate(void *action, const char *src, const char *dst);
136 void TRACE_surf_gtnets_destroy(void *action);
137
138 /* from smpi_instr.c */
139 void TRACE_internal_smpi_set_category (const char *category);
140 const char *TRACE_internal_smpi_get_category (void);
141 void TRACE_smpi_alloc(void);
142 void TRACE_smpi_release(void);
143 void TRACE_smpi_init(int rank);
144 void TRACE_smpi_finalize(int rank);
145 void TRACE_smpi_collective_in(int rank, int root, const char *operation);
146 void TRACE_smpi_collective_out(int rank, int root, const char *operation);
147 void TRACE_smpi_ptp_in(int rank, int src, int dst, const char *operation);
148 void TRACE_smpi_ptp_out(int rank, int src, int dst, const char *operation);
149 void TRACE_smpi_send(int rank, int src, int dst);
150 void TRACE_smpi_recv(int rank, int src, int dst);
151
152 /* from instr_config.c */
153 int TRACE_start (void);
154 int TRACE_end (void);
155 int TRACE_needs_platform (void);
156 int TRACE_is_enabled(void);
157 int TRACE_platform(void);
158 int TRACE_is_configured(void);
159 int TRACE_smpi_is_enabled(void);
160 int TRACE_smpi_is_grouped(void);
161 int TRACE_categorized (void);
162 int TRACE_uncategorized (void);
163 int TRACE_msg_process_is_enabled(void);
164 int TRACE_buffer (void);
165 int TRACE_onelink_only (void);
166 int TRACE_disable_destroy (void);
167 char *TRACE_get_filename(void);
168 char *TRACE_get_triva_uncat_conf (void);
169 char *TRACE_get_triva_cat_conf (void);
170 void TRACE_global_init(int *argc, char **argv);
171 void TRACE_help(int detailed);
172 void TRACE_generate_triva_uncat_conf (void);
173 void TRACE_generate_triva_cat_conf (void);
174
175 /* from resource_utilization.c */
176 void TRACE_surf_host_set_utilization(const char *resource,
177                                      const char *category,
178                                      double value,
179                                      double now,
180                                      double delta);
181 void TRACE_surf_link_set_utilization(const char *resource,
182                                      const char *category,
183                                      double value,
184                                      double now,
185                                      double delta);
186 void TRACE_surf_resource_utilization_alloc(void);
187 void TRACE_surf_resource_utilization_release(void);
188
189 /* sd_instr.c */
190 void TRACE_sd_task_create(SD_task_t task);
191 void TRACE_sd_task_destroy(SD_task_t task);
192
193 /* instr_paje.c */
194 extern xbt_dict_t trivaNodeTypes;
195 extern xbt_dict_t trivaEdgeTypes;
196 long long int instr_new_paje_id (void);
197 void PJ_container_alloc (void);
198 void PJ_container_release (void);
199 container_t PJ_container_new (const char *name, e_container_types kind, container_t father);
200 container_t PJ_container_get (const char *name);
201 container_t PJ_container_get_or_null (const char *name);
202 container_t PJ_container_get_root (void);
203 void PJ_container_set_root (container_t root);
204 void PJ_container_free (container_t container);
205 void PJ_container_free_all (void);
206 void PJ_container_remove_from_parent (container_t container);
207
208 /* instr_paje_types.c */
209 void PJ_type_alloc (void);
210 void PJ_type_release (void);
211 type_t PJ_type_get_root (void);
212 type_t PJ_type_container_new (const char *name, type_t father);
213 type_t PJ_type_event_new (const char *name, const char *color, type_t father);
214 type_t PJ_type_variable_new (const char *name, const char *color, type_t father);
215 type_t PJ_type_link_new (const char *name, type_t father, type_t source, type_t dest);
216 type_t PJ_type_state_new (const char *name, type_t father);
217 type_t PJ_type_get (const char *name, const type_t father);
218 type_t PJ_type_get_or_null (const char *name, type_t father);
219 void PJ_type_free (type_t type);
220 void PJ_type_free_all (void);
221
222 /* instr_paje_values.c */
223 val_t PJ_value_new (const char *name, const char *color, type_t father);
224 val_t PJ_value_get (const char *name, const type_t father);
225 void PJ_value_free (val_t value);
226
227 /* instr_routing.c */
228 void instr_routing_define_callbacks (void);
229 void instr_new_variable_type (const char *new_typename, const char *color);
230 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color);
231 int instr_platform_traced (void);
232 xbt_graph_t instr_routing_platform_graph (void);
233 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
234
235 #endif /* HAVE_TRACING */
236
237 #ifdef HAVE_JEDULE
238 #include "instr/jedule/jedule_sd_binding.h"
239 #endif
240
241 #endif /* INSTR_PRIVATE_H_ */