X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/38ffc837c5692a4d52e7610a67453a5335434bbd..fcb729916269f63a4c9d031d5be35aff3774e769:/include/simgrid/s4u/NetZone.hpp diff --git a/include/simgrid/s4u/NetZone.hpp b/include/simgrid/s4u/NetZone.hpp index 085788eb38..691e9896fc 100644 --- a/include/simgrid/s4u/NetZone.hpp +++ b/include/simgrid/s4u/NetZone.hpp @@ -27,11 +27,13 @@ namespace s4u { * 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: @@ -40,9 +42,9 @@ 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 get_children() const; std::vector get_all_hosts() const; int get_host_count() const; @@ -57,9 +59,11 @@ public: /** @brief Get the netpoint associated to this netzone */ kernel::routing::NetPoint* get_netpoint(); - std::vector 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>* nodes, std::map>* edges); @@ -76,26 +80,44 @@ public: * * @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_list, bool symmetrical = true); + kernel::routing::NetPoint* gw_dst, const std::vector& 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& 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, + std::vector& 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& 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& link_list, bool symmetrical); + const std::vector& link_list); +#ifndef DOXYGEN /*** Called on each newly created regular route (not on bypass routes) */ static xbt::signal const& link_list)> - on_route_creation; + on_route_creation; // XBT_ATTRIB_DEPRECATED_v332 : should not be used by users, used by ns3.. if necessary, + // signal shouldn't use LinkImpl* +#endif + static xbt::signal on_creation; static xbt::signal on_seal; @@ -103,7 +125,7 @@ public: * @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& speed_per_pstate); s4u::Host* create_host(const std::string& name, double speed); @@ -129,6 +151,24 @@ public: s4u::Link* create_link(const std::string& name, const std::vector& 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 * @@ -140,8 +180,10 @@ public: NetZone* seal(); private: - /** @brief Auxiliary function to get list of LinkImpl */ - static std::vector get_link_list_impl(const std::vector link_list); +#ifndef DOXYGEN + /** @brief XBT_ATTRIB_DEPRECATED_v332 Auxiliary function to convert types */ + static std::vector convert_to_linkInRoute(const std::vector& link_list); +#endif }; // External constructors so that the types (and the types of their content) remain hidden @@ -173,6 +215,13 @@ struct ClusterCallbacks { /** * @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 @@ -183,9 +232,10 @@ struct ClusterCallbacks { std::function netpoint; std::function loopback = {}; std::function limiter = {}; - explicit ClusterCallbacks(std::function set_netpoint) : netpoint(set_netpoint){/*nothing to do */}; - ClusterCallbacks(std::function set_netpoint, std::function set_loopback, - std::function set_limiter) + explicit ClusterCallbacks(const std::function& set_netpoint) + : netpoint(set_netpoint){/*nothing to do */}; + ClusterCallbacks(const std::function& set_netpoint, + const std::function& set_loopback, const std::function& set_limiter) : netpoint(set_netpoint), loopback(set_loopback), limiter(set_limiter){/*nothing to do */}; }; /**