Some refactoring (#557)

closes #521 
closes #502

Author: PaulRalnikov

CMakeLists.txt

@@ -54,7 +54,7 @@ if(BUILD_TESTS)
     target_include_directories(${TEST_NAME} PUBLIC "source")
     target_compile_definitions(${TEST_NAME} PRIVATE PROJECT_ROOT_DIR="${CMAKE_SOURCE_DIR}")
 
-    target_compile_options(${TEST_NAME} PRIVATE -Wall -Wextra)
+    target_compile_options(${TEST_NAME} PRIVATE -Wall -Werror -Wextra)
     target_link_libraries(${TEST_NAME} gtest gmock gtest_main yaml-cpp matplot)
 
     if (DEFINED LOG_LEVEL)

README.md

@@ -3,6 +3,20 @@
 ## Overview
 Not Overcomplicated Network Simulator (NoNS) is a free open source project aiming to build a discrete-event network simulator targeted at easy testing of congestion control algorithms.
 
+## Dependencies
+
+NoNS need gnuplot & graphiz to generate plots, so install it:
+```
+sudo apt install --fix-missing gnuplot
+sudo apt install --fix-missing graphviz
+```
+
+Other dependecies are designed as git submodules, so to install them, run
+```
+git submodule init
+git submodule update --init --recursive
+```
+
 ## Build project
 NoNS uses CMake build manager, so project builds in this way:
 
@@ -11,26 +25,12 @@ cmake -B build -DCMAKE_BUILD_TYPE=Release
 cmake --build build
 ```
 
-## Run project
-
-```
-./build/nons
-    --config path
-    [--output-dir output-dir-name]
-    [--no-logs]
-```
 
-Options:
+## Run project
 
-```
--c, --config arg          Path to the scenario configuration file
-    --output-dir arg      Output directory for metrics and plots
-                        (default: metrics)
-    --no-logs             Output without logs
--h, --help                Print usage
-```
+Build project and run it with `-h` option to see help.
 
-Examples of configs are placed under [`configs`](configs/) directory. See config schemas [here](_schemas/configs/).
+Examples of configs that need to run NoNS are placed under [`configs`](configs/) directory. See config schemas [here](_schemas/configs/).
 
 ## How to add a new congestion control algorithm
 

source/main.cpp

@@ -2,14 +2,17 @@
 
 #include "logger/logger.hpp"
 #include "parser/scenario/scenario_parser.hpp"
+#include "utils/filesystem.hpp"
 #include "utils/statistics.hpp"
 
 int main(const int argc, char** argv) {
     cxxopts::Options options("NoNS", "Discrete-event based simulator");
     options.add_options()("c,config", "Path to the scenario configuration file",
                           cxxopts::value<std::string>())(
-        "output-dir", "Output directory for metrics and plots",
+        "output-dir", "Output directory for metrics, logs and plots",
         cxxopts::value<std::string>()->default_value("metrics"))(
+        "w,wipe-output-dir", "Wipe output directory before run",
+        cxxopts::value<bool>()->default_value("false"))(
         "no-logs", "Output without logs",
         cxxopts::value<bool>()->default_value("false"))("h,help",
                                                         "Print usage");
@@ -29,6 +32,10 @@ int main(const int argc, char** argv) {
 
     std::filesystem::path config_path = flags["config"].as<std::string>();
 
+    if (flags["wipe-output-dir"].as<bool>()) {
+        utils::wipe_folder(output_dir);
+    }
+
     std::filesystem::path actions_summary_path(output_dir /
                                                "actions_summary.csv");
 
@@ -38,5 +45,7 @@ int main(const int argc, char** argv) {
     sim::write_to_csv(actions_summary_path, summary.send_data);
     scenario.get_network().save_metrics(output_dir / "network");
 
+    std::cout << "Metrics are written to " << output_dir << "\n\n";
+
     return 0;
 }

source/network/connection/flow/packet_ack_info.hpp

@@ -1,12 +1,14 @@
 #pragma once
+#include "packet.hpp"
 #include "types.hpp"
+#include "utils/statistics.hpp"
 
 namespace sim {
 
 struct PacketAckInfo {
     TimeNs rtt;
-    TimeNs avg_rtt;
-    bool ecn_flag;
+    const utils::Statistics<TimeNs>& rtt_stat;
+    const Packet& ack;
 };
 
 }  // namespace sim

source/network/connection/flow/tcp/tcp_flow.cpp

@@ -187,8 +187,7 @@ void TcpFlow::process_ack(const Packet& ack, SizeByte data_packet_size,
     m_metrics.delivery_rate->add_record(now, delivery_rate.value());
     m_context.delivery_rate_statistics.add_record(delivery_rate);
 
-    callback({PacketAckInfo{rtt, m_context.rtt_statistics.get_mean().value(),
-                            ack.congestion_experienced}});
+    callback({PacketAckInfo{rtt, m_context.rtt_statistics, ack}});
 }
 
 // After ACK with a valid RTT: formula + transition to STEADY (once)

source/network/connection/flow/tcp/tcp_flow.hpp

@@ -16,7 +16,7 @@ struct TcpFlowMetricsFilters {
 class TcpFlow : public IFlow, public std::enable_shared_from_this<TcpFlow> {
 public:
     constexpr static inline RTO DEFAULT_START_RTO =
-        RTO(TimeNs(2000), Time<Second>(1));
+        RTO(Time<Millisecond>(200), Time<Second>(1));
 
     constexpr static inline bool DEFAULT_ECN_CAPABLE = true;
     constexpr static inline TcpFlowMetricsFilters DEFAULT_METRICS_FLAGS = {};

source/network/connection/mplb/cc/basic/basic_cc.cpp

@@ -4,9 +4,7 @@
 
 namespace sim {
 
-void BasicCC::on_ack([[maybe_unused]] TimeNs rtt,
-                     [[maybe_unused]] TimeNs avg_rtt,
-                     [[maybe_unused]] bool ecn_flag) {}
+void BasicCC::on_ack([[maybe_unused]] const PacketAckInfo& info) {}
 
 void BasicCC::on_timeout() {}
 

source/network/connection/mplb/cc/basic/basic_cc.hpp

@@ -5,7 +5,7 @@
 namespace sim {
 class BasicCC : public ITcpCC {
 public:
-    void on_ack(TimeNs rtt, TimeNs avg_rtt, bool ecn_flag) final;
+    void on_ack(const PacketAckInfo& info) final;
     void on_timeout() final;
     TimeNs get_pacing_delay() const final;
     double get_cwnd() const final;

source/network/connection/mplb/cc/i_tcp_cc.hpp

@@ -9,11 +9,7 @@ class ITcpCC {
 public:
     // Callback that triggers every time ACK receives on sender
     // returns true if congestion detected; false otherwice
-    virtual void on_ack(TimeNs rtt, TimeNs avg_rtt, bool ecn_flag) = 0;
-
-    virtual void on_ack(PacketAckInfo info) {
-        on_ack(info.rtt, info.avg_rtt, info.ecn_flag);
-    }
+    virtual void on_ack(const PacketAckInfo& info) = 0;
 
     // Callback that triggers when ACK not delivered on timeout
     virtual void on_timeout() = 0;

source/network/connection/mplb/cc/metricable_cc.cpp

@@ -9,8 +9,8 @@ MetricableCC::MetricableCC(std::unique_ptr<ITcpCC> a_cc,
                            MetricableCCMetricsFilters a_flags)
     : m_cc(std::move(a_cc)), m_metrics_filters(std::move(a_flags)) {}
 
-void MetricableCC::on_ack(TimeNs rtt, TimeNs avg_rtt, bool ecn_flag) {
-    m_cc->on_ack(rtt, avg_rtt, ecn_flag);
+void MetricableCC::on_ack(const PacketAckInfo& info) {
+    m_cc->on_ack(info);
     record_cwnd();
 }