PipeWire: mem.h Source File

PipeWire 0.3.6

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
35 enum pw_memblock_flags {
36 PW_MEMBLOCK_FLAG_NONE = 0,
37 PW_MEMBLOCK_FLAG_READABLE = (1 << 0),
38 PW_MEMBLOCK_FLAG_WRITABLE = (1 << 1),
39 PW_MEMBLOCK_FLAG_SEAL = (1 << 2),
40 PW_MEMBLOCK_FLAG_MAP = (1 << 3),
41 PW_MEMBLOCK_FLAG_DONT_CLOSE = (1 << 4),
42 PW_MEMBLOCK_FLAG_DONT_NOTIFY = (1 << 5),
44 PW_MEMBLOCK_FLAG_READWRITE = PW_MEMBLOCK_FLAG_READABLE | PW_MEMBLOCK_FLAG_WRITABLE,
45 };
46
47 enum pw_memmap_flags {
48 PW_MEMMAP_FLAG_NONE = 0,
49 PW_MEMMAP_FLAG_READ = (1 << 0),
50 PW_MEMMAP_FLAG_WRITE = (1 << 1),
51 PW_MEMMAP_FLAG_TWICE = (1 << 2),
53 PW_MEMMAP_FLAG_PRIVATE = (1 << 3),
54 PW_MEMMAP_FLAG_READWRITE = PW_MEMMAP_FLAG_READ | PW_MEMMAP_FLAG_WRITE,
55 };
56
57 struct pw_memchunk;
58
62 struct pw_mempool {
63 struct pw_properties *props;
64 };
65
68 struct pw_memblock {
69 struct pw_mempool *pool;
70 uint32_t id;
71 int ref;
72 uint32_t flags;
73 uint32_t type;
74 int fd;
75 uint32_t size;
76 struct pw_memmap *map;
77 };
78
80 struct pw_memmap {
81 struct pw_memblock *block;
82 void *ptr;
83 uint32_t flags;
84 uint32_t offset;
85 uint32_t size;
86 uint32_t tag[5];
87 };
88
89 struct pw_mempool_events {
90 #define PW_VERSION_MEMPOOL_EVENTS 0
91 uint32_t version;
92
94 void (*destroy) (void *data);
95
97 void (*added) (void *data, struct pw_memblock *block);
98
100 void (*removed) (void *data, struct pw_memblock *block);
101 };
102
104 struct pw_mempool *pw_mempool_new(struct pw_properties *props);
105
107 void pw_mempool_add_listener(struct pw_mempool *pool,
108 struct spa_hook *listener,
109 const struct pw_mempool_events *events,
110 void *data);
111
113 void pw_mempool_clear(struct pw_mempool *pool);
114
116 void pw_mempool_destroy(struct pw_mempool *pool);
117
118
120 struct pw_memblock * pw_mempool_alloc(struct pw_mempool *pool,
121 enum pw_memblock_flags flags, uint32_t type, size_t size);
122
124 struct pw_memblock * pw_mempool_import_block(struct pw_mempool *pool,
125 struct pw_memblock *mem);
126
128 struct pw_memblock * pw_mempool_import(struct pw_mempool *pool,
129 enum pw_memblock_flags flags, uint32_t type, int fd);
130
132 void pw_memblock_free(struct pw_memblock *mem);
133
135 static inline void pw_memblock_unref(struct pw_memblock *mem)
136 {
137 if (--mem->ref == 0)
138 pw_memblock_free(mem);
139 }
140
142 int pw_mempool_remove_id(struct pw_mempool *pool, uint32_t id);
143
145 struct pw_memblock * pw_mempool_find_ptr(struct pw_mempool *pool, const void *ptr);
146
148 struct pw_memblock * pw_mempool_find_id(struct pw_mempool *pool, uint32_t id);
149
151 struct pw_memblock * pw_mempool_find_fd(struct pw_mempool *pool, int fd);
152
153
155 struct pw_memmap * pw_memblock_map(struct pw_memblock *block,
156 enum pw_memmap_flags flags, uint32_t offset, uint32_t size,
157 uint32_t tag[5]);
158
160 struct pw_memmap * pw_mempool_map_id(struct pw_mempool *pool, uint32_t id,
161 enum pw_memmap_flags flags, uint32_t offset, uint32_t size,
162 uint32_t tag[5]);
163
164 struct pw_memmap * pw_mempool_import_map(struct pw_mempool *pool,
165 struct pw_mempool *other, void *data, uint32_t size, uint32_t tag[5]);
166
168 struct pw_memmap * pw_mempool_find_tag(struct pw_mempool *pool, uint32_t tag[5], size_t size);
169
171 int pw_memmap_free(struct pw_memmap *map);
172
173
175 struct pw_map_range {
176 uint32_t start;
177 uint32_t offset;
178 uint32_t size;
179 };
180
181 #define PW_MAP_RANGE_INIT (struct pw_map_range){ 0, }
182
185 static inline void pw_map_range_init(struct pw_map_range *range,
186 uint32_t offset, uint32_t size,
187 uint32_t page_size)
188 {
189 range->offset = SPA_ROUND_DOWN_N(offset, page_size);
190 range->start = offset - range->offset;
191 range->size = SPA_ROUND_UP_N(range->start + size, page_size);
192 }
193
194
195 #ifdef __cplusplus
196 }
197 #endif
198
199 #endif /* PIPEWIRE_MEM_H */
pw_map_range
parameters to map a memory range
Definition: mem.h:175
PW_MEMBLOCK_FLAG_READWRITE
@ PW_MEMBLOCK_FLAG_READWRITE
Definition: mem.h:44
res
static uint32_t int int res
Definition: core.h:323
pw_mempool_events::version
uint32_t version
Definition: mem.h:91
pw_memblock::pool
struct pw_mempool * pool
owner pool
Definition: mem.h:69
pw_mempool
Definition: mem.h:62
memblock
Definition: mem.c:110
memmap::link
struct spa_list link
Definition: mem.c:132
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:595
pw_memmap
a mapped region of a pw_memblock
Definition: mem.h:80
memblock::link
struct spa_list link
Definition: mem.c:112
PW_MEMMAP_FLAG_WRITE
@ PW_MEMMAP_FLAG_WRITE
map in write mode
Definition: mem.h:50
memmap::mapping
struct mapping * mapping
Definition: mem.c:131
pw_mempool_events::added
void(* added)(void *data, struct pw_memblock *block)
a new memory block is added to the pool
Definition: mem.h:97
pw_mempool_events::removed
void(* removed)(void *data, struct pw_memblock *block)
a memory block is removed from the pool
Definition: mem.h:100
pw_map::pw_map_lookup
static void * pw_map_lookup(struct pw_map *map, uint32_t id)
Find an item in the map.
Definition: map.h:169
mempool
Definition: mem.c:98
pw_map::pw_map_remove
static void pw_map_remove(struct pw_map *map, uint32_t id)
Remove an item at index.
Definition: map.h:157
mapping::ptr
void * ptr
Definition: mem.c:125
MFD_CLOEXEC
#define MFD_CLOEXEC
Definition: mem.c:68
memmap
Definition: mem.c:129
pw_map_range::start
uint32_t start
Definition: mem.h:176
pw_mempool_destroy
void pw_mempool_destroy(struct pw_mempool *pool)
Clear and destroy a pool.
Definition: mem.c:169
pw_memblock::id
uint32_t id
unique id
Definition: mem.h:70
pw_log::pw_log_error
#define pw_log_error(...)
MFD_ALLOW_SEALING
#define MFD_ALLOW_SEALING
Definition: mem.c:72
mempool::blocks
struct spa_list blocks
Definition: mem.c:106
pw_mempool_find_fd
struct pw_memblock * pw_mempool_find_fd(struct pw_mempool *pool, int fd)
Find memblock for given fd.
Definition: mem.c:744
pw_mempool_destroy
void pw_mempool_destroy(struct pw_mempool *pool)
Clear and destroy a pool.
Definition: mem.c:169
PW_MEMBLOCK_FLAG_MAP
@ PW_MEMBLOCK_FLAG_MAP
mmap the fd
Definition: mem.h:40
pw_map::pw_map_init
static void pw_map_init(struct pw_map *map, size_t size, size_t extend)
Initialize a map.
Definition: map.h:76
pw_memmap::block
struct pw_memblock * block
owner memblock
Definition: mem.h:81
PW_MEMBLOCK_FLAG_DONT_NOTIFY
@ PW_MEMBLOCK_FLAG_DONT_NOTIFY
don't notify events
Definition: mem.h:42
pw_mempool_find_ptr
struct pw_memblock * pw_mempool_find_ptr(struct pw_mempool *pool, const void *ptr)
Find memblock for given ptr.
Definition: mem.c:711
pw_memblock::pw_memblock_flags
pw_memblock_flags
Flags passed to pw_mempool_alloc()
Definition: mem.h:35
pw_mempool_clear
void pw_mempool_clear(struct pw_mempool *pool)
Clear a pool.
Definition: mem.c:160
mempool::pagesize
uint32_t pagesize
Definition: mem.c:107
data
Definition: filter.c:70
mapping::block
struct memblock * block
Definition: mem.c:119
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:711
pw_memblock::size
uint32_t size
size of memory
Definition: mem.h:75
PW_MEMMAP_FLAG_READ
@ PW_MEMMAP_FLAG_READ
map in read mode
Definition: mem.h:49
pw_memblock::flags
uint32_t flags
flags for the memory block on of enum pw_memblock_flags
Definition: mem.h:72
PW_MEMMAP_FLAG_PRIVATE
@ PW_MEMMAP_FLAG_PRIVATE
writes will be private
Definition: mem.h:53
pw_mempool_map_id
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:397
pw_mempool::props
struct pw_properties * props
Definition: mem.h:63
PW_MEMMAP_FLAG_READWRITE
@ PW_MEMMAP_FLAG_READWRITE
Definition: mem.h:54
PW_MEMBLOCK_FLAG_DONT_CLOSE
@ PW_MEMBLOCK_FLAG_DONT_CLOSE
don't close fd
Definition: mem.h:41
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:453
pw_mempool_emit_added
#define pw_mempool_emit_added(p, b)
Definition: mem.c:95
impl
Definition: control.c:33
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:188
pw_map_range::offset
uint32_t offset
offset in first page with start of data
Definition: mem.h:177
pw_memmap::ptr
void * ptr
mapped pointer
Definition: mem.h:82
mapping::link
struct spa_list link
Definition: mem.c:124
mempool::link
struct spa_list link
Definition: mem.c:101
pw_memmap::size
uint32_t size
size in memblock
Definition: mem.h:85
pw_memmap_flags
pw_memmap_flags
Definition: mem.h:47
pw_map::pw_map_insert_new
static uint32_t pw_map_insert_new(struct pw_map *map, void *data)
Insert data in the map.
Definition: map.h:105
mapping::do_unmap
unsigned int do_unmap
Definition: mem.c:123
pw_memmap_free
SPA_EXPORT int pw_memmap_free(struct pw_memmap *map)
Unmap a region.
Definition: mem.c:412
PW_MEMBLOCK_FLAG_SEAL
@ PW_MEMBLOCK_FLAG_SEAL
seal the fd
Definition: mem.h:39
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:584
pw_memmap::flags
uint32_t flags
flags for the mapping on of enum pw_memmap_flags
Definition: mem.h:83
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:756
pw_mempool_find_id
struct pw_memblock * pw_mempool_find_id(struct pw_mempool *pool, uint32_t id)
Find memblock for given id.
Definition: mem.c:730
memmap::this
struct pw_memmap this
Definition: mem.c:130
pw_mempool_events::destroy
void(* destroy)(void *data)
the pool is destroyed
Definition: mem.h:94
F_SEAL_GROW
#define F_SEAL_GROW
Definition: mem.c:87
memblock::memmaps
struct spa_list memmaps
Definition: mem.c:114
pw_mempool_events
Definition: mem.h:89
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:354
memblock::this
struct pw_memblock this
Definition: mem.c:111
mapping::ref
int ref
Definition: mem.c:120
PW_MEMBLOCK_FLAG_WRITABLE
@ PW_MEMBLOCK_FLAG_WRITABLE
memory is writable
Definition: mem.h:38
pw_memblock::fd
int fd
fd
Definition: mem.h:74
pw_map_range::size
uint32_t size
page aligned offset to map
Definition: mem.h:178
mapping::size
uint32_t size
Definition: mem.c:122
pw_memblock::ref
int ref
refcount
Definition: mem.h:71
mapping
Definition: mem.c:118
F_ADD_SEALS
#define F_ADD_SEALS
Definition: mem.c:82
mapping::offset
uint32_t offset
Definition: mem.c:121
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:188
pw_log::pw_log_debug
#define pw_log_debug(...)
pw_log::pw_log_warn
#define pw_log_warn(...)
pw_mempool_import
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:547
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:397
F_SEAL_SEAL
#define F_SEAL_SEAL
Definition: mem.c:85
PW_MEMBLOCK_FLAG_NONE
@ PW_MEMBLOCK_FLAG_NONE
Definition: mem.h:36
F_SEAL_SHRINK
#define F_SEAL_SHRINK
Definition: mem.c:86
pw_mempool_new
struct pw_mempool * pw_mempool_new(struct pw_properties *props)
Create a new memory pool.
Definition: mem.c:135
pw_memblock::map
struct pw_memmap * map
optional map when PW_MEMBLOCK_FLAG_MAP was given
Definition: mem.h:76
NAME
#define NAME
Definition: mem.c:44
pw_mempool_emit_removed
#define pw_mempool_emit_removed(p, b)
Definition: mem.c:96
pw_mempool_clear
void pw_mempool_clear(struct pw_mempool *pool)
Clear a pool.
Definition: mem.c:160
pw_map::pw_map_clear
static void pw_map_clear(struct pw_map *map)
Clear a map.
Definition: map.h:87
pw_mempool_import_block
struct pw_memblock * pw_mempool_import_block(struct pw_mempool *pool, struct pw_memblock *mem)
Import a block from another pool.
Definition: mem.c:584
map.h
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:647
pw_memmap::offset
uint32_t offset
offset in memblock
Definition: mem.h:84
pw_memblock::pw_memblock_free
SPA_EXPORT void pw_memblock_free(struct pw_memblock *block)
Free a memblock.
Definition: mem.c:671
pw_memblock
Definition: mem.h:68
pw_mempool_import_map
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:595
pw_memmap::tag
uint32_t tag[5]
user tag
Definition: mem.h:86
log.h
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:547
mempool::map
struct pw_map map
Definition: mem.c:105
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:744
PW_MEMBLOCK_FLAG_READABLE
@ PW_MEMBLOCK_FLAG_READABLE
memory is readable
Definition: mem.h:37
PW_MEMMAP_FLAG_NONE
@ PW_MEMMAP_FLAG_NONE
Definition: mem.h:48
pw_mempool_new
struct pw_mempool * pw_mempool_new(struct pw_properties *props)
Create a new memory pool.
Definition: mem.c:135
pw_mempool_emit_destroy
#define pw_mempool_emit_destroy(p)
Definition: mem.c:94
mempool::listener_list
struct spa_hook_list listener_list
Definition: mem.c:103
mempool::this
struct pw_mempool this
Definition: mem.c:99
impl::this
struct pw_control this
Definition: control.c:34
pw_map
A map.
Definition: map.h:50
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:647
pw_memmap_free
int pw_memmap_free(struct pw_memmap *map)
Unmap a region.
Definition: mem.c:412
mem.h
properties.h
PW_MEMMAP_FLAG_TWICE
@ PW_MEMMAP_FLAG_TWICE
map the same area twice afer eachother, creating a circular ringbuffer
Definition: mem.h:51
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:730
pw_memblock_map
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:354
memblock::mappings
struct spa_list mappings
Definition: mem.c:113
pw_memblock::type
uint32_t type
type of the fd, one of enum spa_data_type
Definition: mem.h:73
pw_properties
A collection of key/value pairs.
Definition: properties.h:45
pw_properties::pw_properties_free
SPA_EXPORT void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition: properties.c:335
pw_mempool_find_tag
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:756