1 /* Copyright (c) 2013-2017. 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. */
8 #include "maxmin_private.hpp"
9 #include "network_cm02.hpp"
10 #include "simgrid/s4u/Host.hpp"
11 #include "simgrid/sg_config.h"
12 #include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
14 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_network);
16 double sg_sender_gap = 0.0;
17 double sg_latency_factor = 1.0; /* default value; can be set by model or from command line */
18 double sg_bandwidth_factor = 1.0; /* default value; can be set by model or from command line */
19 double sg_weight_S_parameter = 0.0; /* default value; can be set by model or from command line */
21 double sg_tcp_gamma = 0.0;
22 int sg_network_crosstraffic = 0;
24 /************************************************************************/
25 /* New model based on optimizations discussed during Pedro Velho's thesis*/
26 /************************************************************************/
27 /* @techreport{VELHO:2011:HAL-00646896:1, */
28 /* url = {http://hal.inria.fr/hal-00646896/en/}, */
29 /* title = {{Flow-level network models: have we reached the limits?}}, */
30 /* author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
31 /* type = {Rapport de recherche}, */
32 /* institution = {INRIA}, */
33 /* number = {RR-7821}, */
36 /* pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
38 void surf_network_model_init_LegrandVelho()
40 if (surf_network_model)
43 surf_network_model = new simgrid::surf::NetworkCm02Model();
44 all_existing_models->push_back(surf_network_model);
46 xbt_cfg_setdefault_double("network/latency-factor", 13.01);
47 xbt_cfg_setdefault_double("network/bandwidth-factor", 0.97);
48 xbt_cfg_setdefault_double("network/weight-S", 20537);
51 /***************************************************************************/
52 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
53 /***************************************************************************/
54 /* @TechReport{ rr-lip2002-40, */
55 /* author = {Henri Casanova and Loris Marchal}, */
56 /* institution = {LIP}, */
57 /* title = {A Network Model for Simulation of Grid Application}, */
58 /* number = {2002-40}, */
62 void surf_network_model_init_CM02()
65 if (surf_network_model)
68 xbt_cfg_setdefault_double("network/latency-factor", 1.0);
69 xbt_cfg_setdefault_double("network/bandwidth-factor", 1.0);
70 xbt_cfg_setdefault_double("network/weight-S", 0.0);
72 surf_network_model = new simgrid::surf::NetworkCm02Model();
73 all_existing_models->push_back(surf_network_model);
76 /***************************************************************************/
77 /* The models from Steven H. Low */
78 /***************************************************************************/
80 /* author={Steven H. Low}, */
81 /* title={A Duality Model of {TCP} and Queue Management Algorithms}, */
83 /* journal={{IEEE/ACM} Transactions on Networking}, */
84 /* volume={11}, number={4}, */
86 void surf_network_model_init_Reno()
88 if (surf_network_model)
91 lmm_set_default_protocol_function(func_reno_f, func_reno_fp, func_reno_fpi);
93 xbt_cfg_setdefault_double("network/latency-factor", 13.01);
94 xbt_cfg_setdefault_double("network/bandwidth-factor", 0.97);
95 xbt_cfg_setdefault_double("network/weight-S", 20537);
97 surf_network_model = new simgrid::surf::NetworkCm02Model(&lagrange_solve);
98 all_existing_models->push_back(surf_network_model);
102 void surf_network_model_init_Reno2()
104 if (surf_network_model)
107 lmm_set_default_protocol_function(func_reno2_f, func_reno2_fp, func_reno2_fpi);
109 xbt_cfg_setdefault_double("network/latency-factor", 13.01);
110 xbt_cfg_setdefault_double("network/bandwidth-factor", 0.97);
111 xbt_cfg_setdefault_double("network/weight-S", 20537);
113 surf_network_model = new simgrid::surf::NetworkCm02Model(&lagrange_solve);
114 all_existing_models->push_back(surf_network_model);
117 void surf_network_model_init_Vegas()
119 if (surf_network_model)
122 lmm_set_default_protocol_function(func_vegas_f, func_vegas_fp, func_vegas_fpi);
124 xbt_cfg_setdefault_double("network/latency-factor", 13.01);
125 xbt_cfg_setdefault_double("network/bandwidth-factor", 0.97);
126 xbt_cfg_setdefault_double("network/weight-S", 20537);
128 surf_network_model = new simgrid::surf::NetworkCm02Model(&lagrange_solve);
129 all_existing_models->push_back(surf_network_model);
135 NetworkCm02Model::NetworkCm02Model()
138 char *optim = xbt_cfg_get_string("network/optim");
139 bool select = xbt_cfg_get_boolean("network/maxmin-selective-update");
141 if (not strcmp(optim, "Full")) {
142 updateMechanism_ = UM_FULL;
143 selectiveUpdate_ = select;
144 } else if (not strcmp(optim, "Lazy")) {
145 updateMechanism_ = UM_LAZY;
146 selectiveUpdate_ = true;
147 xbt_assert(select || (xbt_cfg_is_default_value("network/maxmin-selective-update")),
148 "You cannot disable selective update when using the lazy update mechanism");
150 xbt_die("Unsupported optimization (%s) for this model. Accepted: Full, Lazy.", optim);
153 maxminSystem_ = lmm_system_new(selectiveUpdate_);
154 loopback_ = createLink("__loopback__", 498000000, 0.000015, SURF_LINK_FATPIPE);
156 if (updateMechanism_ == UM_LAZY) {
157 actionHeap_ = xbt_heap_new(8, nullptr);
158 xbt_heap_set_update_callback(actionHeap_, surf_action_lmm_update_index_heap);
159 modifiedSet_ = new ActionLmmList();
160 maxminSystem_->keep_track = modifiedSet_;
163 NetworkCm02Model::NetworkCm02Model(void (*specificSolveFun)(lmm_system_t self))
166 maxminSystem_->solve_fun = specificSolveFun;
169 LinkImpl* NetworkCm02Model::createLink(const char* name, double bandwidth, double latency,
170 e_surf_link_sharing_policy_t policy)
172 return new NetworkCm02Link(this, name, bandwidth, latency, policy, maxminSystem_);
175 void NetworkCm02Model::updateActionsStateLazy(double now, double /*delta*/)
177 while ((xbt_heap_size(actionHeap_) > 0)
178 && (double_equals(xbt_heap_maxkey(actionHeap_), now, sg_surf_precision))) {
180 NetworkCm02Action *action = static_cast<NetworkCm02Action*> (xbt_heap_pop(actionHeap_));
181 XBT_DEBUG("Something happened to action %p", action);
182 if (TRACE_is_enabled()) {
183 int n = lmm_get_number_of_cnst_from_var(maxminSystem_, action->getVariable());
185 for (int i = 0; i < n; i++){
186 lmm_constraint_t constraint = lmm_get_cnst_from_var(maxminSystem_, action->getVariable(), i);
187 NetworkCm02Link *link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
188 double value = lmm_variable_getvalue(action->getVariable())*
189 lmm_get_cnst_weight_from_var(maxminSystem_, action->getVariable(), i);
190 TRACE_surf_link_set_utilization(link->cname(), action->getCategory(), value, action->getLastUpdate(),
191 now - action->getLastUpdate());
195 // if I am wearing a latency hat
196 if (action->getHat() == LATENCY) {
197 XBT_DEBUG("Latency paid for action %p. Activating", action);
198 lmm_update_variable_weight(maxminSystem_, action->getVariable(), action->weight_);
199 action->heapRemove(actionHeap_);
200 action->refreshLastUpdate();
202 // if I am wearing a max_duration or normal hat
203 } else if (action->getHat() == MAX_DURATION || action->getHat() == NORMAL) {
204 // no need to communicate anymore
205 // assume that flows that reached max_duration have remaining of 0
206 XBT_DEBUG("Action %p finished", action);
207 action->setRemains(0);
209 action->setState(Action::State::done);
210 action->heapRemove(actionHeap_);
216 void NetworkCm02Model::updateActionsStateFull(double now, double delta)
218 ActionList *running_actions = getRunningActionSet();
220 for(ActionList::iterator it(running_actions->begin()), itNext=it, itend(running_actions->end())
221 ; it != itend ; it=itNext) {
224 NetworkCm02Action *action = static_cast<NetworkCm02Action*> (&*it);
225 XBT_DEBUG("Something happened to action %p", action);
226 double deltap = delta;
227 if (action->latency_ > 0) {
228 if (action->latency_ > deltap) {
229 double_update(&(action->latency_), deltap, sg_surf_precision);
232 double_update(&(deltap), action->latency_, sg_surf_precision);
233 action->latency_ = 0.0;
235 if (action->latency_ <= 0.0 && not action->isSuspended())
236 lmm_update_variable_weight(maxminSystem_, action->getVariable(), action->weight_);
238 if (TRACE_is_enabled()) {
239 int n = lmm_get_number_of_cnst_from_var(maxminSystem_, action->getVariable());
240 for (int i = 0; i < n; i++){
241 lmm_constraint_t constraint = lmm_get_cnst_from_var(maxminSystem_, action->getVariable(), i);
243 NetworkCm02Link* link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
244 TRACE_surf_link_set_utilization(link->cname(), action->getCategory(),
245 (lmm_variable_getvalue(action->getVariable()) *
246 lmm_get_cnst_weight_from_var(maxminSystem_, action->getVariable(), i)),
247 action->getLastUpdate(), now - action->getLastUpdate());
250 if (not lmm_get_number_of_cnst_from_var(maxminSystem_, action->getVariable())) {
251 /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
252 * vivaldi. In such case, just make sure that the action completes immediately.
254 action->updateRemains(action->getRemains());
256 action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
258 if (action->getMaxDuration() > NO_MAX_DURATION)
259 action->updateMaxDuration(delta);
261 if (((action->getRemains() <= 0) && (lmm_get_variable_weight(action->getVariable()) > 0)) ||
262 ((action->getMaxDuration() > NO_MAX_DURATION) && (action->getMaxDuration() <= 0))) {
264 action->setState(Action::State::done);
269 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
272 double latency = 0.0;
273 std::vector<LinkImpl*>* back_route = nullptr;
274 std::vector<LinkImpl*>* route = new std::vector<LinkImpl*>();
276 XBT_IN("(%s,%s,%g,%g)", src->getCname(), dst->getCname(), size, rate);
278 src->routeTo(dst, route, &latency);
279 xbt_assert(not route->empty() || latency,
280 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
281 src->getCname(), dst->getCname());
283 for (auto link: *route)
287 if (sg_network_crosstraffic == 1) {
288 back_route = new std::vector<LinkImpl*>();
289 dst->routeTo(src, back_route, nullptr);
290 for (auto link: *back_route)
295 NetworkCm02Action *action = new NetworkCm02Action(this, size, failed);
296 action->weight_ = latency;
297 action->latency_ = latency;
298 action->rate_ = rate;
299 if (updateMechanism_ == UM_LAZY) {
300 action->indexHeap_ = -1;
301 action->lastUpdate_ = surf_get_clock();
304 double bandwidth_bound = -1.0;
305 if (sg_weight_S_parameter > 0)
306 for (auto link : *route)
307 action->weight_ += sg_weight_S_parameter / link->bandwidth();
309 for (auto link : *route) {
310 double bb = bandwidthFactor(size) * link->bandwidth();
311 bandwidth_bound = (bandwidth_bound < 0.0) ? bb : std::min(bandwidth_bound, bb);
314 action->latCurrent_ = action->latency_;
315 action->latency_ *= latencyFactor(size);
316 action->rate_ = bandwidthConstraint(action->rate_, bandwidth_bound, size);
318 xbt_assert(not route->empty(),
319 "Using a model with a gap (e.g., SMPI) with a platform without links (e.g. vivaldi)!!!");
321 gapAppend(size, route->at(0), action);
322 XBT_DEBUG("Comm %p: %s -> %s gap=%f (lat=%f)", action, src->getCname(), dst->getCname(), action->senderGap_,
326 int constraints_per_variable = route->size();
327 if (back_route != nullptr)
328 constraints_per_variable += back_route->size();
330 if (action->latency_ > 0) {
331 action->variable_ = lmm_variable_new(maxminSystem_, action, 0.0, -1.0, constraints_per_variable);
332 if (updateMechanism_ == UM_LAZY) {
333 // add to the heap the event when the latency is payed
334 XBT_DEBUG("Added action (%p) one latency event at date %f", action, action->latency_ + action->lastUpdate_);
335 action->heapInsert(actionHeap_, action->latency_ + action->lastUpdate_, route->empty() ? NORMAL : LATENCY);
338 action->variable_ = lmm_variable_new(maxminSystem_, action, 1.0, -1.0, constraints_per_variable);
340 if (action->rate_ < 0) {
341 lmm_update_variable_bound(maxminSystem_, action->getVariable(), (action->latCurrent_ > 0) ? sg_tcp_gamma / (2.0 * action->latCurrent_) : -1.0);
343 lmm_update_variable_bound(maxminSystem_, action->getVariable(), (action->latCurrent_ > 0) ? std::min(action->rate_, sg_tcp_gamma / (2.0 * action->latCurrent_)) : action->rate_);
346 for (auto link: *route)
347 lmm_expand(maxminSystem_, link->constraint(), action->getVariable(), 1.0);
349 if (back_route != nullptr) { // sg_network_crosstraffic was activated
350 XBT_DEBUG("Fullduplex active adding backward flow using 5%%");
351 for (auto link : *back_route)
352 lmm_expand(maxminSystem_, link->constraint(), action->getVariable(), .05);
354 //Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
355 //(You would also have to change lmm_element_concurrency())
356 //lmm_variable_concurrency_share_set(action->getVariable(),2);
363 simgrid::s4u::Link::onCommunicate(action, src, dst);
367 void NetworkCm02Model::gapAppend(double size, const LinkImpl* link, NetworkAction* action){
374 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model* model, const char* name, double bandwidth, double latency,
375 e_surf_link_sharing_policy_t policy, lmm_system_t system)
376 : LinkImpl(model, name, lmm_constraint_new(system, this, sg_bandwidth_factor * bandwidth))
378 bandwidth_.scale = 1.0;
379 bandwidth_.peak = bandwidth;
381 latency_.scale = 1.0;
382 latency_.peak = latency;
384 if (policy == SURF_LINK_FATPIPE)
385 lmm_constraint_shared(constraint());
387 simgrid::s4u::Link::onCreation(this->piface_);
390 void NetworkCm02Link::apply_event(tmgr_trace_event_t triggered, double value)
392 /* Find out which of my iterators was triggered, and react accordingly */
393 if (triggered == bandwidth_.event) {
395 tmgr_trace_event_unref(&bandwidth_.event);
397 } else if (triggered == latency_.event) {
399 tmgr_trace_event_unref(&latency_.event);
401 } else if (triggered == stateEvent_) {
405 lmm_variable_t var = nullptr;
406 lmm_element_t elem = nullptr;
407 double now = surf_get_clock();
410 while ((var = lmm_get_var_from_cnst(model()->getMaxminSystem(), constraint(), &elem))) {
411 Action *action = static_cast<Action*>( lmm_variable_id(var) );
413 if (action->getState() == Action::State::running ||
414 action->getState() == Action::State::ready) {
415 action->setFinishTime(now);
416 action->setState(Action::State::failed);
420 tmgr_trace_event_unref(&stateEvent_);
422 xbt_die("Unknown event!\n");
425 XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)", constraint());
428 void NetworkCm02Link::setBandwidth(double value)
431 bandwidth_.peak = value;
433 lmm_update_constraint_bound(model()->getMaxminSystem(), constraint(),
434 sg_bandwidth_factor * (bandwidth_.peak * bandwidth_.scale));
435 TRACE_surf_link_set_bandwidth(surf_get_clock(), cname(), sg_bandwidth_factor * bandwidth_.peak * bandwidth_.scale);
437 if (sg_weight_S_parameter > 0) {
438 double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale);
441 lmm_element_t elem = nullptr;
442 lmm_element_t nextelem = nullptr;
444 while ((var = lmm_get_var_from_cnst_safe(model()->getMaxminSystem(), constraint(), &elem, &nextelem, &numelem))) {
445 NetworkCm02Action *action = static_cast<NetworkCm02Action*>(lmm_variable_id(var));
446 action->weight_ += delta;
447 if (not action->isSuspended())
448 lmm_update_variable_weight(model()->getMaxminSystem(), action->getVariable(), action->weight_);
453 void NetworkCm02Link::setLatency(double value)
455 double delta = value - latency_.peak;
456 lmm_variable_t var = nullptr;
457 lmm_element_t elem = nullptr;
458 lmm_element_t nextelem = nullptr;
461 latency_.peak = value;
463 while ((var = lmm_get_var_from_cnst_safe(model()->getMaxminSystem(), constraint(), &elem, &nextelem, &numelem))) {
464 NetworkCm02Action *action = static_cast<NetworkCm02Action*>(lmm_variable_id(var));
465 action->latCurrent_ += delta;
466 action->weight_ += delta;
467 if (action->rate_ < 0)
468 lmm_update_variable_bound(model()->getMaxminSystem(), action->getVariable(),
469 sg_tcp_gamma / (2.0 * action->latCurrent_));
471 lmm_update_variable_bound(model()->getMaxminSystem(), action->getVariable(),
472 std::min(action->rate_, sg_tcp_gamma / (2.0 * action->latCurrent_)));
474 if (action->rate_ < sg_tcp_gamma / (2.0 * action->latCurrent_)) {
475 XBT_INFO("Flow is limited BYBANDWIDTH");
477 XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->latCurrent_);
480 if (not action->isSuspended())
481 lmm_update_variable_weight(model()->getMaxminSystem(), action->getVariable(), action->weight_);
489 void NetworkCm02Action::updateRemainingLazy(double now)
494 double delta = now - lastUpdate_;
497 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, remains_, lastUpdate_);
498 double_update(&(remains_), lastValue_ * delta, sg_maxmin_precision*sg_surf_precision);
500 XBT_DEBUG("Updating action(%p): remains is now %f", this, remains_);
503 if (maxDuration_ > NO_MAX_DURATION)
504 double_update(&maxDuration_, delta, sg_surf_precision);
506 if ((remains_ <= 0 && (lmm_get_variable_weight(getVariable()) > 0)) ||
507 ((maxDuration_ > NO_MAX_DURATION) && (maxDuration_ <= 0))) {
509 setState(Action::State::done);
510 heapRemove(getModel()->getActionHeap());
514 lastValue_ = lmm_variable_getvalue(getVariable());
517 void NetworkCm02Link::gapAppend(double size, const LinkImpl* link, NetworkAction* action){