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 "network_cm02.hpp"
10 #include "maxmin_private.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 surf_network_model = new simgrid::surf::NetworkCm02Model();
69 all_existing_models->push_back(surf_network_model);
71 xbt_cfg_setdefault_double("network/latency-factor", 1.0);
72 xbt_cfg_setdefault_double("network/bandwidth-factor", 1.0);
73 xbt_cfg_setdefault_double("network/weight-S", 0.0);
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 surf_network_model = new simgrid::surf::NetworkCm02Model(lagrange_solve);
92 all_existing_models->push_back(surf_network_model);
94 lmm_set_default_protocol_function(func_reno_f, func_reno_fp, func_reno_fpi);
96 xbt_cfg_setdefault_double("network/latency-factor", 10.4);
97 xbt_cfg_setdefault_double("network/bandwidth-factor", 0.92);
98 xbt_cfg_setdefault_double("network/weight-S", 8775);
102 void surf_network_model_init_Reno2()
104 if (surf_network_model)
107 surf_network_model = new simgrid::surf::NetworkCm02Model(lagrange_solve);
108 all_existing_models->push_back(surf_network_model);
110 lmm_set_default_protocol_function(func_reno2_f, func_reno2_fp, func_reno2_fpi);
112 xbt_cfg_setdefault_double("network/latency-factor", 10.4);
113 xbt_cfg_setdefault_double("network/bandwidth-factor", 0.92);
114 xbt_cfg_setdefault_double("network/weight-S", 8775);
117 void surf_network_model_init_Vegas()
119 if (surf_network_model)
122 surf_network_model = new simgrid::surf::NetworkCm02Model(lagrange_solve);
123 all_existing_models->push_back(surf_network_model);
125 lmm_set_default_protocol_function(func_vegas_f, func_vegas_fp, func_vegas_fpi);
127 xbt_cfg_setdefault_double("network/latency-factor", 10.4);
128 xbt_cfg_setdefault_double("network/bandwidth-factor", 0.92);
129 xbt_cfg_setdefault_double("network/weight-S", 8775);
135 NetworkCm02Model::NetworkCm02Model()
138 char *optim = xbt_cfg_get_string("network/optim");
139 int select = xbt_cfg_get_boolean("network/maxmin-selective-update");
141 if (!strcmp(optim, "Full")) {
142 updateMechanism_ = UM_FULL;
143 selectiveUpdate_ = select;
144 } else if (!strcmp(optim, "Lazy")) {
145 updateMechanism_ = UM_LAZY;
146 selectiveUpdate_ = 1;
147 xbt_assert((select == 1) || (xbt_cfg_is_default_value("network/maxmin-selective-update")),
148 "You cannot disable selective update while using the lazy update mechanism!");
150 xbt_die("Unsupported optimization (%s) for this model. Accepted: Full, Lazy.", optim);
154 maxminSystem_ = lmm_system_new(selectiveUpdate_);
156 routing_model_create(createLink("__loopback__", 498000000, 0.000015, SURF_LINK_FATPIPE, nullptr));
158 if (updateMechanism_ == UM_LAZY) {
159 actionHeap_ = xbt_heap_new(8, nullptr);
160 xbt_heap_set_update_callback(actionHeap_, surf_action_lmm_update_index_heap);
161 modifiedSet_ = new ActionLmmList();
162 maxminSystem_->keep_track = modifiedSet_;
165 NetworkCm02Model::NetworkCm02Model(void (*specificSolveFun)(lmm_system_t self))
168 maxminSystem_->solve_fun = specificSolveFun;
172 NetworkCm02Model::~NetworkCm02Model() {}
174 Link* NetworkCm02Model::createLink(const char *name, double bandwidth, double latency, e_surf_link_sharing_policy_t policy,
175 xbt_dict_t properties)
177 return new NetworkCm02Link(this, name, properties, bandwidth, latency, policy, maxminSystem_);
180 void NetworkCm02Model::updateActionsStateLazy(double now, double /*delta*/)
182 while ((xbt_heap_size(actionHeap_) > 0)
183 && (double_equals(xbt_heap_maxkey(actionHeap_), now, sg_surf_precision))) {
185 NetworkCm02Action *action = static_cast<NetworkCm02Action*> (xbt_heap_pop(actionHeap_));
186 XBT_DEBUG("Something happened to action %p", action);
187 if (TRACE_is_enabled()) {
188 int n = lmm_get_number_of_cnst_from_var(maxminSystem_, action->getVariable());
190 for (int i = 0; i < n; i++){
191 lmm_constraint_t constraint = lmm_get_cnst_from_var(maxminSystem_, action->getVariable(), i);
192 NetworkCm02Link *link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
193 double value = lmm_variable_getvalue(action->getVariable())*
194 lmm_get_cnst_weight_from_var(maxminSystem_, action->getVariable(), i);
195 TRACE_surf_link_set_utilization(link->getName(), action->getCategory(), value,
196 action->getLastUpdate(), now - action->getLastUpdate());
200 // if I am wearing a latency hat
201 if (action->getHat() == LATENCY) {
202 XBT_DEBUG("Latency paid for action %p. Activating", action);
203 lmm_update_variable_weight(maxminSystem_, action->getVariable(), action->weight_);
204 action->heapRemove(actionHeap_);
205 action->refreshLastUpdate();
207 // if I am wearing a max_duration or normal hat
208 } else if (action->getHat() == MAX_DURATION || action->getHat() == NORMAL) {
209 // no need to communicate anymore
210 // assume that flows that reached max_duration have remaining of 0
211 XBT_DEBUG("Action %p finished", action);
212 action->setRemains(0);
214 action->setState(Action::State::done);
215 action->heapRemove(actionHeap_);
224 void NetworkCm02Model::updateActionsStateFull(double now, double delta)
226 ActionList *running_actions = getRunningActionSet();
228 for(ActionList::iterator it(running_actions->begin()), itNext=it, itend(running_actions->end())
229 ; it != itend ; it=itNext) {
232 NetworkCm02Action *action = static_cast<NetworkCm02Action*> (&*it);
233 XBT_DEBUG("Something happened to action %p", action);
234 double deltap = delta;
235 if (action->latency_ > 0) {
236 if (action->latency_ > deltap) {
237 double_update(&(action->latency_), deltap, sg_surf_precision);
240 double_update(&(deltap), action->latency_, sg_surf_precision);
241 action->latency_ = 0.0;
243 if (action->latency_ == 0.0 && !(action->isSuspended()))
244 lmm_update_variable_weight(maxminSystem_, action->getVariable(),
247 if (TRACE_is_enabled()) {
248 int n = lmm_get_number_of_cnst_from_var(maxminSystem_, action->getVariable());
249 for (int i = 0; i < n; i++){
250 lmm_constraint_t constraint = lmm_get_cnst_from_var(maxminSystem_, action->getVariable(), i);
252 NetworkCm02Link* link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
253 TRACE_surf_link_set_utilization(link->getName(),
254 action->getCategory(),
255 (lmm_variable_getvalue(action->getVariable())*
256 lmm_get_cnst_weight_from_var(maxminSystem_,
257 action->getVariable(),
259 action->getLastUpdate(),
260 now - action->getLastUpdate());
263 if (!lmm_get_number_of_cnst_from_var (maxminSystem_, action->getVariable())) {
264 /* There is actually no link used, hence an infinite bandwidth.
265 * This happens often when using models like vivaldi.
266 * In such case, just make sure that the action completes immediately.
268 action->updateRemains(action->getRemains());
270 action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
272 if (action->getMaxDuration() != NO_MAX_DURATION)
273 action->updateMaxDuration(delta);
275 if ((action->getRemains() <= 0) &&
276 (lmm_get_variable_weight(action->getVariable()) > 0)) {
278 action->setState(Action::State::done);
280 } else if (((action->getMaxDuration() != NO_MAX_DURATION)
281 && (action->getMaxDuration() <= 0))) {
283 action->setState(Action::State::done);
289 Action *NetworkCm02Model::communicate(kernel::routing::NetCard *src, kernel::routing::NetCard *dst,
290 double size, double rate)
293 double bandwidth_bound;
294 double latency = 0.0;
295 std::vector<Link*> * back_route = nullptr;
296 int constraints_per_variable = 0;
298 std::vector<Link*> *route = new std::vector<Link*>();
300 XBT_IN("(%s,%s,%g,%g)", src->name(), dst->name(), size, rate);
302 routing_platf->getRouteAndLatency(src, dst, route, &latency);
303 xbt_assert(! route->empty() || latency,
304 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
305 src->name(), dst->name());
307 for (auto link: *route)
311 if (sg_network_crosstraffic == 1) {
312 back_route = new std::vector<Link*>();
313 routing_platf->getRouteAndLatency(dst, src, back_route, nullptr);
314 for (auto link: *back_route)
319 NetworkCm02Action *action = new NetworkCm02Action(this, size, failed);
320 action->weight_ = action->latency_ = latency;
322 action->rate_ = rate;
323 if (updateMechanism_ == UM_LAZY) {
324 action->indexHeap_ = -1;
325 action->lastUpdate_ = surf_get_clock();
328 bandwidth_bound = -1.0;
329 if (sg_weight_S_parameter > 0)
330 for (auto link : *route)
331 action->weight_ += sg_weight_S_parameter / link->getBandwidth();
333 for (auto link : *route) {
334 double bb = bandwidthFactor(size) * link->getBandwidth();
335 bandwidth_bound = (bandwidth_bound < 0.0) ? bb : std::min(bandwidth_bound, bb);
338 action->latCurrent_ = action->latency_;
339 action->latency_ *= latencyFactor(size);
340 action->rate_ = bandwidthConstraint(action->rate_, bandwidth_bound, size);
342 xbt_assert(! route->empty(),
343 "Using a model with a gap (e.g., SMPI) with a platform without links (e.g. vivaldi)!!!");
345 gapAppend(size, route->at(0), action);
346 XBT_DEBUG("Comm %p: %s -> %s gap=%f (lat=%f)", action, src->name(), dst->name(), action->senderGap_, action->latency_);
349 constraints_per_variable = route->size();
350 if (back_route != nullptr)
351 constraints_per_variable += back_route->size();
353 if (action->latency_ > 0) {
354 action->variable_ = lmm_variable_new(maxminSystem_, action, 0.0, -1.0, constraints_per_variable);
355 if (updateMechanism_ == UM_LAZY) {
356 // add to the heap the event when the latency is payed
357 XBT_DEBUG("Added action (%p) one latency event at date %f", action, action->latency_ + action->lastUpdate_);
358 action->heapInsert(actionHeap_, action->latency_ + action->lastUpdate_, route->empty() ? NORMAL : LATENCY);
361 action->variable_ = lmm_variable_new(maxminSystem_, action, 1.0, -1.0, constraints_per_variable);
363 if (action->rate_ < 0) {
364 lmm_update_variable_bound(maxminSystem_, action->getVariable(), (action->latCurrent_ > 0) ? sg_tcp_gamma / (2.0 * action->latCurrent_) : -1.0);
366 lmm_update_variable_bound(maxminSystem_, action->getVariable(), (action->latCurrent_ > 0) ? std::min(action->rate_, sg_tcp_gamma / (2.0 * action->latCurrent_)) : action->rate_);
369 for (auto link: *route)
370 lmm_expand(maxminSystem_, link->getConstraint(), action->getVariable(), 1.0);
372 if (sg_network_crosstraffic == 1) {
373 XBT_DEBUG("Fullduplex active adding backward flow using 5%%");
374 for (auto link : *back_route)
375 lmm_expand(maxminSystem_, link->getConstraint(), action->getVariable(), .05);
377 //Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
378 //(You would also have to change lmm_element_concurrency())
379 //lmm_variable_concurrency_share_set(action->getVariable(),2);
386 Link::onCommunicate(action, src, dst);
390 bool NetworkCm02Model::next_occuring_event_isIdempotent()
395 void NetworkCm02Model::gapAppend(double size, const Link* link, NetworkAction* action)
403 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model *model, const char *name, xbt_dict_t props,
404 double bandwidth, double latency, e_surf_link_sharing_policy_t policy,
406 : Link(model, name, props, lmm_constraint_new(system, this, sg_bandwidth_factor * bandwidth))
408 m_bandwidth.scale = 1.0;
409 m_bandwidth.peak = bandwidth;
411 m_latency.scale = 1.0;
412 m_latency.peak = latency;
414 if (policy == SURF_LINK_FATPIPE)
415 lmm_constraint_shared(getConstraint());
417 Link::onCreation(this);
422 void NetworkCm02Link::apply_event(tmgr_trace_iterator_t triggered, double value)
425 /* Find out which of my iterators was triggered, and react accordingly */
426 if (triggered == m_bandwidth.event) {
427 updateBandwidth(value);
428 tmgr_trace_event_unref(&m_bandwidth.event);
430 } else if (triggered == m_latency.event) {
431 updateLatency(value);
432 tmgr_trace_event_unref(&m_latency.event);
434 } else if (triggered == m_stateEvent) {
438 lmm_variable_t var = nullptr;
439 lmm_element_t elem = nullptr;
440 double now = surf_get_clock();
443 while ((var = lmm_get_var_from_cnst(getModel()->getMaxminSystem(), getConstraint(), &elem))) {
444 Action *action = static_cast<Action*>( lmm_variable_id(var) );
446 if (action->getState() == Action::State::running ||
447 action->getState() == Action::State::ready) {
448 action->setFinishTime(now);
449 action->setState(Action::State::failed);
453 tmgr_trace_event_unref(&m_stateEvent);
455 xbt_die("Unknown event!\n");
458 XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
462 void NetworkCm02Link::updateBandwidth(double value) {
464 m_bandwidth.peak = value;
466 lmm_update_constraint_bound(getModel()->getMaxminSystem(), getConstraint(),
467 sg_bandwidth_factor * (m_bandwidth.peak * m_bandwidth.scale));
468 TRACE_surf_link_set_bandwidth(surf_get_clock(), getName(), sg_bandwidth_factor * m_bandwidth.peak * m_bandwidth.scale);
470 if (sg_weight_S_parameter > 0) {
471 double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (m_bandwidth.peak * m_bandwidth.scale);
474 lmm_element_t elem = nullptr, nextelem = nullptr;
476 while ((var = lmm_get_var_from_cnst_safe(getModel()->getMaxminSystem(), getConstraint(), &elem, &nextelem, &numelem))) {
477 NetworkCm02Action *action = (NetworkCm02Action*) lmm_variable_id(var);
478 action->weight_ += delta;
479 if (!action->isSuspended())
480 lmm_update_variable_weight(getModel()->getMaxminSystem(), action->getVariable(), action->weight_);
485 void NetworkCm02Link::updateLatency(double value){
486 double delta = value - m_latency.peak;
487 lmm_variable_t var = nullptr;
488 lmm_element_t elem = nullptr;
489 lmm_element_t nextelem = nullptr;
492 m_latency.peak = value;
494 while ((var = lmm_get_var_from_cnst_safe(getModel()->getMaxminSystem(), getConstraint(), &elem, &nextelem, &numelem))) {
495 NetworkCm02Action *action = (NetworkCm02Action*) lmm_variable_id(var);
496 action->latCurrent_ += delta;
497 action->weight_ += delta;
498 if (action->rate_ < 0)
499 lmm_update_variable_bound(getModel()->getMaxminSystem(), action->getVariable(), sg_tcp_gamma / (2.0 * action->latCurrent_));
501 lmm_update_variable_bound(getModel()->getMaxminSystem(), action->getVariable(),
502 std::min(action->rate_, sg_tcp_gamma / (2.0 * action->latCurrent_)));
504 if (action->rate_ < sg_tcp_gamma / (2.0 * action->latCurrent_)) {
505 XBT_INFO("Flow is limited BYBANDWIDTH");
507 XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->latCurrent_);
510 if (!action->isSuspended())
511 lmm_update_variable_weight(getModel()->getMaxminSystem(), action->getVariable(), action->weight_);
515 NetworkCm02Link::~NetworkCm02Link() {}
521 NetworkCm02Action::~NetworkCm02Action() {}
523 void NetworkCm02Action::updateRemainingLazy(double now)
530 delta = now - lastUpdate_;
533 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, remains_, lastUpdate_);
534 double_update(&(remains_), lastValue_ * delta, sg_maxmin_precision*sg_surf_precision);
536 XBT_DEBUG("Updating action(%p): remains is now %f", this, remains_);
539 if (maxDuration_ != NO_MAX_DURATION)
540 double_update(&maxDuration_, delta, sg_surf_precision);
543 (lmm_get_variable_weight(getVariable()) > 0)) {
545 setState(Action::State::done);
547 heapRemove(getModel()->getActionHeap());
548 } else if (((maxDuration_ != NO_MAX_DURATION)
549 && (maxDuration_ <= 0))) {
551 setState(Action::State::done);
552 heapRemove(getModel()->getActionHeap());
556 lastValue_ = lmm_variable_getvalue(getVariable());
559 void NetworkCm02Link::gapAppend(double size, const Link* link, NetworkAction* action)