1 /* Copyright (c) 2013-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include "maxmin_private.hpp"
10 #include "network_cm02.hpp"
11 #include "simgrid/s4u/host.hpp"
12 #include "simgrid/sg_config.h"
13 #include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
15 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_network);
17 double sg_sender_gap = 0.0;
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 double sg_tcp_gamma = 0.0;
23 int sg_network_crosstraffic = 0;
25 /************************************************************************/
26 /* New model based on optimizations discussed during Pedro Velho's thesis*/
27 /************************************************************************/
28 /* @techreport{VELHO:2011:HAL-00646896:1, */
29 /* url = {http://hal.inria.fr/hal-00646896/en/}, */
30 /* title = {{Flow-level network models: have we reached the limits?}}, */
31 /* author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
32 /* type = {Rapport de recherche}, */
33 /* institution = {INRIA}, */
34 /* number = {RR-7821}, */
37 /* pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
39 void surf_network_model_init_LegrandVelho()
41 if (surf_network_model)
44 surf_network_model = new simgrid::surf::NetworkCm02Model();
45 all_existing_models->push_back(surf_network_model);
47 xbt_cfg_setdefault_double("network/latency-factor", 13.01);
48 xbt_cfg_setdefault_double("network/bandwidth-factor", 0.97);
49 xbt_cfg_setdefault_double("network/weight-S", 20537);
52 /***************************************************************************/
53 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
54 /***************************************************************************/
55 /* @TechReport{ rr-lip2002-40, */
56 /* author = {Henri Casanova and Loris Marchal}, */
57 /* institution = {LIP}, */
58 /* title = {A Network Model for Simulation of Grid Application}, */
59 /* number = {2002-40}, */
63 void surf_network_model_init_CM02()
66 if (surf_network_model)
69 surf_network_model = new simgrid::surf::NetworkCm02Model();
70 all_existing_models->push_back(surf_network_model);
72 xbt_cfg_setdefault_double("network/latency-factor", 1.0);
73 xbt_cfg_setdefault_double("network/bandwidth-factor", 1.0);
74 xbt_cfg_setdefault_double("network/weight-S", 0.0);
77 /***************************************************************************/
78 /* The models from Steven H. Low */
79 /***************************************************************************/
81 /* author={Steven H. Low}, */
82 /* title={A Duality Model of {TCP} and Queue Management Algorithms}, */
84 /* journal={{IEEE/ACM} Transactions on Networking}, */
85 /* volume={11}, number={4}, */
87 void surf_network_model_init_Reno()
89 if (surf_network_model)
92 surf_network_model = new simgrid::surf::NetworkCm02Model(lagrange_solve);
93 all_existing_models->push_back(surf_network_model);
95 lmm_set_default_protocol_function(func_reno_f, func_reno_fp, func_reno_fpi);
97 xbt_cfg_setdefault_double("network/latency-factor", 10.4);
98 xbt_cfg_setdefault_double("network/bandwidth-factor", 0.92);
99 xbt_cfg_setdefault_double("network/weight-S", 8775);
103 void surf_network_model_init_Reno2()
105 if (surf_network_model)
108 surf_network_model = new simgrid::surf::NetworkCm02Model(lagrange_solve);
109 all_existing_models->push_back(surf_network_model);
111 lmm_set_default_protocol_function(func_reno2_f, func_reno2_fp, func_reno2_fpi);
113 xbt_cfg_setdefault_double("network/latency-factor", 10.4);
114 xbt_cfg_setdefault_double("network/bandwidth-factor", 0.92);
115 xbt_cfg_setdefault_double("network/weight-S", 8775);
118 void surf_network_model_init_Vegas()
120 if (surf_network_model)
123 surf_network_model = new simgrid::surf::NetworkCm02Model(lagrange_solve);
124 all_existing_models->push_back(surf_network_model);
126 lmm_set_default_protocol_function(func_vegas_f, func_vegas_fp, func_vegas_fpi);
128 xbt_cfg_setdefault_double("network/latency-factor", 10.4);
129 xbt_cfg_setdefault_double("network/bandwidth-factor", 0.92);
130 xbt_cfg_setdefault_double("network/weight-S", 8775);
136 NetworkCm02Model::NetworkCm02Model()
139 char *optim = xbt_cfg_get_string("network/optim");
140 bool select = xbt_cfg_get_boolean("network/maxmin-selective-update");
142 if (!strcmp(optim, "Full")) {
143 updateMechanism_ = UM_FULL;
144 selectiveUpdate_ = select;
145 } else if (!strcmp(optim, "Lazy")) {
146 updateMechanism_ = UM_LAZY;
147 selectiveUpdate_ = true;
148 xbt_assert(select || (xbt_cfg_is_default_value("network/maxmin-selective-update")),
149 "You cannot disable selective update when using the lazy update mechanism");
151 xbt_die("Unsupported optimization (%s) for this model. Accepted: Full, Lazy.", optim);
154 maxminSystem_ = lmm_system_new(selectiveUpdate_);
155 loopback_ = createLink("__loopback__", 498000000, 0.000015, SURF_LINK_FATPIPE);
157 if (updateMechanism_ == UM_LAZY) {
158 actionHeap_ = xbt_heap_new(8, nullptr);
159 xbt_heap_set_update_callback(actionHeap_, surf_action_lmm_update_index_heap);
160 modifiedSet_ = new ActionLmmList();
161 maxminSystem_->keep_track = modifiedSet_;
164 NetworkCm02Model::NetworkCm02Model(void (*specificSolveFun)(lmm_system_t self))
167 maxminSystem_->solve_fun = specificSolveFun;
171 NetworkCm02Model::~NetworkCm02Model() {}
173 Link* NetworkCm02Model::createLink(const char* name, double bandwidth, double latency,
174 e_surf_link_sharing_policy_t policy)
176 return new NetworkCm02Link(this, name, bandwidth, latency, policy, maxminSystem_);
179 void NetworkCm02Model::updateActionsStateLazy(double now, double /*delta*/)
181 while ((xbt_heap_size(actionHeap_) > 0)
182 && (double_equals(xbt_heap_maxkey(actionHeap_), now, sg_surf_precision))) {
184 NetworkCm02Action *action = static_cast<NetworkCm02Action*> (xbt_heap_pop(actionHeap_));
185 XBT_DEBUG("Something happened to action %p", action);
186 if (TRACE_is_enabled()) {
187 int n = lmm_get_number_of_cnst_from_var(maxminSystem_, action->getVariable());
189 for (int i = 0; i < n; i++){
190 lmm_constraint_t constraint = lmm_get_cnst_from_var(maxminSystem_, action->getVariable(), i);
191 NetworkCm02Link *link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
192 double value = lmm_variable_getvalue(action->getVariable())*
193 lmm_get_cnst_weight_from_var(maxminSystem_, action->getVariable(), i);
194 TRACE_surf_link_set_utilization(link->getName(), action->getCategory(), value,
195 action->getLastUpdate(), now - action->getLastUpdate());
199 // if I am wearing a latency hat
200 if (action->getHat() == LATENCY) {
201 XBT_DEBUG("Latency paid for action %p. Activating", action);
202 lmm_update_variable_weight(maxminSystem_, action->getVariable(), action->weight_);
203 action->heapRemove(actionHeap_);
204 action->refreshLastUpdate();
206 // if I am wearing a max_duration or normal hat
207 } else if (action->getHat() == MAX_DURATION || action->getHat() == NORMAL) {
208 // no need to communicate anymore
209 // assume that flows that reached max_duration have remaining of 0
210 XBT_DEBUG("Action %p finished", action);
211 action->setRemains(0);
213 action->setState(Action::State::done);
214 action->heapRemove(actionHeap_);
223 void NetworkCm02Model::updateActionsStateFull(double now, double delta)
225 ActionList *running_actions = getRunningActionSet();
227 for(ActionList::iterator it(running_actions->begin()), itNext=it, itend(running_actions->end())
228 ; it != itend ; it=itNext) {
231 NetworkCm02Action *action = static_cast<NetworkCm02Action*> (&*it);
232 XBT_DEBUG("Something happened to action %p", action);
233 double deltap = delta;
234 if (action->latency_ > 0) {
235 if (action->latency_ > deltap) {
236 double_update(&(action->latency_), deltap, sg_surf_precision);
239 double_update(&(deltap), action->latency_, sg_surf_precision);
240 action->latency_ = 0.0;
242 if (action->latency_ == 0.0 && !(action->isSuspended()))
243 lmm_update_variable_weight(maxminSystem_, action->getVariable(),
246 if (TRACE_is_enabled()) {
247 int n = lmm_get_number_of_cnst_from_var(maxminSystem_, action->getVariable());
248 for (int i = 0; i < n; i++){
249 lmm_constraint_t constraint = lmm_get_cnst_from_var(maxminSystem_, action->getVariable(), i);
251 NetworkCm02Link* link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
252 TRACE_surf_link_set_utilization(link->getName(),
253 action->getCategory(),
254 (lmm_variable_getvalue(action->getVariable())*
255 lmm_get_cnst_weight_from_var(maxminSystem_,
256 action->getVariable(),
258 action->getLastUpdate(),
259 now - action->getLastUpdate());
262 if (!lmm_get_number_of_cnst_from_var (maxminSystem_, action->getVariable())) {
263 /* There is actually no link used, hence an infinite bandwidth.
264 * This happens often when using models like vivaldi.
265 * In such case, just make sure that the action completes immediately.
267 action->updateRemains(action->getRemains());
269 action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
271 if (action->getMaxDuration() != NO_MAX_DURATION)
272 action->updateMaxDuration(delta);
274 if ((action->getRemains() <= 0) &&
275 (lmm_get_variable_weight(action->getVariable()) > 0)) {
277 action->setState(Action::State::done);
279 } else if (((action->getMaxDuration() != NO_MAX_DURATION)
280 && (action->getMaxDuration() <= 0))) {
282 action->setState(Action::State::done);
288 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
291 double bandwidth_bound;
292 double latency = 0.0;
293 std::vector<Link*> * back_route = nullptr;
294 int constraints_per_variable = 0;
296 std::vector<Link*> *route = new std::vector<Link*>();
298 XBT_IN("(%s,%s,%g,%g)", src->name().c_str(), dst->name().c_str(), size, rate);
300 routing_platf->getRouteAndLatency(src->pimpl_netcard, dst->pimpl_netcard, route, &latency);
301 xbt_assert(!route->empty() || latency,
302 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
303 src->name().c_str(), dst->name().c_str());
305 for (auto link: *route)
309 if (sg_network_crosstraffic == 1) {
310 back_route = new std::vector<Link*>();
311 routing_platf->getRouteAndLatency(dst->pimpl_netcard, src->pimpl_netcard, back_route, nullptr);
312 for (auto link: *back_route)
317 NetworkCm02Action *action = new NetworkCm02Action(this, size, failed);
318 action->weight_ = action->latency_ = latency;
320 action->rate_ = rate;
321 if (updateMechanism_ == UM_LAZY) {
322 action->indexHeap_ = -1;
323 action->lastUpdate_ = surf_get_clock();
326 bandwidth_bound = -1.0;
327 if (sg_weight_S_parameter > 0)
328 for (auto link : *route)
329 action->weight_ += sg_weight_S_parameter / link->bandwidth();
331 for (auto link : *route) {
332 double bb = bandwidthFactor(size) * link->bandwidth();
333 bandwidth_bound = (bandwidth_bound < 0.0) ? bb : std::min(bandwidth_bound, bb);
336 action->latCurrent_ = action->latency_;
337 action->latency_ *= latencyFactor(size);
338 action->rate_ = bandwidthConstraint(action->rate_, bandwidth_bound, size);
340 xbt_assert(! route->empty(),
341 "Using a model with a gap (e.g., SMPI) with a platform without links (e.g. vivaldi)!!!");
343 gapAppend(size, route->at(0), action);
344 XBT_DEBUG("Comm %p: %s -> %s gap=%f (lat=%f)", action, src->name().c_str(), dst->name().c_str(), action->senderGap_,
348 constraints_per_variable = route->size();
349 if (back_route != nullptr)
350 constraints_per_variable += back_route->size();
352 if (action->latency_ > 0) {
353 action->variable_ = lmm_variable_new(maxminSystem_, action, 0.0, -1.0, constraints_per_variable);
354 if (updateMechanism_ == UM_LAZY) {
355 // add to the heap the event when the latency is payed
356 XBT_DEBUG("Added action (%p) one latency event at date %f", action, action->latency_ + action->lastUpdate_);
357 action->heapInsert(actionHeap_, action->latency_ + action->lastUpdate_, route->empty() ? NORMAL : LATENCY);
360 action->variable_ = lmm_variable_new(maxminSystem_, action, 1.0, -1.0, constraints_per_variable);
362 if (action->rate_ < 0) {
363 lmm_update_variable_bound(maxminSystem_, action->getVariable(), (action->latCurrent_ > 0) ? sg_tcp_gamma / (2.0 * action->latCurrent_) : -1.0);
365 lmm_update_variable_bound(maxminSystem_, action->getVariable(), (action->latCurrent_ > 0) ? std::min(action->rate_, sg_tcp_gamma / (2.0 * action->latCurrent_)) : action->rate_);
368 for (auto link: *route)
369 lmm_expand(maxminSystem_, link->getConstraint(), action->getVariable(), 1.0);
371 if (sg_network_crosstraffic == 1) {
372 XBT_DEBUG("Fullduplex active adding backward flow using 5%%");
373 for (auto link : *back_route)
374 lmm_expand(maxminSystem_, link->getConstraint(), action->getVariable(), .05);
376 //Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
377 //(You would also have to change lmm_element_concurrency())
378 //lmm_variable_concurrency_share_set(action->getVariable(),2);
385 Link::onCommunicate(action, src, dst);
389 void NetworkCm02Model::gapAppend(double size, const Link* link, NetworkAction* action)
397 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model* model, const char* name, double bandwidth, double latency,
398 e_surf_link_sharing_policy_t policy, lmm_system_t system)
399 : Link(model, name, lmm_constraint_new(system, this, sg_bandwidth_factor * bandwidth))
401 bandwidth_.scale = 1.0;
402 bandwidth_.peak = bandwidth;
404 latency_.scale = 1.0;
405 latency_.peak = latency;
407 if (policy == SURF_LINK_FATPIPE)
408 lmm_constraint_shared(getConstraint());
410 Link::onCreation(this);
415 void NetworkCm02Link::apply_event(tmgr_trace_iterator_t triggered, double value)
418 /* Find out which of my iterators was triggered, and react accordingly */
419 if (triggered == bandwidth_.event) {
421 tmgr_trace_event_unref(&bandwidth_.event);
423 } else if (triggered == latency_.event) {
425 tmgr_trace_event_unref(&latency_.event);
427 } else if (triggered == stateEvent_) {
431 lmm_variable_t var = nullptr;
432 lmm_element_t elem = nullptr;
433 double now = surf_get_clock();
436 while ((var = lmm_get_var_from_cnst(getModel()->getMaxminSystem(), getConstraint(), &elem))) {
437 Action *action = static_cast<Action*>( lmm_variable_id(var) );
439 if (action->getState() == Action::State::running ||
440 action->getState() == Action::State::ready) {
441 action->setFinishTime(now);
442 action->setState(Action::State::failed);
446 tmgr_trace_event_unref(&stateEvent_);
448 xbt_die("Unknown event!\n");
451 XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
455 void NetworkCm02Link::setBandwidth(double value)
458 bandwidth_.peak = value;
460 lmm_update_constraint_bound(getModel()->getMaxminSystem(), getConstraint(),
461 sg_bandwidth_factor * (bandwidth_.peak * bandwidth_.scale));
462 TRACE_surf_link_set_bandwidth(surf_get_clock(), getName(), sg_bandwidth_factor * bandwidth_.peak * bandwidth_.scale);
464 if (sg_weight_S_parameter > 0) {
465 double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale);
468 lmm_element_t elem = nullptr, nextelem = nullptr;
470 while ((var = lmm_get_var_from_cnst_safe(getModel()->getMaxminSystem(), getConstraint(), &elem, &nextelem, &numelem))) {
471 NetworkCm02Action *action = (NetworkCm02Action*) lmm_variable_id(var);
472 action->weight_ += delta;
473 if (!action->isSuspended())
474 lmm_update_variable_weight(getModel()->getMaxminSystem(), action->getVariable(), action->weight_);
479 void NetworkCm02Link::setLatency(double value)
481 double delta = value - latency_.peak;
482 lmm_variable_t var = nullptr;
483 lmm_element_t elem = nullptr;
484 lmm_element_t nextelem = nullptr;
487 latency_.peak = value;
489 while ((var = lmm_get_var_from_cnst_safe(getModel()->getMaxminSystem(), getConstraint(), &elem, &nextelem, &numelem))) {
490 NetworkCm02Action *action = (NetworkCm02Action*) lmm_variable_id(var);
491 action->latCurrent_ += delta;
492 action->weight_ += delta;
493 if (action->rate_ < 0)
494 lmm_update_variable_bound(getModel()->getMaxminSystem(), action->getVariable(), sg_tcp_gamma / (2.0 * action->latCurrent_));
496 lmm_update_variable_bound(getModel()->getMaxminSystem(), action->getVariable(),
497 std::min(action->rate_, sg_tcp_gamma / (2.0 * action->latCurrent_)));
499 if (action->rate_ < sg_tcp_gamma / (2.0 * action->latCurrent_)) {
500 XBT_INFO("Flow is limited BYBANDWIDTH");
502 XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->latCurrent_);
505 if (!action->isSuspended())
506 lmm_update_variable_weight(getModel()->getMaxminSystem(), action->getVariable(), action->weight_);
510 NetworkCm02Link::~NetworkCm02Link() {}
516 NetworkCm02Action::~NetworkCm02Action() {}
518 void NetworkCm02Action::updateRemainingLazy(double now)
525 delta = now - lastUpdate_;
528 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, remains_, lastUpdate_);
529 double_update(&(remains_), lastValue_ * delta, sg_maxmin_precision*sg_surf_precision);
531 XBT_DEBUG("Updating action(%p): remains is now %f", this, remains_);
534 if (maxDuration_ != NO_MAX_DURATION)
535 double_update(&maxDuration_, delta, sg_surf_precision);
538 (lmm_get_variable_weight(getVariable()) > 0)) {
540 setState(Action::State::done);
542 heapRemove(getModel()->getActionHeap());
543 } else if (((maxDuration_ != NO_MAX_DURATION)
544 && (maxDuration_ <= 0))) {
546 setState(Action::State::done);
547 heapRemove(getModel()->getActionHeap());
551 lastValue_ = lmm_variable_getvalue(getVariable());
554 void NetworkCm02Link::gapAppend(double size, const Link* link, NetworkAction* action)