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   delete this;
  41 }
  42
  43 constexpr kernel::lmm::Constraint::SharingPolicy to_maxmin_policy(s4u::Link::SharingPolicy policy)
  44 {
  45   switch (policy) {
  46     case s4u::Link::SharingPolicy::WIFI:
  47       return kernel::lmm::Constraint::SharingPolicy::WIFI;
  48     case s4u::Link::SharingPolicy::NONLINEAR:
  49       return kernel::lmm::Constraint::SharingPolicy::NONLINEAR;
  50     case s4u::Link::SharingPolicy::FATPIPE:
  51       return kernel::lmm::Constraint::SharingPolicy::FATPIPE;
  52     default:
  53       return kernel::lmm::Constraint::SharingPolicy::SHARED;
  54   }
  55 }
  56
  57 void StandardLinkImpl::set_sharing_policy(s4u::Link::SharingPolicy policy, const s4u::NonLinearResourceCb& cb)
  58 {
  59   get_constraint()->set_sharing_policy(to_maxmin_policy(policy), cb);
  60   sharing_policy_ = policy;
  61 }
  62
  63 void StandardLinkImpl::latency_check(double latency) const
  64 {
  65   static double last_warned_latency = sg_precision_timing;
  66   if (latency != 0.0 && latency < last_warned_latency) {
  67     XBT_WARN("Latency for link %s is smaller than precision/timing (%g < %g)."
  68              " For more accuracy, consider setting \"--cfg=precision/timing:%g\".",
  69              get_cname(), latency, sg_precision_timing, latency);
  70     last_warned_latency = latency;
  71   }
  72 }
  73
  74 StandardLinkImpl* StandardLinkImpl::set_englobing_zone(routing::NetZoneImpl* englobing_zone)
  75 {
  76   englobing_zone_ = englobing_zone;
  77   return this;
  78 }
  79
  80 void StandardLinkImpl::turn_on()
  81 {
  82   if (not is_on()) {
  83     Resource::turn_on();
  84     s4u::Link::on_state_change(piface_);
  85   }
  86 }
  87
  88 void StandardLinkImpl::turn_off()
  89 {
  90   if (is_on()) {
  91     Resource::turn_off();
  92     s4u::Link::on_state_change(piface_);
  93
  94     const kernel::lmm::Element* elem = nullptr;
  95     double now                       = EngineImpl::get_clock();
  96     while (const auto* var = get_constraint()->get_variable(&elem)) {
  97       Action* action = var->get_id();
  98       if (action->get_state() == Action::State::INITED || action->get_state() == Action::State::STARTED) {
  99         action->set_finish_time(now);
 100         action->set_state(Action::State::FAILED);
 101       }
 102     }
 103   }
 104 }
 105
 106 void StandardLinkImpl::seal()
 107 {
 108   if (is_sealed())
 109     return;
 110
 111   xbt_assert(this->get_model(), "Cannot seal Link(%s) without setting the Network model first", this->get_cname());
 112   Resource::seal();
 113 }
 114
 115 void StandardLinkImpl::on_bandwidth_change() const
 116 {
 117   s4u::Link::on_bandwidth_change(piface_);
 118 }
 119
 120 void StandardLinkImpl::set_bandwidth_profile(profile::Profile* profile)
 121 {
 122   if (profile) {
 123     xbt_assert(bandwidth_.event == nullptr, "Cannot set a second bandwidth profile to Link %s", get_cname());
 124     bandwidth_.event = profile->schedule(&profile::future_evt_set, this);
 125   }
 126 }
 127
 128 void StandardLinkImpl::set_latency_profile(profile::Profile* profile)
 129 {
 130   if (profile) {
 131     xbt_assert(latency_.event == nullptr, "Cannot set a second latency profile to Link %s", get_cname());
 132     latency_.event = profile->schedule(&profile::future_evt_set, this);
 133   }
 134 }
 135
 136 } // namespace simgrid::kernel::resource