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 A network card
  32  * @details This represents a position in the network. One can route information between two netcards
  33  */
  34 class NetCard {
  35 public:
  36   virtual ~NetCard(){};
  37   virtual int getId()=0;
  38   virtual int *getIdPtr()=0;
  39   virtual void setId(int id)=0;
  40   virtual char *getName()=0;
  41   virtual As *getRcComponent()=0;
  42   virtual e_surf_network_element_type_t getRcType()=0;
  43 };
  44
  45 /** @ingroup SURF_routing_interface
  46  * @brief The Autonomous System (AS) routing interface
  47  * @details [TODO]
  48  */
  49 class As {
  50 public:
  51   xbt_dynar_t p_indexNetworkElm = xbt_dynar_new(sizeof(char*),NULL);
  52   xbt_dict_t p_bypassRoutes;    /* store bypass routes */
  53   routing_model_description_t p_modelDesc;
  54   e_surf_routing_hierarchy_t p_hierarchy;
  55   char *p_name = nullptr;
  56   As *p_routingFather = nullptr;
  57   xbt_dict_t p_routingSons = xbt_dict_new_homogeneous(NULL);
  58   NetCard *p_netcard;
  59   xbt_dynar_t p_linkUpDownList = NULL;
  60
  61   As(){};
  62   /* Close that AS: no more content can be added to it */
  63   virtual void Seal()=0;
  64
  65   virtual ~As(){
  66     xbt_dict_free(&p_routingSons);
  67     xbt_dynar_free(&p_indexNetworkElm);
  68     xbt_dynar_free(&p_linkUpDownList);
  69     xbt_free(p_name);
  70     if (p_netcard)
  71       delete p_netcard;
  72   };
  73
  74   /**
  75    * @brief Get the characteristics of the routing path between two points
  76    *
  77    * This function is used by the networking model to find the information it needs when starting a communication.
  78    *
  79    * The things are not straightforward because the platform can be routed using several routing models.
  80    * 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.
  81    * Some ASes may even not have any predefined links and use only coordinate informations to compute the latency.
  82    *
  83    * So, the path is constructed recursively, with each traversed AS adding its information to the set.
  84    * The algorithm for that is explained in http://hal.inria.fr/hal-00650233/
  85    *
  86    * @param src Initial point of the routing path
  87    * @param dst Final point of the routing path
  88    * @param into Container into which the links should be pushed
  89    * @param latency Accumulator in which the latencies should be added
  90    */
  91   virtual void getRouteAndLatency(
  92       NetCard *src, NetCard *dst,
  93       sg_platf_route_cbarg_t into, double *latency)=0;
  94   virtual xbt_dynar_t getOneLinkRoutes()=0;
  95   virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges)=0;
  96   virtual sg_platf_route_cbarg_t getBypassRoute(
  97       NetCard *src, NetCard *dst,
  98       double *lat)=0;
  99
 100   /* The parser calls the following functions to inform the routing models
 101    * that a new element is added to the AS currently built.
 102    *
 103    * Of course, only the routing model of this AS is informed, not every ones */
 104   virtual int parsePU(NetCard *elm)=0; /* A host or a router, whatever */
 105   virtual int parseAS(NetCard *elm)=0;
 106   virtual void parseRoute(sg_platf_route_cbarg_t route)=0;
 107   virtual void parseASroute(sg_platf_route_cbarg_t route)=0;
 108   virtual void parseBypassroute(sg_platf_route_cbarg_t e_route)=0;
 109 };
 110
 111 struct XBT_PRIVATE NetCardImpl : public NetCard {
 112 public:
 113   NetCardImpl(const char *name, e_surf_network_element_type_t componentType, As *component)
 114   : component_(component),
 115     componentType_(componentType),
 116     name_(xbt_strdup(name)) {}
 117   ~NetCardImpl() { xbt_free(name_);};
 118
 119   int getId() {return id_;}
 120   int *getIdPtr() {return &id_;}
 121   void setId(int id) {id_ = id;}
 122   char *getName() {return name_;}
 123   As *getRcComponent() {return component_;}
 124   e_surf_network_element_type_t getRcType() {return componentType_;}
 125 private:
 126   As *component_;
 127   e_surf_network_element_type_t componentType_;
 128   int id_ = -1;
 129   char *name_;
 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     : p_src(src), p_dst(dst), p_link(link) {};
 139   NetCard *p_src;
 140   NetCard *p_dst;
 141   void *p_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 *p_root = nullptr;
 152   void *p_loopback;
 153   xbt_dynar_t p_lastRoute = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
 154   xbt_dynar_t getOneLinkRoutes(void);
 155   xbt_dynar_t recursiveGetOneLinkRoutes(As *rc);
 156   void getRouteAndLatency(NetCard *src, NetCard *dst, xbt_dynar_t * links, double *latency);
 157 };
 158
 159 /*************
 160  * Callbacks *
 161  *************/
 162
 163 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(NetCard*)>) netcardCreatedCallbacks;
 164 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(As*)>) asCreatedCallbacks;
 165
 166 }
 167 }
 168
 169 #endif /* NETWORK_ROUTING_HPP_ */