remarks

Author: pavel-kirienko

libudpard/udpard.c

@@ -58,10 +58,15 @@ typedef unsigned char byte_t; ///< For compatibility with platforms where byte s
 
 /// The number of most recent transfers to keep in the history for ACK retransmission and duplicate detection.
 /// Should be a power of two to allow replacement of modulo operation with a bitwise AND.
+///
+/// Implementation node: we used to store bitmask windows instead of a full list of recent transfer-IDs, but they
+/// were found to offer no advantage except in the perfect scenario of non-restarting senders, and an increased
+/// implementation complexity (more branches, more lines of code), so they were replaced with a simple list.
+/// The list works equally well given a non-contiguous transfer-ID stream, unlike the bitmask, thus more robust.
 #define RX_TRANSFER_HISTORY_COUNT 16U
 
 /// In the ORDERED reassembly mode, with the most recently received transfer-ID N, the library will reject
-/// transfers with transfer-ID less than or equal to N - ORDERING_WINDOW (modulo 2^64) as late.
+/// transfers with transfer-ID less than or equal to N-ORDERING_WINDOW (modulo 2^64) as late.
 #define RX_TRANSFER_ORDERING_WINDOW 1024U
 
 #define UDP_PORT               9382U
@@ -1310,7 +1315,6 @@ static void rx_session_ordered_scan_slots(rx_session_t* const self,
         UDPARD_ASSERT((slot != NULL) && (slot->state == rx_slot_done));
         rx_session_eject(self, rx, slot);
     }
-
     // Ensure that in-progress slots, if any, have not ended up within the accepted window after the update.
     // We can release them early to avoid holding the payload buffers that won't be used anyway.
     for (size_t i = 0; i < RX_SLOT_COUNT; i++) {
@@ -1387,6 +1391,7 @@ static void rx_session_update_ordered(rx_session_t* const        self,
                                       const rx_frame_t           frame,
                                       const udpard_mem_deleter_t payload_deleter)
 {
+    // The queries here may be a bit time-consuming. If this becomes a problem, there are many ways to optimize this.
     const bool is_ejected         = rx_session_is_transfer_ejected(self, frame.meta.transfer_id);
     const bool is_late_or_ejected = rx_session_is_transfer_late_or_ejected(self, frame.meta.transfer_id);
     const bool is_interned        = rx_session_is_transfer_interned(self, frame.meta.transfer_id);
@@ -1413,6 +1418,9 @@ static void rx_session_update_ordered(rx_session_t* const        self,
             rx_session_ordered_scan_slots(self, rx, ts, false);
         }
     } else { // retransmit ACK if needed
+        // Note: transfers that are no longer retained in the history will not solicit an ACK response,
+        // meaning that the sender will not get a confirmation if the retransmitted transfer is too old.
+        // We assume that RX_TRANSFER_HISTORY_COUNT is enough to cover all sensible use cases.
         if ((is_interned || is_ejected) && frame.meta.flag_ack && (frame.base.offset == 0U)) {
             rx_session_on_ack_mandate(self, rx, frame.meta.priority, frame.meta.transfer_id, frame.base.payload);
         }

libudpard/udpard.h

@@ -487,7 +487,7 @@ void udpard_tx_free(const udpard_tx_mem_resources_t memory, udpard_tx_item_t* co
 ///
 /// Mode       Guarantees                       Limitations                        Reordering window setting
 /// -----------------------------------------−--------------------------------------------------------------------------
-/// ORDERED    Strictly increasing transfer-ID  May delay transfers                Non-negative number of microseconds
+/// ORDERED    Strictly increasing transfer-ID  May delay transfers, CPU heavier   Non-negative number of microseconds
 /// UNORDERED  Unique transfer-ID               Ordering not guaranteed            UDPARD_RX_REORDERING_WINDOW_UNORDERED
 /// STATELESS  Constant time, constant memory   1-frame only, dups, no responses   UDPARD_RX_REORDERING_WINDOW_STATELESS
 ///
@@ -506,6 +506,8 @@ void udpard_tx_free(const udpard_tx_mem_resources_t memory, udpard_tx_item_t* co
 /// the application will receive 1 2 4 5, and transfer 3 will be permanently lost even if it arrives later
 /// because accepting it without violating the strictly increasing transfer-ID constraint is not possible.
 ///
+/// This mode requires much more bookkeeping which results in a greater processing load per received fragment/transfer.
+///
 /// The ORDERED mode is used if the reordering window is non-negative. Zero is not really a special case, it
 /// simply means that out-of-order transfers are not waited for at all (declared permanently lost immediately).
 /// This should be the default option for most subscriptions; in particular, it is intended for state estimators