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