src/surf/instr_routing.cpp

   1 /* Copyright (c) 2010-2017. The SimGrid Team. All rights reserved.          */
   2
   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. */
   5
   6 #include "src/instr/instr_private.h"
   7
   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"
  16
  17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_routing, instr, "Tracing platform hierarchy");
  18
  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 */
  21
  22 static const char *instr_node_name (xbt_node_t node)
  23 {
  24   void *data = xbt_graph_node_get_data(node);
  25   return static_cast<char*>(data);
  26 }
  27
  28 static container_t lowestCommonAncestor (container_t a1, container_t a2)
  29 {
  30   //this is only an optimization (since most of a1 and a2 share the same parent)
  31   if (a1->father_ == a2->father_)
  32     return a1->father_;
  33
  34   //create an array with all ancestors of a1
  35   std::vector<container_t> ancestors_a1;
  36   container_t p = a1->father_;
  37   while (p){
  38     ancestors_a1.push_back(p);
  39     p = p->father_;
  40   }
  41
  42   //create an array with all ancestors of a2
  43   std::vector<container_t> ancestors_a2;
  44   p = a2->father_;
  45   while (p){
  46     ancestors_a2.push_back(p);
  47     p = p->father_;
  48   }
  49
  50   //find the lowest ancestor
  51   p = nullptr;
  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);
  57     if (a1p == a2p){
  58       p = a1p;
  59     }else{
  60       break;
  61     }
  62     i--;
  63     j--;
  64   }
  65   return p;
  66 }
  67
  68 static void linkContainers (container_t src, container_t dst, xbt_dict_t filter)
  69 {
  70   //ignore loopback
  71   if (strcmp(src->name_, "__loopback__") == 0 || strcmp(dst->name_, "__loopback__") == 0) {
  72     XBT_DEBUG ("  linkContainers: ignoring loopback link");
  73     return;
  74   }
  75
  76   //find common father
  77   container_t father = lowestCommonAncestor (src, dst);
  78   if (not father) {
  79     xbt_die ("common father unknown, this is a tracing problem");
  80   }
  81
  82   if (filter != nullptr){
  83     //check if we already register this pair (we only need one direction)
  84     char aux1[INSTR_DEFAULT_STR_SIZE];
  85     char aux2[INSTR_DEFAULT_STR_SIZE];
  86     snprintf(aux1, INSTR_DEFAULT_STR_SIZE, "%s%s", src->name_, dst->name_);
  87     snprintf(aux2, INSTR_DEFAULT_STR_SIZE, "%s%s", dst->name_, src->name_);
  88     if (xbt_dict_get_or_null (filter, aux1)){
  89       XBT_DEBUG("  linkContainers: already registered %s <-> %s (1)", src->name_, dst->name_);
  90       return;
  91     }
  92     if (xbt_dict_get_or_null (filter, aux2)){
  93       XBT_DEBUG("  linkContainers: already registered %s <-> %s (2)", dst->name_, src->name_);
  94       return;
  95     }
  96
  97     //ok, not found, register it
  98     xbt_dict_set (filter, aux1, xbt_strdup ("1"), nullptr);
  99     xbt_dict_set (filter, aux2, xbt_strdup ("1"), nullptr);
 100   }
 101
 102   //declare type
 103   char link_typename[INSTR_DEFAULT_STR_SIZE];
 104   snprintf(link_typename, INSTR_DEFAULT_STR_SIZE, "%s-%s%s-%s%s", father->type_->name_, src->type_->name_,
 105            src->type_->id_, dst->type_->name_, dst->type_->id_);
 106   simgrid::instr::Type* link_type = simgrid::instr::Type::getOrNull(link_typename, father->type_);
 107   if (link_type == nullptr){
 108     link_type = simgrid::instr::Type::linkNew(link_typename, father->type_, src->type_, dst->type_);
 109   }
 110
 111   //register EDGE types for triva configuration
 112   trivaEdgeTypes.insert(link_type->name_);
 113
 114   //create the link
 115   static long long counter = 0;
 116
 117   char key[INSTR_DEFAULT_STR_SIZE];
 118   snprintf (key, INSTR_DEFAULT_STR_SIZE, "%lld", counter);
 119   counter++;
 120
 121   new simgrid::instr::StartLinkEvent(SIMIX_get_clock(), father, link_type, src, "topology", key);
 122   new simgrid::instr::EndLinkEvent(SIMIX_get_clock(), father, link_type, dst, "topology", key);
 123
 124   XBT_DEBUG("  linkContainers %s <-> %s", src->name_, dst->name_);
 125 }
 126
 127 static void recursiveGraphExtraction(simgrid::s4u::NetZone* netzone, container_t container, xbt_dict_t filter)
 128 {
 129   if (not TRACE_platform_topology()) {
 130     XBT_DEBUG("Graph extraction disabled by user.");
 131     return;
 132   }
 133   XBT_DEBUG("Graph extraction for NetZone = %s", netzone->getCname());
 134   if (not netzone->getChildren()->empty()) {
 135     //bottom-up recursion
 136     for (auto const& nz_son : *netzone->getChildren()) {
 137       container_t child_container = static_cast<container_t>(xbt_dict_get(container->children_, nz_son->getCname()));
 138       recursiveGraphExtraction(nz_son, child_container, filter);
 139     }
 140   }
 141
 142   xbt_graph_t graph = xbt_graph_new_graph (0, nullptr);
 143   xbt_dict_t nodes = xbt_dict_new_homogeneous(nullptr);
 144   xbt_dict_t edges = xbt_dict_new_homogeneous(nullptr);
 145   xbt_edge_t edge = nullptr;
 146
 147   xbt_dict_cursor_t cursor = nullptr;
 148   char *edge_name;
 149
 150   static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
 151   xbt_dict_foreach(edges,cursor,edge_name,edge) {
 152     linkContainers(
 153           PJ_container_get(static_cast<const char*>(edge->src->data)),
 154           PJ_container_get(static_cast<const char*>(edge->dst->data)), filter);
 155   }
 156   xbt_dict_free (&nodes);
 157   xbt_dict_free (&edges);
 158   xbt_graph_free_graph(graph, xbt_free_f, xbt_free_f, nullptr);
 159 }
 160
 161 /*
 162  * Callbacks
 163  */
 164 static void sg_instr_AS_begin(simgrid::s4u::NetZone& netzone)
 165 {
 166   const char* id = netzone.getCname();
 167
 168   if (PJ_container_get_root() == nullptr){
 169     PJ_container_alloc ();
 170     container_t root = PJ_container_new(id, simgrid::instr::INSTR_AS, nullptr);
 171     PJ_container_set_root (root);
 172
 173     if (TRACE_smpi_is_enabled()) {
 174       simgrid::instr::Type* mpi = simgrid::instr::Type::getOrNull("MPI", root->type_);
 175       if (mpi == nullptr){
 176         mpi = simgrid::instr::Type::containerNew("MPI", root->type_);
 177         if (not TRACE_smpi_is_grouped())
 178           simgrid::instr::Type::stateNew("MPI_STATE", mpi);
 179         simgrid::instr::Type::linkNew("MPI_LINK", PJ_type_get_root(), mpi, mpi);
 180       }
 181     }
 182
 183     if (TRACE_needs_platform()){
 184       currentContainer.push_back(root);
 185     }
 186     return;
 187   }
 188
 189   if (TRACE_needs_platform()){
 190     container_t father = currentContainer.back();
 191     container_t container = PJ_container_new(id, simgrid::instr::INSTR_AS, father);
 192     currentContainer.push_back(container);
 193   }
 194 }
 195
 196 static void sg_instr_AS_end(simgrid::s4u::NetZone& /*netzone*/)
 197 {
 198   if (TRACE_needs_platform()){
 199     currentContainer.pop_back();
 200   }
 201 }
 202
 203 static void instr_routing_parse_start_link(simgrid::s4u::Link& link)
 204 {
 205   if (currentContainer.empty()) // No ongoing parsing. Are you creating the loopback?
 206     return;
 207   container_t father = currentContainer.back();
 208
 209   double bandwidth_value = link.bandwidth();
 210   double latency_value   = link.latency();
 211
 212   container_t container = PJ_container_new(link.name(), simgrid::instr::INSTR_LINK, father);
 213
 214   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_link())) {
 215     simgrid::instr::Type* bandwidth = simgrid::instr::Type::getOrNull("bandwidth", container->type_);
 216     if (bandwidth == nullptr) {
 217       bandwidth = simgrid::instr::Type::variableNew("bandwidth", nullptr, container->type_);
 218     }
 219     simgrid::instr::Type* latency = simgrid::instr::Type::getOrNull("latency", container->type_);
 220     if (latency == nullptr) {
 221       latency = simgrid::instr::Type::variableNew("latency", nullptr, container->type_);
 222     }
 223     new simgrid::instr::SetVariableEvent(0, container, bandwidth, bandwidth_value);
 224     new simgrid::instr::SetVariableEvent(0, container, latency, latency_value);
 225   }
 226   if (TRACE_uncategorized()) {
 227     simgrid::instr::Type* bandwidth_used = simgrid::instr::Type::getOrNull("bandwidth_used", container->type_);
 228     if (bandwidth_used == nullptr) {
 229       simgrid::instr::Type::variableNew("bandwidth_used", "0.5 0.5 0.5", container->type_);
 230     }
 231   }
 232 }
 233
 234 static void sg_instr_new_host(simgrid::s4u::Host& host)
 235 {
 236   container_t father = currentContainer.back();
 237   container_t container = PJ_container_new(host.getCname(), simgrid::instr::INSTR_HOST, father);
 238
 239   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_speed())) {
 240     simgrid::instr::Type* speed = simgrid::instr::Type::getOrNull("power", container->type_);
 241     if (speed == nullptr){
 242       speed = simgrid::instr::Type::variableNew("power", nullptr, container->type_);
 243     }
 244
 245     double current_speed_state = host.getSpeed();
 246     new simgrid::instr::SetVariableEvent(0, container, speed, current_speed_state);
 247   }
 248   if (TRACE_uncategorized()){
 249     simgrid::instr::Type* speed_used = simgrid::instr::Type::getOrNull("power_used", container->type_);
 250     if (speed_used == nullptr){
 251       simgrid::instr::Type::variableNew("power_used", "0.5 0.5 0.5", container->type_);
 252     }
 253   }
 254
 255   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()){
 256     simgrid::instr::Type* mpi = simgrid::instr::Type::getOrNull("MPI", container->type_);
 257     if (mpi == nullptr){
 258       mpi = simgrid::instr::Type::containerNew("MPI", container->type_);
 259       simgrid::instr::Type::stateNew("MPI_STATE", mpi);
 260     }
 261   }
 262
 263   if (TRACE_msg_process_is_enabled()) {
 264     simgrid::instr::Type* msg_process = simgrid::instr::Type::getOrNull("MSG_PROCESS", container->type_);
 265     if (msg_process == nullptr){
 266       msg_process                 = simgrid::instr::Type::containerNew("MSG_PROCESS", container->type_);
 267       simgrid::instr::Type* state = simgrid::instr::Type::stateNew("MSG_PROCESS_STATE", msg_process);
 268       simgrid::instr::Value PJ_value("suspend", "1 0 1", state);
 269       simgrid::instr::Value::get_or_new("sleep", "1 1 0", state);
 270       simgrid::instr::Value::get_or_new("receive", "1 0 0", state);
 271       simgrid::instr::Value::get_or_new("send", "0 0 1", state);
 272       simgrid::instr::Value::get_or_new("task_execute", "0 1 1", state);
 273       simgrid::instr::Type::linkNew("MSG_PROCESS_LINK", PJ_type_get_root(), msg_process, msg_process);
 274       simgrid::instr::Type::linkNew("MSG_PROCESS_TASK_LINK", PJ_type_get_root(), msg_process, msg_process);
 275     }
 276   }
 277
 278   if (TRACE_msg_vm_is_enabled()) {
 279     simgrid::instr::Type* msg_vm = simgrid::instr::Type::getOrNull("MSG_VM", container->type_);
 280     if (msg_vm == nullptr){
 281       msg_vm                      = simgrid::instr::Type::containerNew("MSG_VM", container->type_);
 282       simgrid::instr::Type* state = simgrid::instr::Type::stateNew("MSG_VM_STATE", msg_vm);
 283       simgrid::instr::Value PJ_value("suspend", "1 0 1", state);
 284       simgrid::instr::Value::get_or_new("sleep", "1 1 0", state);
 285       simgrid::instr::Value::get_or_new("receive", "1 0 0", state);
 286       simgrid::instr::Value::get_or_new("send", "0 0 1", state);
 287       simgrid::instr::Value::get_or_new("task_execute", "0 1 1", state);
 288       simgrid::instr::Type::linkNew("MSG_VM_LINK", PJ_type_get_root(), msg_vm, msg_vm);
 289       simgrid::instr::Type::linkNew("MSG_VM_PROCESS_LINK", PJ_type_get_root(), msg_vm, msg_vm);
 290     }
 291   }
 292
 293 }
 294
 295 static void sg_instr_new_router(simgrid::kernel::routing::NetPoint * netpoint)
 296 {
 297   if (not netpoint->isRouter())
 298     return;
 299   if (TRACE_is_enabled() && TRACE_needs_platform()) {
 300     container_t father = currentContainer.back();
 301     PJ_container_new(netpoint->cname(), simgrid::instr::INSTR_ROUTER, father);
 302   }
 303 }
 304
 305 static void instr_routing_parse_end_platform ()
 306 {
 307   currentContainer.clear();
 308   xbt_dict_t filter = xbt_dict_new_homogeneous(xbt_free_f);
 309   XBT_DEBUG ("Starting graph extraction.");
 310   recursiveGraphExtraction(simgrid::s4u::Engine::getInstance()->getNetRoot(), PJ_container_get_root(), filter);
 311   XBT_DEBUG ("Graph extraction finished.");
 312   xbt_dict_free(&filter);
 313   platform_created = 1;
 314   TRACE_paje_dump_buffer(1);
 315 }
 316
 317 void instr_routing_define_callbacks ()
 318 {
 319   //always need the call backs to ASes (we need only the root AS),
 320   //to create the rootContainer and the rootType properly
 321   if (not TRACE_is_enabled())
 322     return;
 323   if (TRACE_needs_platform()) {
 324     simgrid::s4u::Link::onCreation.connect(instr_routing_parse_start_link);
 325     simgrid::s4u::onPlatformCreated.connect(instr_routing_parse_end_platform);
 326     simgrid::s4u::Host::onCreation.connect(sg_instr_new_host);
 327   }
 328   simgrid::s4u::NetZone::onCreation.connect(sg_instr_AS_begin);
 329   simgrid::s4u::NetZone::onSeal.connect(sg_instr_AS_end);
 330   simgrid::kernel::routing::NetPoint::onCreation.connect(&sg_instr_new_router);
 331 }
 332 /*
 333  * user categories support
 334  */
 335 static void recursiveNewVariableType(const char* new_typename, const char* color, simgrid::instr::Type* root)
 336 {
 337   if (not strcmp(root->name_, "HOST")) {
 338     char tnstr[INSTR_DEFAULT_STR_SIZE];
 339     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
 340     simgrid::instr::Type::variableNew(tnstr, color, root);
 341   }
 342   if (not strcmp(root->name_, "MSG_VM")) {
 343     char tnstr[INSTR_DEFAULT_STR_SIZE];
 344     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
 345     simgrid::instr::Type::variableNew(tnstr, color, root);
 346   }
 347   if (not strcmp(root->name_, "LINK")) {
 348     char tnstr[INSTR_DEFAULT_STR_SIZE];
 349     snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "b%s", new_typename);
 350     simgrid::instr::Type::variableNew(tnstr, color, root);
 351   }
 352   xbt_dict_cursor_t cursor = nullptr;
 353   simgrid::instr::Type* child_type;
 354   char *name;
 355   xbt_dict_foreach (root->children_, cursor, name, child_type) {
 356     recursiveNewVariableType (new_typename, color, child_type);
 357   }
 358 }
 359
 360 void instr_new_variable_type (const char *new_typename, const char *color)
 361 {
 362   recursiveNewVariableType (new_typename, color, PJ_type_get_root());
 363 }
 364
 365 static void recursiveNewUserVariableType(const char* father_type, const char* new_typename, const char* color,
 366                                          simgrid::instr::Type* root)
 367 {
 368   if (not strcmp(root->name_, father_type)) {
 369     simgrid::instr::Type::variableNew(new_typename, color, root);
 370   }
 371   xbt_dict_cursor_t cursor = nullptr;
 372   simgrid::instr::Type* child_type;
 373   char *name;
 374   xbt_dict_foreach (root->children_, cursor, name, child_type) {
 375     recursiveNewUserVariableType (father_type, new_typename, color, child_type);
 376   }
 377 }
 378
 379 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color)
 380 {
 381   recursiveNewUserVariableType (father_type, new_typename, color, PJ_type_get_root());
 382 }
 383
 384 static void recursiveNewUserStateType(const char* father_type, const char* new_typename, simgrid::instr::Type* root)
 385 {
 386   if (not strcmp(root->name_, father_type)) {
 387     simgrid::instr::Type::stateNew(new_typename, root);
 388   }
 389   xbt_dict_cursor_t cursor = nullptr;
 390   simgrid::instr::Type* child_type;
 391   char *name;
 392   xbt_dict_foreach (root->children_, cursor, name, child_type) {
 393     recursiveNewUserStateType (father_type, new_typename, child_type);
 394   }
 395 }
 396
 397 void instr_new_user_state_type (const char *father_type, const char *new_typename)
 398 {
 399   recursiveNewUserStateType (father_type, new_typename, PJ_type_get_root());
 400 }
 401
 402 static void recursiveNewValueForUserStateType(const char* type_name, const char* val, const char* color,
 403                                               simgrid::instr::Type* root)
 404 {
 405   if (not strcmp(root->name_, type_name)) {
 406     simgrid::instr::Value PJ_value(val, color, root);
 407   }
 408   xbt_dict_cursor_t cursor = nullptr;
 409   simgrid::instr::Type* child_type;
 410   char *name;
 411   xbt_dict_foreach (root->children_, cursor, name, child_type) {
 412     recursiveNewValueForUserStateType(type_name, val, color, child_type);
 413   }
 414 }
 415
 416 void instr_new_value_for_user_state_type (const char *type_name, const char *value, const char *color)
 417 {
 418   recursiveNewValueForUserStateType (type_name, value, color, PJ_type_get_root());
 419 }
 420
 421 int instr_platform_traced ()
 422 {
 423   return platform_created;
 424 }
 425
 426 #define GRAPHICATOR_SUPPORT_FUNCTIONS
 427
 428 static void recursiveXBTGraphExtraction(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges, sg_netzone_t netzone,
 429                                         container_t container)
 430 {
 431   if (not netzone->getChildren()->empty()) {
 432     //bottom-up recursion
 433     for (auto const& netzone_child : *netzone->getChildren()) {
 434       container_t child_container =
 435           static_cast<container_t>(xbt_dict_get(container->children_, netzone_child->getCname()));
 436       recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
 437     }
 438   }
 439
 440   static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
 441 }
 442
 443 xbt_graph_t instr_routing_platform_graph ()
 444 {
 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::getInstance()->getNetRoot(),
 449                               PJ_container_get_root());
 450   xbt_dict_free (&nodes);
 451   xbt_dict_free (&edges);
 452   return ret;
 453 }
 454
 455 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
 456 {
 457   unsigned int cursor = 0;
 458   xbt_node_t node = nullptr;
 459   xbt_edge_t edge = nullptr;
 460
 461   FILE *file = fopen(filename, "w");
 462   xbt_assert(file, "Failed to open %s \n", filename);
 463
 464   if (g->directed)
 465     fprintf(file, "digraph test {\n");
 466   else
 467     fprintf(file, "graph test {\n");
 468
 469   fprintf(file, "  graph [overlap=scale]\n");
 470
 471   fprintf(file, "  node [shape=box, style=filled]\n");
 472   fprintf(file, "  node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
 473
 474   xbt_dynar_foreach(g->nodes, cursor, node) {
 475     fprintf(file, "  \"%s\";\n", instr_node_name(node));
 476   }
 477   xbt_dynar_foreach(g->edges, cursor, edge) {
 478     const char *src_s = instr_node_name (edge->src);
 479     const char *dst_s = instr_node_name (edge->dst);
 480     if (g->directed)
 481       fprintf(file, "  \"%s\" -> \"%s\";\n", src_s, dst_s);
 482     else
 483       fprintf(file, "  \"%s\" -- \"%s\";\n", src_s, dst_s);
 484   }
 485   fprintf(file, "}\n");
 486   fclose(file);
 487 }