/** Retrieve the property value (or nullptr if not set) */
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(
// 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_dragonfly_zone(const std::string& name);
XBT_PUBLIC NetZone* create_empty_zone(const std::string& name);
-XBT_PUBLIC NetZone* create_fatTree_zone(const std::string& name);
XBT_PUBLIC NetZone* create_floyd_zone(const std::string& name);
-/**
- * @brief Callback used to set the netpoint and gateway located at some leaf of the torus
- *
- * 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 Torus zone, needed for creating new resources (hosts, links)
- * @param coord: the coordinates of the element in the torus, eg. 0,1,1
- * @param id: Internal identifier of the element
- * @return pair<NetPoint*, NetPoint*>: returns a pair of netpoint and gateway.
- */
-typedef std::pair<kernel::routing::NetPoint*, kernel::routing::NetPoint*>
-TorusNetPointCb(NetZone* zone, const std::vector<unsigned int>& coord, int id);
-/**
- * @brief Callback used to set the links for some leaf of the torus
- *
- * @param zone: The newly create Torus zone, needed for creating new resources (hosts, links)
- * @param coord: the coordinates of the element in the torus, eg. 0,1,1
- * @param id: Internal identifier of the element
- * @return Pointer to the Link
- */
-typedef Link* TorusLinkCb(NetZone* zone, const std::vector<unsigned int>& coord, int id);
+XBT_PUBLIC NetZone* create_vivaldi_zone(const std::string& name);
+XBT_PUBLIC NetZone* create_wifi_zone(const std::string& name);
+
+// 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 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);
+
+ std::function<ClusterNetPointCb> netpoint;
+ std::function<ClusterLinkCb> loopback = {};
+ std::function<ClusterLinkCb> limiter = {};
+ explicit ClusterCallbacks(std::function<ClusterNetPointCb> set_netpoint) : netpoint(set_netpoint){/*nothing to do */};
+ ClusterCallbacks(std::function<ClusterNetPointCb> set_netpoint, std::function<ClusterLinkCb> set_loopback,
+ std::function<ClusterLinkCb> set_limiter)
+ : netpoint(set_netpoint), loopback(set_loopback), limiter(set_limiter){/*nothing to do */};
+};
/**
* @brief Create a torus zone
*
* elements
* - inter-node communication: (bandwidth, latency, sharing_policy) the elements are connected through regular links
* with these characteristics
+ * More details in: <a href="https://simgrid.org/doc/latest/Platform_examples.html?highlight=torus#torus-cluster">Torus
+ * Cluster</a>
*
* Moreover, this method accepts 3 callbacks to populate the cluster: set_netpoint, set_loopback and set_limiter .
*
- * Note that the all elements in Torus cluster must have (or not) the same elements (loopback and limiter)
+ * Note that the all elements in a Torus cluster must have (or not) the same elements (loopback and limiter)
*
* @param name NetZone's name
- * @param parent Pointer to parent's netzone (nullptr if rootnetzone). Needed to be able to create the resources inside
+ * @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
*/
-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<TorusNetPointCb>& set_netpoint,
- const std::function<TorusLinkCb>& set_loopback = {},
- const std::function<TorusLinkCb>& set_limiter = {});
-XBT_PUBLIC NetZone* create_vivaldi_zone(const std::string& name);
-XBT_PUBLIC NetZone* create_wifi_zone(const std::string& name);
+XBT_PUBLIC NetZone* create_torus_zone(const std::string& name, const NetZone* parent,
+ const std::vector<unsigned int>& 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 {
+ 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);
+};
+/**
+ * @brief Create a Fat-Tree zone
+ *
+ * Fat-Tree clusters are characterized by:
+ * - levels: number of levels in the cluster, e.g. 2 (the final tree will have n+1 levels)
+ * - downlinks: for each level, how many connections between elements below them, e.g. 2, 3: level 1 nodes are connected
+ * to 2 nodes in level 2, which are connected to 3 nodes below. Determines the number total of leaves in the tree.
+ * - uplinks: for each level, how nodes are connected, e.g. 1, 2
+ * - link count: for each level, number of links connecting the nodes, e.g. 1, 1
+ *
+ * The best way to understand it is looking to the doc available in: <a
+ * href="https://simgrid.org/doc/latest/Platform_examples.html#fat-tree-cluster">Fat Tree Cluster</a>
+ *
+ * Moreover, this method accepts 3 callbacks to populate the cluster: set_netpoint, set_loopback and set_limiter .
+ *
+ * Note that the all elements in a Fat-Tree cluster must have (or not) the same elements (loopback and limiter)
+ *
+ * @param name NetZone's name
+ * @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
+ * @return Pointer to new netzone
+ */
+XBT_PUBLIC NetZone* create_fatTree_zone(const std::string& name, const NetZone* parent, const FatTreeParams& parameters,
+ const ClusterCallbacks& set_callbacks, double bandwidth, double latency,
+ Link::SharingPolicy sharing_policy);
+
+/** @brief Aggregates the parameters necessary to build a Dragonfly zone */
+struct DragonflyParams {
+ std::pair<unsigned int, unsigned int> groups;
+ std::pair<unsigned int, unsigned int> chassis;
+ std::pair<unsigned int, unsigned int> routers;
+ unsigned int nodes;
+ DragonflyParams(const std::pair<unsigned int, unsigned int>& groups,
+ const std::pair<unsigned int, unsigned int>& chassis,
+ const std::pair<unsigned int, unsigned int>& routers, unsigned int nodes);
+};
+/**
+ * @brief Create a Dragonfly zone
+ *
+ * Dragonfly clusters are characterized by:
+ * - groups: number of groups and links between each group, e.g. 2,2.
+ * - chassis: number of chassis in each group and the number of links used to connect the chassis, e.g. 2,3
+ * - routers: number of routers in each chassis and their links, e.g. 3,1
+ * - nodes: number of nodes connected to each router using a single link, e.g. 2
+ *
+ * In total, the cluster will have groups * chassis * routers * nodes elements/leaves.
+ *
+ * The best way to understand it is looking to the doc available in: <a
+ * href="https://simgrid.org/doc/latest/Platform_examples.html#dragonfly-cluster">Dragonfly Cluster</a>
+ *
+ * Moreover, this method accepts 3 callbacks to populate the cluster: set_netpoint, set_loopback and set_limiter .
+ *
+ * Note that the all elements in a Dragonfly cluster must have (or not) the same elements (loopback and limiter)
+ *
+ * @param name NetZone's name
+ * @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
+ * @return Pointer to new netzone
+ */
+XBT_PUBLIC NetZone* create_dragonfly_zone(const std::string& name, const NetZone* parent,
+ const DragonflyParams& parameters, const ClusterCallbacks& set_callbacks,
+ double bandwidth, double latency, Link::SharingPolicy sharing_policy);
} // namespace s4u
} // namespace simgrid
