1 /* Copyright (c) 2007-2014. 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_ns3.hpp"
8 #include "surf_private.h"
9 #include "simgrid/sg_config.h"
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_network_ns3, surf,
12 "Logging specific to the SURF network NS3 module");
14 extern xbt_lib_t host_lib;
15 extern xbt_lib_t link_lib;
16 extern xbt_lib_t as_router_lib;
18 extern xbt_dict_t dict_socket;
21 static double time_to_next_flow_completion = -1;
27 static void replace_bdw_ns3(char ** bdw)
29 char *temp = xbt_strdup(*bdw);
31 *bdw = bprintf("%fBps",atof(temp));
36 static void replace_lat_ns3(char ** lat)
38 char *temp = xbt_strdup(*lat);
40 *lat = bprintf("%fs",atof(temp));
44 static void parse_ns3_add_host(sg_platf_host_cbarg_t host)
46 XBT_DEBUG("NS3_ADD_HOST '%s'",host->id);
50 ns3_add_host(host->id)
54 static void parse_ns3_add_link(sg_platf_link_cbarg_t link)
56 XBT_DEBUG("NS3_ADD_LINK '%s'",link->id);
58 if(!IPV4addr) IPV4addr = xbt_dynar_new(sizeof(char*),free);
60 NetworkLinkPtr net_link = surf_network_model->createResource(link->id,
62 link->bandwidth_trace,
69 xbt_lib_set(link_lib, link->id, SURF_LINK_LEVEL, net_link);
72 static void parse_ns3_add_router(sg_platf_router_cbarg_t router)
74 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router->id);
75 xbt_lib_set(as_router_lib,
78 ns3_add_router(router->id)
82 static void parse_ns3_add_AS(sg_platf_AS_cbarg_t AS)
84 XBT_DEBUG("NS3_ADD_AS '%s'",AS->id);
85 xbt_lib_set(as_router_lib,
92 static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
94 const char *cluster_prefix = cluster->prefix;
95 const char *cluster_suffix = cluster->suffix;
96 const char *cluster_radical = cluster->radical;
97 const char *cluster_bb_bw = bprintf("%f",cluster->bb_bw);
98 const char *cluster_bb_lat = bprintf("%f",cluster->bb_lat);
99 const char *cluster_bw = bprintf("%f",cluster->bw);
100 const char *cluster_lat = bprintf("%f",cluster->lat);
101 const char *groups = NULL;
106 xbt_dynar_t radical_elements;
107 xbt_dynar_t radical_ends;
108 xbt_dynar_t tab_elements_num = xbt_dynar_new(sizeof(int), NULL);
110 char *router_id,*host_id;
112 radical_elements = xbt_str_split(cluster_radical, ",");
113 xbt_dynar_foreach(radical_elements, iter, groups) {
114 radical_ends = xbt_str_split(groups, "-");
116 switch (xbt_dynar_length(radical_ends)) {
118 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
119 xbt_dynar_push_as(tab_elements_num, int, start);
120 router_id = bprintf("ns3_%s%d%s", cluster_prefix, start, cluster_suffix);
121 xbt_lib_set(host_lib,
124 ns3_add_host_cluster(router_id)
126 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
131 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
132 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
133 for (i = start; i <= end; i++){
134 xbt_dynar_push_as(tab_elements_num, int, i);
135 router_id = bprintf("ns3_%s%d%s", cluster_prefix, i, cluster_suffix);
136 xbt_lib_set(host_lib,
139 ns3_add_host_cluster(router_id)
141 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
147 XBT_DEBUG("Malformed radical");
154 char * lat = xbt_strdup(cluster_lat);
155 char * bw = xbt_strdup(cluster_bw);
156 replace_lat_ns3(&lat);
157 replace_bdw_ns3(&bw);
159 xbt_dynar_foreach(tab_elements_num,cpt,elmts)
161 host_id = bprintf("%s%d%s", cluster_prefix, elmts, cluster_suffix);
162 router_id = bprintf("ns3_%s%d%s", cluster_prefix, elmts, cluster_suffix);
163 XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
165 ns3_nodes_t host_src = static_cast<ns3_nodes_t>(xbt_lib_get_or_null(host_lib,host_id, NS3_HOST_LEVEL));
166 ns3_nodes_t host_dst = static_cast<ns3_nodes_t>(xbt_lib_get_or_null(host_lib,router_id,NS3_HOST_LEVEL));
168 if(host_src && host_dst){}
169 else xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
171 ns3_add_link(host_src->node_num,host_src->type,
172 host_dst->node_num,host_dst->type,
178 xbt_dynar_free(&tab_elements_num);
181 //Create link backbone
182 lat = xbt_strdup(cluster_bb_lat);
183 bw = xbt_strdup(cluster_bb_bw);
184 replace_lat_ns3(&lat);
185 replace_bdw_ns3(&bw);
186 ns3_add_cluster(bw,lat,cluster->id);
191 /* Create the ns3 topology based on routing strategy */
192 static void create_ns3_topology(void)
194 XBT_DEBUG("Starting topology generation");
196 xbt_dynar_shrink(IPV4addr,0);
198 //get the onelinks from the parsed platform
199 xbt_dynar_t onelink_routes = routing_platf->getOneLinkRoutes();
201 xbt_die("There is no routes!");
202 XBT_DEBUG("Have get_onelink_routes, found %ld routes",onelink_routes->used);
203 //save them in trace file
206 xbt_dynar_foreach(onelink_routes, iter, onelink) {
207 char *src = onelink->p_src->getName();
208 char *dst = onelink->p_dst->getName();
209 NetworkNS3LinkPtr link = static_cast<NetworkNS3LinkPtr>(onelink->p_link);
211 if (strcmp(src,dst) && link->m_created){
212 XBT_DEBUG("Route from '%s' to '%s' with link '%s'", src, dst, link->getName());
213 char * link_bdw = xbt_strdup(link->p_bdw);
214 char * link_lat = xbt_strdup(link->p_lat);
215 replace_lat_ns3(&link_lat);
216 replace_bdw_ns3(&link_bdw);
219 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
220 XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
223 ns3_nodes_t host_src = static_cast<ns3_nodes_t>(xbt_lib_get_or_null(host_lib,src,NS3_HOST_LEVEL));
224 if(!host_src) host_src = static_cast<ns3_nodes_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
225 ns3_nodes_t host_dst = static_cast<ns3_nodes_t>(xbt_lib_get_or_null(host_lib,dst,NS3_HOST_LEVEL));
226 if(!host_dst) host_dst = static_cast<ns3_nodes_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
228 if(host_src && host_dst){}
229 else xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
231 ns3_add_link(host_src->node_num,host_src->type,host_dst->node_num,host_dst->type,link_bdw,link_lat);
239 static void parse_ns3_end_platform(void)
244 static void define_callbacks_ns3(void)
246 sg_platf_host_add_cb (&parse_ns3_add_host);
247 sg_platf_router_add_cb (&parse_ns3_add_router);
248 sg_platf_link_add_cb (&parse_ns3_add_link);
249 sg_platf_cluster_add_cb (&parse_ns3_add_cluster);
250 sg_platf_AS_begin_add_cb (&parse_ns3_add_AS);
251 sg_platf_postparse_add_cb(&create_ns3_topology); //get_one_link_routes
252 sg_platf_postparse_add_cb(&parse_ns3_end_platform); //InitializeRoutes
258 static void free_ns3_link(void * elmts)
260 delete static_cast<NetworkNS3LinkPtr>(elmts);
263 static void free_ns3_host(void * elmts)
265 ns3_nodes_t host = static_cast<ns3_nodes_t>(elmts);
269 void surf_network_model_init_NS3()
271 if (surf_network_model)
274 surf_network_model = new NetworkNS3Model();
276 xbt_dynar_push(model_list, &surf_network_model);
279 NetworkNS3Model::NetworkNS3Model() : NetworkModel("network NS3") {
280 if (ns3_initialize(xbt_cfg_get_string(_sg_cfg_set, "ns3/TcpModel"))) {
281 xbt_die("Impossible to initialize NS3 interface");
283 routing_model_create(NULL);
284 define_callbacks_ns3();
286 NS3_HOST_LEVEL = xbt_lib_add_level(host_lib,(void_f_pvoid_t)free_ns3_host);
287 NS3_ASR_LEVEL = xbt_lib_add_level(as_router_lib,(void_f_pvoid_t)free_ns3_host);
288 NS3_LINK_LEVEL = xbt_lib_add_level(link_lib,(void_f_pvoid_t)free_ns3_link);
291 NetworkNS3Model::~NetworkNS3Model() {
293 xbt_dynar_free_container(&IPV4addr);
294 xbt_dict_free(&dict_socket);
297 NetworkLinkPtr NetworkNS3Model::createResource(const char *name,
299 tmgr_trace_t bw_trace,
301 tmgr_trace_t lat_trace,
302 e_surf_resource_state_t state_initial,
303 tmgr_trace_t state_trace,
304 e_surf_link_sharing_policy_t policy,
305 xbt_dict_t properties){
307 XBT_INFO("The NS3 network model doesn't support bandwidth state traces");
309 XBT_INFO("The NS3 network model doesn't support latency state traces");
311 XBT_INFO("The NS3 network model doesn't support link state traces");
312 return new NetworkNS3Link(this, name, properties, bw_initial, lat_initial);
315 xbt_dynar_t NetworkNS3Model::getRoute(RoutingEdgePtr src, RoutingEdgePtr dst)
317 xbt_dynar_t route = NULL;
318 routing_get_route_and_latency(src, dst, &route, NULL);
319 //routing_platf->getRouteAndLatency(src, dst, &route, NULL);
323 ActionPtr NetworkNS3Model::communicate(RoutingEdgePtr src, RoutingEdgePtr dst,
324 double size, double rate)
326 XBT_DEBUG("Communicate from %s to %s", src->getName(), dst->getName());
327 NetworkNS3ActionPtr action = new NetworkNS3Action(this, size, 0);
329 ns3_create_flow(src->getName(), dst->getName(), surf_get_clock(), size, action);
332 action->m_lastSent = 0;
333 action->p_srcElm = src;
334 action->p_dstElm = dst;
336 surf_callback_emit(networkCommunicateCallbacks, action, src, dst, size, rate);
338 return (surf_action_t) action;
341 double NetworkNS3Model::shareResources(double now)
343 XBT_DEBUG("ns3_share_resources");
345 //get the first relevant value from the running_actions list
346 if (!getRunningActionSet()->size() || now == 0.0)
351 time_to_next_flow_completion = ns3_time() - surf_get_clock();//FIXME: use now instead ?
352 } while(double_equals(time_to_next_flow_completion, 0));
354 XBT_DEBUG("min : %f", now);
355 XBT_DEBUG("ns3 time : %f", ns3_time());
356 XBT_DEBUG("surf time : %f", surf_get_clock());
357 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
359 return time_to_next_flow_completion;
362 void NetworkNS3Model::updateActionsState(double now, double delta)
364 xbt_dict_cursor_t cursor = NULL;
368 static xbt_dynar_t socket_to_destroy = NULL;
369 if(!socket_to_destroy) socket_to_destroy = xbt_dynar_new(sizeof(char*),NULL);
371 /* If there are no running flows, just return */
372 if (!getRunningActionSet()->size()) {
373 while(double_positive(now-ns3_time())) {
374 ns3_simulator(now-ns3_time());
379 NetworkNS3ActionPtr action;
380 xbt_dict_foreach(dict_socket,cursor,key,data){
381 action = static_cast<NetworkNS3ActionPtr>(ns3_get_socket_action(data));
382 XBT_DEBUG("Processing socket %p (action %p)",data,action);
383 action->setRemains(action->getCost() - ns3_get_socket_sent(data));
386 if (TRACE_is_enabled() &&
387 action->getState() == SURF_ACTION_RUNNING){
388 double data_sent = ns3_get_socket_sent(data);
389 double data_delta_sent = data_sent - action->m_lastSent;
391 xbt_dynar_t route = NULL;
393 routing_get_route_and_latency (action->p_srcElm, action->p_dstElm, &route, NULL);
395 for (i = 0; i < xbt_dynar_length (route); i++){
396 NetworkNS3LinkPtr link = ((NetworkNS3LinkPtr)xbt_dynar_get_ptr (route, i));
397 TRACE_surf_link_set_utilization (link->getName(),
398 action->getCategory(),
399 (data_delta_sent)/delta,
403 action->m_lastSent = data_sent;
407 if(ns3_get_socket_is_finished(data) == 1){
408 xbt_dynar_push(socket_to_destroy,&key);
409 XBT_DEBUG("Destroy socket %p of action %p", key, action);
411 action->setState(SURF_ACTION_DONE);
415 while (!xbt_dynar_is_empty(socket_to_destroy)){
416 xbt_dynar_pop(socket_to_destroy,&key);
418 void *data = xbt_dict_get (dict_socket, key);
419 action = static_cast<NetworkNS3ActionPtr>(ns3_get_socket_action(data));
420 XBT_DEBUG ("Removing socket %p of action %p", key, action);
421 xbt_dict_remove(dict_socket, key);
430 NetworkNS3Link::NetworkNS3Link(NetworkNS3ModelPtr model, const char *name, xbt_dict_t props,
431 double bw_initial, double lat_initial)
432 : NetworkLink(model, name, props)
433 , p_lat(bprintf("%f", lat_initial))
434 , p_bdw(bprintf("%f", bw_initial))
439 NetworkNS3Link::~NetworkNS3Link()
443 void NetworkNS3Link::updateState(tmgr_trace_event_t event_type, double value, double date)
452 NetworkNS3Action::NetworkNS3Action(ModelPtr model, double cost, bool failed)
453 : NetworkAction(model, cost, failed)
456 #ifdef HAVE_LATENCY_BOUND_TRACKING
457 int NetworkNS3Action::getLatencyLimited() {
458 return m_latencyLimited;
462 void NetworkNS3Action::suspend()
467 void NetworkNS3Action::resume()
472 /* Test whether a flow is suspended */
473 bool NetworkNS3Action::isSuspended()
478 int NetworkNS3Action::unref()
482 if (actionHook::is_linked())
483 p_stateSet->erase(p_stateSet->iterator_to(*this));
484 XBT_DEBUG ("Removing action %p", this);