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 "ns3/core-module.h"
9 #include "src/surf/network_ns3.hpp"
11 #include "src/surf/HostImpl.hpp"
12 #include "src/surf/surf_private.h"
13 #include "simgrid/sg_config.h"
14 #include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
16 #include "simgrid/s4u/As.hpp"
18 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(ns3);
22 xbt_dynar_t IPV4addr = xbt_dynar_new(sizeof(char*),free);
23 static double time_to_next_flow_completion = -1;
25 extern xbt_dict_t dict_socket;
31 static void simgrid_ns3_add_host(simgrid::s4u::Host& host)
33 const char* id = host.name().c_str();
34 XBT_DEBUG("NS3_ADD_HOST '%s'", id);
35 host.extension_set(NS3_EXTENSION_ID, ns3_add_host(id));
38 static void parse_ns3_add_link(sg_platf_link_cbarg_t link)
40 XBT_DEBUG("NS3_ADD_LINK '%s'",link->id);
42 Link *l = surf_network_model->createLink(link->id, link->bandwidth, link->latency, link->policy, link->properties);
43 if (link->bandwidth_trace)
44 l->setBandwidthTrace(link->latency_trace);
45 if (link->latency_trace)
46 l->setLatencyTrace(link->latency_trace);
47 if (link->state_trace)
48 l->setStateTrace(link->state_trace);
50 static void simgrid_ns3_add_router(simgrid::surf::NetCard* router)
52 const char* router_id = router->name();
53 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
54 xbt_lib_set(as_router_lib,
57 ns3_add_router(router_id)
61 static void parse_ns3_add_AS(simgrid::s4u::As* as)
63 const char* as_id = as->name();
64 XBT_DEBUG("NS3_ADD_AS '%s'", as_id);
65 xbt_lib_set(as_router_lib, as_id, NS3_ASR_LEVEL, ns3_add_AS(as_id) );
68 #include "src/surf/xml/platf.hpp" // FIXME: move that back to the parsing area
69 static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
71 const char *groups = NULL;
76 xbt_dynar_t radical_elements;
77 xbt_dynar_t radical_ends;
78 xbt_dynar_t tab_elements_num = xbt_dynar_new(sizeof(int), NULL);
80 char *router_id,*host_id;
82 radical_elements = xbt_str_split(cluster->radical, ",");
83 xbt_dynar_foreach(radical_elements, iter, groups) {
84 radical_ends = xbt_str_split(groups, "-");
86 switch (xbt_dynar_length(radical_ends)) {
88 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
89 xbt_dynar_push_as(tab_elements_num, int, start);
90 router_id = bprintf("ns3_%s%d%s", cluster->prefix, start, cluster->suffix);
91 simgrid::s4u::Host::by_name_or_create(router_id)
92 ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
93 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
98 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
99 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
100 for (i = start; i <= end; i++){
101 xbt_dynar_push_as(tab_elements_num, int, i);
102 router_id = bprintf("ns3_%s%d%s", cluster->prefix, i, cluster->suffix);
103 simgrid::s4u::Host::by_name_or_create(router_id)
104 ->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
105 XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
111 XBT_DEBUG("Malformed radical");
118 char * lat = bprintf("%fs", cluster->lat);
119 char * bw = bprintf("%fBps", cluster->bw);
121 xbt_dynar_foreach(tab_elements_num,cpt,elmts)
123 host_id = bprintf("%s%d%s", cluster->prefix, elmts, cluster->suffix);
124 router_id = bprintf("ns3_%s%d%s", cluster->prefix, elmts, cluster->suffix);
125 XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
127 ns3_nodes_t host_src = ns3_find_host(host_id);
128 ns3_nodes_t host_dst = ns3_find_host(router_id);
130 if(host_src && host_dst){}
131 else xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
133 ns3_add_link(host_src->node_num,host_src->type,
134 host_dst->node_num,host_dst->type,
142 xbt_dynar_free(&tab_elements_num);
145 //Create link backbone
146 lat = bprintf("%fs", cluster->bb_lat);
147 bw = bprintf("%fBps", cluster->bb_bw);
148 ns3_add_cluster(bw,lat,cluster->id);
153 /* Create the ns3 topology based on routing strategy */
154 static void create_ns3_topology(void)
156 XBT_DEBUG("Starting topology generation");
158 xbt_dynar_shrink(IPV4addr,0);
160 //get the onelinks from the parsed platform
161 xbt_dynar_t onelink_routes = routing_platf->getOneLinkRoutes();
163 xbt_die("There is no routes!");
164 XBT_DEBUG("Have get_onelink_routes, found %ld routes",onelink_routes->used);
165 //save them in trace file
166 simgrid::surf::Onelink *onelink;
168 xbt_dynar_foreach(onelink_routes, iter, onelink) {
169 char *src = onelink->src_->name();
170 char *dst = onelink->dst_->name();
171 simgrid::surf::LinkNS3 *link =
172 static_cast<simgrid::surf::LinkNS3 *>(onelink->link_);
174 if (strcmp(src,dst) && link->m_created){
175 XBT_DEBUG("Route from '%s' to '%s' with link '%s'", src, dst, link->getName());
176 char * link_bdw = bprintf("%fBps", link->getBandwidth());
177 char * link_lat = bprintf("%fs", link->getLatency());
180 // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
181 XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
184 ns3_nodes_t host_src = ns3_find_host(src);
186 host_src = static_cast<ns3_nodes_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
187 ns3_nodes_t host_dst = ns3_find_host(dst);
189 host_dst = static_cast<ns3_nodes_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
191 if (!host_src || !host_dst)
192 xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
194 ns3_add_link(host_src->node_num,host_src->type,host_dst->node_num,host_dst->type,link_bdw,link_lat);
202 static void parse_ns3_end_platform(void)
207 static void define_callbacks_ns3(void)
209 simgrid::s4u::Host::onCreation.connect(simgrid_ns3_add_host);
210 simgrid::surf::netcardCreatedCallbacks.connect(simgrid_ns3_add_router);
211 simgrid::surf::on_link.connect (parse_ns3_add_link);
212 simgrid::surf::on_cluster.connect (&parse_ns3_add_cluster);
213 simgrid::surf::asCreatedCallbacks.connect(parse_ns3_add_AS);
214 simgrid::surf::on_postparse.connect(&create_ns3_topology); //get_one_link_routes
215 simgrid::surf::on_postparse.connect(&parse_ns3_end_platform); //InitializeRoutes
221 static void free_ns3_link(void * elmts)
223 delete static_cast<simgrid::surf::LinkNS3*>(elmts);
226 static void free_ns3_host(void * elmts)
228 ns3_nodes_t host = static_cast<ns3_nodes_t>(elmts);
232 void surf_network_model_init_NS3()
234 if (surf_network_model)
237 surf_network_model = new simgrid::surf::NetworkNS3Model();
239 xbt_dynar_push(all_existing_models, &surf_network_model);
245 NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
246 if (ns3_initialize(xbt_cfg_get_string(_sg_cfg_set, "ns3/TcpModel"))) {
247 xbt_die("Impossible to initialize NS3 interface");
249 routing_model_create(NULL);
250 define_callbacks_ns3();
252 NS3_EXTENSION_ID = simgrid::s4u::Host::extension_create(free_ns3_host);
253 NS3_ASR_LEVEL = xbt_lib_add_level(as_router_lib, free_ns3_host);
256 NetworkNS3Model::~NetworkNS3Model() {
258 xbt_dynar_free_container(&IPV4addr);
259 xbt_dict_free(&dict_socket);
262 Link* NetworkNS3Model::createLink(const char *name, double bandwidth, double latency, e_surf_link_sharing_policy_t policy,
263 xbt_dict_t properties){
265 return new LinkNS3(this, name, properties, bandwidth, latency);
268 Action *NetworkNS3Model::communicate(NetCard *src, NetCard *dst, double size, double rate)
270 XBT_DEBUG("Communicate from %s to %s", src->name(), dst->name());
271 NetworkNS3Action *action = new NetworkNS3Action(this, size, 0);
273 ns3_create_flow(src->name(), dst->name(), surf_get_clock(), size, action);
275 action->m_lastSent = 0;
276 action->p_srcElm = src;
277 action->p_dstElm = dst;
278 networkCommunicateCallbacks(action, src, dst, size, rate);
280 return (surf_action_t) action;
283 double NetworkNS3Model::next_occuring_event(double now)
285 XBT_DEBUG("ns3_next_occuring_event");
287 //get the first relevant value from the running_actions list
288 if (!getRunningActionSet()->size() || now == 0.0)
293 time_to_next_flow_completion = ns3::Simulator::Now().GetSeconds() - surf_get_clock();//FIXME: use now instead ?
294 } while(double_equals(time_to_next_flow_completion, 0, sg_surf_precision));
296 XBT_DEBUG("min : %f", now);
297 XBT_DEBUG("ns3 time : %f", ns3::Simulator::Now().GetSeconds());
298 XBT_DEBUG("surf time : %f", surf_get_clock());
299 XBT_DEBUG("Next completion %f :", time_to_next_flow_completion);
301 return time_to_next_flow_completion;
304 void NetworkNS3Model::updateActionsState(double now, double delta)
306 xbt_dict_cursor_t cursor = NULL;
310 static xbt_dynar_t socket_to_destroy = NULL;
311 if(!socket_to_destroy) socket_to_destroy = xbt_dynar_new(sizeof(char*),NULL);
313 /* If there are no running flows, just return */
314 if (!getRunningActionSet()->size()) {
315 while(double_positive(now-ns3::Simulator::Now().GetSeconds(), sg_surf_precision)) {
316 ns3_simulator(now-ns3::Simulator::Now().GetSeconds());
321 NetworkNS3Action *action;
322 xbt_dict_foreach(dict_socket,cursor,key,data){
323 action = static_cast<NetworkNS3Action*>(ns3_get_socket_action(data));
324 XBT_DEBUG("Processing socket %p (action %p)",data,action);
325 action->setRemains(action->getCost() - ns3_get_socket_sent(data));
327 if (TRACE_is_enabled() &&
328 action->getState() == Action::State::running){
329 double data_sent = ns3_get_socket_sent(data);
330 double data_delta_sent = data_sent - action->m_lastSent;
332 std::vector<Link*> *route = new std::vector<Link*>();
334 routing_platf->getRouteAndLatency (action->p_srcElm, action->p_dstElm, route, NULL);
335 for (auto link : *route)
336 TRACE_surf_link_set_utilization (link->getName(), action->getCategory(), (data_delta_sent)/delta, now-delta, delta);
339 action->m_lastSent = data_sent;
342 if(ns3_get_socket_is_finished(data) == 1){
343 xbt_dynar_push(socket_to_destroy,&key);
344 XBT_DEBUG("Destroy socket %p of action %p", key, action);
346 action->setState(Action::State::done);
350 while (!xbt_dynar_is_empty(socket_to_destroy)){
351 xbt_dynar_pop(socket_to_destroy,&key);
353 void *data = xbt_dict_get (dict_socket, key);
354 action = static_cast<NetworkNS3Action*>(ns3_get_socket_action(data));
355 XBT_DEBUG ("Removing socket %p of action %p", key, action);
356 xbt_dict_remove(dict_socket, key);
365 LinkNS3::LinkNS3(NetworkNS3Model *model, const char *name, xbt_dict_t props, double bandwidth, double latency)
366 : Link(model, name, props)
369 m_bandwidth.peak = bandwidth;
370 m_latency.peak = latency;
372 Link::onCreation(this);
379 void LinkNS3::apply_event(tmgr_trace_iterator_t event, double value)
383 void LinkNS3::setBandwidthTrace(tmgr_trace_t trace) {
384 xbt_die("The NS3 network model doesn't support latency state traces");
386 void LinkNS3::setLatencyTrace(tmgr_trace_t trace) {
387 xbt_die("The NS3 network model doesn't support latency state traces");
394 NetworkNS3Action::NetworkNS3Action(Model *model, double cost, bool failed)
395 : NetworkAction(model, cost, failed)
398 void NetworkNS3Action::suspend()
403 void NetworkNS3Action::resume()
408 /* Test whether a flow is suspended */
409 bool NetworkNS3Action::isSuspended()
414 int NetworkNS3Action::unref()
418 if (action_hook.is_linked())
419 p_stateSet->erase(p_stateSet->iterator_to(*this));
420 XBT_DEBUG ("Removing action %p", this);