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"
13 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_network);
15 double sg_sender_gap = 0.0;
16 double sg_latency_factor = 1.0; /* default value; can be set by model or from command line */
17 double sg_bandwidth_factor = 1.0; /* default value; can be set by model or from command line */
18 double sg_weight_S_parameter = 0.0; /* default value; can be set by model or from command line */
20 double sg_tcp_gamma = 0.0;
21 int sg_network_crosstraffic = 0;
27 void net_define_callbacks(void)
29 /* Figuring out the network links */
30 simgrid::surf::on_link.connect(netlink_parse_init);
37 /************************************************************************/
38 /* New model based on optimizations discussed during Pedro Velho's thesis*/
39 /************************************************************************/
40 /* @techreport{VELHO:2011:HAL-00646896:1, */
41 /* url = {http://hal.inria.fr/hal-00646896/en/}, */
42 /* title = {{Flow-level network models: have we reached the limits?}}, */
43 /* author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
44 /* type = {Rapport de recherche}, */
45 /* institution = {INRIA}, */
46 /* number = {RR-7821}, */
49 /* pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
51 void surf_network_model_init_LegrandVelho(void)
53 if (surf_network_model)
56 surf_network_model = new simgrid::surf::NetworkCm02Model();
57 net_define_callbacks();
58 simgrid::surf::Model *model = surf_network_model;
59 xbt_dynar_push(all_existing_models, &model);
61 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor",
63 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor",
65 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 20537);
68 /***************************************************************************/
69 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
70 /***************************************************************************/
71 /* @TechReport{ rr-lip2002-40, */
72 /* author = {Henri Casanova and Loris Marchal}, */
73 /* institution = {LIP}, */
74 /* title = {A Network Model for Simulation of Grid Application}, */
75 /* number = {2002-40}, */
79 void surf_network_model_init_CM02(void)
82 if (surf_network_model)
85 surf_network_model = new simgrid::surf::NetworkCm02Model();
86 xbt_dynar_push(all_existing_models, &surf_network_model);
87 net_define_callbacks();
89 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
90 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
91 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 0.0);
94 /***************************************************************************/
95 /* The models from Steven H. Low */
96 /***************************************************************************/
98 /* author={Steven H. Low}, */
99 /* title={A Duality Model of {TCP} and Queue Management Algorithms}, */
101 /* journal={{IEEE/ACM} Transactions on Networking}, */
102 /* volume={11}, number={4}, */
104 void surf_network_model_init_Reno(void)
106 if (surf_network_model)
109 surf_network_model = new simgrid::surf::NetworkCm02Model();
110 xbt_dynar_push(all_existing_models, &surf_network_model);
111 net_define_callbacks();
112 lmm_set_default_protocol_function(func_reno_f, func_reno_fp, func_reno_fpi);
113 surf_network_model->f_networkSolve = lagrange_solve;
115 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 10.4);
116 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 0.92);
117 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 8775);
121 void surf_network_model_init_Reno2(void)
123 if (surf_network_model)
126 surf_network_model = new simgrid::surf::NetworkCm02Model();
127 xbt_dynar_push(all_existing_models, &surf_network_model);
128 net_define_callbacks();
129 lmm_set_default_protocol_function(func_reno2_f, func_reno2_fp, func_reno2_fpi);
130 surf_network_model->f_networkSolve = lagrange_solve;
132 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 10.4);
133 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 0.92);
134 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 8775);
137 void surf_network_model_init_Vegas(void)
139 if (surf_network_model)
142 surf_network_model = new simgrid::surf::NetworkCm02Model();
143 xbt_dynar_push(all_existing_models, &surf_network_model);
144 net_define_callbacks();
145 lmm_set_default_protocol_function(func_vegas_f, func_vegas_fp, func_vegas_fpi);
146 surf_network_model->f_networkSolve = lagrange_solve;
148 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 10.4);
149 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 0.92);
150 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 8775);
156 NetworkCm02Model::NetworkCm02Model()
159 char *optim = xbt_cfg_get_string(_sg_cfg_set, "network/optim");
160 int select = xbt_cfg_get_boolean(_sg_cfg_set, "network/maxmin_selective_update");
162 if (!strcmp(optim, "Full")) {
163 p_updateMechanism = UM_FULL;
164 m_selectiveUpdate = select;
165 } else if (!strcmp(optim, "Lazy")) {
166 p_updateMechanism = UM_LAZY;
167 m_selectiveUpdate = 1;
168 xbt_assert((select == 1) || (xbt_cfg_is_default_value(_sg_cfg_set, "network/maxmin_selective_update")),
169 "Disabling selective update while using the lazy update mechanism is dumb!");
171 xbt_die("Unsupported optimization (%s) for this model", optim);
175 p_maxminSystem = lmm_system_new(m_selectiveUpdate);
177 routing_model_create(createLink("__loopback__",
178 498000000, NULL, 0.000015, NULL,
179 1 /*SURF_RESOURCE_ON*/, NULL,
180 SURF_LINK_FATPIPE, NULL));
182 if (p_updateMechanism == UM_LAZY) {
183 p_actionHeap = xbt_heap_new(8, NULL);
184 xbt_heap_set_update_callback(p_actionHeap, surf_action_lmm_update_index_heap);
185 p_modifiedSet = new ActionLmmList();
186 p_maxminSystem->keep_track = p_modifiedSet;
190 Link* NetworkCm02Model::createLink(const char *name,
192 tmgr_trace_t bw_trace,
194 tmgr_trace_t lat_trace,
196 tmgr_trace_t state_trace,
197 e_surf_link_sharing_policy_t policy,
198 xbt_dict_t properties)
200 xbt_assert(NULL == Link::byName(name),
201 "Link '%s' declared several times in the platform",
204 Link* link = new NetworkCm02Link(this, name, properties, p_maxminSystem, sg_bandwidth_factor * bw_initial,
205 initiallyOn, state_trace, bw_initial, bw_trace, lat_initial, lat_trace, policy);
206 Link::onCreation(link);
210 void NetworkCm02Model::updateActionsStateLazy(double now, double /*delta*/)
212 NetworkCm02Action *action;
213 while ((xbt_heap_size(p_actionHeap) > 0)
214 && (double_equals(xbt_heap_maxkey(p_actionHeap), now, sg_surf_precision))) {
215 action = static_cast<NetworkCm02Action*> (xbt_heap_pop(p_actionHeap));
216 XBT_DEBUG("Something happened to action %p", action);
217 if (TRACE_is_enabled()) {
218 int n = lmm_get_number_of_cnst_from_var(p_maxminSystem, action->getVariable());
220 for (i = 0; i < n; i++){
221 lmm_constraint_t constraint = lmm_get_cnst_from_var(p_maxminSystem,
222 action->getVariable(),
224 NetworkCm02Link *link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
225 TRACE_surf_link_set_utilization(link->getName(),
226 action->getCategory(),
227 (lmm_variable_getvalue(action->getVariable())*
228 lmm_get_cnst_weight_from_var(p_maxminSystem,
229 action->getVariable(),
231 action->getLastUpdate(),
232 now - action->getLastUpdate());
236 // if I am wearing a latency hat
237 if (action->getHat() == LATENCY) {
238 XBT_DEBUG("Latency paid for action %p. Activating", action);
239 lmm_update_variable_weight(p_maxminSystem, action->getVariable(), action->m_weight);
240 action->heapRemove(p_actionHeap);
241 action->refreshLastUpdate();
243 // if I am wearing a max_duration or normal hat
244 } else if (action->getHat() == MAX_DURATION ||
245 action->getHat() == NORMAL) {
246 // no need to communicate anymore
247 // assume that flows that reached max_duration have remaining of 0
248 XBT_DEBUG("Action %p finished", action);
249 action->setRemains(0);
251 action->setState(SURF_ACTION_DONE);
252 action->heapRemove(p_actionHeap);
261 void NetworkCm02Model::updateActionsStateFull(double now, double delta)
263 NetworkCm02Action *action;
264 ActionList *running_actions = getRunningActionSet();
266 for(ActionList::iterator it(running_actions->begin()), itNext=it, itend(running_actions->end())
267 ; it != itend ; it=itNext) {
270 action = static_cast<NetworkCm02Action*> (&*it);
271 XBT_DEBUG("Something happened to action %p", action);
272 double deltap = delta;
273 if (action->m_latency > 0) {
274 if (action->m_latency > deltap) {
275 double_update(&(action->m_latency), deltap, sg_surf_precision);
278 double_update(&(deltap), action->m_latency, sg_surf_precision);
279 action->m_latency = 0.0;
281 if (action->m_latency == 0.0 && !(action->isSuspended()))
282 lmm_update_variable_weight(p_maxminSystem, action->getVariable(),
285 if (TRACE_is_enabled()) {
286 int n = lmm_get_number_of_cnst_from_var(p_maxminSystem, action->getVariable());
288 for (i = 0; i < n; i++){
289 lmm_constraint_t constraint = lmm_get_cnst_from_var(p_maxminSystem,
290 action->getVariable(),
292 NetworkCm02Link* link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
293 TRACE_surf_link_set_utilization(link->getName(),
294 action->getCategory(),
295 (lmm_variable_getvalue(action->getVariable())*
296 lmm_get_cnst_weight_from_var(p_maxminSystem,
297 action->getVariable(),
299 action->getLastUpdate(),
300 now - action->getLastUpdate());
303 if (!lmm_get_number_of_cnst_from_var
304 (p_maxminSystem, action->getVariable())) {
305 /* There is actually no link used, hence an infinite bandwidth.
306 * This happens often when using models like vivaldi.
307 * In such case, just make sure that the action completes immediately.
309 action->updateRemains(action->getRemains());
311 action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
313 if (action->getMaxDuration() != NO_MAX_DURATION)
314 action->updateMaxDuration(delta);
316 if ((action->getRemains() <= 0) &&
317 (lmm_get_variable_weight(action->getVariable()) > 0)) {
319 action->setState(SURF_ACTION_DONE);
321 } else if (((action->getMaxDuration() != NO_MAX_DURATION)
322 && (action->getMaxDuration() <= 0))) {
324 action->setState(SURF_ACTION_DONE);
331 Action *NetworkCm02Model::communicate(NetCard *src, NetCard *dst,
332 double size, double rate)
336 NetworkCm02Link *link;
338 NetworkCm02Action *action = NULL;
339 double bandwidth_bound;
340 double latency = 0.0;
341 xbt_dynar_t back_route = NULL;
342 int constraints_per_variable = 0;
344 xbt_dynar_t route = xbt_dynar_new(sizeof(NetCard*), NULL);
346 XBT_IN("(%s,%s,%g,%g)", src->name(), dst->name(), size, rate);
348 routing_platf->getRouteAndLatency(src, dst, &route, &latency);
349 xbt_assert(!xbt_dynar_is_empty(route) || latency,
350 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
351 src->name(), dst->name());
353 xbt_dynar_foreach(route, i, _link) {
354 link = static_cast<NetworkCm02Link*>(_link);
360 if (sg_network_crosstraffic == 1) {
361 routing_platf->getRouteAndLatency(dst, src, &back_route, NULL);
362 xbt_dynar_foreach(back_route, i, _link) {
363 link = static_cast<NetworkCm02Link*>(_link);
371 action = new NetworkCm02Action(this, size, failed);
373 #ifdef HAVE_LATENCY_BOUND_TRACKING
374 action->m_latencyLimited = 0;
376 action->m_weight = action->m_latency = latency;
378 action->m_rate = rate;
379 if (p_updateMechanism == UM_LAZY) {
380 action->m_indexHeap = -1;
381 action->m_lastUpdate = surf_get_clock();
384 bandwidth_bound = -1.0;
385 if (sg_weight_S_parameter > 0) {
386 xbt_dynar_foreach(route, i, _link) {
387 link = static_cast<NetworkCm02Link*>(_link);
388 action->m_weight += sg_weight_S_parameter / link->getBandwidth();
391 xbt_dynar_foreach(route, i, _link) {
392 link = static_cast<NetworkCm02Link*>(_link);
393 double bb = bandwidthFactor(size) * link->getBandwidth();
395 (bandwidth_bound < 0.0) ? bb : std::min(bandwidth_bound, bb);
398 action->m_latCurrent = action->m_latency;
399 action->m_latency *= latencyFactor(size);
400 action->m_rate = bandwidthConstraint(action->m_rate, bandwidth_bound, size);
402 xbt_assert(!xbt_dynar_is_empty(route),
403 "Using a model with a gap (e.g., SMPI) with a platform without links (e.g. vivaldi)!!!");
405 link = *static_cast<NetworkCm02Link **>(xbt_dynar_get_ptr(route, 0));
406 gapAppend(size, link, action);
407 XBT_DEBUG("Comm %p: %s -> %s gap=%f (lat=%f)",
408 action, src->name(), dst->name(), action->m_senderGap,
412 constraints_per_variable = xbt_dynar_length(route);
413 if (back_route != NULL)
414 constraints_per_variable += xbt_dynar_length(back_route);
416 if (action->m_latency > 0) {
417 action->p_variable = lmm_variable_new(p_maxminSystem, action, 0.0, -1.0,
418 constraints_per_variable);
419 if (p_updateMechanism == UM_LAZY) {
420 // add to the heap the event when the latency is payed
421 XBT_DEBUG("Added action (%p) one latency event at date %f", action,
422 action->m_latency + action->m_lastUpdate);
423 action->heapInsert(p_actionHeap, action->m_latency + action->m_lastUpdate, xbt_dynar_is_empty(route) ? NORMAL : LATENCY);
426 action->p_variable = lmm_variable_new(p_maxminSystem, action, 1.0, -1.0, constraints_per_variable);
428 if (action->m_rate < 0) {
429 lmm_update_variable_bound(p_maxminSystem, action->getVariable(), (action->m_latCurrent > 0) ? sg_tcp_gamma / (2.0 * action->m_latCurrent) : -1.0);
431 lmm_update_variable_bound(p_maxminSystem, action->getVariable(), (action->m_latCurrent > 0) ? std::min(action->m_rate, sg_tcp_gamma / (2.0 * action->m_latCurrent)) : action->m_rate);
434 xbt_dynar_foreach(route, i, _link) {
435 link = static_cast<NetworkCm02Link*>(_link);
436 lmm_expand(p_maxminSystem, link->getConstraint(), action->getVariable(), 1.0);
439 if (sg_network_crosstraffic == 1) {
440 XBT_DEBUG("Fullduplex active adding backward flow using 5%%");
441 xbt_dynar_foreach(back_route, i, _link) {
442 link = static_cast<NetworkCm02Link*>(_link);
443 lmm_expand(p_maxminSystem, link->getConstraint(), action->getVariable(), .05);
445 lmm_variable_concurrency_share_set(action->getVariable(),2);
448 xbt_dynar_free(&route);
451 networkCommunicateCallbacks(action, src, dst, size, rate);
458 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model *model, const char *name, xbt_dict_t props,
460 double constraint_value,
461 int initiallyOn, tmgr_trace_t state_trace,
462 double bw_peak, tmgr_trace_t bw_trace,
463 double lat_initial, tmgr_trace_t lat_trace,
464 e_surf_link_sharing_policy_t policy)
465 : Link(model, name, props, lmm_constraint_new(system, this, constraint_value), state_trace)
472 m_bandwidth.scale = 1.0;
473 m_bandwidth.peak = bw_peak;
475 m_bandwidth.event = future_evt_set->add_trace(bw_trace, 0.0, this);
477 m_bandwidth.event = NULL;
479 m_latency.scale = 1.0;
480 m_latency.peak = lat_initial;
482 m_latency.event = future_evt_set->add_trace(lat_trace, 0.0, this);
484 if (policy == SURF_LINK_FATPIPE)
485 lmm_constraint_shared(getConstraint());
490 void NetworkCm02Link::apply_event(tmgr_trace_iterator_t triggered, double value)
493 /* Find out which of my iterators was triggered, and react accordingly */
494 if (triggered == m_bandwidth.event) {
495 updateBandwidth(value);
496 tmgr_trace_event_unref(&m_bandwidth.event);
498 } else if (triggered == m_latency.event) {
499 updateLatency(value);
500 tmgr_trace_event_unref(&m_latency.event);
502 } else if (triggered == m_stateEvent) {
506 lmm_variable_t var = NULL;
507 lmm_element_t elem = NULL;
508 double now = surf_get_clock();
511 while ((var = lmm_get_var_from_cnst(getModel()->getMaxminSystem(), getConstraint(), &elem))) {
512 Action *action = static_cast<Action*>( lmm_variable_id(var) );
514 if (action->getState() == SURF_ACTION_RUNNING ||
515 action->getState() == SURF_ACTION_READY) {
516 action->setFinishTime(now);
517 action->setState(SURF_ACTION_FAILED);
521 tmgr_trace_event_unref(&m_stateEvent);
523 xbt_die("Unknown event!\n");
527 ("There was a resource state event, need to update actions related to the constraint (%p)",
531 void NetworkCm02Link::updateBandwidth(double value) {
532 double delta = sg_weight_S_parameter / value - sg_weight_S_parameter /
533 (m_bandwidth.peak * m_bandwidth.scale);
534 lmm_variable_t var = NULL;
535 lmm_element_t elem = NULL;
536 lmm_element_t nextelem = NULL;
539 NetworkCm02Action *action = NULL;
541 m_bandwidth.peak = value;
542 lmm_update_constraint_bound(getModel()->getMaxminSystem(),
544 sg_bandwidth_factor *
545 (m_bandwidth.peak * m_bandwidth.scale));
546 TRACE_surf_link_set_bandwidth(surf_get_clock(), getName(), sg_bandwidth_factor * m_bandwidth.peak * m_bandwidth.scale);
547 if (sg_weight_S_parameter > 0) {
548 while ((var = lmm_get_var_from_cnst_safe(getModel()->getMaxminSystem(), getConstraint(), &elem, &nextelem, &numelem))) {
549 action = (NetworkCm02Action*) lmm_variable_id(var);
550 action->m_weight += delta;
551 if (!action->isSuspended())
552 lmm_update_variable_weight(getModel()->getMaxminSystem(), action->getVariable(), action->m_weight);
557 void NetworkCm02Link::updateLatency(double value){
558 double delta = value - m_latency.peak;
559 lmm_variable_t var = NULL;
560 lmm_element_t elem = NULL;
561 lmm_element_t nextelem = NULL;
563 NetworkCm02Action *action = NULL;
565 m_latency.peak = value;
566 while ((var = lmm_get_var_from_cnst_safe(getModel()->getMaxminSystem(), getConstraint(), &elem, &nextelem, &numelem))) {
567 action = (NetworkCm02Action*) lmm_variable_id(var);
568 action->m_latCurrent += delta;
569 action->m_weight += delta;
570 if (action->m_rate < 0)
571 lmm_update_variable_bound(getModel()->getMaxminSystem(), action->getVariable(), sg_tcp_gamma / (2.0 * action->m_latCurrent));
573 lmm_update_variable_bound(getModel()->getMaxminSystem(), action->getVariable(),
574 std::min(action->m_rate, sg_tcp_gamma / (2.0 * action->m_latCurrent)));
576 if (action->m_rate < sg_tcp_gamma / (2.0 * action->m_latCurrent)) {
577 XBT_INFO("Flow is limited BYBANDWIDTH");
579 XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f",
580 action->m_latCurrent);
583 if (!action->isSuspended())
584 lmm_update_variable_weight(getModel()->getMaxminSystem(), action->getVariable(), action->m_weight);
591 void NetworkCm02Action::updateRemainingLazy(double now)
595 if (m_suspended != 0)
598 delta = now - m_lastUpdate;
601 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, m_remains, m_lastUpdate);
602 double_update(&(m_remains), m_lastValue * delta, sg_maxmin_precision*sg_surf_precision);
604 XBT_DEBUG("Updating action(%p): remains is now %f", this, m_remains);
607 if (m_maxDuration != NO_MAX_DURATION)
608 double_update(&m_maxDuration, delta, sg_surf_precision);
610 if (m_remains <= 0 &&
611 (lmm_get_variable_weight(getVariable()) > 0)) {
613 setState(SURF_ACTION_DONE);
615 heapRemove(getModel()->getActionHeap());
616 } else if (((m_maxDuration != NO_MAX_DURATION)
617 && (m_maxDuration <= 0))) {
619 setState(SURF_ACTION_DONE);
620 heapRemove(getModel()->getActionHeap());
624 m_lastValue = lmm_variable_getvalue(getVariable());