-/* Copyright (c) 2016-2021. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2016-2023. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#ifndef SIMGRID_S4U_NETZONE_HPP
#define SIMGRID_S4U_NETZONE_HPP
+#include "simgrid/s4u/Host.hpp"
#include <simgrid/forward.h>
#include <simgrid/s4u/Link.hpp>
#include <xbt/graph.h>
#include <map>
#include <string>
#include <unordered_map>
+#include <unordered_set>
#include <utility>
#include <vector>
-namespace simgrid {
-namespace s4u {
+namespace simgrid::s4u {
/** @brief Networking Zones
*
* s4u::Engine).
*/
class XBT_PUBLIC NetZone {
+#ifndef DOXYGEN
+ friend kernel::routing::NetZoneImpl;
+#endif
+
kernel::routing::NetZoneImpl* const pimpl_;
protected:
- friend kernel::routing::NetZoneImpl;
-
explicit NetZone(kernel::routing::NetZoneImpl* impl) : pimpl_(impl) {}
public:
/** @brief Retrieves the name of that netzone as a C string */
const char* get_cname() const;
- XBT_ATTRIB_DEPRECATED_v331("Please use get_parent()") NetZone* get_father();
NetZone* get_parent() const;
NetZone* set_parent(const NetZone* parent);
+ std::vector<NetZone*> get_children() const;
std::vector<Host*> get_all_hosts() const;
- int get_host_count() const;
+ size_t get_host_count() const;
kernel::routing::NetZoneImpl* get_impl() const { return pimpl_; }
const char* get_property(const std::string& key) const;
void set_property(const std::string& key, const std::string& value);
/** @brief Get the netpoint associated to this netzone */
- kernel::routing::NetPoint* get_netpoint();
-
- std::vector<NetZone*> get_children() const;
- XBT_ATTRIB_DEPRECATED_v332("Please use set_parent() to manage NetZone's relationship") NetZone* add_child(
- NetZone* new_zone);
+ kernel::routing::NetPoint* get_netpoint() const;
+ /** @brief Get the gateway associated to this netzone */
+ kernel::routing::NetPoint* get_gateway() const;
+ kernel::routing::NetPoint* get_gateway(const std::string& name) const;
+ void set_gateway(const s4u::Host* router) { set_gateway(router->get_netpoint()); }
+ void set_gateway(kernel::routing::NetPoint* router);
+ void set_gateway(const std::string& name, kernel::routing::NetPoint* router);
void extract_xbt_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t, std::less<>>* nodes,
std::map<std::string, xbt_edge_t, std::less<>>* edges);
/* Add content to the netzone, at parsing time. It should be sealed afterward. */
- int add_component(kernel::routing::NetPoint* elm); /* A host, a router or a netzone, whatever */
+ unsigned long add_component(kernel::routing::NetPoint* elm); /* A host, a router or a netzone, whatever */
+
+ /**
+ * @brief Add a route between 2 netzones, and same in other direction
+ * @param src Source netzone
+ * @param dst Destination netzone
+ * @param links List of links
+ */
+ void add_route(const NetZone* src, const NetZone* dst, const std::vector<const Link*>& links);
+
+/**
+ * @brief Add a route between 2 netzones, and same in other direction
+ * @param src Source netzone
+ * @param dst Destination netzone
+ * @param link_list List of links and their direction used in this communication
+ * @param symmetrical Bi-directional communication
+ */
+ void add_route(const NetZone* src, const NetZone* dst, const std::vector<LinkInRoute>& link_list, bool symmetrical = true);
+#ifndef DOXYGEN
/**
* @brief Add a route between 2 netpoints
*
*
* @param src Source netzone's netpoint
* @param dst Destination netzone' netpoint
- * @param src_gw Netpoint of the gateway in the source netzone
- * @param dst_gw Netpoint of the gateway in the destination netzone
- * @param link_list List of links used in this communication
+ * @param gw_src Netpoint of the gateway in the source netzone
+ * @param gw_dst Netpoint of the gateway in the destination netzone
+ * @param link_list List of links and their direction used in this communication
* @param symmetrical Bi-directional communication
*/
+ //(we should first remove the Python binding in v3.35) XBT_ATTRIB_DEPRECATED_v339("Please call add_route either from
+ // Host to Host or NetZone to NetZone")
void add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
- kernel::routing::NetPoint* gw_dst, const std::vector<Link*>& link_list, bool symmetrical = true);
-
- XBT_ATTRIB_DEPRECATED_v332("Please use add_route() method which uses s4u::Link instead of LinkImpl") void add_route(
+ kernel::routing::NetPoint* gw_dst, const std::vector<LinkInRoute>& link_list, bool symmetrical = true);
+ /**
+ * @brief Add a route between 2 netpoints, and same in other direction
+ *
+ * Create a route:
+ * - route between 2 hosts/routers in same netzone, no gateway is needed
+ * - route between 2 netzones, connecting 2 gateways.
+ *
+ * @param src Source netzone's netpoint
+ * @param dst Destination netzone' netpoint
+ * @param gw_src Netpoint of the gateway in the source netzone
+ * @param gw_dst Netpoint of the gateway in the destination netzone
+ * @param link_list List of links
+ */
+ XBT_ATTRIB_DEPRECATED_v339("Please call add_route either from Host to Host or NetZone to NetZone") void add_route(
kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
- kernel::routing::NetPoint* gw_dst, const std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical);
+ kernel::routing::NetPoint* gw_dst, const std::vector<const Link*>& links);
+#endif
+
+ /**
+ * @brief Add a route between 2 hosts
+ *
+ * @param src Source host
+ * @param dst Destination host
+ * @param link_list List of links and their direction used in this communication
+ * @param symmetrical Bi-directional communication
+ */
+ void add_route(const Host* src, const Host* dst, const std::vector<LinkInRoute>& link_list, bool symmetrical = true);
+ /**
+ * @brief Add a route between 2 hosts
+ *
+ * @param src Source host
+ * @param dst Destination host
+ * @param links List of links. The UP direction will be used on src->dst and DOWN direction on dst->src
+ */
+ void add_route(const Host* src, const Host* dst, const std::vector<const Link*>& links);
+
void add_bypass_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
- std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical);
+ const std::vector<LinkInRoute>& link_list);
- /*** Called on each newly created regular route (not on bypass routes) */
- static xbt::signal<void(bool symmetrical, kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
- kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
- std::vector<kernel::resource::LinkImpl*> const& link_list)>
- on_route_creation;
+private:
+#ifndef DOXYGEN
static xbt::signal<void(NetZone const&)> on_creation;
static xbt::signal<void(NetZone const&)> on_seal;
+#endif
+
+public:
+ /** \static Add a callback fired on each newly created NetZone */
+ static void on_creation_cb(const std::function<void(NetZone const&)>& cb) { on_creation.connect(cb); }
+ /** \static Add a callback fired on each newly sealed NetZone */
+ static void on_seal_cb(const std::function<void(NetZone const&)>& cb) { on_seal.connect(cb); }
/**
* @brief Create a host
*
* @param name Host name
- * @param speed_per_state Vector of CPU's speeds
+ * @param speed_per_pstate Vector of CPU's speeds
*/
s4u::Host* create_host(const std::string& name, const std::vector<double>& speed_per_pstate);
s4u::Host* create_host(const std::string& name, double speed);
s4u::Link* create_link(const std::string& name, const std::vector<std::string>& bandwidths);
s4u::Link* create_link(const std::string& name, const std::string& bandwidth);
- kernel::resource::NetworkModelIntf* get_network_model() const;
+ /**
+ * @brief Create a split-duplex link
+ *
+ * In SimGrid, split-duplex links are a composition of 2 regular (shared) links (up/down).
+ *
+ * This function eases its utilization by creating the 2 links for you. We append a suffix
+ * "_UP" and "_DOWN" to your link name to identify each of them.
+ *
+ * Both up/down links have exactly the same bandwidth
+ *
+ * @param name Name of the link
+ * @param bandwidth Speed
+ */
+ s4u::SplitDuplexLink* create_split_duplex_link(const std::string& name, const std::string& bandwidth);
+ s4u::SplitDuplexLink* create_split_duplex_link(const std::string& name, double bandwidth);
+
+ kernel::resource::NetworkModel* get_network_model() const;
/**
* @brief Make a router within that NetZone
/** @brief Seal this netzone configuration */
NetZone* seal();
-private:
- /** @brief Auxiliary function to get list of LinkImpl */
- static std::vector<kernel::resource::LinkImpl*> get_link_list_impl(const std::vector<Link*>& link_list);
+ void
+ set_latency_factor_cb(std::function<double(double size, const s4u::Host* src, const s4u::Host* dst,
+ const std::vector<s4u::Link*>& /*links*/,
+ const std::unordered_set<s4u::NetZone*>& /*netzones*/)> const& cb) const;
+ void
+ set_bandwidth_factor_cb(std::function<double(double size, const s4u::Host* src, const s4u::Host* dst,
+ const std::vector<s4u::Link*>& /*links*/,
+ const std::unordered_set<s4u::NetZone*>& /*netzones*/)> const& cb) const;
};
// External constructors so that the types (and the types of their content) remain hidden
* @param id: Internal identifier of the element
* @return pair<NetPoint*, NetPoint*>: returns a pair of netpoint and gateway.
*/
+ // XBT_ATTRIB_DEPRECATED_v339
using ClusterNetPointCb = std::pair<kernel::routing::NetPoint*, kernel::routing::NetPoint*>(
- NetZone* zone, const std::vector<unsigned int>& coord, int id);
+ NetZone* zone, const std::vector<unsigned long>& coord, unsigned long id);
+
+ /**
+ * @brief Callback used to set the NetZone located at some leaf of clusters (Torus, FatTree, etc)
+ *
+ * @param zone: The parent zone, needed for creating new resources (hosts, links)
+ * @param coord: the coordinates of the element
+ * @param id: Internal identifier of the element
+ * @return NetZone*: returns newly created netzone
+ */
+ using ClusterNetZoneCb = NetZone*(NetZone* zone, const std::vector<unsigned long>& coord, unsigned long id);
+ /**
+ * @brief Callback used to set the Host located at some leaf of clusters (Torus, FatTree, etc)
+ *
+ * @param zone: The parent zone, needed for creating new resources (hosts, links)
+ * @param coord: the coordinates of the element
+ * @param id: Internal identifier of the element
+ * @return Host*: returns newly created host
+ */
+ using ClusterHostCb = Host*(NetZone* zone, const std::vector<unsigned long>& coord, unsigned long id);
+
/**
* @brief Callback used to set the links for some leaf of the cluster (Torus, FatTree, etc)
*
* @param id: Internal identifier of the element
* @return Pointer to the Link
*/
- using ClusterLinkCb = Link*(NetZone* zone, const std::vector<unsigned int>& coord, int id);
-
- std::function<ClusterNetPointCb> netpoint;
+ using ClusterLinkCb = Link*(NetZone* zone, const std::vector<unsigned long>& coord, unsigned long id);
+
+ bool by_netzone_ = false;
+ bool is_by_netzone() const { return by_netzone_; }
+ bool by_netpoint_ = false; // XBT_ATTRIB_DEPRECATED_v339
+ bool is_by_netpoint() const { return by_netpoint_; } // XBT_ATTRIB_DEPRECATED_v339
+ std::function<ClusterNetPointCb> netpoint; // XBT_ATTRIB_DEPRECATED_v339
+ std::function<ClusterHostCb> host;
+ std::function<ClusterNetZoneCb> netzone;
std::function<ClusterLinkCb> loopback = {};
std::function<ClusterLinkCb> limiter = {};
+ explicit ClusterCallbacks(const std::function<ClusterNetZoneCb>& set_netzone)
+ : by_netzone_(true), netzone(set_netzone){/* nothing to do */};
+
+ ClusterCallbacks(const std::function<ClusterNetZoneCb>& set_netzone,
+ const std::function<ClusterLinkCb>& set_loopback, const std::function<ClusterLinkCb>& set_limiter)
+ : by_netzone_(true), netzone(set_netzone), loopback(set_loopback), limiter(set_limiter){/* nothing to do */};
+
+ explicit ClusterCallbacks(const std::function<ClusterHostCb>& set_host)
+ : host(set_host) {/* nothing to do */};
+
+ ClusterCallbacks(const std::function<ClusterHostCb>& set_host,
+ const std::function<ClusterLinkCb>& set_loopback, const std::function<ClusterLinkCb>& set_limiter)
+ : host(set_host), loopback(set_loopback), limiter(set_limiter){/* nothing to do */};
+
+ XBT_ATTRIB_DEPRECATED_v339("Please use callback with either a Host/NetZone creation function as first parameter")
explicit ClusterCallbacks(const std::function<ClusterNetPointCb>& set_netpoint)
- : netpoint(set_netpoint){/*nothing to do */};
+ : by_netpoint_(true), netpoint(set_netpoint){/* nothing to do */};
+ XBT_ATTRIB_DEPRECATED_v339("Please use callback with either a Host/NetZone creation function as first parameter")
ClusterCallbacks(const std::function<ClusterNetPointCb>& set_netpoint,
const std::function<ClusterLinkCb>& set_loopback, const std::function<ClusterLinkCb>& set_limiter)
- : netpoint(set_netpoint), loopback(set_loopback), limiter(set_limiter){/*nothing to do */};
+ : by_netpoint_(true), netpoint(set_netpoint), loopback(set_loopback), limiter(set_limiter){/* nothing to do */};
};
/**
* @brief Create a torus zone
* @return Pointer to new netzone
*/
XBT_PUBLIC NetZone* create_torus_zone(const std::string& name, const NetZone* parent,
- const std::vector<unsigned int>& dimensions,
+ const std::vector<unsigned long>& dimensions,
const ClusterCallbacks& set_callbacks, double bandwidth, double latency,
Link::SharingPolicy sharing_policy);
/** @brief Aggregates the parameters necessary to build a Fat-tree zone */
-struct FatTreeParams {
+struct XBT_PUBLIC FatTreeParams {
unsigned int levels;
std::vector<unsigned int> down;
std::vector<unsigned int> up;
Link::SharingPolicy sharing_policy);
/** @brief Aggregates the parameters necessary to build a Dragonfly zone */
-struct DragonflyParams {
+struct XBT_PUBLIC DragonflyParams {
std::pair<unsigned int, unsigned int> groups;
std::pair<unsigned int, unsigned int> chassis;
std::pair<unsigned int, unsigned int> routers;
const DragonflyParams& parameters, const ClusterCallbacks& set_callbacks,
double bandwidth, double latency, Link::SharingPolicy sharing_policy);
-} // namespace s4u
-} // namespace simgrid
+} // namespace simgrid::s4u
#endif /* SIMGRID_S4U_NETZONE_HPP */
