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.hpp"
   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, std::set<std::string>* filter)
  69 {
  70   //ignore loopback
  71   if (src->getName() == "__loopback__" || dst->getName() == "__loopback__") {
  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   // check if we already register this pair (we only need one direction)
  83   std::string aux1 = src->getName() + dst->getName();
  84   std::string aux2 = dst->getName() + src->getName();
  85   if (filter->find(aux1) != filter->end()) {
  86     XBT_DEBUG("  linkContainers: already registered %s <-> %s (1)", src->getCname(), dst->getCname());
  87     return;
  88   }
  89   if (filter->find(aux2) != filter->end()) {
  90     XBT_DEBUG("  linkContainers: already registered %s <-> %s (2)", dst->getCname(), src->getCname());
  91     return;
  92   }
  93
  94   // ok, not found, register it
  95   filter->insert(aux1);
  96   filter->insert(aux2);
  97
  98   //declare type
  99   std::string link_typename = father->type_->getName() + "-" + src->type_->getName() + src->type_->getId() + "-" +
 100                               dst->type_->getName() + dst->type_->getId();
 101   simgrid::instr::Type* link_type = father->type_->getOrCreateLinkType(link_typename, src->type_, dst->type_);
 102
 103   //register EDGE types for triva configuration
 104   trivaEdgeTypes.insert(link_type->getName());
 105
 106   //create the link
 107   static long long counter = 0;
 108
 109   char key[INSTR_DEFAULT_STR_SIZE];
 110   snprintf (key, INSTR_DEFAULT_STR_SIZE, "%lld", counter);
 111   counter++;
 112
 113   new simgrid::instr::StartLinkEvent(SIMIX_get_clock(), father, link_type, src, "topology", key);
 114   new simgrid::instr::EndLinkEvent(SIMIX_get_clock(), father, link_type, dst, "topology", key);
 115
 116   XBT_DEBUG("  linkContainers %s <-> %s", src->getCname(), dst->getCname());
 117 }
 118
 119 static void recursiveGraphExtraction(simgrid::s4u::NetZone* netzone, container_t container,
 120                                      std::set<std::string>* filter)
 121 {
 122   if (not TRACE_platform_topology()) {
 123     XBT_DEBUG("Graph extraction disabled by user.");
 124     return;
 125   }
 126   XBT_DEBUG("Graph extraction for NetZone = %s", netzone->getCname());
 127   if (not netzone->getChildren()->empty()) {
 128     //bottom-up recursion
 129     for (auto const& nz_son : *netzone->getChildren()) {
 130       container_t child_container = container->children_.at(nz_son->getCname());
 131       recursiveGraphExtraction(nz_son, child_container, filter);
 132     }
 133   }
 134
 135   xbt_graph_t graph = xbt_graph_new_graph (0, nullptr);
 136   std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
 137   std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
 138
 139   static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
 140   for (auto elm : *edges) {
 141     xbt_edge_t edge = elm.second;
 142     linkContainers(simgrid::instr::Container::byName(static_cast<const char*>(edge->src->data)),
 143                    simgrid::instr::Container::byName(static_cast<const char*>(edge->dst->data)), filter);
 144   }
 145   delete nodes;
 146   delete edges;
 147   xbt_graph_free_graph(graph, xbt_free_f, xbt_free_f, nullptr);
 148 }
 149
 150 /*
 151  * Callbacks
 152  */
 153 static void sg_instr_AS_begin(simgrid::s4u::NetZone& netzone)
 154 {
 155   std::string id = netzone.getName();
 156
 157   if (PJ_container_get_root() == nullptr){
 158     container_t root = new simgrid::instr::Container(id, simgrid::instr::INSTR_AS, nullptr);
 159     PJ_container_set_root (root);
 160
 161     if (TRACE_smpi_is_enabled()) {
 162       simgrid::instr::Type* mpi = root->type_->getOrCreateContainerType("MPI");
 163       if (not TRACE_smpi_is_grouped())
 164         mpi->getOrCreateStateType("MPI_STATE");
 165       simgrid::instr::Type::getRootType()->getOrCreateLinkType("MPI_LINK", mpi, mpi);
 166     }
 167
 168     if (TRACE_needs_platform()){
 169       currentContainer.push_back(root);
 170     }
 171     return;
 172   }
 173
 174   if (TRACE_needs_platform()){
 175     container_t father = currentContainer.back();
 176     container_t container = new simgrid::instr::Container(id, simgrid::instr::INSTR_AS, father);
 177     currentContainer.push_back(container);
 178   }
 179 }
 180
 181 static void sg_instr_AS_end(simgrid::s4u::NetZone& /*netzone*/)
 182 {
 183   if (TRACE_needs_platform()){
 184     currentContainer.pop_back();
 185   }
 186 }
 187
 188 static void instr_routing_parse_start_link(simgrid::s4u::Link& link)
 189 {
 190   if (currentContainer.empty()) // No ongoing parsing. Are you creating the loopback?
 191     return;
 192
 193   container_t father    = currentContainer.back();
 194   container_t container = new simgrid::instr::Container(link.getName(), simgrid::instr::INSTR_LINK, father);
 195
 196   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_link())) {
 197     simgrid::instr::Type* bandwidth = container->type_->getOrCreateVariableType("bandwidth", "");
 198     simgrid::instr::Type* latency   = container->type_->getOrCreateVariableType("latency", "");
 199     new simgrid::instr::SetVariableEvent(0, container, bandwidth, link.bandwidth());
 200     new simgrid::instr::SetVariableEvent(0, container, latency, link.latency());
 201   }
 202   if (TRACE_uncategorized()) {
 203     container->type_->getOrCreateVariableType("bandwidth_used", "0.5 0.5 0.5");
 204   }
 205 }
 206
 207 static void sg_instr_new_host(simgrid::s4u::Host& host)
 208 {
 209   container_t father = currentContainer.back();
 210   container_t container = new simgrid::instr::Container(host.getName(), simgrid::instr::INSTR_HOST, father);
 211
 212   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_speed())) {
 213     simgrid::instr::Type* speed = container->type_->getOrCreateVariableType("power", "");
 214     new simgrid::instr::SetVariableEvent(0, container, speed, host.getSpeed());
 215   }
 216
 217   if (TRACE_uncategorized())
 218     container->type_->getOrCreateVariableType("power_used", "0.5 0.5 0.5");
 219
 220   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped())
 221     container->type_->getOrCreateContainerType("MPI")->getOrCreateStateType("MPI_STATE");
 222
 223   if (TRACE_msg_process_is_enabled()) {
 224     simgrid::instr::Type* msg_process = container->type_->getOrCreateContainerType("MSG_PROCESS");
 225     simgrid::instr::Type* state       = msg_process->getOrCreateStateType("MSG_PROCESS_STATE");
 226     simgrid::instr::Value::byNameOrCreate("suspend", "1 0 1", state);
 227     simgrid::instr::Value::byNameOrCreate("sleep", "1 1 0", state);
 228     simgrid::instr::Value::byNameOrCreate("receive", "1 0 0", state);
 229     simgrid::instr::Value::byNameOrCreate("send", "0 0 1", state);
 230     simgrid::instr::Value::byNameOrCreate("task_execute", "0 1 1", state);
 231     simgrid::instr::Type::getRootType()->getOrCreateLinkType("MSG_PROCESS_LINK", msg_process, msg_process);
 232     simgrid::instr::Type::getRootType()->getOrCreateLinkType("MSG_PROCESS_TASK_LINK", msg_process, msg_process);
 233   }
 234
 235   if (TRACE_msg_vm_is_enabled()) {
 236     simgrid::instr::Type* msg_vm = container->type_->getOrCreateContainerType("MSG_VM");
 237     simgrid::instr::Type* state  = msg_vm->getOrCreateStateType("MSG_VM_STATE");
 238     simgrid::instr::Value::byNameOrCreate("suspend", "1 0 1", state);
 239     simgrid::instr::Value::byNameOrCreate("sleep", "1 1 0", state);
 240     simgrid::instr::Value::byNameOrCreate("receive", "1 0 0", state);
 241     simgrid::instr::Value::byNameOrCreate("send", "0 0 1", state);
 242     simgrid::instr::Value::byNameOrCreate("task_execute", "0 1 1", state);
 243     simgrid::instr::Type::getRootType()->getOrCreateLinkType("MSG_VM_LINK", msg_vm, msg_vm);
 244     simgrid::instr::Type::getRootType()->getOrCreateLinkType("MSG_VM_PROCESS_LINK", msg_vm, msg_vm);
 245   }
 246 }
 247
 248 static void sg_instr_new_router(simgrid::kernel::routing::NetPoint * netpoint)
 249 {
 250   if (not netpoint->isRouter())
 251     return;
 252   if (TRACE_is_enabled() && TRACE_needs_platform())
 253     new simgrid::instr::Container(netpoint->getCname(), simgrid::instr::INSTR_ROUTER, currentContainer.back());
 254 }
 255
 256 static void instr_routing_parse_end_platform ()
 257 {
 258   currentContainer.clear();
 259   std::set<std::string>* filter = new std::set<std::string>;
 260   XBT_DEBUG ("Starting graph extraction.");
 261   recursiveGraphExtraction(simgrid::s4u::Engine::getInstance()->getNetRoot(), PJ_container_get_root(), filter);
 262   XBT_DEBUG ("Graph extraction finished.");
 263   delete filter;
 264   platform_created = 1;
 265   TRACE_paje_dump_buffer(true);
 266 }
 267
 268 void instr_routing_define_callbacks ()
 269 {
 270   // always need the callbacks to ASes (we need only the root AS), to create the rootContainer and the rootType properly
 271   if (not TRACE_is_enabled())
 272     return;
 273   if (TRACE_needs_platform()) {
 274     simgrid::s4u::Link::onCreation.connect(instr_routing_parse_start_link);
 275     simgrid::s4u::onPlatformCreated.connect(instr_routing_parse_end_platform);
 276     simgrid::s4u::Host::onCreation.connect(sg_instr_new_host);
 277   }
 278   simgrid::s4u::NetZone::onCreation.connect(sg_instr_AS_begin);
 279   simgrid::s4u::NetZone::onSeal.connect(sg_instr_AS_end);
 280   simgrid::kernel::routing::NetPoint::onCreation.connect(sg_instr_new_router);
 281 }
 282 /*
 283  * user categories support
 284  */
 285 static void recursiveNewVariableType(std::string new_typename, const char* color, simgrid::instr::Type* root)
 286 {
 287   if (root->getName() == "HOST" || root->getName() == "MSG_VM")
 288     root->getOrCreateVariableType(std::string("p") + new_typename, color == nullptr ? "" : color);
 289
 290   if (root->getName() == "LINK")
 291     root->getOrCreateVariableType(std::string("b") + new_typename, color == nullptr ? "" : color);
 292
 293   for (auto elm : root->children_) {
 294     recursiveNewVariableType(new_typename, color == nullptr ? "" : color, elm.second);
 295   }
 296 }
 297
 298 void instr_new_variable_type(std::string new_typename, const char* color)
 299 {
 300   recursiveNewVariableType(new_typename, color, simgrid::instr::Type::getRootType());
 301 }
 302
 303 static void recursiveNewUserVariableType(std::string father_type, std::string new_typename, const char* color,
 304                                          simgrid::instr::Type* root)
 305 {
 306   if (root->getName() == father_type) {
 307     root->getOrCreateVariableType(new_typename, color == nullptr ? "" : color);
 308   }
 309   for (auto elm : root->children_)
 310     recursiveNewUserVariableType(father_type, new_typename, color, elm.second);
 311 }
 312
 313 void instr_new_user_variable_type(std::string father_type, std::string new_typename, const char* color)
 314 {
 315   recursiveNewUserVariableType(father_type, new_typename, color, simgrid::instr::Type::getRootType());
 316 }
 317
 318 static void recursiveNewUserStateType(std::string father_type, std::string new_typename, simgrid::instr::Type* root)
 319 {
 320   if (root->getName() == father_type) {
 321     root->getOrCreateStateType(new_typename);
 322   }
 323   for (auto elm : root->children_)
 324     recursiveNewUserStateType(father_type, new_typename, elm.second);
 325 }
 326
 327 void instr_new_user_state_type(std::string father_type, std::string new_typename)
 328 {
 329   recursiveNewUserStateType(father_type, new_typename, simgrid::instr::Type::getRootType());
 330 }
 331
 332 static void recursiveNewValueForUserStateType(std::string type_name, const char* val, const char* color,
 333                                               simgrid::instr::Type* root)
 334 {
 335   if (root->getName() == type_name)
 336     simgrid::instr::Value::byNameOrCreate(val, color, root);
 337
 338   for (auto elm : root->children_)
 339     recursiveNewValueForUserStateType(type_name, val, color, elm.second);
 340 }
 341
 342 void instr_new_value_for_user_state_type(std::string type_name, const char* value, const char* color)
 343 {
 344   recursiveNewValueForUserStateType(type_name, value, color, simgrid::instr::Type::getRootType());
 345 }
 346
 347 int instr_platform_traced ()
 348 {
 349   return platform_created;
 350 }
 351
 352 #define GRAPHICATOR_SUPPORT_FUNCTIONS
 353
 354 static void recursiveXBTGraphExtraction(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
 355                                         std::map<std::string, xbt_edge_t>* edges, sg_netzone_t netzone,
 356                                         container_t container)
 357 {
 358   if (not netzone->getChildren()->empty()) {
 359     //bottom-up recursion
 360     for (auto const& netzone_child : *netzone->getChildren()) {
 361       container_t child_container = container->children_.at(netzone_child->getCname());
 362       recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
 363     }
 364   }
 365
 366   static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
 367 }
 368
 369 xbt_graph_t instr_routing_platform_graph ()
 370 {
 371   xbt_graph_t ret = xbt_graph_new_graph (0, nullptr);
 372   std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
 373   std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
 374   recursiveXBTGraphExtraction(ret, nodes, edges, simgrid::s4u::Engine::getInstance()->getNetRoot(),
 375                               PJ_container_get_root());
 376   delete nodes;
 377   delete edges;
 378   return ret;
 379 }
 380
 381 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
 382 {
 383   unsigned int cursor = 0;
 384   xbt_node_t node = nullptr;
 385   xbt_edge_t edge = nullptr;
 386
 387   FILE *file = fopen(filename, "w");
 388   xbt_assert(file, "Failed to open %s \n", filename);
 389
 390   if (g->directed)
 391     fprintf(file, "digraph test {\n");
 392   else
 393     fprintf(file, "graph test {\n");
 394
 395   fprintf(file, "  graph [overlap=scale]\n");
 396
 397   fprintf(file, "  node [shape=box, style=filled]\n");
 398   fprintf(file, "  node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
 399
 400   xbt_dynar_foreach(g->nodes, cursor, node) {
 401     fprintf(file, "  \"%s\";\n", instr_node_name(node));
 402   }
 403   xbt_dynar_foreach(g->edges, cursor, edge) {
 404     const char *src_s = instr_node_name (edge->src);
 405     const char *dst_s = instr_node_name (edge->dst);
 406     if (g->directed)
 407       fprintf(file, "  \"%s\" -> \"%s\";\n", src_s, dst_s);
 408     else
 409       fprintf(file, "  \"%s\" -- \"%s\";\n", src_s, dst_s);
 410   }
 411   fprintf(file, "}\n");
 412   fclose(file);
 413 }