Rename rmw_publish publisher_handle field to rmw_publisher_handle

Signed-off-by: Christophe Bedard <[email protected]>
ros2 · Feb 4, 2024 · 6989561 · 6989561
1 parent 56d0369
commit 6989561
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 9 deletions.
diff --git a/test_tracetools/test/test_pub_sub.py b/test_tracetools/test/test_pub_sub.py
@@ -100,12 +100,12 @@ def test_all(self):
         # Get corresponding rmw/rcl/rclcpp publish events for ping & pong
         rmw_publish_events = self.get_events_with_name(tp.rmw_publish)
         ping_rmw_pub_events = self.get_events_with_field_value(
-            'publisher_handle',
+            'rmw_publisher_handle',
             ping_rmw_pub_handle,
             rmw_publish_events,
         )
         pong_rmw_pub_events = self.get_events_with_field_value(
-            'publisher_handle',
+            'rmw_publisher_handle',
             pong_rmw_pub_handle,
             rmw_publish_events,
         )

diff --git a/test_tracetools/test/test_publisher.py b/test_tracetools/test/test_publisher.py
@@ -61,7 +61,7 @@ def test_all(self):
             # Message is a pointer (aka a handle)
             self.assertValidHandle(
                 event,
-                ['publisher_handle', 'message'],
+                ['rmw_publisher_handle', 'message'],
             )
             self.assertFieldType(event, 'timestamp', int)
         rcl_publish_events = self.get_events_with_name(tp.rcl_publish)
@@ -141,7 +141,7 @@ def test_all(self):
         # Find pointer of published message using rmw_publisher_handle of corresponding rmw_publish
         # event, since it's the "main" publication event
         rmw_publish_topic_events = self.get_events_with_field_value(
-            'publisher_handle',
+            'rmw_publisher_handle',
             rmw_publisher_handle,
             rmw_publish_events,
         )

diff --git a/tracetools/include/tracetools/tp_call.h b/tracetools/include/tracetools/tp_call.h
@@ -137,12 +137,12 @@ TRACEPOINT_EVENT(
   TRACEPOINT_PROVIDER,
   rmw_publish,
   TP_ARGS(
-    const void *, publisher_handle_arg,
+    const void *, rmw_publisher_handle_arg,
     const void *, message_arg,
     int64_t, timestamp_arg
   ),
   TP_FIELDS(
-    ctf_integer_hex(const void *, publisher_handle, publisher_handle_arg)
+    ctf_integer_hex(const void *, rmw_publisher_handle, rmw_publisher_handle_arg)
     ctf_integer_hex(const void *, message, message_arg)
     ctf_integer(int64_t, timestamp, timestamp_arg)
   )

diff --git a/tracetools/include/tracetools/tracetools.h b/tracetools/include/tracetools/tracetools.h
@@ -270,11 +270,13 @@ _DECLARE_TRACEPOINT(
  * Message publication.
  * Notes the pointer to the message being published at the `rmw` level.
  *
+ * \param[in] rmw_publisher_handle pointer to the publisher's `rmw_publisher_t` handle
  * \param[in] message pointer to the message being published
+ * \param[in] timestamp the source timestamp of the message
  */
 _DECLARE_TRACEPOINT(
   rmw_publish,
-  const void * publisher_handle,
+  const void * rmw_publisher_handle,
   const void * message,
   int64_t timestamp)
 

diff --git a/tracetools/src/tracetools.c b/tracetools/src/tracetools.c
@@ -156,11 +156,11 @@ DEFINE_TRACEPOINT(
 DEFINE_TRACEPOINT(
   rmw_publish,
   TRACEPOINT_PARAMS(
-    const void * publisher_handle,
+    const void * rmw_publisher_handle,
     const void * message,
     int64_t timestamp),
   TRACEPOINT_ARGS(
-    publisher_handle,
+    rmw_publisher_handle,
     message,
     timestamp))