udpard_rx_new does not need to return anything now

Author: pavel-kirienko

libudpard/udpard.c

@@ -1507,19 +1507,16 @@ static bool rx_validate_mem_resources(const udpard_rx_mem_resources_t memory)
            (memory.fragment.alloc != NULL) && (memory.fragment.free != NULL);
 }
 
-bool udpard_rx_new(udpard_rx_t* const self)
-{
-    const bool ok = (self != NULL);
-    if (ok) {
-        mem_zero(sizeof(*self), self);
-        self->list_session_by_animation   = (udpard_list_t){ NULL, NULL };
-        self->index_session_by_reordering = NULL;
-        self->errors_oom                  = 0;
-        self->errors_frame_malformed      = 0;
-        self->errors_transfer_malformed   = 0;
-        self->user                        = NULL;
-    }
-    return ok;
+void udpard_rx_new(udpard_rx_t* const self)
+{
+    UDPARD_ASSERT(self != NULL);
+    mem_zero(sizeof(*self), self);
+    self->list_session_by_animation   = (udpard_list_t){ NULL, NULL };
+    self->index_session_by_reordering = NULL;
+    self->errors_oom                  = 0;
+    self->errors_frame_malformed      = 0;
+    self->errors_transfer_malformed   = 0;
+    self->user                        = NULL;
 }
 
 void udpard_rx_poll(udpard_rx_t* const self, const udpard_us_t now)

libudpard/udpard.h

@@ -698,9 +698,8 @@ struct udpard_rx_ack_mandate_t
 };
 
 /// The RX instance holds no resources and can be destroyed at any time by simply freeing all its ports first
-/// using udpard_rx_port_free(), then discarding the instance itself.
-/// True on success, false if any of the arguments are invalid.
-bool udpard_rx_new(udpard_rx_t* const self);
+/// using udpard_rx_port_free(), then discarding the instance itself. The self pointer must not be NULL.
+void udpard_rx_new(udpard_rx_t* const self);
 
 /// Must be invoked at least every few milliseconds (more often is fine) to purge timed-out sessions and eject
 /// received transfers when the reordering window expires. If this is invoked simultaneously with rx subscription

tests/src/test_e2e_edge.cpp

@@ -62,7 +62,7 @@ struct Fixture
         dest               = udpard_make_subject_endpoint(222U);
 
         TEST_ASSERT_TRUE(udpard_tx_new(&tx, 0x0A0B0C0D0E0F1011ULL, 16, tx_mem));
-        TEST_ASSERT_TRUE(udpard_rx_new(&rx));
+        udpard_rx_new(&rx);
         ctx.expected_uid = tx.local_uid;
         ctx.source       = source;
         rx.user          = &ctx;

tests/src/test_e2e_random.cpp

@@ -156,7 +156,7 @@ void test_udpard_tx_rx_end_to_end()
     const udpard_rx_mem_resources_t rx_mem{ .session  = instrumented_allocator_make_resource(&rx_alloc_session),
                                             .fragment = instrumented_allocator_make_resource(&rx_alloc_frag) };
     udpard_rx_t                     rx;
-    TEST_ASSERT_TRUE(udpard_rx_new(&rx));
+    udpard_rx_new(&rx);
 
     // Test parameters.
     constexpr std::array<uint64_t, 3>    topic_hashes{ 0x123456789ABCDEF0ULL,

tests/src/test_intrusive_rx.c

@@ -1662,7 +1662,7 @@ static void test_rx_session_ordered(void)
 
     // Initialize the shared RX instance.
     udpard_rx_t rx;
-    TEST_ASSERT(udpard_rx_new(&rx));
+    udpard_rx_new(&rx);
     callback_result_t cb_result = { 0 };
     rx.user                     = &cb_result;
 
@@ -2274,7 +2274,7 @@ static void test_rx_session_unordered(void)
 
     // Initialize the shared RX instance.
     udpard_rx_t rx;
-    TEST_ASSERT(udpard_rx_new(&rx));
+    udpard_rx_new(&rx);
     callback_result_t cb_result = { 0 };
     rx.user                     = &cb_result;
 
@@ -2515,7 +2515,7 @@ static void test_rx_session_unordered_reject_old(void)
     const udpard_rx_mem_resources_t rx_mem      = { .fragment = mem_frag, .session = mem_session };
     udpard_rx_t                     rx;
     callback_result_t               cb_result = { 0 };
-    TEST_ASSERT(udpard_rx_new(&rx));
+    udpard_rx_new(&rx);
     rx.user                    = &cb_result;
     const uint64_t   local_uid = 0xF00DCAFEF00DCAFEULL;
     udpard_rx_port_t port;
@@ -2613,7 +2613,7 @@ static void test_rx_session_unordered_duplicates(void)
     const udpard_rx_mem_resources_t rx_mem      = { .fragment = mem_frag, .session = mem_session };
     udpard_rx_t                     rx;
     callback_result_t               cb_result = { 0 };
-    TEST_ASSERT(udpard_rx_new(&rx));
+    udpard_rx_new(&rx);
     rx.user = &cb_result;
     udpard_rx_port_t port;
     const uint64_t   topic_hash = 0x1111222233334444ULL;
@@ -2685,7 +2685,7 @@ static void test_rx_session_ordered_reject_stale_after_jump(void)
     const udpard_mem_deleter_t      del_payload = instrumented_allocator_make_deleter(&alloc_payload);
     const udpard_rx_mem_resources_t rx_mem      = { .fragment = mem_frag, .session = mem_session };
     udpard_rx_t                     rx;
-    TEST_ASSERT(udpard_rx_new(&rx));
+    udpard_rx_new(&rx);
     callback_result_t cb_result = { 0 };
     rx.user                     = &cb_result;
     udpard_rx_port_t port;
@@ -2807,7 +2807,7 @@ static void test_rx_session_ordered_zero_reordering_window(void)
     const udpard_rx_mem_resources_t rx_mem      = { .fragment = mem_frag, .session = mem_session };
     udpard_rx_t                     rx;
     callback_result_t               cb_result = { 0 };
-    TEST_ASSERT(udpard_rx_new(&rx));
+    udpard_rx_new(&rx);
     rx.user = &cb_result;
     udpard_rx_port_t port;
     const uint64_t   topic_hash = 0x9999888877776666ULL;
@@ -2885,7 +2885,7 @@ static void test_rx_port(void)
 
     // Initialize the shared RX instance.
     udpard_rx_t rx;
-    TEST_ASSERT(udpard_rx_new(&rx));
+    udpard_rx_new(&rx);
     callback_result_t cb_result = { 0 };
     rx.user                     = &cb_result;
 
@@ -3255,7 +3255,7 @@ static void test_rx_port_timeouts(void)
 
     udpard_rx_t       rx;
     callback_result_t cb_result = { 0 };
-    TEST_ASSERT(udpard_rx_new(&rx));
+    udpard_rx_new(&rx);
     rx.user = &cb_result;
 
     udpard_rx_port_t port_a;
@@ -3419,7 +3419,7 @@ static void test_rx_port_oom(void)
     const udpard_rx_mem_resources_t rx_mem      = { .fragment = mem_frag, .session = mem_session };
     udpard_rx_t                     rx;
     callback_result_t               cb_result = { 0 };
-    TEST_ASSERT(udpard_rx_new(&rx));
+    udpard_rx_new(&rx);
     rx.user = &cb_result;
     udpard_rx_port_t port_ordered;
     udpard_rx_port_t port_stateless;
@@ -3507,7 +3507,7 @@ static void test_rx_port_free_loop(void)
     const uint64_t    local_uid = 0xCAFED00DCAFED00DULL;
     udpard_rx_t       rx;
     callback_result_t cb_result = { 0 };
-    TEST_ASSERT(udpard_rx_new(&rx));
+    udpard_rx_new(&rx);
     rx.user = &cb_result;
 
     udpard_rx_port_t port_p2p;