Go to the documentation of this file.
25 #ifndef PIPEWIRE_MEM_H
26 #define PIPEWIRE_MEM_H
100 #define PW_VERSION_MEMPOOL_EVENTS 0
145 static inline void pw_memblock_unref(
struct pw_memblock *mem)
191 #define PW_MAP_RANGE_INIT (struct pw_map_range){ 0, }
195 static inline void pw_map_range_init(
struct pw_map_range *range,
196 uint32_t offset, uint32_t size,
parameters to map a memory range
Definition: src/pipewire/mem.h:185
uint32_t version
Definition: src/pipewire/mem.h:101
struct pw_mempool * pool
owner pool
Definition: src/pipewire/mem.h:79
A memory pool is a collection of pw_memblocks.
Definition: src/pipewire/mem.h:72
struct spa_list link
Definition: mem.c:134
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
a mapped region of a pw_memblock
Definition: src/pipewire/mem.h:90
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
struct spa_list link
Definition: mem.c:114
struct mapping * mapping
Definition: mem.c:133
void(* added)(void *data, struct pw_memblock *block)
a new memory block is added to the pool
Definition: src/pipewire/mem.h:107
void(* removed)(void *data, struct pw_memblock *block)
a memory block is removed from the pool
Definition: src/pipewire/mem.h:110
void * ptr
Definition: mem.c:127
#define MFD_CLOEXEC
Definition: mem.c:70
struct pw_mempool * pw_mempool_new(struct pw_properties *props)
Create a new memory pool.
Definition: mem.c:137
uint32_t start
Definition: src/pipewire/mem.h:186
uint32_t id
unique id
Definition: src/pipewire/mem.h:80
@ PW_MEMMAP_FLAG_NONE
Definition: src/pipewire/mem.h:57
@ PW_MEMBLOCK_FLAG_READWRITE
Definition: src/pipewire/mem.h:53
#define MFD_ALLOW_SEALING
Definition: mem.c:74
struct spa_list blocks
Definition: mem.c:108
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
writes will be private
Definition: src/pipewire/mem.h:62
void pw_mempool_destroy(struct pw_mempool *pool)
Clear and destroy a pool.
Definition: mem.c:174
struct pw_memblock * block
owner memblock
Definition: src/pipewire/mem.h:91
uint32_t pagesize
Definition: mem.c:109
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
struct memblock * block
Definition: mem.c:121
#define spa_list_for_each(pos, head, member)
Definition: list.h:111
uint32_t size
size of memory
Definition: src/pipewire/mem.h:85
uint32_t flags
flags for the memory block on of enum pw_memblock_flags
Definition: src/pipewire/mem.h:82
#define SPA_ROUND_DOWN_N(num, align)
Definition: defs.h:220
@ PW_MEMBLOCK_FLAG_NONE
Definition: src/pipewire/mem.h:45
struct pw_properties * props
Definition: src/pipewire/mem.h:73
#define SPA_EXPORT
Definition: defs.h:207
#define pw_log_debug(...)
Definition: src/pipewire/log.h:89
@ PW_MEMBLOCK_FLAG_WRITABLE
memory is writable
Definition: src/pipewire/mem.h:47
@ PW_MEMMAP_FLAG_WRITE
map in write mode
Definition: src/pipewire/mem.h:59
#define SPA_ROUND_UP_N(num, align)
Definition: defs.h:221
@ PW_MEMMAP_FLAG_LOCKED
lock the memory into RAM
Definition: src/pipewire/mem.h:63
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
#define pw_mempool_emit_added(p, b)
Definition: mem.c:97
void spa_hook_list_init(struct spa_hook_list *list)
Initialize a hook list.
Definition: hook.h:86
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
uint32_t offset
offset in first page with start of data
Definition: src/pipewire/mem.h:187
@ PW_MEMMAP_FLAG_READWRITE
Definition: src/pipewire/mem.h:64
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
void * ptr
mapped pointer
Definition: src/pipewire/mem.h:92
#define SPA_PTRDIFF(p1, p2)
Definition: defs.h:172
#define SPA_PTROFF(ptr_, offset_, type_)
Return the address (buffer + offset) as pointer of type.
Definition: defs.h:159
struct spa_list link
Definition: mem.c:126
struct spa_list link
Definition: mem.c:103
uint32_t size
size in memblock
Definition: src/pipewire/mem.h:95
static uint32_t int int res
Definition: core.h:329
@ PW_MEMBLOCK_FLAG_DONT_NOTIFY
don't notify events
Definition: src/pipewire/mem.h:51
unsigned int do_unmap
Definition: mem.c:125
#define SPA_CONTAINER_OF(p, t, m)
Definition: defs.h:170
#define spa_list_consume(pos, head, member)
Definition: list.h:96
void pw_mempool_clear(struct pw_mempool *pool)
Clear a pool.
Definition: mem.c:162
uint32_t flags
flags for the mapping on of enum pw_memmap_flags
Definition: src/pipewire/mem.h:93
#define pw_log_error(...)
Definition: src/pipewire/log.h:86
struct pw_memmap this
Definition: mem.c:132
void(* destroy)(void *data)
the pool is destroyed
Definition: src/pipewire/mem.h:104
#define SPA_LIST_INIT(list)
Definition: list.h:42
#define F_SEAL_GROW
Definition: mem.c:89
struct spa_list memmaps
Definition: mem.c:116
Definition: src/pipewire/mem.h:99
struct pw_memblock this
Definition: mem.c:113
void spa_list_remove(struct spa_list *elem)
Definition: list.h:69
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
int ref
Definition: mem.c:122
int fd
fd
Definition: src/pipewire/mem.h:84
uint32_t size
page aligned offset to map
Definition: src/pipewire/mem.h:188
uint32_t size
Definition: mem.c:124
int ref
refcount
Definition: src/pipewire/mem.h:81
#define F_ADD_SEALS
Definition: mem.c:84
@ PW_MEMBLOCK_FLAG_SEAL
seal the fd
Definition: src/pipewire/mem.h:48
uint32_t offset
Definition: mem.c:123
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:76
#define F_SEAL_SEAL
Definition: mem.c:87
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
#define F_SEAL_SHRINK
Definition: mem.c:88
@ PW_MEMBLOCK_FLAG_MAP
mmap the fd
Definition: src/pipewire/mem.h:49
#define SPA_FLAG_IS_SET(field, flag)
Definition: defs.h:73
struct pw_memmap * map
optional map when PW_MEMBLOCK_FLAG_MAP was given
Definition: src/pipewire/mem.h:86
void spa_list_init(struct spa_list *list)
Definition: list.h:44
#define NAME
Definition: mem.c:44
#define pw_mempool_emit_removed(p, b)
Definition: mem.c:98
SPA_EXPORT int pw_memmap_free(struct pw_memmap *map)
Unmap a region.
Definition: mem.c:425
@ PW_MEMMAP_FLAG_READ
map in read mode
Definition: src/pipewire/mem.h:58
int pw_mempool_remove_id(struct pw_mempool *pool, uint32_t id)
Remove a memblock for given id.
Definition: mem.c:675
uint32_t offset
offset in memblock
Definition: src/pipewire/mem.h:94
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
SPA_EXPORT void pw_memblock_free(struct pw_memblock *block)
Free a memblock.
Definition: mem.c:699
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
Memory block structure.
Definition: src/pipewire/mem.h:78
uint32_t tag[5]
user tag
Definition: src/pipewire/mem.h:96
struct pw_map map
Definition: mem.c:107
pw_memmap_flags
Definition: src/pipewire/mem.h:56
#define SPA_ID_INVALID
Definition: defs.h:182
pw_memblock_flags
Flags passed to pw_mempool_alloc()
Definition: src/pipewire/mem.h:44
A list of hooks.
Definition: hook.h:48
@ PW_MEMBLOCK_FLAG_READABLE
memory is readable
Definition: src/pipewire/mem.h:46
#define pw_mempool_emit_destroy(p)
Definition: mem.c:96
struct spa_hook_list listener_list
Definition: mem.c:105
struct pw_mempool this
Definition: mem.c:101
struct pw_control this
Definition: control.c:34
A map.
Definition: map.h:55
@ PW_MEMMAP_FLAG_TWICE
map the same area twice after each other, creating a circular ringbuffer
Definition: src/pipewire/mem.h:60
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
don't close fd
Definition: src/pipewire/mem.h:50
struct spa_list mappings
Definition: mem.c:115
uint32_t type
type of the fd, one of enum spa_data_type
Definition: src/pipewire/mem.h:83
Definition: properties.h:49
SPA_EXPORT void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition: properties.c:386
#define spa_return_if_fail(expr)
Definition: defs.h:240
void spa_hook_list_clean(struct spa_hook_list *list)
Definition: hook.h:124
#define spa_list_append(list, item)
Definition: list.h:81
#define pw_log_warn(...)
Definition: src/pipewire/log.h:87