1 /* Copyright (c) 2007-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. */
7 #include "src/surf/network_ns3.hpp"
8 #include "src/surf/surf_private.h"
9 #include "src/surf/host_interface.hpp"
10 #include "simgrid/sg_config.h"
12 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(ns3);
15 static double time_to_next_flow_completion = -1;
17 extern xbt_dict_t dict_socket;
23 static void replace_bdw_ns3(char ** bdw)
25 char *temp = xbt_strdup(*bdw);
27 *bdw = bprintf("%fBps",atof(temp));
32 static void replace_lat_ns3(char ** lat)
34 char *temp = xbt_strdup(*lat);
36 *lat = bprintf("%fs",atof(temp));
40 static void simgrid_ns3_add_host(simgrid::surf::Host* host)
42 const char* id = host->getName();
43 XBT_DEBUG("NS3_ADD_HOST '%s'", id);
44 host->getHost()->set_facet(NS3_HOST_LEVEL, ns3_add_host(id));
47 static void parse_ns3_add_link(sg_platf_link_cbarg_t link)
49 XBT_DEBUG("NS3_ADD_LINK '%s'",link->id);
51 if(!IPV4addr) IPV4addr = xbt_dynar_new(sizeof(char*),free);
53 surf_network_model->createLink(link->id,
55 link->bandwidth_trace,
64 static void simgrid_ns3_add_router(simgrid::surf::RoutingEdge* router)
66 const char* router_id = router->getName();
67 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
68 xbt_lib_set(as_router_lib,
71 ns3_add_router(router_id)
75 static void parse_ns3_add_AS(simgrid::surf::As* as)
77 const char* as_id = as->p_name;
78 XBT_DEBUG("NS3_ADD_AS '%s'", as_id);
79 xbt_lib_set(as_router_lib, as_id, NS3_ASR_LEVEL, ns3_add_AS(as_id) );
82 static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
84 const char *cluster_prefix = cluster->prefix;
85 const char *cluster_suffix = cluster->suffix;
86 const char *cluster_radical = cluster->radical;
87 const char *cluster_bb_bw = bprintf("%f",cluster->bb_bw);
88 const char *cluster_bb_lat = bprintf("%f",cluster->bb_lat);
89 const char *cluster_bw = bprintf("%f",cluster->bw);
90 const char *cluster_lat = bprintf("%f",cluster->lat);
91 const char *groups = NULL;
96 xbt_dynar_t radical_elements;
97 xbt_dynar_t radical_ends;
98 xbt_dynar_t tab_elements_num = xbt_dynar_new(sizeof(int), NULL);
100 char *router_id,*host_id;
102 radical_elements = xbt_str_split(cluster_radical, ",");
103 xbt_dynar_foreach(radical_elements, iter, groups) {
104 radical_ends = xbt_str_split(groups, "-");
106 switch (xbt_dynar_length(radical_ends)) {
108 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
109 xbt_dynar_push_as(tab_elements_num, int, start);
110 router_id = bprintf("ns3_%s%d%s", cluster_prefix, start, cluster_suffix);
111 simgrid::Host::by_name_or_create(router_id)
112 ->set_facet(NS3_HOST_LEVEL, ns3_add_host_cluster(router_id));
113 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
118 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
119 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
120 for (i = start; i <= end; i++){
121 xbt_dynar_push_as(tab_elements_num, int, i);
122 router_id = bprintf("ns3_%s%d%s", cluster_prefix, i, cluster_suffix);
123 simgrid::Host::by_name_or_create(router_id)
124 ->set_facet(NS3_HOST_LEVEL, ns3_add_host_cluster(router_id));
125 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
131 XBT_DEBUG("Malformed radical");
138 char * lat = xbt_strdup(cluster_lat);
139 char * bw = xbt_strdup(cluster_bw);
140 replace_lat_ns3(&lat);
141 replace_bdw_ns3(&bw);
143 xbt_dynar_foreach(tab_elements_num,cpt,elmts)
145 host_id = bprintf("%s%d%s", cluster_prefix, elmts, cluster_suffix);
146 router_id = bprintf("ns3_%s%d%s", cluster_prefix, elmts, cluster_suffix);
147 XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
149 ns3_nodes_t host_src = ns3_find_host(host_id);
150 ns3_nodes_t host_dst = ns3_find_host(router_id);
152 if(host_src && host_dst){}
153 else xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
155 ns3_add_link(host_src->node_num,host_src->type,
156 host_dst->node_num,host_dst->type,
162 xbt_dynar_free(&tab_elements_num);
165 //Create link backbone
166 lat = xbt_strdup(cluster_bb_lat);
167 bw = xbt_strdup(cluster_bb_bw);
168 replace_lat_ns3(&lat);
169 replace_bdw_ns3(&bw);
170 ns3_add_cluster(bw,lat,cluster->id);
175 /* Create the ns3 topology based on routing strategy */
176 static void create_ns3_topology(void)
178 XBT_DEBUG("Starting topology generation");
180 xbt_dynar_shrink(IPV4addr,0);
182 //get the onelinks from the parsed platform
183 xbt_dynar_t onelink_routes = routing_platf->getOneLinkRoutes();
185 xbt_die("There is no routes!");
186 XBT_DEBUG("Have get_onelink_routes, found %ld routes",onelink_routes->used);
187 //save them in trace file
188 simgrid::surf::Onelink *onelink;
190 xbt_dynar_foreach(onelink_routes, iter, onelink) {
191 char *src = onelink->p_src->getName();
192 char *dst = onelink->p_dst->getName();
193 simgrid::surf::NetworkNS3Link *link =
194 static_cast<simgrid::surf::NetworkNS3Link *>(onelink->p_link);
196 if (strcmp(src,dst) && link->m_created){
197 XBT_DEBUG("Route from '%s' to '%s' with link '%s'", src, dst, link->getName());
198 char * link_bdw = xbt_strdup(link->p_bdw);
199 char * link_lat = xbt_strdup(link->p_lat);
200 replace_lat_ns3(&link_lat);
201 replace_bdw_ns3(&link_bdw);
204 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
205 XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
208 ns3_nodes_t host_src = ns3_find_host(src);
209 if(!host_src) host_src = static_cast<ns3_nodes_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
210 ns3_nodes_t host_dst = ns3_find_host(dst);
211 if(!host_dst) host_dst = static_cast<ns3_nodes_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
213 if(host_src && host_dst){}
214 else xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
216 ns3_add_link(host_src->node_num,host_src->type,host_dst->node_num,host_dst->type,link_bdw,link_lat);
224 static void parse_ns3_end_platform(void)
229 static void define_callbacks_ns3(void)
231 simgrid::surf::hostCreatedCallbacks.connect(simgrid_ns3_add_host);
232 simgrid::surf::routingEdgeCreatedCallbacks.connect(simgrid_ns3_add_router);
233 sg_platf_link_add_cb (&parse_ns3_add_link);
234 sg_platf_cluster_add_cb (&parse_ns3_add_cluster);
235 simgrid::surf::asCreatedCallbacks.connect(parse_ns3_add_AS);
236 sg_platf_postparse_add_cb(&create_ns3_topology); //get_one_link_routes
237 sg_platf_postparse_add_cb(&parse_ns3_end_platform); //InitializeRoutes
243 static void free_ns3_link(void * elmts)
245 delete static_cast<simgrid::surf::NetworkNS3Link*>(elmts);
248 static void free_ns3_host(void * elmts)
250 ns3_nodes_t host = static_cast<ns3_nodes_t>(elmts);
254 void surf_network_model_init_NS3()
256 if (surf_network_model)
259 surf_network_model = new simgrid::surf::NetworkNS3Model();
261 xbt_dynar_push(all_existing_models, &surf_network_model);
267 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
268 if (ns3_initialize(xbt_cfg_get_string(_sg_cfg_set, "ns3/TcpModel"))) {
269 xbt_die("Impossible to initialize NS3 interface");
271 routing_model_create(NULL);
272 define_callbacks_ns3();
274 NS3_HOST_LEVEL = simgrid::Host::add_level(free_ns3_host);
275 NS3_ASR_LEVEL = xbt_lib_add_level(as_router_lib, free_ns3_host);
278 NetworkNS3Model::~NetworkNS3Model() {
280 xbt_dynar_free_container(&IPV4addr);
281 xbt_dict_free(&dict_socket);
284 Link* NetworkNS3Model::createLink(const char *name,
286 tmgr_trace_t bw_trace,
288 tmgr_trace_t lat_trace,
289 e_surf_resource_state_t state_initial,
290 tmgr_trace_t state_trace,
291 e_surf_link_sharing_policy_t policy,
292 xbt_dict_t properties){
294 XBT_INFO("The NS3 network model doesn't support bandwidth state traces");
296 XBT_INFO("The NS3 network model doesn't support latency state traces");
298 XBT_INFO("The NS3 network model doesn't support link state traces");
299 Link* link = new NetworkNS3Link(this, name, properties, bw_initial, lat_initial);
300 networkLinkCreatedCallbacks(link);
304 xbt_dynar_t NetworkNS3Model::getRoute(RoutingEdge *src, RoutingEdge *dst)
306 xbt_dynar_t route = NULL;
307 routing_get_route_and_latency(src, dst, &route, NULL);
308 //routing_platf->getRouteAndLatency(src, dst, &route, NULL);
312 Action *NetworkNS3Model::communicate(RoutingEdge *src, RoutingEdge *dst,
313 double size, double rate)
315 XBT_DEBUG("Communicate from %s to %s", src->getName(), dst->getName());
316 NetworkNS3Action *action = new NetworkNS3Action(this, size, 0);
318 ns3_create_flow(src->getName(), dst->getName(), surf_get_clock(), size, action);
320 action->m_lastSent = 0;
321 action->p_srcElm = src;
322 action->p_dstElm = dst;
323 networkCommunicateCallbacks(action, src, dst, size, rate);
325 return (surf_action_t) action;
328 double NetworkNS3Model::shareResources(double now)
330 XBT_DEBUG("ns3_share_resources");
332 //get the first relevant value from the running_actions list
333 if (!getRunningActionSet()->size() || now == 0.0)
338 time_to_next_flow_completion = ns3_time() - surf_get_clock();//FIXME: use now instead ?
339 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
341 XBT_DEBUG("min : %f", now);
342 XBT_DEBUG("ns3 time : %f", ns3_time());
343 XBT_DEBUG("surf time : %f", surf_get_clock());
344 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
346 return time_to_next_flow_completion;
349 void NetworkNS3Model::updateActionsState(double now, double delta)
351 xbt_dict_cursor_t cursor = NULL;
355 static xbt_dynar_t socket_to_destroy = NULL;
356 if(!socket_to_destroy) socket_to_destroy = xbt_dynar_new(sizeof(char*),NULL);
358 /* If there are no running flows, just return */
359 if (!getRunningActionSet()->size()) {
360 while(double_positive(now-ns3_time(), sg_surf_precision)) {
361 ns3_simulator(now-ns3_time());
366 NetworkNS3Action *action;
367 xbt_dict_foreach(dict_socket,cursor,key,data){
368 action = static_cast<NetworkNS3Action*>(ns3_get_socket_action(data));
369 XBT_DEBUG("Processing socket %p (action %p)",data,action);
370 action->setRemains(action->getCost() - ns3_get_socket_sent(data));
372 if (TRACE_is_enabled() &&
373 action->getState() == SURF_ACTION_RUNNING){
374 double data_sent = ns3_get_socket_sent(data);
375 double data_delta_sent = data_sent - action->m_lastSent;
377 xbt_dynar_t route = NULL;
379 routing_get_route_and_latency (action->p_srcElm, action->p_dstElm, &route, NULL);
381 for (i = 0; i < xbt_dynar_length (route); i++){
382 NetworkNS3Link* link = ((NetworkNS3Link*)xbt_dynar_get_ptr(route, i));
383 TRACE_surf_link_set_utilization (link->getName(),
384 action->getCategory(),
385 (data_delta_sent)/delta,
389 action->m_lastSent = data_sent;
392 if(ns3_get_socket_is_finished(data) == 1){
393 xbt_dynar_push(socket_to_destroy,&key);
394 XBT_DEBUG("Destroy socket %p of action %p", key, action);
396 action->setState(SURF_ACTION_DONE);
400 while (!xbt_dynar_is_empty(socket_to_destroy)){
401 xbt_dynar_pop(socket_to_destroy,&key);
403 void *data = xbt_dict_get (dict_socket, key);
404 action = static_cast<NetworkNS3Action*>(ns3_get_socket_action(data));
405 XBT_DEBUG ("Removing socket %p of action %p", key, action);
406 xbt_dict_remove(dict_socket, key);
415 NetworkNS3Link::NetworkNS3Link(NetworkNS3Model *model, const char *name, xbt_dict_t props,
416 double bw_initial, double lat_initial)
417 : Link(model, name, props)
418 , p_lat(bprintf("%f", lat_initial))
419 , p_bdw(bprintf("%f", bw_initial))
424 NetworkNS3Link::~NetworkNS3Link()
428 void NetworkNS3Link::updateState(tmgr_trace_event_t event_type, double value, double date)
437 NetworkNS3Action::NetworkNS3Action(Model *model, double cost, bool failed)
438 : NetworkAction(model, cost, failed)
441 #ifdef HAVE_LATENCY_BOUND_TRACKING
442 int NetworkNS3Action::getLatencyLimited() {
443 return m_latencyLimited;
447 void NetworkNS3Action::suspend()
452 void NetworkNS3Action::resume()
457 /* Test whether a flow is suspended */
458 bool NetworkNS3Action::isSuspended()
463 int NetworkNS3Action::unref()
467 if (action_hook.is_linked())
468 p_stateSet->erase(p_stateSet->iterator_to(*this));
469 XBT_DEBUG ("Removing action %p", this);