1 /* Copyright (c) 2016-2021. 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 <simgrid/s4u/Link.hpp>
11 #include <xbt/graph.h>
12 #include <xbt/signal.hpp>
16 #include <unordered_map>
23 /** @brief Networking Zones
25 * A netzone is a network container, in charge of routing information between elements (hosts) and to the nearby
26 * netzones. In SimGrid, there is a hierarchy of netzones, with a unique root zone (that you can retrieve from the
29 class XBT_PUBLIC NetZone {
30 kernel::routing::NetZoneImpl* const pimpl_;
33 friend kernel::routing::NetZoneImpl;
35 explicit NetZone(kernel::routing::NetZoneImpl* impl) : pimpl_(impl) {}
38 /** @brief Retrieves the name of that netzone as a C++ string */
39 const std::string& get_name() const;
40 /** @brief Retrieves the name of that netzone as a C string */
41 const char* get_cname() const;
43 XBT_ATTRIB_DEPRECATED_v331("Please use get_parent()") NetZone* get_father();
44 NetZone* get_parent() const;
45 NetZone* set_parent(const NetZone* parent);
47 std::vector<Host*> get_all_hosts() const;
48 int get_host_count() const;
50 kernel::routing::NetZoneImpl* get_impl() const { return pimpl_; }
52 /** Get the properties assigned to a netzone */
53 const std::unordered_map<std::string, std::string>* get_properties() const;
54 /** Retrieve the property value (or nullptr if not set) */
55 const char* get_property(const std::string& key) const;
56 void set_property(const std::string& key, const std::string& value);
58 std::vector<NetZone*> get_children() const;
59 NetZone* add_child(const NetZone* new_zone);
61 void extract_xbt_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t, std::less<>>* nodes,
62 std::map<std::string, xbt_edge_t, std::less<>>* edges);
64 /* Add content to the netzone, at parsing time. It should be sealed afterward. */
65 int add_component(kernel::routing::NetPoint* elm); /* A host, a router or a netzone, whatever */
68 * @brief Add a route between 2 netpoints
70 * Create a regular route between 2 netpoints. A netpoint can be a host
73 * @param src Source netpoint
74 * @param dst Destination netpoint
75 * @param link_list List of links used in this communication
76 * @param symmetrical Bi-directional communication
78 void add_regular_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
79 const std::vector<Link*>& link_list, bool symmetrical = true);
81 * @brief Add a route between 2 netzones
83 * Create a route between 2 netzones, connecting 2 gateways.
85 * @param src Source netzone's netpoint
86 * @param dst Destination netzone' netpoint
87 * @param src_gw Netpoint of the gateway in the source netzone
88 * @param dst_gw Netpoint of the gateway in the destination netzone
89 * @param link_list List of links used in this communication
90 * @param symmetrical Bi-directional communication
92 void add_netzone_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
93 kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
94 const std::vector<Link*>& link_list, bool symmetrical = true);
96 void add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
97 kernel::routing::NetPoint* gw_dst, const std::vector<kernel::resource::LinkImpl*>& link_list,
99 void add_bypass_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
100 kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
101 std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical);
103 /*** Called on each newly created regular route (not on bypass routes) */
104 static xbt::signal<void(bool symmetrical, kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
105 kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
106 std::vector<kernel::resource::LinkImpl*> const& link_list)>
108 static xbt::signal<void(NetZone const&)> on_creation;
109 static xbt::signal<void(NetZone const&)> on_seal;
112 * @brief Create a host
114 * @param name Host name
115 * @param speed_per_state Vector of CPU's speeds
117 s4u::Host* create_host(const std::string& name, const std::vector<double>& speed_per_pstate);
119 * @brief Create a Host (string version)
121 * @throw std::invalid_argument if speed format is incorrect.
123 s4u::Host* create_host(const std::string& name, const std::vector<std::string>& speed_per_pstate);
126 * @brief Create a link
128 * @param name Link name
129 * @param bandwidths Link's speed (vector for wifi links)
130 * @param policy Link sharing policy
131 * @throw std::invalid_argument if bandwidth format is incorrect.
133 s4u::Link* create_link(const std::string& name, const std::vector<double>& bandwidths,
134 Link::SharingPolicy policy = Link::SharingPolicy::SHARED);
136 /** @brief Create a link (string version) */
137 s4u::Link* create_link(const std::string& name, const std::vector<std::string>& bandwidths,
138 Link::SharingPolicy policy = Link::SharingPolicy::SHARED);
141 * @brief Seal this netzone configuration
146 /** @brief Auxiliary function to get list of LinkImpl */
147 static std::vector<kernel::resource::LinkImpl*> get_link_list_impl(const std::vector<Link*> link_list);
150 // External constructors so that the types (and the types of their content) remain hidden
151 XBT_PUBLIC NetZone* create_full_zone(const std::string& name);
152 XBT_PUBLIC NetZone* create_cluster_zone(const std::string& name);
153 XBT_PUBLIC NetZone* create_dijkstra_zone(const std::string& name, bool cache);
154 XBT_PUBLIC NetZone* create_dragonfly_zone(const std::string& name);
155 XBT_PUBLIC NetZone* create_empty_zone(const std::string& name);
156 XBT_PUBLIC NetZone* create_fatTree_zone(const std::string& name);
157 XBT_PUBLIC NetZone* create_floyd_zone(const std::string& name);
158 XBT_PUBLIC NetZone* create_torus_zone(const std::string& name);
159 XBT_PUBLIC NetZone* create_vivaldi_zone(const std::string& name);
160 XBT_PUBLIC NetZone* create_wifi_zone(const std::string& name);
163 } // namespace simgrid
165 #endif /* SIMGRID_S4U_NETZONE_HPP */