fixed some style issues, added tooling for docs

docs/core/error.md

@@ -0,0 +1,9 @@
+# core/error.h
+
+## Free functions
+
+### `std::mutex &error_mutex() noexcept;`
+### `inline T&& show(std::string_view name, T&& value) noexcept { ... }`
+### `std::lock_guard<std::mutex> lock(error_mutex());`
+### `inline T&& eval_and_show(std::string_view expr, T&& value) noexcept { ... }`
+### `std::lock_guard<std::mutex> lock(error_mutex());`

docs/core/host.md

@@ -0,0 +1,10 @@
+# core/host.h
+
+## class NetworkNic — public interface
+
+### `Host(Simulator *const sim, NodeId id) noexcept;`
+### `virtual ~Host() = default;`
+### `NetworkNic *nic() const noexcept { ... }`
+### `void attach_nic(NetworkNic* nic) noexcept;`
+### `void detach_nic(NetworkNic* nic) noexcept;`
+### `Host(const Host &) = delete;`

docs/core/logger.md

@@ -0,0 +1,13 @@
+# core/logger.h
+
+## class Logger — public interface
+
+### `Logger(std::string_view path, bool append) noexcept;`
+### `~Logger() noexcept;`
+### `Logger(const Logger &) = delete;`
+### `Logger(Logger &&) = delete;`
+### `bool is_open() const noexcept { ... }`
+### `void write_line(std::string_view line) noexcept;`
+### `void flush() noexcept;`
+### `void close() noexcept;`
+### `std::string_view path() const noexcept { ... }`

docs/core/node.md

@@ -0,0 +1,13 @@
+# core/node.h
+
+## class Node — public interface
+
+### `Node(Simulator *const sim, NodeId id, NodeType type) noexcept;`
+### `virtual ~Node() = default;`
+### `NodeId id() const noexcept;`
+### `NodeStatus status() const noexcept;`
+### `NodeType type() const noexcept;`
+### `void set_status(NodeStatus s) noexcept;`
+### `void boot(Time boottime_ns);`
+### `void reboot(Time boottime_ns);`
+### `Node(const Node &) = delete;`

docs/core/rng.md

@@ -0,0 +1,16 @@
+# core/rng.h
+
+## class Rng — public interface
+
+### `: _eng(seed) { ... }`
+### `void seed(seed_type s) noexcept { ... }`
+### `_eng.seed(s);`
+### `double uniform01() { ... }`
+### `Int uniform_range(Int lo_inclusive, Int hi_exclusive) { ... }`
+### `Int uniform_range(Int hi_exclusive) { ... }`
+### `double uniform_range(double lo_inclusive, double hi_exclusive) { ... }`
+### `std::uint64_t poisson(double lambda) { ... }`
+### `T choose_weighted(const std::vector<std::pair<double, T>>& items) { ... }`
+### `return choose_weighted_impl(items.begin(), items.end());`
+### `T choose_weighted(std::initializer_list<std::pair<double, T>> items) { ... }`
+### `return choose_weighted_impl(items.begin(), items.end());`

docs/core/simulator.md

@@ -0,0 +1,27 @@
+# core/simulator.h
+
+## Free functions
+
+### `std::numeric_limits<InstanceId>::max();`
+### `std::numeric_limits<LinkId>::max();`
+
+## class Rng — public interface
+
+### `Simulator() = default;`
+### `static std::pair<InstanceId, Simulator *> create_simulator(InstanceId id);`
+### `static Simulator *get_simulator(InstanceId id) noexcept;`
+### `Time now() const noexcept;`
+### `EventId schedule_at(Time abs_time, F&& f, Args&&... args) { ... }`
+### `_event_pq.push(std::move(it));`
+### `EventId schedule_after(Time delay, F&& f, Args&&... args) { ... }`
+### `bool cancel(EventId id);`
+### `bool run_next();`
+### `void run_until(Time end_time);`
+### `void lock() noexcept;`
+### `bool is_locked() const noexcept { ... }`
+### `void flush_after(Time grace) noexcept;`
+### `Rng* create_rng(std::uint64_t seed);`
+### `Rng* get_rng() noexcept;`
+### `Rng const* get_rng() const noexcept;`
+### `Link* get_link(LinkId id) noexcept;`
+### `Link const* get_link(LinkId id) const noexcept;`

docs/core/time.md

@@ -0,0 +1,36 @@
+# core/time.h
+
+## Free functions
+
+### `constexpr Time operator""_ns(unsigned long long v) noexcept { ... }`
+### `return Time::from_ns(static_cast<Time::rep>(v));`
+### `constexpr Time operator""_us(unsigned long long v) noexcept { ... }`
+### `return Time::from_us(static_cast<Time::rep>(v));`
+### `constexpr Time operator""_ms(unsigned long long v) noexcept { ... }`
+### `return Time::from_ms(static_cast<Time::rep>(v));`
+### `constexpr Time operator""_s (unsigned long long v) noexcept { ... }`
+### `return Time::from_s (static_cast<Time::rep>(v));`
+
+## class Time — public interface
+
+### `constexpr Time() : _nsec(0) { ... }`
+### `explicit constexpr Time(rep ns) : _nsec(ns) { ... }`
+### `static constexpr Time from_ns(rep ns) noexcept { ... }`
+### `return Time(ns);`
+### `static constexpr Time from_us(rep us) noexcept { ... }`
+### `return Time(us * 1000ULL);`
+### `static constexpr Time from_ms(rep ms) noexcept { ... }`
+### `return Time(ms * 1000ULL * 1000ULL);`
+### `static constexpr Time from_s (rep s ) noexcept { ... }`
+### `return Time(s * 1000ULL * 1000ULL * 1000ULL);`
+### `constexpr rep ns() const noexcept { ... }`
+### `constexpr rep count() const noexcept { ... }`
+### `static constexpr rep us_to_ns(rep us) noexcept { ... }`
+### `static constexpr rep ms_to_ns(rep ms) noexcept { ... }`
+### `return Time(a._nsec + b._nsec);`
+### `return Time(a._nsec * b._nsec);`
+### `return safe_sub(a, b);`
+### `if (a._nsec < b._nsec) { ... }`
+### `return Time(a._nsec - b._nsec);`
+### `constexpr Time unsafe_sub(Time t) const noexcept { ... }`
+### `return Time(this->_nsec - t._nsec);`

docs/core/timer.md

@@ -0,0 +1,13 @@
+# core/timer.h
+
+## class Timer — public interface
+
+### `Timer() { ... }`
+### `init();`
+### `void init() noexcept { ... }`
+### `_start = clock::now();`
+### `Time start() const noexcept { ... }`
+### `auto tp = _start.time_since_epoch();`
+### `Time now() const noexcept { ... }`
+### `auto tp = clock::now().time_since_epoch();`
+### `Time elapsed() const noexcept { ... }`

docs/core/types.md

@@ -0,0 +1,6 @@
+# core/types.h
+
+## Free functions
+
+### `inline IPv4Addr ipv4(NodeId n, PortId p) noexcept { ... }`
+### `return (static_cast<uint32_t>(n) << 16) | static_cast<uint32_t>(p);`

docs/hosts/mgmt_msg.md

@@ -0,0 +1,19 @@
+# hosts/mgmt_msg.h
+
+## class MgmtMsg — public interface
+
+### `virtual ~MgmtMsg() = default;`
+
+## class HeartbeatMsg — public interface
+
+### `: subscriber_id(sid), status(st), generated_at(t) { ... }`
+### `MgmtKind kind() const noexcept override { ... }`
+
+## class JobFinishedMsg — public interface
+
+### `: flow_id(fid), finished_at(t) { ... }`
+### `MgmtKind kind() const noexcept override { ... }`
+
+## class EndSimulationMsg — public interface
+
+### `MgmtKind kind() const noexcept override { ... }`

docs/hosts/policies.md

@@ -0,0 +1,20 @@
+# hosts/policies.h
+
+## class PubBasePolicy — public interface
+
+### `virtual ~PubBasePolicy() = default;`
+
+## class PubRRPolicy — public interface
+
+### `: _ranges(std::move(ranges)) { ... }`
+### `validate_and_build();`
+### `PacketGroups select_multicast_groups(PacketGroups update_groups_mask) override { ... }`
+### `for (auto const& r : _ranges) { ... }`
+
+## class SubBasePolicy — public interface
+
+### `virtual ~SubBasePolicy() = default;`
+
+## class SubDummyPolicy — public interface
+
+### `~SubDummyPolicy() override = default;`

docs/hosts/publisher.md

@@ -0,0 +1,10 @@
+# hosts/publisher.h
+
+## class Publisher — public interface
+
+### `void recv_update(Bytes size, PacketGroups update_groups_mask) noexcept;`
+### `void set_status(NodeStatus s, Time new_latency = Time{}) noexcept;`
+### `virtual void recv_mgmt_msg(MgmtMsgPtr msg) noexcept override;`
+### `virtual void recv_frame(const Packet& frame) override;`
+### `uint64_t updates_in() const noexcept { ... }`
+### `uint64_t bytes_out() const noexcept { ... }`

docs/hosts/subscriber.md

@@ -0,0 +1,8 @@
+# hosts/subscriber.h
+
+## class Publisher — public interface
+
+### `virtual void recv_mgmt_msg(MgmtMsgPtr msg) noexcept override;`
+### `void recv_frame(const Packet& frame) override;`
+### `void set_status(NodeStatus s) noexcept;`
+### `void set_publisher(Publisher* p) noexcept { ... }`

docs/network/link.md

@@ -0,0 +1,19 @@
+# network/link.h
+
+## class Link — public interface
+
+### `void send_pkt(Packet &pkt, NodeId caller);`
+### `void schedule_delivery_after(Packet &pkt, NodeId caller, Time after);`
+### `Time next_available(NodeId sender) const noexcept;`
+### `std::optional<Reservation> reserve(Bytes bytes, NodeId sender) noexcept;`
+### `Time serialization_time(Bytes bytes) const noexcept { ... }`
+### `return serialization_time(bytes, _bandwidth_gbps_cur);`
+### `Time propagation_latency() const noexcept { ... }`
+### `LinkId id() const noexcept { ... }`
+### `LinkStatus status() const noexcept { ... }`
+### `double bandwidth_gbps() const noexcept { ... }`
+### `NodeId src_id() const noexcept { ... }`
+### `NodeId dst_id() const noexcept { ... }`
+### `PortId src_port() const noexcept { ... }`
+### `PortId dst_port() const noexcept { ... }`
+### `static Time serialization_time(Bytes bytes, double gbps) noexcept;`

docs/network/network_nic.md

@@ -0,0 +1,11 @@
+# network/network_nic.h
+
+## class NetworkNic — public interface
+
+### `virtual void recv_pkt(Packet &pkt, PortId ingress) override;`
+### `void attach_host(Host* host) noexcept;`
+### `void detach_host(Host* host) noexcept;`
+### `void set_status(NodeStatus s, Time new_latency = Time(0)) noexcept;`
+### `const NicTelemetry &telemetry() const noexcept { ... }`
+### `void set_port_blacklisted(PortId port, bool blacklisted) noexcept;`
+### `bool is_port_blacklisted(PortId port) const noexcept;`

docs/network/network_node.md

@@ -0,0 +1,6 @@
+# network/network_node.h
+
+## class NetworkNode — public interface
+
+### `explicit NetworkNode(Simulator *const sim, NodeId id, NodeType type) noexcept;`
+### `virtual ~NetworkNode() = default;`

docs/network/network_switch.md

@@ -0,0 +1,9 @@
+# network/network_switch.h
+
+## class NetworkSwitch — public interface
+
+### `virtual void recv_pkt(Packet &pkt, PortId ingress) override;`
+### `void set_status(NodeStatus s, Time new_forward_latency = Time(0)) noexcept;`
+### `NodeStatus get_status() const noexcept { ... }`
+### `return status();`
+### `uint16_t port_cnt() const noexcept { ... }`

docs/network/nic/congestion_control.md

@@ -0,0 +1,18 @@
+# network/nic/congestion_control.h
+
+## class CongestionControl — public interface
+
+### `explicit CongestionControl(Bytes init_cwnd, Bytes max_cwnd) noexcept;`
+### `virtual ~CongestionControl() = default;`
+### `Bytes cwnd() const noexcept { ... }`
+### `Bytes cwnd_max() const noexcept { ... }`
+
+## class DCQCN — public interface
+
+### `explicit DCQCN(Bytes init_cwnd, Bytes max_cwnd) noexcept;`
+### `virtual void update(const Packet& pkt, Time rtt) noexcept override;`
+
+## class NSCC — public interface
+
+### `explicit NSCC(Bytes init_cwnd, Bytes max_cwnd) noexcept;`
+### `virtual void update(const Packet& pkt, Time rtt) noexcept override;`

docs/network/nic/load_balance.md

@@ -0,0 +1,12 @@
+# network/nic/load_balance.h
+
+## class LoadBalance — public interface
+
+### `explicit LoadBalance(Rng *const rng) noexcept : _rng(rng) { ... }`
+### `virtual ~LoadBalance() = default;`
+
+## class LBRandomPacketSpraying — public interface
+
+### `explicit LBRandomPacketSpraying(Rng *const rng) noexcept : LoadBalance(rng) { ... }`
+### `virtual void update(const Packet& pkt) noexcept override;`
+### `virtual uint16_t get_entropy(const Packet& context) noexcept override;`

docs/network/packet.md

@@ -0,0 +1,35 @@
+# network/packet.h
+
+## class Packet — public interface
+
+### `NodeId src_node() const noexcept;`
+### `PortId src_port() const noexcept;`
+### `NodeId dst_node() const noexcept;`
+### `PortId dst_port() const noexcept;`
+### `PacketProtocol protocol() const noexcept;`
+### `PacketSeq seq() const noexcept;`
+### `FlowId flow_id() const noexcept;`
+### `uint32_t entropy() const noexcept;`
+### `void set_src_node(NodeId n) noexcept;`
+### `void set_src_port(PortId p) noexcept;`
+### `void set_dst_node(NodeId n) noexcept;`
+### `void set_dst_port(PortId p) noexcept;`
+### `void set_seq(PacketSeq s) noexcept;`
+### `void set_flow_id(FlowId f) noexcept;`
+### `void set_entropy(uint32_t e) noexcept;`
+### `void set_protocol(PacketProtocol p) noexcept;`
+### `void set_payload_size(Bytes size) noexcept;`
+### `void set_ecn_enabled(bool v) noexcept;`
+### `void set_ecn_marked(bool v) noexcept;`
+### `void set_eof(bool v) noexcept;`
+### `bool is_ecn_enabled() const noexcept;`
+### `bool is_ecn() const noexcept;`
+### `bool is_eof() const noexcept;`
+### `FlowPriority priority() const noexcept;`
+### `uint8_t priority_raw() const noexcept;`
+### `Bytes header_size() const noexcept;`
+### `Bytes payload_size() const noexcept;`
+### `Bytes total_size() const noexcept;`
+### `PacketGroups groups() const noexcept;`
+### `void set_groups(PacketGroups g) noexcept;`
+### `void add_groups(PacketGroups gmask) noexcept;`

docs/network/switch/dedicated_buffer.md

@@ -0,0 +1,5 @@
+# network/switch/dedicated_buffer.h
+
+## class DedicatedBuffer — public interface
+
+### `bool drain_one(PortId port) override;`

docs/network/switch/ecn_dedicated_red.md

@@ -0,0 +1,5 @@
+# network/switch/ecn_dedicated_red.h
+
+## class DedicatedREDEngine — public interface
+
+### `_rng(rng) { ... }`

docs/network/switch/ecn_engine.md

@@ -0,0 +1,5 @@
+# network/switch/ecn_engine.h
+
+## class SwitchBuffer — public interface
+
+### `virtual ~ECNEngine() = default;`

docs/network/switch/ecn_shared_red.md

@@ -0,0 +1,5 @@
+# network/switch/ecn_shared_red.h
+
+## class SharedREDEngine — public interface
+
+### `_avg_port_bytes() { ... }`

docs/network/switch/multicast_table.md

@@ -0,0 +1,15 @@
+# network/switch/multicast_table.h
+
+## class MulticastTable — public interface
+
+### `MulticastTable();`
+### `bool add_tree(std::size_t group_id, uint16_t tree_id);`
+### `bool delete_tree(std::size_t group_id, uint16_t tree_id);`
+### `bool add_child_port(std::size_t group_id, uint16_t tree_id, PortId out_port);`
+### `bool delete_child_port(std::size_t group_id, uint16_t tree_id, PortId out_port);`
+### `bool set_parent(std::size_t group_id, uint16_t tree_id, PortId parent);`
+### `bool set_weight(std::size_t group_id, uint16_t tree_id, uint8_t w);`
+### `bool set_epoch(std::size_t group_id, uint16_t tree_id, uint8_t epoch);`
+### `const std::vector<McTree> *trees_of(std::size_t group_id) const;`
+### `std::size_t group_count() const noexcept;`
+### `std::vector<PortId> get_port_list(PacketGroups groups) const;`

docs/network/switch/shared_buffer.md

@@ -0,0 +1,5 @@
+# network/switch/shared_buffer.h
+
+## class SharedBuffer — public interface
+
+### `virtual bool drain_one(PortId port) override;`

docs/network/switch/switch_buffer.md

@@ -0,0 +1,19 @@
+# network/switch/switch_buffer.h
+
+## class NetworkSwitch — public interface
+
+### `virtual ~SwitchBuffer() = default;`
+### `Bytes buffer_size() const noexcept;`
+### `SwitchBufferType type() const noexcept;`
+### `uint16_t port_cnt() const noexcept;`
+### `Bytes port_buffered(PortId p) const noexcept;`
+### `const std::vector<Bytes> &ports_buffered() const noexcept;`
+### `uint8_t share_ctrl() const noexcept;`
+### `uint8_t share_mice() const noexcept;`
+### `uint8_t share_elephant() const noexcept;`
+### `void set_share_ctrl(uint8_t pct) noexcept;`
+### `void set_share_mice(uint8_t pct) noexcept;`
+### `void set_share_elephant(uint8_t pct) noexcept;`
+### `const Simulator *simulator() const noexcept;`
+### `const NetworkSwitch *owner() const noexcept;`
+### `void set_egress_links(const std::vector<Link*> &links);`

docs/network/switch/unicast_table.md

@@ -0,0 +1,8 @@
+# network/switch/unicast_table.h
+
+## class UnicastTable — public interface
+
+### `UnicastTable() = default;`
+### `std::vector<PortId> get_port_list(NodeId dst_node, PortId dst_port) const;`
+### `bool add_entry(NodeId dst_node, PortId dst_port, PortId out_port);`
+### `bool delete_entry(NodeId dst_node, PortId dst_port, PortId out_port);`