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 "simgrid/s4u/VirtualMachine.hpp"
  14 #include "src/surf/network_interface.hpp"
  15 #include "src/surf/xml/platf_private.hpp"
  16 #include "surf/surf.hpp"
  17 #include "xbt/graph.h"
  18
  19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_routing, instr, "Tracing platform hierarchy");
  20
  21 static std::vector<simgrid::instr::NetZoneContainer*> currentContainer; /* push and pop, used only in creation */
  22
  23 static const char* instr_node_name(xbt_node_t node)
  24 {
  25   return static_cast<char*>(xbt_graph_node_get_data(node));
  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->get_name() == "__loopback__" || dst->get_name() == "__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->get_name() + dst->get_name();
  84   std::string aux2 = dst->get_name() + src->get_name();
  85   if (filter->find(aux1) != filter->end()) {
  86     XBT_DEBUG("  linkContainers: already registered %s <-> %s (1)", src->get_cname(), dst->get_cname());
  87     return;
  88   }
  89   if (filter->find(aux2) != filter->end()) {
  90     XBT_DEBUG("  linkContainers: already registered %s <-> %s (2)", dst->get_cname(), src->get_cname());
  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_->get_name() + "-" + src->type_->get_name() +
 100                               std::to_string(src->type_->get_id()) + "-" + dst->type_->get_name() +
 101                               std::to_string(dst->type_->get_id());
 102   simgrid::instr::LinkType* link = father->type_->getOrCreateLinkType(link_typename, src->type_, dst->type_);
 103   link->setCallingContainer(father);
 104
 105   // register EDGE types for triva configuration
 106   trivaEdgeTypes.insert(link->get_name());
 107
 108   // create the link
 109   static long long counter = 0;
 110
 111   std::string key = std::to_string(counter);
 112   counter++;
 113
 114   link->startEvent(src, "topology", key);
 115   link->endEvent(dst, "topology", key);
 116
 117   XBT_DEBUG("  linkContainers %s <-> %s", src->get_cname(), dst->get_cname());
 118 }
 119
 120 static void recursiveGraphExtraction(simgrid::s4u::NetZone* netzone, container_t container,
 121                                      std::set<std::string>* filter)
 122 {
 123   if (not TRACE_platform_topology()) {
 124     XBT_DEBUG("Graph extraction disabled by user.");
 125     return;
 126   }
 127   XBT_DEBUG("Graph extraction for NetZone = %s", netzone->get_cname());
 128   if (not netzone->getChildren()->empty()) {
 129     // bottom-up recursion
 130     for (auto const& nz_son : *netzone->getChildren()) {
 131       container_t child_container = container->children_.at(nz_son->get_cname());
 132       recursiveGraphExtraction(nz_son, child_container, filter);
 133     }
 134   }
 135
 136   xbt_graph_t graph                        = xbt_graph_new_graph(0, nullptr);
 137   std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
 138   std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
 139
 140   static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->get_graph(graph, nodes, edges);
 141   for (auto elm : *edges) {
 142     xbt_edge_t edge = elm.second;
 143     linkContainers(simgrid::instr::Container::byName(static_cast<const char*>(edge->src->data)),
 144                    simgrid::instr::Container::byName(static_cast<const char*>(edge->dst->data)), filter);
 145   }
 146   delete nodes;
 147   delete edges;
 148   xbt_graph_free_graph(graph, xbt_free_f, xbt_free_f, nullptr);
 149 }
 150
 151 /*
 152  * Callbacks
 153  */
 154 static void instr_netzone_on_creation(simgrid::s4u::NetZone& netzone)
 155 {
 156   std::string id = netzone.get_name();
 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 instr_netzone_on_seal(simgrid::s4u::NetZone& /*netzone*/)
 184 {
 185   if (TRACE_needs_platform()) {
 186     currentContainer.pop_back();
 187   }
 188 }
 189
 190 static void instr_link_on_creation(simgrid::s4u::Link& link)
 191 {
 192   if (currentContainer.empty()) // No ongoing parsing. Are you creating the loopback?
 193     return;
 194
 195   container_t container = new simgrid::instr::Container(link.get_name(), "LINK", currentContainer.back());
 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
 233 static void instr_netpoint_on_creation(simgrid::kernel::routing::NetPoint* netpoint)
 234 {
 235   if (netpoint->is_router() && TRACE_needs_platform() && TRACE_is_enabled())
 236     new simgrid::instr::RouterContainer(netpoint->get_cname(), currentContainer.back());
 237 }
 238
 239 static void instr_on_platform_created()
 240 {
 241   currentContainer.clear();
 242   std::set<std::string>* filter = new std::set<std::string>;
 243   XBT_DEBUG("Starting graph extraction.");
 244   recursiveGraphExtraction(simgrid::s4u::Engine::get_instance()->get_netzone_root(),
 245                            simgrid::instr::Container::getRoot(), filter);
 246   XBT_DEBUG("Graph extraction finished.");
 247   delete filter;
 248   TRACE_paje_dump_buffer(true);
 249 }
 250
 251 static void instr_actor_on_creation(simgrid::s4u::ActorPtr actor)
 252 {
 253   container_t root      = simgrid::instr::Container::getRoot();
 254   container_t container = simgrid::instr::Container::byName(actor->get_host()->get_name());
 255
 256   container->createChild(instr_pid(actor.get()), "ACTOR");
 257   simgrid::instr::ContainerType* actor_type = container->type_->getOrCreateContainerType("ACTOR");
 258   simgrid::instr::StateType* state          = actor_type->getOrCreateStateType("ACTOR_STATE");
 259   state->addEntityValue("suspend", "1 0 1");
 260   state->addEntityValue("sleep", "1 1 0");
 261   state->addEntityValue("receive", "1 0 0");
 262   state->addEntityValue("send", "0 0 1");
 263   state->addEntityValue("task_execute", "0 1 1");
 264   root->type_->getOrCreateLinkType("ACTOR_LINK", actor_type, actor_type);
 265   root->type_->getOrCreateLinkType("ACTOR_TASK_LINK", actor_type, actor_type);
 266 }
 267
 268 static void instr_actor_on_suspend(simgrid::s4u::ActorPtr actor)
 269 {
 270   simgrid::instr::Container::byName(instr_pid(actor.get()))->getState("ACTOR_STATE")->pushEvent("suspend");
 271 }
 272
 273 static void instr_actor_on_resume(simgrid::s4u::ActorPtr actor)
 274 {
 275   simgrid::instr::Container::byName(instr_pid(actor.get()))->getState("ACTOR_STATE")->popEvent();
 276 }
 277
 278 static long long int counter = 0;
 279
 280 static void instr_actor_on_migration_start(simgrid::s4u::ActorPtr actor)
 281 {
 282   // start link
 283   container_t container = simgrid::instr::Container::byName(instr_pid(actor.get()));
 284   simgrid::instr::Container::getRoot()->getLink("ACTOR_LINK")->startEvent(container, "M", std::to_string(counter));
 285
 286   // destroy existing container of this process
 287   container->removeFromParent();
 288 }
 289
 290 static void instr_actor_on_migration_end(simgrid::s4u::ActorPtr actor)
 291 {
 292   // create new container on the new_host location
 293   simgrid::instr::Container::byName(actor->get_host()->get_name())->createChild(instr_pid(actor.get()), "ACTOR");
 294   // end link
 295   simgrid::instr::Container::getRoot()
 296       ->getLink("ACTOR_LINK")
 297       ->endEvent(simgrid::instr::Container::byName(instr_pid(actor.get())), "M", std::to_string(counter));
 298   counter++;
 299 }
 300
 301 static void instr_vm_on_creation(simgrid::s4u::Host& host)
 302 {
 303   container_t container                 = new simgrid::instr::HostContainer(host, currentContainer.back());
 304   container_t root                      = simgrid::instr::Container::getRoot();
 305   simgrid::instr::ContainerType* msg_vm = container->type_->getOrCreateContainerType("VM");
 306   simgrid::instr::StateType* state      = msg_vm->getOrCreateStateType("VM_STATE");
 307   state->addEntityValue("suspend", "1 0 1");
 308   state->addEntityValue("sleep", "1 1 0");
 309   state->addEntityValue("receive", "1 0 0");
 310   state->addEntityValue("send", "0 0 1");
 311   state->addEntityValue("task_execute", "0 1 1");
 312   root->type_->getOrCreateLinkType("VM_LINK", msg_vm, msg_vm);
 313   root->type_->getOrCreateLinkType("VM_ACTOR_LINK", msg_vm, msg_vm);
 314 }
 315
 316 static void instr_vm_on_start(simgrid::s4u::VirtualMachine& vm)
 317 {
 318   simgrid::instr::Container::byName(vm.get_name())->getState("VM_STATE")->pushEvent("start");
 319 }
 320
 321 static void instr_vm_on_started(simgrid::s4u::VirtualMachine& vm)
 322 {
 323   simgrid::instr::Container::byName(vm.get_name())->getState("VM_STATE")->popEvent();
 324 }
 325
 326 static void instr_vm_on_suspend(simgrid::s4u::VirtualMachine& vm)
 327 {
 328   simgrid::instr::Container::byName(vm.get_name())->getState("VM_STATE")->pushEvent("suspend");
 329 }
 330
 331 static void instr_vm_on_resume(simgrid::s4u::VirtualMachine& vm)
 332 {
 333   simgrid::instr::Container::byName(vm.get_name())->getState("VM_STATE")->popEvent();
 334 }
 335
 336 static void instr_vm_on_destruction(simgrid::s4u::Host& host)
 337 {
 338   simgrid::instr::Container::byName(host.get_name())->removeFromParent();
 339 }
 340
 341 void instr_define_callbacks()
 342 {
 343   // always need the callbacks to zones (we need only the root zone), to create the rootContainer and the rootType
 344   // properly
 345   if (TRACE_needs_platform()) {
 346     simgrid::s4u::on_platform_created.connect(instr_on_platform_created);
 347     simgrid::s4u::Host::onCreation.connect(instr_host_on_creation);
 348     simgrid::s4u::Link::onCreation.connect(instr_link_on_creation);
 349   }
 350   simgrid::s4u::NetZone::onCreation.connect(instr_netzone_on_creation);
 351   simgrid::s4u::NetZone::onSeal.connect(instr_netzone_on_seal);
 352   simgrid::kernel::routing::NetPoint::onCreation.connect(instr_netpoint_on_creation);
 353
 354   if (TRACE_actor_is_enabled()) {
 355     simgrid::s4u::Actor::on_creation.connect(instr_actor_on_creation);
 356     simgrid::s4u::Actor::on_suspend.connect(instr_actor_on_suspend);
 357     simgrid::s4u::Actor::on_resume.connect(instr_actor_on_resume);
 358     simgrid::s4u::Actor::on_migration_start.connect(instr_actor_on_migration_start);
 359     simgrid::s4u::Actor::on_migration_end.connect(instr_actor_on_migration_end);
 360   }
 361
 362   if (TRACE_vm_is_enabled()) {
 363     simgrid::s4u::Host::onCreation.connect(instr_vm_on_creation);
 364     simgrid::s4u::VirtualMachine::on_start.connect(instr_vm_on_start);
 365     simgrid::s4u::VirtualMachine::on_started.connect(instr_vm_on_started);
 366     simgrid::s4u::VirtualMachine::on_suspend.connect(instr_vm_on_suspend);
 367     simgrid::s4u::VirtualMachine::on_resume.connect(instr_vm_on_resume);
 368     simgrid::s4u::Host::onDestruction.connect(instr_vm_on_destruction);
 369   }
 370 }
 371 /*
 372  * user categories support
 373  */
 374 static void recursiveNewVariableType(std::string new_typename, std::string color, simgrid::instr::Type* root)
 375 {
 376   if (root->get_name() == "HOST" || root->get_name() == "VM")
 377     root->getOrCreateVariableType(std::string("p") + new_typename, color);
 378
 379   if (root->get_name() == "LINK")
 380     root->getOrCreateVariableType(std::string("b") + new_typename, color);
 381
 382   for (auto elm : root->children_) {
 383     recursiveNewVariableType(new_typename, color, elm.second);
 384   }
 385 }
 386
 387 void instr_new_variable_type(std::string new_typename, std::string color)
 388 {
 389   recursiveNewVariableType(new_typename, color, simgrid::instr::Container::getRoot()->type_);
 390 }
 391
 392 static void recursiveNewUserVariableType(std::string father_type, std::string new_typename, std::string color,
 393                                          simgrid::instr::Type* root)
 394 {
 395   if (root->get_name() == father_type) {
 396     root->getOrCreateVariableType(new_typename, color);
 397   }
 398   for (auto elm : root->children_)
 399     recursiveNewUserVariableType(father_type, new_typename, color, elm.second);
 400 }
 401
 402 void instr_new_user_variable_type(std::string father_type, std::string new_typename, std::string color)
 403 {
 404   recursiveNewUserVariableType(father_type, new_typename, color, simgrid::instr::Container::getRoot()->type_);
 405 }
 406
 407 static void recursiveNewUserStateType(std::string father_type, std::string new_typename, simgrid::instr::Type* root)
 408 {
 409   if (root->get_name() == father_type)
 410     root->getOrCreateStateType(new_typename);
 411
 412   for (auto elm : root->children_)
 413     recursiveNewUserStateType(father_type, new_typename, elm.second);
 414 }
 415
 416 void instr_new_user_state_type(std::string father_type, std::string new_typename)
 417 {
 418   recursiveNewUserStateType(father_type, new_typename, simgrid::instr::Container::getRoot()->type_);
 419 }
 420
 421 static void recursiveNewValueForUserStateType(std::string type_name, const char* val, std::string color,
 422                                               simgrid::instr::Type* root)
 423 {
 424   if (root->get_name() == type_name)
 425     static_cast<simgrid::instr::StateType*>(root)->addEntityValue(val, color);
 426
 427   for (auto elm : root->children_)
 428     recursiveNewValueForUserStateType(type_name, val, color, elm.second);
 429 }
 430
 431 void instr_new_value_for_user_state_type(std::string type_name, const char* value, std::string color)
 432 {
 433   recursiveNewValueForUserStateType(type_name, value, color, simgrid::instr::Container::getRoot()->type_);
 434 }
 435
 436 #define GRAPHICATOR_SUPPORT_FUNCTIONS
 437
 438 static void recursiveXBTGraphExtraction(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
 439                                         std::map<std::string, xbt_edge_t>* edges, sg_netzone_t netzone,
 440                                         container_t container)
 441 {
 442   if (not netzone->getChildren()->empty()) {
 443     // bottom-up recursion
 444     for (auto const& netzone_child : *netzone->getChildren()) {
 445       container_t child_container = container->children_.at(netzone_child->get_cname());
 446       recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
 447     }
 448   }
 449
 450   static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->get_graph(graph, nodes, edges);
 451 }
 452
 453 xbt_graph_t instr_routing_platform_graph()
 454 {
 455   xbt_graph_t ret                          = xbt_graph_new_graph(0, nullptr);
 456   std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
 457   std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
 458   recursiveXBTGraphExtraction(ret, nodes, edges, simgrid::s4u::Engine::get_instance()->get_netzone_root(),
 459                               simgrid::instr::Container::getRoot());
 460   delete nodes;
 461   delete edges;
 462   return ret;
 463 }
 464
 465 void instr_routing_platform_graph_export_graphviz(xbt_graph_t g, const char* filename)
 466 {
 467   unsigned int cursor = 0;
 468   xbt_node_t node     = nullptr;
 469   xbt_edge_t edge     = nullptr;
 470
 471   FILE* file = fopen(filename, "w");
 472   xbt_assert(file, "Failed to open %s \n", filename);
 473
 474   if (g->directed)
 475     fprintf(file, "digraph test {\n");
 476   else
 477     fprintf(file, "graph test {\n");
 478
 479   fprintf(file, "  graph [overlap=scale]\n");
 480
 481   fprintf(file, "  node [shape=box, style=filled]\n");
 482   fprintf(file, "  node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
 483
 484   xbt_dynar_foreach (g->nodes, cursor, node) {
 485     fprintf(file, "  \"%s\";\n", instr_node_name(node));
 486   }
 487   xbt_dynar_foreach (g->edges, cursor, edge) {
 488     const char* src_s = instr_node_name(edge->src);
 489     const char* dst_s = instr_node_name(edge->dst);
 490     if (g->directed)
 491       fprintf(file, "  \"%s\" -> \"%s\";\n", src_s, dst_s);
 492     else
 493       fprintf(file, "  \"%s\" -- \"%s\";\n", src_s, dst_s);
 494   }
 495   fprintf(file, "}\n");
 496   fclose(file);
 497 }