X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f23b0fb864cb60978c1fcfd48d50f62dd054fe31..1d66ac4c2a43e3df812bd855d3c385b23127a57d:/include/simgrid/s4u/NetZone.hpp

diff --git a/include/simgrid/s4u/NetZone.hpp b/include/simgrid/s4u/NetZone.hpp
index e4d56e0f77..045a08948f 100644
--- a/include/simgrid/s4u/NetZone.hpp
+++ b/include/simgrid/s4u/NetZone.hpp
@@ -1,4 +1,4 @@
-/* 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. */
@@ -7,8 +7,11 @@
 #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>
@@ -24,11 +27,12 @@ namespace s4u {
  * s4u::Engine).
  */
 class XBT_PUBLIC NetZone {
+  kernel::routing::NetZoneImpl* const pimpl_;
+
 protected:
-  friend simgrid::kernel::routing::NetZoneImpl;
+  friend kernel::routing::NetZoneImpl;
 
-  explicit NetZone(kernel::routing::NetZoneImpl* impl);
-  ~NetZone();
+  explicit NetZone(kernel::routing::NetZoneImpl* impl) : pimpl_(impl) {}
 
 public:
   /** @brief Retrieves the name of that netzone as a C++ string */
@@ -36,89 +40,122 @@ public:
   /** @brief Retrieves the name of that netzone as a C string */
   const char* get_cname() const;
 
-  NetZone* get_father();
-
-  std::vector<Host*> get_all_hosts();
-  int get_host_count();
+  XBT_ATTRIB_DEPRECATED_v331("Please use get_parent()") NetZone* get_father();
+  NetZone* get_parent() const;
+  NetZone* set_parent(const NetZone* parent);
 
-  kernel::routing::NetZoneImpl* get_impl() { return pimpl_; }
+  std::vector<Host*> get_all_hosts() const;
+  int get_host_count() const;
 
-private:
-  kernel::routing::NetZoneImpl* pimpl_;
-  std::unordered_map<std::string, std::string> properties_;
+  kernel::routing::NetZoneImpl* get_impl() const { return pimpl_; }
 
-public:
   /** Get the properties assigned to a netzone */
-  std::unordered_map<std::string, std::string>* get_properties();
+  const std::unordered_map<std::string, std::string>* get_properties() const;
+  /** 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);
 
-  std::vector<NetZone*> get_children();
+  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);
 
-  /** Retrieve the property value (or nullptr if not set) */
-  const char* get_property(const char* key);
-  void set_property(const char* key, const char* value);
+  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 */
+
+  /**
+   * @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,
+                         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, std::vector<kernel::resource::LinkImpl*>& link_list,
+                 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);
-  }
-  XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_properties()") std::unordered_map<std::string, std::string>* getProperties()
-  {
-    return get_properties();
-  }
-  XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_property()") const char* getProperty(const char* key)
-  {
-    return get_property(key);
-  }
-  XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::set_property()") void setProperty(const char* key, const char* value)
-  {
-    set_property(key, value);
-  }
-  XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::add_component()") int addComponent(kernel::routing::NetPoint* elm)
-  {
-    return add_component(elm);
-  }
-  XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_vertices()") std::vector<kernel::routing::NetPoint*> getVertices();
-  XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_host_count()") int getHostCount() { return get_host_count(); }
-  XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_all_hosts()") void getHosts(
-      std::vector<s4u::Host*>* whereto); // retrieve my content as a vector of hosts
-  XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_children()") std::vector<NetZone*>* getChildren()
-  {
-    std::vector<NetZone*>* res = new std::vector<NetZone*>();
-    for (auto child : get_children())
-      res->push_back(child);
-    return res;
-  }
+  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)
+   * @throw std::invalid_argument if bandwidth format is incorrect.
+   */
+  s4u::Link* create_link(const std::string& name, const std::vector<double>& bandwidths);
+
+  /** @brief Create a link (string version) */
+  s4u::Link* create_link(const std::string& name, const std::vector<std::string>& bandwidths);
+
+  /** @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);
 };
-}
-}; // 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 */