Go to the documentation of this file.
25 #ifndef PIPEWIRE_MEM_H
26 #define PIPEWIRE_MEM_H
86 #define PW_VERSION_MEMPOOL_EVENTS 0
104 struct spa_hook *listener,
131 static inline void pw_memblock_unref(
struct pw_memblock *mem)
177 #define PW_MAP_RANGE_INIT (struct pw_map_range){ 0, }
181 static inline void pw_map_range_init(
struct pw_map_range *range,
182 uint32_t offset, uint32_t size,
185 range->
offset = SPA_ROUND_DOWN_N(offset, page_size);
187 range->
size = SPA_ROUND_UP_N(range->
start + size, page_size);
parameters to map a memory range
Definition: mem.h:171
@ PW_MEMBLOCK_FLAG_READWRITE
Definition: mem.h:43
static uint32_t int int res
Definition: core.h:323
uint32_t version
Definition: mem.h:87
struct pw_mempool * pool
owner pool
Definition: mem.h:65
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:578
a mapped region of a pw_memblock
Definition: mem.h:76
struct spa_list link
Definition: mem.c:112
@ PW_MEMMAP_FLAG_WRITE
map in write mode
Definition: mem.h:49
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:93
void(* removed)(void *data, struct pw_memblock *block)
a memory block is removed from the pool
Definition: mem.h:96
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:124
#define MFD_CLOEXEC
Definition: mem.c:68
uint32_t start
Definition: mem.h:172
void pw_mempool_destroy(struct pw_mempool *pool)
Clear and destroy a pool.
Definition: mem.c:167
uint32_t id
unique id
Definition: mem.h:66
#define pw_log_error(...)
#define MFD_ALLOW_SEALING
Definition: mem.c:72
struct spa_list blocks
Definition: mem.c:106
struct pw_memblock * pw_mempool_find_fd(struct pw_mempool *pool, int fd)
Find memblock for given fd.
Definition: mem.c:716
void pw_mempool_destroy(struct pw_mempool *pool)
Clear and destroy a pool.
Definition: mem.c:167
@ PW_MEMBLOCK_FLAG_MAP
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:77
struct pw_memblock * pw_mempool_find_ptr(struct pw_mempool *pool, const void *ptr)
Find memblock for given ptr.
Definition: mem.c:683
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:107
struct memblock * block
Definition: mem.c:118
SPA_EXPORT struct pw_memblock * pw_mempool_find_ptr(struct pw_mempool *pool, const void *ptr)
Find memblock for given ptr.
Definition: mem.c:683
uint32_t size
size of memory
Definition: mem.h:71
@ PW_MEMMAP_FLAG_READ
map in read mode
Definition: mem.h:48
uint32_t flags
flags for the memory block on of enum pw_memblock_flags
Definition: mem.h:68
@ PW_MEMMAP_FLAG_PRIVATE
writes will be private
Definition: mem.h:52
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:384
struct pw_properties * props
Definition: mem.h:59
@ PW_MEMMAP_FLAG_READWRITE
Definition: mem.h:53
@ PW_MEMBLOCK_FLAG_DONT_CLOSE
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:440
#define pw_mempool_emit_added(p, b)
Definition: mem.c:95
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:186
uint32_t offset
offset in first page with start of data
Definition: mem.h:173
void * ptr
mapped pointer
Definition: mem.h:78
struct spa_list maps
Definition: mem.c:114
struct spa_list link
Definition: mem.c:123
struct spa_list link
Definition: mem.c:101
uint32_t size
size in memblock
Definition: mem.h:81
pw_memmap_flags
Definition: mem.h:46
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:122
SPA_EXPORT int pw_memmap_free(struct pw_memmap *map)
Unmap a region.
Definition: mem.c:399
@ PW_MEMBLOCK_FLAG_SEAL
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:569
uint32_t flags
flags for the mapping on of enum pw_memmap_flags
Definition: mem.h:79
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:728
struct pw_memblock * pw_mempool_find_id(struct pw_mempool *pool, uint32_t id)
Find memblock for given id.
Definition: mem.c:702
struct pw_memmap this
Definition: mem.c:128
void(* destroy)(void *data)
the pool is destroyed
Definition: mem.h:90
#define F_SEAL_GROW
Definition: mem.c:87
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:341
struct pw_memblock this
Definition: mem.c:111
int ref
Definition: mem.c:119
@ PW_MEMBLOCK_FLAG_WRITABLE
Definition: mem.h:38
int fd
fd
Definition: mem.h:70
uint32_t size
page aligned offset to map
Definition: mem.h:174
uint32_t size
Definition: mem.c:121
int ref
refcount
Definition: mem.h:67
#define F_ADD_SEALS
Definition: mem.c:82
uint32_t offset
Definition: mem.c:120
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:186
#define pw_log_debug(...)
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:533
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:384
#define F_SEAL_SEAL
Definition: mem.c:85
@ PW_MEMBLOCK_FLAG_NONE
Definition: mem.h:36
#define F_SEAL_SHRINK
Definition: mem.c:86
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:72
#define NAME
Definition: mem.c:44
#define pw_mempool_emit_removed(p, b)
Definition: mem.c:96
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:569
int pw_mempool_remove_id(struct pw_mempool *pool, uint32_t id)
Remove a memblock for given id.
Definition: mem.c:626
uint32_t offset
offset in memblock
Definition: mem.h:80
SPA_EXPORT void pw_memblock_free(struct pw_memblock *block)
Free a memblock.
Definition: mem.c:650
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:578
uint32_t tag[5]
user tag
Definition: mem.h:82
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:533
struct pw_map map
Definition: mem.c:105
SPA_EXPORT struct pw_memblock * pw_mempool_find_fd(struct pw_mempool *pool, int fd)
Find memblock for given fd.
Definition: mem.c:716
@ PW_MEMBLOCK_FLAG_READABLE
Definition: mem.h:37
@ PW_MEMMAP_FLAG_NONE
Definition: mem.h:47
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:94
struct spa_hook_list listener_list
Definition: mem.c:103
struct pw_mempool this
Definition: mem.c:99
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:626
int pw_memmap_free(struct pw_memmap *map)
Unmap a region.
Definition: mem.c:399
@ PW_MEMMAP_FLAG_TWICE
map the same area twice afer eachother, creating a circular ringbuffer
Definition: mem.h:50
SPA_EXPORT struct pw_memblock * pw_mempool_find_id(struct pw_mempool *pool, uint32_t id)
Find memblock for given id.
Definition: mem.c:702
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:341
struct spa_list mappings
Definition: mem.c:113
uint32_t type
type of the fd, one of enum spa_data_type
Definition: mem.h:69
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:330
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:728