src/kernel/resource/NetworkModelFactors.cpp

   1 /* Copyright (c) 2013-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 #include "src/kernel/resource/NetworkModelFactors.hpp"
   7 #include "simgrid/sg_config.hpp"
   8 #include "src/kernel/resource/FactorSet.hpp"
   9
  10 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(res_network);
  11
  12 /*********
  13  * Model *
  14  *********/
  15
  16 namespace simgrid::kernel::resource {
  17 static FactorSet cfg_latency_factor("network/latency-factor");
  18 static FactorSet cfg_bandwidth_factor("network/bandwidth-factor");
  19
  20 config::Flag<std::string> cfg_latency_factor_str(
  21     "network/latency-factor", std::initializer_list<const char*>{"smpi/lat-factor"},
  22     "Correction factor to apply to the provided latency (default value overridden by network model)", "1.0");
  23 static config::Flag<std::string> cfg_bandwidth_factor_str(
  24     "network/bandwidth-factor", std::initializer_list<const char*>{"smpi/bw-factor"},
  25     "Correction factor to apply to the provided bandwidth (default value overridden by network model)", "1.0");
  26
  27 double NetworkModelFactors::get_bandwidth_factor() const
  28 {
  29   xbt_assert(not bw_factor_cb_,
  30              "Cannot access the global bandwidth factor since a callback is used. Please go for the advanced API.");
  31
  32   if (not cfg_bandwidth_factor.is_initialized())
  33     cfg_bandwidth_factor.parse(cfg_bandwidth_factor_str.get());
  34
  35   return cfg_bandwidth_factor(0);
  36 }
  37
  38 double NetworkModelFactors::get_latency_factor() const
  39 {
  40   xbt_assert(not lat_factor_cb_,
  41              "Cannot access the global latency factor since a callback is used. Please go for the advanced API.");
  42
  43   if (not cfg_latency_factor.is_initialized()) // lazy initiaization to avoid initialization fiasco
  44     cfg_latency_factor.parse(cfg_latency_factor_str.get());
  45
  46   return cfg_latency_factor(0);
  47 }
  48
  49 double NetworkModelFactors::get_latency_factor(double size, const s4u::Host* src, const s4u::Host* dst,
  50                                                const std::vector<s4u::Link*>& links,
  51                                                const std::unordered_set<s4u::NetZone*>& netzones) const
  52 {
  53   if (lat_factor_cb_)
  54     return lat_factor_cb_(size, src, dst, links, netzones);
  55
  56   if (not cfg_latency_factor.is_initialized()) // lazy initiaization to avoid initialization fiasco
  57     cfg_latency_factor.parse(cfg_latency_factor_str.get());
  58
  59   return cfg_latency_factor(size);
  60 }
  61
  62 double NetworkModelFactors::get_bandwidth_factor(double size, const s4u::Host* src, const s4u::Host* dst,
  63                                                  const std::vector<s4u::Link*>& links,
  64                                                  const std::unordered_set<s4u::NetZone*>& netzones) const
  65 {
  66   if (bw_factor_cb_)
  67     return bw_factor_cb_(size, src, dst, links, netzones);
  68
  69   if (not cfg_bandwidth_factor.is_initialized())
  70     cfg_bandwidth_factor.parse(cfg_bandwidth_factor_str.get());
  71
  72   return cfg_bandwidth_factor(size);
  73 }
  74
  75 void NetworkModelFactors::set_lat_factor_cb(const std::function<NetworkFactorCb>& cb)
  76 {
  77   if (not cb)
  78     throw std::invalid_argument("NetworkModelFactors: Invalid callback");
  79   if (not simgrid::config::is_default("network/latency-factor"))
  80     throw std::invalid_argument("You must choose between network/latency-factor and callback configuration.");
  81
  82   lat_factor_cb_ = cb;
  83 }
  84
  85 void NetworkModelFactors::set_bw_factor_cb(const std::function<NetworkFactorCb>& cb)
  86 {
  87   if (not cb)
  88     throw std::invalid_argument("NetworkModelFactors: Invalid callback");
  89   if (not simgrid::config::is_default("network/bandwidth-factor"))
  90     throw std::invalid_argument("You must choose between network/bandwidth-factor and callback configuration.");
  91
  92   bw_factor_cb_ = cb;
  93 }
  94
  95 } // namespace simgrid::kernel::resource