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/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
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;
24 /************************************************************************/
25 /* New model based on optimizations discussed during Pedro Velho's thesis*/
26 /************************************************************************/
27 /* @techreport{VELHO:2011:HAL-00646896:1, */
28 /* url = {http://hal.inria.fr/hal-00646896/en/}, */
29 /* title = {{Flow-level network models: have we reached the limits?}}, */
30 /* author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
31 /* type = {Rapport de recherche}, */
32 /* institution = {INRIA}, */
33 /* number = {RR-7821}, */
36 /* pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
38 void surf_network_model_init_LegrandVelho(void)
40 if (surf_network_model)
43 simgrid::surf::on_link.connect(netlink_parse_init);
44 surf_network_model = new simgrid::surf::NetworkCm02Model();
45 xbt_dynar_push(all_existing_models, &surf_network_model);
47 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 13.01);
48 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 0.97);
49 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 20537);
52 /***************************************************************************/
53 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
54 /***************************************************************************/
55 /* @TechReport{ rr-lip2002-40, */
56 /* author = {Henri Casanova and Loris Marchal}, */
57 /* institution = {LIP}, */
58 /* title = {A Network Model for Simulation of Grid Application}, */
59 /* number = {2002-40}, */
63 void surf_network_model_init_CM02(void)
66 if (surf_network_model)
69 simgrid::surf::on_link.connect(netlink_parse_init);
70 surf_network_model = new simgrid::surf::NetworkCm02Model();
71 xbt_dynar_push(all_existing_models, &surf_network_model);
73 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 1.0);
74 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
75 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 0.0);
78 /***************************************************************************/
79 /* The models from Steven H. Low */
80 /***************************************************************************/
82 /* author={Steven H. Low}, */
83 /* title={A Duality Model of {TCP} and Queue Management Algorithms}, */
85 /* journal={{IEEE/ACM} Transactions on Networking}, */
86 /* volume={11}, number={4}, */
88 void surf_network_model_init_Reno(void)
90 if (surf_network_model)
93 simgrid::surf::on_link.connect(netlink_parse_init);
94 surf_network_model = new simgrid::surf::NetworkCm02Model();
95 xbt_dynar_push(all_existing_models, &surf_network_model);
97 lmm_set_default_protocol_function(func_reno_f, func_reno_fp, func_reno_fpi);
98 surf_network_model->f_networkSolve = lagrange_solve;
100 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 10.4);
101 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 0.92);
102 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 8775);
106 void surf_network_model_init_Reno2(void)
108 if (surf_network_model)
111 simgrid::surf::on_link.connect(netlink_parse_init);
112 surf_network_model = new simgrid::surf::NetworkCm02Model();
113 xbt_dynar_push(all_existing_models, &surf_network_model);
115 lmm_set_default_protocol_function(func_reno2_f, func_reno2_fp, func_reno2_fpi);
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", 0.92);
120 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 8775);
123 void surf_network_model_init_Vegas(void)
125 if (surf_network_model)
128 simgrid::surf::on_link.connect(netlink_parse_init);
129 surf_network_model = new simgrid::surf::NetworkCm02Model();
130 xbt_dynar_push(all_existing_models, &surf_network_model);
132 lmm_set_default_protocol_function(func_vegas_f, func_vegas_fp, func_vegas_fpi);
133 surf_network_model->f_networkSolve = lagrange_solve;
135 xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor", 10.4);
136 xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 0.92);
137 xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S", 8775);
143 NetworkCm02Model::NetworkCm02Model()
146 char *optim = xbt_cfg_get_string(_sg_cfg_set, "network/optim");
147 int select = xbt_cfg_get_boolean(_sg_cfg_set, "network/maxmin_selective_update");
149 if (!strcmp(optim, "Full")) {
150 p_updateMechanism = UM_FULL;
151 m_selectiveUpdate = select;
152 } else if (!strcmp(optim, "Lazy")) {
153 p_updateMechanism = UM_LAZY;
154 m_selectiveUpdate = 1;
155 xbt_assert((select == 1) || (xbt_cfg_is_default_value(_sg_cfg_set, "network/maxmin_selective_update")),
156 "Disabling selective update while using the lazy update mechanism is dumb!");
158 xbt_die("Unsupported optimization (%s) for this model", optim);
162 p_maxminSystem = lmm_system_new(m_selectiveUpdate);
164 routing_model_create(createLink("__loopback__",
165 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 e_surf_link_sharing_policy_t policy, xbt_dict_t properties)
181 xbt_assert(NULL == Link::byName(name),
182 "Link '%s' declared several times in the platform",
185 Link* link = new NetworkCm02Link(this, name, properties, p_maxminSystem, sg_bandwidth_factor * bw_initial,
186 bw_initial, bw_trace, lat_initial, lat_trace, policy);
187 Link::onCreation(link);
191 void NetworkCm02Model::updateActionsStateLazy(double now, double /*delta*/)
193 NetworkCm02Action *action;
194 while ((xbt_heap_size(p_actionHeap) > 0)
195 && (double_equals(xbt_heap_maxkey(p_actionHeap), now, sg_surf_precision))) {
196 action = static_cast<NetworkCm02Action*> (xbt_heap_pop(p_actionHeap));
197 XBT_DEBUG("Something happened to action %p", action);
198 if (TRACE_is_enabled()) {
199 int n = lmm_get_number_of_cnst_from_var(p_maxminSystem, action->getVariable());
201 for (int i = 0; i < n; i++){
202 lmm_constraint_t constraint = lmm_get_cnst_from_var(p_maxminSystem, action->getVariable(), i);
203 NetworkCm02Link *link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
204 TRACE_surf_link_set_utilization(link->getName(),
205 action->getCategory(),
206 (lmm_variable_getvalue(action->getVariable())*
207 lmm_get_cnst_weight_from_var(p_maxminSystem,
208 action->getVariable(),
210 action->getLastUpdate(),
211 now - action->getLastUpdate());
215 // if I am wearing a latency hat
216 if (action->getHat() == LATENCY) {
217 XBT_DEBUG("Latency paid for action %p. Activating", action);
218 lmm_update_variable_weight(p_maxminSystem, action->getVariable(), action->m_weight);
219 action->heapRemove(p_actionHeap);
220 action->refreshLastUpdate();
222 // if I am wearing a max_duration or normal hat
223 } else if (action->getHat() == MAX_DURATION ||
224 action->getHat() == NORMAL) {
225 // no need to communicate anymore
226 // assume that flows that reached max_duration have remaining of 0
227 XBT_DEBUG("Action %p finished", action);
228 action->setRemains(0);
230 action->setState(SURF_ACTION_DONE);
231 action->heapRemove(p_actionHeap);
240 void NetworkCm02Model::updateActionsStateFull(double now, double delta)
242 NetworkCm02Action *action;
243 ActionList *running_actions = getRunningActionSet();
245 for(ActionList::iterator it(running_actions->begin()), itNext=it, itend(running_actions->end())
246 ; it != itend ; it=itNext) {
249 action = static_cast<NetworkCm02Action*> (&*it);
250 XBT_DEBUG("Something happened to action %p", action);
251 double deltap = delta;
252 if (action->m_latency > 0) {
253 if (action->m_latency > deltap) {
254 double_update(&(action->m_latency), deltap, sg_surf_precision);
257 double_update(&(deltap), action->m_latency, sg_surf_precision);
258 action->m_latency = 0.0;
260 if (action->m_latency == 0.0 && !(action->isSuspended()))
261 lmm_update_variable_weight(p_maxminSystem, action->getVariable(),
264 if (TRACE_is_enabled()) {
265 int n = lmm_get_number_of_cnst_from_var(p_maxminSystem, action->getVariable());
266 for (int i = 0; i < n; i++){
267 lmm_constraint_t constraint = lmm_get_cnst_from_var(p_maxminSystem, action->getVariable(), i);
269 NetworkCm02Link* link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
270 TRACE_surf_link_set_utilization(link->getName(),
271 action->getCategory(),
272 (lmm_variable_getvalue(action->getVariable())*
273 lmm_get_cnst_weight_from_var(p_maxminSystem,
274 action->getVariable(),
276 action->getLastUpdate(),
277 now - action->getLastUpdate());
280 if (!lmm_get_number_of_cnst_from_var (p_maxminSystem, action->getVariable())) {
281 /* There is actually no link used, hence an infinite bandwidth.
282 * This happens often when using models like vivaldi.
283 * In such case, just make sure that the action completes immediately.
285 action->updateRemains(action->getRemains());
287 action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
289 if (action->getMaxDuration() != NO_MAX_DURATION)
290 action->updateMaxDuration(delta);
292 if ((action->getRemains() <= 0) &&
293 (lmm_get_variable_weight(action->getVariable()) > 0)) {
295 action->setState(SURF_ACTION_DONE);
297 } else if (((action->getMaxDuration() != NO_MAX_DURATION)
298 && (action->getMaxDuration() <= 0))) {
300 action->setState(SURF_ACTION_DONE);
306 Action *NetworkCm02Model::communicate(NetCard *src, NetCard *dst, double size, double rate)
309 double bandwidth_bound;
310 double latency = 0.0;
311 std::vector<Link*> * back_route = NULL;
312 int constraints_per_variable = 0;
314 std::vector<Link*> *route = new std::vector<Link*>();
316 XBT_IN("(%s,%s,%g,%g)", src->name(), dst->name(), size, rate);
318 routing_platf->getRouteAndLatency(src, dst, route, &latency);
319 xbt_assert(! route->empty() || latency,
320 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
321 src->name(), dst->name());
323 for (auto link: *route)
327 if (sg_network_crosstraffic == 1) {
328 back_route = new std::vector<Link*>();
329 routing_platf->getRouteAndLatency(dst, src, back_route, NULL);
330 for (auto link: *back_route)
335 NetworkCm02Action *action = new NetworkCm02Action(this, size, failed);
336 action->m_weight = action->m_latency = latency;
338 action->m_rate = rate;
339 if (p_updateMechanism == UM_LAZY) {
340 action->m_indexHeap = -1;
341 action->m_lastUpdate = surf_get_clock();
344 bandwidth_bound = -1.0;
345 if (sg_weight_S_parameter > 0)
346 for (auto link : *route)
347 action->m_weight += sg_weight_S_parameter / link->getBandwidth();
349 for (auto link : *route) {
350 double bb = bandwidthFactor(size) * link->getBandwidth();
351 bandwidth_bound = (bandwidth_bound < 0.0) ? bb : std::min(bandwidth_bound, bb);
354 action->m_latCurrent = action->m_latency;
355 action->m_latency *= latencyFactor(size);
356 action->m_rate = bandwidthConstraint(action->m_rate, bandwidth_bound, size);
358 xbt_assert(! route->empty(),
359 "Using a model with a gap (e.g., SMPI) with a platform without links (e.g. vivaldi)!!!");
361 gapAppend(size, route->at(0), action);
362 XBT_DEBUG("Comm %p: %s -> %s gap=%f (lat=%f)", action, src->name(), dst->name(), action->m_senderGap, action->m_latency);
365 constraints_per_variable = route->size();
366 if (back_route != NULL)
367 constraints_per_variable += back_route->size();
369 if (action->m_latency > 0) {
370 action->p_variable = lmm_variable_new(p_maxminSystem, action, 0.0, -1.0, constraints_per_variable);
371 if (p_updateMechanism == UM_LAZY) {
372 // add to the heap the event when the latency is payed
373 XBT_DEBUG("Added action (%p) one latency event at date %f", action, action->m_latency + action->m_lastUpdate);
374 action->heapInsert(p_actionHeap, action->m_latency + action->m_lastUpdate, route->empty() ? NORMAL : LATENCY);
377 action->p_variable = lmm_variable_new(p_maxminSystem, action, 1.0, -1.0, constraints_per_variable);
379 if (action->m_rate < 0) {
380 lmm_update_variable_bound(p_maxminSystem, action->getVariable(), (action->m_latCurrent > 0) ? sg_tcp_gamma / (2.0 * action->m_latCurrent) : -1.0);
382 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);
385 for (auto link: *route)
386 lmm_expand(p_maxminSystem, link->getConstraint(), action->getVariable(), 1.0);
388 if (sg_network_crosstraffic == 1) {
389 XBT_DEBUG("Fullduplex active adding backward flow using 5%%");
390 for (auto link : *back_route)
391 lmm_expand(p_maxminSystem, link->getConstraint(), action->getVariable(), .05);
393 //Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
394 //(You would also have to change lmm_element_concurrency())
395 //lmm_variable_concurrency_share_set(action->getVariable(),2);
401 networkCommunicateCallbacks(action, src, dst, size, rate);
408 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model *model, const char *name, xbt_dict_t props,
410 double constraint_value,
411 double bw_peak, tmgr_trace_t bw_trace,
412 double lat_initial, tmgr_trace_t lat_trace,
413 e_surf_link_sharing_policy_t policy)
414 : Link(model, name, props, lmm_constraint_new(system, this, constraint_value))
416 m_bandwidth.scale = 1.0;
417 m_bandwidth.peak = bw_peak;
419 m_bandwidth.event = future_evt_set->add_trace(bw_trace, 0.0, this);
421 m_bandwidth.event = NULL;
423 m_latency.scale = 1.0;
424 m_latency.peak = lat_initial;
426 m_latency.event = future_evt_set->add_trace(lat_trace, 0.0, this);
428 if (policy == SURF_LINK_FATPIPE)
429 lmm_constraint_shared(getConstraint());
434 void NetworkCm02Link::apply_event(tmgr_trace_iterator_t triggered, double value)
437 /* Find out which of my iterators was triggered, and react accordingly */
438 if (triggered == m_bandwidth.event) {
439 updateBandwidth(value);
440 tmgr_trace_event_unref(&m_bandwidth.event);
442 } else if (triggered == m_latency.event) {
443 updateLatency(value);
444 tmgr_trace_event_unref(&m_latency.event);
446 } else if (triggered == m_stateEvent) {
450 lmm_variable_t var = NULL;
451 lmm_element_t elem = NULL;
452 double now = surf_get_clock();
455 while ((var = lmm_get_var_from_cnst(getModel()->getMaxminSystem(), getConstraint(), &elem))) {
456 Action *action = static_cast<Action*>( lmm_variable_id(var) );
458 if (action->getState() == SURF_ACTION_RUNNING ||
459 action->getState() == SURF_ACTION_READY) {
460 action->setFinishTime(now);
461 action->setState(SURF_ACTION_FAILED);
465 tmgr_trace_event_unref(&m_stateEvent);
467 xbt_die("Unknown event!\n");
470 XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
474 void NetworkCm02Link::updateBandwidth(double value) {
476 m_bandwidth.peak = value;
478 lmm_update_constraint_bound(getModel()->getMaxminSystem(), getConstraint(),
479 sg_bandwidth_factor * (m_bandwidth.peak * m_bandwidth.scale));
480 TRACE_surf_link_set_bandwidth(surf_get_clock(), getName(), sg_bandwidth_factor * m_bandwidth.peak * m_bandwidth.scale);
482 if (sg_weight_S_parameter > 0) {
483 double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (m_bandwidth.peak * m_bandwidth.scale);
486 lmm_element_t elem = NULL, nextelem = NULL;
488 while ((var = lmm_get_var_from_cnst_safe(getModel()->getMaxminSystem(), getConstraint(), &elem, &nextelem, &numelem))) {
489 NetworkCm02Action *action = (NetworkCm02Action*) lmm_variable_id(var);
490 action->m_weight += delta;
491 if (!action->isSuspended())
492 lmm_update_variable_weight(getModel()->getMaxminSystem(), action->getVariable(), action->m_weight);
497 void NetworkCm02Link::updateLatency(double value){
498 double delta = value - m_latency.peak;
499 lmm_variable_t var = NULL;
500 lmm_element_t elem = NULL;
501 lmm_element_t nextelem = NULL;
504 m_latency.peak = value;
506 while ((var = lmm_get_var_from_cnst_safe(getModel()->getMaxminSystem(), getConstraint(), &elem, &nextelem, &numelem))) {
507 NetworkCm02Action *action = (NetworkCm02Action*) lmm_variable_id(var);
508 action->m_latCurrent += delta;
509 action->m_weight += delta;
510 if (action->m_rate < 0)
511 lmm_update_variable_bound(getModel()->getMaxminSystem(), action->getVariable(), sg_tcp_gamma / (2.0 * action->m_latCurrent));
513 lmm_update_variable_bound(getModel()->getMaxminSystem(), action->getVariable(),
514 std::min(action->m_rate, sg_tcp_gamma / (2.0 * action->m_latCurrent)));
516 if (action->m_rate < sg_tcp_gamma / (2.0 * action->m_latCurrent)) {
517 XBT_INFO("Flow is limited BYBANDWIDTH");
519 XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->m_latCurrent);
522 if (!action->isSuspended())
523 lmm_update_variable_weight(getModel()->getMaxminSystem(), action->getVariable(), action->m_weight);
530 void NetworkCm02Action::updateRemainingLazy(double now)
534 if (m_suspended != 0)
537 delta = now - m_lastUpdate;
540 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, m_remains, m_lastUpdate);
541 double_update(&(m_remains), m_lastValue * delta, sg_maxmin_precision*sg_surf_precision);
543 XBT_DEBUG("Updating action(%p): remains is now %f", this, m_remains);
546 if (m_maxDuration != NO_MAX_DURATION)
547 double_update(&m_maxDuration, delta, sg_surf_precision);
549 if (m_remains <= 0 &&
550 (lmm_get_variable_weight(getVariable()) > 0)) {
552 setState(SURF_ACTION_DONE);
554 heapRemove(getModel()->getActionHeap());
555 } else if (((m_maxDuration != NO_MAX_DURATION)
556 && (m_maxDuration <= 0))) {
558 setState(SURF_ACTION_DONE);
559 heapRemove(getModel()->getActionHeap());
563 m_lastValue = lmm_variable_getvalue(getVariable());