API Reference Manual  1.45.0
api/spec/shared_memory.h File Reference

ODP shared memory. More...

#include <odp/visibility_begin.h>
#include <odp/api/init.h>
#include <odp/visibility_end.h>
Include dependency graph for api/spec/shared_memory.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  odp_shm_info_t
 Shared memory block info. More...
 
struct  odp_shm_segment_info_t
 SHM memory segment info. More...
 
struct  odp_shm_capability_t
 Shared memory capabilities. More...
 

Macros

#define ODP_SHM_PROC   0x2
 Share with external processes.
 
#define ODP_SHM_SINGLE_VA   0x4
 Single virtual address. More...
 
#define ODP_SHM_EXPORT   0x08
 Export memory. More...
 
#define ODP_SHM_HP   0x10
 Use huge pages. More...
 
#define ODP_SHM_HW_ACCESS   0x20
 Share memory with HW accelerators. More...
 
#define ODP_SHM_NO_HP   0x40
 Don't use huge pages. More...
 

Typedefs

typedef struct odp_shm_info_t odp_shm_info_t
 Shared memory block info.
 
typedef struct odp_shm_segment_info_t odp_shm_segment_info_t
 SHM memory segment info.
 
typedef struct odp_shm_capability_t odp_shm_capability_t
 Shared memory capabilities.
 

Functions

int odp_shm_capability (odp_shm_capability_t *capa)
 Query shared memory capabilities. More...
 
odp_shm_t odp_shm_reserve (const char *name, uint64_t size, uint64_t align, uint32_t flags)
 Reserve a contiguous block of shared memory. More...
 
int odp_shm_free (odp_shm_t shm)
 Free a contiguous block of shared memory. More...
 
odp_shm_t odp_shm_lookup (const char *name)
 Lookup for a block of shared memory. More...
 
odp_shm_t odp_shm_import (const char *remote_name, odp_instance_t odp_inst, const char *local_name)
 Import a block of shared memory, exported by another ODP instance. More...
 
void * odp_shm_addr (odp_shm_t shm)
 Shared memory block address. More...
 
int odp_shm_info (odp_shm_t shm, odp_shm_info_t *info)
 Shared memory block info. More...
 
int odp_shm_segment_info (odp_shm_t shm, uint32_t index, uint32_t num, odp_shm_segment_info_t info[])
 SHM block segmentation information. More...
 
void odp_shm_print_all (void)
 Print all shared memory blocks.
 
void odp_shm_print (odp_shm_t shm)
 Print shared memory block info. More...
 
uint64_t odp_shm_to_u64 (odp_shm_t shm)
 Get printable value for an odp_shm_t. More...
 

Detailed Description

ODP shared memory.

Definition in file api/spec/shared_memory.h.