1 /* Copyright (c) 2010-2017. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #include "src/instr/instr_private.hpp"
8 #include "simgrid/s4u/Engine.hpp"
9 #include "simgrid/s4u/Host.hpp"
10 #include "src/kernel/routing/NetZoneImpl.hpp"
11 #include "src/kernel/routing/NetPoint.hpp"
12 #include "src/surf/network_interface.hpp"
13 #include "src/surf/xml/platf_private.hpp"
14 #include "surf/surf.h"
15 #include "xbt/graph.h"
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_routing, instr, "Tracing platform hierarchy");
19 static int platform_created = 0; /* indicate whether the platform file has been traced */
20 static std::vector<container_t> currentContainer; /* push and pop, used only in creation */
22 static const char *instr_node_name (xbt_node_t node)
24 void *data = xbt_graph_node_get_data(node);
25 return static_cast<char*>(data);
28 static container_t lowestCommonAncestor (container_t a1, container_t a2)
30 //this is only an optimization (since most of a1 and a2 share the same parent)
31 if (a1->father_ == a2->father_)
34 //create an array with all ancestors of a1
35 std::vector<container_t> ancestors_a1;
36 container_t p = a1->father_;
38 ancestors_a1.push_back(p);
42 //create an array with all ancestors of a2
43 std::vector<container_t> ancestors_a2;
46 ancestors_a2.push_back(p);
50 //find the lowest ancestor
52 int i = ancestors_a1.size() - 1;
53 int j = ancestors_a2.size() - 1;
54 while (i >= 0 && j >= 0){
55 container_t a1p = ancestors_a1.at(i);
56 container_t a2p = ancestors_a2.at(j);
68 static void linkContainers(container_t src, container_t dst, std::set<std::string>* filter)
71 if (src->name_ == "__loopback__" || dst->name_ == "__loopback__") {
72 XBT_DEBUG (" linkContainers: ignoring loopback link");
77 container_t father = lowestCommonAncestor (src, dst);
79 xbt_die ("common father unknown, this is a tracing problem");
82 // check if we already register this pair (we only need one direction)
83 std::string aux1 = src->name_ + dst->name_;
84 std::string aux2 = dst->name_ + src->name_;
85 if (filter->find(aux1) != filter->end()) {
86 XBT_DEBUG(" linkContainers: already registered %s <-> %s (1)", src->name_.c_str(), dst->name_.c_str());
89 if (filter->find(aux2) != filter->end()) {
90 XBT_DEBUG(" linkContainers: already registered %s <-> %s (2)", dst->name_.c_str(), src->name_.c_str());
94 // ok, not found, register it
99 char link_typename[INSTR_DEFAULT_STR_SIZE];
100 snprintf(link_typename, INSTR_DEFAULT_STR_SIZE, "%s-%s%s-%s%s", father->type_->name_, src->type_->name_,
101 src->type_->id_, dst->type_->name_, dst->type_->id_);
102 simgrid::instr::Type* link_type = father->type_->getChildOrNull(link_typename);
103 if (link_type == nullptr)
104 link_type = simgrid::instr::Type::linkNew(link_typename, father->type_, src->type_, dst->type_);
106 //register EDGE types for triva configuration
107 trivaEdgeTypes.insert(link_type->name_);
110 static long long counter = 0;
112 char key[INSTR_DEFAULT_STR_SIZE];
113 snprintf (key, INSTR_DEFAULT_STR_SIZE, "%lld", counter);
116 new simgrid::instr::StartLinkEvent(SIMIX_get_clock(), father, link_type, src, "topology", key);
117 new simgrid::instr::EndLinkEvent(SIMIX_get_clock(), father, link_type, dst, "topology", key);
119 XBT_DEBUG(" linkContainers %s <-> %s", src->name_.c_str(), dst->name_.c_str());
122 static void recursiveGraphExtraction(simgrid::s4u::NetZone* netzone, container_t container,
123 std::set<std::string>* filter)
125 if (not TRACE_platform_topology()) {
126 XBT_DEBUG("Graph extraction disabled by user.");
129 XBT_DEBUG("Graph extraction for NetZone = %s", netzone->getCname());
130 if (not netzone->getChildren()->empty()) {
131 //bottom-up recursion
132 for (auto const& nz_son : *netzone->getChildren()) {
133 container_t child_container = container->children_.at(nz_son->getCname());
134 recursiveGraphExtraction(nz_son, child_container, filter);
138 xbt_graph_t graph = xbt_graph_new_graph (0, nullptr);
139 xbt_dict_t nodes = xbt_dict_new_homogeneous(nullptr);
140 xbt_dict_t edges = xbt_dict_new_homogeneous(nullptr);
141 xbt_edge_t edge = nullptr;
143 xbt_dict_cursor_t cursor = nullptr;
146 static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
147 xbt_dict_foreach(edges,cursor,edge_name,edge) {
149 PJ_container_get(static_cast<const char*>(edge->src->data)),
150 PJ_container_get(static_cast<const char*>(edge->dst->data)), filter);
152 xbt_dict_free (&nodes);
153 xbt_dict_free (&edges);
154 xbt_graph_free_graph(graph, xbt_free_f, xbt_free_f, nullptr);
160 static void sg_instr_AS_begin(simgrid::s4u::NetZone& netzone)
162 const char* id = netzone.getCname();
164 if (PJ_container_get_root() == nullptr){
165 container_t root = new simgrid::instr::Container(id, simgrid::instr::INSTR_AS, nullptr);
166 PJ_container_set_root (root);
168 if (TRACE_smpi_is_enabled()) {
169 simgrid::instr::Type* mpi = root->type_->getChildOrNull("MPI");
171 mpi = simgrid::instr::Type::containerNew("MPI", root->type_);
172 if (not TRACE_smpi_is_grouped())
173 simgrid::instr::Type::stateNew("MPI_STATE", mpi);
174 simgrid::instr::Type::linkNew("MPI_LINK", PJ_type_get_root(), mpi, mpi);
178 if (TRACE_needs_platform()){
179 currentContainer.push_back(root);
184 if (TRACE_needs_platform()){
185 container_t father = currentContainer.back();
186 container_t container = new simgrid::instr::Container(id, simgrid::instr::INSTR_AS, father);
187 currentContainer.push_back(container);
191 static void sg_instr_AS_end(simgrid::s4u::NetZone& /*netzone*/)
193 if (TRACE_needs_platform()){
194 currentContainer.pop_back();
198 static void instr_routing_parse_start_link(simgrid::s4u::Link& link)
200 if (currentContainer.empty()) // No ongoing parsing. Are you creating the loopback?
202 container_t father = currentContainer.back();
204 double bandwidth_value = link.bandwidth();
205 double latency_value = link.latency();
207 container_t container = new simgrid::instr::Container(link.name(), simgrid::instr::INSTR_LINK, father);
209 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_link())) {
210 simgrid::instr::Type* bandwidth = container->type_->getChildOrNull("bandwidth");
211 if (bandwidth == nullptr)
212 bandwidth = simgrid::instr::Type::variableNew("bandwidth", nullptr, container->type_);
213 simgrid::instr::Type* latency = container->type_->getChildOrNull("latency");
214 if (latency == nullptr)
215 latency = simgrid::instr::Type::variableNew("latency", nullptr, container->type_);
216 new simgrid::instr::SetVariableEvent(0, container, bandwidth, bandwidth_value);
217 new simgrid::instr::SetVariableEvent(0, container, latency, latency_value);
219 if (TRACE_uncategorized()) {
220 simgrid::instr::Type* bandwidth_used = container->type_->getChildOrNull("bandwidth_used");
221 if (bandwidth_used == nullptr)
222 simgrid::instr::Type::variableNew("bandwidth_used", "0.5 0.5 0.5", container->type_);
226 static void sg_instr_new_host(simgrid::s4u::Host& host)
228 container_t father = currentContainer.back();
229 container_t container = new simgrid::instr::Container(host.getCname(), simgrid::instr::INSTR_HOST, father);
231 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_speed())) {
232 simgrid::instr::Type* speed = container->type_->getChildOrNull("power");
233 if (speed == nullptr){
234 speed = simgrid::instr::Type::variableNew("power", nullptr, container->type_);
237 double current_speed_state = host.getSpeed();
238 new simgrid::instr::SetVariableEvent(0, container, speed, current_speed_state);
240 if (TRACE_uncategorized()){
241 simgrid::instr::Type* speed_used = container->type_->getChildOrNull("power_used");
242 if (speed_used == nullptr){
243 simgrid::instr::Type::variableNew("power_used", "0.5 0.5 0.5", container->type_);
247 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()){
248 simgrid::instr::Type* mpi = container->type_->getChildOrNull("MPI");
250 mpi = simgrid::instr::Type::containerNew("MPI", container->type_);
251 simgrid::instr::Type::stateNew("MPI_STATE", mpi);
255 if (TRACE_msg_process_is_enabled()) {
256 simgrid::instr::Type* msg_process = container->type_->getChildOrNull("MSG_PROCESS");
257 if (msg_process == nullptr){
258 msg_process = simgrid::instr::Type::containerNew("MSG_PROCESS", container->type_);
259 simgrid::instr::Type* state = simgrid::instr::Type::stateNew("MSG_PROCESS_STATE", msg_process);
260 new simgrid::instr::Value("suspend", "1 0 1", state);
261 simgrid::instr::Value::get_or_new("sleep", "1 1 0", state);
262 simgrid::instr::Value::get_or_new("receive", "1 0 0", state);
263 simgrid::instr::Value::get_or_new("send", "0 0 1", state);
264 simgrid::instr::Value::get_or_new("task_execute", "0 1 1", state);
265 simgrid::instr::Type::linkNew("MSG_PROCESS_LINK", PJ_type_get_root(), msg_process, msg_process);
266 simgrid::instr::Type::linkNew("MSG_PROCESS_TASK_LINK", PJ_type_get_root(), msg_process, msg_process);
270 if (TRACE_msg_vm_is_enabled()) {
271 simgrid::instr::Type* msg_vm = container->type_->getChildOrNull("MSG_VM");
272 if (msg_vm == nullptr){
273 msg_vm = simgrid::instr::Type::containerNew("MSG_VM", container->type_);
274 simgrid::instr::Type* state = simgrid::instr::Type::stateNew("MSG_VM_STATE", msg_vm);
275 new simgrid::instr::Value("suspend", "1 0 1", state);
276 simgrid::instr::Value::get_or_new("sleep", "1 1 0", state);
277 simgrid::instr::Value::get_or_new("receive", "1 0 0", state);
278 simgrid::instr::Value::get_or_new("send", "0 0 1", state);
279 simgrid::instr::Value::get_or_new("task_execute", "0 1 1", state);
280 simgrid::instr::Type::linkNew("MSG_VM_LINK", PJ_type_get_root(), msg_vm, msg_vm);
281 simgrid::instr::Type::linkNew("MSG_VM_PROCESS_LINK", PJ_type_get_root(), msg_vm, msg_vm);
286 static void sg_instr_new_router(simgrid::kernel::routing::NetPoint * netpoint)
288 if (not netpoint->isRouter())
290 if (TRACE_is_enabled() && TRACE_needs_platform()) {
291 container_t father = currentContainer.back();
292 new simgrid::instr::Container(netpoint->cname(), simgrid::instr::INSTR_ROUTER, father);
296 static void instr_routing_parse_end_platform ()
298 currentContainer.clear();
299 std::set<std::string>* filter = new std::set<std::string>;
300 XBT_DEBUG ("Starting graph extraction.");
301 recursiveGraphExtraction(simgrid::s4u::Engine::getInstance()->getNetRoot(), PJ_container_get_root(), filter);
302 XBT_DEBUG ("Graph extraction finished.");
304 platform_created = 1;
305 TRACE_paje_dump_buffer(1);
308 void instr_routing_define_callbacks ()
310 //always need the call backs to ASes (we need only the root AS),
311 //to create the rootContainer and the rootType properly
312 if (not TRACE_is_enabled())
314 if (TRACE_needs_platform()) {
315 simgrid::s4u::Link::onCreation.connect(instr_routing_parse_start_link);
316 simgrid::s4u::onPlatformCreated.connect(instr_routing_parse_end_platform);
317 simgrid::s4u::Host::onCreation.connect(sg_instr_new_host);
319 simgrid::s4u::NetZone::onCreation.connect(sg_instr_AS_begin);
320 simgrid::s4u::NetZone::onSeal.connect(sg_instr_AS_end);
321 simgrid::kernel::routing::NetPoint::onCreation.connect(&sg_instr_new_router);
324 * user categories support
326 static void recursiveNewVariableType(const char* new_typename, const char* color, simgrid::instr::Type* root)
328 if (not strcmp(root->name_, "HOST")) {
329 char tnstr[INSTR_DEFAULT_STR_SIZE];
330 snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
331 simgrid::instr::Type::variableNew(tnstr, color, root);
333 if (not strcmp(root->name_, "MSG_VM")) {
334 char tnstr[INSTR_DEFAULT_STR_SIZE];
335 snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
336 simgrid::instr::Type::variableNew(tnstr, color, root);
338 if (not strcmp(root->name_, "LINK")) {
339 char tnstr[INSTR_DEFAULT_STR_SIZE];
340 snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "b%s", new_typename);
341 simgrid::instr::Type::variableNew(tnstr, color, root);
343 xbt_dict_cursor_t cursor = nullptr;
344 simgrid::instr::Type* child_type;
346 xbt_dict_foreach (root->children_, cursor, name, child_type) {
347 recursiveNewVariableType (new_typename, color, child_type);
351 void instr_new_variable_type (const char *new_typename, const char *color)
353 recursiveNewVariableType (new_typename, color, PJ_type_get_root());
356 static void recursiveNewUserVariableType(const char* father_type, const char* new_typename, const char* color,
357 simgrid::instr::Type* root)
359 if (not strcmp(root->name_, father_type)) {
360 simgrid::instr::Type::variableNew(new_typename, color, root);
362 xbt_dict_cursor_t cursor = nullptr;
363 simgrid::instr::Type* child_type;
365 xbt_dict_foreach (root->children_, cursor, name, child_type) {
366 recursiveNewUserVariableType (father_type, new_typename, color, child_type);
370 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color)
372 recursiveNewUserVariableType (father_type, new_typename, color, PJ_type_get_root());
375 static void recursiveNewUserStateType(const char* father_type, const char* new_typename, simgrid::instr::Type* root)
377 if (not strcmp(root->name_, father_type)) {
378 simgrid::instr::Type::stateNew(new_typename, root);
380 xbt_dict_cursor_t cursor = nullptr;
381 simgrid::instr::Type* child_type;
383 xbt_dict_foreach (root->children_, cursor, name, child_type) {
384 recursiveNewUserStateType (father_type, new_typename, child_type);
388 void instr_new_user_state_type (const char *father_type, const char *new_typename)
390 recursiveNewUserStateType (father_type, new_typename, PJ_type_get_root());
393 static void recursiveNewValueForUserStateType(const char* type_name, const char* val, const char* color,
394 simgrid::instr::Type* root)
396 if (not strcmp(root->name_, type_name)) {
397 new simgrid::instr::Value(val, color, root);
399 xbt_dict_cursor_t cursor = nullptr;
400 simgrid::instr::Type* child_type;
402 xbt_dict_foreach (root->children_, cursor, name, child_type) {
403 recursiveNewValueForUserStateType(type_name, val, color, child_type);
407 void instr_new_value_for_user_state_type (const char *type_name, const char *value, const char *color)
409 recursiveNewValueForUserStateType (type_name, value, color, PJ_type_get_root());
412 int instr_platform_traced ()
414 return platform_created;
417 #define GRAPHICATOR_SUPPORT_FUNCTIONS
419 static void recursiveXBTGraphExtraction(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges, sg_netzone_t netzone,
420 container_t container)
422 if (not netzone->getChildren()->empty()) {
423 //bottom-up recursion
424 for (auto const& netzone_child : *netzone->getChildren()) {
425 container_t child_container = container->children_.at(netzone_child->getCname());
426 recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
430 static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
433 xbt_graph_t instr_routing_platform_graph ()
435 xbt_graph_t ret = xbt_graph_new_graph (0, nullptr);
436 xbt_dict_t nodes = xbt_dict_new_homogeneous(nullptr);
437 xbt_dict_t edges = xbt_dict_new_homogeneous(nullptr);
438 recursiveXBTGraphExtraction(ret, nodes, edges, simgrid::s4u::Engine::getInstance()->getNetRoot(),
439 PJ_container_get_root());
440 xbt_dict_free (&nodes);
441 xbt_dict_free (&edges);
445 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
447 unsigned int cursor = 0;
448 xbt_node_t node = nullptr;
449 xbt_edge_t edge = nullptr;
451 FILE *file = fopen(filename, "w");
452 xbt_assert(file, "Failed to open %s \n", filename);
455 fprintf(file, "digraph test {\n");
457 fprintf(file, "graph test {\n");
459 fprintf(file, " graph [overlap=scale]\n");
461 fprintf(file, " node [shape=box, style=filled]\n");
462 fprintf(file, " node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
464 xbt_dynar_foreach(g->nodes, cursor, node) {
465 fprintf(file, " \"%s\";\n", instr_node_name(node));
467 xbt_dynar_foreach(g->edges, cursor, edge) {
468 const char *src_s = instr_node_name (edge->src);
469 const char *dst_s = instr_node_name (edge->dst);
471 fprintf(file, " \"%s\" -> \"%s\";\n", src_s, dst_s);
473 fprintf(file, " \"%s\" -- \"%s\";\n", src_s, dst_s);
475 fprintf(file, "}\n");