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");
162 xbt_cfg_get_boolean(_sg_cfg_set, "network/maxmin_selective_update");
164 if (!strcmp(optim, "Full")) {
165 p_updateMechanism = UM_FULL;
166 m_selectiveUpdate = select;
167 } else if (!strcmp(optim, "Lazy")) {
168 p_updateMechanism = UM_LAZY;
169 m_selectiveUpdate = 1;
170 xbt_assert((select == 1) || (xbt_cfg_is_default_value(_sg_cfg_set, "network/maxmin_selective_update")),
171 "Disabling selective update while using the lazy update mechanism is dumb!");
173 xbt_die("Unsupported optimization (%s) for this model", optim);
177 p_maxminSystem = lmm_system_new(m_selectiveUpdate);
179 routing_model_create(createLink("__loopback__",
180 498000000, NULL, 0.000015, NULL,
181 1 /*SURF_RESOURCE_ON*/, NULL,
182 SURF_LINK_FATPIPE, NULL));
184 if (p_updateMechanism == UM_LAZY) {
185 p_actionHeap = xbt_heap_new(8, NULL);
186 xbt_heap_set_update_callback(p_actionHeap, surf_action_lmm_update_index_heap);
187 p_modifiedSet = new ActionLmmList();
188 p_maxminSystem->keep_track = p_modifiedSet;
192 Link* NetworkCm02Model::createLink(const char *name,
194 tmgr_trace_t bw_trace,
196 tmgr_trace_t lat_trace,
198 tmgr_trace_t state_trace,
199 e_surf_link_sharing_policy_t policy,
200 xbt_dict_t properties)
202 xbt_assert(NULL == Link::byName(name),
203 "Link '%s' declared several times in the platform",
206 Link* link = new NetworkCm02Link(this, name, properties, p_maxminSystem, sg_bandwidth_factor * bw_initial,
207 initiallyOn, state_trace, bw_initial, bw_trace, lat_initial, lat_trace, policy);
208 Link::onCreation(link);
212 void NetworkCm02Model::updateActionsStateLazy(double now, double /*delta*/)
214 NetworkCm02Action *action;
215 while ((xbt_heap_size(p_actionHeap) > 0)
216 && (double_equals(xbt_heap_maxkey(p_actionHeap), now, sg_surf_precision))) {
217 action = static_cast<NetworkCm02Action*> (xbt_heap_pop(p_actionHeap));
218 XBT_DEBUG("Something happened to action %p", action);
219 if (TRACE_is_enabled()) {
220 int n = lmm_get_number_of_cnst_from_var(p_maxminSystem, action->getVariable());
222 for (i = 0; i < n; i++){
223 lmm_constraint_t constraint = lmm_get_cnst_from_var(p_maxminSystem,
224 action->getVariable(),
226 NetworkCm02Link *link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
227 TRACE_surf_link_set_utilization(link->getName(),
228 action->getCategory(),
229 (lmm_variable_getvalue(action->getVariable())*
230 lmm_get_cnst_weight_from_var(p_maxminSystem,
231 action->getVariable(),
233 action->getLastUpdate(),
234 now - action->getLastUpdate());
238 // if I am wearing a latency hat
239 if (action->getHat() == LATENCY) {
240 XBT_DEBUG("Latency paid for action %p. Activating", action);
241 lmm_update_variable_weight(p_maxminSystem, action->getVariable(), action->m_weight);
242 action->heapRemove(p_actionHeap);
243 action->refreshLastUpdate();
245 // if I am wearing a max_duration or normal hat
246 } else if (action->getHat() == MAX_DURATION ||
247 action->getHat() == NORMAL) {
248 // no need to communicate anymore
249 // assume that flows that reached max_duration have remaining of 0
250 XBT_DEBUG("Action %p finished", action);
251 action->setRemains(0);
253 action->setState(SURF_ACTION_DONE);
254 action->heapRemove(p_actionHeap);
263 void NetworkCm02Model::updateActionsStateFull(double now, double delta)
265 NetworkCm02Action *action;
266 ActionList *running_actions = getRunningActionSet();
268 for(ActionList::iterator it(running_actions->begin()), itNext=it, itend(running_actions->end())
269 ; it != itend ; it=itNext) {
272 action = static_cast<NetworkCm02Action*> (&*it);
273 XBT_DEBUG("Something happened to action %p", action);
274 double deltap = delta;
275 if (action->m_latency > 0) {
276 if (action->m_latency > deltap) {
277 double_update(&(action->m_latency), deltap, sg_surf_precision);
280 double_update(&(deltap), action->m_latency, sg_surf_precision);
281 action->m_latency = 0.0;
283 if (action->m_latency == 0.0 && !(action->isSuspended()))
284 lmm_update_variable_weight(p_maxminSystem, action->getVariable(),
287 if (TRACE_is_enabled()) {
288 int n = lmm_get_number_of_cnst_from_var(p_maxminSystem, action->getVariable());
290 for (i = 0; i < n; i++){
291 lmm_constraint_t constraint = lmm_get_cnst_from_var(p_maxminSystem,
292 action->getVariable(),
294 NetworkCm02Link* link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
295 TRACE_surf_link_set_utilization(link->getName(),
296 action->getCategory(),
297 (lmm_variable_getvalue(action->getVariable())*
298 lmm_get_cnst_weight_from_var(p_maxminSystem,
299 action->getVariable(),
301 action->getLastUpdate(),
302 now - action->getLastUpdate());
305 if (!lmm_get_number_of_cnst_from_var
306 (p_maxminSystem, action->getVariable())) {
307 /* There is actually no link used, hence an infinite bandwidth.
308 * This happens often when using models like vivaldi.
309 * In such case, just make sure that the action completes immediately.
311 action->updateRemains(action->getRemains());
313 action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
315 if (action->getMaxDuration() != NO_MAX_DURATION)
316 action->updateMaxDuration(delta);
318 if ((action->getRemains() <= 0) &&
319 (lmm_get_variable_weight(action->getVariable()) > 0)) {
321 action->setState(SURF_ACTION_DONE);
323 } else if (((action->getMaxDuration() != NO_MAX_DURATION)
324 && (action->getMaxDuration() <= 0))) {
326 action->setState(SURF_ACTION_DONE);
333 Action *NetworkCm02Model::communicate(NetCard *src, NetCard *dst,
334 double size, double rate)
338 NetworkCm02Link *link;
340 NetworkCm02Action *action = NULL;
341 double bandwidth_bound;
342 double latency = 0.0;
343 xbt_dynar_t back_route = NULL;
344 int constraints_per_variable = 0;
346 xbt_dynar_t route = xbt_dynar_new(sizeof(NetCard*), NULL);
348 XBT_IN("(%s,%s,%g,%g)", src->getName(), dst->getName(), size, rate);
350 routing_platf->getRouteAndLatency(src, dst, &route, &latency);
351 xbt_assert(!xbt_dynar_is_empty(route) || latency,
352 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
353 src->getName(), dst->getName());
355 xbt_dynar_foreach(route, i, _link) {
356 link = static_cast<NetworkCm02Link*>(_link);
362 if (sg_network_crosstraffic == 1) {
363 routing_platf->getRouteAndLatency(dst, src, &back_route, NULL);
364 xbt_dynar_foreach(back_route, i, _link) {
365 link = static_cast<NetworkCm02Link*>(_link);
373 action = new NetworkCm02Action(this, size, failed);
375 #ifdef HAVE_LATENCY_BOUND_TRACKING
376 action->m_latencyLimited = 0;
378 action->m_weight = action->m_latency = latency;
380 action->m_rate = rate;
381 if (p_updateMechanism == UM_LAZY) {
382 action->m_indexHeap = -1;
383 action->m_lastUpdate = surf_get_clock();
386 bandwidth_bound = -1.0;
387 if (sg_weight_S_parameter > 0) {
388 xbt_dynar_foreach(route, i, _link) {
389 link = static_cast<NetworkCm02Link*>(_link);
390 action->m_weight += sg_weight_S_parameter / link->getBandwidth();
393 xbt_dynar_foreach(route, i, _link) {
394 link = static_cast<NetworkCm02Link*>(_link);
395 double bb = bandwidthFactor(size) * link->getBandwidth();
397 (bandwidth_bound < 0.0) ? bb : std::min(bandwidth_bound, bb);
400 action->m_latCurrent = action->m_latency;
401 action->m_latency *= latencyFactor(size);
402 action->m_rate = bandwidthConstraint(action->m_rate, bandwidth_bound, size);
404 xbt_assert(!xbt_dynar_is_empty(route),
405 "Using a model with a gap (e.g., SMPI) with a platform without links (e.g. vivaldi)!!!");
407 link = *static_cast<NetworkCm02Link **>(xbt_dynar_get_ptr(route, 0));
408 gapAppend(size, link, action);
409 XBT_DEBUG("Comm %p: %s -> %s gap=%f (lat=%f)",
410 action, src->getName(), dst->getName(), action->m_senderGap,
414 constraints_per_variable = xbt_dynar_length(route);
415 if (back_route != NULL)
416 constraints_per_variable += xbt_dynar_length(back_route);
418 if (action->m_latency > 0) {
419 action->p_variable = lmm_variable_new(p_maxminSystem, action, 0.0, -1.0,
420 constraints_per_variable);
421 if (p_updateMechanism == UM_LAZY) {
422 // add to the heap the event when the latency is payed
423 XBT_DEBUG("Added action (%p) one latency event at date %f", action,
424 action->m_latency + action->m_lastUpdate);
425 action->heapInsert(p_actionHeap, action->m_latency + action->m_lastUpdate, xbt_dynar_is_empty(route) ? NORMAL : LATENCY);
428 action->p_variable = lmm_variable_new(p_maxminSystem, action, 1.0, -1.0, constraints_per_variable);
430 if (action->m_rate < 0) {
431 lmm_update_variable_bound(p_maxminSystem, action->getVariable(), (action->m_latCurrent > 0) ? sg_tcp_gamma / (2.0 * action->m_latCurrent) : -1.0);
433 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);
436 xbt_dynar_foreach(route, i, _link) {
437 link = static_cast<NetworkCm02Link*>(_link);
438 lmm_expand(p_maxminSystem, link->getConstraint(), action->getVariable(), 1.0);
441 if (sg_network_crosstraffic == 1) {
442 XBT_DEBUG("Fullduplex active adding backward flow using 5%%");
443 xbt_dynar_foreach(back_route, i, _link) {
444 link = static_cast<NetworkCm02Link*>(_link);
445 lmm_expand(p_maxminSystem, link->getConstraint(), action->getVariable(), .05);
447 lmm_variable_concurrency_share_set(action->getVariable(),2);
450 xbt_dynar_free(&route);
453 networkCommunicateCallbacks(action, src, dst, size, rate);
457 void NetworkCm02Model::addTraces(){
464 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model *model, const char *name, xbt_dict_t props,
466 double constraint_value,
467 int initiallyOn, tmgr_trace_t state_trace,
468 double bw_peak, tmgr_trace_t bw_trace,
469 double lat_initial, tmgr_trace_t lat_trace,
470 e_surf_link_sharing_policy_t policy)
471 : Link(model, name, props, lmm_constraint_new(system, this, constraint_value), state_trace)
478 m_bandwidth.scale = 1.0;
479 m_bandwidth.peak = bw_peak;
481 m_bandwidth.event = future_evt_set->add_trace(bw_trace, 0.0, this);
483 m_bandwidth.event = NULL;
485 m_latency.scale = 1.0;
486 m_latency.peak = lat_initial;
488 m_latency.event = future_evt_set->add_trace(lat_trace, 0.0, this);
490 if (policy == SURF_LINK_FATPIPE)
491 lmm_constraint_shared(getConstraint());
496 void NetworkCm02Link::apply_event(tmgr_trace_iterator_t triggered, double value)
499 /* Find out which of my iterators was triggered, and react accordingly */
500 if (triggered == m_bandwidth.event) {
501 updateBandwidth(value);
502 tmgr_trace_event_unref(&m_bandwidth.event);
503 } else if (triggered == m_latency.event) {
504 updateLatency(value);
505 tmgr_trace_event_unref(&m_latency.event);
506 } else if (triggered == m_stateEvent) {
510 lmm_variable_t var = NULL;
511 lmm_element_t elem = NULL;
512 double now = surf_get_clock();
515 while ((var = lmm_get_var_from_cnst(getModel()->getMaxminSystem(), getConstraint(), &elem))) {
516 Action *action = static_cast<Action*>( lmm_variable_id(var) );
518 if (action->getState() == SURF_ACTION_RUNNING ||
519 action->getState() == SURF_ACTION_READY) {
520 action->setFinishTime(now);
521 action->setState(SURF_ACTION_FAILED);
525 tmgr_trace_event_unref(&m_stateEvent);
527 xbt_die("Unknown event!\n");
531 ("There was a resource state event, need to update actions related to the constraint (%p)",
535 void NetworkCm02Link::updateBandwidth(double value) {
536 double delta = sg_weight_S_parameter / value - sg_weight_S_parameter /
537 (m_bandwidth.peak * m_bandwidth.scale);
538 lmm_variable_t var = NULL;
539 lmm_element_t elem = NULL;
540 lmm_element_t nextelem = NULL;
543 NetworkCm02Action *action = NULL;
545 m_bandwidth.peak = value;
546 lmm_update_constraint_bound(getModel()->getMaxminSystem(),
548 sg_bandwidth_factor *
549 (m_bandwidth.peak * m_bandwidth.scale));
550 TRACE_surf_link_set_bandwidth(surf_get_clock(), getName(), sg_bandwidth_factor * m_bandwidth.peak * m_bandwidth.scale);
551 if (sg_weight_S_parameter > 0) {
552 while ((var = lmm_get_var_from_cnst_safe(getModel()->getMaxminSystem(), getConstraint(), &elem, &nextelem, &numelem))) {
553 action = (NetworkCm02Action*) lmm_variable_id(var);
554 action->m_weight += delta;
555 if (!action->isSuspended())
556 lmm_update_variable_weight(getModel()->getMaxminSystem(), action->getVariable(), action->m_weight);
561 void NetworkCm02Link::updateLatency(double value){
562 double delta = value - m_latency.peak;
563 lmm_variable_t var = NULL;
564 lmm_element_t elem = NULL;
565 lmm_element_t nextelem = NULL;
567 NetworkCm02Action *action = NULL;
569 m_latency.peak = value;
570 while ((var = lmm_get_var_from_cnst_safe(getModel()->getMaxminSystem(), getConstraint(), &elem, &nextelem, &numelem))) {
571 action = (NetworkCm02Action*) lmm_variable_id(var);
572 action->m_latCurrent += delta;
573 action->m_weight += delta;
574 if (action->m_rate < 0)
575 lmm_update_variable_bound(getModel()->getMaxminSystem(), action->getVariable(), sg_tcp_gamma / (2.0 * action->m_latCurrent));
577 lmm_update_variable_bound(getModel()->getMaxminSystem(), action->getVariable(),
578 std::min(action->m_rate, sg_tcp_gamma / (2.0 * action->m_latCurrent)));
580 if (action->m_rate < sg_tcp_gamma / (2.0 * action->m_latCurrent)) {
581 XBT_INFO("Flow is limited BYBANDWIDTH");
583 XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f",
584 action->m_latCurrent);
587 if (!action->isSuspended())
588 lmm_update_variable_weight(getModel()->getMaxminSystem(), action->getVariable(), action->m_weight);
595 void NetworkCm02Action::updateRemainingLazy(double now)
599 if (m_suspended != 0)
602 delta = now - m_lastUpdate;
605 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, m_remains, m_lastUpdate);
606 double_update(&(m_remains), m_lastValue * delta, sg_maxmin_precision*sg_surf_precision);
608 XBT_DEBUG("Updating action(%p): remains is now %f", this, m_remains);
611 if (m_maxDuration != NO_MAX_DURATION)
612 double_update(&m_maxDuration, delta, sg_surf_precision);
614 if (m_remains <= 0 &&
615 (lmm_get_variable_weight(getVariable()) > 0)) {
617 setState(SURF_ACTION_DONE);
619 heapRemove(getModel()->getActionHeap());
620 } else if (((m_maxDuration != NO_MAX_DURATION)
621 && (m_maxDuration <= 0))) {
623 setState(SURF_ACTION_DONE);
624 heapRemove(getModel()->getActionHeap());
628 m_lastValue = lmm_variable_getvalue(getVariable());