src/surf/surf_routing.hpp

   1 /* Copyright (c) 2013-2015. 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 #ifndef NETWORK_ROUTING_HPP_
   8 #define NETWORK_ROUTING_HPP_
   9
  10 #include <xbt/base.h>
  11 #include <xbt/signal.hpp>
  12
  13 #include "surf_interface.hpp"
  14 #include <float.h>
  15
  16 #include <vector>
  17 #include <map>
  18
  19 XBT_PUBLIC(void) routing_model_create( void *loopback);
  20
  21 namespace simgrid {
  22 namespace surf {
  23
  24 /***********
  25  * Classes *
  26  ***********/
  27
  28 class As;
  29 class XBT_PRIVATE RoutingModelDescription;
  30 class XBT_PRIVATE Onelink;
  31 class RoutingPlatf;
  32
  33 /** @ingroup SURF_routing_interface
  34  * @brief Network cards are the vertices in the graph representing the network, used to compute paths between nodes.
  35  *
  36  * @details This represents a position in the network. One can route information between two netcards
  37  */
  38 class NetCard {
  39 public:
  40   virtual ~NetCard(){};
  41   virtual int id()=0; // Our rank in the vertices_ array of our containing AS.
  42   virtual void setId(int id)=0;
  43   virtual char *name()=0;
  44   virtual As *containingAS()=0; // This is the AS in which I am
  45   virtual e_surf_network_element_type_t getRcType()=0;
  46 };
  47
  48 /** @ingroup SURF_routing_interface
  49  * @brief Network Autonomous System (AS)
  50  * @details [TODO]
  51  */
  52 class As {
  53 public:
  54   As(const char*name);
  55   /** @brief Close that AS: no more content can be added to it */
  56   virtual void Seal();
  57   virtual ~As();
  58
  59   e_surf_routing_hierarchy_t hierarchy_ = SURF_ROUTING_NULL;
  60   xbt_dynar_t upDownLinks = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
  61
  62   char *name_ = nullptr;
  63   NetCard *netcard_ = nullptr; // Our representative in the father AS
  64   As *father_ = nullptr;
  65   xbt_dict_t sons_ = xbt_dict_new_homogeneous(NULL); // sub-ASes
  66   xbt_dynar_t vertices_ = xbt_dynar_new(sizeof(char*),NULL); // our content, as known to our graph routing algorithm (maps vertexId -> vertex)
  67
  68 private:
  69   bool sealed_ = false; // We cannot add more content when sealed
  70   std::map<std::string, std::vector<Link*>*> *bypassRoutes_ = nullptr;
  71
  72 public:
  73   /**
  74    * @brief Probe the routing path between two points
  75    *
  76    * The networking model uses this function when creating a communication
  77    * to retrieve both the list of links that the create communication will use,
  78    * and the summed latency that these links represent.
  79    *
  80    * The network could recompute the latency by itself from the list, but it would
  81    * require an additional link set traversal. This operation being on the critical
  82    * path of SimGrid, the routing computes the latency in behalf of the network.
  83    *
  84    * Things are rather complex here because we have to find the path from ASes to ASes, and within each.
  85    * In addition, the different ASes may use differing routing models.
  86    * Some ASes may be routed in full, others may have only some connection information and use a shortest path on top of that, and so on.
  87    * Some ASes may even not have any predefined links and use only coordinate informations to compute the latency.
  88    *
  89    * So, the path is constructed recursively, with each traversed AS adding its information to the set.
  90    * The algorithm for that is explained in http://hal.inria.fr/hal-00650233/
  91    *
  92    * @param src Initial point of the routing path
  93    * @param dst Final point of the routing path
  94    * @param into Container into which the traversed links should be pushed
  95    * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
  96    */
  97   virtual void getRouteAndLatency(NetCard *src, NetCard *dst, sg_platf_route_cbarg_t into, double *latency)=0;
  98   /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
  99   virtual xbt_dynar_t getOneLinkRoutes();
 100
 101   virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges)=0;
 102
 103   std::vector<Link*> *getBypassRoute(NetCard *src, NetCard *dst);
 104
 105   /* Add content to the AS, at parsing time. It should be sealed afterward. */
 106   virtual int addComponent(NetCard *elm); /* A host, a router or an AS, whatever */
 107   virtual void addRoute(sg_platf_route_cbarg_t route);
 108   void addBypassRoute(sg_platf_route_cbarg_t e_route);
 109 };
 110
 111 struct XBT_PRIVATE NetCardImpl : public NetCard {
 112 public:
 113   NetCardImpl(const char *name, e_surf_network_element_type_t componentType, As *as)
 114   : name_(xbt_strdup(name)),
 115     componentType_(componentType),
 116     containingAS_(as)
 117   {}
 118   ~NetCardImpl() { xbt_free(name_);};
 119
 120   int id()           override {return id_;}
 121   void setId(int id) override {id_ = id;}
 122   char *name()       override {return name_;}
 123   As *containingAS() override {return containingAS_;}
 124   e_surf_network_element_type_t getRcType() override {return componentType_;}
 125 private:
 126   int id_ = -1;
 127   char *name_;
 128   e_surf_network_element_type_t componentType_;
 129   As *containingAS_;
 130 };
 131
 132 /** @ingroup SURF_routing_interface
 133  * @brief Link of lenght 1, alongside with its source and destination. This is mainly usefull in the ns3 bindings
 134  */
 135 class Onelink {
 136 public:
 137   Onelink(void *link, NetCard *src, NetCard *dst)
 138     : src_(src), dst_(dst), link_(link) {};
 139   NetCard *src_;
 140   NetCard *dst_;
 141   void *link_;
 142 };
 143
 144 /** @ingroup SURF_routing_interface
 145  * @brief The class representing a whole routing platform
 146  */
 147 XBT_PUBLIC_CLASS RoutingPlatf {
 148 public:
 149   RoutingPlatf(void *loopback);
 150   ~RoutingPlatf();
 151   As *root_ = nullptr;
 152   void *loopback_;
 153   xbt_dynar_t lastRoute_ = xbt_dynar_new(sizeof(Link*),NULL);
 154   xbt_dynar_t getOneLinkRoutes(void);
 155   void getRouteAndLatency(NetCard *src, NetCard *dst, xbt_dynar_t * links, double *latency);
 156 };
 157
 158 /*************
 159  * Callbacks *
 160  *************/
 161
 162 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(NetCard*)>) netcardCreatedCallbacks;
 163 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(As*)>) asCreatedCallbacks;
 164
 165 }
 166 }
 167
 168 #endif /* NETWORK_ROUTING_HPP_ */