PipeWire  0.3.30
src/pipewire/mem.h
Go to the documentation of this file.
1 /* PipeWire
2  *
3  * Copyright © 2018 Wim Taymans
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice (including the next
13  * paragraph) shall be included in all copies or substantial portions of the
14  * Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  * DEALINGS IN THE SOFTWARE.
23  */
24 
25 #ifndef PIPEWIRE_MEM_H
26 #define PIPEWIRE_MEM_H
27 
28 #include <pipewire/properties.h>
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
48  PW_MEMBLOCK_FLAG_SEAL = (1 << 2),
49  PW_MEMBLOCK_FLAG_MAP = (1 << 3),
54 };
55 
58  PW_MEMMAP_FLAG_READ = (1 << 0),
59  PW_MEMMAP_FLAG_WRITE = (1 << 1),
60  PW_MEMMAP_FLAG_TWICE = (1 << 2),
63  PW_MEMMAP_FLAG_LOCKED = (1 << 4),
65 };
66 
67 struct pw_memchunk;
68 
72 struct pw_mempool {
74 };
75 
78 struct pw_memblock {
79  struct pw_mempool *pool;
80  uint32_t id;
81  int ref;
82  uint32_t flags;
83  uint32_t type;
84  int fd;
85  uint32_t size;
86  struct pw_memmap *map;
87 };
88 
90 struct pw_memmap {
91  struct pw_memblock *block;
92  void *ptr;
93  uint32_t flags;
94  uint32_t offset;
95  uint32_t size;
96  uint32_t tag[5];
97 };
98 
100 #define PW_VERSION_MEMPOOL_EVENTS 0
101  uint32_t version;
102 
104  void (*destroy) (void *data);
105 
107  void (*added) (void *data, struct pw_memblock *block);
108 
110  void (*removed) (void *data, struct pw_memblock *block);
111 };
112 
115 
117 void pw_mempool_add_listener(struct pw_mempool *pool,
118  struct spa_hook *listener,
119  const struct pw_mempool_events *events,
120  void *data);
121 
123 void pw_mempool_clear(struct pw_mempool *pool);
124 
126 void pw_mempool_destroy(struct pw_mempool *pool);
127 
128 
131  enum pw_memblock_flags flags, uint32_t type, size_t size);
132 
135  struct pw_memblock *mem);
136 
139  enum pw_memblock_flags flags, uint32_t type, int fd);
140 
142 void pw_memblock_free(struct pw_memblock *mem);
143 
145 static inline void pw_memblock_unref(struct pw_memblock *mem)
146 {
147  if (--mem->ref == 0)
148  pw_memblock_free(mem);
149 }
150 
152 int pw_mempool_remove_id(struct pw_mempool *pool, uint32_t id);
153 
155 struct pw_memblock * pw_mempool_find_ptr(struct pw_mempool *pool, const void *ptr);
156 
158 struct pw_memblock * pw_mempool_find_id(struct pw_mempool *pool, uint32_t id);
159 
161 struct pw_memblock * pw_mempool_find_fd(struct pw_mempool *pool, int fd);
162 
163 
165 struct pw_memmap * pw_memblock_map(struct pw_memblock *block,
166  enum pw_memmap_flags flags, uint32_t offset, uint32_t size,
167  uint32_t tag[5]);
168 
170 struct pw_memmap * pw_mempool_map_id(struct pw_mempool *pool, uint32_t id,
171  enum pw_memmap_flags flags, uint32_t offset, uint32_t size,
172  uint32_t tag[5]);
173 
174 struct pw_memmap * pw_mempool_import_map(struct pw_mempool *pool,
175  struct pw_mempool *other, void *data, uint32_t size, uint32_t tag[5]);
176 
178 struct pw_memmap * pw_mempool_find_tag(struct pw_mempool *pool, uint32_t tag[5], size_t size);
179 
181 int pw_memmap_free(struct pw_memmap *map);
182 
183 
185 struct pw_map_range {
186  uint32_t start;
187  uint32_t offset;
188  uint32_t size;
189 };
190 
191 #define PW_MAP_RANGE_INIT (struct pw_map_range){ 0, }
192 
195 static inline void pw_map_range_init(struct pw_map_range *range,
196  uint32_t offset, uint32_t size,
197  uint32_t page_size)
198 {
199  range->offset = SPA_ROUND_DOWN_N(offset, page_size);
200  range->start = offset - range->offset;
201  range->size = SPA_ROUND_UP_N(range->start + size, page_size);
202 }
203 
208 #ifdef __cplusplus
209 }
210 #endif
211 
212 #endif /* PIPEWIRE_MEM_H */
pw_map_range
parameters to map a memory range
Definition: src/pipewire/mem.h:185
pw_mempool_events::version
uint32_t version
Definition: src/pipewire/mem.h:101
pw_memblock::pool
struct pw_mempool * pool
owner pool
Definition: src/pipewire/mem.h:79
pw_mempool
A memory pool is a collection of pw_memblocks.
Definition: src/pipewire/mem.h:72
memblock
Definition: mem.c:112
memmap::link
struct spa_list link
Definition: mem.c:134
pw_mempool_import_map
SPA_EXPORT struct pw_memmap * pw_mempool_import_map(struct pw_mempool *pool, struct pw_mempool *other, void *data, uint32_t size, uint32_t tag[5])
Definition: mem.c:623
pw_memmap
a mapped region of a pw_memblock
Definition: src/pipewire/mem.h:90
pw_mempool_find_id
SPA_EXPORT struct pw_memblock * pw_mempool_find_id(struct pw_mempool *pool, uint32_t id)
Find memblock for given id.
Definition: mem.c:758
memblock::link
struct spa_list link
Definition: mem.c:114
memmap::mapping
struct mapping * mapping
Definition: mem.c:133
pw_mempool_events::added
void(* added)(void *data, struct pw_memblock *block)
a new memory block is added to the pool
Definition: src/pipewire/mem.h:107
pw_mempool_events::removed
void(* removed)(void *data, struct pw_memblock *block)
a memory block is removed from the pool
Definition: src/pipewire/mem.h:110
mempool
Definition: mem.c:100
mapping::ptr
void * ptr
Definition: mem.c:127
MFD_CLOEXEC
#define MFD_CLOEXEC
Definition: mem.c:70
memmap
Definition: mem.c:131
pw_mempool_new
struct pw_mempool * pw_mempool_new(struct pw_properties *props)
Create a new memory pool.
Definition: mem.c:137
pw_map_range::start
uint32_t start
Definition: src/pipewire/mem.h:186
pw_memblock::id
uint32_t id
unique id
Definition: src/pipewire/mem.h:80
PW_MEMMAP_FLAG_NONE
@ PW_MEMMAP_FLAG_NONE
Definition: src/pipewire/mem.h:57
PW_MEMBLOCK_FLAG_READWRITE
@ PW_MEMBLOCK_FLAG_READWRITE
Definition: src/pipewire/mem.h:53
MFD_ALLOW_SEALING
#define MFD_ALLOW_SEALING
Definition: mem.c:74
mempool::blocks
struct spa_list blocks
Definition: mem.c:108
pw_mempool_find_fd
SPA_EXPORT struct pw_memblock * pw_mempool_find_fd(struct pw_mempool *pool, int fd)
Find memblock for given fd.
Definition: mem.c:772
PW_MEMMAP_FLAG_PRIVATE
@ PW_MEMMAP_FLAG_PRIVATE
writes will be private
Definition: src/pipewire/mem.h:62
pw_mempool_destroy
void pw_mempool_destroy(struct pw_mempool *pool)
Clear and destroy a pool.
Definition: mem.c:174
pw_memmap::block
struct pw_memblock * block
owner memblock
Definition: src/pipewire/mem.h:91
string.h
mempool::pagesize
uint32_t pagesize
Definition: mem.c:109
data
Definition: filter.c:75
mem.h
pw_mempool_add_listener
void pw_mempool_add_listener(struct pw_mempool *pool, struct spa_hook *listener, const struct pw_mempool_events *events, void *data)
Listen for events.
Definition: mem.c:194
mapping::block
struct memblock * block
Definition: mem.c:121
spa_list_for_each
#define spa_list_for_each(pos, head, member)
Definition: list.h:111
pw_memblock::size
uint32_t size
size of memory
Definition: src/pipewire/mem.h:85
pw_memblock::flags
uint32_t flags
flags for the memory block on of enum pw_memblock_flags
Definition: src/pipewire/mem.h:82
SPA_ROUND_DOWN_N
#define SPA_ROUND_DOWN_N(num, align)
Definition: defs.h:220
PW_MEMBLOCK_FLAG_NONE
@ PW_MEMBLOCK_FLAG_NONE
Definition: src/pipewire/mem.h:45
pw_mempool::props
struct pw_properties * props
Definition: src/pipewire/mem.h:73
SPA_EXPORT
#define SPA_EXPORT
Definition: defs.h:207
pw_log_debug
#define pw_log_debug(...)
Definition: src/pipewire/log.h:89
PW_MEMBLOCK_FLAG_WRITABLE
@ PW_MEMBLOCK_FLAG_WRITABLE
memory is writable
Definition: src/pipewire/mem.h:47
PW_MEMMAP_FLAG_WRITE
@ PW_MEMMAP_FLAG_WRITE
map in write mode
Definition: src/pipewire/mem.h:59
SPA_ROUND_UP_N
#define SPA_ROUND_UP_N(num, align)
Definition: defs.h:221
PW_MEMMAP_FLAG_LOCKED
@ PW_MEMMAP_FLAG_LOCKED
lock the memory into RAM
Definition: src/pipewire/mem.h:63
pw_memblock::pw_mempool_alloc
SPA_EXPORT struct pw_memblock * pw_mempool_alloc(struct pw_mempool *pool, enum pw_memblock_flags flags, uint32_t type, size_t size)
Create a new memblock.
Definition: mem.c:474
pw_mempool_emit_added
#define pw_mempool_emit_added(p, b)
Definition: mem.c:97
impl
Definition: control.c:33
spa_hook_list_init
void spa_hook_list_init(struct spa_hook_list *list)
Initialize a hook list.
Definition: hook.h:86
pw_mempool_find_ptr
SPA_EXPORT struct pw_memblock * pw_mempool_find_ptr(struct pw_mempool *pool, const void *ptr)
Find memblock for given ptr.
Definition: mem.c:739
pw_map_range::offset
uint32_t offset
offset in first page with start of data
Definition: src/pipewire/mem.h:187
PW_MEMMAP_FLAG_READWRITE
@ PW_MEMMAP_FLAG_READWRITE
Definition: src/pipewire/mem.h:64
pw_mempool_import_block
SPA_EXPORT struct pw_memblock * pw_mempool_import_block(struct pw_mempool *pool, struct pw_memblock *mem)
Import a block from another pool.
Definition: mem.c:612
spa_list
Definition: list.h:37
pw_memmap::ptr
void * ptr
mapped pointer
Definition: src/pipewire/mem.h:92
SPA_PTRDIFF
#define SPA_PTRDIFF(p1, p2)
Definition: defs.h:172
SPA_PTROFF
#define SPA_PTROFF(ptr_, offset_, type_)
Return the address (buffer + offset) as pointer of type.
Definition: defs.h:159
mapping::link
struct spa_list link
Definition: mem.c:126
mempool::link
struct spa_list link
Definition: mem.c:103
pw_memmap::size
uint32_t size
size in memblock
Definition: src/pipewire/mem.h:95
res
static uint32_t int int res
Definition: core.h:329
PW_MEMBLOCK_FLAG_DONT_NOTIFY
@ PW_MEMBLOCK_FLAG_DONT_NOTIFY
don't notify events
Definition: src/pipewire/mem.h:51
mapping::do_unmap
unsigned int do_unmap
Definition: mem.c:125
SPA_CONTAINER_OF
#define SPA_CONTAINER_OF(p, t, m)
Definition: defs.h:170
spa_list_consume
#define spa_list_consume(pos, head, member)
Definition: list.h:96
pw_mempool_clear
void pw_mempool_clear(struct pw_mempool *pool)
Clear a pool.
Definition: mem.c:162
pw_memmap::flags
uint32_t flags
flags for the mapping on of enum pw_memmap_flags
Definition: src/pipewire/mem.h:93
pw_log_error
#define pw_log_error(...)
Definition: src/pipewire/log.h:86
memmap::this
struct pw_memmap this
Definition: mem.c:132
pw_mempool_events::destroy
void(* destroy)(void *data)
the pool is destroyed
Definition: src/pipewire/mem.h:104
SPA_LIST_INIT
#define SPA_LIST_INIT(list)
Definition: list.h:42
F_SEAL_GROW
#define F_SEAL_GROW
Definition: mem.c:89
memblock::memmaps
struct spa_list memmaps
Definition: mem.c:116
pw_mempool_events
Definition: src/pipewire/mem.h:99
memblock::this
struct pw_memblock this
Definition: mem.c:113
spa_list_remove
void spa_list_remove(struct spa_list *elem)
Definition: list.h:69
buffer.h
pw_mempool_find_tag
SPA_EXPORT struct pw_memmap * pw_mempool_find_tag(struct pw_mempool *pool, uint32_t tag[5], size_t size)
find a map with the given tag
Definition: mem.c:784
mapping::ref
int ref
Definition: mem.c:122
pw_memblock::fd
int fd
fd
Definition: src/pipewire/mem.h:84
pw_map_range::size
uint32_t size
page aligned offset to map
Definition: src/pipewire/mem.h:188
mapping::size
uint32_t size
Definition: mem.c:124
pw_memblock::ref
int ref
refcount
Definition: src/pipewire/mem.h:81
mapping
Definition: mem.c:120
F_ADD_SEALS
#define F_ADD_SEALS
Definition: mem.c:84
PW_MEMBLOCK_FLAG_SEAL
@ PW_MEMBLOCK_FLAG_SEAL
seal the fd
Definition: src/pipewire/mem.h:48
mapping::offset
uint32_t offset
Definition: mem.c:123
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:76
F_SEAL_SEAL
#define F_SEAL_SEAL
Definition: mem.c:87
pw_mempool_map_id
SPA_EXPORT struct pw_memmap * pw_mempool_map_id(struct pw_mempool *pool, uint32_t id, enum pw_memmap_flags flags, uint32_t offset, uint32_t size, uint32_t tag[5])
Map a region of a memory block with id.
Definition: mem.c:410
F_SEAL_SHRINK
#define F_SEAL_SHRINK
Definition: mem.c:88
PW_MEMBLOCK_FLAG_MAP
@ PW_MEMBLOCK_FLAG_MAP
mmap the fd
Definition: src/pipewire/mem.h:49
SPA_FLAG_IS_SET
#define SPA_FLAG_IS_SET(field, flag)
Definition: defs.h:73
pw_memblock::map
struct pw_memmap * map
optional map when PW_MEMBLOCK_FLAG_MAP was given
Definition: src/pipewire/mem.h:86
spa_list_init
void spa_list_init(struct spa_list *list)
Definition: list.h:44
NAME
#define NAME
Definition: mem.c:44
pw_mempool_emit_removed
#define pw_mempool_emit_removed(p, b)
Definition: mem.c:98
map.h
pw_memmap_free
SPA_EXPORT int pw_memmap_free(struct pw_memmap *map)
Unmap a region.
Definition: mem.c:425
PW_MEMMAP_FLAG_READ
@ PW_MEMMAP_FLAG_READ
map in read mode
Definition: src/pipewire/mem.h:58
pw_mempool_remove_id
int pw_mempool_remove_id(struct pw_mempool *pool, uint32_t id)
Remove a memblock for given id.
Definition: mem.c:675
pw_memmap::offset
uint32_t offset
offset in memblock
Definition: src/pipewire/mem.h:94
pw_memblock_map
SPA_EXPORT struct pw_memmap * pw_memblock_map(struct pw_memblock *block, enum pw_memmap_flags flags, uint32_t offset, uint32_t size, uint32_t tag[5])
Map a region of a memory block.
Definition: mem.c:363
pw_memblock::pw_memblock_free
SPA_EXPORT void pw_memblock_free(struct pw_memblock *block)
Free a memblock.
Definition: mem.c:699
pw_mempool_import
SPA_EXPORT struct pw_memblock * pw_mempool_import(struct pw_mempool *pool, enum pw_memblock_flags flags, uint32_t type, int fd)
Import an fd into the pool.
Definition: mem.c:575
pw_memblock
Memory block structure.
Definition: src/pipewire/mem.h:78
pw_memmap::tag
uint32_t tag[5]
user tag
Definition: src/pipewire/mem.h:96
mempool::map
struct pw_map map
Definition: mem.c:107
pw_memmap_flags
pw_memmap_flags
Definition: src/pipewire/mem.h:56
SPA_ID_INVALID
#define SPA_ID_INVALID
Definition: defs.h:182
pw_memblock_flags
pw_memblock_flags
Flags passed to pw_mempool_alloc()
Definition: src/pipewire/mem.h:44
spa_hook_list
A list of hooks.
Definition: hook.h:48
PW_MEMBLOCK_FLAG_READABLE
@ PW_MEMBLOCK_FLAG_READABLE
memory is readable
Definition: src/pipewire/mem.h:46
pw_mempool_emit_destroy
#define pw_mempool_emit_destroy(p)
Definition: mem.c:96
mempool::listener_list
struct spa_hook_list listener_list
Definition: mem.c:105
mempool::this
struct pw_mempool this
Definition: mem.c:101
impl::this
struct pw_control this
Definition: control.c:34
pw_map
A map.
Definition: map.h:55
PW_MEMMAP_FLAG_TWICE
@ PW_MEMMAP_FLAG_TWICE
map the same area twice after each other, creating a circular ringbuffer
Definition: src/pipewire/mem.h:60
spa_hook_list_append
void spa_hook_list_append(struct spa_hook_list *list, struct spa_hook *hook, const void *funcs, void *data)
Append a hook.
Definition: hook.h:97
PW_MEMBLOCK_FLAG_DONT_CLOSE
@ PW_MEMBLOCK_FLAG_DONT_CLOSE
don't close fd
Definition: src/pipewire/mem.h:50
properties.h
list.h
memblock::mappings
struct spa_list mappings
Definition: mem.c:115
pw_memblock::type
uint32_t type
type of the fd, one of enum spa_data_type
Definition: src/pipewire/mem.h:83
log.h
pw_properties
Definition: properties.h:49
pw_properties::pw_properties_free
SPA_EXPORT void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition: properties.c:386
spa_return_if_fail
#define spa_return_if_fail(expr)
Definition: defs.h:240
spa_hook_list_clean
void spa_hook_list_clean(struct spa_hook_list *list)
Definition: hook.h:124
spa_list_append
#define spa_list_append(list, item)
Definition: list.h:81
pw_log_warn
#define pw_log_warn(...)
Definition: src/pipewire/log.h:87