1 /* Copyright (c) 2007-2023. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #include "src/surf/ns3/ns3_simulator.hpp"
8 #include "xbt/sysdep.h"
10 #include <ns3/ipv4-address-helper.h>
11 #include <ns3/point-to-point-helper.h>
12 #include <ns3/application-container.h>
14 #include <ns3/callback.h>
15 #include <ns3/packet-sink.h>
19 std::map<std::string, SgFlow*, std::less<>> flow_from_sock; // ns3::sock -> SgFlow
20 std::map<std::string, ns3::ApplicationContainer, std::less<>> sink_from_sock; // ns3::sock -> ns3::PacketSink
22 static void receive_callback(ns3::Ptr<ns3::Socket> socket);
23 static void datasent_cb(ns3::Ptr<ns3::Socket> socket, uint32_t dataSent);
25 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(res_ns3);
27 SgFlow::SgFlow(uint32_t totalBytes, simgrid::kernel::resource::NetworkNS3Action* action)
28 : total_bytes_(totalBytes), remaining_(totalBytes), action_(action)
32 static SgFlow* getFlowFromSocket(ns3::Ptr<ns3::Socket> socket)
34 auto it = flow_from_sock.find(transform_socket_ptr(socket));
35 return (it == flow_from_sock.end()) ? nullptr : it->second;
38 static ns3::ApplicationContainer* getSinkFromSocket(ns3::Ptr<ns3::Socket> socket)
40 auto it = sink_from_sock.find(transform_socket_ptr(socket));
41 return (it == sink_from_sock.end()) ? nullptr : &(it->second);
44 static void receive_callback(ns3::Ptr<ns3::Socket> socket)
46 SgFlow* flow = getFlowFromSocket(socket);
47 XBT_DEBUG("received on F[%p, total: %u, remain: %u]", flow, flow->total_bytes_, flow->remaining_);
49 if (not flow->finished_) {
50 flow->finished_ = true;
51 XBT_DEBUG("recv_cb of F[%p, %p, %u]", flow, flow->action_, flow->total_bytes_);
52 XBT_DEBUG("Stop simulator at %f seconds", ns3::Simulator::Now().GetSeconds());
53 ns3::Simulator::Stop();
57 static void send_cb(ns3::Ptr<ns3::Socket> sock, uint32_t /*txSpace*/)
59 SgFlow* flow = getFlowFromSocket(sock);
60 const ns3::ApplicationContainer* sink = getSinkFromSocket(sock);
61 XBT_DEBUG("Asked to write on F[%p, total: %u, remain: %u]", flow, flow->total_bytes_, flow->remaining_);
63 if (flow->remaining_ == 0) // all data was already buffered (and socket was already closed)
66 /* While not all is buffered and there remain space in the buffers */
67 while (flow->buffered_bytes_ < flow->total_bytes_ && sock->GetTxAvailable() > 0) {
68 // Send at most 1040 bytes (data size in a TCP packet), as ns-3 seems to not split correctly by itself
69 uint32_t toWrite = std::min({flow->remaining_, sock->GetTxAvailable(), std::uint32_t(1040)});
71 if (toWrite == 0) { // buffer full
72 XBT_DEBUG("%f: buffer full on flow %p (still %u to go)", ns3::Simulator::Now().GetSeconds(), flow,
76 int amountSent = sock->Send(nullptr, toWrite, 0);
78 xbt_assert(amountSent > 0, "Since TxAvailable>0, amountSent should also >0");
79 flow->buffered_bytes_ += amountSent;
80 flow->remaining_ -= amountSent;
82 XBT_DEBUG("%f: sent %d bytes over flow %p (still %u to go)", ns3::Simulator::Now().GetSeconds(), amountSent, flow,
86 if (flow->buffered_bytes_ >= flow->total_bytes_){
87 XBT_DEBUG("Closing Sockets of flow %p", flow);
88 // Closing the sockets of the receiving application
89 ns3::Ptr<ns3::PacketSink> app = ns3::DynamicCast<ns3::PacketSink, ns3::Application>(sink->Get(0));
90 ns3::Ptr<ns3::Socket> listening_sock = app->GetListeningSocket();
91 listening_sock->Close();
92 listening_sock->SetRecvCallback(ns3::MakeNullCallback<void, ns3::Ptr<ns3::Socket>>());
93 for(ns3::Ptr<ns3::Socket> accepted_sock : app->GetAcceptedSockets())
94 accepted_sock->Close();
95 // Closing the socket of the sender
100 static void datasent_cb(ns3::Ptr<ns3::Socket> socket, uint32_t dataSent)
102 /* The tracing wants to know */
103 SgFlow* flow = getFlowFromSocket(socket);
104 flow->sent_bytes_ += dataSent;
105 XBT_DEBUG("datasent_cb of F[%p, %p, %u] %u sent (%u total)", flow, flow->action_, flow->total_bytes_, dataSent,
109 static void normalClose_callback(ns3::Ptr<ns3::Socket> socket)
111 SgFlow* flow = getFlowFromSocket(socket);
112 XBT_DEBUG("normalClose_cb of F[%p, %p] total: %u; sent: %u", flow, flow->action_, flow->total_bytes_,
114 xbt_assert(flow->total_bytes_ == flow->sent_bytes_, "total_bytes (=%u) is not sent_bytes(=%u)", flow->total_bytes_,
116 xbt_assert(flow->remaining_ == 0, "Remaining is not 0 but %u", flow->remaining_);
117 receive_callback(socket);
120 XBT_ATTRIB_NORETURN static void errorClose_callback(ns3::Ptr<ns3::Socket> socket)
122 SgFlow* flow = getFlowFromSocket(socket);
123 XBT_DEBUG("errorClose_cb of F[%p, %p, %u]", flow, flow->action_, flow->total_bytes_);
124 xbt_die("ns-3: a socket was closed anormally");
127 static void succeededConnect_callback(ns3::Ptr<ns3::Socket> socket)
129 SgFlow* flow = getFlowFromSocket(socket);
130 XBT_DEBUG("succeededConnect_cb of F[%p, %p, %u]", flow, flow->action_, flow->total_bytes_);
133 XBT_ATTRIB_NORETURN static void failedConnect_callback(ns3::Ptr<ns3::Socket> socket)
135 SgFlow* mysocket = getFlowFromSocket(socket);
136 XBT_DEBUG("failedConnect_cb of F[%p, %p, %u]", mysocket, mysocket->action_, mysocket->total_bytes_);
137 xbt_die("ns-3: a socket failed to connect");
140 void start_flow(ns3::Ptr<ns3::Socket> sock, const char* to, uint16_t port_number)
142 SgFlow* flow = getFlowFromSocket(sock);
143 ns3::InetSocketAddress serverAddr(to, port_number);
145 sock->Connect(serverAddr);
146 // tell the tcp implementation to call send_cb again
147 // if we blocked and new tx buffer space becomes available
148 sock->SetSendCallback(MakeCallback(&send_cb));
149 // Notice when we actually sent some data (mostly for the TRACING module)
150 sock->SetDataSentCallback(MakeCallback(&datasent_cb));
152 XBT_DEBUG("startFlow of F[%p, %p, %u] dest=%s port=%d", flow, flow->action_, flow->total_bytes_, to, port_number);
154 sock->SetConnectCallback(MakeCallback(&succeededConnect_callback), MakeCallback(&failedConnect_callback));
155 sock->SetCloseCallbacks(MakeCallback(&normalClose_callback), MakeCallback(&errorClose_callback));