Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
rename AsRoute to BypassRoute, and move it to its own file
[simgrid.git] / include / simgrid / s4u / As.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_S4U_AS_HPP
7 #define SIMGRID_S4U_AS_HPP
8
9 #include <map>
10 #include <string>
11 #include <utility>
12 #include <vector>
13
14 #include <xbt/base.h>
15 #include <xbt/graph.h>
16
17 #include <simgrid/s4u/forward.hpp>
18
19 #include "src/surf/xml/platf_private.hpp" // FIXME: kill sg_platf_route_cbarg_t to remove that UGLY include
20
21 namespace simgrid {
22
23 namespace surf {
24   class Link;
25 }
26 namespace kernel {
27   namespace routing {
28     class AsImpl;
29     class NetCard;
30     class BypassRoute;
31   }
32 }
33 namespace s4u {
34
35 /** @brief Autonomous Systems
36  *
37  * An AS is a network container, in charge of routing information between elements (hosts) and to the nearby ASes.
38  * In SimGrid, there is a hierarchy of ASes, with a unique root AS (that you can retrieve from the s4u::Engine).
39  */
40 XBT_PUBLIC_CLASS As {
41 protected:
42   friend simgrid::kernel::routing::AsImpl;
43
44   explicit As(As * father, const char* name);
45   virtual ~As();
46   
47 public:
48   /** @brief Seal your AS once you're done adding content, and before routing stuff through it */
49   virtual void seal();
50   char *name();
51   As *father();;
52   xbt_dict_t children(); // Sub AS
53   xbt_dynar_t hosts();   // my content as a dynar
54
55 public:
56   /* Add content to the AS, at parsing time. It should be sealed afterward. */
57   virtual int addComponent(kernel::routing::NetCard *elm); /* A host, a router or an AS, whatever */
58   virtual void addRoute(sg_platf_route_cbarg_t route);
59   void addBypassRoute(sg_platf_route_cbarg_t e_route);
60
61   /*** Called on each newly created regular route (not on bypass routes) */
62   static simgrid::xbt::signal<void(bool symmetrical, kernel::routing::NetCard* src, kernel::routing::NetCard* dst,
63                                    kernel::routing::NetCard* gw_src, kernel::routing::NetCard* gw_dst,
64                                    std::vector<Link*>* link_list)>
65       onRouteCreation;
66
67 protected:
68   std::vector<kernel::routing::NetCard*> vertices_; // our content, as known to our graph routing algorithm (maps vertexId -> vertex)
69
70 private:
71   As* father_ = nullptr;
72   char* name_ = nullptr;
73
74   bool sealed_ = false; // We cannot add more content when sealed
75
76   std::map<std::pair<kernel::routing::NetCard*, kernel::routing::NetCard*>, kernel::routing::BypassRoute*>
77       bypassRoutes_;                                                                      // src x dst -> route
78   xbt_dict_t children_ = xbt_dict_new_homogeneous(nullptr);                               // sub-ASes
79 };
80
81 }}; // Namespace simgrid::s4u
82
83 #endif /* SIMGRID_S4U_AS_HPP */