Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of scm.gforge.inria.fr:/gitroot/simgrid/simgrid
[simgrid.git] / 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 RoutingPlatf; // FIXME: KILLME
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, with a unique root AS (that you can retrieve from the s4u::Engine).
25  */
26 XBT_PUBLIC_CLASS AsImpl : public s4u::As {
27   friend simgrid::kernel::routing::RoutingPlatf;
28 protected:
29   explicit AsImpl(As * father, const char* name);
30   ~AsImpl() override;
31   
32 public:
33   /** @brief attach the given host to that AS */
34   void attachHost(s4u::Host * host);
35
36   /**
37    * @brief Probe the routing path between two points
38    *
39    * The networking model uses this function when creating a communication
40    * to retrieve both the list of links that the create communication will use,
41    * and the summed latency that these links represent.
42    *
43    * The network could recompute the latency by itself from the list, but it would
44    * require an additional link set traversal. This operation being on the critical
45    * path of SimGrid, the routing computes the latency in behalf of the network.
46    *
47    * Things are rather complex here because we have to find the path from ASes to ASes, and within each.
48    * In addition, the different ASes may use differing routing models.
49    * 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.
50    * Some ASes may even not have any predefined links and use only coordinate information to compute the latency.
51    *
52    * So, the path is constructed recursively, with each traversed AS adding its information to the set.
53    * The algorithm for that is explained in http://hal.inria.fr/hal-00650233/
54    *
55    * @param src Initial point of the routing path
56    * @param dst Final point of the routing path
57    * @param into Container into which the traversed links should be pushed
58    * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
59    */
60   virtual void getRouteAndLatency(NetCard *src, NetCard *dst, sg_platf_route_cbarg_t into, double *latency)=0;
61   /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
62   virtual xbt_dynar_t getOneLinkRoutes();
63   std::vector<surf::Link*> *getBypassRoute(routing::NetCard *src, routing::NetCard *dst);
64
65   virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges)=0;
66   static void getRouteRecursive(routing::NetCard *src, routing::NetCard *dst, /* OUT */ std::vector<surf::Link*> * links, double *latency);
67
68
69   enum class RoutingMode {
70     unset = 0,  /**< Undefined type                                   */
71     base,       /**< Base case: use simple link lists for routing     */
72     recursive   /**< Recursive case: also return gateway information  */
73   };
74   /* FIXME: protect the following fields once the construction madness is sorted out */
75   RoutingMode hierarchy_ = RoutingMode::unset;
76   routing::NetCard *netcard_ = nullptr; // Our representative in the father AS
77 };
78
79 }}}; // Namespace simgrid::kernel::routing
80
81 #endif /* SIMGRID_SURF_AS_HPP */