1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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_private.h"
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_network, surf,
12 "Logging specific to the SURF network module");
14 surf_model_t surf_network_model = NULL;
15 static lmm_system_t network_maxmin_system = NULL;
16 static void (*network_solve) (lmm_system_t) = NULL;
18 double sg_latency_factor = 1.0; /* default value; can be set by model or from command line */
19 double sg_bandwidth_factor = 1.0; /* default value; can be set by model or from command line */
20 double sg_weight_S_parameter = 0.0;/* default value; can be set by model or from command line */
22 double sg_tcp_gamma = 0.0;
25 static link_CM02_t net_link_new(char *name,
27 tmgr_trace_t bw_trace,
29 tmgr_trace_t lat_trace,
30 e_surf_resource_state_t
32 tmgr_trace_t state_trace,
33 e_surf_link_sharing_policy_t
34 policy, xbt_dict_t properties)
36 link_CM02_t nw_link = (link_CM02_t)
37 surf_resource_lmm_new(sizeof(s_link_CM02_t),
38 surf_network_model, name, properties,
39 network_maxmin_system,
40 sg_bandwidth_factor * bw_initial,
42 state_initial, state_trace,
43 bw_initial, bw_trace);
45 xbt_assert1(!xbt_dict_get_or_null(surf_network_model->resource_set, name),
46 "Link '%s' declared several times in the platform file.", name);
48 nw_link->lat_current = lat_initial;
51 tmgr_history_add_trace(history, lat_trace, 0.0, 0, nw_link);
53 if (policy == SURF_LINK_FATPIPE)
54 lmm_constraint_shared(nw_link->lmm_resource.constraint);
56 xbt_dict_set(surf_network_model->resource_set, name, nw_link,
59 TRACE_surf_link_declaration (name, bw_initial, lat_initial);
65 static void net_parse_link_init(void)
69 tmgr_trace_t bw_trace;
71 tmgr_trace_t lat_trace;
72 e_surf_resource_state_t state_initial_link = SURF_RESOURCE_ON;
73 e_surf_link_sharing_policy_t policy_initial_link = SURF_LINK_SHARED;
74 tmgr_trace_t state_trace;
76 name_link = xbt_strdup(A_surfxml_link_id);
77 surf_parse_get_double(&bw_initial, A_surfxml_link_bandwidth);
78 bw_trace = tmgr_trace_new(A_surfxml_link_bandwidth_file);
79 surf_parse_get_double(&lat_initial, A_surfxml_link_latency);
80 lat_trace = tmgr_trace_new(A_surfxml_link_latency_file);
82 xbt_assert0((A_surfxml_link_state == A_surfxml_link_state_ON)
83 || (A_surfxml_link_state ==
84 A_surfxml_link_state_OFF), "Invalid state");
85 if (A_surfxml_link_state == A_surfxml_link_state_ON)
86 state_initial_link = SURF_RESOURCE_ON;
87 else if (A_surfxml_link_state == A_surfxml_link_state_OFF)
88 state_initial_link = SURF_RESOURCE_OFF;
90 if (A_surfxml_link_sharing_policy == A_surfxml_link_sharing_policy_SHARED)
91 policy_initial_link = SURF_LINK_SHARED;
92 else if (A_surfxml_link_sharing_policy ==
93 A_surfxml_link_sharing_policy_FATPIPE)
94 policy_initial_link = SURF_LINK_FATPIPE;
96 state_trace = tmgr_trace_new(A_surfxml_link_state_file);
98 net_link_new(name_link, bw_initial, bw_trace,
99 lat_initial, lat_trace, state_initial_link, state_trace,
100 policy_initial_link, xbt_dict_new());
104 static void net_add_traces(void)
106 xbt_dict_cursor_t cursor = NULL;
107 char *trace_name, *elm;
109 static int called = 0;
114 /* connect all traces relative to network */
115 xbt_dict_foreach(trace_connect_list_link_avail, cursor, trace_name, elm) {
116 tmgr_trace_t trace = xbt_dict_get_or_null(traces_set_list, trace_name);
118 xbt_dict_get_or_null(surf_network_model->resource_set, elm);
120 xbt_assert2(link, "Cannot connect trace %s to link %s: link undefined",
122 xbt_assert2(trace, "Cannot connect trace %s to link %s: trace undefined",
125 link->lmm_resource.state_event =
126 tmgr_history_add_trace(history, trace, 0.0, 0, link);
129 xbt_dict_foreach(trace_connect_list_bandwidth, cursor, trace_name, elm) {
130 tmgr_trace_t trace = xbt_dict_get_or_null(traces_set_list, trace_name);
132 xbt_dict_get_or_null(surf_network_model->resource_set, elm);
134 xbt_assert2(link, "Cannot connect trace %s to link %s: link undefined",
136 xbt_assert2(trace, "Cannot connect trace %s to link %s: trace undefined",
139 link->lmm_resource.power.event =
140 tmgr_history_add_trace(history, trace, 0.0, 0, link);
143 xbt_dict_foreach(trace_connect_list_latency, cursor, trace_name, elm) {
144 tmgr_trace_t trace = xbt_dict_get_or_null(traces_set_list, trace_name);
146 xbt_dict_get_or_null(surf_network_model->resource_set, elm);
148 xbt_assert2(link, "Cannot connect trace %s to link %s: link undefined",
150 xbt_assert2(trace, "Cannot connect trace %s to link %s: trace undefined",
153 link->lat_event = tmgr_history_add_trace(history, trace, 0.0, 0, link);
157 static void net_define_callbacks(const char *file)
159 /* Figuring out the network links */
160 surfxml_add_callback(STag_surfxml_link_cb_list, &net_parse_link_init);
161 surfxml_add_callback(ETag_surfxml_platform_cb_list, &net_add_traces);
164 static int net_resource_used(void *resource_id)
166 return lmm_constraint_used(network_maxmin_system,
167 ((surf_resource_lmm_t) resource_id)->constraint);
170 static int net_action_unref(surf_action_t action)
173 if (!action->refcount) {
174 xbt_swag_remove(action, action->state_set);
175 if (((surf_action_network_CM02_t) action)->variable)
176 lmm_variable_free(network_maxmin_system,
177 ((surf_action_network_CM02_t) action)->variable);
184 static void net_action_cancel(surf_action_t action)
186 surf_network_model->action_state_set((surf_action_t) action,
191 static void net_action_recycle(surf_action_t action)
196 static double net_action_get_remains(surf_action_t action)
198 return action->remains;
201 static double net_share_resources(double now)
203 s_surf_action_network_CM02_t s_action;
204 surf_action_network_CM02_t action = NULL;
205 xbt_swag_t running_actions = surf_network_model->states.running_action_set;
208 min = generic_maxmin_share_resources(running_actions,
209 xbt_swag_offset(s_action,
211 network_maxmin_system, network_solve);
213 #define VARIABLE(action) (*((lmm_variable_t*)(((char *) (action)) + xbt_swag_offset(s_action, variable) )))
215 xbt_swag_foreach(action, running_actions) {
216 if (action->latency > 0) {
218 min = action->latency;
219 else if (action->latency < min)
220 min = action->latency;
227 static void net_update_actions_state(double now, double delta)
230 surf_action_network_CM02_t action = NULL;
231 surf_action_network_CM02_t next_action = NULL;
232 xbt_swag_t running_actions = surf_network_model->states.running_action_set;
234 xbt_swag_t failed_actions =
235 surf_network_model->states.failed_action_set;
238 xbt_swag_foreach_safe(action, next_action, running_actions) {
241 xbt_dynar_t route = used_routing->get_route(action->src, action->dst);
244 xbt_dynar_foreach(route, i, link) {
245 TRACE_surf_link_set_utilization (link->lmm_resource.generic_resource.name,
246 action->generic_action.data, lmm_variable_getvalue(action->variable), now-delta, delta);
251 if (action->latency > 0) {
252 if (action->latency > deltap) {
253 double_update(&(action->latency), deltap);
256 double_update(&(deltap), action->latency);
257 action->latency = 0.0;
259 if ((action->latency == 0.0) && !(action->suspended))
260 lmm_update_variable_weight(network_maxmin_system, action->variable,
263 double_update(&(action->generic_action.remains),
264 lmm_variable_getvalue(action->variable) * deltap);
265 if (action->generic_action.max_duration != NO_MAX_DURATION)
266 double_update(&(action->generic_action.max_duration), delta);
268 if ((action->generic_action.remains <= 0) &&
269 (lmm_get_variable_weight(action->variable) > 0)) {
270 action->generic_action.finish = surf_get_clock();
271 surf_network_model->action_state_set((surf_action_t) action,
273 } else if ((action->generic_action.max_duration != NO_MAX_DURATION)
274 && (action->generic_action.max_duration <= 0)) {
275 action->generic_action.finish = surf_get_clock();
276 surf_network_model->action_state_set((surf_action_t) action,
284 static void net_update_resource_state(void *id,
285 tmgr_trace_event_t event_type,
286 double value, double date)
288 link_CM02_t nw_link = id;
289 /* printf("[" "%lg" "] Asking to update network card \"%s\" with value " */
290 /* "%lg" " for event %p\n", surf_get_clock(), nw_link->name, */
291 /* value, event_type); */
293 if (event_type == nw_link->lmm_resource.power.event) {
295 sg_weight_S_parameter / value - sg_weight_S_parameter /
296 (nw_link->lmm_resource.power.peak * nw_link->lmm_resource.power.scale);
297 lmm_variable_t var = NULL;
298 lmm_element_t elem = NULL;
299 surf_action_network_CM02_t action = NULL;
301 nw_link->lmm_resource.power.peak = value;
302 lmm_update_constraint_bound(network_maxmin_system,
303 nw_link->lmm_resource.constraint,
304 sg_bandwidth_factor *
305 (nw_link->lmm_resource.power.peak *
306 nw_link->lmm_resource.power.scale));
308 TRACE_surf_link_set_bandwidth (date, nw_link->lmm_resource.generic_resource.name, sg_bandwidth_factor * (nw_link->lmm_resource.power.peak * nw_link->lmm_resource.power.scale));
310 if (sg_weight_S_parameter > 0) {
311 while ((var = lmm_get_var_from_cnst
312 (network_maxmin_system, nw_link->lmm_resource.constraint,
314 action = lmm_variable_id(var);
315 action->weight += delta;
316 if (!(action->suspended))
317 lmm_update_variable_weight(network_maxmin_system, action->variable,
321 if (tmgr_trace_event_free(event_type))
322 nw_link->lmm_resource.power.event = NULL;
323 } else if (event_type == nw_link->lat_event) {
324 double delta = value - nw_link->lat_current;
325 lmm_variable_t var = NULL;
326 lmm_element_t elem = NULL;
327 surf_action_network_CM02_t action = NULL;
329 nw_link->lat_current = value;
330 while ((var = lmm_get_var_from_cnst
331 (network_maxmin_system, nw_link->lmm_resource.constraint,
333 action = lmm_variable_id(var);
334 action->lat_current += delta;
335 action->weight += delta;
336 if (action->rate < 0)
337 lmm_update_variable_bound(network_maxmin_system, action->variable,
338 sg_tcp_gamma / (2.0 * action->lat_current));
340 lmm_update_variable_bound(network_maxmin_system, action->variable,
342 sg_tcp_gamma / (2.0 *
343 action->lat_current)));
344 if (!(action->suspended))
345 lmm_update_variable_weight(network_maxmin_system, action->variable,
349 if (tmgr_trace_event_free(event_type))
350 nw_link->lat_event = NULL;
351 } else if (event_type == nw_link->lmm_resource.state_event) {
353 nw_link->lmm_resource.state_current = SURF_RESOURCE_ON;
355 lmm_constraint_t cnst = nw_link->lmm_resource.constraint;
356 lmm_variable_t var = NULL;
357 lmm_element_t elem = NULL;
359 nw_link->lmm_resource.state_current = SURF_RESOURCE_OFF;
360 while ((var = lmm_get_var_from_cnst
361 (network_maxmin_system, cnst, &elem))) {
362 surf_action_t action = lmm_variable_id(var);
364 if (surf_action_state_get(action) == SURF_ACTION_RUNNING ||
365 surf_action_state_get(action) == SURF_ACTION_READY) {
366 action->finish = date;
367 surf_network_model->action_state_set(action, SURF_ACTION_FAILED);
371 if (tmgr_trace_event_free(event_type))
372 nw_link->lmm_resource.state_event = NULL;
374 CRITICAL0("Unknown event ! \n");
381 static surf_action_t net_communicate(const char *src_name, const char *dst_name,
382 int src, int dst, double size, double rate)
384 surf_action_network_CM02_t action = NULL;
385 /* LARGE PLATFORMS HACK:
386 Add a link_CM02_t *link and a int link_nb to network_card_CM02_t. It will represent local links for this node
387 Use the cluster_id for ->id */
388 xbt_dynar_t route = used_routing->get_route(src, dst);
389 /* LARGE PLATFORMS HACK:
390 total_route_size = route_size + src->link_nb + dst->nb */
393 XBT_IN4("(%s,%s,%g,%g)", src_name, dst_name, size, rate);
394 /* LARGE PLATFORMS HACK:
395 assert on total_route_size */
396 xbt_assert2(xbt_dynar_length(route),
397 "You're trying to send data from %s to %s but there is no connection between these two hosts.",
402 xbt_dynar_foreach(route, i, link) {
403 if (link->lmm_resource.state_current == SURF_RESOURCE_OFF) {
409 surf_action_new(sizeof(s_surf_action_network_CM02_t), size,
410 surf_network_model, failed);
412 xbt_swag_insert(action, action->generic_action.state_set);
415 action->latency = 0.0;
416 action->weight = 0.0;
417 xbt_dynar_foreach(route, i, link) {
418 action->latency += link->lat_current;
421 sg_weight_S_parameter /
422 (link->lmm_resource.power.peak * link->lmm_resource.power.scale);
424 /* LARGE PLATFORMS HACK:
425 Add src->link and dst->link latencies */
426 action->lat_current = action->latency;
427 action->latency *= sg_latency_factor;
429 /* LARGE PLATFORMS HACK:
430 lmm_variable_new(..., total_route_size) */
431 if (action->latency > 0)
433 lmm_variable_new(network_maxmin_system, action, 0.0, -1.0,
434 xbt_dynar_length(route));
437 lmm_variable_new(network_maxmin_system, action, 1.0, -1.0,
438 xbt_dynar_length(route));
440 if (action->rate < 0) {
441 if (action->lat_current > 0)
442 lmm_update_variable_bound(network_maxmin_system, action->variable,
443 sg_tcp_gamma / (2.0 * action->lat_current));
445 lmm_update_variable_bound(network_maxmin_system, action->variable,
448 if (action->lat_current > 0)
449 lmm_update_variable_bound(network_maxmin_system, action->variable,
451 sg_tcp_gamma / (2.0 *
452 action->lat_current)));
454 lmm_update_variable_bound(network_maxmin_system, action->variable,
458 xbt_dynar_foreach(route, i, link) {
459 lmm_expand(network_maxmin_system, link->lmm_resource.constraint,
460 action->variable, 1.0);
462 /* LARGE PLATFORMS HACK:
463 expand also with src->link and dst->link */
465 /* saving the src and dst of this communication */
471 return (surf_action_t) action;
474 static double net_get_link_bandwidth(const void *link)
476 surf_resource_lmm_t lmm = (surf_resource_lmm_t) link;
477 return lmm->power.peak * lmm->power.scale;
480 static double net_get_link_latency(const void *link)
482 return ((link_CM02_t) link)->lat_current;
485 static int net_link_shared(const void *link)
487 return lmm_constraint_is_shared(((surf_resource_lmm_t) link)->constraint);
490 static void net_action_suspend(surf_action_t action)
492 ((surf_action_network_CM02_t) action)->suspended = 1;
493 lmm_update_variable_weight(network_maxmin_system,
494 ((surf_action_network_CM02_t) action)->variable,
498 static void net_action_resume(surf_action_t action)
500 if (((surf_action_network_CM02_t) action)->suspended) {
501 lmm_update_variable_weight(network_maxmin_system,
502 ((surf_action_network_CM02_t)
504 ((surf_action_network_CM02_t) action)->weight);
505 ((surf_action_network_CM02_t) action)->suspended = 0;
509 static int net_action_is_suspended(surf_action_t action)
511 return ((surf_action_network_CM02_t) action)->suspended;
514 static void net_action_set_max_duration(surf_action_t action, double duration)
516 action->max_duration = duration;
519 static void net_finalize(void)
521 surf_model_exit(surf_network_model);
522 surf_network_model = NULL;
524 used_routing->finalize();
525 lmm_system_free(network_maxmin_system);
526 network_maxmin_system = NULL;
529 static void surf_network_model_init_internal(void)
531 surf_network_model = surf_model_init();
533 surf_network_model->name = "network";
534 surf_network_model->action_unref = net_action_unref;
535 surf_network_model->action_cancel = net_action_cancel;
536 surf_network_model->action_recycle = net_action_recycle;
537 surf_network_model->get_remains = net_action_get_remains;
539 surf_network_model->model_private->resource_used = net_resource_used;
540 surf_network_model->model_private->share_resources = net_share_resources;
541 surf_network_model->model_private->update_actions_state =
542 net_update_actions_state;
543 surf_network_model->model_private->update_resource_state =
544 net_update_resource_state;
545 surf_network_model->model_private->finalize = net_finalize;
547 surf_network_model->suspend = net_action_suspend;
548 surf_network_model->resume = net_action_resume;
549 surf_network_model->is_suspended = net_action_is_suspended;
550 surf_cpu_model->set_max_duration = net_action_set_max_duration;
552 surf_network_model->extension.network.communicate = net_communicate;
553 surf_network_model->extension.network.get_link_bandwidth =
554 net_get_link_bandwidth;
555 surf_network_model->extension.network.get_link_latency = net_get_link_latency;
556 surf_network_model->extension.network.link_shared = net_link_shared;
558 if (!network_maxmin_system)
559 network_maxmin_system = lmm_system_new();
561 routing_model_create(sizeof(link_CM02_t),
562 net_link_new(xbt_strdup("__loopback__"),
563 498000000, NULL, 0.000015, NULL,
564 SURF_RESOURCE_ON, NULL, SURF_LINK_FATPIPE,
568 /************************************************************************/
569 /* New model based on optimizations discussed during this thesis */
570 /************************************************************************/
571 void surf_network_model_init_LegrandVelho(const char *filename)
574 if (surf_network_model)
576 surf_network_model_init_internal();
577 net_define_callbacks(filename);
578 xbt_dynar_push(model_list, &surf_network_model);
579 network_solve = lmm_solve;
581 xbt_cfg_setdefault_double(_surf_cfg_set,"network/latency_factor",10.4);
582 xbt_cfg_setdefault_double(_surf_cfg_set,"network/bandwidth_factor", 0.92);
583 xbt_cfg_setdefault_double(_surf_cfg_set,"network/weight_S", 8775);
585 update_model_description(surf_network_model_description,
586 "LV08", surf_network_model);
589 /***************************************************************************/
590 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
591 /***************************************************************************/
592 /* @TechReport{ rr-lip2002-40, */
593 /* author = {Henri Casanova and Loris Marchal}, */
594 /* institution = {LIP}, */
595 /* title = {A Network Model for Simulation of Grid Application}, */
596 /* number = {2002-40}, */
600 void surf_network_model_init_CM02(const char *filename)
603 if (surf_network_model)
605 surf_network_model_init_internal();
606 net_define_callbacks(filename);
607 xbt_dynar_push(model_list, &surf_network_model);
608 network_solve = lmm_solve;
610 update_model_description(surf_network_model_description,
611 "CM02", surf_network_model);
614 void surf_network_model_init_Reno(const char *filename)
616 if (surf_network_model)
618 surf_network_model_init_internal();
619 net_define_callbacks(filename);
621 xbt_dynar_push(model_list, &surf_network_model);
622 lmm_set_default_protocol_function(func_reno_f, func_reno_fp, func_reno_fpi);
623 network_solve = lagrange_solve;
625 xbt_cfg_setdefault_double(_surf_cfg_set,"network/latency_factor", 10.4);
626 xbt_cfg_setdefault_double(_surf_cfg_set,"network/bandwidth_factor", 0.92);
627 xbt_cfg_setdefault_double(_surf_cfg_set,"network/weight_S", 8775);
629 update_model_description(surf_network_model_description,
630 "Reno", surf_network_model);
634 void surf_network_model_init_Reno2(const char *filename)
636 if (surf_network_model)
638 surf_network_model_init_internal();
639 net_define_callbacks(filename);
641 xbt_dynar_push(model_list, &surf_network_model);
642 lmm_set_default_protocol_function(func_reno2_f, func_reno2_fp,
644 network_solve = lagrange_solve;
646 xbt_cfg_setdefault_double(_surf_cfg_set,"network/latency_factor", 10.4);
647 xbt_cfg_setdefault_double(_surf_cfg_set,"network/bandwidth_factor", 0.92);
648 xbt_cfg_setdefault_double(_surf_cfg_set,"network/weight_S_parameter", 8775);
650 update_model_description(surf_network_model_description,
651 "Reno2", surf_network_model);
654 void surf_network_model_init_Vegas(const char *filename)
656 if (surf_network_model)
658 surf_network_model_init_internal();
659 net_define_callbacks(filename);
661 xbt_dynar_push(model_list, &surf_network_model);
662 lmm_set_default_protocol_function(func_vegas_f, func_vegas_fp,
664 network_solve = lagrange_solve;
666 xbt_cfg_setdefault_double(_surf_cfg_set,"network/latency_factor", 10.4);
667 xbt_cfg_setdefault_double(_surf_cfg_set,"network/bandwidth_factor", 0.92);
668 xbt_cfg_setdefault_double(_surf_cfg_set,"network/weight_S", 8775);
670 update_model_description(surf_network_model_description,
671 "Vegas", surf_network_model);