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. */
7 #include "network_cm02.hpp"
8 #include "maxmin_private.hpp"
9 #include "simgrid/sg_config.h"
11 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_network);
13 double sg_sender_gap = 0.0;
14 double sg_latency_factor = 1.0; /* default value; can be set by model or from command line */
15 double sg_bandwidth_factor = 1.0; /* default value; can be set by model or from command line */
16 double sg_weight_S_parameter = 0.0; /* default value; can be set by model or from command line */
18 double sg_tcp_gamma = 0.0;
19 int sg_network_crosstraffic = 0;
25 void net_define_callbacks(void)
27 /* Figuring out the network links */
28 sg_platf_link_add_cb(netlink_parse_init);
29 sg_platf_postparse_add_cb(net_add_traces);
36 /************************************************************************/
37 /* New model based on optimizations discussed during Pedro Velho's thesis*/
38 /************************************************************************/
39 /* @techreport{VELHO:2011:HAL-00646896:1, */
40 /* url = {http://hal.inria.fr/hal-00646896/en/}, */
41 /* title = {{Flow-level network models: have we reached the limits?}}, */
42 /* author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
43 /* type = {Rapport de recherche}, */
44 /* institution = {INRIA}, */
45 /* number = {RR-7821}, */
48 /* pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
50 void surf_network_model_init_LegrandVelho(void)
52 if (surf_network_model)
55 surf_network_model = new NetworkCm02Model();
56 net_define_callbacks();
57 Model *model = surf_network_model;
58 xbt_dynar_push(model_list, &model);
60 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor",
62 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor",
64 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 20537);
67 /***************************************************************************/
68 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
69 /***************************************************************************/
70 /* @TechReport{ rr-lip2002-40, */
71 /* author = {Henri Casanova and Loris Marchal}, */
72 /* institution = {LIP}, */
73 /* title = {A Network Model for Simulation of Grid Application}, */
74 /* number = {2002-40}, */
78 void surf_network_model_init_CM02(void)
81 if (surf_network_model)
84 surf_network_model = new NetworkCm02Model();
85 net_define_callbacks();
86 Model *model = surf_network_model;
87 xbt_dynar_push(model_list, &model);
89 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
90 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor",
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 NetworkCm02Model();
111 net_define_callbacks();
112 Model *model = surf_network_model;
113 xbt_dynar_push(model_list, &model);
114 lmm_set_default_protocol_function(func_reno_f, func_reno_fp,
116 surf_network_model->f_networkSolve = lagrange_solve;
118 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 10.4);
119 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor",
121 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 8775);
125 void surf_network_model_init_Reno2(void)
127 if (surf_network_model)
130 surf_network_model = new NetworkCm02Model();
131 net_define_callbacks();
132 Model *model = surf_network_model;
133 xbt_dynar_push(model_list, &model);
134 lmm_set_default_protocol_function(func_reno2_f, func_reno2_fp,
136 surf_network_model->f_networkSolve = lagrange_solve;
138 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 10.4);
139 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor",
141 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S",
145 void surf_network_model_init_Vegas(void)
147 if (surf_network_model)
150 surf_network_model = new NetworkCm02Model();
151 net_define_callbacks();
152 Model *model = surf_network_model;
153 xbt_dynar_push(model_list, &model);
154 lmm_set_default_protocol_function(func_vegas_f, func_vegas_fp,
156 surf_network_model->f_networkSolve = lagrange_solve;
158 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 10.4);
159 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor",
161 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 8775);
164 NetworkCm02Model::NetworkCm02Model()
167 char *optim = xbt_cfg_get_string(_sg_cfg_set, "network/optim");
169 xbt_cfg_get_boolean(_sg_cfg_set, "network/maxmin_selective_update");
171 if (!strcmp(optim, "Full")) {
172 p_updateMechanism = UM_FULL;
173 m_selectiveUpdate = select;
174 } else if (!strcmp(optim, "Lazy")) {
175 p_updateMechanism = UM_LAZY;
176 m_selectiveUpdate = 1;
177 xbt_assert((select == 1)
179 (xbt_cfg_is_default_value
180 (_sg_cfg_set, "network/maxmin_selective_update")),
181 "Disabling selective update while using the lazy update mechanism is dumb!");
183 xbt_die("Unsupported optimization (%s) for this model", optim);
187 p_maxminSystem = lmm_system_new(m_selectiveUpdate);
189 routing_model_create(createLink("__loopback__",
190 498000000, NULL, 0.000015, NULL,
191 SURF_RESOURCE_ON, NULL,
192 SURF_LINK_FATPIPE, NULL));
194 if (p_updateMechanism == UM_LAZY) {
195 p_actionHeap = xbt_heap_new(8, NULL);
196 xbt_heap_set_update_callback(p_actionHeap, surf_action_lmm_update_index_heap);
197 p_modifiedSet = new ActionLmmList();
198 p_maxminSystem->keep_track = p_modifiedSet;
204 Link* NetworkCm02Model::createLink(const char *name,
206 tmgr_trace_t bw_trace,
208 tmgr_trace_t lat_trace,
209 e_surf_resource_state_t state_initial,
210 tmgr_trace_t state_trace,
211 e_surf_link_sharing_policy_t policy,
212 xbt_dict_t properties)
214 xbt_assert(NULL == Link::byName(name),
215 "Link '%s' declared several times in the platform",
218 return new NetworkCm02Link(this, name, properties, p_maxminSystem, sg_bandwidth_factor * bw_initial, history,
219 state_initial, state_trace, bw_initial, bw_trace, lat_initial, lat_trace, policy);
222 void NetworkCm02Model::updateActionsStateLazy(double now, double /*delta*/)
224 NetworkCm02Action *action;
225 while ((xbt_heap_size(p_actionHeap) > 0)
226 && (double_equals(xbt_heap_maxkey(p_actionHeap), now, sg_surf_precision))) {
227 action = static_cast<NetworkCm02Action*> (xbt_heap_pop(p_actionHeap));
228 XBT_DEBUG("Something happened to action %p", action);
229 if (TRACE_is_enabled()) {
230 int n = lmm_get_number_of_cnst_from_var(p_maxminSystem, action->getVariable());
232 for (i = 0; i < n; i++){
233 lmm_constraint_t constraint = lmm_get_cnst_from_var(p_maxminSystem,
234 action->getVariable(),
236 NetworkCm02Link *link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
237 TRACE_surf_link_set_utilization(link->getName(),
238 action->getCategory(),
239 (lmm_variable_getvalue(action->getVariable())*
240 lmm_get_cnst_weight_from_var(p_maxminSystem,
241 action->getVariable(),
243 action->getLastUpdate(),
244 now - action->getLastUpdate());
248 // if I am wearing a latency hat
249 if (action->getHat() == LATENCY) {
250 XBT_DEBUG("Latency paid for action %p. Activating", action);
251 lmm_update_variable_weight(p_maxminSystem, action->getVariable(), action->m_weight);
252 action->heapRemove(p_actionHeap);
253 action->refreshLastUpdate();
255 // if I am wearing a max_duration or normal hat
256 } else if (action->getHat() == MAX_DURATION ||
257 action->getHat() == NORMAL) {
258 // no need to communicate anymore
259 // assume that flows that reached max_duration have remaining of 0
260 XBT_DEBUG("Action %p finished", action);
261 action->setRemains(0);
263 action->setState(SURF_ACTION_DONE);
264 action->heapRemove(p_actionHeap);
273 void NetworkCm02Model::updateActionsStateFull(double now, double delta)
275 NetworkCm02Action *action;
276 ActionList *running_actions = getRunningActionSet();
278 for(ActionList::iterator it(running_actions->begin()), itNext=it, itend(running_actions->end())
279 ; it != itend ; it=itNext) {
282 action = static_cast<NetworkCm02Action*> (&*it);
283 XBT_DEBUG("Something happened to action %p", action);
284 double deltap = delta;
285 if (action->m_latency > 0) {
286 if (action->m_latency > deltap) {
287 double_update(&(action->m_latency), deltap, sg_surf_precision);
290 double_update(&(deltap), action->m_latency, sg_surf_precision);
291 action->m_latency = 0.0;
293 if (action->m_latency == 0.0 && !(action->isSuspended()))
294 lmm_update_variable_weight(p_maxminSystem, action->getVariable(),
297 if (TRACE_is_enabled()) {
298 int n = lmm_get_number_of_cnst_from_var(p_maxminSystem, action->getVariable());
300 for (i = 0; i < n; i++){
301 lmm_constraint_t constraint = lmm_get_cnst_from_var(p_maxminSystem,
302 action->getVariable(),
304 NetworkCm02Link* link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
305 TRACE_surf_link_set_utilization(link->getName(),
306 action->getCategory(),
307 (lmm_variable_getvalue(action->getVariable())*
308 lmm_get_cnst_weight_from_var(p_maxminSystem,
309 action->getVariable(),
311 action->getLastUpdate(),
312 now - action->getLastUpdate());
315 if (!lmm_get_number_of_cnst_from_var
316 (p_maxminSystem, action->getVariable())) {
317 /* There is actually no link used, hence an infinite bandwidth.
318 * This happens often when using models like vivaldi.
319 * In such case, just make sure that the action completes immediately.
321 action->updateRemains(action->getRemains());
323 action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
325 if (action->getMaxDuration() != NO_MAX_DURATION)
326 action->updateMaxDuration(delta);
328 if ((action->getRemains() <= 0) &&
329 (lmm_get_variable_weight(action->getVariable()) > 0)) {
331 action->setState(SURF_ACTION_DONE);
333 } else if (((action->getMaxDuration() != NO_MAX_DURATION)
334 && (action->getMaxDuration() <= 0))) {
336 action->setState(SURF_ACTION_DONE);
343 Action *NetworkCm02Model::communicate(RoutingEdge *src, RoutingEdge *dst,
344 double size, double rate)
348 NetworkCm02Link *link;
350 NetworkCm02Action *action = NULL;
351 double bandwidth_bound;
352 double latency = 0.0;
353 xbt_dynar_t back_route = NULL;
354 int constraints_per_variable = 0;
356 xbt_dynar_t route = xbt_dynar_new(sizeof(RoutingEdge*), NULL);
358 XBT_IN("(%s,%s,%g,%g)", src->getName(), dst->getName(), size, rate);
360 routing_platf->getRouteAndLatency(src, dst, &route, &latency);
361 xbt_assert(!xbt_dynar_is_empty(route) || latency,
362 "You're trying to send data from %s to %s but there is no connection at all between these two hosts.",
363 src->getName(), dst->getName());
365 xbt_dynar_foreach(route, i, _link) {
366 link = static_cast<NetworkCm02Link*>(_link);
367 if (link->getState() == SURF_RESOURCE_OFF) {
372 if (sg_network_crosstraffic == 1) {
373 routing_platf->getRouteAndLatency(dst, src, &back_route, NULL);
374 xbt_dynar_foreach(back_route, i, _link) {
375 link = static_cast<NetworkCm02Link*>(_link);
376 if (link->getState() == SURF_RESOURCE_OFF) {
383 action = new NetworkCm02Action(this, size, failed);
385 #ifdef HAVE_LATENCY_BOUND_TRACKING
386 action->m_latencyLimited = 0;
388 action->m_weight = action->m_latency = latency;
390 action->m_rate = rate;
391 if (p_updateMechanism == UM_LAZY) {
392 action->m_indexHeap = -1;
393 action->m_lastUpdate = surf_get_clock();
396 bandwidth_bound = -1.0;
397 if (sg_weight_S_parameter > 0) {
398 xbt_dynar_foreach(route, i, _link) {
399 link = static_cast<NetworkCm02Link*>(_link);
400 action->m_weight += sg_weight_S_parameter / link->getBandwidth();
403 xbt_dynar_foreach(route, i, _link) {
404 link = static_cast<NetworkCm02Link*>(_link);
405 double bb = bandwidthFactor(size) * link->getBandwidth(); //(link->p_power.peak * link->p_power.scale);
407 (bandwidth_bound < 0.0) ? bb : min(bandwidth_bound, bb);
410 action->m_latCurrent = action->m_latency;
411 action->m_latency *= latencyFactor(size);
412 action->m_rate = bandwidthConstraint(action->m_rate, bandwidth_bound, size);
414 xbt_assert(!xbt_dynar_is_empty(route),
415 "Using a model with a gap (e.g., SMPI) with a platform without links (e.g. vivaldi)!!!");
417 link = *static_cast<NetworkCm02Link **>(xbt_dynar_get_ptr(route, 0));
418 gapAppend(size, link, action);
419 XBT_DEBUG("Comm %p: %s -> %s gap=%f (lat=%f)",
420 action, src->getName(), dst->getName(), action->m_senderGap,
424 constraints_per_variable = xbt_dynar_length(route);
425 if (back_route != NULL)
426 constraints_per_variable += xbt_dynar_length(back_route);
428 if (action->m_latency > 0) {
429 action->p_variable = lmm_variable_new(p_maxminSystem, action, 0.0, -1.0,
430 constraints_per_variable);
431 if (p_updateMechanism == UM_LAZY) {
432 // add to the heap the event when the latency is payed
433 XBT_DEBUG("Added action (%p) one latency event at date %f", action,
434 action->m_latency + action->m_lastUpdate);
435 action->heapInsert(p_actionHeap, action->m_latency + action->m_lastUpdate, xbt_dynar_is_empty(route) ? NORMAL : LATENCY);
438 action->p_variable = lmm_variable_new(p_maxminSystem, action, 1.0, -1.0, constraints_per_variable);
440 if (action->m_rate < 0) {
441 lmm_update_variable_bound(p_maxminSystem, action->getVariable(), (action->m_latCurrent > 0) ? sg_tcp_gamma / (2.0 * action->m_latCurrent) : -1.0);
443 lmm_update_variable_bound(p_maxminSystem, action->getVariable(), (action->m_latCurrent > 0) ? min(action->m_rate, sg_tcp_gamma / (2.0 * action->m_latCurrent)) : action->m_rate);
446 xbt_dynar_foreach(route, i, _link) {
447 link = static_cast<NetworkCm02Link*>(_link);
448 lmm_expand(p_maxminSystem, link->getConstraint(), action->getVariable(), 1.0);
451 if (sg_network_crosstraffic == 1) {
452 XBT_DEBUG("Fullduplex active adding backward flow using 5%%");
453 xbt_dynar_foreach(back_route, i, _link) {
454 link = static_cast<NetworkCm02Link*>(_link);
455 lmm_expand(p_maxminSystem, link->getConstraint(), action->getVariable(), .05);
459 xbt_dynar_free(&route);
462 surf_callback_emit(networkCommunicateCallbacks, action, src, dst, size, rate);
466 void NetworkCm02Model::addTraces(){
467 xbt_dict_cursor_t cursor = NULL;
468 char *trace_name, *elm;
470 static int called = 0;
475 /* connect all traces relative to network */
476 xbt_dict_foreach(trace_connect_list_link_avail, cursor, trace_name, elm) {
477 tmgr_trace_t trace = (tmgr_trace_t) xbt_dict_get_or_null(traces_set_list, trace_name);
478 NetworkCm02Link *link = static_cast<NetworkCm02Link*>( Link::byName(elm) );
480 xbt_assert(link, "Cannot connect trace %s to link %s: link undefined",
483 "Cannot connect trace %s to link %s: trace undefined",
486 link->p_stateEvent = tmgr_history_add_trace(history, trace, 0.0, 0, link);
489 xbt_dict_foreach(trace_connect_list_bandwidth, cursor, trace_name, elm) {
490 tmgr_trace_t trace = (tmgr_trace_t) xbt_dict_get_or_null(traces_set_list, trace_name);
491 NetworkCm02Link *link = static_cast<NetworkCm02Link*>( Link::byName(elm) );
493 xbt_assert(link, "Cannot connect trace %s to link %s: link undefined",
496 "Cannot connect trace %s to link %s: trace undefined",
499 link->p_power.event = tmgr_history_add_trace(history, trace, 0.0, 0, link);
502 xbt_dict_foreach(trace_connect_list_latency, cursor, trace_name, elm) {
503 tmgr_trace_t trace = (tmgr_trace_t) xbt_dict_get_or_null(traces_set_list, trace_name);
504 NetworkCm02Link *link = static_cast<NetworkCm02Link*>(Link::byName(elm));;
506 xbt_assert(link, "Cannot connect trace %s to link %s: link undefined",
509 "Cannot connect trace %s to link %s: trace undefined",
512 link->p_latEvent = tmgr_history_add_trace(history, trace, 0.0, 0, link);
519 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model *model, const char *name, xbt_dict_t props,
521 double constraint_value,
522 tmgr_history_t history,
523 e_surf_resource_state_t state_init,
524 tmgr_trace_t state_trace,
526 tmgr_trace_t metric_trace,
528 tmgr_trace_t lat_trace,
529 e_surf_link_sharing_policy_t policy)
530 : Link(model, name, props, lmm_constraint_new(system, this, constraint_value), history, state_trace)
532 setState(state_init);
535 p_power.peak = metric_peak;
537 p_power.event = tmgr_history_add_trace(history, metric_trace, 0.0, 0, this);
539 p_power.event = NULL;
541 m_latCurrent = lat_initial;
543 p_latEvent = tmgr_history_add_trace(history, lat_trace, 0.0, 0, this);
545 if (policy == SURF_LINK_FATPIPE)
546 lmm_constraint_shared(getConstraint());
551 void NetworkCm02Link::updateState(tmgr_trace_event_t event_type,
552 double value, double date)
554 /* printf("[" "%g" "] Asking to update network card \"%s\" with value " */
555 /* "%g" " for event %p\n", surf_get_clock(), nw_link->name, */
556 /* value, event_type); */
558 if (event_type == p_power.event) {
559 updateBandwidth(value, date);
560 if (tmgr_trace_event_free(event_type))
561 p_power.event = NULL;
562 } else if (event_type == p_latEvent) {
563 updateLatency(value, date);
564 if (tmgr_trace_event_free(event_type))
566 } else if (event_type == p_stateEvent) {
568 setState(SURF_RESOURCE_ON);
570 lmm_constraint_t cnst = getConstraint();
571 lmm_variable_t var = NULL;
572 lmm_element_t elem = NULL;
574 setState(SURF_RESOURCE_OFF);
575 while ((var = lmm_get_var_from_cnst(getModel()->getMaxminSystem(), cnst, &elem))) {
576 Action *action = static_cast<Action*>( lmm_variable_id(var) );
578 if (action->getState() == SURF_ACTION_RUNNING ||
579 action->getState() == SURF_ACTION_READY) {
580 action->setFinishTime(date);
581 action->setState(SURF_ACTION_FAILED);
585 if (tmgr_trace_event_free(event_type))
588 XBT_CRITICAL("Unknown event ! \n");
593 ("There were a resource state event, need to update actions related to the constraint (%p)",
598 void NetworkCm02Link::updateBandwidth(double value, double date){
599 double delta = sg_weight_S_parameter / value - sg_weight_S_parameter /
600 (p_power.peak * p_power.scale);
601 lmm_variable_t var = NULL;
602 lmm_element_t elem = NULL;
603 lmm_element_t nextelem = NULL;
606 NetworkCm02Action *action = NULL;
608 p_power.peak = value;
609 lmm_update_constraint_bound(getModel()->getMaxminSystem(),
611 sg_bandwidth_factor *
612 (p_power.peak * p_power.scale));
613 TRACE_surf_link_set_bandwidth(date, getName(), sg_bandwidth_factor * p_power.peak * p_power.scale);
614 if (sg_weight_S_parameter > 0) {
615 while ((var = lmm_get_var_from_cnst_safe(getModel()->getMaxminSystem(), getConstraint(), &elem, &nextelem, &numelem))) {
616 action = (NetworkCm02Action*) lmm_variable_id(var);
617 action->m_weight += delta;
618 if (!action->isSuspended())
619 lmm_update_variable_weight(getModel()->getMaxminSystem(), action->getVariable(), action->m_weight);
624 void NetworkCm02Link::updateLatency(double value, double date){
625 double delta = value - m_latCurrent;
626 lmm_variable_t var = NULL;
627 lmm_element_t elem = NULL;
628 lmm_element_t nextelem = NULL;
630 NetworkCm02Action *action = NULL;
632 m_latCurrent = value;
633 while ((var = lmm_get_var_from_cnst_safe(getModel()->getMaxminSystem(), getConstraint(), &elem, &nextelem, &numelem))) {
634 action = (NetworkCm02Action*) lmm_variable_id(var);
635 action->m_latCurrent += delta;
636 action->m_weight += delta;
637 if (action->m_rate < 0)
638 lmm_update_variable_bound(getModel()->getMaxminSystem(), action->getVariable(), sg_tcp_gamma / (2.0 * action->m_latCurrent));
640 lmm_update_variable_bound(getModel()->getMaxminSystem(), action->getVariable(),
641 min(action->m_rate, sg_tcp_gamma / (2.0 * action->m_latCurrent)));
643 if (action->m_rate < sg_tcp_gamma / (2.0 * action->m_latCurrent)) {
644 XBT_INFO("Flow is limited BYBANDWIDTH");
646 XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f",
647 action->m_latCurrent);
650 if (!action->isSuspended())
651 lmm_update_variable_weight(getModel()->getMaxminSystem(), action->getVariable(), action->m_weight);
658 void NetworkCm02Action::updateRemainingLazy(double now)
662 if (m_suspended != 0)
665 delta = now - m_lastUpdate;
668 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, m_remains, m_lastUpdate);
669 double_update(&(m_remains), m_lastValue * delta, sg_maxmin_precision*sg_surf_precision);
671 XBT_DEBUG("Updating action(%p): remains is now %f", this, m_remains);
674 if (m_maxDuration != NO_MAX_DURATION)
675 double_update(&m_maxDuration, delta, sg_surf_precision);
677 if (m_remains <= 0 &&
678 (lmm_get_variable_weight(getVariable()) > 0)) {
680 setState(SURF_ACTION_DONE);
682 heapRemove(getModel()->getActionHeap());
683 } else if (((m_maxDuration != NO_MAX_DURATION)
684 && (m_maxDuration <= 0))) {
686 setState(SURF_ACTION_DONE);
687 heapRemove(getModel()->getActionHeap());
691 m_lastValue = lmm_variable_getvalue(getVariable());