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