Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
d04ad90fa9d6bca57f0a73404c7b668f0b6e658a
[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_NETZONE_HPP
7 #define SIMGRID_S4U_NETZONE_HPP
8
9 #include <string>
10 #include <unordered_map>
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 namespace kernel {
23 namespace routing {
24 class NetZoneImpl;
25 }
26 }
27
28 namespace s4u {
29
30 /** @brief Networking Zones
31  *
32  * A netzone is a network container, in charge of routing information between elements (hosts) and to the nearby
33  * netzones. In SimGrid, there is a hierarchy of netzones, with a unique root zone (that you can retrieve from the
34  * s4u::Engine).
35  */
36 XBT_PUBLIC_CLASS NetZone
37 {
38 protected:
39   friend simgrid::kernel::routing::NetZoneImpl;
40
41   explicit NetZone(NetZone * father, const char* name);
42   virtual ~NetZone();
43
44 public:
45   /** @brief Seal your netzone once you're done adding content, and before routing stuff through it */
46   virtual void seal();
47   char* name();
48   NetZone* father();
49
50   xbt_dict_t children(); // Sub netzones
51   std::vector<Host*> hosts(); // my content as a vector of hosts
52
53   /** Get the properties assigned to a host */
54   std::unordered_map<std::string, std::string>* properties();
55
56   /** Retrieve the property value (or nullptr if not set) */
57   const char* property(const char* key);
58   void setProperty(const char* key, const char* value);
59
60   /* Add content to the netzone, at parsing time. It should be sealed afterward. */
61   virtual int addComponent(kernel::routing::NetPoint * elm); /* A host, a router or a netzone, whatever */
62   virtual void addRoute(sg_platf_route_cbarg_t route);
63   virtual void addBypassRoute(sg_platf_route_cbarg_t e_route) = 0;
64
65   /*** Called on each newly created regular route (not on bypass routes) */
66   static simgrid::xbt::signal<void(bool symmetrical, kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
67                                    kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
68                                    std::vector<surf::LinkImpl*>* link_list)>
69       onRouteCreation;
70
71 protected:
72   std::vector<kernel::routing::NetPoint*>
73       vertices_; // our content, as known to our graph routing algorithm (maps vertexId -> vertex)
74
75 private:
76   std::unordered_map<std::string, std::string> properties_;
77   NetZone* father_ = nullptr;
78   char* name_      = nullptr;
79
80   bool sealed_ = false; // We cannot add more content when sealed
81
82   xbt_dict_t children_ = xbt_dict_new_homogeneous(nullptr); // sub-netzones
83 };
84 }
85 }; // Namespace simgrid::s4u
86
87 #endif /* SIMGRID_S4U_NETZONE_HPP */