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;
23 /************************************************************************/
24 /* New model based on optimizations discussed during Pedro Velho's thesis*/
25 /************************************************************************/
26 /* @techreport{VELHO:2011:HAL-00646896:1, */
27 /* url = {http://hal.inria.fr/hal-00646896/en/}, */
28 /* title = {{Flow-level network models: have we reached the limits?}}, */
29 /* author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
30 /* type = {Rapport de recherche}, */
31 /* institution = {INRIA}, */
32 /* number = {RR-7821}, */
35 /* pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
37 void surf_network_model_init_LegrandVelho(void)
39 if (surf_network_model)
42 simgrid::surf::on_link.connect(netlink_parse_init);
43 surf_network_model = new simgrid::surf::NetworkCm02Model();
44 xbt_dynar_push(all_existing_models, &surf_network_model);
46 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 13.01);
47 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 0.97);
48 xbt_cfg_setdefault_double(_sg_cfg_set, "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(void)
65 if (surf_network_model)
68 simgrid::surf::on_link.connect(netlink_parse_init);
69 surf_network_model = new simgrid::surf::NetworkCm02Model();
70 xbt_dynar_push(all_existing_models, &surf_network_model);
72 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
73 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
74 xbt_cfg_setdefault_double(_sg_cfg_set, "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(void)
89 if (surf_network_model)
92 simgrid::surf::on_link.connect(netlink_parse_init);
93 surf_network_model = new simgrid::surf::NetworkCm02Model();
94 xbt_dynar_push(all_existing_models, &surf_network_model);
96 lmm_set_default_protocol_function(func_reno_f, func_reno_fp, func_reno_fpi);
97 surf_network_model->f_networkSolve = lagrange_solve;
99 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 10.4);
100 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 0.92);
101 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 8775);
105 void surf_network_model_init_Reno2(void)
107 if (surf_network_model)
110 simgrid::surf::on_link.connect(netlink_parse_init);
111 surf_network_model = new simgrid::surf::NetworkCm02Model();
112 xbt_dynar_push(all_existing_models, &surf_network_model);
114 lmm_set_default_protocol_function(func_reno2_f, func_reno2_fp, func_reno2_fpi);
115 surf_network_model->f_networkSolve = lagrange_solve;
117 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 10.4);
118 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 0.92);
119 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 8775);
122 void surf_network_model_init_Vegas(void)
124 if (surf_network_model)
127 simgrid::surf::on_link.connect(netlink_parse_init);
128 surf_network_model = new simgrid::surf::NetworkCm02Model();
129 xbt_dynar_push(all_existing_models, &surf_network_model);
131 lmm_set_default_protocol_function(func_vegas_f, func_vegas_fp, func_vegas_fpi);
132 surf_network_model->f_networkSolve = lagrange_solve;
134 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 10.4);
135 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 0.92);
136 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 8775);
142 NetworkCm02Model::NetworkCm02Model()
145 char *optim = xbt_cfg_get_string(_sg_cfg_set, "network/optim");
146 int select = xbt_cfg_get_boolean(_sg_cfg_set, "network/maxmin_selective_update");
148 if (!strcmp(optim, "Full")) {
149 p_updateMechanism = UM_FULL;
150 m_selectiveUpdate = select;
151 } else if (!strcmp(optim, "Lazy")) {
152 p_updateMechanism = UM_LAZY;
153 m_selectiveUpdate = 1;
154 xbt_assert((select == 1) || (xbt_cfg_is_default_value(_sg_cfg_set, "network/maxmin_selective_update")),
155 "Disabling selective update while using the lazy update mechanism is dumb!");
157 xbt_die("Unsupported optimization (%s) for this model", optim);
161 p_maxminSystem = lmm_system_new(m_selectiveUpdate);
163 routing_model_create(createLink("__loopback__",
164 498000000, NULL, 0.000015, NULL,
166 SURF_LINK_FATPIPE, NULL));
168 if (p_updateMechanism == UM_LAZY) {
169 p_actionHeap = xbt_heap_new(8, NULL);
170 xbt_heap_set_update_callback(p_actionHeap, surf_action_lmm_update_index_heap);
171 p_modifiedSet = new ActionLmmList();
172 p_maxminSystem->keep_track = p_modifiedSet;
176 Link* NetworkCm02Model::createLink(const char *name,
177 double bw_initial, tmgr_trace_t bw_trace,
178 double lat_initial, tmgr_trace_t lat_trace,
179 tmgr_trace_t state_trace,
180 e_surf_link_sharing_policy_t policy, xbt_dict_t properties)
182 xbt_assert(NULL == Link::byName(name),
183 "Link '%s' declared several times in the platform",
186 Link* link = new NetworkCm02Link(this, name, properties, p_maxminSystem, sg_bandwidth_factor * bw_initial,
187 state_trace, bw_initial, bw_trace, lat_initial, lat_trace, policy);
188 Link::onCreation(link);
192 void NetworkCm02Model::updateActionsStateLazy(double now, double /*delta*/)
194 NetworkCm02Action *action;
195 while ((xbt_heap_size(p_actionHeap) > 0)
196 && (double_equals(xbt_heap_maxkey(p_actionHeap), now, sg_surf_precision))) {
197 action = static_cast<NetworkCm02Action*> (xbt_heap_pop(p_actionHeap));
198 XBT_DEBUG("Something happened to action %p", action);
199 if (TRACE_is_enabled()) {
200 int n = lmm_get_number_of_cnst_from_var(p_maxminSystem, action->getVariable());
202 for (int i = 0; i < n; i++){
203 lmm_constraint_t constraint = lmm_get_cnst_from_var(p_maxminSystem, action->getVariable(), i);
204 NetworkCm02Link *link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
205 TRACE_surf_link_set_utilization(link->getName(),
206 action->getCategory(),
207 (lmm_variable_getvalue(action->getVariable())*
208 lmm_get_cnst_weight_from_var(p_maxminSystem,
209 action->getVariable(),
211 action->getLastUpdate(),
212 now - action->getLastUpdate());
216 // if I am wearing a latency hat
217 if (action->getHat() == LATENCY) {
218 XBT_DEBUG("Latency paid for action %p. Activating", action);
219 lmm_update_variable_weight(p_maxminSystem, action->getVariable(), action->m_weight);
220 action->heapRemove(p_actionHeap);
221 action->refreshLastUpdate();
223 // if I am wearing a max_duration or normal hat
224 } else if (action->getHat() == MAX_DURATION ||
225 action->getHat() == NORMAL) {
226 // no need to communicate anymore
227 // assume that flows that reached max_duration have remaining of 0
228 XBT_DEBUG("Action %p finished", action);
229 action->setRemains(0);
231 action->setState(SURF_ACTION_DONE);
232 action->heapRemove(p_actionHeap);
241 void NetworkCm02Model::updateActionsStateFull(double now, double delta)
243 NetworkCm02Action *action;
244 ActionList *running_actions = getRunningActionSet();
246 for(ActionList::iterator it(running_actions->begin()), itNext=it, itend(running_actions->end())
247 ; it != itend ; it=itNext) {
250 action = static_cast<NetworkCm02Action*> (&*it);
251 XBT_DEBUG("Something happened to action %p", action);
252 double deltap = delta;
253 if (action->m_latency > 0) {
254 if (action->m_latency > deltap) {
255 double_update(&(action->m_latency), deltap, sg_surf_precision);
258 double_update(&(deltap), action->m_latency, sg_surf_precision);
259 action->m_latency = 0.0;
261 if (action->m_latency == 0.0 && !(action->isSuspended()))
262 lmm_update_variable_weight(p_maxminSystem, action->getVariable(),
265 if (TRACE_is_enabled()) {
266 int n = lmm_get_number_of_cnst_from_var(p_maxminSystem, action->getVariable());
267 for (int i = 0; i < n; i++){
268 lmm_constraint_t constraint = lmm_get_cnst_from_var(p_maxminSystem, action->getVariable(), i);
270 NetworkCm02Link* link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
271 TRACE_surf_link_set_utilization(link->getName(),
272 action->getCategory(),
273 (lmm_variable_getvalue(action->getVariable())*
274 lmm_get_cnst_weight_from_var(p_maxminSystem,
275 action->getVariable(),
277 action->getLastUpdate(),
278 now - action->getLastUpdate());
281 if (!lmm_get_number_of_cnst_from_var (p_maxminSystem, action->getVariable())) {
282 /* There is actually no link used, hence an infinite bandwidth.
283 * This happens often when using models like vivaldi.
284 * In such case, just make sure that the action completes immediately.
286 action->updateRemains(action->getRemains());
288 action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
290 if (action->getMaxDuration() != NO_MAX_DURATION)
291 action->updateMaxDuration(delta);
293 if ((action->getRemains() <= 0) &&
294 (lmm_get_variable_weight(action->getVariable()) > 0)) {
296 action->setState(SURF_ACTION_DONE);
298 } else if (((action->getMaxDuration() != NO_MAX_DURATION)
299 && (action->getMaxDuration() <= 0))) {
301 action->setState(SURF_ACTION_DONE);
307 Action *NetworkCm02Model::communicate(NetCard *src, NetCard *dst,
308 double size, double rate)
312 NetworkCm02Link *link;
314 NetworkCm02Action *action = NULL;
315 double bandwidth_bound;
316 double latency = 0.0;
317 xbt_dynar_t back_route = NULL;
318 int constraints_per_variable = 0;
320 xbt_dynar_t route = xbt_dynar_new(sizeof(NetCard*), NULL);
322 XBT_IN("(%s,%s,%g,%g)", src->name(), dst->name(), size, rate);
324 routing_platf->getRouteAndLatency(src, dst, &route, &latency);
325 xbt_assert(!xbt_dynar_is_empty(route) || latency,
326 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
327 src->name(), dst->name());
329 xbt_dynar_foreach(route, i, _link) {
330 link = static_cast<NetworkCm02Link*>(_link);
336 if (sg_network_crosstraffic == 1) {
337 routing_platf->getRouteAndLatency(dst, src, &back_route, NULL);
338 xbt_dynar_foreach(back_route, i, _link) {
339 link = static_cast<NetworkCm02Link*>(_link);
347 action = new NetworkCm02Action(this, size, failed);
349 #ifdef HAVE_LATENCY_BOUND_TRACKING
350 action->m_latencyLimited = 0;
352 action->m_weight = action->m_latency = latency;
354 action->m_rate = rate;
355 if (p_updateMechanism == UM_LAZY) {
356 action->m_indexHeap = -1;
357 action->m_lastUpdate = surf_get_clock();
360 bandwidth_bound = -1.0;
361 if (sg_weight_S_parameter > 0) {
362 xbt_dynar_foreach(route, i, _link) {
363 link = static_cast<NetworkCm02Link*>(_link);
364 action->m_weight += sg_weight_S_parameter / link->getBandwidth();
367 xbt_dynar_foreach(route, i, _link) {
368 link = static_cast<NetworkCm02Link*>(_link);
369 double bb = bandwidthFactor(size) * link->getBandwidth();
371 (bandwidth_bound < 0.0) ? bb : std::min(bandwidth_bound, bb);
374 action->m_latCurrent = action->m_latency;
375 action->m_latency *= latencyFactor(size);
376 action->m_rate = bandwidthConstraint(action->m_rate, bandwidth_bound, size);
378 xbt_assert(!xbt_dynar_is_empty(route),
379 "Using a model with a gap (e.g., SMPI) with a platform without links (e.g. vivaldi)!!!");
381 link = *static_cast<NetworkCm02Link **>(xbt_dynar_get_ptr(route, 0));
382 gapAppend(size, link, action);
383 XBT_DEBUG("Comm %p: %s -> %s gap=%f (lat=%f)",
384 action, src->name(), dst->name(), action->m_senderGap,
388 constraints_per_variable = xbt_dynar_length(route);
389 if (back_route != NULL)
390 constraints_per_variable += xbt_dynar_length(back_route);
392 if (action->m_latency > 0) {
393 action->p_variable = lmm_variable_new(p_maxminSystem, action, 0.0, -1.0,
394 constraints_per_variable);
395 if (p_updateMechanism == UM_LAZY) {
396 // add to the heap the event when the latency is payed
397 XBT_DEBUG("Added action (%p) one latency event at date %f", action,
398 action->m_latency + action->m_lastUpdate);
399 action->heapInsert(p_actionHeap, action->m_latency + action->m_lastUpdate, xbt_dynar_is_empty(route) ? NORMAL : LATENCY);
402 action->p_variable = lmm_variable_new(p_maxminSystem, action, 1.0, -1.0, constraints_per_variable);
404 if (action->m_rate < 0) {
405 lmm_update_variable_bound(p_maxminSystem, action->getVariable(), (action->m_latCurrent > 0) ? sg_tcp_gamma / (2.0 * action->m_latCurrent) : -1.0);
407 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);
410 xbt_dynar_foreach(route, i, _link) {
411 link = static_cast<NetworkCm02Link*>(_link);
412 lmm_expand(p_maxminSystem, link->getConstraint(), action->getVariable(), 1.0);
415 if (sg_network_crosstraffic == 1) {
416 XBT_DEBUG("Fullduplex active adding backward flow using 5%%");
417 xbt_dynar_foreach(back_route, i, _link) {
418 link = static_cast<NetworkCm02Link*>(_link);
419 lmm_expand(p_maxminSystem, link->getConstraint(), action->getVariable(), .05);
421 lmm_variable_concurrency_share_set(action->getVariable(),2);
424 xbt_dynar_free(&route);
427 networkCommunicateCallbacks(action, src, dst, size, rate);
434 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model *model, const char *name, xbt_dict_t props,
436 double constraint_value,
437 tmgr_trace_t state_trace,
438 double bw_peak, tmgr_trace_t bw_trace,
439 double lat_initial, tmgr_trace_t lat_trace,
440 e_surf_link_sharing_policy_t policy)
441 : Link(model, name, props, lmm_constraint_new(system, this, constraint_value), state_trace)
443 m_bandwidth.scale = 1.0;
444 m_bandwidth.peak = bw_peak;
446 m_bandwidth.event = future_evt_set->add_trace(bw_trace, 0.0, this);
448 m_bandwidth.event = NULL;
450 m_latency.scale = 1.0;
451 m_latency.peak = lat_initial;
453 m_latency.event = future_evt_set->add_trace(lat_trace, 0.0, this);
455 if (policy == SURF_LINK_FATPIPE)
456 lmm_constraint_shared(getConstraint());
461 void NetworkCm02Link::apply_event(tmgr_trace_iterator_t triggered, double value)
464 /* Find out which of my iterators was triggered, and react accordingly */
465 if (triggered == m_bandwidth.event) {
466 updateBandwidth(value);
467 tmgr_trace_event_unref(&m_bandwidth.event);
469 } else if (triggered == m_latency.event) {
470 updateLatency(value);
471 tmgr_trace_event_unref(&m_latency.event);
473 } else if (triggered == m_stateEvent) {
477 lmm_variable_t var = NULL;
478 lmm_element_t elem = NULL;
479 double now = surf_get_clock();
482 while ((var = lmm_get_var_from_cnst(getModel()->getMaxminSystem(), getConstraint(), &elem))) {
483 Action *action = static_cast<Action*>( lmm_variable_id(var) );
485 if (action->getState() == SURF_ACTION_RUNNING ||
486 action->getState() == SURF_ACTION_READY) {
487 action->setFinishTime(now);
488 action->setState(SURF_ACTION_FAILED);
492 tmgr_trace_event_unref(&m_stateEvent);
494 xbt_die("Unknown event!\n");
497 XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
501 void NetworkCm02Link::updateBandwidth(double value) {
503 m_bandwidth.peak = value;
505 lmm_update_constraint_bound(getModel()->getMaxminSystem(), getConstraint(),
506 sg_bandwidth_factor * (m_bandwidth.peak * m_bandwidth.scale));
507 TRACE_surf_link_set_bandwidth(surf_get_clock(), getName(), sg_bandwidth_factor * m_bandwidth.peak * m_bandwidth.scale);
509 if (sg_weight_S_parameter > 0) {
510 double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (m_bandwidth.peak * m_bandwidth.scale);
513 lmm_element_t elem = NULL, nextelem = NULL;
515 while ((var = lmm_get_var_from_cnst_safe(getModel()->getMaxminSystem(), getConstraint(), &elem, &nextelem, &numelem))) {
516 NetworkCm02Action *action = (NetworkCm02Action*) lmm_variable_id(var);
517 action->m_weight += delta;
518 if (!action->isSuspended())
519 lmm_update_variable_weight(getModel()->getMaxminSystem(), action->getVariable(), action->m_weight);
524 void NetworkCm02Link::updateLatency(double value){
525 double delta = value - m_latency.peak;
526 lmm_variable_t var = NULL;
527 lmm_element_t elem = NULL;
528 lmm_element_t nextelem = NULL;
531 m_latency.peak = value;
533 while ((var = lmm_get_var_from_cnst_safe(getModel()->getMaxminSystem(), getConstraint(), &elem, &nextelem, &numelem))) {
534 NetworkCm02Action *action = (NetworkCm02Action*) lmm_variable_id(var);
535 action->m_latCurrent += delta;
536 action->m_weight += delta;
537 if (action->m_rate < 0)
538 lmm_update_variable_bound(getModel()->getMaxminSystem(), action->getVariable(), sg_tcp_gamma / (2.0 * action->m_latCurrent));
540 lmm_update_variable_bound(getModel()->getMaxminSystem(), action->getVariable(),
541 std::min(action->m_rate, sg_tcp_gamma / (2.0 * action->m_latCurrent)));
543 if (action->m_rate < sg_tcp_gamma / (2.0 * action->m_latCurrent)) {
544 XBT_INFO("Flow is limited BYBANDWIDTH");
546 XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->m_latCurrent);
549 if (!action->isSuspended())
550 lmm_update_variable_weight(getModel()->getMaxminSystem(), action->getVariable(), action->m_weight);
557 void NetworkCm02Action::updateRemainingLazy(double now)
561 if (m_suspended != 0)
564 delta = now - m_lastUpdate;
567 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, m_remains, m_lastUpdate);
568 double_update(&(m_remains), m_lastValue * delta, sg_maxmin_precision*sg_surf_precision);
570 XBT_DEBUG("Updating action(%p): remains is now %f", this, m_remains);
573 if (m_maxDuration != NO_MAX_DURATION)
574 double_update(&m_maxDuration, delta, sg_surf_precision);
576 if (m_remains <= 0 &&
577 (lmm_get_variable_weight(getVariable()) > 0)) {
579 setState(SURF_ACTION_DONE);
581 heapRemove(getModel()->getActionHeap());
582 } else if (((m_maxDuration != NO_MAX_DURATION)
583 && (m_maxDuration <= 0))) {
585 setState(SURF_ACTION_DONE);
586 heapRemove(getModel()->getActionHeap());
590 m_lastValue = lmm_variable_getvalue(getVariable());