Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace] declaring xbt_log categories for tracing
[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 #define INSTR_DEFAULT_STR_SIZE 500
15
16 #include "instr/instr.h"
17 #include "msg/msg.h"
18 #include "simdag/private.h"
19 #include "simix/private.h"
20
21 /* from paje.c */
22 void TRACE_paje_create_header(void);
23 void TRACE_paje_start(void);
24 void TRACE_paje_end(void);
25 void pajeDefineContainerType(const char *alias, const char *containerType,
26                              const char *name);
27 void pajeDefineStateType(const char *alias, const char *containerType,
28                          const char *name);
29 void pajeDefineEventType(const char *alias, const char *containerType,
30                          const char *name);
31 void pajeDefineLinkType(const char *alias, const char *containerType,
32                         const char *sourceContainerType,
33                         const char *destContainerType, const char *name);
34 void pajeCreateContainer(double time, const char *alias, const char *type,
35                          const char *container, const char *name);
36 void pajeDestroyContainer(double time, const char *type,
37                           const char *container);
38 void pajeSetState(double time, const char *entityType,
39                   const char *container, const char *value);
40 void pajePushState(double time, const char *entityType,
41                    const char *container, const char *value);
42 void pajePopState(double time, const char *entityType,
43                   const char *container);
44 void pajeStartLink(double time, const char *entityType,
45                    const char *container, const char *value,
46                    const char *sourceContainer, const char *key);
47 void pajeStartLinkWithVolume(double time, const char *entityType,
48                              const char *container, const char *value,
49                              const char *sourceContainer, const char *key,
50                              double volume);
51 void pajeEndLink(double time, const char *entityType,
52                  const char *container, const char *value,
53                  const char *destContainer, const char *key);
54 void pajeDefineVariableType(const char *alias, const char *containerType,
55                             const char *name);
56 void pajeDefineVariableTypeWithColor(const char *alias, const char *containerType,
57                             const char *name, const char *color);
58 void pajeSetVariable(double time, const char *entityType,
59                      const char *container, const char *value);
60 void pajeAddVariable(double time, const char *entityType,
61                      const char *container, const char *value);
62 void pajeSubVariable(double time, const char *entityType,
63                      const char *container, const char *value);
64 void pajeNewEvent(double time, const char *entityType,
65                   const char *container, const char *value);
66
67 /* from categories.c */
68 void TRACE_category_alloc(void);
69 void TRACE_category_release(void);
70 void TRACE_category_set(smx_process_t proc, const char *category);
71 char *TRACE_category_get(smx_process_t proc);
72 void TRACE_category_unset(smx_process_t proc);
73 void TRACE_msg_category_set(smx_process_t proc, m_task_t task);
74
75 /* declaration of instrumentation functions from msg_task_instr.c */
76 char *TRACE_task_container(m_task_t task, char *output, int len);
77 void TRACE_msg_task_alloc(void);
78 void TRACE_msg_task_release(void);
79 void TRACE_msg_task_create(m_task_t task);
80 void TRACE_msg_task_execute_start(m_task_t task);
81 void TRACE_msg_task_execute_end(m_task_t task);
82 void TRACE_msg_task_destroy(m_task_t task);
83 void TRACE_msg_task_get_start(void);
84 void TRACE_msg_task_get_end(double start_time, m_task_t task);
85 int TRACE_msg_task_put_start(m_task_t task);    //returns TRUE if the task_put_end must be called
86 void TRACE_msg_task_put_end(void);
87
88 /* declaration of instrumentation functions from msg_process_instr.c */
89 char *TRACE_process_alias_container(m_process_t process, m_host_t host,
90                                     char *output, int len);
91 char *TRACE_process_container(m_process_t process, char *output, int len);
92 void TRACE_msg_process_alloc(void);
93 void TRACE_msg_process_release(void);
94 void TRACE_msg_process_change_host(m_process_t process, m_host_t old_host,
95                                    m_host_t new_host);
96 void TRACE_msg_process_kill(m_process_t process);
97 void TRACE_msg_process_suspend(m_process_t process);
98 void TRACE_msg_process_resume(m_process_t process);
99 void TRACE_msg_process_sleep_in(m_process_t process);   //called from msg/gos.c
100 void TRACE_msg_process_sleep_out(m_process_t process);
101 void TRACE_msg_process_end(m_process_t process);
102
103 /* declaration of instrumentation functions from msg_volume.c */
104 void TRACE_msg_volume_start(m_task_t task);
105 void TRACE_msg_volume_finish(m_task_t task);
106
107 /* from smx.c */
108 void TRACE_smx_host_execute(smx_action_t act);
109 void TRACE_smx_action_communicate(smx_action_t act, smx_process_t proc);
110 void TRACE_smx_action_destroy(smx_action_t act);
111
112 /* from surf_instr.c */
113 void TRACE_surf_alloc(void);
114 void TRACE_surf_release(void);
115 void TRACE_surf_host_declaration(const char *name, double power);
116 void TRACE_surf_host_set_power(double date, const char *resource,
117                                double power);
118 void TRACE_surf_host_define_id(const char *name, int host_id);
119 void TRACE_surf_host_vivaldi_parse(char *host, double x, double y,
120                                    double h);
121 void TRACE_surf_link_declaration(void *link, char *name, double bw,
122                                  double lat);
123 void TRACE_surf_link_set_bandwidth(double date, void *link,
124                                    double bandwidth);
125 void TRACE_surf_link_set_latency(double date, void *link, double latency);
126 void TRACE_surf_save_onelink(void);
127 int TRACE_surf_link_is_traced(void *link);
128 void TRACE_surf_action(surf_action_t surf_action, const char *category);
129
130 //for tracing gtnets
131 void TRACE_surf_gtnets_communicate(void *action, int src, int dst);
132 int TRACE_surf_gtnets_get_src(void *action);
133 int TRACE_surf_gtnets_get_dst(void *action);
134 void TRACE_surf_gtnets_destroy(void *action);
135
136 /* from smpi_instr.c */
137 void TRACE_smpi_alloc(void);
138 void TRACE_smpi_release(void);
139 void TRACE_smpi_init(int rank);
140 void TRACE_smpi_finalize(int rank);
141 void TRACE_smpi_start(void);
142 void TRACE_smpi_collective_in(int rank, int root, const char *operation);
143 void TRACE_smpi_collective_out(int rank, int root, const char *operation);
144 void TRACE_smpi_ptp_in(int rank, int src, int dst, const char *operation);
145 void TRACE_smpi_ptp_out(int rank, int src, int dst, const char *operation);
146 void TRACE_smpi_send(int rank, int src, int dst);
147 void TRACE_smpi_recv(int rank, int src, int dst);
148
149 /* from instr_config.c */
150 void TRACE_activate (void);
151 void TRACE_desactivate (void);
152 int TRACE_is_active (void);
153 int TRACE_is_enabled(void);
154 int TRACE_is_configured(void);
155 int TRACE_smpi_is_enabled(void);
156 int TRACE_smpi_is_grouped(void);
157 int TRACE_platform_is_enabled(void);
158 int TRACE_uncategorized (void);
159 int TRACE_msg_task_is_enabled(void);
160 int TRACE_msg_process_is_enabled(void);
161 int TRACE_msg_volume_is_enabled(void);
162 char *TRACE_get_filename(void);
163 char *TRACE_get_platform_method(void);
164 char *TRACE_get_triva_uncat_conf (void);
165 char *TRACE_get_triva_cat_conf (void);
166 void TRACE_global_init(int *argc, char **argv);
167 void TRACE_help(int detailed);
168 void TRACE_generate_triva_uncat_conf (void);
169 void TRACE_generate_triva_cat_conf (void);
170
171 /* from resource_utilization.c */
172 void TRACE_surf_host_set_utilization(const char *name,
173                                      smx_action_t smx_action,
174                                      surf_action_t surf_action,
175                                      double value, double now,
176                                      double delta);
177 void TRACE_surf_link_set_utilization(void *link, smx_action_t smx_action,
178                                      surf_action_t surf_action,
179                                      double value, double now,
180                                      double delta);
181 void TRACE_surf_resource_utilization_start(smx_action_t action);
182 void TRACE_surf_resource_utilization_event(smx_action_t action, double now,
183                                            double delta,
184                                            const char *variable,
185                                            const char *resource,
186                                            double value);
187 void TRACE_surf_resource_utilization_end(smx_action_t action);
188 void TRACE_surf_resource_utilization_alloc(void);
189 void TRACE_surf_resource_utilization_release(void);
190
191 /* sd_instr.c */
192 void TRACE_sd_task_create(SD_task_t task);
193 void TRACE_sd_task_destroy(SD_task_t task);
194
195 #endif /* HAVE_TRACING */
196 #endif /* INSTR_PRIVATE_H_ */