src/instr/instr_platform.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/Actor.hpp"
  11 #include "simgrid/s4u/Engine.hpp"
  12 #include "simgrid/s4u/Host.hpp"
  13 #include "src/surf/network_interface.hpp"
  14 #include "src/surf/xml/platf_private.hpp"
  15 #include "surf/surf.hpp"
  16 #include "xbt/graph.h"
  17
  18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_routing, instr, "Tracing platform hierarchy");
  19
  20 static std::vector<simgrid::instr::NetZoneContainer*> currentContainer; /* push and pop, used only in creation */
  21
  22 static const char* instr_node_name(xbt_node_t node)
  23 {
  24   return static_cast<char*>(xbt_graph_node_get_data(node));
  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 instr_netzone_on_creation(simgrid::s4u::NetZone& netzone)
 154 {
 155   std::string id = netzone.get_name();
 156   if (simgrid::instr::Container::getRoot() == nullptr) {
 157     simgrid::instr::NetZoneContainer* root = new simgrid::instr::NetZoneContainer(id, 0, nullptr);
 158
 159     if (TRACE_smpi_is_enabled()) {
 160       simgrid::instr::Type* mpi = root->type_->getOrCreateContainerType("MPI");
 161       if (not TRACE_smpi_is_grouped())
 162         mpi->getOrCreateStateType("MPI_STATE");
 163       root->type_->getOrCreateLinkType("MPI_LINK", mpi, mpi);
 164       // TODO See if we can move this to the LoadBalancer plugin
 165       root->type_->getOrCreateLinkType("MIGRATE_LINK", mpi, mpi);
 166       mpi->getOrCreateStateType("MIGRATE_STATE");
 167     }
 168
 169     if (TRACE_needs_platform()) {
 170       currentContainer.push_back(root);
 171     }
 172     return;
 173   }
 174
 175   if (TRACE_needs_platform()) {
 176     simgrid::instr::NetZoneContainer* container =
 177         new simgrid::instr::NetZoneContainer(id, currentContainer.size(), currentContainer.back());
 178     currentContainer.push_back(container);
 179   }
 180 }
 181
 182 static void instr_netzone_on_seal(simgrid::s4u::NetZone& /*netzone*/)
 183 {
 184   if (TRACE_needs_platform()) {
 185     currentContainer.pop_back();
 186   }
 187 }
 188
 189 static void instr_link_on_creation(simgrid::s4u::Link& link)
 190 {
 191   if (currentContainer.empty()) // No ongoing parsing. Are you creating the loopback?
 192     return;
 193
 194   container_t father    = currentContainer.back();
 195   container_t container = new simgrid::instr::Container(link.get_name(), "LINK", father);
 196
 197   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_link())) {
 198     simgrid::instr::VariableType* bandwidth = container->type_->getOrCreateVariableType("bandwidth", "");
 199     bandwidth->setCallingContainer(container);
 200     bandwidth->setEvent(0, link.bandwidth());
 201     simgrid::instr::VariableType* latency = container->type_->getOrCreateVariableType("latency", "");
 202     latency->setCallingContainer(container);
 203     latency->setEvent(0, link.latency());
 204   }
 205   if (TRACE_uncategorized()) {
 206     container->type_->getOrCreateVariableType("bandwidth_used", "0.5 0.5 0.5");
 207   }
 208 }
 209
 210 static void instr_host_on_creation(simgrid::s4u::Host& host)
 211 {
 212   container_t container = new simgrid::instr::HostContainer(host, currentContainer.back());
 213   container_t root      = simgrid::instr::Container::getRoot();
 214
 215   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_speed())) {
 216     simgrid::instr::VariableType* power = container->type_->getOrCreateVariableType("power", "");
 217     power->setCallingContainer(container);
 218     power->setEvent(0, host.getSpeed());
 219   }
 220
 221   if (TRACE_uncategorized())
 222     container->type_->getOrCreateVariableType("power_used", "0.5 0.5 0.5");
 223
 224   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()) {
 225     simgrid::instr::ContainerType* mpi = container->type_->getOrCreateContainerType("MPI");
 226     mpi->getOrCreateStateType("MPI_STATE");
 227     // TODO See if we can move this to the LoadBalancer plugin
 228     root->type_->getOrCreateLinkType("MIGRATE_LINK", mpi, mpi);
 229     mpi->getOrCreateStateType("MIGRATE_STATE");
 230   }
 231
 232   if (TRACE_actor_is_enabled()) {
 233     simgrid::instr::ContainerType* actor = container->type_->getOrCreateContainerType("ACTOR");
 234     simgrid::instr::StateType* state     = actor->getOrCreateStateType("ACTOR_STATE");
 235     state->addEntityValue("suspend", "1 0 1");
 236     state->addEntityValue("sleep", "1 1 0");
 237     state->addEntityValue("receive", "1 0 0");
 238     state->addEntityValue("send", "0 0 1");
 239     state->addEntityValue("task_execute", "0 1 1");
 240     root->type_->getOrCreateLinkType("ACTOR_LINK", actor, actor);
 241     root->type_->getOrCreateLinkType("ACTOR_TASK_LINK", actor, actor);
 242   }
 243
 244   if (TRACE_vm_is_enabled()) {
 245     simgrid::instr::ContainerType* msg_vm = container->type_->getOrCreateContainerType("MSG_VM");
 246     simgrid::instr::StateType* state      = msg_vm->getOrCreateStateType("MSG_VM_STATE");
 247     state->addEntityValue("suspend", "1 0 1");
 248     state->addEntityValue("sleep", "1 1 0");
 249     state->addEntityValue("receive", "1 0 0");
 250     state->addEntityValue("send", "0 0 1");
 251     state->addEntityValue("task_execute", "0 1 1");
 252     root->type_->getOrCreateLinkType("MSG_VM_LINK", msg_vm, msg_vm);
 253     root->type_->getOrCreateLinkType("MSG_VM_ACTOR_LINK", msg_vm, msg_vm);
 254   }
 255 }
 256
 257 static void instr_netpoint_on_creation(simgrid::kernel::routing::NetPoint* netpoint)
 258 {
 259   if (netpoint->is_router() && TRACE_needs_platform() && TRACE_is_enabled())
 260     new simgrid::instr::RouterContainer(netpoint->get_cname(), currentContainer.back());
 261 }
 262
 263 static void instr_on_platform_created()
 264 {
 265   currentContainer.clear();
 266   std::set<std::string>* filter = new std::set<std::string>;
 267   XBT_DEBUG("Starting graph extraction.");
 268   recursiveGraphExtraction(simgrid::s4u::Engine::get_instance()->getNetRoot(), simgrid::instr::Container::getRoot(),
 269                            filter);
 270   XBT_DEBUG("Graph extraction finished.");
 271   delete filter;
 272   TRACE_paje_dump_buffer(true);
 273 }
 274
 275 static void instr_on_actor_suspend(simgrid::s4u::ActorPtr actor)
 276 {
 277   simgrid::instr::Container::byName(instr_pid(actor.get()))->getState("ACTOR_STATE")->pushEvent("suspend");
 278 }
 279
 280 static void instr_on_actor_resume(simgrid::s4u::ActorPtr actor)
 281 {
 282   simgrid::instr::Container::byName(instr_pid(actor.get()))->getState("ACTOR_STATE")->popEvent();
 283 }
 284
 285 static long long int counter = 0;
 286
 287 static void instr_on_actor_migration_start(simgrid::s4u::ActorPtr actor)
 288 {
 289   // start link
 290   container_t container = simgrid::instr::Container::byName(instr_pid(actor.get()));
 291   simgrid::instr::Container::getRoot()->getLink("ACTOR_LINK")->startEvent(container, "M", std::to_string(counter));
 292
 293   // destroy existing container of this process
 294   container->removeFromParent();
 295 }
 296
 297 static void instr_on_actor_migration_end(simgrid::s4u::ActorPtr actor)
 298 {
 299   // create new container on the new_host location
 300   simgrid::instr::Container::byName(actor->get_host()->get_name())->createChild(instr_pid(actor.get()), "ACTOR");
 301   // end link
 302   simgrid::instr::Container::getRoot()
 303       ->getLink("ACTOR_LINK")
 304       ->endEvent(simgrid::instr::Container::byName(instr_pid(actor.get())), "M", std::to_string(counter));
 305   counter++;
 306 }
 307
 308 void instr_define_callbacks()
 309 {
 310   // always need the callbacks to zones (we need only the root zone), to create the rootContainer and the rootType
 311   // properly
 312   if (TRACE_needs_platform()) {
 313     simgrid::s4u::on_platform_created.connect(instr_on_platform_created);
 314     simgrid::s4u::Host::onCreation.connect(instr_host_on_creation);
 315     simgrid::s4u::Link::onCreation.connect(instr_link_on_creation);
 316   }
 317   simgrid::s4u::NetZone::onCreation.connect(instr_netzone_on_creation);
 318   simgrid::s4u::NetZone::onSeal.connect(instr_netzone_on_seal);
 319   simgrid::kernel::routing::NetPoint::onCreation.connect(instr_netpoint_on_creation);
 320   if (TRACE_actor_is_enabled()) {
 321     simgrid::s4u::Actor::on_suspend.connect(instr_on_actor_suspend);
 322     simgrid::s4u::Actor::on_resume.connect(instr_on_actor_resume);
 323     simgrid::s4u::Actor::on_migration_start.connect(instr_on_actor_migration_start);
 324     simgrid::s4u::Actor::on_migration_end.connect(instr_on_actor_migration_end);
 325   }
 326 }
 327 /*
 328  * user categories support
 329  */
 330 static void recursiveNewVariableType(std::string new_typename, std::string color, simgrid::instr::Type* root)
 331 {
 332   if (root->get_name() == "HOST" || root->get_name() == "MSG_VM")
 333     root->getOrCreateVariableType(std::string("p") + new_typename, color);
 334
 335   if (root->get_name() == "LINK")
 336     root->getOrCreateVariableType(std::string("b") + new_typename, color);
 337
 338   for (auto elm : root->children_) {
 339     recursiveNewVariableType(new_typename, color, elm.second);
 340   }
 341 }
 342
 343 void instr_new_variable_type(std::string new_typename, std::string color)
 344 {
 345   recursiveNewVariableType(new_typename, color, simgrid::instr::Container::getRoot()->type_);
 346 }
 347
 348 static void recursiveNewUserVariableType(std::string father_type, std::string new_typename, std::string color,
 349                                          simgrid::instr::Type* root)
 350 {
 351   if (root->get_name() == father_type) {
 352     root->getOrCreateVariableType(new_typename, color);
 353   }
 354   for (auto elm : root->children_)
 355     recursiveNewUserVariableType(father_type, new_typename, color, elm.second);
 356 }
 357
 358 void instr_new_user_variable_type(std::string father_type, std::string new_typename, std::string color)
 359 {
 360   recursiveNewUserVariableType(father_type, new_typename, color, simgrid::instr::Container::getRoot()->type_);
 361 }
 362
 363 static void recursiveNewUserStateType(std::string father_type, std::string new_typename, simgrid::instr::Type* root)
 364 {
 365   if (root->get_name() == father_type)
 366     root->getOrCreateStateType(new_typename);
 367
 368   for (auto elm : root->children_)
 369     recursiveNewUserStateType(father_type, new_typename, elm.second);
 370 }
 371
 372 void instr_new_user_state_type(std::string father_type, std::string new_typename)
 373 {
 374   recursiveNewUserStateType(father_type, new_typename, simgrid::instr::Container::getRoot()->type_);
 375 }
 376
 377 static void recursiveNewValueForUserStateType(std::string type_name, const char* val, std::string color,
 378                                               simgrid::instr::Type* root)
 379 {
 380   if (root->get_name() == type_name)
 381     static_cast<simgrid::instr::StateType*>(root)->addEntityValue(val, color);
 382
 383   for (auto elm : root->children_)
 384     recursiveNewValueForUserStateType(type_name, val, color, elm.second);
 385 }
 386
 387 void instr_new_value_for_user_state_type(std::string type_name, const char* value, std::string color)
 388 {
 389   recursiveNewValueForUserStateType(type_name, value, color, simgrid::instr::Container::getRoot()->type_);
 390 }
 391
 392 #define GRAPHICATOR_SUPPORT_FUNCTIONS
 393
 394 static void recursiveXBTGraphExtraction(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
 395                                         std::map<std::string, xbt_edge_t>* edges, sg_netzone_t netzone,
 396                                         container_t container)
 397 {
 398   if (not netzone->getChildren()->empty()) {
 399     // bottom-up recursion
 400     for (auto const& netzone_child : *netzone->getChildren()) {
 401       container_t child_container = container->children_.at(netzone_child->get_cname());
 402       recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
 403     }
 404   }
 405
 406   static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->get_graph(graph, nodes, edges);
 407 }
 408
 409 xbt_graph_t instr_routing_platform_graph()
 410 {
 411   xbt_graph_t ret                          = xbt_graph_new_graph(0, nullptr);
 412   std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
 413   std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
 414   recursiveXBTGraphExtraction(ret, nodes, edges, simgrid::s4u::Engine::get_instance()->getNetRoot(),
 415                               simgrid::instr::Container::getRoot());
 416   delete nodes;
 417   delete edges;
 418   return ret;
 419 }
 420
 421 void instr_routing_platform_graph_export_graphviz(xbt_graph_t g, const char* filename)
 422 {
 423   unsigned int cursor = 0;
 424   xbt_node_t node     = nullptr;
 425   xbt_edge_t edge     = nullptr;
 426
 427   FILE* file = fopen(filename, "w");
 428   xbt_assert(file, "Failed to open %s \n", filename);
 429
 430   if (g->directed)
 431     fprintf(file, "digraph test {\n");
 432   else
 433     fprintf(file, "graph test {\n");
 434
 435   fprintf(file, "  graph [overlap=scale]\n");
 436
 437   fprintf(file, "  node [shape=box, style=filled]\n");
 438   fprintf(file, "  node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
 439
 440   xbt_dynar_foreach (g->nodes, cursor, node) {
 441     fprintf(file, "  \"%s\";\n", instr_node_name(node));
 442   }
 443   xbt_dynar_foreach (g->edges, cursor, edge) {
 444     const char* src_s = instr_node_name(edge->src);
 445     const char* dst_s = instr_node_name(edge->dst);
 446     if (g->directed)
 447       fprintf(file, "  \"%s\" -> \"%s\";\n", src_s, dst_s);
 448     else
 449       fprintf(file, "  \"%s\" -- \"%s\";\n", src_s, dst_s);
 450   }
 451   fprintf(file, "}\n");
 452   fclose(file);
 453 }