libmetal
Data Structures | Functions
Shared Memory Interfaces

Data Structures

struct  metal_generic_shmem
 

Functions

int metal_shmem_open (const char *name, size_t size, struct metal_io_region **io)
 Open a libmetal shared memory segment. More...
 
int metal_shmem_register_generic (struct metal_generic_shmem *shmem)
 Statically register a generic shared memory region. More...
 

Detailed Description

Function Documentation

◆ metal_shmem_open()

int metal_shmem_open ( const char *  name,
size_t  size,
struct metal_io_region **  io 
)

Open a libmetal shared memory segment.

Open a shared memory segment.

Parameters
[in]nameName of segment to open.
[in]sizeSize of segment.
[out]ioI/O region handle, if successful.
Returns
0 on success, or -errno on failure.
See also
metal_shmem_create

◆ metal_shmem_register_generic()

int metal_shmem_register_generic ( struct metal_generic_shmem shmem)

Statically register a generic shared memory region.

Shared memory regions may be statically registered at application initialization, or may be dynamically opened. This interface is used for static registration of regions. Subsequent calls to metal_shmem_open() look up in this list of pre-registered regions.

Parameters
[in]shmemGeneric shmem structure.
Returns
0 on success, or -errno on failure.