src/kernel/resource/models/network_constant.cpp

   1 /* Copyright (c) 2013-2023. 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 <simgrid/kernel/routing/NetZoneImpl.hpp>
   7 #include <simgrid/s4u/Engine.hpp>
   8
   9 #include "src/kernel/EngineImpl.hpp"
  10 #include "src/kernel/resource/models/network_constant.hpp"
  11
  12 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(res_network);
  13
  14 /*********
  15  * Model *
  16  *********/
  17 SIMGRID_REGISTER_NETWORK_MODEL(
  18     Constant,
  19     "Simplistic network model where all communication take a constant time (one second). This model "
  20     "provides the lowest realism, but is (marginally) faster. It is mostly useful when studying theoretical "
  21     "distributed algorithms where the network is usually abstracted away.",
  22     []() {
  23       auto net_model = std::make_shared<simgrid::kernel::resource::NetworkConstantModel>("Network_Constant");
  24       auto* engine   = simgrid::kernel::EngineImpl::get_instance();
  25       engine->add_model(net_model);
  26       engine->get_netzone_root()->set_network_model(net_model);
  27     });
  28
  29 namespace simgrid::kernel::resource {
  30
  31 StandardLinkImpl* NetworkConstantModel::create_link(const std::string& name, const std::vector<double>& /*bandwidth*/)
  32 {
  33   xbt_die("Refusing to create the link %s: there is no link in the Constant network model. "
  34           "Please remove any link from your platform (and switch to routing='None')",
  35           name.c_str());
  36   return nullptr;
  37 }
  38
  39 StandardLinkImpl* NetworkConstantModel::create_wifi_link(const std::string& name, const std::vector<double>& bandwidths)
  40 {
  41   return create_link(name, bandwidths);
  42 }
  43
  44 double NetworkConstantModel::next_occurring_event(double /*now*/)
  45 {
  46   double min = -1.0;
  47   for (Action const& action : *get_started_action_set()) {
  48     const auto& net_action = static_cast<const NetworkConstantAction&>(action);
  49     if (net_action.latency_ > 0 && (min < 0 || net_action.latency_ < min))
  50       min = net_action.latency_;
  51   }
  52   return min;
  53 }
  54
  55 void NetworkConstantModel::update_actions_state(double /*now*/, double delta)
  56 {
  57   for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
  58     auto& action = static_cast<NetworkConstantAction&>(*it);
  59     ++it; // increment iterator here since the following calls to action.finish() may invalidate it
  60     if (action.latency_ > 0) {
  61       if (action.latency_ > delta) {
  62         double_update(&action.latency_, delta, sg_precision_timing);
  63       } else {
  64         action.latency_ = 0.0;
  65       }
  66     }
  67     action.update_remains(action.get_cost() * delta / get_latency_factor());
  68     action.update_max_duration(delta);
  69
  70     if ((action.get_remains_no_update() <= 0) ||
  71         ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
  72       action.finish(Action::State::FINISHED);
  73     }
  74   }
  75 }
  76
  77 Action* NetworkConstantModel::communicate(s4u::Host* src, s4u::Host* dst, double size, double /*rate*/,
  78                                           bool /*streamed*/)
  79 {
  80   return (new NetworkConstantAction(this, *src, *dst, size));
  81 }
  82
  83 /**********
  84  * Action *
  85  **********/
  86 NetworkConstantAction::NetworkConstantAction(NetworkConstantModel* model_, s4u::Host& src, s4u::Host& dst, double size)
  87     : NetworkAction(model_, src, dst, size, false)
  88 {
  89   latency_ = model_->get_latency_factor();
  90   if (latency_ <= 0.0)
  91     set_state(Action::State::FINISHED);
  92 }
  93
  94 void NetworkConstantAction::update_remains_lazy(double /*now*/)
  95 {
  96   THROW_IMPOSSIBLE;
  97 }
  98
  99 } // namespace simgrid::kernel::resource