From 0859def0eb5acaec18f6bd71837b1acb2043f559 Mon Sep 17 00:00:00 2001
From: Christian Eltzschig <me@elchris.org>
Date: Mon, 21 Oct 2024 22:46:41 +0200
Subject: [PATCH] [#483] Add --send-copy flag to pub/sub benchmark

---
 benchmarks/publish-subscribe/src/main.rs | 37 +++++++++++++++++-------
 doc/release-notes/iceoryx2-unreleased.md |  5 ++--
 2 files changed, 30 insertions(+), 12 deletions(-)

diff --git a/benchmarks/publish-subscribe/src/main.rs b/benchmarks/publish-subscribe/src/main.rs
index b13c1c570..8350ac8b8 100644
--- a/benchmarks/publish-subscribe/src/main.rs
+++ b/benchmarks/publish-subscribe/src/main.rs
@@ -10,6 +10,8 @@
 //
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
+use std::mem::MaybeUninit;
+
 use clap::Parser;
 use iceoryx2::prelude::*;
 use iceoryx2_bb_log::set_log_level;
@@ -60,11 +62,17 @@ fn perform_benchmark<T: Service>(args: &Args) -> Result<(), Box<dyn std::error::
 
             barrier.wait();
 
-            let mut sample = unsafe {
-                sender_a2b
-                    .loan_slice_uninit(args.payload_size)
-                    .unwrap()
-                    .assume_init()
+            let mut sample = if args.send_copy {
+                let mut sample = sender_a2b.loan_slice_uninit(args.payload_size).unwrap();
+                sample.payload_mut().fill(MaybeUninit::new(0));
+                unsafe { sample.assume_init() }
+            } else {
+                unsafe {
+                    sender_a2b
+                        .loan_slice_uninit(args.payload_size)
+                        .unwrap()
+                        .assume_init()
+                }
             };
 
             for _ in 0..args.iterations {
@@ -93,12 +101,19 @@ fn perform_benchmark<T: Service>(args: &Args) -> Result<(), Box<dyn std::error::
             barrier.wait();
 
             for _ in 0..args.iterations {
-                let sample = unsafe {
-                    sender_b2a
-                        .loan_slice_uninit(args.payload_size)
-                        .unwrap()
-                        .assume_init()
+                let sample = if args.send_copy {
+                    let mut sample = sender_b2a.loan_slice_uninit(args.payload_size).unwrap();
+                    sample.payload_mut().fill(MaybeUninit::new(0));
+                    unsafe { sample.assume_init() }
+                } else {
+                    unsafe {
+                        sender_b2a
+                            .loan_slice_uninit(args.payload_size)
+                            .unwrap()
+                            .assume_init()
+                    }
                 };
+
                 while receiver_a2b.receive().unwrap().is_none() {}
 
                 sample.send().unwrap();
@@ -152,6 +167,8 @@ struct Args {
     /// The size in bytes of the payload that shall be used
     #[clap(short, long, default_value_t = 8192)]
     payload_size: usize,
+    #[clap(long)]
+    send_copy: bool,
 }
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
diff --git a/doc/release-notes/iceoryx2-unreleased.md b/doc/release-notes/iceoryx2-unreleased.md
index 3f289f100..8f095bd7d 100644
--- a/doc/release-notes/iceoryx2-unreleased.md
+++ b/doc/release-notes/iceoryx2-unreleased.md
@@ -14,6 +14,7 @@
 * Add Event-Multiplexer `WaitSet` [#390](https://github.com/eclipse-iceoryx/iceoryx2/issues/390)
 * Add `PeriodicTimer` into POSIX building blocks [#425](https://github.com/eclipse-iceoryx/iceoryx2/issues/425)
 * Developer permissions for resources [#460](https://github.com/eclipse-iceoryx/iceoryx2/issues/460)
+* Add `--send-copy` flag to Benchmark to consider mem operations [#483](https://github.com/eclipse-iceoryx/iceoryx2/issues/483)
 
 ### Bugfixes
 
@@ -58,7 +59,7 @@
 
 ### API Breaking Changes
 
-1. Renamed `NodeEvent` into `WaitEvent`
+1. Removed `NodeEvent`. `Node::wait` returns now `Result<(), NodeWaitFailure>`
 
    ```rust
    // old
@@ -67,7 +68,7 @@
    }
 
    // new
-   while node.wait(CYCLE_TIME) != WaitEvent::TerminationRequest {
+   while node.wait(CYCLE_TIME).is_ok() {
     // ...
    }
    ```