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