PipeWire 1.2.6

Loading...
Searching...
No Matches
mem.h
Go to the documentation of this file.
1/* PipeWire */
2/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
3/* SPDX-License-Identifier: MIT */
4
5#ifndef PIPEWIRE_MEM_H
6#define PIPEWIRE_MEM_H
7
8#include <pipewire/properties.h>
9
10#ifdef __cplusplus
11 extern "C" {
12#endif
13
24 enum pw_memblock_flags {
25 PW_MEMBLOCK_FLAG_NONE = 0,
26 PW_MEMBLOCK_FLAG_READABLE = (1 << 0),
27 PW_MEMBLOCK_FLAG_WRITABLE = (1 << 1),
28 PW_MEMBLOCK_FLAG_SEAL = (1 << 2),
29 PW_MEMBLOCK_FLAG_MAP = (1 << 3),
30 PW_MEMBLOCK_FLAG_DONT_CLOSE = (1 << 4),
31 PW_MEMBLOCK_FLAG_DONT_NOTIFY = (1 << 5),
32 PW_MEMBLOCK_FLAG_UNMAPPABLE = (1 << 6),
34 PW_MEMBLOCK_FLAG_READWRITE = PW_MEMBLOCK_FLAG_READABLE | PW_MEMBLOCK_FLAG_WRITABLE,
35};
36
37 enum pw_memmap_flags {
38 PW_MEMMAP_FLAG_NONE = 0,
39 PW_MEMMAP_FLAG_READ = (1 << 0),
40 PW_MEMMAP_FLAG_WRITE = (1 << 1),
41 PW_MEMMAP_FLAG_TWICE = (1 << 2),
43 PW_MEMMAP_FLAG_PRIVATE = (1 << 3),
44 PW_MEMMAP_FLAG_LOCKED = (1 << 4),
45 PW_MEMMAP_FLAG_READWRITE = PW_MEMMAP_FLAG_READ | PW_MEMMAP_FLAG_WRITE,
46};
47
48 struct pw_memchunk;
49
53 struct pw_mempool {
54 struct pw_properties *props;
55};
56
59 struct pw_memblock {
60 struct pw_mempool *pool;
61 uint32_t id;
62 int ref;
63 uint32_t flags;
64 uint32_t type;
65 int fd;
66 uint32_t size;
67 struct pw_memmap *map;
68};
69
71 struct pw_memmap {
72 struct pw_memblock *block;
73 void *ptr;
74 uint32_t flags;
75 uint32_t offset;
76 uint32_t size;
77 uint32_t tag[5];
78};
79
80 struct pw_mempool_events {
81#define PW_VERSION_MEMPOOL_EVENTS 0
82 uint32_t version;
83
85 void (*destroy) (void *data);
86
88 void (*added) (void *data, struct pw_memblock *block);
89
91 void (*removed) (void *data, struct pw_memblock *block);
92};
93
95 struct pw_mempool *pw_mempool_new(struct pw_properties *props);
96
98 void pw_mempool_add_listener(struct pw_mempool *pool,
99 struct spa_hook *listener,
100 const struct pw_mempool_events *events,
101 void *data);
102
104 void pw_mempool_clear(struct pw_mempool *pool);
105
107 void pw_mempool_destroy(struct pw_mempool *pool);
108
109
111 struct pw_memblock * pw_mempool_alloc(struct pw_mempool *pool,
112 enum pw_memblock_flags flags, uint32_t type, size_t size);
113
115 struct pw_memblock * pw_mempool_import_block(struct pw_mempool *pool,
116 struct pw_memblock *mem);
117
119 struct pw_memblock * pw_mempool_import(struct pw_mempool *pool,
120 enum pw_memblock_flags flags, uint32_t type, int fd);
121
123 void pw_memblock_free(struct pw_memblock *mem);
124
126 static inline void pw_memblock_unref(struct pw_memblock *mem)
127{
128 if (--mem->ref == 0)
129 pw_memblock_free(mem);
130}
131
133 int pw_mempool_remove_id(struct pw_mempool *pool, uint32_t id);
134
136 struct pw_memblock * pw_mempool_find_ptr(struct pw_mempool *pool, const void *ptr);
137
139 struct pw_memblock * pw_mempool_find_id(struct pw_mempool *pool, uint32_t id);
140
142 struct pw_memblock * pw_mempool_find_fd(struct pw_mempool *pool, int fd);
143
144
146 struct pw_memmap * pw_memblock_map(struct pw_memblock *block,
147 enum pw_memmap_flags flags, uint32_t offset, uint32_t size,
148 uint32_t tag[5]);
149
151 struct pw_memmap * pw_mempool_map_id(struct pw_mempool *pool, uint32_t id,
152 enum pw_memmap_flags flags, uint32_t offset, uint32_t size,
153 uint32_t tag[5]);
154
155 struct pw_memmap * pw_mempool_import_map(struct pw_mempool *pool,
156 struct pw_mempool *other, void *data, uint32_t size, uint32_t tag[5]);
157
159 struct pw_memmap * pw_mempool_find_tag(struct pw_mempool *pool, uint32_t tag[5], size_t size);
160
162 int pw_memmap_free(struct pw_memmap *map);
163
164
166 struct pw_map_range {
167 uint32_t start;
168 uint32_t offset;
169 uint32_t size;
170};
171
172#define PW_MAP_RANGE_INIT (struct pw_map_range){ 0, }
173
176 static inline void pw_map_range_init(struct pw_map_range *range,
177 uint32_t offset, uint32_t size,
178 uint32_t page_size)
179{
180 range->offset = SPA_ROUND_DOWN_N(offset, page_size);
181 range->start = offset - range->offset;
182 range->size = SPA_ROUND_UP_N(range->start + size, page_size);
183}
184
189#ifdef __cplusplus
190}
191#endif
192
193#endif /* PIPEWIRE_MEM_H */
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:913
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:645
pw_memmap_flags
pw_memmap_flags
Definition mem.h:41
pw_mempool_alloc
struct pw_memblock * pw_mempool_alloc(struct pw_mempool *pool, enum pw_memblock_flags flags, uint32_t type, size_t size)
Allocate a memory block from the pool.
Definition mem.c:522
pw_mempool_new
struct pw_mempool * pw_mempool_new(struct pw_properties *props)
Create a new memory pool.
Definition mem.c:156
pw_memmap_free
int pw_memmap_free(struct pw_memmap *map)
Unmap a region.
Definition mem.c:474
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:795
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:710
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:211
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:459
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:742
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:901
pw_memblock_unref
static void pw_memblock_unref(struct pw_memblock *mem)
Unref a memblock.
Definition mem.h:132
pw_map_range_init
static void pw_map_range_init(struct pw_map_range *range, uint32_t offset, uint32_t size, uint32_t page_size)
Calculate parameters to mmap() memory into range so that size bytes at offset can be mapped with mmap...
Definition mem.h:183
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:887
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:868
pw_mempool_clear
void pw_mempool_clear(struct pw_mempool *pool)
Clear a pool.
Definition mem.c:180
pw_memblock_free
void pw_memblock_free(struct pw_memblock *mem)
Free a memblock regardless of the refcount and destroy all mappings.
Definition mem.c:818
pw_memblock_flags
pw_memblock_flags
Flags passed to pw_mempool_alloc()
Definition mem.h:28
pw_mempool_destroy
void pw_mempool_destroy(struct pw_mempool *pool)
Clear and destroy a pool.
Definition mem.c:193
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:389
PW_MEMMAP_FLAG_LOCKED
@ PW_MEMMAP_FLAG_LOCKED
lock the memory into RAM
Definition mem.h:48
PW_MEMMAP_FLAG_READ
@ PW_MEMMAP_FLAG_READ
map in read mode
Definition mem.h:43
PW_MEMMAP_FLAG_READWRITE
@ PW_MEMMAP_FLAG_READWRITE
Definition mem.h:49
PW_MEMMAP_FLAG_WRITE
@ PW_MEMMAP_FLAG_WRITE
map in write mode
Definition mem.h:44
PW_MEMMAP_FLAG_NONE
@ PW_MEMMAP_FLAG_NONE
Definition mem.h:42
PW_MEMMAP_FLAG_TWICE
@ PW_MEMMAP_FLAG_TWICE
map the same area twice after each other, creating a circular ringbuffer
Definition mem.h:45
PW_MEMMAP_FLAG_PRIVATE
@ PW_MEMMAP_FLAG_PRIVATE
writes will be private
Definition mem.h:47
PW_MEMBLOCK_FLAG_READWRITE
@ PW_MEMBLOCK_FLAG_READWRITE
Definition mem.h:38
PW_MEMBLOCK_FLAG_MAP
@ PW_MEMBLOCK_FLAG_MAP
mmap the fd
Definition mem.h:33
PW_MEMBLOCK_FLAG_DONT_NOTIFY
@ PW_MEMBLOCK_FLAG_DONT_NOTIFY
don't notify events
Definition mem.h:35
PW_MEMBLOCK_FLAG_READABLE
@ PW_MEMBLOCK_FLAG_READABLE
memory is readable
Definition mem.h:30
PW_MEMBLOCK_FLAG_SEAL
@ PW_MEMBLOCK_FLAG_SEAL
seal the fd
Definition mem.h:32
PW_MEMBLOCK_FLAG_WRITABLE
@ PW_MEMBLOCK_FLAG_WRITABLE
memory is writable
Definition mem.h:31
PW_MEMBLOCK_FLAG_NONE
@ PW_MEMBLOCK_FLAG_NONE
Definition mem.h:29
PW_MEMBLOCK_FLAG_UNMAPPABLE
@ PW_MEMBLOCK_FLAG_UNMAPPABLE
the fd can not be mmapped
Definition mem.h:36
PW_MEMBLOCK_FLAG_DONT_CLOSE
@ PW_MEMBLOCK_FLAG_DONT_CLOSE
don't close fd
Definition mem.h:34
SPA_ROUND_UP_N
#define SPA_ROUND_UP_N(num, align)
Definition defs.h:342
SPA_ROUND_DOWN_N
#define SPA_ROUND_DOWN_N(num, align)
Definition defs.h:340
properties.h
pipewire/properties.h
pw_map_range
parameters to map a memory range
Definition mem.h:172
pw_map_range::size
uint32_t size
page aligned offset to map
Definition mem.h:175
pw_map_range::offset
uint32_t offset
offset in first page with start of data
Definition mem.h:174
pw_memblock
Memory block structure.
Definition mem.h:64
pw_memblock::id
uint32_t id
unique id
Definition mem.h:66
pw_memblock::fd
int fd
fd
Definition mem.h:70
pw_memblock::pool
struct pw_mempool * pool
owner pool
Definition mem.h:65
pw_memblock::flags
uint32_t flags
flags for the memory block on of enum pw_memblock_flags
Definition mem.h:68
pw_memblock::size
uint32_t size
size of memory
Definition mem.h:71
pw_memblock::type
uint32_t type
type of the fd, one of enum spa_data_type
Definition mem.h:69
pw_memblock::ref
int ref
refcount
Definition mem.h:67
pw_memblock::map
struct pw_memmap * map
optional map when PW_MEMBLOCK_FLAG_MAP was given
Definition mem.h:72
pw_memchunk
pw_memmap
a mapped region of a pw_memblock
Definition mem.h:76
pw_memmap::offset
uint32_t offset
offset in memblock
Definition mem.h:80
pw_memmap::ptr
void * ptr
mapped pointer
Definition mem.h:78
pw_memmap::flags
uint32_t flags
flags for the mapping on of enum pw_memmap_flags
Definition mem.h:79
pw_memmap::size
uint32_t size
size in memblock
Definition mem.h:81
pw_memmap::block
struct pw_memblock * block
owner memblock
Definition mem.h:77
pw_memmap::tag
uint32_t tag[5]
user tag
Definition mem.h:82
pw_mempool_events
Definition mem.h:85
pw_mempool_events::removed
void(* removed)(void *data, struct pw_memblock *block)
a memory block is removed from the pool
Definition mem.h:97
pw_mempool_events::destroy
void(* destroy)(void *data)
the pool is destroyed
Definition mem.h:91
pw_mempool_events::added
void(* added)(void *data, struct pw_memblock *block)
a new memory block is added to the pool
Definition mem.h:94
pw_mempool_events::version
uint32_t version
Definition mem.h:88
pw_mempool
A memory pool is a collection of pw_memblocks.
Definition mem.h:58
pw_properties
Definition properties.h:34
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition hook.h:350