src/surf/network_interface.cpp

   1 /* Copyright (c) 2013-2021. 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 "network_interface.hpp"
   7 #include "simgrid/s4u/Engine.hpp"
   8 #include "simgrid/sg_config.hpp"
   9 #include "src/kernel/resource/profile/Profile.hpp"
  10 #include "src/surf/surf_interface.hpp"
  11 #include "surf/surf.hpp"
  12
  13 #ifndef NETWORK_INTERFACE_CPP_
  14 #define NETWORK_INTERFACE_CPP_
  15
  16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(res_network, ker_resource, "Network resources, that fuels communications");
  17
  18 /*********
  19  * Model *
  20  *********/
  21
  22 simgrid::kernel::resource::NetworkModel* surf_network_model = nullptr;
  23
  24 namespace simgrid {
  25 namespace kernel {
  26 namespace resource {
  27
  28 /** @brief Command-line option 'network/TCP-gamma' -- see @ref options_model_network_gamma */
  29 simgrid::config::Flag<double> NetworkModel::cfg_tcp_gamma(
  30     "network/TCP-gamma",
  31     "Size of the biggest TCP window (cat /proc/sys/net/ipv4/tcp_[rw]mem for recv/send window; "
  32     "Use the last given value, which is the max window size)",
  33     4194304.0);
  34
  35 /** @brief Command-line option 'network/crosstraffic' -- see @ref options_model_network_crosstraffic */
  36 simgrid::config::Flag<bool> NetworkModel::cfg_crosstraffic(
  37     "network/crosstraffic",
  38     "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)", "yes");
  39
  40 NetworkModel::~NetworkModel() = default;
  41
  42 double NetworkModel::get_latency_factor(double /*size*/)
  43 {
  44   return sg_latency_factor;
  45 }
  46
  47 double NetworkModel::get_bandwidth_factor(double /*size*/)
  48 {
  49   return sg_bandwidth_factor;
  50 }
  51
  52 double NetworkModel::get_bandwidth_constraint(double rate, double /*bound*/, double /*size*/)
  53 {
  54   return rate;
  55 }
  56
  57 double NetworkModel::next_occurring_event_full(double now)
  58 {
  59   double minRes = Model::next_occurring_event_full(now);
  60
  61   for (Action const& action : *get_started_action_set()) {
  62     const auto& net_action = static_cast<const NetworkAction&>(action);
  63     if (net_action.latency_ > 0)
  64       minRes = (minRes < 0) ? net_action.latency_ : std::min(minRes, net_action.latency_);
  65   }
  66
  67   XBT_DEBUG("Min of share resources %f", minRes);
  68
  69   return minRes;
  70 }
  71
  72 /************
  73  * Resource *
  74  ************/
  75
  76 LinkImpl::LinkImpl(NetworkModel* model, const std::string& name, lmm::Constraint* constraint)
  77     : Resource(name), piface_(this)
  78 {
  79   this->set_model(model)->set_constraint(constraint);
  80   if (name != "__loopback__")
  81     xbt_assert(not s4u::Link::by_name_or_null(name), "Link '%s' declared several times in the platform.", name.c_str());
  82
  83   latency_.scale   = 1;
  84   bandwidth_.scale = 1;
  85
  86   s4u::Engine::get_instance()->link_register(name, &piface_);
  87   XBT_DEBUG("Create link '%s'", name.c_str());
  88 }
  89
  90 /** @brief Fire the required callbacks and destroy the object
  91  *
  92  * Don't delete directly a Link, call l->destroy() instead.
  93  */
  94 void LinkImpl::destroy()
  95 {
  96   s4u::Link::on_destruction(this->piface_);
  97   delete this;
  98 }
  99
 100 bool LinkImpl::is_used() const
 101 {
 102   return get_model()->get_maxmin_system()->constraint_used(get_constraint());
 103 }
 104
 105 double LinkImpl::get_latency() const
 106 {
 107   return latency_.peak * latency_.scale;
 108 }
 109
 110 double LinkImpl::get_bandwidth() const
 111 {
 112   return bandwidth_.peak * bandwidth_.scale;
 113 }
 114
 115 s4u::Link::SharingPolicy LinkImpl::get_sharing_policy() const
 116 {
 117   return get_constraint()->get_sharing_policy();
 118 }
 119
 120 void LinkImpl::latency_check(double latency)
 121 {
 122   static double last_warned_latency = sg_surf_precision;
 123   if (latency != 0.0 && latency < last_warned_latency) {
 124     XBT_WARN("Latency for link %s is smaller than surf/precision (%g < %g)."
 125         " For more accuracy, consider setting \"--cfg=surf/precision:%g\".",
 126         get_cname(), latency, sg_surf_precision, latency);
 127     last_warned_latency = latency;
 128   }
 129 }
 130
 131 void LinkImpl::turn_on()
 132 {
 133   if (not is_on()) {
 134     Resource::turn_on();
 135     s4u::Link::on_state_change(this->piface_);
 136   }
 137 }
 138
 139 void LinkImpl::turn_off()
 140 {
 141   if (is_on()) {
 142     Resource::turn_off();
 143     s4u::Link::on_state_change(this->piface_);
 144
 145     const kernel::lmm::Variable* var;
 146     const kernel::lmm::Element* elem = nullptr;
 147     double now                       = surf_get_clock();
 148     while ((var = get_constraint()->get_variable(&elem))) {
 149       Action* action = var->get_id();
 150       if (action->get_state() == Action::State::INITED || action->get_state() == Action::State::STARTED) {
 151         action->set_finish_time(now);
 152         action->set_state(Action::State::FAILED);
 153       }
 154     }
 155   }
 156 }
 157 void LinkImpl::seal()
 158 {
 159   simgrid::s4u::Link::on_creation(*get_iface());
 160 }
 161 void LinkImpl::on_bandwidth_change() const
 162 {
 163   s4u::Link::on_bandwidth_change(this->piface_);
 164 }
 165
 166 void LinkImpl::set_bandwidth_profile(profile::Profile* profile)
 167 {
 168   xbt_assert(bandwidth_.event == nullptr, "Cannot set a second bandwidth profile to Link %s", get_cname());
 169   bandwidth_.event = profile->schedule(&profile::future_evt_set, this);
 170 }
 171
 172 void LinkImpl::set_latency_profile(profile::Profile* profile)
 173 {
 174   xbt_assert(latency_.event == nullptr, "Cannot set a second latency profile to Link %s", get_cname());
 175   latency_.event = profile->schedule(&profile::future_evt_set, this);
 176 }
 177
 178 /**********
 179  * Action *
 180  **********/
 181
 182 void NetworkAction::set_state(Action::State state)
 183 {
 184   Action::State previous = get_state();
 185   Action::set_state(state);
 186   if (previous != state) // Trigger only if the state changed
 187     s4u::Link::on_communication_state_change(*this, previous);
 188 }
 189
 190 /** @brief returns a list of all Links that this action is using */
 191 std::list<LinkImpl*> NetworkAction::get_links() const
 192 {
 193   std::list<LinkImpl*> retlist;
 194   int llen = get_variable()->get_number_of_constraint();
 195
 196   for (int i = 0; i < llen; i++) {
 197     /* Beware of composite actions: ptasks put links and cpus together */
 198     // extra pb: we cannot dynamic_cast from void*...
 199     Resource* resource = get_variable()->get_constraint(i)->get_id();
 200     auto* link         = dynamic_cast<LinkImpl*>(resource);
 201     if (link != nullptr)
 202       retlist.push_back(link);
 203   }
 204
 205   return retlist;
 206 }
 207 }
 208 } // namespace kernel
 209 }
 210
 211 #endif /* NETWORK_INTERFACE_CPP_ */