Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Split-Duplex: new management
[simgrid.git] / src / surf / LinkImpl.hpp
diff --git a/src/surf/LinkImpl.hpp b/src/surf/LinkImpl.hpp
new file mode 100644 (file)
index 0000000..5883775
--- /dev/null
@@ -0,0 +1,81 @@
+/* Copyright (c) 2004-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. */
+
+#ifndef SIMGRID_KERNEL_RESOURCE_LINKIMPL_HPP
+#define SIMGRID_KERNEL_RESOURCE_LINKIMPL_HPP
+
+#include "src/surf/LinkImplIntf.hpp"
+
+/***********
+ * Classes *
+ ***********/
+
+namespace simgrid {
+namespace kernel {
+namespace resource {
+/************
+ * Resource *
+ ************/
+/** @ingroup SURF_network_interface
+ * @brief SURF network link interface class
+ * @details A Link represents the link between two [hosts](@ref simgrid::surf::HostImpl)
+ */
+class LinkImpl : public LinkImplIntf {
+  s4u::Link piface_;
+  s4u::Link::SharingPolicy sharing_policy_ = s4u::Link::SharingPolicy::SHARED;
+
+protected:
+  explicit LinkImpl(const std::string& name);
+  LinkImpl(const LinkImpl&) = delete;
+  LinkImpl& operator=(const LinkImpl&) = delete;
+  ~LinkImpl() override                 = default; // Use destroy() instead of this destructor.
+
+public:
+  void destroy(); // Must be called instead of the destructor
+
+  void latency_check(double latency) const;
+
+  /** @brief Public interface */
+  const s4u::Link* get_iface() const { return &piface_; }
+  s4u::Link* get_iface() { return &piface_; }
+
+  /** @brief Get the bandwidth in bytes per second of current Link */
+  double get_bandwidth() const override { return bandwidth_.peak * bandwidth_.scale; }
+
+  /** @brief Get the latency in seconds of current Link */
+  double get_latency() const override { return latency_.peak * latency_.scale; }
+
+  /** @brief The sharing policy */
+  virtual void set_sharing_policy(s4u::Link::SharingPolicy policy) override;
+  virtual s4u::Link::SharingPolicy get_sharing_policy() const override;
+
+  /** @brief Check if the Link is used */
+  bool is_used() const override;
+
+  void turn_on() override;
+  void turn_off() override;
+
+  void seal() override;
+
+  void on_bandwidth_change() const;
+
+  /* setup the profile file with bandwidth events (peak speed changes due to external load).
+   * Profile must contain percentages (value between 0 and 1). */
+  virtual void set_bandwidth_profile(kernel::profile::Profile* profile) override;
+  /* setup the profile file with latency events (peak latency changes due to external load).
+   * Profile must contain absolute values */
+  virtual void set_latency_profile(kernel::profile::Profile* profile) override;
+
+  void set_concurrency_limit(int limit) const override;
+
+  Metric latency_   = {0.0, 1, nullptr};
+  Metric bandwidth_ = {1.0, 1, nullptr};
+};
+
+} // namespace resource
+} // namespace kernel
+} // namespace simgrid
+
+#endif /* SIMGRID_KERNEL_RESOURCE_LINKIMPL_HPP */