-/* Copyright (c) 2016-2021. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2016-2022. 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. */
* 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;
/** @brief Get the netpoint associated to this netzone */
kernel::routing::NetPoint* get_netpoint();
- std::vector<NetZone*> get_children() const;
+#ifndef DOXYGEN
+ XBT_ATTRIB_DEPRECATED_v331("Please use get_parent()") NetZone* get_father() const;
XBT_ATTRIB_DEPRECATED_v332("Please use set_parent() to manage NetZone's relationship") NetZone* add_child(
NetZone* new_zone);
+#endif
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);
+
+#ifndef DOXYGEN
+ XBT_ATTRIB_DEPRECATED_v332(
+ "Please use add_route() method which uses s4u::LinkInRoute 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::StandardLinkImpl*>& link_list, bool symmetrical);
+
+ XBT_ATTRIB_DEPRECATED_v332(
+ "Please use add_bypass_route() method which uses s4u::LinkInRoute instead of "
+ "LinkImpl") void add_bypass_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
+ kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
+ const std::vector<kernel::resource::StandardLinkImpl*>& link_list,
+ bool /*symmetrical*/);
+#endif
- 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);
+#ifndef DOXYGEN
/*** 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;
+ std::vector<kernel::resource::StandardLinkImpl*> const& link_list)>
+ on_route_creation; // XBT_ATTRIB_DEPRECATED_v332 : should not be used by users, used by ns3.. if necessary,
+ // signal shouldn't use LinkImpl*
+
+private:
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::NetworkModelIntf* get_network_model() const;
+
/**
* @brief Make a router within that NetZone
*
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);
+#ifndef DOXYGEN
+ /** @brief XBT_ATTRIB_DEPRECATED_v332 Auxiliary function to convert types */
+ static std::vector<LinkInRoute>
+ convert_to_linkInRoute(const std::vector<kernel::resource::StandardLinkImpl*>& link_list);
+#endif
};
// External constructors so that the types (and the types of their content) remain hidden
* @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);
+ 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);
+ using ClusterLinkCb = Link*(NetZone* zone, const std::vector<unsigned long>& coord, unsigned long id);
std::function<ClusterNetPointCb> netpoint;
std::function<ClusterLinkCb> loopback = {};
* @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;