iceoryx2 0.10.0

iceoryx2: Lock-Free Zero-Copy Interprocess Communication
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

// Copyright (c) 2026 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available under the
// terms of the Apache Software License 2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
// which is available at https://opensource.org/licenses/MIT.
//
// SPDX-License-Identifier: Apache-2.0 OR MIT

extern crate alloc;

use crate::{config::Config, service::Service};
use alloc::format;

use iceoryx2_bb_concurrency::atomic::{AtomicU32, Ordering};
use iceoryx2_bb_container::semantic_string::SemanticString;
use iceoryx2_bb_derive_macros::ZeroCopySend;
use iceoryx2_bb_elementary::package_version::PackageVersion;
use iceoryx2_bb_elementary_traits::zero_copy_send::ZeroCopySend;
use iceoryx2_bb_system_types::file_name::FileName;
use iceoryx2_cal::dynamic_storage::*;
use iceoryx2_cal::named_concept::*;
use iceoryx2_log::fail;
use iceoryx2_log::fatal_panic;

const GLOBAL_MGMT_NAME: FileName = unsafe { FileName::new_unchecked_const(b"node") };

#[derive(Debug, Default, ZeroCopySend)]
#[repr(C)]
struct State {
    node_counter: AtomicU32,
}

pub(crate) struct GlobalManagementSegment<S: Service> {
    storage: S::PersistentDynamicStorage<State>,
}

impl<S: Service> GlobalManagementSegment<S> {
    pub fn open_or_create(global_config: &Config) -> Result<Self, DynamicStorageOpenOrCreateError> {
        let origin = "GlobalManagementSegment::open_or_create()";
        let msg = "Unable to open or create the management segment";
        let config = Self::dynamic_storage_config(global_config);
        let storage = match <<S::PersistentDynamicStorage<State> as DynamicStorage<State>>::Builder<
            '_,
        > as NamedConceptBuilder<S::PersistentDynamicStorage<State>>>::new(
            &GLOBAL_MGMT_NAME
        )
        .has_ownership(false)
        .config(&config)
        .timeout(global_config.global.creation_timeout)
        .enable_global_access(true)
        .initializer(|_, _| true)
        .open_or_create()
        {
            Ok(storage) => storage,
            Err(e) => {
                fail!(from origin, with e,
                    "{msg} since the underlying persistent dynamic storage could not be opened. [{e:?}]");
            }
        };

        Ok(Self { storage })
    }

    /// # Safety
    ///
    /// * It must be ensured that !NO! other process is running currently using the
    ///   same iceoryx2 domain.
    ///
    pub(crate) unsafe fn remove(global_config: &Config) -> Result<bool, NamedConceptRemoveError> {
        let origin = "GlobalManagementSegment::remove()";
        let msg = "Unable to remove the global management segment";
        let config = Self::dynamic_storage_config(global_config);
        match unsafe {
            <S::PersistentDynamicStorage<State> as NamedConceptMgmt>::remove_cfg(
                &GLOBAL_MGMT_NAME,
                &config,
            )
        } {
            Ok(v) => Ok(v),
            Err(e) => {
                fail!(from origin, with e, "{msg} due to {e:?}.");
            }
        }
    }

    pub fn increment_node_counter(&self) -> u32 {
        self.storage
            .get()
            .node_counter
            .fetch_add(1, Ordering::Relaxed)
    }

    fn dynamic_storage_config(
        global_config: &Config,
    ) -> <S::PersistentDynamicStorage<State> as NamedConceptMgmt>::Configuration {
        let mut suffix = global_config.global.node.global_mgmt_suffix;
        let ver = PackageVersion::get();
        fatal_panic!(
            from "dynamic_storage_config()",
            when suffix.insert_bytes(0, format!(".{}_{}_{}", ver.major(), ver.minor(), ver.patch()).as_bytes()),
            "This should never happen! Failed to added package version suffix to global management segment.");

        <S::PersistentDynamicStorage<State> as NamedConceptMgmt>::Configuration::default()
            .prefix(&global_config.global.prefix)
            .suffix(&suffix)
            .path_hint(global_config.global.root_path())
    }
}