-/* 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. */
#include <map>
#include <string>
#include <unordered_map>
+#include <unordered_set>
#include <utility>
#include <vector>
* 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_; }
/** @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);
-
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 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
*/
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);
+ kernel::routing::NetPoint* gw_dst, const std::vector<LinkInRoute>& 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* 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);
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 void on_creation_cb(const std::function<void(NetZone const&)>& cb) { on_creation.connect(cb); }
+ 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);
+ /**
+ * @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
XBT_PUBLIC NetZone* create_full_zone(const std::string& name);
-XBT_PUBLIC NetZone* create_cluster_zone(const std::string& name);
XBT_PUBLIC NetZone* create_star_zone(const std::string& name);
XBT_PUBLIC NetZone* create_dijkstra_zone(const std::string& name, bool cache);
XBT_PUBLIC NetZone* create_empty_zone(const std::string& name);
XBT_PUBLIC NetZone* create_floyd_zone(const std::string& name);
XBT_PUBLIC NetZone* create_vivaldi_zone(const std::string& name);
XBT_PUBLIC NetZone* create_wifi_zone(const std::string& name);
-/**
- * @brief Callback used to set the netpoint and gateway located at some leaf of clusters (Torus, FatTree, etc)
- *
- * The netpoint can be either a host, router or another netzone.
- * Gateway must be non-null if netpoint is a netzone
- *
- * @param zone: The newly create zone, needed for creating new resources (hosts, links)
- * @param coord: the coordinates of the element
- * @param id: Internal identifier of the element
- * @return pair<NetPoint*, NetPoint*>: returns a pair of netpoint and gateway.
- */
-using ClusterNetPointCb = std::pair<kernel::routing::NetPoint*, kernel::routing::NetPoint*>(
- NetZone* zone, const std::vector<unsigned int>& coord, int id);
-/**
- * @brief Callback used to set the links for some leaf of the cluster (Torus, FatTree, etc)
- *
- * @param zone: The newly create zone, needed for creating new resources (hosts, links)
- * @param coord: the coordinates of the element
- * @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);
+
+// Extra data structure for complex constructors
+
+/** @brief Aggregates the callbacks used to build clusters netzones (Torus/Dragronfly/Fat-Tree) */
+struct ClusterCallbacks {
+ /**
+ * @brief Callback used to set the netpoint and gateway located at some leaf of clusters (Torus, FatTree, etc)
+ *
+ * The netpoint can be either a host, router or another netzone.
+ * Gateway must be non-null if netpoint is a netzone
+ *
+ * @param zone: The newly create zone, needed for creating new resources (hosts, links)
+ * @param coord: the coordinates of the element
+ * @param id: Internal identifier of the element
+ * @return pair<NetPoint*, NetPoint*>: returns a pair of netpoint and gateway.
+ */
+ using ClusterNetPointCb = std::pair<kernel::routing::NetPoint*, kernel::routing::NetPoint*>(
+ 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)
+ *
+ * The coord parameter depends on the cluster being created:
+ * - Torus: Direct translation of the Torus' dimensions, e.g. (0, 0, 0) for a 3-D Torus
+ * - Fat-Tree: A pair (level in the tree, id), e.g. (0, 0): first leaf and (1,0): first switch at level 1.
+ * - Dragonfly: a tuple (group, chassis, blades/routers, nodes), e.g. (0, 0, 0, 0) for first node in the cluster.
+ * Important: To identify the router inside a "group, chassis, blade", we use MAX_UINT in the last parameter (e.g. 0,
+ * 0, 0, 4294967295).
+ *
+ * @param zone: The newly create zone, needed for creating new resources (hosts, links)
+ * @param coord: the coordinates of the element
+ * @param id: Internal identifier of the element
+ * @return Pointer to the Link
+ */
+ using ClusterLinkCb = Link*(NetZone* zone, const std::vector<unsigned long>& coord, unsigned long id);
+
+ std::function<ClusterNetPointCb> netpoint;
+ std::function<ClusterLinkCb> loopback = {};
+ std::function<ClusterLinkCb> limiter = {};
+ explicit ClusterCallbacks(const std::function<ClusterNetPointCb>& set_netpoint)
+ : netpoint(set_netpoint){/*nothing to do */};
+ 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 */};
+};
/**
* @brief Create a torus zone
*
* @param parent Pointer to parent's netzone (nullptr if root netzone). Needed to be able to create the resources inside
* the netzone
* @param dimensions List of positive integers (> 0) which determines the torus' dimensions
+ * @param set_callbacks Callbacks to set properties from cluster elements (netpoint, loopback and limiter)
* @param bandwidth Characteristics of the inter-nodes link
* @param latency Characteristics of the inter-nodes link
* @param sharing_policy Characteristics of the inter-nodes link
- * @param set_netpoint Callback to set the netpoint of an element in the torus
- * @param set_loopback Callback to set the loopback
- * @param set_limiter Callback to set the limiter
* @return Pointer to new netzone
*/
XBT_PUBLIC NetZone* create_torus_zone(const std::string& name, const NetZone* parent,
- const std::vector<unsigned int>& dimensions, double bandwidth, double latency,
- Link::SharingPolicy sharing_policy,
- const std::function<ClusterNetPointCb>& set_netpoint,
- const std::function<ClusterLinkCb>& set_loopback = {},
- const std::function<ClusterLinkCb>& set_limiter = {});
+ 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;
std::vector<unsigned int> number;
FatTreeParams(unsigned int n_levels, const std::vector<unsigned int>& down_links,
- const std::vector<unsigned int>& up_links, const std::vector<unsigned int>& links_number)
- : levels(n_levels), down(down_links), up(up_links), number(links_number)
- { /* nothing to do */
- }
+ const std::vector<unsigned int>& up_links, const std::vector<unsigned int>& links_number);
};
/**
* @brief Create a Fat-Tree zone
* @param parent Pointer to parent's netzone (nullptr if root netzone). Needed to be able to create the resources inside
* the netzone
* @param parameters Characteristics of this Fat-Tree
+ * @param set_callbacks Callbacks to set properties from cluster elements (netpoint, loopback and limiter)
* @param bandwidth Characteristics of the inter-nodes link
* @param latency Characteristics of the inter-nodes link
* @param sharing_policy Characteristics of the inter-nodes link
- * @param set_netpoint Callback to set the netpoint of an element in the torus
- * @param set_loopback Callback to set the loopback
- * @param set_limiter Callback to set the limiter
* @return Pointer to new netzone
*/
XBT_PUBLIC NetZone* create_fatTree_zone(const std::string& name, const NetZone* parent, const FatTreeParams& parameters,
- double bandwidth, double latency, Link::SharingPolicy sharing_policy,
- const std::function<ClusterNetPointCb>& set_netpoint,
- const std::function<ClusterLinkCb>& set_loopback = {},
- const std::function<ClusterLinkCb>& set_limiter = {});
+ const ClusterCallbacks& set_callbacks, double bandwidth, double latency,
+ 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;
* @param parent Pointer to parent's netzone (nullptr if root netzone). Needed to be able to create the resources inside
* the netzone
* @param parameters Characteristics of this Dragonfly
+ * @param set_callbacks Callbacks to set properties from cluster elements (netpoint, loopback and limiter)
* @param bandwidth Characteristics of the inter-nodes link
* @param latency Characteristics of the inter-nodes link
* @param sharing_policy Characteristics of the inter-nodes link
- * @param set_netpoint Callback to set the netpoint of an element in the torus
- * @param set_loopback Callback to set the loopback
- * @param set_limiter Callback to set the limiter
* @return Pointer to new netzone
*/
XBT_PUBLIC NetZone* create_dragonfly_zone(const std::string& name, const NetZone* parent,
- const DragonflyParams& parameters, double bandwidth, double latency,
- Link::SharingPolicy sharing_policy,
- const std::function<ClusterNetPointCb>& set_netpoint,
- const std::function<ClusterLinkCb>& set_loopback = {},
- const std::function<ClusterLinkCb>& set_limiter = {});
+ const DragonflyParams& parameters, const ClusterCallbacks& set_callbacks,
+ double bandwidth, double latency, Link::SharingPolicy sharing_policy);
} // namespace s4u
} // namespace simgrid
