src/surf/surf_routing.cpp

   1 /* Copyright (c) 2009-2011, 2013-2016. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include <vector>
   8
   9 #include <xbt/signal.hpp>
  10
  11 #include <simgrid/s4u/host.hpp>
  12
  13 #include "surf_routing.hpp"
  14
  15 #include "simgrid/sg_config.h"
  16 #include "storage_interface.hpp"
  17
  18 #include "src/kernel/routing/AsImpl.hpp"
  19 #include "src/surf/xml/platf.hpp" // FIXME: move that back to the parsing area
  20
  21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
  22
  23 namespace simgrid {
  24 namespace kernel {
  25 namespace routing {
  26
  27   /* Callbacks */
  28   simgrid::xbt::signal<void(NetCard*)> netcardCreatedCallbacks;
  29   simgrid::xbt::signal<void(s4u::As*)> asCreatedCallbacks;
  30
  31 }}} // namespace simgrid::kernel::routing
  32
  33 /**
  34  * @ingroup SURF_build_api
  35  * @brief A library containing all known hosts
  36  */
  37
  38 int MSG_FILE_LEVEL = -1;             //Msg file level
  39
  40 int SIMIX_STORAGE_LEVEL = -1;        //Simix storage level
  41 int MSG_STORAGE_LEVEL = -1;          //Msg storage level
  42
  43 xbt_lib_t as_router_lib;
  44 int ROUTING_ASR_LEVEL = -1;          //Routing level
  45 int COORD_ASR_LEVEL = -1;            //Coordinates level
  46 int NS3_ASR_LEVEL = -1;              //host node for ns3
  47 int ROUTING_PROP_ASR_LEVEL = -1;     //Where the properties are stored
  48
  49 /** @brief Retrieve a netcard from its name
  50  *
  51  * Netcards are the thing that connect host or routers to the network
  52  */
  53 simgrid::kernel::routing::NetCard *sg_netcard_by_name_or_null(const char *name)
  54 {
  55   sg_host_t h = sg_host_by_name(name);
  56   simgrid::kernel::routing::NetCard *netcard = h==nullptr ? nullptr: h->pimpl_netcard;
  57   if (!netcard)
  58     netcard = (simgrid::kernel::routing::NetCard*) xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
  59   return netcard;
  60 }
  61
  62 /* Global vars */
  63 simgrid::kernel::routing::RoutingPlatf *routing_platf = nullptr;
  64
  65
  66 void sg_platf_new_trace(sg_platf_trace_cbarg_t trace)
  67 {
  68   tmgr_trace_t tmgr_trace;
  69   if (trace->file && strcmp(trace->file, "") != 0) {
  70     tmgr_trace = tmgr_trace_new_from_file(trace->file);
  71   } else {
  72     xbt_assert(strcmp(trace->pc_data, ""),
  73         "Trace '%s' must have either a content, or point to a file on disk.",trace->id);
  74     tmgr_trace = tmgr_trace_new_from_string(trace->id, trace->pc_data, trace->periodicity);
  75   }
  76   xbt_dict_set(traces_set_list, trace->id, (void *) tmgr_trace, nullptr);
  77 }
  78
  79 namespace simgrid {
  80 namespace kernel {
  81 namespace routing {
  82
  83 /**
  84  * \brief Find a route between hosts
  85  *
  86  * \param src the network_element_t for src host
  87  * \param dst the network_element_t for dst host
  88  * \param route where to store the list of links.
  89  *              If *route=nullptr, create a short lived dynar. Else, fill the provided dynar
  90  * \param latency where to store the latency experienced on the path (or nullptr if not interested)
  91  *                It is the caller responsibility to initialize latency to 0 (we add to provided route)
  92  * \pre route!=nullptr
  93  *
  94  * walk through the routing components tree and find a route between hosts
  95  * by calling each "get_route" function in each routing component.
  96  */
  97 void RoutingPlatf::getRouteAndLatency(NetCard *src, NetCard *dst, std::vector<Link*> * route, double *latency)
  98 {
  99   XBT_DEBUG("getRouteAndLatency from %s to %s", src->name().c_str(), dst->name().c_str());
 100
 101   AsImpl::getRouteRecursive(src, dst, route, latency);
 102 }
 103
 104 static xbt_dynar_t _recursiveGetOneLinkRoutes(AsImpl *as)
 105 {
 106   xbt_dynar_t ret = xbt_dynar_new(sizeof(Onelink*), xbt_free_f);
 107
 108   //adding my one link routes
 109   xbt_dynar_t onelink_mine = as->getOneLinkRoutes();
 110   if (onelink_mine)
 111     xbt_dynar_merge(&ret,&onelink_mine);
 112
 113   //recursing
 114   char *key;
 115   xbt_dict_cursor_t cursor = nullptr;
 116   AsImpl *rc_child;
 117   xbt_dict_foreach(as->children(), cursor, key, rc_child) {
 118     xbt_dynar_t onelink_child = _recursiveGetOneLinkRoutes(rc_child);
 119     if (onelink_child)
 120       xbt_dynar_merge(&ret,&onelink_child);
 121   }
 122   return ret;
 123 }
 124
 125 xbt_dynar_t RoutingPlatf::getOneLinkRoutes(){
 126   return _recursiveGetOneLinkRoutes(root_);
 127 }
 128
 129 }}}
 130
 131 /** @brief create the root AS */
 132 void routing_model_create()
 133 {
 134   routing_platf = new simgrid::kernel::routing::RoutingPlatf();
 135 }
 136
 137 /* ************************************************************************** */
 138 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
 139
 140 static void check_disk_attachment()
 141 {
 142   xbt_lib_cursor_t cursor;
 143   char *key;
 144   void **data;
 145   xbt_lib_foreach(storage_lib, cursor, key, data) {
 146     if (xbt_lib_get_level(xbt_lib_get_elm_or_null(storage_lib, key), SURF_STORAGE_LEVEL) != nullptr) {
 147       simgrid::surf::Storage* storage =
 148           static_cast<simgrid::surf::Storage*>(xbt_lib_get_or_null(storage_lib, key, SURF_STORAGE_LEVEL));
 149       simgrid::kernel::routing::NetCard* host_elm = sg_netcard_by_name_or_null(storage->attach_);
 150       if (!host_elm)
 151         surf_parse_error("Unable to attach storage %s: host %s doesn't exist.", storage->getName(), storage->attach_);
 152     }
 153   }
 154 }
 155
 156 void routing_register_callbacks()
 157 {
 158   simgrid::surf::on_postparse.connect(check_disk_attachment);
 159
 160   instr_routing_define_callbacks();
 161 }
 162
 163 /** \brief Frees all memory allocated by the routing module */
 164 void routing_exit() {
 165   delete routing_platf;
 166 }
 167
 168 simgrid::kernel::routing::RoutingPlatf::RoutingPlatf() = default;
 169 simgrid::kernel::routing::RoutingPlatf::~RoutingPlatf()
 170 {
 171   delete root_;
 172 }