Move the responsibility of pointer zeroing to the caller

PatrickHaecker · PatrickHaecker · commit b3983236980d · 2024-06-26T07:12:52.000+02:00
diff --git a/rclc/include/rclc/executor.h b/rclc/include/rclc/executor.h
@@ -1003,7 +1003,7 @@ rclc_executor_t *
 rclc_alloc_zero_initialized_executor(const rcl_allocator_t * const allocator);
 
 /**
- *  De-allocates an rclc_executor_t object and sets the pointer to NULL.
+ *  De-allocates an rclc_executor_t object.
  *
  *  * <hr>
  * Attribute          | Adherence
diff --git a/rclc/include/rclc/init.h b/rclc/include/rclc/init.h
@@ -144,7 +144,7 @@ rclc_get_context(
   rclc_support_t * support);
 
 /**
- *  De-allocates the rclc_support_t object and sets the pointer to NULL.
+ *  De-allocates an rclc_support_t object.
  *
  *  * <hr>
  * Attribute          | Adherence
@@ -166,8 +166,7 @@ rclc_support_free(
 
 
 /**
- *  Allocates the rcl_allocator_t object on the heap and sets it with default
- *  values.
+ *  Allocates the rcl_allocator_t object and sets it to default values.
  *  Can be used as an alternative to rcl_get_default_allocator() if no
  *  stack allocation can or should be used.
  *
@@ -187,7 +186,7 @@ rcl_allocator_t *
 rclc_allocator_alloc_default();
 
 /**
- *  De-allocates the rcl_allocator_t object and sets the pointer to NULL.
+ *  De-allocates an rcl_allocator_t object.
  *
  *  * <hr>
  * Attribute          | Adherence
diff --git a/rclc/include/rclc/node.h b/rclc/include/rclc/node.h
@@ -100,7 +100,7 @@ rcl_node_t *
 rclc_alloc_zero_initialized_node(const rcl_allocator_t * const allocator);
 
 /**
- *  De-allocates an rcl_node_t object and sets the pointer to NULL.
+ *  De-allocates an rcl_node_t object.
  *
  *  * <hr>
  * Attribute          | Adherence
diff --git a/rclc/include/rclc/publisher.h b/rclc/include/rclc/publisher.h
@@ -130,7 +130,7 @@ rclc_publisher_alloc(
   const rcl_allocator_t * const allocator);
 
 /**
- *  De-allocates an rcl_publisher_t object and sets the pointer to NULL.
+ *  De-allocates an rcl_publisher_t object.
  *
  *  * <hr>
  * Attribute          | Adherence
diff --git a/rclc/include/rclc/subscription.h b/rclc/include/rclc/subscription.h
@@ -131,7 +131,7 @@ rclc_alloc_zero_initialized_subscription(
 );
 
 /**
- *  De-allocates an rcl_subscription_t object and sets the pointer to NULL.
+ *  De-allocates an rcl_subscription_t object.
  *
  *  * <hr>
  * Attribute          | Adherence
diff --git a/rclc/include/rclc/timer.h b/rclc/include/rclc/timer.h
@@ -75,7 +75,7 @@ rclc_alloc_zero_initialized_timer(
 );
 
 /**
- *  De-allocates an rcl_timer_t object and sets the pointer to NULL.
+ *  De-allocates an rcl_timer_t object.
  *
  *  * <hr>
  * Attribute          | Adherence
diff --git a/rclc/src/rclc/executor.c b/rclc/src/rclc/executor.c
@@ -2137,6 +2137,5 @@ rclc_executor_free(rclc_executor_t * executor)
   RCL_CHECK_FOR_NULL_WITH_MSG(
     executor, "executor is a null pointer", return RCL_RET_INVALID_ARGUMENT);
   executor->allocator->deallocate(executor, executor->allocator->state);
-  executor = NULL;
   return RCL_RET_OK;
 }
diff --git a/rclc/src/rclc/init.c b/rclc/src/rclc/init.c
@@ -124,7 +124,6 @@ rclc_support_free(rclc_support_t * support, const rcl_allocator_t * const alloca
   RCL_CHECK_FOR_NULL_WITH_MSG(
     support, "support is a null pointer", return RCL_RET_INVALID_ARGUMENT);
   allocator->deallocate(support, allocator->state);
-  support = NULL;
   return RCL_RET_OK;
 }
 
@@ -156,7 +155,6 @@ rclc_allocator_free(rcl_allocator_t * allocator)
   RCL_CHECK_FOR_NULL_WITH_MSG(
     allocator, "allocator is a null pointer", return RCL_RET_INVALID_ARGUMENT);
   allocator->deallocate(allocator, allocator->state);
-  allocator = NULL;
   return RCL_RET_OK;
 }
 
diff --git a/rclc/src/rclc/node.c b/rclc/src/rclc/node.c
@@ -102,6 +102,5 @@ rclc_node_free(rcl_node_t * node, const rcl_allocator_t * const allocator)
   RCL_CHECK_FOR_NULL_WITH_MSG(
     node, "node is a null pointer", return RCL_RET_INVALID_ARGUMENT);
   allocator->deallocate(node, allocator->state);
-  node = NULL;
   return RCL_RET_OK;
 }
diff --git a/rclc/src/rclc/publisher.c b/rclc/src/rclc/publisher.c
@@ -98,6 +98,5 @@ rclc_publisher_free(
   RCL_CHECK_FOR_NULL_WITH_MSG(
     publisher, "publisher is a null pointer", return RCL_RET_INVALID_ARGUMENT);
   allocator->deallocate(publisher, allocator->state);
-  publisher = NULL;
   return RCL_RET_OK;
 }
diff --git a/rclc/src/rclc/subscription.c b/rclc/src/rclc/subscription.c
@@ -98,6 +98,5 @@ rclc_subscription_free(
   RCL_CHECK_FOR_NULL_WITH_MSG(
     subscription, "subscription is a null pointer", return RCL_RET_INVALID_ARGUMENT);
   allocator->deallocate(subscription, allocator->state);
-  subscription = NULL;
   return RCL_RET_OK;
 }
diff --git a/rclc/src/rclc/timer.c b/rclc/src/rclc/timer.c
@@ -64,6 +64,5 @@ rclc_timer_free(rcl_timer_t * timer, const rcl_allocator_t * const allocator)
   RCL_CHECK_FOR_NULL_WITH_MSG(
     timer, "timer is a null pointer", return RCL_RET_INVALID_ARGUMENT);
   allocator->deallocate(timer, allocator->state);
-  timer = NULL;
   return RCL_RET_OK;
 }
diff --git a/rclc/test/rclc/test_executor.cpp b/rclc/test/rclc/test_executor.cpp
@@ -2812,4 +2812,6 @@ TEST(TestDefaultExecutor, rclc_alloc_zero_initialized_executor) {
   EXPECT_NE(nullptr, executor);
   rcl_ret_t rc = rclc_executor_fini(executor);
   EXPECT_EQ(RCL_RET_OK, rc);
+  rclc_executor_free(executor);
+  executor = nullptr;
 }
diff --git a/rclc/test/rclc/test_init.cpp b/rclc/test/rclc/test_init.cpp
@@ -92,6 +92,7 @@ TEST(Test, rclc_support_alloc) {
   EXPECT_NE(nullptr, support);
   rcl_ret_t rc = rclc_support_free(support, &allocator);
   EXPECT_EQ(RCL_RET_OK, rc);
+  support = nullptr;
 }
 
 TEST(Test, rclc_get_context) {
@@ -110,8 +111,9 @@ TEST(Test, rclc_get_context) {
 
 TEST(Test, rclc_allocator_alloc_default) {
   // test heap allocation and freeing
-  rcl_allocator_t * allocator_heap = rclc_allocator_alloc_default();
-  EXPECT_NE(nullptr, allocator_heap);
-  rcl_ret_t rc = rclc_allocator_free(allocator_heap);
+  rcl_allocator_t * allocator = rclc_allocator_alloc_default();
+  EXPECT_NE(nullptr, allocator);
+  rcl_ret_t rc = rclc_allocator_free(allocator);
   EXPECT_EQ(RCL_RET_OK, rc);
+  allocator = nullptr;
 }
diff --git a/rclc/test/rclc/test_node.cpp b/rclc/test/rclc/test_node.cpp
@@ -121,4 +121,5 @@ TEST(Test, rclc_alloc_zero_initialized_node) {
   EXPECT_NE(nullptr, node);
   rcl_ret_t rc = rclc_node_free(node, &allocator);
   EXPECT_EQ(RCL_RET_OK, rc);
+  node = nullptr;
 }
diff --git a/rclc/test/rclc/test_publisher.cpp b/rclc/test/rclc/test_publisher.cpp
@@ -162,4 +162,5 @@ TEST(Test, rclc_publisher_alloc) {
   EXPECT_NE(nullptr, publisher);
   rcl_ret_t rc = rclc_publisher_free(publisher, &allocator);
   EXPECT_EQ(RCL_RET_OK, rc);
+  publisher = nullptr;
 }
diff --git a/rclc/test/rclc/test_subscription.cpp b/rclc/test/rclc/test_subscription.cpp
@@ -159,4 +159,5 @@ TEST(Test, rclc_alloc_zero_initialized_subscription) {
   EXPECT_NE(nullptr, subscription);
   rcl_ret_t rc = rclc_subscription_free(subscription, &allocator);
   EXPECT_EQ(RCL_RET_OK, rc);
+  subscription = nullptr;
 }
diff --git a/rclc/test/rclc/test_timer.cpp b/rclc/test/rclc/test_timer.cpp
@@ -64,4 +64,5 @@ TEST(Test, rclc_alloc_zero_initialized_timer) {
   EXPECT_NE(nullptr, timer);
   rcl_ret_t rc = rclc_timer_free(timer, &allocator);
   EXPECT_EQ(RCL_RET_OK, rc);
+  timer = nullptr;
 }

Original file line number	Diff line number	Diff line change
`@@ -1003,7 +1003,7 @@ rclc_executor_t *`
`1003`	`1003`	`rclc_alloc_zero_initialized_executor(const rcl_allocator_t * const allocator);`
`1004`	`1004`
`1005`	`1005`	`/**`
`1006`		`- * De-allocates an rclc_executor_t object and sets the pointer to NULL.`
	`1006`	`+ * De-allocates an rclc_executor_t object.`
`1007`	`1007`	`*`
`1008`	`1008`	`* * <hr>`
`1009`	`1009`	`* Attribute \| Adherence`
Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ rcl_node_t *`
`100`	`100`	`rclc_alloc_zero_initialized_node(const rcl_allocator_t * const allocator);`
`101`	`101`
`102`	`102`	`/**`
`103`		`- * De-allocates an rcl_node_t object and sets the pointer to NULL.`
	`103`	`+ * De-allocates an rcl_node_t object.`
`104`	`104`	`*`
`105`	`105`	`* * <hr>`
`106`	`106`	`* Attribute \| Adherence`
Original file line number	Diff line number	Diff line change
`@@ -130,7 +130,7 @@ rclc_publisher_alloc(`
`130`	`130`	`const rcl_allocator_t * const allocator);`
`131`	`131`
`132`	`132`	`/**`
`133`		`- * De-allocates an rcl_publisher_t object and sets the pointer to NULL.`
	`133`	`+ * De-allocates an rcl_publisher_t object.`
`134`	`134`	`*`
`135`	`135`	`* * <hr>`
`136`	`136`	`* Attribute \| Adherence`
Original file line number	Diff line number	Diff line change
`@@ -131,7 +131,7 @@ rclc_alloc_zero_initialized_subscription(`
`131`	`131`	`);`
`132`	`132`
`133`	`133`	`/**`
`134`		`- * De-allocates an rcl_subscription_t object and sets the pointer to NULL.`
	`134`	`+ * De-allocates an rcl_subscription_t object.`
`135`	`135`	`*`
`136`	`136`	`* * <hr>`
`137`	`137`	`* Attribute \| Adherence`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ rclc_alloc_zero_initialized_timer(`
`75`	`75`	`);`
`76`	`76`
`77`	`77`	`/**`
`78`		`- * De-allocates an rcl_timer_t object and sets the pointer to NULL.`
	`78`	`+ * De-allocates an rcl_timer_t object.`
`79`	`79`	`*`
`80`	`80`	`* * <hr>`
`81`	`81`	`* Attribute \| Adherence`
Original file line number	Diff line number	Diff line change
`@@ -2137,6 +2137,5 @@ rclc_executor_free(rclc_executor_t * executor)`
`2137`	`2137`	`RCL_CHECK_FOR_NULL_WITH_MSG(`
`2138`	`2138`	`executor, "executor is a null pointer", return RCL_RET_INVALID_ARGUMENT);`
`2139`	`2139`	`executor->allocator->deallocate(executor, executor->allocator->state);`
`2140`		`- executor = NULL;`
`2141`	`2140`	`return RCL_RET_OK;`
`2142`	`2141`	`}`
Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,6 @@ rclc_support_free(rclc_support_t * support, const rcl_allocator_t * const alloca`
`124`	`124`	`RCL_CHECK_FOR_NULL_WITH_MSG(`
`125`	`125`	`support, "support is a null pointer", return RCL_RET_INVALID_ARGUMENT);`
`126`	`126`	`allocator->deallocate(support, allocator->state);`
`127`		`- support = NULL;`
`128`	`127`	`return RCL_RET_OK;`
`129`	`128`	`}`
`130`	`129`
`@@ -156,7 +155,6 @@ rclc_allocator_free(rcl_allocator_t * allocator)`
`156`	`155`	`RCL_CHECK_FOR_NULL_WITH_MSG(`
`157`	`156`	`allocator, "allocator is a null pointer", return RCL_RET_INVALID_ARGUMENT);`
`158`	`157`	`allocator->deallocate(allocator, allocator->state);`
`159`		`- allocator = NULL;`
`160`	`158`	`return RCL_RET_OK;`
`161`	`159`	`}`
`162`	`160`
Original file line number	Diff line number	Diff line change
`@@ -102,6 +102,5 @@ rclc_node_free(rcl_node_t * node, const rcl_allocator_t * const allocator)`
`102`	`102`	`RCL_CHECK_FOR_NULL_WITH_MSG(`
`103`	`103`	`node, "node is a null pointer", return RCL_RET_INVALID_ARGUMENT);`
`104`	`104`	`allocator->deallocate(node, allocator->state);`
`105`		`- node = NULL;`
`106`	`105`	`return RCL_RET_OK;`
`107`	`106`	`}`
Original file line number	Diff line number	Diff line change
`@@ -98,6 +98,5 @@ rclc_publisher_free(`
`98`	`98`	`RCL_CHECK_FOR_NULL_WITH_MSG(`
`99`	`99`	`publisher, "publisher is a null pointer", return RCL_RET_INVALID_ARGUMENT);`
`100`	`100`	`allocator->deallocate(publisher, allocator->state);`
`101`		`- publisher = NULL;`
`102`	`101`	`return RCL_RET_OK;`
`103`	`102`	`}`