1 /* Copyright (c) 2007, 2008, 2009, 2010, 2011. 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 "surf_private.h"
8 #include "surf/maxmin.h"
9 #include "surf/ns3/ns3_interface.h"
11 #include "surf/network_ns3_private.h"
14 extern xbt_lib_t host_lib;
15 extern xbt_lib_t link_lib;
16 extern xbt_lib_t as_router_lib;
18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_network_ns3, surf,
19 "Logging specific to the SURF network NS3 module");
21 extern routing_platf_t routing_platf;
22 extern xbt_dict_t dict_socket;
24 static double time_to_next_flow_completion = -1;
26 static double ns3_share_resources(double min);
27 static void ns3_update_actions_state(double now, double delta);
28 static void finalize(void);
29 static surf_action_t ns3_communicate(sg_routing_edge_t src_elm,
30 sg_routing_edge_t dst_elm,
31 double size, double rate);
32 static void action_suspend(surf_action_t action);
33 static void action_resume(surf_action_t action);
34 static int action_is_suspended(surf_action_t action);
35 static int action_unref(surf_action_t action);
39 static void replace_bdw_ns3(char ** bdw)
41 char *temp = xbt_strdup(*bdw);
43 *bdw = bprintf("%fBps",atof(temp));
48 static void replace_lat_ns3(char ** lat)
50 char *temp = xbt_strdup(*lat);
52 *lat = bprintf("%fs",atof(temp));
56 static void parse_ns3_add_host(sg_platf_host_cbarg_t host)
58 XBT_DEBUG("NS3_ADD_HOST '%s'",host->id);
62 ns3_add_host(host->id)
66 static void parse_ns3_add_link(sg_platf_link_cbarg_t link)
68 XBT_DEBUG("NS3_ADD_LINK '%s'",link->id);
70 if(!IPV4addr) IPV4addr = xbt_dynar_new(sizeof(char*),free);
72 tmgr_trace_t bw_trace;
73 tmgr_trace_t state_trace;
74 tmgr_trace_t lat_trace;
76 bw_trace = link->bandwidth_trace;
77 lat_trace = link->latency_trace;
78 state_trace = link->state_trace;
81 XBT_INFO("The NS3 network model doesn't support bandwidth state traces");
83 XBT_INFO("The NS3 network model doesn't support latency state traces");
85 XBT_INFO("The NS3 network model doesn't support link state traces");
87 ns3_link_t link_ns3 = xbt_new0(s_ns3_link_t,1);;
88 link_ns3->id = xbt_strdup((char*)(link->id));
89 link_ns3->bdw = bprintf("%f",link->bandwidth);
90 link_ns3->lat = bprintf("%f",link->latency);
92 surf_ns3_link_t l = xbt_new0(s_surf_ns3_link_t,1);
93 l->generic_resource.name = xbt_strdup(link->id);
94 l->generic_resource.properties = current_property_set;
98 xbt_lib_set(link_lib,link->id,NS3_LINK_LEVEL,link_ns3);
99 xbt_lib_set(link_lib,link->id,SURF_LINK_LEVEL,l);
102 static void parse_ns3_add_router(sg_platf_router_cbarg_t router)
104 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router->id);
105 xbt_lib_set(as_router_lib,
108 ns3_add_router(router->id)
112 static void parse_ns3_add_AS(sg_platf_AS_cbarg_t AS)
114 XBT_DEBUG("NS3_ADD_AS '%s'",AS->id);
115 xbt_lib_set(as_router_lib,
122 static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
124 const char *cluster_prefix = cluster->prefix;
125 const char *cluster_suffix = cluster->suffix;
126 const char *cluster_radical = cluster->radical;
127 const char *cluster_bb_bw = bprintf("%f",cluster->bb_bw);
128 const char *cluster_bb_lat = bprintf("%f",cluster->bb_lat);
129 const char *cluster_bw = bprintf("%f",cluster->bw);
130 const char *cluster_lat = bprintf("%f",cluster->lat);
131 const char *groups = NULL;
136 xbt_dynar_t radical_elements;
137 xbt_dynar_t radical_ends;
138 xbt_dynar_t tab_elements_num = xbt_dynar_new(sizeof(int), NULL);
140 char *router_id,*host_id;
142 radical_elements = xbt_str_split(cluster_radical, ",");
143 xbt_dynar_foreach(radical_elements, iter, groups) {
144 radical_ends = xbt_str_split(groups, "-");
146 switch (xbt_dynar_length(radical_ends)) {
148 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
149 xbt_dynar_push_as(tab_elements_num, int, start);
150 router_id = bprintf("ns3_%s%d%s", cluster_prefix, start, cluster_suffix);
151 xbt_lib_set(host_lib,
154 ns3_add_host_cluster(router_id)
156 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
161 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
162 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
163 for (i = start; i <= end; i++){
164 xbt_dynar_push_as(tab_elements_num, int, i);
165 router_id = bprintf("ns3_%s%d%s", cluster_prefix, i, cluster_suffix);
166 xbt_lib_set(host_lib,
169 ns3_add_host_cluster(router_id)
171 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
177 XBT_DEBUG("Malformed radical");
184 char * lat = xbt_strdup(cluster_lat);
185 char * bw = xbt_strdup(cluster_bw);
186 replace_lat_ns3(&lat);
187 replace_bdw_ns3(&bw);
189 xbt_dynar_foreach(tab_elements_num,cpt,elmts)
191 host_id = bprintf("%s%d%s", cluster_prefix, elmts, cluster_suffix);
192 router_id = bprintf("ns3_%s%d%s", cluster_prefix, elmts, cluster_suffix);
193 XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
195 ns3_nodes_t host_src = xbt_lib_get_or_null(host_lib,host_id, NS3_HOST_LEVEL);
196 ns3_nodes_t host_dst = xbt_lib_get_or_null(host_lib,router_id,NS3_HOST_LEVEL);
198 if(host_src && host_dst){}
199 else xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
201 ns3_add_link(host_src->node_num,host_src->type,
202 host_dst->node_num,host_dst->type,
208 xbt_dynar_free(&tab_elements_num);
211 //Create link backbone
212 lat = xbt_strdup(cluster_bb_lat);
213 bw = xbt_strdup(cluster_bb_bw);
214 replace_lat_ns3(&lat);
215 replace_bdw_ns3(&bw);
216 ns3_add_cluster(bw,lat,cluster->id);
221 static double ns3_get_link_latency (const void *link)
224 //XBT_DEBUG("link_id:%s link_lat:%s link_bdw:%s",((surf_ns3_link_t)link)->data->id,((surf_ns3_link_t)link)->data->lat,((surf_ns3_link_t)link)->data->bdw);
225 sscanf(((surf_ns3_link_t)link)->data->lat,"%lg",&lat);
228 static double ns3_get_link_bandwidth (const void *link)
231 //XBT_DEBUG("link_id:%s link_lat:%s link_bdw:%s",((surf_ns3_link_t)link)->data->id,((surf_ns3_link_t)link)->data->lat,((surf_ns3_link_t)link)->data->bdw);
232 sscanf(((surf_ns3_link_t)link)->data->bdw,"%lg",&bdw);
236 static xbt_dynar_t ns3_get_route(void *src_card, void *dst_card)
238 xbt_dynar_t route = NULL;
239 routing_get_route_and_latency(src_card, dst_card, &route, NULL);
243 static void parse_ns3_end_platform(void)
248 /* Create the ns3 topology based on routing strategy */
249 static void create_ns3_topology(void)
251 XBT_DEBUG("Starting topology generation");
253 xbt_dynar_shrink(IPV4addr,0);
255 //get the onelinks from the parsed platform
256 xbt_dynar_t onelink_routes = routing_platf->get_onelink_routes();
258 xbt_die("There is no routes!");
259 XBT_DEBUG("Have get_onelink_routes, found %ld routes",onelink_routes->used);
260 //save them in trace file
263 xbt_dynar_foreach(onelink_routes, iter, onelink) {
264 char *src = onelink->src->name;
265 char *dst = onelink->dst->name;
266 void *link = onelink->link_ptr;
267 if( strcmp(src,dst) && ((surf_ns3_link_t)link)->created){
268 XBT_DEBUG("Route from '%s' to '%s' with link '%s'",src,dst,((surf_ns3_link_t)link)->data->id);
269 char * link_bdw = xbt_strdup(((surf_ns3_link_t)link)->data->bdw);
270 char * link_lat = xbt_strdup(((surf_ns3_link_t)link)->data->lat);
271 replace_lat_ns3(&link_lat);
272 replace_bdw_ns3(&link_bdw);
273 ((surf_ns3_link_t)link)->created = 0;
275 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
276 XBT_DEBUG("\tLink (%s) bdw:%s lat:%s",((surf_ns3_link_t)link)->data->id,
282 ns3_nodes_t host_src = xbt_lib_get_or_null(host_lib,src,NS3_HOST_LEVEL);
283 if(!host_src) host_src = xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL);
284 ns3_nodes_t host_dst = xbt_lib_get_or_null(host_lib,dst,NS3_HOST_LEVEL);
285 if(!host_dst) host_dst = xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL);
287 if(host_src && host_dst){}
288 else xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
290 ns3_add_link(host_src->node_num,host_src->type,host_dst->node_num,host_dst->type,link_bdw,link_lat);
298 static void define_callbacks_ns3(void)
300 sg_platf_host_add_cb (&parse_ns3_add_host);
301 sg_platf_router_add_cb (&parse_ns3_add_router);
302 sg_platf_link_add_cb (&parse_ns3_add_link);
303 sg_platf_cluster_add_cb (&parse_ns3_add_cluster);
304 sg_platf_AS_begin_add_cb (&parse_ns3_add_AS);
305 sg_platf_postparse_add_cb(&create_ns3_topology); //get_one_link_routes
306 sg_platf_postparse_add_cb(&parse_ns3_end_platform); //InitializeRoutes
309 static void free_ns3_link(void * elmts)
311 ns3_link_t link = elmts;
318 static void free_ns3_host(void * elmts)
320 ns3_nodes_t host = elmts;
324 #ifdef HAVE_LATENCY_BOUND_TRACKING
325 static int ns3_get_link_latency_limited(surf_action_t action)
332 static void ns3_action_set_category(surf_action_t action, const char *category)
334 action->category = xbt_strdup (category);
338 void surf_network_model_init_NS3()
340 if (surf_network_model)
343 surf_network_model = surf_model_init();
344 surf_network_model->name = "network NS3";
345 surf_network_model->extension.network.get_link_latency = ns3_get_link_latency;
346 surf_network_model->extension.network.get_link_bandwidth = ns3_get_link_bandwidth;
347 surf_network_model->extension.network.get_route = ns3_get_route;
349 surf_network_model->model_private->share_resources = ns3_share_resources;
350 surf_network_model->model_private->update_actions_state = ns3_update_actions_state;
351 surf_network_model->model_private->finalize = finalize;
353 surf_network_model->suspend = action_suspend;
354 surf_network_model->resume = action_resume;
355 surf_network_model->is_suspended = action_is_suspended;
356 surf_network_model->action_unref = action_unref;
357 surf_network_model->extension.network.communicate = ns3_communicate;
360 surf_network_model->set_category = ns3_action_set_category;
363 /* Added the initialization for NS3 interface */
365 if (ns3_initialize(xbt_cfg_get_string(_sg_cfg_set, "ns3/TcpModel"))) {
366 xbt_die("Impossible to initialize NS3 interface");
369 routing_model_create(NULL);
370 define_callbacks_ns3();
372 NS3_HOST_LEVEL = xbt_lib_add_level(host_lib,(void_f_pvoid_t)free_ns3_host);
373 NS3_ASR_LEVEL = xbt_lib_add_level(as_router_lib,(void_f_pvoid_t)free_ns3_host);
374 NS3_LINK_LEVEL = xbt_lib_add_level(link_lib,(void_f_pvoid_t)free_ns3_link);
376 xbt_dynar_push(model_list, &surf_network_model);
378 #ifdef HAVE_LATENCY_BOUND_TRACKING
379 surf_network_model->get_latency_limited = ns3_get_link_latency_limited;
383 static void finalize(void)
386 xbt_dynar_free_container(&IPV4addr);
387 xbt_dict_free(&dict_socket);
390 static double ns3_share_resources(double min)
392 XBT_DEBUG("ns3_share_resources");
394 xbt_swag_t running_actions =
395 surf_network_model->states.running_action_set;
397 //get the first relevant value from the running_actions list
398 if (!xbt_swag_size(running_actions) || min == 0.0)
403 time_to_next_flow_completion = ns3_time() - surf_get_clock();
404 } while(double_equals(time_to_next_flow_completion,0));
406 XBT_DEBUG("min : %f",min);
407 XBT_DEBUG("ns3 time : %f",ns3_time());
408 XBT_DEBUG("surf time : %f",surf_get_clock());
409 XBT_DEBUG("Next completion %f :",time_to_next_flow_completion);
411 return time_to_next_flow_completion;
414 static void ns3_update_actions_state(double now, double delta)
416 xbt_dict_cursor_t cursor = NULL;
420 static xbt_dynar_t socket_to_destroy = NULL;
421 if(!socket_to_destroy) socket_to_destroy = xbt_dynar_new(sizeof(char*),NULL);
423 surf_action_network_ns3_t action = NULL;
424 xbt_swag_t running_actions =
425 surf_network_model->states.running_action_set;
427 /* If there are no running flows, just return */
428 if (!xbt_swag_size(running_actions)) {
429 while(double_positive(now-ns3_time())) {
430 ns3_simulator(now-ns3_time());
435 xbt_dict_foreach(dict_socket,cursor,key,data){
436 action = (surf_action_network_ns3_t)ns3_get_socket_action(data);
437 XBT_DEBUG("Processing socket %p (action %p)",data,action);
438 action->generic_action.remains = action->generic_action.cost - ns3_get_socket_sent(data);
441 if (TRACE_is_enabled() &&
442 surf_action_state_get(&(action->generic_action)) == SURF_ACTION_RUNNING){
443 double data_sent = ns3_get_socket_sent(data);
444 double data_delta_sent = data_sent - action->last_sent;
446 xbt_dynar_t route = NULL;
448 routing_get_route_and_latency (action->src_elm, action->dst_elm, &route, NULL);
450 for (i = 0; i < xbt_dynar_length (route); i++){
451 surf_ns3_link_t *link = ((surf_ns3_link_t*)xbt_dynar_get_ptr (route, i));
452 TRACE_surf_link_set_utilization ((*link)->generic_resource.name,
453 ((surf_action_t) action)->category,
454 (data_delta_sent)/delta,
458 action->last_sent = data_sent;
462 if(ns3_get_socket_is_finished(data) == 1){
463 xbt_dynar_push(socket_to_destroy,&key);
464 XBT_DEBUG("Destroy socket %p of action %p", key, action);
465 action->generic_action.finish = now;
466 surf_action_state_set(&(action->generic_action), SURF_ACTION_DONE);
470 while (!xbt_dynar_is_empty(socket_to_destroy)){
471 xbt_dynar_pop(socket_to_destroy,&key);
473 void *data = xbt_dict_get (dict_socket, key);
474 surf_action_network_ns3_t action = (surf_action_network_ns3_t)ns3_get_socket_action(data);
475 XBT_DEBUG ("Removing socket %p of action %p", key, action);
476 xbt_dict_remove(dict_socket,key);
481 /* Max durations are not supported */
482 static surf_action_t ns3_communicate(sg_routing_edge_t src_elm,
483 sg_routing_edge_t dst_elm,
484 double size, double rate)
486 surf_action_network_ns3_t action = NULL;
488 XBT_DEBUG("Communicate from %s to %s", src_elm->name, dst_elm->name);
489 action = surf_action_new(sizeof(s_surf_action_network_ns3_t), size, surf_network_model, 0);
491 ns3_create_flow(src_elm->name, dst_elm->name, surf_get_clock(), size, action);
494 action->last_sent = 0;
495 action->src_elm = src_elm;
496 action->dst_elm = dst_elm;
499 return (surf_action_t) action;
502 /* Suspend a flow() */
503 static void action_suspend(surf_action_t action)
508 /* Resume a flow() */
509 static void action_resume(surf_action_t action)
514 /* Test whether a flow is suspended */
515 static int action_is_suspended(surf_action_t action)
520 static int action_unref(surf_action_t action)
523 if (!action->refcount) {
524 xbt_swag_remove(action, action->state_set);
527 xbt_free(action->category);
529 XBT_DEBUG ("Removing action %p", action);
530 surf_action_free(&action);