Logo AND Algorithmique Numérique Distribuée

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