cosmetics

[simgrid.git] / src / surf / network_interface.hpp

diff --git a/src/surf/network_interface.hpp b/src/surf/network_interface.hpp
index 9cb6cc7..256ff5d 100644 (file)
--- a/src/surf/network_interface.hpp
+++ b/src/surf/network_interface.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2020. The SimGrid Team. All rights reserved.          */
+/* 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. */
@@ -35,21 +35,20 @@ public:
   static config::Flag<double> cfg_tcp_gamma;
   static config::Flag<bool> cfg_crosstraffic;
 
-  explicit NetworkModel(Model::UpdateAlgo algo) : Model(algo) {}
+  using Model::Model;
   NetworkModel(const NetworkModel&) = delete;
   NetworkModel& operator=(const NetworkModel&) = delete;
   ~NetworkModel() override;
 
   /**
-   * @brief Create a Link
+   * @brief Create a [WiFi]Link
    *
    * @param name The name of the Link
-   * @param bandwidth The initial bandwidth of the Link in bytes per second
-   * @param latency The initial latency of the Link in seconds
-   * @param policy The sharing policy of the Link
+   * @param bandwidths The vector of bandwidths of the Link in bytes per second
    */
-  virtual LinkImpl* create_link(const std::string& name, const std::vector<double>& bandwidths, double latency,
-                                s4u::Link::SharingPolicy policy) = 0;
+  virtual LinkImpl* create_link(const std::string& name, const std::vector<double>& bandwidths) = 0;
+
+  virtual LinkImpl* create_wifi_link(const std::string& name, const std::vector<double>& bandwidths) = 0;
 
   /**
    * @brief Create a communication between two hosts.
@@ -107,53 +106,56 @@ public:
  * @brief SURF network link interface class
  * @details A Link represents the link between two [hosts](@ref simgrid::surf::HostImpl)
  */
-class LinkImpl : public Resource, public xbt::PropertyHolder {
-  bool currently_destroying_ = false;
+class LinkImpl : public Resource_T<LinkImpl>, public xbt::PropertyHolder {
   s4u::Link piface_;
 
 protected:
-  LinkImpl(NetworkModel* model, const std::string& name, lmm::Constraint* constraint);
+  explicit LinkImpl(const std::string& name);
   LinkImpl(const LinkImpl&) = delete;
   LinkImpl& operator=(const LinkImpl&) = delete;
-  ~LinkImpl() override;
+  ~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 */
-  virtual double get_bandwidth();
+  double get_bandwidth() const;
 
   /** @brief Update the bandwidth in bytes per second of current Link */
   virtual void set_bandwidth(double value) = 0;
 
   /** @brief Get the latency in seconds of current Link */
-  virtual double get_latency();
+  double get_latency() const;
 
   /** @brief Update the latency in seconds of current Link */
-  virtual void set_latency(double value) = 0;
+  virtual LinkImpl* set_latency(double value) = 0;
 
   /** @brief The sharing policy */
-  virtual s4u::Link::SharingPolicy get_sharing_policy();
+  virtual LinkImpl* set_sharing_policy(s4u::Link::SharingPolicy policy);
+  virtual s4u::Link::SharingPolicy get_sharing_policy() const;
 
   /** @brief Check if the Link is used */
-  bool is_used() override;
+  bool is_used() const override;
 
   void turn_on() override;
   void turn_off() override;
 
+  void seal() override;
+
   void on_bandwidth_change() const;
 
-  virtual void
-  set_bandwidth_profile(kernel::profile::Profile* profile); /*< setup the profile file with bandwidth events
-                                                   (peak speed changes due to external load). Trace must
-                                                   contain percentages (value between 0 and 1). */
-  virtual void
-  set_latency_profile(kernel::profile::Profile* profile); /*< setup the trace file with latency events (peak
-                                                 latency changes due to external load).   Trace must contain
-                                                 absolute values */
+  /* setup the profile file with bandwidth events (peak speed changes due to external load).
+   * Profile must contain percentages (value between 0 and 1). */
+  virtual LinkImpl* set_bandwidth_profile(kernel::profile::Profile* profile);
+  /* setup the profile file with latency events (peak latency changes due to external load).
+   * Profile must contain absolute values */
+  virtual LinkImpl* set_latency_profile(kernel::profile::Profile* profile);
 
   Metric latency_                   = {0.0, 0, nullptr};
   Metric bandwidth_                 = {1.0, 0, nullptr};
@@ -196,10 +198,10 @@ public:
   void set_state(Action::State state) override;
   virtual std::list<LinkImpl*> get_links() const;
 
-  double latency_    = {};
-  double lat_current_ = {};
+  double latency_         = 0.; // Delay before the action starts
+  double lat_current_     = 0.; // Used to compute the communication RTT, and accordingly limit the communication rate
   double sharing_penalty_ = {};
-  double rate_       = {};
+
   s4u::Host& get_src() const { return src_; }
   s4u::Host& get_dst() const { return dst_; }
 };
@@ -207,11 +209,6 @@ public:
 } // namespace kernel
 } // namespace simgrid
 
-/** @ingroup SURF_models
- *  @brief The network model
- */
-XBT_PUBLIC_DATA simgrid::kernel::resource::NetworkModel* surf_network_model;
-
 #endif /* SURF_NETWORK_INTERFACE_HPP_ */