1 /* Copyright (c) 2016-2019. 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
9 #include <simgrid/forward.h>
10 #include <xbt/signal.hpp>
13 #include <unordered_map>
20 /** @brief Networking Zones
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
26 class XBT_PUBLIC NetZone {
28 friend kernel::routing::NetZoneImpl;
30 explicit NetZone(kernel::routing::NetZoneImpl* impl) : pimpl_(impl) {}
33 /** @brief Retrieves the name of that netzone as a C++ string */
34 const std::string& get_name() const;
35 /** @brief Retrieves the name of that netzone as a C string */
36 const char* get_cname() const;
38 NetZone* get_father();
40 std::vector<Host*> get_all_hosts();
43 kernel::routing::NetZoneImpl* get_impl() const { return pimpl_; }
46 kernel::routing::NetZoneImpl* const pimpl_;
47 std::unordered_map<std::string, std::string> properties_;
50 /** Get the properties assigned to a netzone */
51 const std::unordered_map<std::string, std::string>* get_properties() const;
53 std::vector<NetZone*> get_children();
55 /** Retrieve the property value (or nullptr if not set) */
56 const char* get_property(const std::string& key) const;
57 void set_property(const std::string& key, const std::string& value);
59 /* Add content to the netzone, at parsing time. It should be sealed afterward. */
60 int add_component(kernel::routing::NetPoint* elm); /* A host, a router or a netzone, whatever */
61 void add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
62 kernel::routing::NetPoint* gw_dst, std::vector<kernel::resource::LinkImpl*>& link_list,
64 void add_bypass_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
65 kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
66 std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical);
68 /*** Called on each newly created regular route (not on bypass routes) */
69 static xbt::signal<void(bool symmetrical, kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
70 kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
71 std::vector<kernel::resource::LinkImpl*> const& link_list)>
73 static xbt::signal<void(NetZone const&)> on_creation;
74 static xbt::signal<void(NetZone const&)> on_seal;
78 } // namespace simgrid
80 #endif /* SIMGRID_S4U_NETZONE_HPP */