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