src/kernel/resource/StandardLinkImpl.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/s4u/Engine.hpp>
   7
   8 #include "src/kernel/EngineImpl.hpp"
   9 #include "src/kernel/resource/StandardLinkImpl.hpp"
  10 #include <numeric>
  11
  12 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(res_network);
  13
  14 /*********
  15  * Model *
  16  *********/
  17
  18 namespace simgrid::kernel::resource {
  19
  20 StandardLinkImpl::StandardLinkImpl(const std::string& name) : LinkImpl(name), piface_(this)
  21 {
  22   if (name != "__loopback__")
  23     xbt_assert(not s4u::Link::by_name_or_null(name), "Link '%s' declared several times in the platform.", name.c_str());
  24
  25   XBT_DEBUG("Create link '%s'", name.c_str());
  26 }
  27
  28 void StandardLinkImpl::Deleter::operator()(resource::StandardLinkImpl* link) const
  29 {
  30   link->destroy();
  31 }
  32
  33 /** @brief Fire the required callbacks and destroy the object
  34  *
  35  * Don't delete directly a Link, call l->destroy() instead.
  36  */
  37 void StandardLinkImpl::destroy()
  38 {
  39   s4u::Link::on_destruction(piface_);
  40   piface_.on_this_destruction(piface_);
  41   delete this;
  42 }
  43
  44 constexpr kernel::lmm::Constraint::SharingPolicy to_maxmin_policy(s4u::Link::SharingPolicy policy)
  45 {
  46   switch (policy) {
  47     case s4u::Link::SharingPolicy::WIFI:
  48       return kernel::lmm::Constraint::SharingPolicy::WIFI;
  49     case s4u::Link::SharingPolicy::NONLINEAR:
  50       return kernel::lmm::Constraint::SharingPolicy::NONLINEAR;
  51     case s4u::Link::SharingPolicy::FATPIPE:
  52       return kernel::lmm::Constraint::SharingPolicy::FATPIPE;
  53     default:
  54       return kernel::lmm::Constraint::SharingPolicy::SHARED;
  55   }
  56 }
  57
  58 void StandardLinkImpl::set_sharing_policy(s4u::Link::SharingPolicy policy, const s4u::NonLinearResourceCb& cb)
  59 {
  60   get_constraint()->set_sharing_policy(to_maxmin_policy(policy), cb);
  61   sharing_policy_ = policy;
  62 }
  63
  64 void StandardLinkImpl::latency_check(double latency) const
  65 {
  66   static double last_warned_latency = sg_precision_timing;
  67   if (latency != 0.0 && latency < last_warned_latency) {
  68     XBT_WARN("Latency for link %s is smaller than precision/timing (%g < %g)."
  69              " For more accuracy, consider setting \"--cfg=precision/timing:%g\".",
  70              get_cname(), latency, sg_precision_timing, latency);
  71     last_warned_latency = latency;
  72   }
  73 }
  74
  75 StandardLinkImpl* StandardLinkImpl::set_englobing_zone(routing::NetZoneImpl* englobing_zone)
  76 {
  77   englobing_zone_ = englobing_zone;
  78   return this;
  79 }
  80
  81 void StandardLinkImpl::turn_on()
  82 {
  83   if (not is_on()) {
  84     Resource::turn_on();
  85     s4u::Link::on_state_change(piface_);
  86   }
  87 }
  88
  89 void StandardLinkImpl::turn_off()
  90 {
  91   if (is_on()) {
  92     Resource::turn_off();
  93     s4u::Link::on_state_change(piface_);
  94
  95     const kernel::lmm::Element* elem = nullptr;
  96     double now                       = EngineImpl::get_clock();
  97     while (const auto* var = get_constraint()->get_variable(&elem)) {
  98       Action* action = var->get_id();
  99       if (action->get_state() == Action::State::INITED || action->get_state() == Action::State::STARTED) {
 100         action->set_finish_time(now);
 101         action->set_state(Action::State::FAILED);
 102       }
 103     }
 104   }
 105 }
 106
 107 void StandardLinkImpl::seal()
 108 {
 109   if (is_sealed())
 110     return;
 111
 112   xbt_assert(this->get_model(), "Cannot seal Link(%s) without setting the Network model first", this->get_cname());
 113   Resource::seal();
 114 }
 115
 116 void StandardLinkImpl::on_bandwidth_change() const
 117 {
 118   s4u::Link::on_bandwidth_change(piface_);
 119   piface_.on_this_bandwidth_change(piface_);
 120 }
 121
 122 void StandardLinkImpl::set_bandwidth_profile(profile::Profile* profile)
 123 {
 124   if (profile) {
 125     xbt_assert(bandwidth_.event == nullptr, "Cannot set a second bandwidth profile to Link %s", get_cname());
 126     bandwidth_.event = profile->schedule(&profile::future_evt_set, this);
 127   }
 128 }
 129
 130 void StandardLinkImpl::set_latency_profile(profile::Profile* profile)
 131 {
 132   if (profile) {
 133     xbt_assert(latency_.event == nullptr, "Cannot set a second latency profile to Link %s", get_cname());
 134     latency_.event = profile->schedule(&profile::future_evt_set, this);
 135   }
 136 }
 137
 138 } // namespace simgrid::kernel::resource