-/* Copyright (c) 2007-2015. The SimGrid Team.
- * All rights reserved. */
+/* Copyright (c) 2007-2017. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#include <unordered_set>
-#include <xbt/config.hpp>
+#include "xbt/config.hpp"
#include "ns3/core-module.h"
#include "ns3/node.h"
-#include "ns3/ns3_interface.h"
#include "ns3/ns3_simulator.h"
#include "network_ns3.hpp"
-#include "src/surf/HostImpl.hpp"
-#include "src/surf/surf_private.h"
-#include "simgrid/sg_config.h"
#include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
+#include "src/kernel/routing/NetPoint.hpp"
-#include "simgrid/s4u/As.hpp"
+#include "simgrid/s4u/Engine.hpp"
+#include "simgrid/s4u/NetZone.hpp"
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ns3, surf, "Logging specific to the SURF network NS3 module");
-int NS3_EXTENSION_ID;
-
-xbt_dynar_t IPV4addr = xbt_dynar_new(sizeof(char*),free);
+std::vector<char*> IPV4addr;
/*****************
* Crude globals *
static int number_of_networks = 1;
static int port_number = 1025; //Port number is limited from 1025 to 65 000
-/*************
- * Callbacks *
- *************/
+simgrid::xbt::Extension<simgrid::kernel::routing::NetPoint, NetPointNs3> NetPointNs3::EXTENSION_ID;
-static void ns3_add_host(simgrid::s4u::Host& host)
+NetPointNs3::NetPointNs3()
{
- const char* id = host.name().c_str();
- XBT_DEBUG("NS3_ADD_HOST '%s'", id);
-
- ns3_node_t ns3host = xbt_new0(s_ns3_node_t,1);
- ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
+ ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node>(0);
stack.Install(node);
nodes.Add(node);
- ns3host->node_num = number_of_nodes ++;
-
- host.extension_set(NS3_EXTENSION_ID, ns3host);
+ node_num = number_of_nodes++;
}
-static void ns3_add_netcard(simgrid::kernel::routing::NetCard* netcard)
-{
- const char* id = netcard->name();
-
- ns3_node_t ns3netcard = xbt_new0(s_ns3_node_t,1);
- XBT_DEBUG("Interface ns3 add netcard[%d] '%s'",number_of_nodes,id);
- ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
- stack.Install(node);
- nodes.Add(node);
- ns3netcard->node_num = number_of_nodes++;
-
- xbt_lib_set(as_router_lib, id, NS3_ASR_LEVEL, ns3netcard );
-}
+/*************
+ * Callbacks *
+ *************/
-#include "src/surf/xml/platf.hpp" // FIXME: move that back to the parsing area
-static void parse_ns3_add_cluster(sg_platf_cluster_cbarg_t cluster)
+static void clusterCreation_cb(sg_platf_cluster_cbarg_t cluster)
{
char* lat = bprintf("%fs", cluster->lat);
char* bw = bprintf("%fBps", cluster->bw);
for (int i : *cluster->radicals) {
- char* router_id = bprintf("ns3_%s%d%s", cluster->prefix, i, cluster->suffix);
- simgrid::s4u::Host::by_name_or_create(router_id)->extension_set(NS3_EXTENSION_ID, ns3_add_host_cluster(router_id));
- XBT_DEBUG("NS3_ADD_ROUTER '%s'", router_id);
+ // Routers don't create a router on the other end of the private link by themselves.
+ // We just need this router to be given an ID so we create a temporary NetPointNS3 so that it gets one
+ NetPointNs3* host_dst = new NetPointNs3();
// Create private link
char* host_id = bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
- XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
-
- ns3_node_t host_src = ns3_find_host(host_id);
- ns3_node_t host_dst = ns3_find_host(router_id);
+ NetPointNs3* host_src = sg_host_by_name(host_id)->pimpl_netpoint->extension<NetPointNs3>();
+ xbt_assert(host_src, "Cannot find a NS3 host of name %s", host_id);
- xbt_assert(host_src && host_dst, "\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
+ // Any NS3 route is symmetrical
+ ns3_add_link(host_src, host_dst, bw, lat);
- ns3_add_link(host_src->node_num, host_dst->node_num, bw,lat);
-
- free(router_id);
+ delete host_dst;
free(host_id);
}
xbt_free(lat);
//Create link backbone
lat = bprintf("%fs", cluster->bb_lat);
bw = bprintf("%fBps", cluster->bb_bw);
- ns3_add_cluster(bw,lat,cluster->id);
+ ns3_add_cluster(cluster->id, bw, lat);
xbt_free(lat);
-
xbt_free(bw);
}
-/* Create the ns3 topology based on routing strategy */
-static void create_ns3_topology(void)
+static void routeCreation_cb(bool symmetrical, simgrid::kernel::routing::NetPoint* src,
+ simgrid::kernel::routing::NetPoint* dst, simgrid::kernel::routing::NetPoint* gw_src,
+ simgrid::kernel::routing::NetPoint* gw_dst,
+ std::vector<simgrid::surf::LinkImpl*>* link_list)
{
- XBT_DEBUG("Starting topology generation");
+ if (link_list->size() == 1) {
+ simgrid::surf::LinkNS3* link = static_cast<simgrid::surf::LinkNS3*>(link_list->at(0));
- xbt_dynar_shrink(IPV4addr,0);
+ XBT_DEBUG("Route from '%s' to '%s' with link '%s' %s", src->cname(), dst->cname(), link->cname(),
+ (symmetrical ? "(symmetrical)" : "(not symmetrical)"));
+ char* link_bdw = bprintf("%fBps", link->bandwidth());
+ char* link_lat = bprintf("%fs", link->latency());
- //get the onelinks from the parsed platform
- xbt_dynar_t onelink_routes = routing_platf->getOneLinkRoutes();
+ // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
+ XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->cname(), link_bdw, link_lat);
- std::unordered_set<simgrid::surf::LinkNS3*> already_seen = std::unordered_set<simgrid::surf::LinkNS3*>();
+ // create link ns3
+ NetPointNs3* host_src = src->extension<NetPointNs3>();
+ NetPointNs3* host_dst = dst->extension<NetPointNs3>();
- XBT_DEBUG("There is %ld one-link routes",onelink_routes->used);
- simgrid::kernel::routing::Onelink *onelink;
- unsigned int iter;
- xbt_dynar_foreach(onelink_routes, iter, onelink) {
- char *src = onelink->src_->name();
- char *dst = onelink->dst_->name();
- simgrid::surf::LinkNS3 *link = static_cast<simgrid::surf::LinkNS3 *>(onelink->link_);
+ xbt_assert(host_src != nullptr, "Network element %s does not seem to be NS3-ready", src->cname());
+ xbt_assert(host_dst != nullptr, "Network element %s does not seem to be NS3-ready", dst->cname());
- if (strcmp(src,dst) && (already_seen.find(link) == already_seen.end())) {
- already_seen.insert(link);
- XBT_DEBUG("Route from '%s' to '%s' with link '%s'", src, dst, link->getName());
- char * link_bdw = bprintf("%fBps", link->getBandwidth());
- char * link_lat = bprintf("%fs", link->getLatency());
+ // Any NS3 route is symmetrical
+ ns3_add_link(host_src, host_dst, link_bdw, link_lat);
- // XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
- XBT_DEBUG("\tLink (%s) bdw:%s lat:%s", link->getName(), link_bdw, link_lat);
-
- //create link ns3
- ns3_node_t host_src = ns3_find_host(src);
- if (!host_src)
- host_src = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL));
- ns3_node_t host_dst = ns3_find_host(dst);
- if(!host_dst)
- host_dst = static_cast<ns3_node_t>(xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL));
-
- if (!host_src || !host_dst)
- xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
-
- ns3_add_link(host_src->node_num, host_dst->node_num, link_bdw, link_lat);
-
- xbt_free(link_bdw);
- xbt_free(link_lat);
- }
+ xbt_free(link_bdw);
+ xbt_free(link_lat);
+ } else {
+ static bool warned_about_long_routes = false;
+
+ if (not warned_about_long_routes)
+ XBT_WARN("Ignoring a route between %s and %s of length %zu: Only routes of length 1 are considered with NS3.\n"
+ "WARNING: You can ignore this warning if your hosts can still communicate when only considering routes "
+ "of length 1.\n"
+ "WARNING: Remove long routes to avoid this harmless message; subsequent long routes will be silently "
+ "ignored.",
+ src->cname(), dst->cname(), link_list->size());
+ warned_about_long_routes = true;
}
+}
+
+/* Create the ns3 topology based on routing strategy */
+static void postparse_cb()
+{
+ IPV4addr.shrink_to_fit();
ns3::GlobalRouteManager::BuildGlobalRoutingDatabase();
ns3::GlobalRouteManager::InitializeRoutes();
namespace surf {
NetworkNS3Model::NetworkNS3Model() : NetworkModel() {
- ns3_initialize(ns3_tcp_model.get().c_str());
+ NetPointNs3::EXTENSION_ID = simgrid::kernel::routing::NetPoint::extension_create<NetPointNs3>();
- routing_model_create(nullptr);
- simgrid::s4u::Host::onCreation.connect(ns3_add_host);
- simgrid::kernel::routing::netcardCreatedCallbacks.connect(ns3_add_netcard);
- simgrid::surf::on_cluster.connect (&parse_ns3_add_cluster);
- simgrid::surf::on_postparse.connect(&create_ns3_topology);
+ ns3_initialize(ns3_tcp_model.get().c_str());
- NS3_EXTENSION_ID = simgrid::s4u::Host::extension_create(xbt_free_f);
- NS3_ASR_LEVEL = xbt_lib_add_level(as_router_lib, xbt_free_f);
+ simgrid::kernel::routing::NetPoint::onCreation.connect([](simgrid::kernel::routing::NetPoint* pt) {
+ pt->extension_set<NetPointNs3>(new NetPointNs3());
+ XBT_VERB("SimGrid's %s is known as node %d within NS3", pt->cname(), pt->extension<NetPointNs3>()->node_num);
+ });
+ simgrid::surf::on_cluster.connect(&clusterCreation_cb);
+ simgrid::s4u::onPlatformCreated.connect(&postparse_cb);
+ simgrid::s4u::NetZone::onRouteCreation.connect(&routeCreation_cb);
LogComponentEnable("UdpEchoClientApplication", ns3::LOG_LEVEL_INFO);
LogComponentEnable("UdpEchoServerApplication", ns3::LOG_LEVEL_INFO);
}
NetworkNS3Model::~NetworkNS3Model() {
- xbt_dynar_free_container(&IPV4addr);
+ for (auto addr : IPV4addr)
+ free(addr);
+ IPV4addr.clear();
xbt_dict_free(&flowFromSock);
}
-Link* NetworkNS3Model::createLink(const char *name, double bandwidth, double latency, e_surf_link_sharing_policy_t policy,
- xbt_dict_t properties){
-
- return new LinkNS3(this, name, properties, bandwidth, latency);
+LinkImpl* NetworkNS3Model::createLink(const char* name, double bandwidth, double latency,
+ e_surf_link_sharing_policy_t policy)
+{
+ return new LinkNS3(this, name, bandwidth, latency);
}
Action* NetworkNS3Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
XBT_DEBUG("ns3_next_occuring_event");
//get the first relevant value from the running_actions list
- if (!getRunningActionSet()->size() || now == 0.0)
+ if (not getRunningActionSet()->size() || now == 0.0)
return -1.0;
else
do {
action->getState() == Action::State::running){
double data_delta_sent = sgFlow->sentBytes_ - action->lastSent_;
- std::vector<Link*> route = std::vector<Link*>();
+ std::vector<LinkImpl*> route = std::vector<LinkImpl*>();
- routing_platf->getRouteAndLatency(action->src_->pimpl_netcard, action->dst_->pimpl_netcard, &route, nullptr);
+ action->src_->routeTo(action->dst_, &route, nullptr);
for (auto link : route)
- TRACE_surf_link_set_utilization (link->getName(), action->getCategory(), (data_delta_sent)/delta, now-delta, delta);
+ TRACE_surf_link_set_utilization(link->cname(), action->getCategory(), (data_delta_sent) / delta, now - delta,
+ delta);
action->lastSent_ = sgFlow->sentBytes_;
}
}
}
- while (!xbt_dynar_is_empty(socket_to_destroy)){
+ while (not xbt_dynar_is_empty(socket_to_destroy)) {
xbt_dynar_pop(socket_to_destroy,&ns3Socket);
if (XBT_LOG_ISENABLED(ns3, xbt_log_priority_debug)) {
* Resource *
************/
-LinkNS3::LinkNS3(NetworkNS3Model *model, const char *name, xbt_dict_t props, double bandwidth, double latency)
- : Link(model, name, props)
+LinkNS3::LinkNS3(NetworkNS3Model* model, const char* name, double bandwidth, double latency)
+ : LinkImpl(model, name, nullptr)
{
- m_bandwidth.peak = bandwidth;
- m_latency.peak = latency;
+ bandwidth_.peak = bandwidth;
+ latency_.peak = latency;
- Link::onCreation(this);
+ s4u::Link::onCreation(this->piface_);
}
-LinkNS3::~LinkNS3()
-{
-}
+LinkNS3::~LinkNS3() = default;
-void LinkNS3::apply_event(tmgr_trace_iterator_t event, double value)
+void LinkNS3::apply_event(tmgr_trace_event_t event, double value)
{
THROW_UNIMPLEMENTED;
}
NetworkNS3Action::NetworkNS3Action(Model* model, double size, s4u::Host* src, s4u::Host* dst)
: NetworkAction(model, size, false)
{
- XBT_DEBUG("Communicate from %s to %s", src->name().c_str(), dst->name().c_str());
+ XBT_DEBUG("Communicate from %s to %s", src->cname(), dst->cname());
src_ = src;
dst_ = dst;
- ns3_create_flow(src->name().c_str(), dst->name().c_str(), surf_get_clock(), size, this);
+ ns3_create_flow(src, dst, surf_get_clock(), size, this);
- Link::onCommunicate(this, src, dst);
+ s4u::Link::onCommunicate(this, src, dst);
}
void NetworkNS3Action::suspend() {
THROW_UNIMPLEMENTED;
}
- /* Test whether a flow is suspended */
+std::list<LinkImpl*> NetworkNS3Action::links()
+{
+ THROW_UNIMPLEMENTED;
+}
+
+/* Test whether a flow is suspended */
bool NetworkNS3Action::isSuspended()
{
return false;
int NetworkNS3Action::unref()
{
refcount_--;
- if (!refcount_) {
+ if (not refcount_) {
if (action_hook.is_linked())
stateSet_->erase(stateSet_->iterator_to(*this));
XBT_DEBUG ("Removing action %p", this);
}
}
-
-void ns3_simulator(double maxSeconds){
+void ns3_simulator(double maxSeconds)
+{
if (maxSeconds > 0.0) // If there is a maximum amount of time to run
ns3::Simulator::Stop(ns3::Seconds(maxSeconds));
- XBT_DEBUG("Start simulator for at most %fs",maxSeconds);
+ XBT_DEBUG("Start simulator for at most %fs (current time: %f)", maxSeconds, surf_get_clock());
ns3::Simulator::Run ();
}
-void ns3_create_flow(const char* a,const char *b,double startTime,u_int32_t TotalBytes,simgrid::surf::NetworkNS3Action * action)
+void ns3_create_flow(simgrid::s4u::Host* src, simgrid::s4u::Host* dst, double startTime, u_int32_t TotalBytes,
+ simgrid::surf::NetworkNS3Action* action)
{
- int node1 = ns3_find_host(a)->node_num;
- int node2 = ns3_find_host(b)->node_num;
+ unsigned int node1 = src->pimpl_netpoint->extension<NetPointNs3>()->node_num;
+ unsigned int node2 = dst->pimpl_netpoint->extension<NetPointNs3>()->node_num;
ns3::Ptr<ns3::Node> src_node = nodes.Get(node1);
ns3::Ptr<ns3::Node> dst_node = nodes.Get(node2);
- char* addr = (char*)xbt_dynar_get_as(IPV4addr,node2,char*);
+ xbt_assert(node2 < IPV4addr.size(), "Element %s is unknown to NS3. Is it connected to any one-hop link?",
+ dst->pimpl_netpoint->cname());
+ char* addr = IPV4addr.at(node2);
+ xbt_assert(addr != nullptr, "Element %s is unknown to NS3. Is it connected to any one-hop link?",
+ dst->pimpl_netpoint->cname());
XBT_DEBUG("ns3_create_flow %d Bytes from %d to %d with Interface %s",TotalBytes, node1, node2,addr);
ns3::PacketSinkHelper sink("ns3::TcpSocketFactory", ns3::InetSocketAddress (ns3::Ipv4Address::GetAny(), port_number));
ns3::Config::SetDefault ("ns3::TcpSocket::SegmentSize", ns3::UintegerValue (1024)); // 1024-byte packet for easier reading
ns3::Config::SetDefault ("ns3::TcpSocket::DelAckCount", ns3::UintegerValue (1));
- if (!strcmp(TcpProtocol,"default"))
+ if (not strcmp(TcpProtocol, "default"))
return;
- if (!strcmp(TcpProtocol,"Reno")) {
+ if (not strcmp(TcpProtocol, "Reno")) {
XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpReno"));
return;
}
- if (!strcmp(TcpProtocol,"NewReno")) {
+ if (not strcmp(TcpProtocol, "NewReno")) {
XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpNewReno"));
return;
}
- if(!strcmp(TcpProtocol,"Tahoe")){
+ if (not strcmp(TcpProtocol, "Tahoe")) {
XBT_INFO("Switching Tcp protocol to '%s'",TcpProtocol);
ns3::Config::SetDefault ("ns3::TcpL4Protocol::SocketType", ns3::StringValue("ns3::TcpTahoe"));
return;
xbt_die("The ns3/TcpModel must be : NewReno or Reno or Tahoe");
}
-void * ns3_add_host_cluster(const char * id)
-{
- ns3_node_t host = xbt_new0(s_ns3_node_t,1);
- XBT_DEBUG("Interface ns3 add host[%d] '%s'",number_of_nodes,id);
- ns3::Ptr<ns3::Node> node = ns3::CreateObject<ns3::Node> (0);
- stack.Install(node);
- Cluster_nodes.Add(node);
- nodes.Add(node);
- host->node_num = number_of_nodes;
- number_of_nodes++;
- return host;
-}
-
-void ns3_add_cluster(char * bw,char * lat,const char *id)
+void ns3_add_cluster(const char* id, char* bw, char* lat)
{
- XBT_DEBUG("cluster_id: %s",id);
- XBT_DEBUG("bw: %s lat: %s",bw,lat);
- XBT_DEBUG("Number of %s nodes: %d",id,Cluster_nodes.GetN() - number_of_clusters_nodes);
-
ns3::NodeContainer Nodes;
- for(unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN() ; i++){
+ for (unsigned int i = number_of_clusters_nodes; i < Cluster_nodes.GetN(); i++) {
Nodes.Add(Cluster_nodes.Get(i));
XBT_DEBUG("Add node %d to cluster",i);
}
return bprintf("%s",s.c_str());
}
-void ns3_add_link(int src, int dst, char *bw, char *lat)
+void ns3_add_link(NetPointNs3* src, NetPointNs3* dst, char* bw, char* lat)
{
ns3::PointToPointHelper pointToPoint;
- ns3::NetDeviceContainer netA;
ns3::Ipv4AddressHelper address;
- ns3::Ptr<ns3::Node> a = nodes.Get(src);
- ns3::Ptr<ns3::Node> b = nodes.Get(dst);
+ int srcNum = src->node_num;
+ int dstNum = dst->node_num;
+
+ ns3::Ptr<ns3::Node> a = nodes.Get(srcNum);
+ ns3::Ptr<ns3::Node> b = nodes.Get(dstNum);
- XBT_DEBUG("\tAdd PTP from %d to %d bw:'%s' lat:'%s'",src,dst,bw,lat);
+ XBT_DEBUG("\tAdd PTP from %d to %d bw:'%s' lat:'%s'", srcNum, dstNum, bw, lat);
pointToPoint.SetDeviceAttribute ("DataRate", ns3::StringValue (bw));
pointToPoint.SetChannelAttribute ("Delay", ns3::StringValue (lat));
+ ns3::NetDeviceContainer netA;
netA.Add(pointToPoint.Install (a, b));
char * adr = bprintf("%d.%d.0.0",number_of_networks,number_of_links);
free(adr);
interfaces.Add(address.Assign (netA));
- char *tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-2));
- xbt_dynar_set_as(IPV4addr,src,char*,tmp);
- XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,src,char*),src);
+ if (IPV4addr.size() <= (unsigned)srcNum)
+ IPV4addr.resize(srcNum + 1, nullptr);
+ IPV4addr.at(srcNum) = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 2));
- tmp = transformIpv4Address(interfaces.GetAddress(interfaces.GetN()-1));
- xbt_dynar_set_as(IPV4addr,dst,char*,tmp);
- XBT_DEBUG("Have write '%s' for Node '%d'",(char*)xbt_dynar_get_as(IPV4addr,dst,char*),dst);
+ if (IPV4addr.size() <= (unsigned)dstNum)
+ IPV4addr.resize(dstNum + 1, nullptr);
+ IPV4addr.at(dstNum) = transformIpv4Address(interfaces.GetAddress(interfaces.GetN() - 1));
if (number_of_links == 255){
xbt_assert(number_of_networks < 255, "Number of links and networks exceed 255*255");