native-ipc-core 0.6.1

Platform-neutral, pointer-free protocol and sequencing primitives for native-ipc
Documentation

native-ipc-core

Platform-neutral, pointer-free wire formats, checked shared-memory layouts, publication sequencing, and mapping-owned reader/writer bindings for native-ipc.

This crate is useful when implementing a custom transport or protocol. Most applications should depend on native-ipc, which combines these primitives with native capability enforcement.

Main modules

  • codec: fixed-width envelopes, bounded decoding, and protocol traits.
  • layout: canonical multi-region layouts and hostile-memory validation.
  • mapping: mapping-owned runtime regions that prevent duplicate safe writer binding.
  • slot: release/acquire publication, snapshot rechecks, and acknowledgements.

Layout example

use native_ipc_core::layout::{
    AcknowledgementRouteSpec, Endpoint, LayoutLimits, RegionSetLayout,
    RegionSpec, RoleId,
};

let producer = RoleId::new(1).unwrap();
let peer = RoleId::new(2).unwrap();
let regions = [
    RegionSpec {
        role: producer,
        writer: Endpoint::Initiator,
        slot_count: 1,
        payload_bytes: 256,
        acknowledgement_count: 1,
    },
    RegionSpec {
        role: peer,
        writer: Endpoint::Responder,
        slot_count: 1,
        payload_bytes: 256,
        acknowledgement_count: 1,
    },
];
let routes = [
    AcknowledgementRouteSpec {
        owner: peer,
        target: producer,
        slot_index: 0,
        cell_index: 0,
    },
    AcknowledgementRouteSpec {
        owner: producer,
        target: peer,
        slot_index: 0,
        cell_index: 0,
    },
];
let topology = RegionSetLayout::calculate(
    [0x52; 32],
    1,
    &regions,
    &routes,
    LayoutLimits {
        maximum_mapping_size: 64 * 1024,
        maximum_slot_count: 8,
        maximum_acknowledgement_count: 8,
        maximum_payload_bytes: 4096,
    },
)?;
assert_eq!(topology.region(producer).unwrap().slot_count(), 1);
# Ok::<(), native_ipc_core::layout::LayoutError>(())

Complete examples:

The crate supports no_std with allocation by disabling the default std feature.

Licensed under MIT or Apache-2.0.