src/surf/instr_routing.cpp

   1 /* Copyright (c) 2010-2018. 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/kernel/routing/NetPoint.hpp"
   9 #include "simgrid/kernel/routing/NetZoneImpl.hpp"
  10 #include "simgrid/s4u/Engine.hpp"
  11 #include "simgrid/s4u/Host.hpp"
  12 #include "src/surf/network_interface.hpp"
  13 #include "src/surf/xml/platf_private.hpp"
  14 #include "surf/surf.hpp"
  15 #include "xbt/graph.h"
  16
  17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_routing, instr, "Tracing platform hierarchy");
  18
  19 static std::vector<simgrid::instr::NetZoneContainer*> currentContainer; /* push and pop, used only in creation */
  20
  21 static const char *instr_node_name (xbt_node_t node)
  22 {
  23   void *data = xbt_graph_node_get_data(node);
  24   return static_cast<char*>(data);
  25 }
  26
  27 static container_t lowestCommonAncestor (container_t a1, container_t a2)
  28 {
  29   //this is only an optimization (since most of a1 and a2 share the same parent)
  30   if (a1->father_ == a2->father_)
  31     return a1->father_;
  32
  33   //create an array with all ancestors of a1
  34   std::vector<container_t> ancestors_a1;
  35   container_t p = a1->father_;
  36   while (p){
  37     ancestors_a1.push_back(p);
  38     p = p->father_;
  39   }
  40
  41   //create an array with all ancestors of a2
  42   std::vector<container_t> ancestors_a2;
  43   p = a2->father_;
  44   while (p){
  45     ancestors_a2.push_back(p);
  46     p = p->father_;
  47   }
  48
  49   //find the lowest ancestor
  50   p = nullptr;
  51   int i = ancestors_a1.size() - 1;
  52   int j = ancestors_a2.size() - 1;
  53   while (i >= 0 && j >= 0){
  54     container_t a1p = ancestors_a1.at(i);
  55     container_t a2p = ancestors_a2.at(j);
  56     if (a1p == a2p){
  57       p = a1p;
  58     }else{
  59       break;
  60     }
  61     i--;
  62     j--;
  63   }
  64   return p;
  65 }
  66
  67 static void linkContainers(container_t src, container_t dst, std::set<std::string>* filter)
  68 {
  69   //ignore loopback
  70   if (src->get_name() == "__loopback__" || dst->get_name() == "__loopback__") {
  71     XBT_DEBUG ("  linkContainers: ignoring loopback link");
  72     return;
  73   }
  74
  75   //find common father
  76   container_t father = lowestCommonAncestor (src, dst);
  77   if (not father) {
  78     xbt_die ("common father unknown, this is a tracing problem");
  79   }
  80
  81   // check if we already register this pair (we only need one direction)
  82   std::string aux1 = src->get_name() + dst->get_name();
  83   std::string aux2 = dst->get_name() + src->get_name();
  84   if (filter->find(aux1) != filter->end()) {
  85     XBT_DEBUG("  linkContainers: already registered %s <-> %s (1)", src->get_cname(), dst->get_cname());
  86     return;
  87   }
  88   if (filter->find(aux2) != filter->end()) {
  89     XBT_DEBUG("  linkContainers: already registered %s <-> %s (2)", dst->get_cname(), src->get_cname());
  90     return;
  91   }
  92
  93   // ok, not found, register it
  94   filter->insert(aux1);
  95   filter->insert(aux2);
  96
  97   //declare type
  98   std::string link_typename = father->type_->get_name() + "-" + src->type_->get_name() +
  99                               std::to_string(src->type_->get_id()) + "-" + dst->type_->get_name() +
 100                               std::to_string(dst->type_->get_id());
 101   simgrid::instr::LinkType* link = father->type_->getOrCreateLinkType(link_typename, src->type_, dst->type_);
 102   link->setCallingContainer(father);
 103
 104   //register EDGE types for triva configuration
 105   trivaEdgeTypes.insert(link->get_name());
 106
 107   //create the link
 108   static long long counter = 0;
 109
 110   std::string key = std::to_string(counter);
 111   counter++;
 112
 113   link->startEvent(src, "topology", key);
 114   link->endEvent(dst, "topology", key);
 115
 116   XBT_DEBUG("  linkContainers %s <-> %s", src->get_cname(), dst->get_cname());
 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->get_cname());
 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->get_cname());
 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)->get_graph(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.get_name();
 156
 157   if (simgrid::instr::Container::getRoot() == nullptr) {
 158     simgrid::instr::NetZoneContainer* root = new simgrid::instr::NetZoneContainer(id, 0, nullptr);
 159
 160     if (TRACE_smpi_is_enabled()) {
 161       simgrid::instr::Type* mpi = root->type_->getOrCreateContainerType("MPI");
 162       if (not TRACE_smpi_is_grouped())
 163         mpi->getOrCreateStateType("MPI_STATE");
 164       root->type_->getOrCreateLinkType("MPI_LINK", mpi, mpi);
 165       // TODO See if we can move this to the LoadBalancer plugin
 166       root->type_->getOrCreateLinkType("MIGRATE_LINK", mpi, mpi);
 167       mpi->getOrCreateStateType("MIGRATE_STATE");
 168     }
 169
 170     if (TRACE_needs_platform()){
 171       currentContainer.push_back(root);
 172     }
 173     return;
 174   }
 175
 176   if (TRACE_needs_platform()){
 177     simgrid::instr::NetZoneContainer* container =
 178         new simgrid::instr::NetZoneContainer(id, currentContainer.size(), currentContainer.back());
 179     currentContainer.push_back(container);
 180   }
 181 }
 182
 183 static void sg_instr_AS_end(simgrid::s4u::NetZone& /*netzone*/)
 184 {
 185   if (TRACE_needs_platform()){
 186     currentContainer.pop_back();
 187   }
 188 }
 189
 190 static void instr_routing_parse_start_link(simgrid::s4u::Link& link)
 191 {
 192   if (currentContainer.empty()) // No ongoing parsing. Are you creating the loopback?
 193     return;
 194
 195   container_t father    = currentContainer.back();
 196   container_t container = new simgrid::instr::Container(link.get_name(), "LINK", father);
 197
 198   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_link())) {
 199     simgrid::instr::VariableType* bandwidth = container->type_->getOrCreateVariableType("bandwidth", "");
 200     bandwidth->setCallingContainer(container);
 201     bandwidth->setEvent(0, link.bandwidth());
 202     simgrid::instr::VariableType* latency = container->type_->getOrCreateVariableType("latency", "");
 203     latency->setCallingContainer(container);
 204     latency->setEvent(0, link.latency());
 205   }
 206   if (TRACE_uncategorized()) {
 207     container->type_->getOrCreateVariableType("bandwidth_used", "0.5 0.5 0.5");
 208   }
 209 }
 210
 211 static void sg_instr_new_host(simgrid::s4u::Host& host)
 212 {
 213   container_t container = new simgrid::instr::HostContainer(host, currentContainer.back());
 214   container_t root      = simgrid::instr::Container::getRoot();
 215
 216   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_speed())) {
 217     simgrid::instr::VariableType* power = container->type_->getOrCreateVariableType("power", "");
 218     power->setCallingContainer(container);
 219     power->setEvent(0, host.getSpeed());
 220   }
 221
 222   if (TRACE_uncategorized())
 223     container->type_->getOrCreateVariableType("power_used", "0.5 0.5 0.5");
 224
 225   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()) {
 226     simgrid::instr::ContainerType* mpi = container->type_->getOrCreateContainerType("MPI");
 227     mpi->getOrCreateStateType("MPI_STATE");
 228     // TODO See if we can move this to the LoadBalancer plugin
 229     root->type_->getOrCreateLinkType("MIGRATE_LINK", mpi, mpi);
 230     mpi->getOrCreateStateType("MIGRATE_STATE");
 231   }
 232
 233   if (TRACE_actor_is_enabled()) {
 234     simgrid::instr::ContainerType* actor = container->type_->getOrCreateContainerType("ACTOR");
 235     simgrid::instr::StateType* state     = actor->getOrCreateStateType("ACTOR_STATE");
 236     state->addEntityValue("suspend", "1 0 1");
 237     state->addEntityValue("sleep", "1 1 0");
 238     state->addEntityValue("receive", "1 0 0");
 239     state->addEntityValue("send", "0 0 1");
 240     state->addEntityValue("task_execute", "0 1 1");
 241     root->type_->getOrCreateLinkType("ACTOR_LINK", actor, actor);
 242     root->type_->getOrCreateLinkType("ACTOR_TASK_LINK", actor, actor);
 243   }
 244
 245   if (TRACE_vm_is_enabled()) {
 246     simgrid::instr::ContainerType* msg_vm = container->type_->getOrCreateContainerType("MSG_VM");
 247     simgrid::instr::StateType* state      = msg_vm->getOrCreateStateType("MSG_VM_STATE");
 248     state->addEntityValue("suspend", "1 0 1");
 249     state->addEntityValue("sleep", "1 1 0");
 250     state->addEntityValue("receive", "1 0 0");
 251     state->addEntityValue("send", "0 0 1");
 252     state->addEntityValue("task_execute", "0 1 1");
 253     root->type_->getOrCreateLinkType("MSG_VM_LINK", msg_vm, msg_vm);
 254     root->type_->getOrCreateLinkType("MSG_VM_ACTOR_LINK", msg_vm, msg_vm);
 255   }
 256 }
 257
 258 static void sg_instr_new_router(simgrid::kernel::routing::NetPoint * netpoint)
 259 {
 260   if (netpoint->is_router() && TRACE_is_enabled() && TRACE_needs_platform())
 261     new simgrid::instr::RouterContainer(netpoint->get_cname(), currentContainer.back());
 262 }
 263
 264 static void instr_routing_parse_end_platform ()
 265 {
 266   currentContainer.clear();
 267   std::set<std::string>* filter = new std::set<std::string>;
 268   XBT_DEBUG ("Starting graph extraction.");
 269   recursiveGraphExtraction(simgrid::s4u::Engine::getInstance()->getNetRoot(), simgrid::instr::Container::getRoot(),
 270                            filter);
 271   XBT_DEBUG ("Graph extraction finished.");
 272   delete filter;
 273   TRACE_paje_dump_buffer(true);
 274 }
 275
 276 void instr_routing_define_callbacks ()
 277 {
 278   // always need the callbacks to ASes (we need only the root AS), to create the rootContainer and the rootType properly
 279   if (not TRACE_is_enabled())
 280     return;
 281   if (TRACE_needs_platform()) {
 282     simgrid::s4u::Link::onCreation.connect(instr_routing_parse_start_link);
 283     simgrid::s4u::onPlatformCreated.connect(instr_routing_parse_end_platform);
 284     simgrid::s4u::Host::onCreation.connect(sg_instr_new_host);
 285   }
 286   simgrid::s4u::NetZone::onCreation.connect(sg_instr_AS_begin);
 287   simgrid::s4u::NetZone::onSeal.connect(sg_instr_AS_end);
 288   simgrid::kernel::routing::NetPoint::onCreation.connect(sg_instr_new_router);
 289 }
 290 /*
 291  * user categories support
 292  */
 293 static void recursiveNewVariableType(std::string new_typename, std::string color, simgrid::instr::Type* root)
 294 {
 295   if (root->get_name() == "HOST" || root->get_name() == "MSG_VM")
 296     root->getOrCreateVariableType(std::string("p") + new_typename, color);
 297
 298   if (root->get_name() == "LINK")
 299     root->getOrCreateVariableType(std::string("b") + new_typename, color);
 300
 301   for (auto elm : root->children_) {
 302     recursiveNewVariableType(new_typename, color, elm.second);
 303   }
 304 }
 305
 306 void instr_new_variable_type(std::string new_typename, std::string color)
 307 {
 308   recursiveNewVariableType(new_typename, color, simgrid::instr::Container::getRoot()->type_);
 309 }
 310
 311 static void recursiveNewUserVariableType(std::string father_type, std::string new_typename, std::string color,
 312                                          simgrid::instr::Type* root)
 313 {
 314   if (root->get_name() == father_type) {
 315     root->getOrCreateVariableType(new_typename, color);
 316   }
 317   for (auto elm : root->children_)
 318     recursiveNewUserVariableType(father_type, new_typename, color, elm.second);
 319 }
 320
 321 void instr_new_user_variable_type(std::string father_type, std::string new_typename, std::string color)
 322 {
 323   recursiveNewUserVariableType(father_type, new_typename, color, simgrid::instr::Container::getRoot()->type_);
 324 }
 325
 326 static void recursiveNewUserStateType(std::string father_type, std::string new_typename, simgrid::instr::Type* root)
 327 {
 328   if (root->get_name() == father_type)
 329     root->getOrCreateStateType(new_typename);
 330
 331   for (auto elm : root->children_)
 332     recursiveNewUserStateType(father_type, new_typename, elm.second);
 333 }
 334
 335 void instr_new_user_state_type(std::string father_type, std::string new_typename)
 336 {
 337   recursiveNewUserStateType(father_type, new_typename, simgrid::instr::Container::getRoot()->type_);
 338 }
 339
 340 static void recursiveNewValueForUserStateType(std::string type_name, const char* val, std::string color,
 341                                               simgrid::instr::Type* root)
 342 {
 343   if (root->get_name() == type_name)
 344     static_cast<simgrid::instr::StateType*>(root)->addEntityValue(val, color);
 345
 346   for (auto elm : root->children_)
 347     recursiveNewValueForUserStateType(type_name, val, color, elm.second);
 348 }
 349
 350 void instr_new_value_for_user_state_type(std::string type_name, const char* value, std::string color)
 351 {
 352   recursiveNewValueForUserStateType(type_name, value, color, simgrid::instr::Container::getRoot()->type_);
 353 }
 354
 355 #define GRAPHICATOR_SUPPORT_FUNCTIONS
 356
 357 static void recursiveXBTGraphExtraction(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
 358                                         std::map<std::string, xbt_edge_t>* edges, sg_netzone_t netzone,
 359                                         container_t container)
 360 {
 361   if (not netzone->getChildren()->empty()) {
 362     //bottom-up recursion
 363     for (auto const& netzone_child : *netzone->getChildren()) {
 364       container_t child_container = container->children_.at(netzone_child->get_cname());
 365       recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
 366     }
 367   }
 368
 369   static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->get_graph(graph, nodes, edges);
 370 }
 371
 372 xbt_graph_t instr_routing_platform_graph ()
 373 {
 374   xbt_graph_t ret = xbt_graph_new_graph (0, nullptr);
 375   std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
 376   std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
 377   recursiveXBTGraphExtraction(ret, nodes, edges, simgrid::s4u::Engine::getInstance()->getNetRoot(),
 378                               simgrid::instr::Container::getRoot());
 379   delete nodes;
 380   delete edges;
 381   return ret;
 382 }
 383
 384 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
 385 {
 386   unsigned int cursor = 0;
 387   xbt_node_t node = nullptr;
 388   xbt_edge_t edge = nullptr;
 389
 390   FILE *file = fopen(filename, "w");
 391   xbt_assert(file, "Failed to open %s \n", filename);
 392
 393   if (g->directed)
 394     fprintf(file, "digraph test {\n");
 395   else
 396     fprintf(file, "graph test {\n");
 397
 398   fprintf(file, "  graph [overlap=scale]\n");
 399
 400   fprintf(file, "  node [shape=box, style=filled]\n");
 401   fprintf(file, "  node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
 402
 403   xbt_dynar_foreach(g->nodes, cursor, node) {
 404     fprintf(file, "  \"%s\";\n", instr_node_name(node));
 405   }
 406   xbt_dynar_foreach(g->edges, cursor, edge) {
 407     const char *src_s = instr_node_name (edge->src);
 408     const char *dst_s = instr_node_name (edge->dst);
 409     if (g->directed)
 410       fprintf(file, "  \"%s\" -> \"%s\";\n", src_s, dst_s);
 411     else
 412       fprintf(file, "  \"%s\" -- \"%s\";\n", src_s, dst_s);
 413   }
 414   fprintf(file, "}\n");
 415   fclose(file);
 416 }