Move protection (#575)

* owned type added, test compile fail fix * owned types added, compilation passed * arduino example fix * test build fix * test build fixes * test build fix * examples buld fix * examples build fix * examble build fix * example build fix * test build fix * moved struct in dummy macro * take implemented, test for take added * build errors fixed, take macro added * compilation fix * test fail fix * z_view_xxx_check/null replaced by is_empty/empty to separate them from _check/_null for owned structs * no z_check for view anymore * compile fix * query under feature
eclipse-zenoh · Aug 12, 2024 · 939c469 · 939c469
1 parent 48887a9
commit 939c469
Show file tree

Hide file tree

Showing 33 changed files with 472 additions and 495 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -285,7 +285,6 @@ Macros
 Primitives
 ~~~~~~~~~~
 
-.. autocfunction:: primitives.h::z_view_string_empty
 .. autocfunction:: primitives.h::z_view_string_from_str
 .. autocfunction:: primitives.h::z_view_keyexpr_from_str
 .. autocfunction:: primitives.h::z_view_keyexpr_from_str_unchecked

diff --git a/examples/arduino/z_get.ino b/examples/arduino/z_get.ino
@@ -118,7 +118,7 @@ void loop() {
     z_owned_bytes_t payload;
     if (strcmp(VALUE, "") != 0) {
         z_bytes_from_static_str(&payload, VALUE);
-        opts.payload = &payload;
+        opts.payload = z_bytes_move(&payload);
     }
     z_owned_closure_reply_t callback;
     z_closure_reply(&callback, reply_handler, reply_dropper, NULL);

diff --git a/examples/espidf/z_get.c b/examples/espidf/z_get.c
@@ -165,7 +165,7 @@ void app_main() {
         z_owned_bytes_t payload;
         if (strcmp(VALUE, "") != 0) {
             z_bytes_from_static_str(&payload, VALUE);
-            opts.payload = &payload;
+            opts.payload = z_move(payload);
         }
         z_owned_closure_reply_t callback;
         z_closure(&callback, reply_handler, reply_dropper);

diff --git a/examples/freertos_plus_tcp/z_get.c b/examples/freertos_plus_tcp/z_get.c
@@ -77,7 +77,7 @@ void app_main(void) {
     z_view_keyexpr_t ke;
     if (z_view_keyexpr_from_str(&ke, KEYEXPR) < 0) {
         printf("%s is not a valid key expression", KEYEXPR);
-        return -1;
+        return;
     }
 
     while (1) {
@@ -89,7 +89,7 @@ void app_main(void) {
         z_owned_bytes_t payload;
         if (strcmp(VALUE, "") != 0) {
             z_bytes_from_static_str(&payload, VALUE);
-            opts.payload = &payload;
+            opts.payload = z_move(payload);
         }
         z_owned_closure_reply_t callback;
         z_closure(&callback, reply_handler, reply_dropper);

diff --git a/examples/freertos_plus_tcp/z_queryable.c b/examples/freertos_plus_tcp/z_queryable.c
@@ -79,7 +79,7 @@ void app_main(void) {
     z_view_keyexpr_t ke;
     if (z_view_keyexpr_from_str(&ke, KEYEXPR) < 0) {
         printf("%s is not a valid key expression", KEYEXPR);
-        return -1;
+        return;
     }
 
     printf("Creating Queryable on '%s'...\n", KEYEXPR);

diff --git a/examples/mbed/z_get.cpp b/examples/mbed/z_get.cpp
@@ -86,7 +86,7 @@ int main(int argc, char **argv) {
         z_owned_bytes_t payload;
         if (strcmp(VALUE, "") != 0) {
             z_bytes_from_static_str(&payload, VALUE);
-            opts.payload = &payload;
+            opts.payload = z_bytes_move(&payload);
         }
         z_owned_closure_reply_t callback;
         z_closure_reply(&callback, reply_handler, reply_dropper, NULL);

diff --git a/examples/unix/c11/z_get.c b/examples/unix/c11/z_get.c
@@ -130,7 +130,7 @@ int main(int argc, char **argv) {
     z_owned_bytes_t payload;
     if (value != NULL) {
         z_bytes_from_static_str(&payload, value);
-        opts.payload = &payload;
+        opts.payload = z_bytes_move(&payload);
     }
 
     z_owned_closure_reply_t callback;

diff --git a/examples/unix/c11/z_get_attachment.c b/examples/unix/c11/z_get_attachment.c
@@ -68,9 +68,9 @@ void parse_attachment(kv_pairs_rx_t *kvp, const z_loaned_bytes_t *attachment) {
         z_bytes_deserialize_into_pair(z_loan(kv), &first, &second);
         z_bytes_deserialize_into_string(z_loan(first), &kvp->data[kvp->current_idx].key);
         z_bytes_deserialize_into_string(z_loan(second), &kvp->data[kvp->current_idx].value);
-        z_bytes_drop(&first);
-        z_bytes_drop(&second);
-        z_bytes_drop(&kv);
+        z_bytes_drop(z_bytes_move(&first));
+        z_bytes_drop(z_bytes_move(&second));
+        z_bytes_drop(z_bytes_move(&kv));
         kvp->current_idx++;
     }
 }
@@ -85,8 +85,8 @@ void print_attachment(kv_pairs_rx_t *kvp) {
 
 void drop_attachment(kv_pairs_rx_t *kvp) {
     for (size_t i = 0; i < kvp->current_idx; i++) {
-        z_string_drop(&kvp->data[i].key);
-        z_string_drop(&kvp->data[i].value);
+        z_string_drop(z_string_move(&kvp->data[i].key));
+        z_string_drop(z_string_move(&kvp->data[i].value));
     }
     z_free(kvp->data);
 }
@@ -206,7 +206,7 @@ int main(int argc, char **argv) {
     z_owned_bytes_t payload;
     if (value != NULL) {
         z_bytes_from_static_str(&payload, value);
-        opts.payload = &payload;
+        opts.payload = z_bytes_move(&payload);
     }
 
     // Add attachment value

diff --git a/examples/unix/c11/z_get_channel.c b/examples/unix/c11/z_get_channel.c
@@ -94,7 +94,7 @@ int main(int argc, char **argv) {
     z_owned_bytes_t payload;
     if (value != NULL) {
         z_bytes_from_static_str(&payload, value);
-        opts.payload = &payload;
+        opts.payload = z_bytes_move(&payload);
     }
     z_owned_closure_reply_t closure;
     z_owned_ring_handler_reply_t handler;

diff --git a/examples/unix/c11/z_pong.c b/examples/unix/c11/z_pong.c
@@ -24,7 +24,7 @@ void callback(const z_loaned_sample_t* sample, void* context) {
 }
 void drop(void* context) {
     z_owned_publisher_t* pub = (z_owned_publisher_t*)context;
-    z_drop(pub);
+    z_drop(z_move(*pub));
     // A note on lifetimes:
     //  here, `sub` takes ownership of `pub` and will drop it before returning from its own `drop`,
     //  which makes passing a pointer to the stack safe as long as `sub` is dropped in a scope where `pub` is still
@@ -59,7 +59,7 @@ int main(int argc, char** argv) {
     z_view_keyexpr_t ping;
     z_view_keyexpr_from_str_unchecked(&ping, "test/ping");
     z_owned_closure_sample_t respond;
-    z_closure(&respond, callback, drop, (void*)z_move(pub));
+    z_closure(&respond, callback, drop, (void*)(&pub));
     z_owned_subscriber_t sub;
     if (z_declare_subscriber(&sub, z_loan(session), z_loan(ping), z_move(respond), NULL) < 0) {
         printf("Unable to declare subscriber for key expression.\n");

diff --git a/examples/unix/c11/z_queryable_attachment.c b/examples/unix/c11/z_queryable_attachment.c
@@ -80,9 +80,9 @@ void parse_attachment(kv_pairs_rx_t *kvp, const z_loaned_bytes_t *attachment) {
         z_bytes_deserialize_into_pair(z_loan(kv), &first, &second);
         z_bytes_deserialize_into_string(z_loan(first), &kvp->data[kvp->current_idx].key);
         z_bytes_deserialize_into_string(z_loan(second), &kvp->data[kvp->current_idx].value);
-        z_bytes_drop(&first);
-        z_bytes_drop(&second);
-        z_bytes_drop(&kv);
+        z_bytes_drop(z_bytes_move(&first));
+        z_bytes_drop(z_bytes_move(&second));
+        z_bytes_drop(z_bytes_move(&kv));
         kvp->current_idx++;
     }
 }
@@ -97,8 +97,8 @@ void print_attachment(kv_pairs_rx_t *kvp) {
 
 void drop_attachment(kv_pairs_rx_t *kvp) {
     for (size_t i = 0; i < kvp->current_idx; i++) {
-        z_string_drop(&kvp->data[i].key);
-        z_string_drop(&kvp->data[i].value);
+        z_string_drop(z_string_move(&kvp->data[i].key));
+        z_string_drop(z_string_move(&kvp->data[i].value));
     }
     z_free(kvp->data);
 }

diff --git a/examples/unix/c11/z_sub_attachment.c b/examples/unix/c11/z_sub_attachment.c
@@ -46,9 +46,9 @@ void parse_attachment(kv_pairs_t *kvp, const z_loaned_bytes_t *attachment) {
         z_bytes_deserialize_into_pair(z_loan(kv), &first, &second);
         z_bytes_deserialize_into_string(z_loan(first), &kvp->data[kvp->current_idx].key);
         z_bytes_deserialize_into_string(z_loan(second), &kvp->data[kvp->current_idx].value);
-        z_bytes_drop(&first);
-        z_bytes_drop(&second);
-        z_bytes_drop(&kv);
+        z_bytes_drop(z_bytes_move(&first));
+        z_bytes_drop(z_bytes_move(&second));
+        z_bytes_drop(z_bytes_move(&kv));
         kvp->current_idx++;
     }
 }
@@ -63,8 +63,8 @@ void print_attachment(kv_pairs_t *kvp) {
 
 void drop_attachment(kv_pairs_t *kvp) {
     for (size_t i = 0; i < kvp->current_idx; i++) {
-        z_string_drop(&kvp->data[i].key);
-        z_string_drop(&kvp->data[i].value);
+        z_string_drop(z_string_move(&kvp->data[i].key));
+        z_string_drop(z_string_move(&kvp->data[i].value));
     }
     z_free(kvp->data);
 }

diff --git a/examples/unix/c99/z_get.c b/examples/unix/c99/z_get.c
@@ -124,7 +124,7 @@ int main(int argc, char **argv) {
     z_owned_bytes_t payload;
     if (value != NULL) {
         z_bytes_from_static_str(&payload, value);
-        opts.payload = &payload;
+        opts.payload = z_bytes_move(&payload);
     }
     z_owned_closure_reply_t callback;
     z_closure_reply(&callback, reply_handler, reply_dropper, NULL);

diff --git a/examples/unix/c99/z_pong.c b/examples/unix/c99/z_pong.c
@@ -26,7 +26,7 @@ void callback(const z_loaned_sample_t* sample, void* context) {
 
 void drop(void* context) {
     z_owned_publisher_t* pub = (z_owned_publisher_t*)context;
-    z_undeclare_publisher(pub);
+    z_undeclare_publisher(z_publisher_move(pub));
     // A note on lifetimes:
     //  here, `sub` takes ownership of `pub` and will drop it before returning from its own `drop`,
     //  which makes passing a pointer to the stack safe as long as `sub` is dropped in a scope where `pub` is still
@@ -63,7 +63,7 @@ int main(int argc, char** argv) {
     z_view_keyexpr_t ping;
     z_view_keyexpr_from_str_unchecked(&ping, "test/ping");
     z_owned_closure_sample_t respond;
-    z_closure_sample(&respond, callback, drop, (void*)z_publisher_move(&pub));
+    z_closure_sample(&respond, callback, drop, (void*)(&pub));
     z_owned_subscriber_t sub;
     if (z_declare_subscriber(&sub, z_session_loan(&session), z_view_keyexpr_loan(&ping),
                              z_closure_sample_move(&respond), NULL) < 0) {

diff --git a/examples/windows/z_get.c b/examples/windows/z_get.c
@@ -88,7 +88,7 @@ int main(int argc, char **argv) {
     z_owned_bytes_t payload;
     if (value != NULL) {
         z_bytes_from_static_str(&payload, value);
-        opts.payload = &payload;
+        opts.payload = z_move(payload);
     }
     z_owned_closure_reply_t callback;
     z_closure(&callback, reply_handler, reply_dropper);

diff --git a/examples/windows/z_pong.c b/examples/windows/z_pong.c
@@ -24,7 +24,7 @@ void callback(const z_loaned_sample_t* sample, void* context) {
 }
 void drop(void* context) {
     z_owned_publisher_t* pub = (z_owned_publisher_t*)context;
-    z_drop(pub);
+    z_drop(z_move(*pub));
     // A note on lifetimes:
     //  here, `sub` takes ownership of `pub` and will drop it before returning from its own `drop`,
     //  which makes passing a pointer to the stack safe as long as `sub` is dropped in a scope where `pub` is still
@@ -59,7 +59,7 @@ int main(int argc, char** argv) {
     z_view_keyexpr_t ping;
     z_view_keyexpr_from_str_unchecked(&ping, "test/ping");
     z_owned_closure_sample_t respond;
-    z_closure(&respond, callback, drop, (void*)z_move(pub));
+    z_closure(&respond, callback, drop, (void*)(&pub));
     z_owned_subscriber_t sub;
     if (z_declare_subscriber(&sub, z_loan(session), z_loan(ping), z_move(respond), NULL) < 0) {
         printf("Unable to declare subscriber for key expression.\n");

diff --git a/examples/zephyr/z_get.c b/examples/zephyr/z_get.c
@@ -83,7 +83,7 @@ int main(int argc, char **argv) {
         z_owned_bytes_t payload;
         if (strcmp(VALUE, "") != 0) {
             z_bytes_from_static_str(&payload, VALUE);
-            opts.payload = &payload;
+            opts.payload = z_move(payload);
         }
         z_owned_closure_reply_t callback;
         z_closure(&callback, reply_handler, reply_dropper);

diff --git a/include/zenoh-pico/api/handlers.h b/include/zenoh-pico/api/handlers.h
@@ -31,16 +31,15 @@ extern "C" {
 #define _Z_CHANNEL_DEFINE_IMPL(handler_type, handler_name, handler_new_f_name, callback_type, callback_new_f,          \
                                collection_type, collection_new_f, collection_free_f, collection_push_f,                \
                                collection_pull_f, collection_try_pull_f, collection_close_f, elem_owned_type,          \
-                               elem_loaned_type, elem_clone_f, elem_drop_f, elem_null_f)                               \
+                               elem_loaned_type, elem_clone_f, elem_move_f, elem_drop_f, elem_null_f)                  \
     typedef struct {                                                                                                   \
         collection_type *collection;                                                                                   \
     } handler_type;                                                                                                    \
                                                                                                                        \
     _Z_OWNED_TYPE_VALUE(handler_type, handler_name)                                                                    \
-    _Z_LOANED_TYPE(handler_type, handler_name)                                                                         \
                                                                                                                        \
     static inline void _z_##handler_name##_elem_free(void **elem) {                                                    \
-        elem_drop_f((elem_owned_type *)*elem);                                                                         \
+        elem_drop_f(elem_move_f((elem_owned_type *)*elem));                                                            \
         z_free(*elem);                                                                                                 \
         *elem = NULL;                                                                                                  \
     }                                                                                                                  \
@@ -140,20 +139,25 @@ extern "C" {
                            /* elem_owned_type                 */ z_owned_##item_name##_t,                   \
                            /* elem_loaned_type                */ z_loaned_##item_name##_t,                  \
                            /* elem_clone_f                     */ z_##item_name##_clone,                    \
+                           /* elem_move_f                     */ z_##item_name##_move,                      \
                            /* elem_drop_f                     */ z_##item_name##_drop,                      \
                            /* elem_null                       */ z_##item_name##_null)
 
-#define _Z_CHANNEL_DEFINE_DUMMY(item_name, kind_name)       \
-    typedef struct {                                        \
-        uint8_t _foo;                                       \
-    } z_owned_##kind_name##_handler_##item_name##_t;        \
-    typedef struct {                                        \
-        uint8_t _foo;                                       \
-    } z_loaned_##kind_name##_handler_##item_name##_t;       \
-    void *z_##kind_name##_handler_##item_name##_loan(void); \
-    void *z_##kind_name##_handler_##item_name##_move(void); \
-    void *z_##kind_name##_handler_##item_name##_drop(void); \
-    void *z_##kind_name##_handler_##item_name##_recv(void); \
+#define _Z_CHANNEL_DEFINE_DUMMY(item_name, kind_name)        \
+    typedef struct {                                         \
+        uint8_t _foo;                                        \
+    } z_owned_##kind_name##_handler_##item_name##_t;         \
+    typedef struct {                                         \
+        uint8_t _foo;                                        \
+    } z_loaned_##kind_name##_handler_##item_name##_t;        \
+    typedef struct {                                         \
+        z_owned_##kind_name##_handler_##item_name##_t *_ptr; \
+    } z_moved_##kind_name##_handler_##item_name##_t;         \
+    void *z_##kind_name##_handler_##item_name##_loan(void);  \
+    void *z_##kind_name##_handler_##item_name##_move(void);  \
+    void *z_##kind_name##_handler_##item_name##_drop(void);  \
+    void *z_##kind_name##_handler_##item_name##_recv(void);  \
+    void *z_##kind_name##_handler_##item_name##_take(void);  \
     void *z_##kind_name##_handler_##item_name##_try_recv(void);
 
 // This macro defines: