src/surf/network_interface.hpp

   1 /* Copyright (c) 2004-2021. 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 SURF_NETWORK_INTERFACE_HPP_
   7 #define SURF_NETWORK_INTERFACE_HPP_
   8
   9 #include "simgrid/kernel/resource/Model.hpp"
  10 #include "simgrid/kernel/resource/NetworkModelIntf.hpp"
  11 #include "simgrid/kernel/resource/Resource.hpp"
  12 #include "simgrid/s4u/Link.hpp"
  13 #include "src/kernel/lmm/maxmin.hpp"
  14 #include <xbt/PropertyHolder.hpp>
  15
  16 #include <list>
  17 #include <unordered_map>
  18
  19 /***********
  20  * Classes *
  21  ***********/
  22
  23 namespace simgrid {
  24 namespace kernel {
  25 namespace resource {
  26 /*********
  27  * Model *
  28  *********/
  29
  30 /** @ingroup SURF_network_interface
  31  * @brief SURF network model interface class
  32  * @details A model is an object which handles the interactions between its Resources and its Actions
  33  */
  34 class NetworkModel : public Model, public NetworkModelIntf {
  35 public:
  36   static config::Flag<double> cfg_tcp_gamma;
  37   static config::Flag<bool> cfg_crosstraffic;
  38
  39   using Model::Model;
  40   NetworkModel(const NetworkModel&) = delete;
  41   NetworkModel& operator=(const NetworkModel&) = delete;
  42   ~NetworkModel() override;
  43
  44   /**
  45    * @brief Create a [WiFi]Link
  46    *
  47    * @param name The name of the Link
  48    * @param bandwidths The vector of bandwidths of the Link in bytes per second
  49    */
  50   virtual LinkImpl* create_link(const std::string& name, const std::vector<double>& bandwidths) = 0;
  51
  52   virtual LinkImpl* create_wifi_link(const std::string& name, const std::vector<double>& bandwidths) = 0;
  53
  54   /**
  55    * @brief Create a communication between two hosts.
  56    * @details It makes calls to the routing part, and execute the communication between the two end points.
  57    *
  58    * @param src The source of the communication
  59    * @param dst The destination of the communication
  60    * @param size The size of the communication in bytes
  61    * @param rate Allows to limit the transfer rate. Negative value means unlimited.
  62    * @return The action representing the communication
  63    */
  64   virtual Action* communicate(s4u::Host* src, s4u::Host* dst, double size, double rate) = 0;
  65
  66   /**
  67    * @brief Get the right multiplicative factor for the latency.
  68    * @details Depending on the model, the effective latency when sending a message might be different from the
  69    * theoretical latency of the link, in function of the message size. In order to account for this, this function gets
  70    * this factor.
  71    *
  72    * @param size The size of the message.
  73    * @return The latency factor.
  74    */
  75   virtual double get_latency_factor(double /* size */) { return sg_latency_factor; }
  76
  77   /**
  78    * @brief Get the right multiplicative factor for the bandwidth.
  79    * @details Depending on the model, the effective bandwidth when sending a message might be different from the
  80    * theoretical bandwidth of the link, in function of the message size. In order to account for this, this function
  81    * gets this factor.
  82    *
  83    * @param size The size of the message.
  84    * @return The bandwidth factor.
  85    */
  86   virtual double get_bandwidth_factor(double /* size*/) { return sg_bandwidth_factor; }
  87
  88   /**
  89    * @brief Get definitive bandwidth.
  90    * @details It gives the minimum bandwidth between the one that would occur if no limitation was enforced, and the
  91    * one arbitrary limited.
  92    * @param rate The desired maximum bandwidth.
  93    * @param bound The bandwidth with only the network taken into account.
  94    * @param size The size of the message.
  95    * @return The new bandwidth.
  96    */
  97   virtual double get_bandwidth_constraint(double rate, double /*bound*/, double /*size*/) { return rate; }
  98
  99   double next_occurring_event_full(double now) override;
 100
 101   virtual void set_lat_factor_cb(const std::function<NetworkFactorCb>& cb) override { THROW_UNIMPLEMENTED; }
 102   virtual void set_bw_factor_cb(const std::function<NetworkFactorCb>& cb) override { THROW_UNIMPLEMENTED; }
 103
 104   LinkImpl* loopback_ = nullptr;
 105 };
 106
 107 /************
 108  * Resource *
 109  ************/
 110 /** @ingroup SURF_network_interface
 111  * @brief SURF network link interface class
 112  * @details A Link represents the link between two [hosts](@ref simgrid::surf::HostImpl)
 113  */
 114 class LinkImpl : public Resource_T<LinkImpl>, public xbt::PropertyHolder {
 115   s4u::Link piface_;
 116
 117 protected:
 118   explicit LinkImpl(const std::string& name);
 119   LinkImpl(const LinkImpl&) = delete;
 120   LinkImpl& operator=(const LinkImpl&) = delete;
 121   ~LinkImpl() override                 = default; // Use destroy() instead of this destructor.
 122
 123 public:
 124   void destroy(); // Must be called instead of the destructor
 125
 126   void latency_check(double latency) const;
 127
 128   /** @brief Public interface */
 129   const s4u::Link* get_iface() const { return &piface_; }
 130   s4u::Link* get_iface() { return &piface_; }
 131
 132   /** @brief Get the bandwidth in bytes per second of current Link */
 133   double get_bandwidth() const { return bandwidth_.peak * bandwidth_.scale; }
 134   /** @brief Update the bandwidth in bytes per second of current Link */
 135   virtual void set_bandwidth(double value) = 0;
 136
 137   /** @brief Get the latency in seconds of current Link */
 138   double get_latency() const { return latency_.peak * latency_.scale; }
 139   /** @brief Update the latency in seconds of current Link */
 140   virtual LinkImpl* set_latency(double value) = 0;
 141
 142   /** @brief The sharing policy */
 143   virtual LinkImpl* set_sharing_policy(s4u::Link::SharingPolicy policy);
 144   virtual s4u::Link::SharingPolicy get_sharing_policy() const;
 145
 146   /** @brief Check if the Link is used */
 147   bool is_used() const override;
 148
 149   void turn_on() override;
 150   void turn_off() override;
 151
 152   void seal() override;
 153
 154   void on_bandwidth_change() const;
 155
 156   /* setup the profile file with bandwidth events (peak speed changes due to external load).
 157    * Profile must contain percentages (value between 0 and 1). */
 158   virtual LinkImpl* set_bandwidth_profile(kernel::profile::Profile* profile);
 159   /* setup the profile file with latency events (peak latency changes due to external load).
 160    * Profile must contain absolute values */
 161   virtual LinkImpl* set_latency_profile(kernel::profile::Profile* profile);
 162
 163   Metric latency_   = {0.0, 0, nullptr};
 164   Metric bandwidth_ = {1.0, 0, nullptr};
 165 };
 166
 167 /**********
 168  * Action *
 169  **********/
 170 /** @ingroup SURF_network_interface
 171  * @brief SURF network action interface class
 172  * @details A NetworkAction represents a communication between two [hosts](@ref simgrid::surf::HostImpl)
 173  */
 174 class NetworkAction : public Action {
 175   s4u::Host& src_;
 176   s4u::Host& dst_;
 177
 178 public:
 179   /** @brief Constructor
 180    *
 181    * @param model The NetworkModel associated to this NetworkAction
 182    * @param cost The cost of this  NetworkAction in [TODO]
 183    * @param failed [description]
 184    */
 185   NetworkAction(Model* model, s4u::Host& src, s4u::Host& dst, double cost, bool failed)
 186       : Action(model, cost, failed), src_(src), dst_(dst)
 187   {
 188   }
 189
 190   /**
 191    * @brief NetworkAction constructor
 192    *
 193    * @param model The NetworkModel associated to this NetworkAction
 194    * @param cost The cost of this  NetworkAction in bytes
 195    * @param failed Actions can be created in a failed state
 196    * @param var The lmm variable associated to this Action if it is part of a LMM component
 197    */
 198   NetworkAction(Model* model, s4u::Host& src, s4u::Host& dst, double cost, bool failed, lmm::Variable* var)
 199       : Action(model, cost, failed, var), src_(src), dst_(dst){};
 200
 201   void set_state(Action::State state) override;
 202   virtual std::list<LinkImpl*> get_links() const;
 203
 204   double latency_         = 0.; // Delay before the action starts
 205   double lat_current_     = 0.; // Used to compute the communication RTT, and accordingly limit the communication rate
 206   double sharing_penalty_ = {};
 207
 208   s4u::Host& get_src() const { return src_; }
 209   s4u::Host& get_dst() const { return dst_; }
 210 };
 211 } // namespace resource
 212 } // namespace kernel
 213 } // namespace simgrid
 214
 215 #endif /* SURF_NETWORK_INTERFACE_HPP_ */