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"
11 #include "src/surf/platform.hpp"
13 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(ns3);
18 static double time_to_next_flow_completion = -1;
20 extern xbt_dict_t dict_socket;
26 static void replace_bdw_ns3(char ** bdw)
28 char *temp = xbt_strdup(*bdw);
30 *bdw = bprintf("%fBps",atof(temp));
35 static void replace_lat_ns3(char ** lat)
37 char *temp = xbt_strdup(*lat);
39 *lat = bprintf("%fs",atof(temp));
43 static void simgrid_ns3_add_host(simgrid::s4u::Host& host)
45 const char* id = host.name().c_str();
46 XBT_DEBUG("NS3_ADD_HOST '%s'", id);
47 host.extension_set(NS3_EXTENSION_ID, ns3_add_host(id));
50 static void parse_ns3_add_link(sg_platf_link_cbarg_t link)
52 XBT_DEBUG("NS3_ADD_LINK '%s'",link->id);
54 if(!IPV4addr) IPV4addr = xbt_dynar_new(sizeof(char*),free);
56 surf_network_model->createLink(link->id,
58 link->bandwidth_trace,
67 static void simgrid_ns3_add_router(simgrid::surf::NetCard* router)
69 const char* router_id = router->getName();
70 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
71 xbt_lib_set(as_router_lib,
74 ns3_add_router(router_id)
78 static void parse_ns3_add_AS(simgrid::surf::As* as)
80 const char* as_id = as->p_name;
81 XBT_DEBUG("NS3_ADD_AS '%s'", as_id);
82 xbt_lib_set(as_router_lib, as_id, NS3_ASR_LEVEL, ns3_add_AS(as_id) );
85 static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
87 const char *cluster_prefix = cluster->prefix;
88 const char *cluster_suffix = cluster->suffix;
89 const char *cluster_radical = cluster->radical;
90 const char *cluster_bb_bw = bprintf("%f",cluster->bb_bw);
91 const char *cluster_bb_lat = bprintf("%f",cluster->bb_lat);
92 const char *cluster_bw = bprintf("%f",cluster->bw);
93 const char *cluster_lat = bprintf("%f",cluster->lat);
94 const char *groups = NULL;
99 xbt_dynar_t radical_elements;
100 xbt_dynar_t radical_ends;
101 xbt_dynar_t tab_elements_num = xbt_dynar_new(sizeof(int), NULL);
103 char *router_id,*host_id;
105 radical_elements = xbt_str_split(cluster_radical, ",");
106 xbt_dynar_foreach(radical_elements, iter, groups) {
107 radical_ends = xbt_str_split(groups, "-");
109 switch (xbt_dynar_length(radical_ends)) {
111 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
112 xbt_dynar_push_as(tab_elements_num, int, start);
113 router_id = bprintf("ns3_%s%d%s", cluster_prefix, start, cluster_suffix);
114 simgrid::s4u::Host::by_name_or_create(router_id)
115 ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
116 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
121 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
122 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
123 for (i = start; i <= end; i++){
124 xbt_dynar_push_as(tab_elements_num, int, i);
125 router_id = bprintf("ns3_%s%d%s", cluster_prefix, i, cluster_suffix);
126 simgrid::s4u::Host::by_name_or_create(router_id)
127 ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
128 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
134 XBT_DEBUG("Malformed radical");
141 char * lat = xbt_strdup(cluster_lat);
142 char * bw = xbt_strdup(cluster_bw);
143 replace_lat_ns3(&lat);
144 replace_bdw_ns3(&bw);
146 xbt_dynar_foreach(tab_elements_num,cpt,elmts)
148 host_id = bprintf("%s%d%s", cluster_prefix, elmts, cluster_suffix);
149 router_id = bprintf("ns3_%s%d%s", cluster_prefix, elmts, cluster_suffix);
150 XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
152 ns3_nodes_t host_src = ns3_find_host(host_id);
153 ns3_nodes_t host_dst = ns3_find_host(router_id);
155 if(host_src && host_dst){}
156 else xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
158 ns3_add_link(host_src->node_num,host_src->type,
159 host_dst->node_num,host_dst->type,
165 xbt_dynar_free(&tab_elements_num);
168 //Create link backbone
169 lat = xbt_strdup(cluster_bb_lat);
170 bw = xbt_strdup(cluster_bb_bw);
171 replace_lat_ns3(&lat);
172 replace_bdw_ns3(&bw);
173 ns3_add_cluster(bw,lat,cluster->id);
178 /* Create the ns3 topology based on routing strategy */
179 static void create_ns3_topology(void)
181 XBT_DEBUG("Starting topology generation");
183 xbt_dynar_shrink(IPV4addr,0);
185 //get the onelinks from the parsed platform
186 xbt_dynar_t onelink_routes = routing_platf->getOneLinkRoutes();
188 xbt_die("There is no routes!");
189 XBT_DEBUG("Have get_onelink_routes, found %ld routes",onelink_routes->used);
190 //save them in trace file
191 simgrid::surf::Onelink *onelink;
193 xbt_dynar_foreach(onelink_routes, iter, onelink) {
194 char *src = onelink->p_src->getName();
195 char *dst = onelink->p_dst->getName();
196 simgrid::surf::NetworkNS3Link *link =
197 static_cast<simgrid::surf::NetworkNS3Link *>(onelink->p_link);
199 if (strcmp(src,dst) && link->m_created){
200 XBT_DEBUG("Route from '%s' to '%s' with link '%s'", src, dst, link->getName());
201 char * link_bdw = xbt_strdup(link->p_bdw);
202 char * link_lat = xbt_strdup(link->p_lat);
203 replace_lat_ns3(&link_lat);
204 replace_bdw_ns3(&link_bdw);
207 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
208 XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
211 ns3_nodes_t host_src = ns3_find_host(src);
212 if(!host_src) host_src = static_cast<ns3_nodes_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
213 ns3_nodes_t host_dst = ns3_find_host(dst);
214 if(!host_dst) host_dst = static_cast<ns3_nodes_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
216 if(host_src && host_dst){}
217 else xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
219 ns3_add_link(host_src->node_num,host_src->type,host_dst->node_num,host_dst->type,link_bdw,link_lat);
227 static void parse_ns3_end_platform(void)
232 static void define_callbacks_ns3(void)
234 simgrid::s4u::Host::onCreation.connect(simgrid_ns3_add_host);
235 simgrid::surf::netcardCreatedCallbacks.connect(simgrid_ns3_add_router);
236 simgrid::surf::on_link.connect (&parse_ns3_add_link);
237 simgrid::surf::on_cluster.connect (&parse_ns3_add_cluster);
238 simgrid::surf::asCreatedCallbacks.connect(parse_ns3_add_AS);
239 simgrid::surf::on_postparse.connect(&create_ns3_topology); //get_one_link_routes
240 simgrid::surf::on_postparse.connect(&parse_ns3_end_platform); //InitializeRoutes
246 static void free_ns3_link(void * elmts)
248 delete static_cast<simgrid::surf::NetworkNS3Link*>(elmts);
251 static void free_ns3_host(void * elmts)
253 ns3_nodes_t host = static_cast<ns3_nodes_t>(elmts);
257 void surf_network_model_init_NS3()
259 if (surf_network_model)
262 surf_network_model = new simgrid::surf::NetworkNS3Model();
264 xbt_dynar_push(all_existing_models, &surf_network_model);
270 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
271 if (ns3_initialize(xbt_cfg_get_string(_sg_cfg_set, "ns3/TcpModel"))) {
272 xbt_die("Impossible to initialize NS3 interface");
274 routing_model_create(NULL);
275 define_callbacks_ns3();
277 NS3_EXTENSION_ID = simgrid::s4u::Host::extension_create(free_ns3_host);
278 NS3_ASR_LEVEL = xbt_lib_add_level(as_router_lib, free_ns3_host);
281 NetworkNS3Model::~NetworkNS3Model() {
283 xbt_dynar_free_container(&IPV4addr);
284 xbt_dict_free(&dict_socket);
287 Link* NetworkNS3Model::createLink(const char *name,
289 tmgr_trace_t bw_trace,
291 tmgr_trace_t lat_trace,
293 tmgr_trace_t state_trace,
294 e_surf_link_sharing_policy_t policy,
295 xbt_dict_t properties){
297 XBT_INFO("The NS3 network model doesn't support bandwidth state traces");
299 XBT_INFO("The NS3 network model doesn't support latency state traces");
301 XBT_INFO("The NS3 network model doesn't support link state traces");
302 Link* link = new NetworkNS3Link(this, name, properties, bw_initial, lat_initial);
303 Link::onCreation(link);
307 xbt_dynar_t NetworkNS3Model::getRoute(NetCard *src, NetCard *dst)
309 xbt_dynar_t route = NULL;
310 routing_get_route_and_latency(src, dst, &route, NULL);
311 //routing_platf->getRouteAndLatency(src, dst, &route, NULL);
315 Action *NetworkNS3Model::communicate(NetCard *src, NetCard *dst,
316 double size, double rate)
318 XBT_DEBUG("Communicate from %s to %s", src->getName(), dst->getName());
319 NetworkNS3Action *action = new NetworkNS3Action(this, size, 0);
321 ns3_create_flow(src->getName(), dst->getName(), surf_get_clock(), size, action);
323 action->m_lastSent = 0;
324 action->p_srcElm = src;
325 action->p_dstElm = dst;
326 networkCommunicateCallbacks(action, src, dst, size, rate);
328 return (surf_action_t) action;
331 double NetworkNS3Model::shareResources(double now)
333 XBT_DEBUG("ns3_share_resources");
335 //get the first relevant value from the running_actions list
336 if (!getRunningActionSet()->size() || now == 0.0)
341 time_to_next_flow_completion = ns3_time() - surf_get_clock();//FIXME: use now instead ?
342 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
344 XBT_DEBUG("min : %f", now);
345 XBT_DEBUG("ns3 time : %f", ns3_time());
346 XBT_DEBUG("surf time : %f", surf_get_clock());
347 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
349 return time_to_next_flow_completion;
352 void NetworkNS3Model::updateActionsState(double now, double delta)
354 xbt_dict_cursor_t cursor = NULL;
358 static xbt_dynar_t socket_to_destroy = NULL;
359 if(!socket_to_destroy) socket_to_destroy = xbt_dynar_new(sizeof(char*),NULL);
361 /* If there are no running flows, just return */
362 if (!getRunningActionSet()->size()) {
363 while(double_positive(now-ns3_time(), sg_surf_precision)) {
364 ns3_simulator(now-ns3_time());
369 NetworkNS3Action *action;
370 xbt_dict_foreach(dict_socket,cursor,key,data){
371 action = static_cast<NetworkNS3Action*>(ns3_get_socket_action(data));
372 XBT_DEBUG("Processing socket %p (action %p)",data,action);
373 action->setRemains(action->getCost() - ns3_get_socket_sent(data));
375 if (TRACE_is_enabled() &&
376 action->getState() == SURF_ACTION_RUNNING){
377 double data_sent = ns3_get_socket_sent(data);
378 double data_delta_sent = data_sent - action->m_lastSent;
380 xbt_dynar_t route = NULL;
382 routing_get_route_and_latency (action->p_srcElm, action->p_dstElm, &route, NULL);
384 for (i = 0; i < xbt_dynar_length (route); i++){
385 NetworkNS3Link* link = ((NetworkNS3Link*)xbt_dynar_get_ptr(route, i));
386 TRACE_surf_link_set_utilization (link->getName(),
387 action->getCategory(),
388 (data_delta_sent)/delta,
392 action->m_lastSent = data_sent;
395 if(ns3_get_socket_is_finished(data) == 1){
396 xbt_dynar_push(socket_to_destroy,&key);
397 XBT_DEBUG("Destroy socket %p of action %p", key, action);
399 action->setState(SURF_ACTION_DONE);
403 while (!xbt_dynar_is_empty(socket_to_destroy)){
404 xbt_dynar_pop(socket_to_destroy,&key);
406 void *data = xbt_dict_get (dict_socket, key);
407 action = static_cast<NetworkNS3Action*>(ns3_get_socket_action(data));
408 XBT_DEBUG ("Removing socket %p of action %p", key, action);
409 xbt_dict_remove(dict_socket, key);
418 NetworkNS3Link::NetworkNS3Link(NetworkNS3Model *model, const char *name, xbt_dict_t props,
419 double bw_initial, double lat_initial)
420 : Link(model, name, props)
421 , p_lat(bprintf("%f", lat_initial))
422 , p_bdw(bprintf("%f", bw_initial))
427 NetworkNS3Link::~NetworkNS3Link()
431 void NetworkNS3Link::updateState(tmgr_trace_event_t event_type, double value, double date)
440 NetworkNS3Action::NetworkNS3Action(Model *model, double cost, bool failed)
441 : NetworkAction(model, cost, failed)
444 #ifdef HAVE_LATENCY_BOUND_TRACKING
445 int NetworkNS3Action::getLatencyLimited() {
446 return m_latencyLimited;
450 void NetworkNS3Action::suspend()
455 void NetworkNS3Action::resume()
460 /* Test whether a flow is suspended */
461 bool NetworkNS3Action::isSuspended()
466 int NetworkNS3Action::unref()
470 if (action_hook.is_linked())
471 p_stateSet->erase(p_stateSet->iterator_to(*this));
472 XBT_DEBUG ("Removing action %p", this);