src/kernel/routing/AsImpl.hpp

   1 /* Copyright (c) 2016. 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 #ifndef SIMGRID_SURF_AS_HPP
   7 #define SIMGRID_SURF_AS_HPP
   8
   9 #include "xbt/graph.h"
  10
  11 #include "simgrid/s4u/forward.hpp"
  12 #include "simgrid/s4u/As.hpp"
  13
  14 #include "src/surf/xml/platf_private.hpp" // FIXME: kill sg_platf_route_cbarg_t to remove that UGLY include
  15
  16 namespace simgrid {
  17 namespace kernel {
  18 namespace routing {
  19   class Onelink;
  20
  21   /** @brief Autonomous Systems
  22    *
  23    * An AS is a network container, in charge of routing information between elements (hosts) and to the nearby ASes.
  24    * In SimGrid, there is a hierarchy of ASes, ie a tree with a unique root AS, that you can retrieve from the
  25    * s4u::Engine.
  26    *
  27    * The purpose of the kernel::routing module is to retrieve the routing path between two points in a time- and
  28    * space-efficient manner. This is done by AsImpl::getGlobalRoute(), called when creating a communication to
  29    * retrieve both the list of links that the create communication will use, and the summed latency that these
  30    * links represent.
  31    *
  32    * The network could recompute the latency by itself from the list, but it would require an additional link
  33    * set traversal. This operation being on the critical path of SimGrid, the routing computes the latency on the
  34    * behalf of the network.
  35    *
  36    * Finding the path between two nodes is rather complex because we navigate a hierarchy of ASes, each of them
  37    * being a full network. In addition, the routing can declare shortcuts (called bypasses), either within an AS
  38    * at the route level or directly between ASes. Also, each AS can use a differing routing algorithm, depending
  39    * on its class. @ref{AsFull} have a full matrix giving explicitly the path between any pair of their
  40    * contained nodes, while @ref{AsDijkstra} or @ref{AsFloyd} rely on a shortest path algorithm. @ref{AsVivaldi}
  41    * does not even have any link but only use only coordinate information to compute the latency.
  42    *
  43    * So AsImpl::getGlobalRoute builds the path recursively asking its specific information to each traversed AS with
  44    * AsImpl::getLocalRoute, that is redefined in each sub-class.
  45    * The algorithm for that is explained in http://hal.inria.fr/hal-00650233/
  46    *
  47    */
  48   XBT_PUBLIC_CLASS AsImpl : public s4u::As
  49   {
  50   protected:
  51     explicit AsImpl(As * father, const char* name);
  52
  53   public:
  54     /** @brief Make an host within that AS */
  55     simgrid::s4u::Host* createHost(const char* name, std::vector<double>* speedPerPstate, int coreAmount);
  56
  57   protected:
  58     /**
  59      * @brief Probe the routing path between two points that are local to the called AS.
  60      *
  61      * @param src where from
  62      * @param dst where to
  63      * @param into Container into which the traversed links and gateway informations should be pushed
  64      * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
  65      */
  66     virtual void getLocalRoute(NetCard * src, NetCard * dst, sg_platf_route_cbarg_t into, double* latency) = 0;
  67     /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
  68     /* returns whether we found a bypass path */
  69     bool getBypassRoute(routing::NetCard * src, routing::NetCard * dst,
  70                         /* OUT */ std::vector<surf::Link*> * links, double* latency);
  71
  72   public:
  73     /* @brief get the route between two nodes in the full platform
  74      *
  75      * @param src where from
  76      * @param dst where to
  77      * @param links Accumulator in which all traversed links should be pushed (caller must empty it)
  78      * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
  79      */
  80     static void getGlobalRoute(routing::NetCard * src, routing::NetCard * dst,
  81                                /* OUT */ std::vector<surf::Link*> * links, double* latency);
  82
  83     virtual void getOneLinkRoutes(std::vector<Onelink*> * accumulator);
  84     virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges) = 0;
  85     enum class RoutingMode {
  86       unset = 0, /**< Undefined type                                   */
  87       base,      /**< Base case: use simple link lists for routing     */
  88       recursive  /**< Recursive case: also return gateway information  */
  89     };
  90     /* FIXME: protect the following fields once the construction madness is sorted out */
  91     RoutingMode hierarchy_     = RoutingMode::unset;
  92
  93   private:
  94     routing::NetCard* netcard_ = nullptr; // Our representative in the father AS
  95 };
  96
  97 }}}; // Namespace simgrid::kernel::routing
  98
  99 #endif /* SIMGRID_SURF_AS_HPP */