src/kernel/resource/StandardLinkImpl.hpp

   1 /* Copyright (c) 2004-2022. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_KERNEL_RESOURCE_STANDARDLINKIMPL_HPP
   7 #define SIMGRID_KERNEL_RESOURCE_STANDARDLINKIMPL_HPP
   8
   9 #include "src/kernel/resource/LinkImpl.hpp"
  10
  11 /***********
  12  * Classes *
  13  ***********/
  14
  15 namespace simgrid {
  16 namespace kernel {
  17 namespace resource {
  18 /************
  19  * Resource *
  20  ************/
  21 class StandardLinkImpl : public LinkImpl {
  22   s4u::Link piface_;
  23   s4u::Link::SharingPolicy sharing_policy_ = s4u::Link::SharingPolicy::SHARED;
  24   routing::NetZoneImpl* englobing_zone_    = nullptr;
  25
  26 protected:
  27   explicit StandardLinkImpl(const std::string& name);
  28   StandardLinkImpl(const StandardLinkImpl&) = delete;
  29   StandardLinkImpl& operator=(const StandardLinkImpl&) = delete;
  30   ~StandardLinkImpl() override                         = default; // Use destroy() instead of this destructor.
  31
  32   Metric latency_   = {0.0, 1, nullptr};
  33   Metric bandwidth_ = {1.0, 1, nullptr};
  34
  35 public:
  36   void destroy(); // Must be called instead of the destructor
  37
  38   void latency_check(double latency) const;
  39
  40   /** @brief Public interface */
  41   const s4u::Link* get_iface() const { return &piface_; }
  42   s4u::Link* get_iface() { return &piface_; }
  43
  44   /** @brief Get the bandwidth in bytes per second of current Link */
  45   double get_bandwidth() const override { return bandwidth_.peak * bandwidth_.scale; }
  46
  47   /** @brief Get the latency in seconds of current Link */
  48   double get_latency() const override { return latency_.peak * latency_.scale; }
  49
  50   routing::NetZoneImpl* get_englobing_zone() const { return englobing_zone_; }
  51   /** @brief Set the NetZone in which this Link is included */
  52   StandardLinkImpl* set_englobing_zone(routing::NetZoneImpl* netzone_p);
  53
  54   /** @brief The sharing policy */
  55   void set_sharing_policy(s4u::Link::SharingPolicy policy, const s4u::NonLinearResourceCb& cb) override;
  56   s4u::Link::SharingPolicy get_sharing_policy() const override { return sharing_policy_; }
  57
  58   void turn_on() override;
  59   void turn_off() override;
  60
  61   void seal() override;
  62
  63   void on_bandwidth_change() const;
  64
  65   /* setup the profile file with bandwidth events (peak speed changes due to external load).
  66    * Profile must contain percentages (value between 0 and 1). */
  67   void set_bandwidth_profile(kernel::profile::Profile* profile) override;
  68   /* setup the profile file with latency events (peak latency changes due to external load).
  69    * Profile must contain absolute values */
  70   void set_latency_profile(kernel::profile::Profile* profile) override;
  71
  72   void set_concurrency_limit(int limit) const override;
  73 };
  74
  75 } // namespace resource
  76 } // namespace kernel
  77 } // namespace simgrid
  78
  79 #endif /* SIMGRID_KERNEL_RESOURCE_STANDARDLINKIMPL_HPP */