1 /* Copyright (c) 2010, 2012-2015. 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 #include "src/instr/instr_private.h"
9 #include "simgrid/s4u/engine.hpp"
10 #include "simgrid/s4u/host.hpp"
12 #include "src/kernel/routing/NetZoneImpl.hpp"
13 #include "src/surf/network_interface.hpp"
14 #include "src/surf/xml/platf_private.hpp"
15 #include "surf/surf.h"
16 #include "xbt/graph.h"
18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_routing, instr, "Tracing platform hierarchy");
20 static int platform_created = 0; /* indicate whether the platform file has been traced */
21 static std::vector<container_t> currentContainer; /* push and pop, used only in creation */
23 static const char *instr_node_name (xbt_node_t node)
25 void *data = xbt_graph_node_get_data(node);
26 return static_cast<char*>(data);
29 static container_t lowestCommonAncestor (container_t a1, container_t a2)
31 //this is only an optimization (since most of a1 and a2 share the same parent)
32 if (a1->father == a2->father)
35 //create an array with all ancestors of a1
36 std::vector<container_t> ancestors_a1;
37 container_t p = a1->father;
39 ancestors_a1.push_back(p);
43 //create an array with all ancestors of a2
44 std::vector<container_t> ancestors_a2;
47 ancestors_a2.push_back(p);
51 //find the lowest ancestor
53 int i = ancestors_a1.size() - 1;
54 int j = ancestors_a2.size() - 1;
55 while (i >= 0 && j >= 0){
56 container_t a1p = ancestors_a1.at(i);
57 container_t a2p = ancestors_a2.at(j);
69 static void linkContainers (container_t src, container_t dst, xbt_dict_t filter)
72 if (strcmp (src->name, "__loopback__") == 0 || strcmp (dst->name, "__loopback__") == 0){
73 XBT_DEBUG (" linkContainers: ignoring loopback link");
78 container_t father = lowestCommonAncestor (src, dst);
80 xbt_die ("common father unknown, this is a tracing problem");
83 if (filter != nullptr){
84 //check if we already register this pair (we only need one direction)
85 char aux1[INSTR_DEFAULT_STR_SIZE];
86 char aux2[INSTR_DEFAULT_STR_SIZE];
87 snprintf (aux1, INSTR_DEFAULT_STR_SIZE, "%s%s", src->name, dst->name);
88 snprintf (aux2, INSTR_DEFAULT_STR_SIZE, "%s%s", dst->name, src->name);
89 if (xbt_dict_get_or_null (filter, aux1)){
90 XBT_DEBUG (" linkContainers: already registered %s <-> %s (1)", src->name, dst->name);
93 if (xbt_dict_get_or_null (filter, aux2)){
94 XBT_DEBUG (" linkContainers: already registered %s <-> %s (2)", dst->name, src->name);
98 //ok, not found, register it
99 xbt_dict_set (filter, aux1, xbt_strdup ("1"), nullptr);
100 xbt_dict_set (filter, aux2, xbt_strdup ("1"), nullptr);
104 char link_typename[INSTR_DEFAULT_STR_SIZE];
105 snprintf (link_typename, INSTR_DEFAULT_STR_SIZE, "%s-%s%s-%s%s",
107 src->type->name, src->type->id,
108 dst->type->name, dst->type->id);
109 type_t link_type = PJ_type_get_or_null (link_typename, father->type);
110 if (link_type == nullptr){
111 link_type = PJ_type_link_new (link_typename, father->type, src->type, dst->type);
114 //register EDGE types for triva configuration
115 xbt_dict_set (trivaEdgeTypes, link_type->name, xbt_strdup("1"), nullptr);
118 static long long counter = 0;
120 char key[INSTR_DEFAULT_STR_SIZE];
121 snprintf (key, INSTR_DEFAULT_STR_SIZE, "%lld", counter);
124 new_pajeStartLink(SIMIX_get_clock(), father, link_type, src, "topology", key);
125 new_pajeEndLink(SIMIX_get_clock(), father, link_type, dst, "topology", key);
127 XBT_DEBUG (" linkContainers %s <-> %s", src->name, dst->name);
130 static void recursiveGraphExtraction(simgrid::s4u::NetZone* netzone, container_t container, xbt_dict_t filter)
132 if (!TRACE_platform_topology()){
133 XBT_DEBUG("Graph extraction disabled by user.");
136 XBT_DEBUG("Graph extraction for NetZone = %s", netzone->name());
137 if (!xbt_dict_is_empty(netzone->children())) {
138 xbt_dict_cursor_t cursor = nullptr;
141 //bottom-up recursion
142 xbt_dict_foreach (netzone->children(), cursor, child_name, nz_son) {
143 container_t child_container = static_cast<container_t>(xbt_dict_get(container->children, nz_son->name()));
144 recursiveGraphExtraction(nz_son, child_container, filter);
148 xbt_graph_t graph = xbt_graph_new_graph (0, nullptr);
149 xbt_dict_t nodes = xbt_dict_new_homogeneous(nullptr);
150 xbt_dict_t edges = xbt_dict_new_homogeneous(nullptr);
151 xbt_edge_t edge = nullptr;
153 xbt_dict_cursor_t cursor = nullptr;
156 static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
157 xbt_dict_foreach(edges,cursor,edge_name,edge) {
159 PJ_container_get(static_cast<const char*>(edge->src->data)),
160 PJ_container_get(static_cast<const char*>(edge->dst->data)), filter);
162 xbt_dict_free (&nodes);
163 xbt_dict_free (&edges);
164 xbt_graph_free_graph(graph, xbt_free_f, xbt_free_f, nullptr);
170 void sg_instr_AS_begin(sg_platf_AS_cbarg_t AS)
172 const char*id = AS->id;
174 if (PJ_container_get_root() == nullptr){
175 PJ_container_alloc ();
177 container_t root = PJ_container_new (id, INSTR_AS, nullptr);
178 PJ_container_set_root (root);
180 if (TRACE_smpi_is_enabled()) {
181 type_t mpi = PJ_type_get_or_null ("MPI", root->type);
183 mpi = PJ_type_container_new("MPI", root->type);
184 if (!TRACE_smpi_is_grouped())
185 PJ_type_state_new ("MPI_STATE", mpi);
186 PJ_type_link_new ("MPI_LINK", PJ_type_get_root(), mpi, mpi);
190 if (TRACE_needs_platform()){
191 currentContainer.push_back(root);
196 if (TRACE_needs_platform()){
197 container_t father = currentContainer.back();
198 container_t container = PJ_container_new (id, INSTR_AS, father);
199 currentContainer.push_back(container);
203 void sg_instr_AS_end()
205 if (TRACE_needs_platform()){
206 currentContainer.pop_back();
210 static void instr_routing_parse_start_link(simgrid::s4u::Link& link)
212 if (currentContainer.empty()) // No ongoing parsing. Are you creating the loopback?
214 container_t father = currentContainer.back();
216 double bandwidth_value = link.bandwidth();
217 double latency_value = link.latency();
219 container_t container = PJ_container_new(link.name(), INSTR_LINK, father);
221 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (! TRACE_disable_link())) {
222 type_t bandwidth = PJ_type_get_or_null("bandwidth", container->type);
223 if (bandwidth == nullptr) {
224 bandwidth = PJ_type_variable_new("bandwidth", nullptr, container->type);
226 type_t latency = PJ_type_get_or_null("latency", container->type);
227 if (latency == nullptr) {
228 latency = PJ_type_variable_new("latency", nullptr, container->type);
230 new_pajeSetVariable(0, container, bandwidth, bandwidth_value);
231 new_pajeSetVariable(0, container, latency, latency_value);
233 if (TRACE_uncategorized()) {
234 type_t bandwidth_used = PJ_type_get_or_null("bandwidth_used", container->type);
235 if (bandwidth_used == nullptr) {
236 PJ_type_variable_new("bandwidth_used", "0.5 0.5 0.5", container->type);
241 void sg_instr_new_host(simgrid::s4u::Host& host)
243 container_t father = currentContainer.back();
244 container_t container = PJ_container_new(host.cname(), INSTR_HOST, father);
246 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (! TRACE_disable_speed())) {
247 type_t speed = PJ_type_get_or_null ("power", container->type);
248 if (speed == nullptr){
249 speed = PJ_type_variable_new ("power", nullptr, container->type);
252 double current_speed_state = host.getPstateSpeedCurrent();
253 new_pajeSetVariable (0, container, speed, current_speed_state);
255 if (TRACE_uncategorized()){
256 type_t speed_used = PJ_type_get_or_null ("power_used", container->type);
257 if (speed_used == nullptr){
258 PJ_type_variable_new ("power_used", "0.5 0.5 0.5", container->type);
262 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()){
263 type_t mpi = PJ_type_get_or_null ("MPI", container->type);
265 mpi = PJ_type_container_new("MPI", container->type);
266 PJ_type_state_new ("MPI_STATE", mpi);
270 if (TRACE_msg_process_is_enabled()) {
271 type_t msg_process = PJ_type_get_or_null ("MSG_PROCESS", container->type);
272 if (msg_process == nullptr){
273 msg_process = PJ_type_container_new("MSG_PROCESS", container->type);
274 type_t state = PJ_type_state_new ("MSG_PROCESS_STATE", msg_process);
275 PJ_value_new ("suspend", "1 0 1", state);
276 PJ_value_new ("sleep", "1 1 0", state);
277 PJ_value_new ("receive", "1 0 0", state);
278 PJ_value_new ("send", "0 0 1", state);
279 PJ_value_new ("task_execute", "0 1 1", state);
280 PJ_type_link_new ("MSG_PROCESS_LINK", PJ_type_get_root(), msg_process, msg_process);
281 PJ_type_link_new ("MSG_PROCESS_TASK_LINK", PJ_type_get_root(), msg_process, msg_process);
285 if (TRACE_msg_vm_is_enabled()) {
286 type_t msg_vm = PJ_type_get_or_null ("MSG_VM", container->type);
287 if (msg_vm == nullptr){
288 msg_vm = PJ_type_container_new("MSG_VM", container->type);
289 type_t state = PJ_type_state_new ("MSG_VM_STATE", msg_vm);
290 PJ_value_new ("suspend", "1 0 1", state);
291 PJ_value_new ("sleep", "1 1 0", state);
292 PJ_value_new ("receive", "1 0 0", state);
293 PJ_value_new ("send", "0 0 1", state);
294 PJ_value_new ("task_execute", "0 1 1", state);
295 PJ_type_link_new ("MSG_VM_LINK", PJ_type_get_root(), msg_vm, msg_vm);
296 PJ_type_link_new ("MSG_VM_PROCESS_LINK", PJ_type_get_root(), msg_vm, msg_vm);
302 void sg_instr_new_router(const char* name)
304 if (TRACE_is_enabled() && TRACE_needs_platform()) {
305 container_t father = currentContainer.back();
306 PJ_container_new(name, INSTR_ROUTER, father);
310 static void instr_routing_parse_end_platform ()
312 currentContainer.clear();
313 xbt_dict_t filter = xbt_dict_new_homogeneous(xbt_free_f);
314 XBT_DEBUG ("Starting graph extraction.");
315 recursiveGraphExtraction(simgrid::s4u::Engine::instance()->netRoot(), PJ_container_get_root(), filter);
316 XBT_DEBUG ("Graph extraction finished.");
317 xbt_dict_free(&filter);
318 platform_created = 1;
319 TRACE_paje_dump_buffer(1);
322 void instr_routing_define_callbacks ()
324 //always need the call backs to ASes (we need only the root AS),
325 //to create the rootContainer and the rootType properly
326 if (!TRACE_is_enabled() || !TRACE_needs_platform())
328 simgrid::s4u::Link::onCreation.connect(instr_routing_parse_start_link);
329 simgrid::s4u::onPlatformCreated.connect(instr_routing_parse_end_platform);
333 * user categories support
335 static void recursiveNewVariableType (const char *new_typename, const char *color, type_t root)
337 if (!strcmp (root->name, "HOST")){
338 char tnstr[INSTR_DEFAULT_STR_SIZE];
339 snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
340 PJ_type_variable_new (tnstr, color, root);
342 if (!strcmp (root->name, "MSG_VM")){
343 char tnstr[INSTR_DEFAULT_STR_SIZE];
344 snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
345 PJ_type_variable_new (tnstr, color, root);
347 if (!strcmp (root->name, "LINK")){
348 char tnstr[INSTR_DEFAULT_STR_SIZE];
349 snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "b%s", new_typename);
350 PJ_type_variable_new (tnstr, color, root);
352 xbt_dict_cursor_t cursor = nullptr;
355 xbt_dict_foreach(root->children, cursor, name, child_type) {
356 recursiveNewVariableType (new_typename, color, child_type);
360 void instr_new_variable_type (const char *new_typename, const char *color)
362 recursiveNewVariableType (new_typename, color, PJ_type_get_root());
365 static void recursiveNewUserVariableType (const char *father_type, const char *new_typename, const char *color, type_t root)
367 if (!strcmp (root->name, father_type)){
368 PJ_type_variable_new (new_typename, color, root);
370 xbt_dict_cursor_t cursor = nullptr;
373 xbt_dict_foreach(root->children, cursor, name, child_type) {
374 recursiveNewUserVariableType (father_type, new_typename, color, child_type);
378 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color)
380 recursiveNewUserVariableType (father_type, new_typename, color, PJ_type_get_root());
383 static void recursiveNewUserStateType (const char *father_type, const char *new_typename, type_t root)
385 if (!strcmp (root->name, father_type)){
386 PJ_type_state_new (new_typename, root);
388 xbt_dict_cursor_t cursor = nullptr;
391 xbt_dict_foreach(root->children, cursor, name, child_type) {
392 recursiveNewUserStateType (father_type, new_typename, child_type);
396 void instr_new_user_state_type (const char *father_type, const char *new_typename)
398 recursiveNewUserStateType (father_type, new_typename, PJ_type_get_root());
401 static void recursiveNewValueForUserStateType (const char *type_name, const char *value, const char *color, type_t root)
403 if (!strcmp (root->name, type_name)){
404 PJ_value_new (value, color, root);
406 xbt_dict_cursor_t cursor = nullptr;
409 xbt_dict_foreach(root->children, cursor, name, child_type) {
410 recursiveNewValueForUserStateType (type_name, value, color, child_type);
414 void instr_new_value_for_user_state_type (const char *type_name, const char *value, const char *color)
416 recursiveNewValueForUserStateType (type_name, value, color, PJ_type_get_root());
419 int instr_platform_traced ()
421 return platform_created;
424 #define GRAPHICATOR_SUPPORT_FUNCTIONS
426 static void recursiveXBTGraphExtraction(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges, sg_netzone_t netzone,
427 container_t container)
429 if (!xbt_dict_is_empty(netzone->children())) {
430 xbt_dict_cursor_t cursor = nullptr;
431 sg_netzone_t netzone_child;
433 //bottom-up recursion
434 xbt_dict_foreach (netzone->children(), cursor, child_name, netzone_child) {
435 container_t child_container = static_cast<container_t>(xbt_dict_get(container->children, netzone_child->name()));
436 recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
440 static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
443 xbt_graph_t instr_routing_platform_graph ()
445 xbt_graph_t ret = xbt_graph_new_graph (0, nullptr);
446 xbt_dict_t nodes = xbt_dict_new_homogeneous(nullptr);
447 xbt_dict_t edges = xbt_dict_new_homogeneous(nullptr);
448 recursiveXBTGraphExtraction(ret, nodes, edges, simgrid::s4u::Engine::instance()->netRoot(), PJ_container_get_root());
449 xbt_dict_free (&nodes);
450 xbt_dict_free (&edges);
454 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
456 unsigned int cursor = 0;
457 xbt_node_t node = nullptr;
458 xbt_edge_t edge = nullptr;
460 FILE *file = fopen(filename, "w");
461 xbt_assert(file, "Failed to open %s \n", filename);
464 fprintf(file, "digraph test {\n");
466 fprintf(file, "graph test {\n");
468 fprintf(file, " graph [overlap=scale]\n");
470 fprintf(file, " node [shape=box, style=filled]\n");
471 fprintf(file, " node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
473 xbt_dynar_foreach(g->nodes, cursor, node) {
474 fprintf(file, " \"%s\";\n", instr_node_name(node));
476 xbt_dynar_foreach(g->edges, cursor, edge) {
477 const char *src_s = instr_node_name (edge->src);
478 const char *dst_s = instr_node_name (edge->dst);
480 fprintf(file, " \"%s\" -> \"%s\";\n", src_s, dst_s);
482 fprintf(file, " \"%s\" -- \"%s\";\n", src_s, dst_s);
484 fprintf(file, "}\n");