Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
added ns3 wifi doc
[simgrid.git] / src / surf / ns3 / ns3_simulator.hpp
1 /* Copyright (c) 2007-2020. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #ifndef NS3_SIMULATOR_HPP
7 #define NS3_SIMULATOR_HPP
8
9 #include "simgrid/s4u/Host.hpp"
10 #include "src/surf/network_ns3.hpp"
11
12 #include <ns3/node.h>
13 #include <ns3/tcp-socket-factory.h>
14 #include "ns3/wifi-module.h"
15
16 #include <cstdint>
17
18 class NetPointNs3 {
19 public:
20   static simgrid::xbt::Extension<simgrid::kernel::routing::NetPoint, NetPointNs3> EXTENSION_ID;
21
22   void set_name(std::string name) {name_ = name;}
23
24   explicit NetPointNs3();
25   std::string name_;
26   int node_num;
27   ns3::Ptr<ns3::Node> ns3_node_;
28
29 };
30
31 XBT_PUBLIC void ns3_initialize(std::string TcpProtocol);
32 XBT_PUBLIC void ns3_simulator(double max_seconds);
33 XBT_PUBLIC void ns3_add_direct_route(NetPointNs3* src, NetPointNs3* dst, double bw, double lat, std::string link_name,
34                                      simgrid::s4u::Link::SharingPolicy policy);
35 XBT_PUBLIC void ns3_add_cluster(const char* id, double bw, double lat);
36
37 class XBT_PRIVATE SgFlow {
38 public:
39   SgFlow(uint32_t total_bytes, simgrid::kernel::resource::NetworkNS3Action* action);
40
41   // private:
42   std::uint32_t buffered_bytes_ = 0;
43   std::uint32_t sent_bytes_     = 0;
44   std::uint32_t remaining_;
45   std::uint32_t total_bytes_;
46   bool finished_ = false;
47   simgrid::kernel::resource::NetworkNS3Action* action_;
48 };
49
50 void start_flow(ns3::Ptr<ns3::Socket> sock, const char* to, uint16_t port_number);
51
52 static inline std::string transform_socket_ptr(ns3::Ptr<ns3::Socket> local_socket)
53 {
54   std::stringstream sstream;
55   sstream << local_socket;
56   return sstream.str();
57 }
58
59 class XBT_PRIVATE WifiZone {
60 public:
61   WifiZone(std::string name_, simgrid::s4u::Host* host_, ns3::Ptr<ns3::Node> ap_node_,
62            ns3::Ptr<ns3::YansWifiChannel> channel_, int mcs_, int nss_, int network_, int link_);
63
64   const char* get_cname() {return name.c_str();}
65   simgrid::s4u::Host* get_host(){return host;}
66   ns3::Ptr<ns3::Node> get_ap_node() {return ap_node;}
67   ns3::Ptr<ns3::YansWifiChannel> get_channel() {return channel;}
68   int get_mcs() {return mcs;}
69   int get_nss() {return nss;}
70   int get_network() {return network;}
71   int get_link() {return link;}
72   int get_n_sta_nodes() {return n_sta_nodes;}
73
74   void set_network(int network_) {network = network_;}
75   void set_link(int link_) {link = link_;}
76   void add_sta_node() {n_sta_nodes++;}
77
78   static bool is_ap(ns3::Ptr<ns3::Node> node);
79   static WifiZone* by_name(std::string name);
80
81 private:
82   std::string name;
83   simgrid::s4u::Host* host;
84   ns3::Ptr<ns3::Node> ap_node;
85   ns3::Ptr<ns3::YansWifiChannel> channel;
86   int mcs;
87   int nss;
88   int network;
89   int link;
90   int n_sta_nodes = 0;
91   static std::unordered_map<std::string, WifiZone*> wifi_zones;
92 };
93
94 #endif