-/* Copyright (c) 2016-2018. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2016-2021. 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. */
#define SIMGRID_S4U_NETZONE_HPP
#include <simgrid/forward.h>
+#include <simgrid/s4u/Link.hpp>
+#include <xbt/graph.h>
#include <xbt/signal.hpp>
+#include <map>
#include <string>
#include <unordered_map>
#include <utility>
* s4u::Engine).
*/
class XBT_PUBLIC NetZone {
+ kernel::routing::NetZoneImpl* const pimpl_;
+
protected:
- friend simgrid::kernel::routing::NetZoneImpl;
+ friend kernel::routing::NetZoneImpl;
- explicit NetZone(NetZone * father, std::string name);
- virtual ~NetZone();
+ explicit NetZone(kernel::routing::NetZoneImpl* impl) : pimpl_(impl) {}
public:
- /** @brief Seal your netzone once you're done adding content, and before routing stuff through it */
- virtual void seal();
/** @brief Retrieves the name of that netzone as a C++ string */
- const std::string& get_name() const { return name_; }
+ const std::string& get_name() const;
/** @brief Retrieves the name of that netzone as a C string */
const char* get_cname() const;
- NetZone* get_father();
- std::vector<NetZone*>* getChildren(); // Sub netzones
- void getHosts(std::vector<s4u::Host*> * whereto); // retrieve my content as a vector of hosts
- int getHostCount();
+ XBT_ATTRIB_DEPRECATED_v331("Please use get_parent()") NetZone* get_father();
+ NetZone* get_parent() const;
+ NetZone* set_parent(const NetZone* parent);
+
+ std::vector<Host*> get_all_hosts() const;
+ int get_host_count() const;
- /** Get the properties assigned to a host */
- std::unordered_map<std::string, std::string>* getProperties();
+ kernel::routing::NetZoneImpl* get_impl() const { return pimpl_; }
+ /** Get the properties assigned to a netzone */
+ const std::unordered_map<std::string, std::string>* get_properties() const;
/** Retrieve the property value (or nullptr if not set) */
- const char* getProperty(const char* key);
- void setProperty(const char* key, const char* value);
+ const char* get_property(const std::string& key) const;
+ void set_property(const std::string& key, const std::string& value);
+
+ std::vector<NetZone*> get_children() const;
+ NetZone* add_child(const 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. */
- virtual int addComponent(kernel::routing::NetPoint * elm); /* A host, a router or a netzone, whatever */
- virtual void add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
+ int add_component(kernel::routing::NetPoint* elm); /* A host, a router or a netzone, whatever */
+
+ /**
+ * @brief Add a route between 2 netpoints
+ *
+ * Create a regular route between 2 netpoints. A netpoint can be a host
+ * or a router.
+ *
+ * @param src Source netpoint
+ * @param dst Destination netpoint
+ * @param link_list List of links used in this communication
+ * @param symmetrical Bi-directional communication
+ */
+ void add_regular_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
+ const std::vector<Link*>& link_list, bool symmetrical = true);
+ /**
+ * @brief Add a route between 2 netzones
+ *
+ * Create a route between 2 netzones, connecting 2 gateways.
+ *
+ * @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 symmetrical Bi-directional communication
+ */
+ void add_netzone_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);
- virtual 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) = 0;
+ const std::vector<Link*>& link_list, bool symmetrical = true);
+
+ 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);
/*** Called on each newly created regular route (not on bypass routes) */
- static simgrid::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*>& link_list)>
+ 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;
- static simgrid::xbt::signal<void(NetZone&)> on_creation;
- static simgrid::xbt::signal<void(NetZone&)> on_seal;
-
- // Deprecation wrappers
- XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_father()") NetZone* getFather() { return get_father(); }
- XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_name()") const std::string& getName() const { return get_name(); }
- XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_cname()") const char* getCname() const { return get_cname(); }
- XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_route()") void addRoute(
- kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
- kernel::routing::NetPoint* gw_dst, std::vector<simgrid::kernel::resource::LinkImpl*>& link_list, bool symmetrical)
- {
- add_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
- }
- XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_bypass_route()") void addBypassRoute(
- kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
- kernel::routing::NetPoint* gw_dst, std::vector<simgrid::kernel::resource::LinkImpl*>& link_list, bool symmetrical)
- {
- add_bypass_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
- }
-
-protected:
- unsigned int getTableSize() { return vertices_.size(); }
- std::vector<kernel::routing::NetPoint*> getVertices() { return vertices_; }
+ static xbt::signal<void(NetZone const&)> on_creation;
+ static xbt::signal<void(NetZone const&)> on_seal;
+
+ /**
+ * @brief Create a host
+ *
+ * @param name Host name
+ * @param speed_per_state Vector of CPU's speeds
+ */
+ s4u::Host* create_host(const std::string& name, const std::vector<double>& speed_per_pstate);
+ /**
+ * @brief Create a Host (string version)
+ *
+ * @throw std::invalid_argument if speed format is incorrect.
+ */
+ s4u::Host* create_host(const std::string& name, const std::vector<std::string>& speed_per_pstate);
+
+ /**
+ * @brief Create a link
+ *
+ * @param name Link name
+ * @param bandwidths Link's speed (vector for wifi links)
+ * @param policy Link sharing policy
+ * @throw std::invalid_argument if bandwidth format is incorrect.
+ */
+ s4u::Link* create_link(const std::string& name, const std::vector<double>& bandwidths,
+ Link::SharingPolicy policy = Link::SharingPolicy::SHARED);
+
+ /** @brief Create a link (string version) */
+ s4u::Link* create_link(const std::string& name, const std::vector<std::string>& bandwidths,
+ Link::SharingPolicy policy = Link::SharingPolicy::SHARED);
+
+ /**
+ * @brief Seal this netzone configuration
+ */
+ void seal();
private:
- // our content, as known to our graph routing algorithm (maps vertexId -> vertex)
- std::vector<kernel::routing::NetPoint*> vertices_;
-
- std::unordered_map<std::string, std::string> properties_;
- NetZone* father_ = nullptr;
- std::string name_;
-
- bool sealed_ = false; // We cannot add more content when sealed
-
- std::vector<NetZone*>* children_ = nullptr; // sub-netzones
+ /** @brief Auxiliary function to get list of LinkImpl */
+ static std::vector<kernel::resource::LinkImpl*> get_link_list_impl(const std::vector<Link*> link_list);
};
-}
-}; // Namespace simgrid::s4u
+
+// 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_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);
+XBT_PUBLIC NetZone* create_torus_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);
+
+} // namespace s4u
+} // namespace simgrid
#endif /* SIMGRID_S4U_NETZONE_HPP */