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