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/cpu_interface.hpp"
  15 #include "src/surf/network_interface.hpp"
  16 #include "src/surf/xml/platf_private.hpp"
  17 #include "surf/surf.hpp"
  18 #include "xbt/graph.h"
  19
  20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_routing, instr, "Tracing platform hierarchy");
  21
  22 static std::vector<simgrid::instr::NetZoneContainer*> currentContainer; /* push and pop, used only in creation */
  23
  24 static const char* instr_node_name(xbt_node_t node)
  25 {
  26   return static_cast<char*>(xbt_graph_node_get_data(node));
  27 }
  28
  29 static container_t lowestCommonAncestor(container_t a1, container_t a2)
  30 {
  31   // this is only an optimization (since most of a1 and a2 share the same parent)
  32   if (a1->father_ == a2->father_)
  33     return a1->father_;
  34
  35   // create an array with all ancestors of a1
  36   std::vector<container_t> ancestors_a1;
  37   container_t p = a1->father_;
  38   while (p) {
  39     ancestors_a1.push_back(p);
  40     p = p->father_;
  41   }
  42
  43   // create an array with all ancestors of a2
  44   std::vector<container_t> ancestors_a2;
  45   p = a2->father_;
  46   while (p) {
  47     ancestors_a2.push_back(p);
  48     p = p->father_;
  49   }
  50
  51   // find the lowest ancestor
  52   p     = nullptr;
  53   int i = ancestors_a1.size() - 1;
  54   int j = ancestors_a2.size() - 1;
  55   while (i >= 0 && j >= 0) {
  56     container_t a1p = ancestors_a1.at(i);
  57     container_t a2p = ancestors_a2.at(j);
  58     if (a1p == a2p) {
  59       p = a1p;
  60     } else {
  61       break;
  62     }
  63     i--;
  64     j--;
  65   }
  66   return p;
  67 }
  68
  69 static void linkContainers(container_t src, container_t dst, std::set<std::string>* filter)
  70 {
  71   // ignore loopback
  72   if (src->get_name() == "__loopback__" || dst->get_name() == "__loopback__") {
  73     XBT_DEBUG("  linkContainers: ignoring loopback link");
  74     return;
  75   }
  76
  77   // find common father
  78   container_t father = lowestCommonAncestor(src, dst);
  79   if (not father) {
  80     xbt_die("common father unknown, this is a tracing problem");
  81   }
  82
  83   // check if we already register this pair (we only need one direction)
  84   std::string aux1 = src->get_name() + dst->get_name();
  85   std::string aux2 = dst->get_name() + src->get_name();
  86   if (filter->find(aux1) != filter->end()) {
  87     XBT_DEBUG("  linkContainers: already registered %s <-> %s (1)", src->get_cname(), dst->get_cname());
  88     return;
  89   }
  90   if (filter->find(aux2) != filter->end()) {
  91     XBT_DEBUG("  linkContainers: already registered %s <-> %s (2)", dst->get_cname(), src->get_cname());
  92     return;
  93   }
  94
  95   // ok, not found, register it
  96   filter->insert(aux1);
  97   filter->insert(aux2);
  98
  99   // declare type
 100   std::string link_typename = father->type_->get_name() + "-" + src->type_->get_name() +
 101                               std::to_string(src->type_->get_id()) + "-" + dst->type_->get_name() +
 102                               std::to_string(dst->type_->get_id());
 103   simgrid::instr::LinkType* link = father->type_->by_name_or_create(link_typename, src->type_, dst->type_);
 104   link->set_calling_container(father);
 105
 106   // register EDGE types for triva configuration
 107   trivaEdgeTypes.insert(link->get_name());
 108
 109   // create the link
 110   static long long counter = 0;
 111
 112   std::string key = std::to_string(counter);
 113   counter++;
 114
 115   link->start_event(src, "topology", key);
 116   link->end_event(dst, "topology", key);
 117
 118   XBT_DEBUG("  linkContainers %s <-> %s", src->get_cname(), dst->get_cname());
 119 }
 120
 121 static void recursiveGraphExtraction(simgrid::s4u::NetZone* netzone, container_t container,
 122                                      std::set<std::string>* filter)
 123 {
 124   if (not TRACE_platform_topology()) {
 125     XBT_DEBUG("Graph extraction disabled by user.");
 126     return;
 127   }
 128   XBT_DEBUG("Graph extraction for NetZone = %s", netzone->get_cname());
 129   if (not netzone->getChildren()->empty()) {
 130     // bottom-up recursion
 131     for (auto const& nz_son : *netzone->getChildren()) {
 132       container_t child_container = container->children_.at(nz_son->get_cname());
 133       recursiveGraphExtraction(nz_son, child_container, filter);
 134     }
 135   }
 136
 137   xbt_graph_t graph                        = xbt_graph_new_graph(0, nullptr);
 138   std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
 139   std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
 140
 141   static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->get_graph(graph, nodes, edges);
 142   for (auto elm : *edges) {
 143     xbt_edge_t edge = elm.second;
 144     linkContainers(simgrid::instr::Container::by_name(static_cast<const char*>(edge->src->data)),
 145                    simgrid::instr::Container::by_name(static_cast<const char*>(edge->dst->data)), filter);
 146   }
 147   delete nodes;
 148   delete edges;
 149   xbt_graph_free_graph(graph, xbt_free_f, xbt_free_f, nullptr);
 150 }
 151
 152 /*
 153  * Callbacks
 154  */
 155 static void instr_netzone_on_creation(simgrid::s4u::NetZone& netzone)
 156 {
 157   std::string id = netzone.get_name();
 158   if (simgrid::instr::Container::get_root() == nullptr) {
 159     simgrid::instr::NetZoneContainer* root = new simgrid::instr::NetZoneContainer(id, 0, nullptr);
 160
 161     if (TRACE_smpi_is_enabled()) {
 162       simgrid::instr::ContainerType* mpi = root->type_->by_name_or_create<simgrid::instr::ContainerType>("MPI");
 163       if (not TRACE_smpi_is_grouped())
 164         mpi->by_name_or_create<simgrid::instr::StateType>("MPI_STATE");
 165       root->type_->by_name_or_create("MPI_LINK", mpi, mpi);
 166       // TODO See if we can move this to the LoadBalancer plugin
 167       root->type_->by_name_or_create("MIGRATE_LINK", mpi, mpi);
 168       mpi->by_name_or_create<simgrid::instr::StateType>("MIGRATE_STATE");
 169     }
 170
 171     if (TRACE_needs_platform()) {
 172       currentContainer.push_back(root);
 173     }
 174     return;
 175   }
 176
 177   if (TRACE_needs_platform()) {
 178     simgrid::instr::NetZoneContainer* container =
 179         new simgrid::instr::NetZoneContainer(id, currentContainer.size(), currentContainer.back());
 180     currentContainer.push_back(container);
 181   }
 182 }
 183
 184 static void instr_netzone_on_seal(simgrid::s4u::NetZone& /*netzone*/)
 185 {
 186   if (TRACE_needs_platform()) {
 187     currentContainer.pop_back();
 188   }
 189 }
 190
 191 static void instr_link_on_creation(simgrid::s4u::Link& link)
 192 {
 193   if (currentContainer.empty()) // No ongoing parsing. Are you creating the loopback?
 194     return;
 195
 196   container_t container = new simgrid::instr::Container(link.get_name(), "LINK", currentContainer.back());
 197
 198   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_link())) {
 199     simgrid::instr::VariableType* bandwidth = container->type_->by_name_or_create("bandwidth", "");
 200     bandwidth->set_calling_container(container);
 201     bandwidth->set_event(0, link.bandwidth());
 202     simgrid::instr::VariableType* latency = container->type_->by_name_or_create("latency", "");
 203     latency->set_calling_container(container);
 204     latency->set_event(0, link.latency());
 205   }
 206   if (TRACE_uncategorized()) {
 207     container->type_->by_name_or_create("bandwidth_used", "0.5 0.5 0.5");
 208   }
 209 }
 210
 211 static void instr_host_on_creation(simgrid::s4u::Host& host)
 212 {
 213   container_t container = new simgrid::instr::HostContainer(host, currentContainer.back());
 214   container_t root      = simgrid::instr::Container::get_root();
 215
 216   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_speed())) {
 217     simgrid::instr::VariableType* power = container->type_->by_name_or_create("power", "");
 218     power->set_calling_container(container);
 219     power->set_event(0, host.getSpeed());
 220   }
 221
 222   if (TRACE_uncategorized())
 223     container->type_->by_name_or_create("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_->by_name_or_create<simgrid::instr::ContainerType>("MPI");
 227     mpi->by_name_or_create<simgrid::instr::StateType>("MPI_STATE");
 228     // TODO See if we can move this to the LoadBalancer plugin
 229     root->type_->by_name_or_create("MIGRATE_LINK", mpi, mpi);
 230     mpi->by_name_or_create<simgrid::instr::StateType>("MIGRATE_STATE");
 231   }
 232 }
 233
 234 static void instr_cpu_action_on_state_change(simgrid::surf::CpuAction* action,
 235                                              simgrid::kernel::resource::Action::State /* previous */)
 236 {
 237   simgrid::surf::Cpu* cpu = static_cast<simgrid::surf::Cpu*>(action->get_variable()->get_constraint(0)->get_id());
 238   TRACE_surf_resource_set_utilization("HOST", "power_used", cpu->get_cname(), action->get_category(),
 239                                       action->get_variable()->get_value(), action->get_last_update(),
 240                                       SIMIX_get_clock() - action->get_last_update());
 241 }
 242
 243 static void instr_netpoint_on_creation(simgrid::kernel::routing::NetPoint* netpoint)
 244 {
 245   if (netpoint->is_router() && TRACE_needs_platform() && TRACE_is_enabled())
 246     new simgrid::instr::RouterContainer(netpoint->get_cname(), currentContainer.back());
 247 }
 248
 249 static void instr_on_platform_created()
 250 {
 251   currentContainer.clear();
 252   std::set<std::string>* filter = new std::set<std::string>;
 253   XBT_DEBUG("Starting graph extraction.");
 254   recursiveGraphExtraction(simgrid::s4u::Engine::get_instance()->get_netzone_root(),
 255                            simgrid::instr::Container::get_root(), filter);
 256   XBT_DEBUG("Graph extraction finished.");
 257   delete filter;
 258   TRACE_paje_dump_buffer(true);
 259 }
 260
 261 static void instr_actor_on_creation(simgrid::s4u::ActorPtr actor)
 262 {
 263   container_t root      = simgrid::instr::Container::get_root();
 264   container_t container = simgrid::instr::Container::by_name(actor->get_host()->get_name());
 265
 266   container->create_child(instr_pid(actor.get()), "ACTOR");
 267   simgrid::instr::ContainerType* actor_type =
 268       container->type_->by_name_or_create<simgrid::instr::ContainerType>("ACTOR");
 269   simgrid::instr::StateType* state = actor_type->by_name_or_create<simgrid::instr::StateType>("ACTOR_STATE");
 270   state->add_entity_value("suspend", "1 0 1");
 271   state->add_entity_value("sleep", "1 1 0");
 272   state->add_entity_value("receive", "1 0 0");
 273   state->add_entity_value("send", "0 0 1");
 274   state->add_entity_value("task_execute", "0 1 1");
 275   root->type_->by_name_or_create("ACTOR_LINK", actor_type, actor_type);
 276   root->type_->by_name_or_create("ACTOR_TASK_LINK", actor_type, actor_type);
 277 }
 278
 279 static void instr_actor_on_suspend(simgrid::s4u::ActorPtr actor)
 280 {
 281   simgrid::instr::Container::by_name(instr_pid(actor.get()))->get_state("ACTOR_STATE")->push_event("suspend");
 282 }
 283
 284 static void instr_actor_on_resume(simgrid::s4u::ActorPtr actor)
 285 {
 286   simgrid::instr::Container::by_name(instr_pid(actor.get()))->get_state("ACTOR_STATE")->pop_event();
 287 }
 288
 289 static long long int counter = 0;
 290
 291 static void instr_actor_on_migration_start(simgrid::s4u::ActorPtr actor)
 292 {
 293   // start link
 294   container_t container = simgrid::instr::Container::by_name(instr_pid(actor.get()));
 295   simgrid::instr::Container::get_root()->get_link("ACTOR_LINK")->start_event(container, "M", std::to_string(counter));
 296
 297   // destroy existing container of this process
 298   container->remove_from_parent();
 299 }
 300
 301 static void instr_actor_on_migration_end(simgrid::s4u::ActorPtr actor)
 302 {
 303   // create new container on the new_host location
 304   simgrid::instr::Container::by_name(actor->get_host()->get_name())->create_child(instr_pid(actor.get()), "ACTOR");
 305   // end link
 306   simgrid::instr::Container::get_root()
 307       ->get_link("ACTOR_LINK")
 308       ->end_event(simgrid::instr::Container::by_name(instr_pid(actor.get())), "M", std::to_string(counter));
 309   counter++;
 310 }
 311
 312 static void instr_vm_on_creation(simgrid::s4u::Host& host)
 313 {
 314   container_t container             = new simgrid::instr::HostContainer(host, currentContainer.back());
 315   container_t root                  = simgrid::instr::Container::get_root();
 316   simgrid::instr::ContainerType* vm = container->type_->by_name_or_create<simgrid::instr::ContainerType>("VM");
 317   simgrid::instr::StateType* state  = vm->by_name_or_create<simgrid::instr::StateType>("VM_STATE");
 318   state->add_entity_value("suspend", "1 0 1");
 319   state->add_entity_value("sleep", "1 1 0");
 320   state->add_entity_value("receive", "1 0 0");
 321   state->add_entity_value("send", "0 0 1");
 322   state->add_entity_value("task_execute", "0 1 1");
 323   root->type_->by_name_or_create("VM_LINK", vm, vm);
 324   root->type_->by_name_or_create("VM_ACTOR_LINK", vm, vm);
 325 }
 326
 327 static void instr_vm_on_start(simgrid::s4u::VirtualMachine& vm)
 328 {
 329   simgrid::instr::Container::by_name(vm.get_name())->get_state("VM_STATE")->push_event("start");
 330 }
 331
 332 static void instr_vm_on_started(simgrid::s4u::VirtualMachine& vm)
 333 {
 334   simgrid::instr::Container::by_name(vm.get_name())->get_state("VM_STATE")->pop_event();
 335 }
 336
 337 static void instr_vm_on_suspend(simgrid::s4u::VirtualMachine& vm)
 338 {
 339   simgrid::instr::Container::by_name(vm.get_name())->get_state("VM_STATE")->push_event("suspend");
 340 }
 341
 342 static void instr_vm_on_resume(simgrid::s4u::VirtualMachine& vm)
 343 {
 344   simgrid::instr::Container::by_name(vm.get_name())->get_state("VM_STATE")->pop_event();
 345 }
 346
 347 static void instr_vm_on_destruction(simgrid::s4u::Host& host)
 348 {
 349   simgrid::instr::Container::by_name(host.get_name())->remove_from_parent();
 350 }
 351
 352 void instr_define_callbacks()
 353 {
 354   // always need the callbacks to zones (we need only the root zone), to create the rootContainer and the rootType
 355   // properly
 356   if (TRACE_needs_platform()) {
 357     simgrid::s4u::on_platform_created.connect(instr_on_platform_created);
 358     simgrid::s4u::Host::onCreation.connect(instr_host_on_creation);
 359     simgrid::s4u::Link::onCreation.connect(instr_link_on_creation);
 360   }
 361   simgrid::s4u::NetZone::onCreation.connect(instr_netzone_on_creation);
 362   simgrid::s4u::NetZone::onSeal.connect(instr_netzone_on_seal);
 363   simgrid::kernel::routing::NetPoint::onCreation.connect(instr_netpoint_on_creation);
 364
 365   simgrid::surf::CpuAction::onStateChange.connect(instr_cpu_action_on_state_change);
 366
 367   if (TRACE_actor_is_enabled()) {
 368     simgrid::s4u::Actor::on_creation.connect(instr_actor_on_creation);
 369     simgrid::s4u::Actor::on_suspend.connect(instr_actor_on_suspend);
 370     simgrid::s4u::Actor::on_resume.connect(instr_actor_on_resume);
 371     simgrid::s4u::Actor::on_migration_start.connect(instr_actor_on_migration_start);
 372     simgrid::s4u::Actor::on_migration_end.connect(instr_actor_on_migration_end);
 373   }
 374
 375   if (TRACE_vm_is_enabled()) {
 376     simgrid::s4u::Host::onCreation.connect(instr_vm_on_creation);
 377     simgrid::s4u::VirtualMachine::on_start.connect(instr_vm_on_start);
 378     simgrid::s4u::VirtualMachine::on_started.connect(instr_vm_on_started);
 379     simgrid::s4u::VirtualMachine::on_suspend.connect(instr_vm_on_suspend);
 380     simgrid::s4u::VirtualMachine::on_resume.connect(instr_vm_on_resume);
 381     simgrid::s4u::Host::onDestruction.connect(instr_vm_on_destruction);
 382   }
 383 }
 384 /*
 385  * user categories support
 386  */
 387 static void recursiveNewVariableType(std::string new_typename, std::string color, simgrid::instr::Type* root)
 388 {
 389   if (root->get_name() == "HOST" || root->get_name() == "VM")
 390     root->by_name_or_create(std::string("p") + new_typename, color);
 391
 392   if (root->get_name() == "LINK")
 393     root->by_name_or_create(std::string("b") + new_typename, color);
 394
 395   for (auto elm : root->children_) {
 396     recursiveNewVariableType(new_typename, color, elm.second);
 397   }
 398 }
 399
 400 void instr_new_variable_type(std::string new_typename, std::string color)
 401 {
 402   recursiveNewVariableType(new_typename, color, simgrid::instr::Container::get_root()->type_);
 403 }
 404
 405 static void recursiveNewUserVariableType(std::string father_type, std::string new_typename, std::string color,
 406                                          simgrid::instr::Type* root)
 407 {
 408   if (root->get_name() == father_type) {
 409     root->by_name_or_create(new_typename, color);
 410   }
 411   for (auto elm : root->children_)
 412     recursiveNewUserVariableType(father_type, new_typename, color, elm.second);
 413 }
 414
 415 void instr_new_user_variable_type(std::string father_type, std::string new_typename, std::string color)
 416 {
 417   recursiveNewUserVariableType(father_type, new_typename, color, simgrid::instr::Container::get_root()->type_);
 418 }
 419
 420 static void recursiveNewUserStateType(std::string father_type, std::string new_typename, simgrid::instr::Type* root)
 421 {
 422   if (root->get_name() == father_type)
 423     root->by_name_or_create<simgrid::instr::StateType>(new_typename);
 424
 425   for (auto elm : root->children_)
 426     recursiveNewUserStateType(father_type, new_typename, elm.second);
 427 }
 428
 429 void instr_new_user_state_type(std::string father_type, std::string new_typename)
 430 {
 431   recursiveNewUserStateType(father_type, new_typename, simgrid::instr::Container::get_root()->type_);
 432 }
 433
 434 static void recursiveNewValueForUserStateType(std::string type_name, const char* val, std::string color,
 435                                               simgrid::instr::Type* root)
 436 {
 437   if (root->get_name() == type_name)
 438     static_cast<simgrid::instr::StateType*>(root)->add_entity_value(val, color);
 439
 440   for (auto elm : root->children_)
 441     recursiveNewValueForUserStateType(type_name, val, color, elm.second);
 442 }
 443
 444 void instr_new_value_for_user_state_type(std::string type_name, const char* value, std::string color)
 445 {
 446   recursiveNewValueForUserStateType(type_name, value, color, simgrid::instr::Container::get_root()->type_);
 447 }
 448
 449 #define GRAPHICATOR_SUPPORT_FUNCTIONS
 450
 451 static void recursiveXBTGraphExtraction(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
 452                                         std::map<std::string, xbt_edge_t>* edges, sg_netzone_t netzone,
 453                                         container_t container)
 454 {
 455   if (not netzone->getChildren()->empty()) {
 456     // bottom-up recursion
 457     for (auto const& netzone_child : *netzone->getChildren()) {
 458       container_t child_container = container->children_.at(netzone_child->get_cname());
 459       recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
 460     }
 461   }
 462
 463   static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->get_graph(graph, nodes, edges);
 464 }
 465
 466 xbt_graph_t instr_routing_platform_graph()
 467 {
 468   xbt_graph_t ret                          = xbt_graph_new_graph(0, nullptr);
 469   std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
 470   std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
 471   recursiveXBTGraphExtraction(ret, nodes, edges, simgrid::s4u::Engine::get_instance()->get_netzone_root(),
 472                               simgrid::instr::Container::get_root());
 473   delete nodes;
 474   delete edges;
 475   return ret;
 476 }
 477
 478 void instr_routing_platform_graph_export_graphviz(xbt_graph_t g, const char* filename)
 479 {
 480   unsigned int cursor = 0;
 481   xbt_node_t node     = nullptr;
 482   xbt_edge_t edge     = nullptr;
 483
 484   FILE* file = fopen(filename, "w");
 485   xbt_assert(file, "Failed to open %s \n", filename);
 486
 487   if (g->directed)
 488     fprintf(file, "digraph test {\n");
 489   else
 490     fprintf(file, "graph test {\n");
 491
 492   fprintf(file, "  graph [overlap=scale]\n");
 493
 494   fprintf(file, "  node [shape=box, style=filled]\n");
 495   fprintf(file, "  node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
 496
 497   xbt_dynar_foreach (g->nodes, cursor, node) {
 498     fprintf(file, "  \"%s\";\n", instr_node_name(node));
 499   }
 500   xbt_dynar_foreach (g->edges, cursor, edge) {
 501     const char* src_s = instr_node_name(edge->src);
 502     const char* dst_s = instr_node_name(edge->dst);
 503     if (g->directed)
 504       fprintf(file, "  \"%s\" -> \"%s\";\n", src_s, dst_s);
 505     else
 506       fprintf(file, "  \"%s\" -- \"%s\";\n", src_s, dst_s);
 507   }
 508   fprintf(file, "}\n");
 509   fclose(file);
 510 }