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);
17 static double time_to_next_flow_completion = -1;
19 extern xbt_dict_t dict_socket;
25 static void replace_bdw_ns3(char ** bdw)
27 char *temp = xbt_strdup(*bdw);
29 *bdw = bprintf("%fBps",atof(temp));
34 static void replace_lat_ns3(char ** lat)
36 char *temp = xbt_strdup(*lat);
38 *lat = bprintf("%fs",atof(temp));
42 static void simgrid_ns3_add_host(simgrid::Host& host)
44 const char* id = host.getName().c_str();
45 XBT_DEBUG("NS3_ADD_HOST '%s'", id);
46 host.extension_set(NS3_EXTENSION_ID, ns3_add_host(id));
49 static void parse_ns3_add_link(sg_platf_link_cbarg_t link)
51 XBT_DEBUG("NS3_ADD_LINK '%s'",link->id);
53 if(!IPV4addr) IPV4addr = xbt_dynar_new(sizeof(char*),free);
55 surf_network_model->createLink(link->id,
57 link->bandwidth_trace,
66 static void simgrid_ns3_add_router(simgrid::surf::NetCard* router)
68 const char* router_id = router->getName();
69 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
70 xbt_lib_set(as_router_lib,
73 ns3_add_router(router_id)
77 static void parse_ns3_add_AS(simgrid::surf::As* as)
79 const char* as_id = as->p_name;
80 XBT_DEBUG("NS3_ADD_AS '%s'", as_id);
81 xbt_lib_set(as_router_lib, as_id, NS3_ASR_LEVEL, ns3_add_AS(as_id) );
84 static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
86 const char *cluster_prefix = cluster->prefix;
87 const char *cluster_suffix = cluster->suffix;
88 const char *cluster_radical = cluster->radical;
89 const char *cluster_bb_bw = bprintf("%f",cluster->bb_bw);
90 const char *cluster_bb_lat = bprintf("%f",cluster->bb_lat);
91 const char *cluster_bw = bprintf("%f",cluster->bw);
92 const char *cluster_lat = bprintf("%f",cluster->lat);
93 const char *groups = NULL;
98 xbt_dynar_t radical_elements;
99 xbt_dynar_t radical_ends;
100 xbt_dynar_t tab_elements_num = xbt_dynar_new(sizeof(int), NULL);
102 char *router_id,*host_id;
104 radical_elements = xbt_str_split(cluster_radical, ",");
105 xbt_dynar_foreach(radical_elements, iter, groups) {
106 radical_ends = xbt_str_split(groups, "-");
108 switch (xbt_dynar_length(radical_ends)) {
110 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
111 xbt_dynar_push_as(tab_elements_num, int, start);
112 router_id = bprintf("ns3_%s%d%s", cluster_prefix, start, cluster_suffix);
113 simgrid::s4u::Host::by_name_or_create(router_id)
114 ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
115 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
120 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
121 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
122 for (i = start; i <= end; i++){
123 xbt_dynar_push_as(tab_elements_num, int, i);
124 router_id = bprintf("ns3_%s%d%s", cluster_prefix, i, cluster_suffix);
125 simgrid::s4u::Host::by_name_or_create(router_id)
126 ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
127 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
133 XBT_DEBUG("Malformed radical");
140 char * lat = xbt_strdup(cluster_lat);
141 char * bw = xbt_strdup(cluster_bw);
142 replace_lat_ns3(&lat);
143 replace_bdw_ns3(&bw);
145 xbt_dynar_foreach(tab_elements_num,cpt,elmts)
147 host_id = bprintf("%s%d%s", cluster_prefix, elmts, cluster_suffix);
148 router_id = bprintf("ns3_%s%d%s", cluster_prefix, elmts, cluster_suffix);
149 XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
151 ns3_nodes_t host_src = ns3_find_host(host_id);
152 ns3_nodes_t host_dst = ns3_find_host(router_id);
154 if(host_src && host_dst){}
155 else xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
157 ns3_add_link(host_src->node_num,host_src->type,
158 host_dst->node_num,host_dst->type,
164 xbt_dynar_free(&tab_elements_num);
167 //Create link backbone
168 lat = xbt_strdup(cluster_bb_lat);
169 bw = xbt_strdup(cluster_bb_bw);
170 replace_lat_ns3(&lat);
171 replace_bdw_ns3(&bw);
172 ns3_add_cluster(bw,lat,cluster->id);
177 /* Create the ns3 topology based on routing strategy */
178 static void create_ns3_topology(void)
180 XBT_DEBUG("Starting topology generation");
182 xbt_dynar_shrink(IPV4addr,0);
184 //get the onelinks from the parsed platform
185 xbt_dynar_t onelink_routes = routing_platf->getOneLinkRoutes();
187 xbt_die("There is no routes!");
188 XBT_DEBUG("Have get_onelink_routes, found %ld routes",onelink_routes->used);
189 //save them in trace file
190 simgrid::surf::Onelink *onelink;
192 xbt_dynar_foreach(onelink_routes, iter, onelink) {
193 char *src = onelink->p_src->getName();
194 char *dst = onelink->p_dst->getName();
195 simgrid::surf::NetworkNS3Link *link =
196 static_cast<simgrid::surf::NetworkNS3Link *>(onelink->p_link);
198 if (strcmp(src,dst) && link->m_created){
199 XBT_DEBUG("Route from '%s' to '%s' with link '%s'", src, dst, link->getName());
200 char * link_bdw = xbt_strdup(link->p_bdw);
201 char * link_lat = xbt_strdup(link->p_lat);
202 replace_lat_ns3(&link_lat);
203 replace_bdw_ns3(&link_bdw);
206 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
207 XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
210 ns3_nodes_t host_src = ns3_find_host(src);
211 if(!host_src) host_src = static_cast<ns3_nodes_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
212 ns3_nodes_t host_dst = ns3_find_host(dst);
213 if(!host_dst) host_dst = static_cast<ns3_nodes_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
215 if(host_src && host_dst){}
216 else xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
218 ns3_add_link(host_src->node_num,host_src->type,host_dst->node_num,host_dst->type,link_bdw,link_lat);
226 static void parse_ns3_end_platform(void)
231 static void define_callbacks_ns3(void)
233 simgrid::Host::onCreation.connect(simgrid_ns3_add_host);
234 simgrid::surf::routingEdgeCreatedCallbacks.connect(simgrid_ns3_add_router);
235 sg_platf_link_add_cb (&parse_ns3_add_link);
236 sg_platf_cluster_add_cb (&parse_ns3_add_cluster);
237 simgrid::surf::asCreatedCallbacks.connect(parse_ns3_add_AS);
238 sg_platf_postparse_add_cb(&create_ns3_topology); //get_one_link_routes
239 sg_platf_postparse_add_cb(&parse_ns3_end_platform); //InitializeRoutes
245 static void free_ns3_link(void * elmts)
247 delete static_cast<simgrid::surf::NetworkNS3Link*>(elmts);
250 static void free_ns3_host(void * elmts)
252 ns3_nodes_t host = static_cast<ns3_nodes_t>(elmts);
256 void surf_network_model_init_NS3()
258 if (surf_network_model)
261 surf_network_model = new simgrid::surf::NetworkNS3Model();
263 xbt_dynar_push(all_existing_models, &surf_network_model);
269 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
270 if (ns3_initialize(xbt_cfg_get_string(_sg_cfg_set, "ns3/TcpModel"))) {
271 xbt_die("Impossible to initialize NS3 interface");
273 routing_model_create(NULL);
274 define_callbacks_ns3();
276 NS3_EXTENSION_ID = simgrid::s4u::Host::extension_create(free_ns3_host);
277 NS3_ASR_LEVEL = xbt_lib_add_level(as_router_lib, free_ns3_host);
280 NetworkNS3Model::~NetworkNS3Model() {
282 xbt_dynar_free_container(&IPV4addr);
283 xbt_dict_free(&dict_socket);
286 Link* NetworkNS3Model::createLink(const char *name,
288 tmgr_trace_t bw_trace,
290 tmgr_trace_t lat_trace,
292 tmgr_trace_t state_trace,
293 e_surf_link_sharing_policy_t policy,
294 xbt_dict_t properties){
296 XBT_INFO("The NS3 network model doesn't support bandwidth state traces");
298 XBT_INFO("The NS3 network model doesn't support latency state traces");
300 XBT_INFO("The NS3 network model doesn't support link state traces");
301 Link* link = new NetworkNS3Link(this, name, properties, bw_initial, lat_initial);
302 Link::onCreation(link);
306 xbt_dynar_t NetworkNS3Model::getRoute(NetCard *src, NetCard *dst)
308 xbt_dynar_t route = NULL;
309 routing_get_route_and_latency(src, dst, &route, NULL);
310 //routing_platf->getRouteAndLatency(src, dst, &route, NULL);
314 Action *NetworkNS3Model::communicate(NetCard *src, NetCard *dst,
315 double size, double rate)
317 XBT_DEBUG("Communicate from %s to %s", src->getName(), dst->getName());
318 NetworkNS3Action *action = new NetworkNS3Action(this, size, 0);
320 ns3_create_flow(src->getName(), dst->getName(), surf_get_clock(), size, action);
322 action->m_lastSent = 0;
323 action->p_srcElm = src;
324 action->p_dstElm = dst;
325 networkCommunicateCallbacks(action, src, dst, size, rate);
327 return (surf_action_t) action;
330 double NetworkNS3Model::shareResources(double now)
332 XBT_DEBUG("ns3_share_resources");
334 //get the first relevant value from the running_actions list
335 if (!getRunningActionSet()->size() || now == 0.0)
340 time_to_next_flow_completion = ns3_time() - surf_get_clock();//FIXME: use now instead ?
341 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
343 XBT_DEBUG("min : %f", now);
344 XBT_DEBUG("ns3 time : %f", ns3_time());
345 XBT_DEBUG("surf time : %f", surf_get_clock());
346 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
348 return time_to_next_flow_completion;
351 void NetworkNS3Model::updateActionsState(double now, double delta)
353 xbt_dict_cursor_t cursor = NULL;
357 static xbt_dynar_t socket_to_destroy = NULL;
358 if(!socket_to_destroy) socket_to_destroy = xbt_dynar_new(sizeof(char*),NULL);
360 /* If there are no running flows, just return */
361 if (!getRunningActionSet()->size()) {
362 while(double_positive(now-ns3_time(), sg_surf_precision)) {
363 ns3_simulator(now-ns3_time());
368 NetworkNS3Action *action;
369 xbt_dict_foreach(dict_socket,cursor,key,data){
370 action = static_cast<NetworkNS3Action*>(ns3_get_socket_action(data));
371 XBT_DEBUG("Processing socket %p (action %p)",data,action);
372 action->setRemains(action->getCost() - ns3_get_socket_sent(data));
374 if (TRACE_is_enabled() &&
375 action->getState() == SURF_ACTION_RUNNING){
376 double data_sent = ns3_get_socket_sent(data);
377 double data_delta_sent = data_sent - action->m_lastSent;
379 xbt_dynar_t route = NULL;
381 routing_get_route_and_latency (action->p_srcElm, action->p_dstElm, &route, NULL);
383 for (i = 0; i < xbt_dynar_length (route); i++){
384 NetworkNS3Link* link = ((NetworkNS3Link*)xbt_dynar_get_ptr(route, i));
385 TRACE_surf_link_set_utilization (link->getName(),
386 action->getCategory(),
387 (data_delta_sent)/delta,
391 action->m_lastSent = data_sent;
394 if(ns3_get_socket_is_finished(data) == 1){
395 xbt_dynar_push(socket_to_destroy,&key);
396 XBT_DEBUG("Destroy socket %p of action %p", key, action);
398 action->setState(SURF_ACTION_DONE);
402 while (!xbt_dynar_is_empty(socket_to_destroy)){
403 xbt_dynar_pop(socket_to_destroy,&key);
405 void *data = xbt_dict_get (dict_socket, key);
406 action = static_cast<NetworkNS3Action*>(ns3_get_socket_action(data));
407 XBT_DEBUG ("Removing socket %p of action %p", key, action);
408 xbt_dict_remove(dict_socket, key);
417 NetworkNS3Link::NetworkNS3Link(NetworkNS3Model *model, const char *name, xbt_dict_t props,
418 double bw_initial, double lat_initial)
419 : Link(model, name, props)
420 , p_lat(bprintf("%f", lat_initial))
421 , p_bdw(bprintf("%f", bw_initial))
426 NetworkNS3Link::~NetworkNS3Link()
430 void NetworkNS3Link::updateState(tmgr_trace_event_t event_type, double value, double date)
439 NetworkNS3Action::NetworkNS3Action(Model *model, double cost, bool failed)
440 : NetworkAction(model, cost, failed)
443 #ifdef HAVE_LATENCY_BOUND_TRACKING
444 int NetworkNS3Action::getLatencyLimited() {
445 return m_latencyLimited;
449 void NetworkNS3Action::suspend()
454 void NetworkNS3Action::resume()
459 /* Test whether a flow is suspended */
460 bool NetworkNS3Action::isSuspended()
465 int NetworkNS3Action::unref()
469 if (action_hook.is_linked())
470 p_stateSet->erase(p_stateSet->iterator_to(*this));
471 XBT_DEBUG ("Removing action %p", this);