Go to the documentation of this file.
25 #ifndef PIPEWIRE_MEM_H
26 #define PIPEWIRE_MEM_H
91 #define PW_VERSION_MEMPOOL_EVENTS 0
109 struct spa_hook *listener,
136 static inline void pw_memblock_unref(
struct pw_memblock *mem)
182 #define PW_MAP_RANGE_INIT (struct pw_map_range){ 0, }
186 static inline void pw_map_range_init(
struct pw_map_range *range,
187 uint32_t offset, uint32_t size,
190 range->
offset = SPA_ROUND_DOWN_N(offset, page_size);
192 range->
size = SPA_ROUND_UP_N(range->
start + size, page_size);
parameters to map a memory range
Definition: mem.h:176
@ PW_MEMBLOCK_FLAG_READWRITE
Definition: mem.h:44
static uint32_t int int res
Definition: core.h:326
uint32_t version
Definition: mem.h:92
struct pw_mempool * pool
owner pool
Definition: mem.h:70
struct spa_list link
Definition: mem.c:130
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:612
a mapped region of a pw_memblock
Definition: mem.h:81
struct spa_list link
Definition: mem.c:110
@ PW_MEMMAP_FLAG_WRITE
map in write mode
Definition: mem.h:50
struct mapping * mapping
Definition: mem.c:129
void(* added)(void *data, struct pw_memblock *block)
a new memory block is added to the pool
Definition: mem.h:98
void(* removed)(void *data, struct pw_memblock *block)
a memory block is removed from the pool
Definition: mem.h:101
static void * pw_map_lookup(struct pw_map *map, uint32_t id)
Find an item in the map.
Definition: map.h:169
static void pw_map_remove(struct pw_map *map, uint32_t id)
Remove an item at index.
Definition: map.h:157
void * ptr
Definition: mem.c:123
#define MFD_CLOEXEC
Definition: mem.c:66
uint32_t start
Definition: mem.h:177
void pw_mempool_destroy(struct pw_mempool *pool)
Clear and destroy a pool.
Definition: mem.c:170
uint32_t id
unique id
Definition: mem.h:71
#define pw_log_error(...)
Log an error message.
#define MFD_ALLOW_SEALING
Definition: mem.c:70
struct spa_list blocks
Definition: mem.c:104
struct pw_memblock * pw_mempool_find_fd(struct pw_mempool *pool, int fd)
Find memblock for given fd.
Definition: mem.c:761
void pw_mempool_destroy(struct pw_mempool *pool)
Clear and destroy a pool.
Definition: mem.c:170
@ PW_MEMBLOCK_FLAG_MAP
mmap the fd
Definition: mem.h:40
static void pw_map_init(struct pw_map *map, size_t size, size_t extend)
Initialize a map.
Definition: map.h:76
struct pw_memblock * block
owner memblock
Definition: mem.h:82
@ PW_MEMBLOCK_FLAG_DONT_NOTIFY
don't notify events
Definition: mem.h:42
struct pw_memblock * pw_mempool_find_ptr(struct pw_mempool *pool, const void *ptr)
Find memblock for given ptr.
Definition: mem.c:728
pw_memblock_flags
Flags passed to pw_mempool_alloc()
Definition: mem.h:35
void pw_mempool_clear(struct pw_mempool *pool)
Clear a pool.
Definition: mem.c:158
uint32_t pagesize
Definition: mem.c:105
struct memblock * block
Definition: mem.c:117
SPA_EXPORT struct pw_memblock * pw_mempool_find_ptr(struct pw_mempool *pool, const void *ptr)
Find memblock for given ptr.
Definition: mem.c:728
uint32_t size
size of memory
Definition: mem.h:76
@ PW_MEMMAP_FLAG_READ
map in read mode
Definition: mem.h:49
uint32_t flags
flags for the memory block on of enum pw_memblock_flags
Definition: mem.h:73
@ PW_MEMMAP_FLAG_PRIVATE
writes will be private
Definition: mem.h:53
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:407
struct pw_properties * props
Definition: mem.h:64
@ PW_MEMMAP_FLAG_READWRITE
Definition: mem.h:55
@ PW_MEMBLOCK_FLAG_DONT_CLOSE
don't close fd
Definition: mem.h:41
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:463
#define pw_mempool_emit_added(p, b)
Definition: mem.c:93
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:191
uint32_t offset
offset in first page with start of data
Definition: mem.h:178
void * ptr
mapped pointer
Definition: mem.h:83
struct spa_list link
Definition: mem.c:122
struct spa_list link
Definition: mem.c:99
uint32_t size
size in memblock
Definition: mem.h:86
pw_memmap_flags
Definition: mem.h:47
static uint32_t pw_map_insert_new(struct pw_map *map, void *data)
Insert data in the map.
Definition: map.h:105
unsigned int do_unmap
Definition: mem.c:121
SPA_EXPORT int pw_memmap_free(struct pw_memmap *map)
Unmap a region.
Definition: mem.c:422
@ PW_MEMBLOCK_FLAG_SEAL
seal the fd
Definition: mem.h:39
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:601
uint32_t flags
flags for the mapping on of enum pw_memmap_flags
Definition: mem.h:84
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:773
struct pw_memblock * pw_mempool_find_id(struct pw_mempool *pool, uint32_t id)
Find memblock for given id.
Definition: mem.c:747
struct pw_memmap this
Definition: mem.c:128
void(* destroy)(void *data)
the pool is destroyed
Definition: mem.h:95
#define F_SEAL_GROW
Definition: mem.c:85
struct spa_list memmaps
Definition: mem.c:112
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:360
struct pw_memblock this
Definition: mem.c:109
int ref
Definition: mem.c:118
@ PW_MEMBLOCK_FLAG_WRITABLE
memory is writable
Definition: mem.h:38
int fd
fd
Definition: mem.h:75
uint32_t size
page aligned offset to map
Definition: mem.h:179
uint32_t size
Definition: mem.c:120
int ref
refcount
Definition: mem.h:72
#define F_ADD_SEALS
Definition: mem.c:80
uint32_t offset
Definition: mem.c:119
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:191
#define pw_log_debug(...)
Log a debug message.
#define pw_log_warn(...)
Log a warning message.
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:564
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:407
#define F_SEAL_SEAL
Definition: mem.c:83
@ PW_MEMBLOCK_FLAG_NONE
Definition: mem.h:36
#define F_SEAL_SHRINK
Definition: mem.c:84
struct pw_mempool * pw_mempool_new(struct pw_properties *props)
Create a new memory pool.
Definition: mem.c:133
struct pw_memmap * map
optional map when PW_MEMBLOCK_FLAG_MAP was given
Definition: mem.h:77
#define NAME
Definition: mem.c:44
#define pw_mempool_emit_removed(p, b)
Definition: mem.c:94
void pw_mempool_clear(struct pw_mempool *pool)
Clear a pool.
Definition: mem.c:158
static void pw_map_clear(struct pw_map *map)
Clear a map.
Definition: map.h:87
struct pw_memblock * pw_mempool_import_block(struct pw_mempool *pool, struct pw_memblock *mem)
Import a block from another pool.
Definition: mem.c:601
int pw_mempool_remove_id(struct pw_mempool *pool, uint32_t id)
Remove a memblock for given id.
Definition: mem.c:664
uint32_t offset
offset in memblock
Definition: mem.h:85
SPA_EXPORT void pw_memblock_free(struct pw_memblock *block)
Free a memblock.
Definition: mem.c:688
A memory pool is a collection of pw_memblocks.
Definition: mem.h:69
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:612
uint32_t tag[5]
user tag
Definition: mem.h:87
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:564
struct pw_map map
Definition: mem.c:103
SPA_EXPORT struct pw_memblock * pw_mempool_find_fd(struct pw_mempool *pool, int fd)
Find memblock for given fd.
Definition: mem.c:761
@ PW_MEMBLOCK_FLAG_READABLE
memory is readable
Definition: mem.h:37
@ PW_MEMMAP_FLAG_NONE
Definition: mem.h:48
struct pw_mempool * pw_mempool_new(struct pw_properties *props)
Create a new memory pool.
Definition: mem.c:133
#define pw_mempool_emit_destroy(p)
Definition: mem.c:92
struct spa_hook_list listener_list
Definition: mem.c:101
struct pw_mempool this
Definition: mem.c:97
struct pw_control this
Definition: control.c:34
A map.
Definition: map.h:50
int pw_mempool_remove_id(struct pw_mempool *pool, uint32_t id)
Remove a memblock for given id.
Definition: mem.c:664
int pw_memmap_free(struct pw_memmap *map)
Unmap a region.
Definition: mem.c:422
@ PW_MEMMAP_FLAG_TWICE
map the same area twice after each other, creating a circular ringbuffer
Definition: mem.h:51
SPA_EXPORT struct pw_memblock * pw_mempool_find_id(struct pw_mempool *pool, uint32_t id)
Find memblock for given id.
Definition: mem.c:747
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:360
struct spa_list mappings
Definition: mem.c:111
@ PW_MEMMAP_FLAG_LOCKED
lock the memory into RAM
Definition: mem.h:54
uint32_t type
type of the fd, one of enum spa_data_type
Definition: mem.h:74
A collection of key/value pairs.
Definition: properties.h:45
SPA_EXPORT void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition: properties.c:356
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:773