Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
84121d3941867bcd1c73ba5447e77a79b9801cfd
[simgrid.git] / include / simgrid / s4u / NetZone.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 NetZoneImpl;
29 class NetCard;
30 }
31 }
32 namespace s4u {
33
34 /** @brief Autonomous Systems
35  *
36  * An AS is a network container, in charge of routing information between elements (hosts) and to the nearby ASes.
37  * In SimGrid, there is a hierarchy of ASes, with a unique root AS (that you can retrieve from the s4u::Engine).
38  */
39 XBT_PUBLIC_CLASS NetZone
40 {
41 protected:
42   friend simgrid::kernel::routing::NetZoneImpl;
43
44   explicit NetZone(NetZone * father, const char* name);
45   virtual ~NetZone();
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   NetZone* father();
52   ;
53   xbt_dict_t children(); // Sub AS
54   xbt_dynar_t hosts();   // my content as a dynar
55
56 public:
57   /* Add content to the AS, at parsing time. It should be sealed afterward. */
58   virtual int addComponent(kernel::routing::NetCard * elm); /* A host, a router or an AS, whatever */
59   virtual void addRoute(sg_platf_route_cbarg_t route);
60   virtual void addBypassRoute(sg_platf_route_cbarg_t e_route) = 0;
61
62   /*** Called on each newly created regular route (not on bypass routes) */
63   static simgrid::xbt::signal<void(bool symmetrical, kernel::routing::NetCard* src, kernel::routing::NetCard* dst,
64                                    kernel::routing::NetCard* gw_src, kernel::routing::NetCard* gw_dst,
65                                    std::vector<Link*>* link_list)>
66       onRouteCreation;
67
68 protected:
69   std::vector<kernel::routing::NetCard*>
70       vertices_; // our content, as known to our graph routing algorithm (maps vertexId -> vertex)
71
72 private:
73   NetZone* father_ = nullptr;
74   char* name_      = nullptr;
75
76   bool sealed_ = false; // We cannot add more content when sealed
77
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 */