X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/08e7455d67920bbd7a87f440d00f2c1e071314a0..fcb729916269f63a4c9d031d5be35aff3774e769:/include/simgrid/s4u/Link.hpp

diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp
index ae4335a337..bcd91afbac 100644
--- a/include/simgrid/s4u/Link.hpp
+++ b/include/simgrid/s4u/Link.hpp
@@ -25,23 +25,26 @@ extern template class XBT_PUBLIC xbt::Extendable<s4u::Link>;
 
 namespace s4u {
 /**
- * @rst
+ * @beginrst
  * A Link represents the network facilities between :cpp:class:`hosts <simgrid::s4u::Host>`.
  * @endrst
  */
 class XBT_PUBLIC Link : public xbt::Extendable<Link> {
+#ifndef DOXYGEN
   friend kernel::resource::LinkImpl;
+#endif
 
+protected:
   // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
-  explicit Link(kernel::resource::LinkImpl* pimpl) : pimpl_(pimpl) {}
+  explicit Link(kernel::resource::LinkImplIntf* pimpl) : pimpl_(pimpl) {}
   virtual ~Link() = default;
-  // The private implementation, that never changes
-  kernel::resource::LinkImpl* const pimpl_;
+  // The implementation that never changes
+  kernel::resource::LinkImplIntf* const pimpl_;
 
 public:
-  enum class SharingPolicy { WIFI = 3, SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
+  enum class SharingPolicy { NONLINEAR = 4, WIFI = 3, SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
 
-  kernel::resource::LinkImpl* get_impl() const { return pimpl_; }
+  kernel::resource::LinkImpl* get_impl() const;
 
   /** @brief Retrieve a link from its name */
   static Link* by_name(const std::string& name);
@@ -52,19 +55,57 @@ public:
   /** @brief Retrieves the name of that link as a C string */
   const char* get_cname() const;
 
-  /** Get the bandwidth of the current Link (in bytes per second) */
+  /** Get/Set the bandwidth of the current Link (in bytes per second) */
   double get_bandwidth() const;
-  /** Set the bandwidth of the current Link (in bytes per second) */
-  void set_bandwidth(double value);
+  Link* set_bandwidth(double value);
 
-  /** Get the latency of the current Link (in seconds) */
+  /** Get/Set the latency of the current Link (in seconds) */
   double get_latency() const;
-  /** Set the latency of the current Link (in seconds) */
-  void set_latency(double value);
+  /**
+   * @brief Set link's latency
+   *
+   * @param value New latency value (in s)
+   */
+  Link* set_latency(double value);
+  /**
+   * @brief Set latency (string version)
+   *
+   * Accepts values with units, such as '1s' or '7ms'.
+   *
+   * Full list of accepted units: w (week), d (day), h, s, ms, us, ns, ps.
+   *
+   * @throw std::invalid_argument if latency format is incorrect.
+   */
+  Link* set_latency(const std::string& value);
 
   /** @brief Describes how the link is shared between flows */
+  Link* set_sharing_policy(SharingPolicy policy, const NonLinearResourceCb& cb = {});
   SharingPolicy get_sharing_policy() const;
 
+  /** Setup the profile with states events (ON or OFF). The profile must contain boolean values. */
+  Link* set_state_profile(kernel::profile::Profile* profile);
+  /** Setup the profile with bandwidth events (peak speed changes due to external load).
+   * The profile must contain percentages (value between 0 and 1). */
+  Link* set_bandwidth_profile(kernel::profile::Profile* profile);
+  /** Setup the profile file with latency events (peak latency changes due to external load).
+   * The profile must contain absolute values */
+  Link* set_latency_profile(kernel::profile::Profile* profile);
+
+  const std::unordered_map<std::string, std::string>* get_properties() const;
+  const char* get_property(const std::string& key) const;
+  Link* set_properties(const std::unordered_map<std::string, std::string>& properties);
+  Link* set_property(const std::string& key, const std::string& value);
+
+  /**
+   * @brief Set the number of communications that can shared this link at the same time
+   *
+   * Use this method to serialize communication flows going through this link.
+   * Use -1 to set no limit.
+   *
+   * @param limit  Number of concurrent flows
+   */
+  Link* set_concurrency_limit(int limit);
+
   /** @brief Set the level of communication speed of the given host on this wifi link.
    *
    * The bandwidth of a wifi link for a given host depends on its SNR (signal to noise ratio),
@@ -84,21 +125,14 @@ public:
   /** @brief Check if the Link is used (at least one flow uses the link) */
   bool is_used() const;
 
+  /** @brief Check if the Link is shared (not a FATPIPE) */
+  bool is_shared() const;
+
   void turn_on();
-  bool is_on() const;
   void turn_off();
+  bool is_on() const;
 
-  /** Setup the profile with states events (ON or OFF). The profile must contain boolean values. */
-  void set_state_profile(kernel::profile::Profile* profile);
-  /** Setup the profile with bandwidth events (peak speed changes due to external load).
-   * The profile must contain percentages (value between 0 and 1). */
-  void set_bandwidth_profile(kernel::profile::Profile* profile);
-  /** Setup the profile file with latency events (peak latency changes due to external load).
-   * The profile must contain absolute values */
-  void set_latency_profile(kernel::profile::Profile* profile);
-
-  const char* get_property(const std::string& key) const;
-  void set_property(const std::string& key, const std::string& value);
+  Link* seal();
 
   /* The signals */
   /** @brief Callback signal fired when a new Link is created */
@@ -120,6 +154,54 @@ public:
   static xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>
       on_communication_state_change;
 };
+
+/**
+ * @beginrst
+ * A SplitDuplexLink encapsulates the :cpp:class:`links <simgrid::s4u::Link>` which
+ * compose a Split-Duplex link. Remember that a Split-Duplex link is nothing more than
+ * a pair of up/down links.
+ * @endrst
+ */
+class XBT_PUBLIC SplitDuplexLink : public Link {
+public:
+  explicit SplitDuplexLink(kernel::resource::LinkImplIntf* pimpl) : Link(pimpl) {}
+  /** @brief Get the link direction up*/
+  Link* get_link_up() const;
+  /** @brief Get the link direction down */
+  Link* get_link_down() const;
+
+  /** @brief Retrieve a link from its name */
+  static SplitDuplexLink* by_name(const std::string& name);
+};
+
+/**
+ * @beginrst
+ * Another encapsulation for using links in the :cpp:func:`NetZone::add_route`
+ *
+ * When adding a route with split-duplex links, you need to specify the direction of the link
+ * so SimGrid can know exactly which physical link to insert in the route.
+ *
+ * For shared/fat-pipe links, use the :cpp:enumerator:`Direction::NONE` since they don't have
+ * the concept of UP/DOWN links.
+ * @endrst
+ */
+class XBT_PUBLIC LinkInRoute {
+public:
+  enum class Direction { UP = 2, DOWN = 1, NONE = 0 };
+
+  explicit LinkInRoute(const Link* link) : link_(link) {}
+  LinkInRoute(const Link* link, Direction d) : link_(link), direction_(d) {}
+
+  /** @brief Get direction of this link in the route: UP or DOWN */
+  Direction get_direction() const { return direction_; }
+  /** @brief Get pointer to the link */
+  const Link* get_link() const { return link_; }
+
+private:
+  const Link* link_;
+  Direction direction_ = Direction::NONE;
+};
+
 } // namespace s4u
 } // namespace simgrid