Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
4fea672f9cb952f62b4c8bfc919553d1235522d2
[simgrid.git] / include / simgrid / s4u / NetZone.hpp
1 /* Copyright (c) 2016-2018. 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_NETZONE_HPP
7 #define SIMGRID_S4U_NETZONE_HPP
8
9 #include <simgrid/forward.h>
10 #include <xbt/signal.hpp>
11
12 #include <string>
13 #include <unordered_map>
14 #include <utility>
15 #include <vector>
16
17 namespace simgrid {
18 namespace s4u {
19
20 /** @brief Networking Zones
21  *
22  * A netzone is a network container, in charge of routing information between elements (hosts) and to the nearby
23  * netzones. In SimGrid, there is a hierarchy of netzones, with a unique root zone (that you can retrieve from the
24  * s4u::Engine).
25  */
26 class XBT_PUBLIC NetZone {
27 protected:
28   friend simgrid::kernel::routing::NetZoneImpl;
29
30   explicit NetZone(NetZone * father, std::string name);
31   virtual ~NetZone();
32
33 public:
34   /** @brief Seal your netzone once you're done adding content, and before routing stuff through it */
35   virtual void seal();
36   /** @brief Retrieves the name of that netzone as a C++ string */
37   const std::string& get_name() const { return name_; }
38   /** @brief Retrieves the name of that netzone as a C string */
39   const char* get_cname() const;
40   NetZone* getFather();
41
42   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_name()") const std::string& getName() const { return get_name(); }
43   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_cname()") const char* getCname() const { return get_cname(); }
44   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_route()") void addRoute(
45       kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
46       kernel::routing::NetPoint* gw_dst, std::vector<simgrid::kernel::resource::LinkImpl*>& link_list, bool symmetrical)
47   {
48     add_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
49   }
50   XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_bypass_route()") void addBypassRoute(
51       kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
52       kernel::routing::NetPoint* gw_dst, std::vector<simgrid::kernel::resource::LinkImpl*>& link_list, bool symmetrical)
53   {
54     add_bypass_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
55   }
56
57   std::vector<NetZone*>* getChildren();             // Sub netzones
58   void getHosts(std::vector<s4u::Host*> * whereto); // retrieve my content as a vector of hosts
59   int getHostCount();
60
61   /** Get the properties assigned to a host */
62   std::unordered_map<std::string, std::string>* getProperties();
63
64   /** Retrieve the property value (or nullptr if not set) */
65   const char* getProperty(const char* key);
66   void setProperty(const char* key, const char* value);
67
68   /* Add content to the netzone, at parsing time. It should be sealed afterward. */
69   virtual int addComponent(kernel::routing::NetPoint * elm); /* A host, a router or a netzone, whatever */
70   virtual void add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
71                          kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
72                          std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical);
73   virtual void add_bypass_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
74                                 kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
75                                 std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical) = 0;
76
77   /*** Called on each newly created regular route (not on bypass routes) */
78   static simgrid::xbt::signal<void(bool symmetrical, kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
79                                    kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
80                                    std::vector<kernel::resource::LinkImpl*>& link_list)>
81       onRouteCreation;
82   static simgrid::xbt::signal<void(NetZone&)> onCreation;
83   static simgrid::xbt::signal<void(NetZone&)> onSeal;
84
85 protected:
86   unsigned int getTableSize() { return vertices_.size(); }
87   std::vector<kernel::routing::NetPoint*> getVertices() { return vertices_; }
88
89 private:
90   // our content, as known to our graph routing algorithm (maps vertexId -> vertex)
91   std::vector<kernel::routing::NetPoint*> vertices_;
92
93   std::unordered_map<std::string, std::string> properties_;
94   NetZone* father_ = nullptr;
95   std::string name_;
96
97   bool sealed_ = false; // We cannot add more content when sealed
98
99   std::vector<NetZone*>* children_ = nullptr; // sub-netzones
100 };
101 }
102 }; // Namespace simgrid::s4u
103
104 #endif /* SIMGRID_S4U_NETZONE_HPP */