Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
6ceeade23078c91d548da088d8fa6fd88ab5c120
[simgrid.git] / 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 pajeSetVariable(double time, const char *entityType,
67                      const char *container, const char *value);
68 void pajeAddVariable(double time, const char *entityType,
69                      const char *container, const char *value);
70 void pajeSubVariable(double time, const char *entityType,
71                      const char *container, const char *value);
72 void pajeNewEvent(double time, const char *entityType,
73                   const char *container, const char *value);
74
75 /* from general.c */
76 char *TRACE_paje_msg_container(m_task_t task, char *host, char *output,
77                                int len);
78 char *TRACE_paje_smx_container(smx_action_t action, int seqnumber,
79                                char *host, char *output, int len);
80 char *TRACE_paje_surf_container(void *action, int seqnumber, char *output,
81                                 int len);
82 char *TRACE_host_container(m_host_t host, char *output, int len);
83 char *TRACE_task_container(m_task_t task, char *output, int len);
84 char *TRACE_process_container(m_process_t process, char *output, int len);
85 char *TRACE_process_alias_container(m_process_t process, m_host_t host,
86                                     char *output, int len);
87 char *TRACE_task_alias_container(m_task_t task, m_process_t process,
88                                  m_host_t host, char *output, int len);
89
90 /* from categories.c */
91 void TRACE_category_alloc(void);
92 void TRACE_category_release(void);
93 void TRACE_category_set(smx_process_t proc, const char *category);
94 char *TRACE_category_get(smx_process_t proc);
95 void TRACE_category_unset(smx_process_t proc);
96 void TRACE_msg_category_set(smx_process_t proc, m_task_t task);
97
98 /* declaration of instrumentation functions from msg_task_instr.c */
99 void TRACE_msg_task_alloc(void);
100 void TRACE_msg_task_release(void);
101 void TRACE_msg_task_create(m_task_t task);
102 void TRACE_msg_task_execute_start(m_task_t task);
103 void TRACE_msg_task_execute_end(m_task_t task);
104 void TRACE_msg_task_destroy(m_task_t task);
105 void TRACE_msg_task_get_start(void);
106 void TRACE_msg_task_get_end(double start_time, m_task_t task);
107 int TRACE_msg_task_put_start(m_task_t task);    //returns TRUE if the task_put_end must be called
108 void TRACE_msg_task_put_end(void);
109
110 /* declaration of instrumentation functions from msg_process_instr.c */
111 void TRACE_msg_process_alloc(void);
112 void TRACE_msg_process_release(void);
113 void TRACE_msg_process_change_host(m_process_t process, m_host_t old_host,
114                                    m_host_t new_host);
115 void TRACE_msg_process_kill(m_process_t process);
116 void TRACE_msg_process_suspend(m_process_t process);
117 void TRACE_msg_process_resume(m_process_t process);
118 void TRACE_msg_process_sleep_in(m_process_t process);   //called from msg/gos.c
119 void TRACE_msg_process_sleep_out(m_process_t process);
120 void TRACE_msg_process_end(m_process_t process);
121
122 /* declaration of instrumentation functions from msg_volume.c */
123 void TRACE_msg_volume_start(m_task_t task);
124 void TRACE_msg_volume_finish(m_task_t task);
125
126 /* from smx.c */
127 void TRACE_smx_action_execute(smx_action_t act);
128 void TRACE_smx_action_communicate(smx_action_t act, smx_process_t proc);
129 void TRACE_smx_action_destroy(smx_action_t act);
130
131 /* from surf_instr.c */
132 void TRACE_surf_alloc(void);
133 void TRACE_surf_release(void);
134 void TRACE_surf_host_declaration(const char *name, double power);
135 void TRACE_surf_host_set_power(double date, const char *resource,
136                                double power);
137 void TRACE_surf_host_define_id(const char *name, int host_id);
138 void TRACE_surf_host_vivaldi_parse(char *host, double x, double y,
139                                    double h);
140 void TRACE_surf_link_declaration(void *link, char *name, double bw,
141                                  double lat);
142 void TRACE_surf_link_set_bandwidth(double date, void *link,
143                                    double bandwidth);
144 void TRACE_surf_link_set_latency(double date, void *link, double latency);
145 void TRACE_surf_save_onelink(void);
146 int TRACE_surf_link_is_traced(void *link);
147 void TRACE_surf_action(surf_action_t surf_action, const char *category);
148
149 //for tracing gtnets
150 void TRACE_surf_gtnets_communicate(void *action, int src, int dst);
151 int TRACE_surf_gtnets_get_src(void *action);
152 int TRACE_surf_gtnets_get_dst(void *action);
153 void TRACE_surf_gtnets_destroy(void *action);
154
155 /* from smpi_instr.c */
156 void TRACE_smpi_alloc(void);
157 void TRACE_smpi_release(void);
158 void TRACE_smpi_init(int rank);
159 void TRACE_smpi_finalize(int rank);
160 void TRACE_smpi_start(void);
161 void TRACE_smpi_collective_in(int rank, int root, const char *operation);
162 void TRACE_smpi_collective_out(int rank, int root, const char *operation);
163 void TRACE_smpi_ptp_in(int rank, int src, int dst, const char *operation);
164 void TRACE_smpi_ptp_out(int rank, int src, int dst, const char *operation);
165 void TRACE_smpi_send(int rank, int src, int dst);
166 void TRACE_smpi_recv(int rank, int src, int dst);
167
168 /* from instr_config.c */
169 int TRACE_is_configured(void);
170 int TRACE_smpi_is_enabled(void);
171 int TRACE_smpi_is_grouped(void);
172 int TRACE_platform_is_enabled(void);
173 int TRACE_msg_task_is_enabled(void);
174 int TRACE_msg_process_is_enabled(void);
175 int TRACE_msg_volume_is_enabled(void);
176 char *TRACE_get_filename(void);
177 char *TRACE_get_platform_method(void);
178 void TRACE_global_init(int *argc, char **argv);
179
180 /* from resource_utilization.c */
181 void TRACE_surf_host_set_utilization(const char *name,
182                                      smx_action_t smx_action,
183                                      surf_action_t surf_action,
184                                      double value, double now,
185                                      double delta);
186 void TRACE_surf_link_set_utilization(void *link, smx_action_t smx_action,
187                                      surf_action_t surf_action,
188                                      double value, double now,
189                                      double delta);
190 void TRACE_surf_resource_utilization_start(smx_action_t action);
191 void TRACE_surf_resource_utilization_event(smx_action_t action, double now,
192                                            double delta,
193                                            const char *variable,
194                                            const char *resource,
195                                            double value);
196 void TRACE_surf_resource_utilization_end(smx_action_t action);
197 void TRACE_surf_resource_utilization_alloc(void);
198 void TRACE_surf_resource_utilization_release(void);
199
200 /* sd_instr.c */
201 void TRACE_sd_task_create(SD_task_t task);
202 void TRACE_sd_task_destroy(SD_task_t task);
203
204 #endif
205
206 #endif                          /* PRIVATE_H_ */