blob: 5b27b6b9eb28c4c414e9dfdca435b00c7b50d998 (
plain)
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
/* Copyright (c) 2013-2014, Linaro Limited
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/**
* @file
*
* ODP shared memory
*/
#ifndef ODP_SHARED_MEMORY_H_
#define ODP_SHARED_MEMORY_H_
#ifdef __cplusplus
extern "C" {
#endif
/** @defgroup odp_shared_memory ODP SHARED MEMORY
* Operations on shared memory.
* @{
*/
/**
* @typedef odp_shm_t
* ODP shared memory block
*/
/**
* @def ODP_SHM_INVALID
* Invalid shared memory block
*/
/**
* @def ODP_SHM_NULL
* Synonym for buffer pool use
*/
/** Maximum shared memory block name length in chars */
#define ODP_SHM_NAME_LEN 32
/*
* Shared memory flags
*/
/* Share level */
#define ODP_SHM_SW_ONLY 0x1 /**< Application SW only, no HW access */
#define ODP_SHM_PROC 0x2 /**< Share with external processes */
/**
* Shared memory block info
*/
typedef struct odp_shm_info_t {
const char *name; /**< Block name */
void *addr; /**< Block address */
uint64_t size; /**< Block size in bytes */
uint64_t page_size; /**< Memory page size */
uint32_t flags; /**< ODP_SHM_* flags */
} odp_shm_info_t;
/**
* Reserve a contiguous block of shared memory
*
* @param[in] name Name of the block (maximum ODP_SHM_NAME_LEN - 1 chars)
* @param[in] size Block size in bytes
* @param[in] align Block alignment in bytes
* @param[in] flags Shared memory parameter flags (ODP_SHM_*).
* Default value is 0.
*
* @return Pointer to the reserved block, or NULL
*/
odp_shm_t odp_shm_reserve(const char *name, uint64_t size, uint64_t align,
uint32_t flags);
/**
* Free a contiguous block of shared memory
*
* Frees a previously reserved block of shared memory.
* @note Freeing memory that is in use will result in UNDEFINED behavior
*
* @param[in] shm Block handle
*
* @retval 0 if the handle is already free
* @retval 0 if the handle free succeeds
* @retval -1 on failure to free the handle
*/
int odp_shm_free(odp_shm_t shm);
/**
* Lookup for a block of shared memory
*
* @param[in] name Name of the block
*
* @return A handle to the block if it is found by name
* @retval #ODP_SHM_INVALID if the block is not found
*/
odp_shm_t odp_shm_lookup(const char *name);
/**
* Shared memory block address
*
* @param[in] shm Block handle
*
* @return Memory block address, or NULL on error
*/
void *odp_shm_addr(odp_shm_t shm);
/**
* Shared memory block info
*
* @param[in] shm Block handle
* @param[out] info Block info pointer for output
*
* @return 0 on success, otherwise non-zero
*/
int odp_shm_info(odp_shm_t shm, odp_shm_info_t *info);
/**
* Print all shared memory blocks
*/
void odp_shm_print_all(void);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif
|
