1 /* Copyright (c) 2013-2019. The SimGrid Team. All rights reserved. */
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. */
6 #include "network_cm02.hpp"
7 #include "simgrid/s4u/Host.hpp"
8 #include "simgrid/sg_config.hpp"
9 #include "src/kernel/resource/profile/Event.hpp"
10 #include "src/surf/surf_interface.hpp"
11 #include "surf/surf.hpp"
16 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_network);
18 double sg_latency_factor = 1.0; /* default value; can be set by model or from command line */
19 double sg_bandwidth_factor = 1.0; /* default value; can be set by model or from command line */
20 double sg_weight_S_parameter = 0.0; /* default value; can be set by model or from command line */
22 /************************************************************************/
23 /* New model based on optimizations discussed during Pedro Velho's thesis*/
24 /************************************************************************/
25 /* @techreport{VELHO:2011:HAL-00646896:1, */
26 /* url = {http://hal.inria.fr/hal-00646896/en/}, */
27 /* title = {{Flow-level network models: have we reached the limits?}}, */
28 /* author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
29 /* type = {Rapport de recherche}, */
30 /* institution = {INRIA}, */
31 /* number = {RR-7821}, */
34 /* pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
36 void surf_network_model_init_LegrandVelho()
38 xbt_assert(surf_network_model == nullptr, "Cannot set the network model twice");
40 surf_network_model = new simgrid::kernel::resource::NetworkCm02Model();
42 simgrid::config::set_default<double>("network/latency-factor", 13.01);
43 simgrid::config::set_default<double>("network/bandwidth-factor", 0.97);
44 simgrid::config::set_default<double>("network/weight-S", 20537);
47 /***************************************************************************/
48 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
49 /***************************************************************************/
50 /* @TechReport{ rr-lip2002-40, */
51 /* author = {Henri Casanova and Loris Marchal}, */
52 /* institution = {LIP}, */
53 /* title = {A Network Model for Simulation of Grid Application}, */
54 /* number = {2002-40}, */
58 void surf_network_model_init_CM02()
60 xbt_assert(surf_network_model == nullptr, "Cannot set the network model twice");
62 simgrid::config::set_default<double>("network/latency-factor", 1.0);
63 simgrid::config::set_default<double>("network/bandwidth-factor", 1.0);
64 simgrid::config::set_default<double>("network/weight-S", 0.0);
66 surf_network_model = new simgrid::kernel::resource::NetworkCm02Model();
73 NetworkCm02Model::NetworkCm02Model(kernel::lmm::System* (*make_new_lmm_system)(bool))
74 : NetworkModel(simgrid::config::get_value<std::string>("network/optim") == "Full" ? Model::UpdateAlgo::FULL
75 : Model::UpdateAlgo::LAZY)
77 all_existing_models.push_back(this);
79 std::string optim = simgrid::config::get_value<std::string>("network/optim");
80 bool select = simgrid::config::get_value<bool>("network/maxmin-selective-update");
82 if (optim == "Lazy") {
83 xbt_assert(select || simgrid::config::is_default("network/maxmin-selective-update"),
84 "You cannot disable network selective update when using the lazy update mechanism");
88 set_maxmin_system(make_new_lmm_system(select));
89 loopback_ = NetworkCm02Model::create_link("__loopback__", 498000000, 0.000015, s4u::Link::SharingPolicy::FATPIPE);
92 LinkImpl* NetworkCm02Model::create_link(const std::string& name, double bandwidth, double latency,
93 s4u::Link::SharingPolicy policy)
95 return new NetworkCm02Link(this, name, bandwidth, latency, policy, get_maxmin_system());
98 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
100 while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
102 NetworkCm02Action* action = static_cast<NetworkCm02Action*>(get_action_heap().pop());
103 XBT_DEBUG("Something happened to action %p", action);
105 // if I am wearing a latency hat
106 if (action->get_type() == ActionHeap::Type::latency) {
107 XBT_DEBUG("Latency paid for action %p. Activating", action);
108 get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
109 get_action_heap().remove(action);
110 action->set_last_update();
112 // if I am wearing a max_duration or normal hat
113 } else if (action->get_type() == ActionHeap::Type::max_duration || action->get_type() == ActionHeap::Type::normal) {
114 // no need to communicate anymore
115 // assume that flows that reached max_duration have remaining of 0
116 XBT_DEBUG("Action %p finished", action);
117 action->finish(Action::State::FINISHED);
118 get_action_heap().remove(action);
123 void NetworkCm02Model::update_actions_state_full(double /*now*/, double delta)
125 for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
126 NetworkCm02Action& action = static_cast<NetworkCm02Action&>(*it);
127 ++it; // increment iterator here since the following calls to action.finish() may invalidate it
128 XBT_DEBUG("Something happened to action %p", &action);
129 double deltap = delta;
130 if (action.latency_ > 0) {
131 if (action.latency_ > deltap) {
132 double_update(&action.latency_, deltap, sg_surf_precision);
135 double_update(&deltap, action.latency_, sg_surf_precision);
136 action.latency_ = 0.0;
138 if (action.latency_ <= 0.0 && not action.is_suspended())
139 get_maxmin_system()->update_variable_penalty(action.get_variable(), action.sharing_penalty_);
142 if (not action.get_variable()->get_number_of_constraint()) {
143 /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
144 * vivaldi. In such case, just make sure that the action completes immediately.
146 action.update_remains(action.get_remains());
148 action.update_remains(action.get_variable()->get_value() * delta);
150 if (action.get_max_duration() != NO_MAX_DURATION)
151 action.update_max_duration(delta);
153 if (((action.get_remains() <= 0) && (action.get_variable()->get_penalty() > 0)) ||
154 ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
155 action.finish(Action::State::FINISHED);
160 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
162 double latency = 0.0;
163 std::vector<LinkImpl*> back_route;
164 std::vector<LinkImpl*> route;
166 XBT_IN("(%s,%s,%g,%g)", src->get_cname(), dst->get_cname(), size, rate);
168 src->route_to(dst, route, &latency);
169 xbt_assert(not route.empty() || latency > 0,
170 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
171 src->get_cname(), dst->get_cname());
173 bool failed = std::any_of(route.begin(), route.end(), [](const LinkImpl* link) { return not link->is_on(); });
175 if (cfg_crosstraffic) {
176 dst->route_to(src, back_route, nullptr);
179 std::any_of(back_route.begin(), back_route.end(), [](const LinkImpl* link) { return not link->is_on(); });
182 NetworkCm02Action *action = new NetworkCm02Action(this, size, failed);
183 action->sharing_penalty_ = latency;
184 action->latency_ = latency;
185 action->rate_ = rate;
186 if (get_update_algorithm() == Model::UpdateAlgo::LAZY) {
187 action->set_last_update();
190 if (sg_weight_S_parameter > 0) {
191 action->sharing_penalty_ =
192 std::accumulate(route.begin(), route.end(), action->sharing_penalty_, [](double total, LinkImpl* const& link) {
193 return total + sg_weight_S_parameter / link->get_bandwidth();
197 double bandwidth_bound = route.empty() ? -1.0 : get_bandwidth_factor(size) * route.front()->get_bandwidth();
199 for (auto const& link : route)
200 bandwidth_bound = std::min(bandwidth_bound, get_bandwidth_factor(size) * link->get_bandwidth());
202 action->lat_current_ = action->latency_;
203 action->latency_ *= get_latency_factor(size);
204 action->rate_ = get_bandwidth_constraint(action->rate_, bandwidth_bound, size);
206 size_t constraints_per_variable = route.size();
207 constraints_per_variable += back_route.size();
209 if (action->latency_ > 0) {
210 action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
211 if (get_update_algorithm() == Model::UpdateAlgo::LAZY) {
212 // add to the heap the event when the latency is payed
213 double date = action->latency_ + action->get_last_update();
215 ActionHeap::Type type = route.empty() ? ActionHeap::Type::normal : ActionHeap::Type::latency;
217 XBT_DEBUG("Added action (%p) one latency event at date %f", action, date);
218 get_action_heap().insert(action, date, type);
221 action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
223 if (action->rate_ < 0) {
224 get_maxmin_system()->update_variable_bound(
225 action->get_variable(), (action->lat_current_ > 0) ? cfg_tcp_gamma / (2.0 * action->lat_current_) : -1.0);
227 get_maxmin_system()->update_variable_bound(
228 action->get_variable(), (action->lat_current_ > 0)
229 ? std::min(action->rate_, cfg_tcp_gamma / (2.0 * action->lat_current_))
233 for (auto const& link : route)
234 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0);
236 if (cfg_crosstraffic) {
237 XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
238 for (auto const& link : back_route)
239 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), .05);
241 // Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
242 // (You would also have to change simgrid::kernel::lmm::Element::get_concurrency())
243 // action->getVariable()->set_concurrency_share(2)
247 simgrid::s4u::Link::on_communicate(*action, src, dst);
254 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model* model, const std::string& name, double bandwidth, double latency,
255 s4u::Link::SharingPolicy policy, kernel::lmm::System* system)
256 : LinkImpl(model, name, system->constraint_new(this, sg_bandwidth_factor * bandwidth))
258 bandwidth_.scale = 1.0;
259 bandwidth_.peak = bandwidth;
261 latency_.scale = 1.0;
262 latency_.peak = latency;
264 if (policy == s4u::Link::SharingPolicy::FATPIPE)
265 get_constraint()->unshare();
267 simgrid::s4u::Link::on_creation(this->piface_);
270 void NetworkCm02Link::apply_event(kernel::profile::Event* triggered, double value)
272 /* Find out which of my iterators was triggered, and react accordingly */
273 if (triggered == bandwidth_.event) {
274 set_bandwidth(value);
275 tmgr_trace_event_unref(&bandwidth_.event);
277 } else if (triggered == latency_.event) {
279 tmgr_trace_event_unref(&latency_.event);
281 } else if (triggered == state_event_) {
285 kernel::lmm::Variable* var = nullptr;
286 const kernel::lmm::Element* elem = nullptr;
287 double now = surf_get_clock();
290 while ((var = get_constraint()->get_variable(&elem))) {
291 Action* action = static_cast<Action*>(var->get_id());
293 if (action->get_state() == Action::State::INITED || action->get_state() == Action::State::STARTED) {
294 action->set_finish_time(now);
295 action->set_state(Action::State::FAILED);
299 tmgr_trace_event_unref(&state_event_);
301 xbt_die("Unknown event!\n");
304 XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
308 void NetworkCm02Link::set_bandwidth(double value)
310 bandwidth_.peak = value;
312 get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(),
313 sg_bandwidth_factor * (bandwidth_.peak * bandwidth_.scale));
315 LinkImpl::on_bandwidth_change();
317 if (sg_weight_S_parameter > 0) {
318 double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale);
320 kernel::lmm::Variable* var;
321 const kernel::lmm::Element* elem = nullptr;
322 const kernel::lmm::Element* nextelem = nullptr;
324 while ((var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
325 NetworkCm02Action* action = static_cast<NetworkCm02Action*>(var->get_id());
326 action->sharing_penalty_ += delta;
327 if (not action->is_suspended())
328 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
333 void NetworkCm02Link::set_latency(double value)
335 double delta = value - latency_.peak;
336 kernel::lmm::Variable* var = nullptr;
337 const kernel::lmm::Element* elem = nullptr;
338 const kernel::lmm::Element* nextelem = nullptr;
341 latency_.peak = value;
343 while ((var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
344 NetworkCm02Action* action = static_cast<NetworkCm02Action*>(var->get_id());
345 action->lat_current_ += delta;
346 action->sharing_penalty_ += delta;
347 if (action->rate_ < 0)
348 get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), NetworkModel::cfg_tcp_gamma /
349 (2.0 * action->lat_current_));
351 get_model()->get_maxmin_system()->update_variable_bound(
352 action->get_variable(), std::min(action->rate_, NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
354 if (action->rate_ < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
355 XBT_INFO("Flow is limited BYBANDWIDTH");
357 XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->lat_current_);
360 if (not action->is_suspended())
361 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
369 void NetworkCm02Action::update_remains_lazy(double now)
371 if (not is_running())
374 double delta = now - get_last_update();
376 if (get_remains_no_update() > 0) {
377 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
379 update_remains(get_last_value() * delta);
381 XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
384 update_max_duration(delta);
386 if ((get_remains_no_update() <= 0 && (get_variable()->get_penalty() > 0)) ||
387 ((get_max_duration() != NO_MAX_DURATION) && (get_max_duration() <= 0))) {
388 finish(Action::State::FINISHED);
389 get_model()->get_action_heap().remove(this);
393 set_last_value(get_variable()->get_value());
398 } // namespace simgrid