src/kernel/resource/NetworkModelFactors.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_NETWORKMODELFACTORS_HPP
   7 #define SIMGRID_KERNEL_RESOURCE_NETWORKMODELFACTORS_HPP
   8
   9 #include "simgrid/sg_config.hpp"
  10 #include "xbt/asserts.h"
  11 #include <simgrid/forward.h>
  12
  13 #include <unordered_set>
  14 #include <vector>
  15
  16 namespace simgrid::kernel::resource {
  17
  18 /** This Trait of NetworkModel is in charge of handling the network factors (bw and lat) */
  19
  20 class XBT_PUBLIC NetworkModelFactors {
  21   using NetworkFactorCb = double(double size, const s4u::Host* src, const s4u::Host* dst,
  22                                  const std::vector<s4u::Link*>& links,
  23                                  const std::unordered_set<s4u::NetZone*>& netzones);
  24
  25   std::function<NetworkFactorCb> lat_factor_cb_;
  26   std::function<NetworkFactorCb> bw_factor_cb_;
  27
  28 public:
  29   /**
  30    * @brief Get the right multiplicative factor for the latency.
  31    * @details Depending on the model, the effective latency when sending a message might be different from the
  32    * theoretical latency of the link, in function of the message size. In order to account for this, this function gets
  33    * this factor.
  34    */
  35   double get_latency_factor(double size, const s4u::Host* src, const s4u::Host* dst,
  36                             const std::vector<s4u::Link*>& links, const std::unordered_set<s4u::NetZone*>& netzones);
  37
  38   /** Get the right multiplicative factor for the bandwidth (only if no callback was defined) */
  39   double get_latency_factor();
  40
  41   /**
  42    * @brief Get the right multiplicative factor for the bandwidth.
  43    *
  44    * @details Depending on the model, the effective bandwidth when sending a message might be different from the
  45    * theoretical bandwidth of the link, in function of the message size. In order to account for this, this function
  46    * gets this factor.
  47    */
  48   double get_bandwidth_factor(double size, const s4u::Host* src, const s4u::Host* dst,
  49                               const std::vector<s4u::Link*>& links, const std::unordered_set<s4u::NetZone*>& netzones);
  50
  51   /** Get the right multiplicative factor for the bandwidth (only if no callback was defined) */
  52   double get_bandwidth_factor();
  53
  54   /**
  55    * @brief Callback to set the bandwidth and latency factors used in a communication
  56    *
  57    * This callback offers more flexibility when setting the network factors.
  58    * It is an alternative to SimGrid's configs, such as network/latency-factors
  59    * and network/bandwidth-factors.
  60    *
  61    * @param size Communication size in bytes
  62    * @param src Source host
  63    * @param dst Destination host
  64    * @param links Vectors with the links used in this comm
  65    * @param netzones Set with NetZones involved in the comm
  66    * @return Multiply factor
  67    */
  68   /** @brief Configure the latency factor callback */
  69   void set_lat_factor_cb(const std::function<NetworkFactorCb>& cb);
  70
  71   /** @brief Configure the bandwidth factor callback */
  72   void set_bw_factor_cb(const std::function<NetworkFactorCb>& cb);
  73
  74   /** Returns whether a callback was set for latency-factor OR bandwidth-factor */
  75   bool has_network_factor_cb() { return lat_factor_cb_ || bw_factor_cb_; }
  76 };
  77
  78 } // namespace simgrid::kernel::resource
  79
  80 #endif /* SIMGRID_KERNEL_RESOURCE_NETWORKMODELFACTORS_HPP */