1 /* Copyright (c) 2016-2018. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_S4U_NETZONE_HPP
7 #define SIMGRID_S4U_NETZONE_HPP
10 #include <unordered_map>
15 #include <xbt/graph.h>
16 #include <xbt/signal.hpp>
18 #include <simgrid/forward.h>
19 #include <simgrid/s4u/forward.hpp>
25 /** @brief Networking Zones
27 * A netzone is a network container, in charge of routing information between elements (hosts) and to the nearby
28 * netzones. In SimGrid, there is a hierarchy of netzones, with a unique root zone (that you can retrieve from the
31 class XBT_PUBLIC NetZone {
33 friend simgrid::kernel::routing::NetZoneImpl;
35 explicit NetZone(NetZone * father, std::string name);
39 /** @brief Seal your netzone once you're done adding content, and before routing stuff through it */
41 /** @brief Retrieves the name of that netzone as a C++ string */
42 const std::string& get_name() const { return name_; }
43 /** @brief Retrieves the name of that netzone as a C string */
44 const char* get_cname() const;
47 XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_name()") const std::string& getName() const { return get_name(); }
48 XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_cname()") const char* getCname() const { return get_cname(); }
49 XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_route()") void addRoute(
50 kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
51 kernel::routing::NetPoint* gw_dst, std::vector<simgrid::kernel::resource::LinkImpl*>& link_list, bool symmetrical)
53 add_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
55 XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_bypass_route()") void addBypassRoute(
56 kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
57 kernel::routing::NetPoint* gw_dst, std::vector<simgrid::kernel::resource::LinkImpl*>& link_list, bool symmetrical)
59 add_bypass_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
62 std::vector<NetZone*>* getChildren(); // Sub netzones
63 void getHosts(std::vector<s4u::Host*> * whereto); // retrieve my content as a vector of hosts
66 /** Get the properties assigned to a host */
67 std::unordered_map<std::string, std::string>* getProperties();
69 /** Retrieve the property value (or nullptr if not set) */
70 const char* getProperty(const char* key);
71 void setProperty(const char* key, const char* value);
73 /* Add content to the netzone, at parsing time. It should be sealed afterward. */
74 virtual int addComponent(kernel::routing::NetPoint * elm); /* A host, a router or a netzone, whatever */
75 virtual void add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
76 kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
77 std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical);
78 virtual void add_bypass_route(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, bool symmetrical) = 0;
82 /*** Called on each newly created regular route (not on bypass routes) */
83 static simgrid::xbt::signal<void(bool symmetrical, kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
84 kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
85 std::vector<kernel::resource::LinkImpl*>& link_list)>
87 static simgrid::xbt::signal<void(NetZone&)> onCreation;
88 static simgrid::xbt::signal<void(NetZone&)> onSeal;
91 unsigned int getTableSize() { return vertices_.size(); }
92 std::vector<kernel::routing::NetPoint*> getVertices() { return vertices_; }
95 // our content, as known to our graph routing algorithm (maps vertexId -> vertex)
96 std::vector<kernel::routing::NetPoint*> vertices_;
98 std::unordered_map<std::string, std::string> properties_;
99 NetZone* father_ = nullptr;
102 bool sealed_ = false; // We cannot add more content when sealed
104 std::vector<NetZone*>* children_ = nullptr; // sub-netzones
107 }; // Namespace simgrid::s4u
109 #endif /* SIMGRID_S4U_NETZONE_HPP */