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/surf/platform.hpp"
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;
28 void net_define_callbacks(void)
30 /* Figuring out the network links */
31 simgrid::surf::on_link.connect(netlink_parse_init);
38 /************************************************************************/
39 /* New model based on optimizations discussed during Pedro Velho's thesis*/
40 /************************************************************************/
41 /* @techreport{VELHO:2011:HAL-00646896:1, */
42 /* url = {http://hal.inria.fr/hal-00646896/en/}, */
43 /* title = {{Flow-level network models: have we reached the limits?}}, */
44 /* author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
45 /* type = {Rapport de recherche}, */
46 /* institution = {INRIA}, */
47 /* number = {RR-7821}, */
50 /* pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
52 void surf_network_model_init_LegrandVelho(void)
54 if (surf_network_model)
57 surf_network_model = new simgrid::surf::NetworkCm02Model();
58 net_define_callbacks();
59 simgrid::surf::Model *model = surf_network_model;
60 xbt_dynar_push(all_existing_models, &model);
62 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor",
64 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor",
66 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 20537);
69 /***************************************************************************/
70 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
71 /***************************************************************************/
72 /* @TechReport{ rr-lip2002-40, */
73 /* author = {Henri Casanova and Loris Marchal}, */
74 /* institution = {LIP}, */
75 /* title = {A Network Model for Simulation of Grid Application}, */
76 /* number = {2002-40}, */
80 void surf_network_model_init_CM02(void)
83 if (surf_network_model)
86 surf_network_model = new simgrid::surf::NetworkCm02Model();
87 xbt_dynar_push(all_existing_models, &surf_network_model);
88 net_define_callbacks();
90 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
91 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
92 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 0.0);
95 /***************************************************************************/
96 /* The models from Steven H. Low */
97 /***************************************************************************/
99 /* author={Steven H. Low}, */
100 /* title={A Duality Model of {TCP} and Queue Management Algorithms}, */
102 /* journal={{IEEE/ACM} Transactions on Networking}, */
103 /* volume={11}, number={4}, */
105 void surf_network_model_init_Reno(void)
107 if (surf_network_model)
110 surf_network_model = new simgrid::surf::NetworkCm02Model();
111 xbt_dynar_push(all_existing_models, &surf_network_model);
112 net_define_callbacks();
113 lmm_set_default_protocol_function(func_reno_f, func_reno_fp, func_reno_fpi);
114 surf_network_model->f_networkSolve = lagrange_solve;
116 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 10.4);
117 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 0.92);
118 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 8775);
122 void surf_network_model_init_Reno2(void)
124 if (surf_network_model)
127 surf_network_model = new simgrid::surf::NetworkCm02Model();
128 xbt_dynar_push(all_existing_models, &surf_network_model);
129 net_define_callbacks();
130 lmm_set_default_protocol_function(func_reno2_f, func_reno2_fp, func_reno2_fpi);
131 surf_network_model->f_networkSolve = lagrange_solve;
133 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 10.4);
134 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 0.92);
135 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 8775);
138 void surf_network_model_init_Vegas(void)
140 if (surf_network_model)
143 surf_network_model = new simgrid::surf::NetworkCm02Model();
144 xbt_dynar_push(all_existing_models, &surf_network_model);
145 net_define_callbacks();
146 lmm_set_default_protocol_function(func_vegas_f, func_vegas_fp, func_vegas_fpi);
147 surf_network_model->f_networkSolve = lagrange_solve;
149 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 10.4);
150 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 0.92);
151 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 8775);
157 NetworkCm02Model::NetworkCm02Model()
160 char *optim = xbt_cfg_get_string(_sg_cfg_set, "network/optim");
161 int select = xbt_cfg_get_boolean(_sg_cfg_set, "network/maxmin_selective_update");
163 if (!strcmp(optim, "Full")) {
164 p_updateMechanism = UM_FULL;
165 m_selectiveUpdate = select;
166 } else if (!strcmp(optim, "Lazy")) {
167 p_updateMechanism = UM_LAZY;
168 m_selectiveUpdate = 1;
169 xbt_assert((select == 1) || (xbt_cfg_is_default_value(_sg_cfg_set, "network/maxmin_selective_update")),
170 "Disabling selective update while using the lazy update mechanism is dumb!");
172 xbt_die("Unsupported optimization (%s) for this model", optim);
176 p_maxminSystem = lmm_system_new(m_selectiveUpdate);
178 routing_model_create(createLink("__loopback__",
179 498000000, NULL, 0.000015, NULL,
180 1 /*SURF_RESOURCE_ON*/, NULL,
181 SURF_LINK_FATPIPE, NULL));
183 if (p_updateMechanism == UM_LAZY) {
184 p_actionHeap = xbt_heap_new(8, NULL);
185 xbt_heap_set_update_callback(p_actionHeap, surf_action_lmm_update_index_heap);
186 p_modifiedSet = new ActionLmmList();
187 p_maxminSystem->keep_track = p_modifiedSet;
191 Link* NetworkCm02Model::createLink(const char *name,
193 tmgr_trace_t bw_trace,
195 tmgr_trace_t lat_trace,
197 tmgr_trace_t state_trace,
198 e_surf_link_sharing_policy_t policy,
199 xbt_dict_t properties)
201 xbt_assert(NULL == Link::byName(name),
202 "Link '%s' declared several times in the platform",
205 Link* link = new NetworkCm02Link(this, name, properties, p_maxminSystem, sg_bandwidth_factor * bw_initial,
206 initiallyOn, state_trace, bw_initial, bw_trace, lat_initial, lat_trace, policy);
207 Link::onCreation(link);
211 void NetworkCm02Model::updateActionsStateLazy(double now, double /*delta*/)
213 NetworkCm02Action *action;
214 while ((xbt_heap_size(p_actionHeap) > 0)
215 && (double_equals(xbt_heap_maxkey(p_actionHeap), now, sg_surf_precision))) {
216 action = static_cast<NetworkCm02Action*> (xbt_heap_pop(p_actionHeap));
217 XBT_DEBUG("Something happened to action %p", action);
218 if (TRACE_is_enabled()) {
219 int n = lmm_get_number_of_cnst_from_var(p_maxminSystem, action->getVariable());
221 for (i = 0; i < n; i++){
222 lmm_constraint_t constraint = lmm_get_cnst_from_var(p_maxminSystem,
223 action->getVariable(),
225 NetworkCm02Link *link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
226 TRACE_surf_link_set_utilization(link->getName(),
227 action->getCategory(),
228 (lmm_variable_getvalue(action->getVariable())*
229 lmm_get_cnst_weight_from_var(p_maxminSystem,
230 action->getVariable(),
232 action->getLastUpdate(),
233 now - action->getLastUpdate());
237 // if I am wearing a latency hat
238 if (action->getHat() == LATENCY) {
239 XBT_DEBUG("Latency paid for action %p. Activating", action);
240 lmm_update_variable_weight(p_maxminSystem, action->getVariable(), action->m_weight);
241 action->heapRemove(p_actionHeap);
242 action->refreshLastUpdate();
244 // if I am wearing a max_duration or normal hat
245 } else if (action->getHat() == MAX_DURATION ||
246 action->getHat() == NORMAL) {
247 // no need to communicate anymore
248 // assume that flows that reached max_duration have remaining of 0
249 XBT_DEBUG("Action %p finished", action);
250 action->setRemains(0);
252 action->setState(SURF_ACTION_DONE);
253 action->heapRemove(p_actionHeap);
262 void NetworkCm02Model::updateActionsStateFull(double now, double delta)
264 NetworkCm02Action *action;
265 ActionList *running_actions = getRunningActionSet();
267 for(ActionList::iterator it(running_actions->begin()), itNext=it, itend(running_actions->end())
268 ; it != itend ; it=itNext) {
271 action = static_cast<NetworkCm02Action*> (&*it);
272 XBT_DEBUG("Something happened to action %p", action);
273 double deltap = delta;
274 if (action->m_latency > 0) {
275 if (action->m_latency > deltap) {
276 double_update(&(action->m_latency), deltap, sg_surf_precision);
279 double_update(&(deltap), action->m_latency, sg_surf_precision);
280 action->m_latency = 0.0;
282 if (action->m_latency == 0.0 && !(action->isSuspended()))
283 lmm_update_variable_weight(p_maxminSystem, action->getVariable(),
286 if (TRACE_is_enabled()) {
287 int n = lmm_get_number_of_cnst_from_var(p_maxminSystem, action->getVariable());
289 for (i = 0; i < n; i++){
290 lmm_constraint_t constraint = lmm_get_cnst_from_var(p_maxminSystem,
291 action->getVariable(),
293 NetworkCm02Link* link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
294 TRACE_surf_link_set_utilization(link->getName(),
295 action->getCategory(),
296 (lmm_variable_getvalue(action->getVariable())*
297 lmm_get_cnst_weight_from_var(p_maxminSystem,
298 action->getVariable(),
300 action->getLastUpdate(),
301 now - action->getLastUpdate());
304 if (!lmm_get_number_of_cnst_from_var
305 (p_maxminSystem, action->getVariable())) {
306 /* There is actually no link used, hence an infinite bandwidth.
307 * This happens often when using models like vivaldi.
308 * In such case, just make sure that the action completes immediately.
310 action->updateRemains(action->getRemains());
312 action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
314 if (action->getMaxDuration() != NO_MAX_DURATION)
315 action->updateMaxDuration(delta);
317 if ((action->getRemains() <= 0) &&
318 (lmm_get_variable_weight(action->getVariable()) > 0)) {
320 action->setState(SURF_ACTION_DONE);
322 } else if (((action->getMaxDuration() != NO_MAX_DURATION)
323 && (action->getMaxDuration() <= 0))) {
325 action->setState(SURF_ACTION_DONE);
332 Action *NetworkCm02Model::communicate(NetCard *src, NetCard *dst,
333 double size, double rate)
337 NetworkCm02Link *link;
339 NetworkCm02Action *action = NULL;
340 double bandwidth_bound;
341 double latency = 0.0;
342 xbt_dynar_t back_route = NULL;
343 int constraints_per_variable = 0;
345 xbt_dynar_t route = xbt_dynar_new(sizeof(NetCard*), NULL);
347 XBT_IN("(%s,%s,%g,%g)", src->getName(), dst->getName(), size, rate);
349 routing_platf->getRouteAndLatency(src, dst, &route, &latency);
350 xbt_assert(!xbt_dynar_is_empty(route) || latency,
351 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
352 src->getName(), dst->getName());
354 xbt_dynar_foreach(route, i, _link) {
355 link = static_cast<NetworkCm02Link*>(_link);
361 if (sg_network_crosstraffic == 1) {
362 routing_platf->getRouteAndLatency(dst, src, &back_route, NULL);
363 xbt_dynar_foreach(back_route, i, _link) {
364 link = static_cast<NetworkCm02Link*>(_link);
372 action = new NetworkCm02Action(this, size, failed);
374 #ifdef HAVE_LATENCY_BOUND_TRACKING
375 action->m_latencyLimited = 0;
377 action->m_weight = action->m_latency = latency;
379 action->m_rate = rate;
380 if (p_updateMechanism == UM_LAZY) {
381 action->m_indexHeap = -1;
382 action->m_lastUpdate = surf_get_clock();
385 bandwidth_bound = -1.0;
386 if (sg_weight_S_parameter > 0) {
387 xbt_dynar_foreach(route, i, _link) {
388 link = static_cast<NetworkCm02Link*>(_link);
389 action->m_weight += sg_weight_S_parameter / link->getBandwidth();
392 xbt_dynar_foreach(route, i, _link) {
393 link = static_cast<NetworkCm02Link*>(_link);
394 double bb = bandwidthFactor(size) * link->getBandwidth();
396 (bandwidth_bound < 0.0) ? bb : std::min(bandwidth_bound, bb);
399 action->m_latCurrent = action->m_latency;
400 action->m_latency *= latencyFactor(size);
401 action->m_rate = bandwidthConstraint(action->m_rate, bandwidth_bound, size);
403 xbt_assert(!xbt_dynar_is_empty(route),
404 "Using a model with a gap (e.g., SMPI) with a platform without links (e.g. vivaldi)!!!");
406 link = *static_cast<NetworkCm02Link **>(xbt_dynar_get_ptr(route, 0));
407 gapAppend(size, link, action);
408 XBT_DEBUG("Comm %p: %s -> %s gap=%f (lat=%f)",
409 action, src->getName(), dst->getName(), action->m_senderGap,
413 constraints_per_variable = xbt_dynar_length(route);
414 if (back_route != NULL)
415 constraints_per_variable += xbt_dynar_length(back_route);
417 if (action->m_latency > 0) {
418 action->p_variable = lmm_variable_new(p_maxminSystem, action, 0.0, -1.0,
419 constraints_per_variable);
420 if (p_updateMechanism == UM_LAZY) {
421 // add to the heap the event when the latency is payed
422 XBT_DEBUG("Added action (%p) one latency event at date %f", action,
423 action->m_latency + action->m_lastUpdate);
424 action->heapInsert(p_actionHeap, action->m_latency + action->m_lastUpdate, xbt_dynar_is_empty(route) ? NORMAL : LATENCY);
427 action->p_variable = lmm_variable_new(p_maxminSystem, action, 1.0, -1.0, constraints_per_variable);
429 if (action->m_rate < 0) {
430 lmm_update_variable_bound(p_maxminSystem, action->getVariable(), (action->m_latCurrent > 0) ? sg_tcp_gamma / (2.0 * action->m_latCurrent) : -1.0);
432 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);
435 xbt_dynar_foreach(route, i, _link) {
436 link = static_cast<NetworkCm02Link*>(_link);
437 lmm_expand(p_maxminSystem, link->getConstraint(), action->getVariable(), 1.0);
440 if (sg_network_crosstraffic == 1) {
441 XBT_DEBUG("Fullduplex active adding backward flow using 5%%");
442 xbt_dynar_foreach(back_route, i, _link) {
443 link = static_cast<NetworkCm02Link*>(_link);
444 lmm_expand(p_maxminSystem, link->getConstraint(), action->getVariable(), .05);
446 lmm_variable_concurrency_share_set(action->getVariable(),2);
449 xbt_dynar_free(&route);
452 networkCommunicateCallbacks(action, src, dst, size, rate);
459 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model *model, const char *name, xbt_dict_t props,
461 double constraint_value,
462 int initiallyOn, tmgr_trace_t state_trace,
463 double bw_peak, tmgr_trace_t bw_trace,
464 double lat_initial, tmgr_trace_t lat_trace,
465 e_surf_link_sharing_policy_t policy)
466 : Link(model, name, props, lmm_constraint_new(system, this, constraint_value), state_trace)
473 m_bandwidth.scale = 1.0;
474 m_bandwidth.peak = bw_peak;
476 m_bandwidth.event = future_evt_set->add_trace(bw_trace, 0.0, this);
478 m_bandwidth.event = NULL;
480 m_latency.scale = 1.0;
481 m_latency.peak = lat_initial;
483 m_latency.event = future_evt_set->add_trace(lat_trace, 0.0, this);
485 if (policy == SURF_LINK_FATPIPE)
486 lmm_constraint_shared(getConstraint());
491 void NetworkCm02Link::apply_event(tmgr_trace_iterator_t triggered, double value)
494 /* Find out which of my iterators was triggered, and react accordingly */
495 if (triggered == m_bandwidth.event) {
496 updateBandwidth(value);
497 tmgr_trace_event_unref(&m_bandwidth.event);
499 } else if (triggered == m_latency.event) {
500 updateLatency(value);
501 tmgr_trace_event_unref(&m_latency.event);
503 } else if (triggered == m_stateEvent) {
507 lmm_variable_t var = NULL;
508 lmm_element_t elem = NULL;
509 double now = surf_get_clock();
512 while ((var = lmm_get_var_from_cnst(getModel()->getMaxminSystem(), getConstraint(), &elem))) {
513 Action *action = static_cast<Action*>( lmm_variable_id(var) );
515 if (action->getState() == SURF_ACTION_RUNNING ||
516 action->getState() == SURF_ACTION_READY) {
517 action->setFinishTime(now);
518 action->setState(SURF_ACTION_FAILED);
522 tmgr_trace_event_unref(&m_stateEvent);
524 xbt_die("Unknown event!\n");
528 ("There was a resource state event, need to update actions related to the constraint (%p)",
532 void NetworkCm02Link::updateBandwidth(double value) {
533 double delta = sg_weight_S_parameter / value - sg_weight_S_parameter /
534 (m_bandwidth.peak * m_bandwidth.scale);
535 lmm_variable_t var = NULL;
536 lmm_element_t elem = NULL;
537 lmm_element_t nextelem = NULL;
540 NetworkCm02Action *action = NULL;
542 m_bandwidth.peak = value;
543 lmm_update_constraint_bound(getModel()->getMaxminSystem(),
545 sg_bandwidth_factor *
546 (m_bandwidth.peak * m_bandwidth.scale));
547 TRACE_surf_link_set_bandwidth(surf_get_clock(), getName(), sg_bandwidth_factor * m_bandwidth.peak * m_bandwidth.scale);
548 if (sg_weight_S_parameter > 0) {
549 while ((var = lmm_get_var_from_cnst_safe(getModel()->getMaxminSystem(), getConstraint(), &elem, &nextelem, &numelem))) {
550 action = (NetworkCm02Action*) lmm_variable_id(var);
551 action->m_weight += delta;
552 if (!action->isSuspended())
553 lmm_update_variable_weight(getModel()->getMaxminSystem(), action->getVariable(), action->m_weight);
558 void NetworkCm02Link::updateLatency(double value){
559 double delta = value - m_latency.peak;
560 lmm_variable_t var = NULL;
561 lmm_element_t elem = NULL;
562 lmm_element_t nextelem = NULL;
564 NetworkCm02Action *action = NULL;
566 m_latency.peak = value;
567 while ((var = lmm_get_var_from_cnst_safe(getModel()->getMaxminSystem(), getConstraint(), &elem, &nextelem, &numelem))) {
568 action = (NetworkCm02Action*) lmm_variable_id(var);
569 action->m_latCurrent += delta;
570 action->m_weight += delta;
571 if (action->m_rate < 0)
572 lmm_update_variable_bound(getModel()->getMaxminSystem(), action->getVariable(), sg_tcp_gamma / (2.0 * action->m_latCurrent));
574 lmm_update_variable_bound(getModel()->getMaxminSystem(), action->getVariable(),
575 std::min(action->m_rate, sg_tcp_gamma / (2.0 * action->m_latCurrent)));
577 if (action->m_rate < sg_tcp_gamma / (2.0 * action->m_latCurrent)) {
578 XBT_INFO("Flow is limited BYBANDWIDTH");
580 XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f",
581 action->m_latCurrent);
584 if (!action->isSuspended())
585 lmm_update_variable_weight(getModel()->getMaxminSystem(), action->getVariable(), action->m_weight);
592 void NetworkCm02Action::updateRemainingLazy(double now)
596 if (m_suspended != 0)
599 delta = now - m_lastUpdate;
602 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, m_remains, m_lastUpdate);
603 double_update(&(m_remains), m_lastValue * delta, sg_maxmin_precision*sg_surf_precision);
605 XBT_DEBUG("Updating action(%p): remains is now %f", this, m_remains);
608 if (m_maxDuration != NO_MAX_DURATION)
609 double_update(&m_maxDuration, delta, sg_surf_precision);
611 if (m_remains <= 0 &&
612 (lmm_get_variable_weight(getVariable()) > 0)) {
614 setState(SURF_ACTION_DONE);
616 heapRemove(getModel()->getActionHeap());
617 } else if (((m_maxDuration != NO_MAX_DURATION)
618 && (m_maxDuration <= 0))) {
620 setState(SURF_ACTION_DONE);
621 heapRemove(getModel()->getActionHeap());
625 m_lastValue = lmm_variable_getvalue(getVariable());