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