src/kernel/resource/NetworkModel.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_NETWORKMODEL_HPP
   7 #define SIMGRID_KERNEL_RESOURCE_NETWORKMODEL_HPP
   8
   9 #include "simgrid/kernel/resource/Model.hpp"
  10 #include "simgrid/kernel/resource/NetworkModelIntf.hpp"
  11 #include "src/kernel/resource/StandardLinkImpl.hpp"
  12
  13 #include <list>
  14
  15 namespace simgrid::kernel::resource {
  16
  17 /*********
  18  * Model *
  19  *********/
  20
  21 /** @ingroup SURF_network_interface
  22  * @brief SURF network model interface class
  23  * @details A model is an object which handles the interactions between its Resources and its Actions
  24  */
  25 class NetworkModel : public Model, public NetworkModelIntf {
  26 public:
  27   static config::Flag<double> cfg_tcp_gamma;
  28   static config::Flag<bool> cfg_crosstraffic;
  29
  30   using Model::Model;
  31   NetworkModel(const NetworkModel&) = delete;
  32   NetworkModel& operator=(const NetworkModel&) = delete;
  33   ~NetworkModel() override;
  34
  35   /**
  36    * @brief Create a [WiFi]Link
  37    *
  38    * @param name The name of the Link
  39    * @param bandwidths The vector of bandwidths of the Link in bytes per second
  40    */
  41   virtual StandardLinkImpl* create_link(const std::string& name, const std::vector<double>& bandwidths) = 0;
  42
  43   virtual StandardLinkImpl* create_wifi_link(const std::string& name, const std::vector<double>& bandwidths) = 0;
  44
  45   /**
  46    * @brief Create a communication between two hosts.
  47    * @details It makes calls to the routing part, and execute the communication between the two end points.
  48    *
  49    * @param src The source of the communication
  50    * @param dst The destination of the communication
  51    * @param size The size of the communication in bytes
  52    * @param rate Allows to limit the transfer rate. Negative value means unlimited.
  53    * @return The action representing the communication
  54    */
  55   virtual Action* communicate(s4u::Host* src, s4u::Host* dst, double size, double rate) = 0;
  56
  57   /**
  58    * @brief Get the right multiplicative factor for the latency.
  59    * @details Depending on the model, the effective latency when sending a message might be different from the
  60    * theoretical latency of the link, in function of the message size. In order to account for this, this function gets
  61    * this factor.
  62    *
  63    * @param size The size of the message.
  64    * @return The latency factor.
  65    */
  66   virtual double get_latency_factor(double /* size */) { return sg_latency_factor; }
  67
  68   /**
  69    * @brief Get the right multiplicative factor for the bandwidth.
  70    * @details Depending on the model, the effective bandwidth when sending a message might be different from the
  71    * theoretical bandwidth of the link, in function of the message size. In order to account for this, this function
  72    * gets this factor.
  73    *
  74    * @param size The size of the message.
  75    * @return The bandwidth factor.
  76    */
  77   virtual double get_bandwidth_factor(double /* size*/) { return sg_bandwidth_factor; }
  78
  79   double next_occurring_event_full(double now) override;
  80
  81   void set_lat_factor_cb(const std::function<NetworkFactorCb>& cb) override { THROW_UNIMPLEMENTED; }
  82   void set_bw_factor_cb(const std::function<NetworkFactorCb>& cb) override { THROW_UNIMPLEMENTED; }
  83
  84   std::unique_ptr<StandardLinkImpl, StandardLinkImpl::Deleter> loopback_;
  85 };
  86
  87 /**********
  88  * Action *
  89  **********/
  90 /** @ingroup SURF_network_interface
  91  * @brief SURF network action interface class
  92  * @details A NetworkAction represents a communication between two [hosts](@ref HostImpl)
  93  */
  94 class NetworkAction : public Action {
  95   s4u::Host& src_;
  96   s4u::Host& dst_;
  97
  98 public:
  99   /** @brief Constructor
 100    *
 101    * @param model The NetworkModel associated to this NetworkAction
 102    * @param cost The cost of this  NetworkAction in [TODO]
 103    * @param failed [description]
 104    */
 105   NetworkAction(Model* model, s4u::Host& src, s4u::Host& dst, double cost, bool failed)
 106       : Action(model, cost, failed), src_(src), dst_(dst)
 107   {
 108   }
 109
 110   /**
 111    * @brief NetworkAction constructor
 112    *
 113    * @param model The NetworkModel associated to this NetworkAction
 114    * @param cost The cost of this  NetworkAction in bytes
 115    * @param failed Actions can be created in a failed state
 116    * @param var The lmm variable associated to this Action if it is part of a LMM component
 117    */
 118   NetworkAction(Model* model, s4u::Host& src, s4u::Host& dst, double cost, bool failed, lmm::Variable* var)
 119       : Action(model, cost, failed, var), src_(src), dst_(dst){};
 120
 121   void set_state(Action::State state) override;
 122   virtual std::list<StandardLinkImpl*> get_links() const;
 123
 124   double latency_         = 0.; // Delay before the action starts
 125   double lat_current_     = 0.; // Used to compute the communication RTT, and accordingly limit the communication rate
 126   double sharing_penalty_ = {};
 127
 128   s4u::Host& get_src() const { return src_; }
 129   s4u::Host& get_dst() const { return dst_; }
 130 };
 131
 132 /* Insert link(s) at the end of vector `result' (at the beginning, and reversed, for insert_link_latency()), and add
 133  * link->get_latency() to *latency when latency is not null
 134  */
 135 void add_link_latency(std::vector<StandardLinkImpl*>& result, StandardLinkImpl* link, double* latency);
 136 void add_link_latency(std::vector<StandardLinkImpl*>& result, const std::vector<StandardLinkImpl*>& links,
 137                       double* latency);
 138 void insert_link_latency(std::vector<StandardLinkImpl*>& result, const std::vector<StandardLinkImpl*>& links,
 139                          double* latency);
 140
 141 } // namespace simgrid::kernel::resource
 142
 143 #endif /* SIMGRID_KERNEL_RESOURCE_NETWORKMODEL_HPP */