| PipeWire 1.4.6
    | 
Memory allocation and pools. More...
| Files | |
| file | mem.h | 
| pipewire/mem.h | |
| Data Structures | |
| struct | pw_mempool | 
| A memory pool is a collection of pw_memblocks.  More... | |
| struct | pw_memblock | 
| Memory block structure.  More... | |
| struct | pw_memmap | 
| a mapped region of a pw_memblock  More... | |
| struct | pw_mempool_events | 
| struct | pw_map_range | 
| parameters to map a memory range  More... | |
| struct | pw_memchunk | 
| Enumerations | |
| enum | pw_memblock_flags { PW_MEMBLOCK_FLAG_NONE = 0 , PW_MEMBLOCK_FLAG_READABLE = (1 << 0) , PW_MEMBLOCK_FLAG_WRITABLE = (1 << 1) , PW_MEMBLOCK_FLAG_SEAL = (1 << 2) , PW_MEMBLOCK_FLAG_MAP = (1 << 3) , PW_MEMBLOCK_FLAG_DONT_CLOSE = (1 << 4) , PW_MEMBLOCK_FLAG_DONT_NOTIFY = (1 << 5) , PW_MEMBLOCK_FLAG_UNMAPPABLE = (1 << 6) , PW_MEMBLOCK_FLAG_READWRITE = PW_MEMBLOCK_FLAG_READABLE | PW_MEMBLOCK_FLAG_WRITABLE } | 
| Flags passed to pw_mempool_alloc()  More... | |
| enum | pw_memmap_flags { PW_MEMMAP_FLAG_NONE = 0 , PW_MEMMAP_FLAG_READ = (1 << 0) , PW_MEMMAP_FLAG_WRITE = (1 << 1) , PW_MEMMAP_FLAG_TWICE = (1 << 2) , PW_MEMMAP_FLAG_PRIVATE = (1 << 3) , PW_MEMMAP_FLAG_LOCKED = (1 << 4) , PW_MEMMAP_FLAG_READWRITE = PW_MEMMAP_FLAG_READ | PW_MEMMAP_FLAG_WRITE } | 
| Macros | |
| #define | PW_VERSION_MEMPOOL_EVENTS 0 | 
| #define | PW_MAP_RANGE_INIT (struct pw_map_range){ 0, } | 
| Functions | |
| struct pw_mempool * | pw_mempool_new (struct pw_properties *props) | 
| Create a new memory pool. | |
| void | pw_mempool_add_listener (struct pw_mempool *pool, struct spa_hook *listener, const struct pw_mempool_events *events, void *data) | 
| Listen for events. | |
| void | pw_mempool_clear (struct pw_mempool *pool) | 
| Clear a pool. | |
| void | pw_mempool_destroy (struct pw_mempool *pool) | 
| Clear and destroy a pool. | |
| 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. | |
| struct pw_memblock * | pw_mempool_import_block (struct pw_mempool *pool, struct pw_memblock *mem) | 
| Import a block from another pool. | |
| 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. | |
| void | pw_memblock_free (struct pw_memblock *mem) | 
| Free a memblock regardless of the refcount and destroy all mappings. | |
| PW_API_MEM void | pw_memblock_unref (struct pw_memblock *mem) | 
| Unref a memblock. | |
| int | pw_mempool_remove_id (struct pw_mempool *pool, uint32_t id) | 
| Remove a memblock for given id. | |
| struct pw_memblock * | pw_mempool_find_ptr (struct pw_mempool *pool, const void *ptr) | 
| Find memblock for given ptr. | |
| struct pw_memblock * | pw_mempool_find_id (struct pw_mempool *pool, uint32_t id) | 
| Find memblock for given id. | |
| struct pw_memblock * | pw_mempool_find_fd (struct pw_mempool *pool, int fd) | 
| Find memblock for given fd. | |
| 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. | |
| 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. | |
| struct pw_memmap * | pw_mempool_import_map (struct pw_mempool *pool, struct pw_mempool *other, void *data, uint32_t size, uint32_t tag[5]) | 
| 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 | |
| int | pw_memmap_free (struct pw_memmap *map) | 
| Unmap a region. | |
| PW_API_MEM 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(). | |
Memory allocation and pools.
| enum pw_memblock_flags | 
Flags passed to pw_mempool_alloc()
| enum pw_memmap_flags | 
| #define PW_VERSION_MEMPOOL_EVENTS 0 | 
| #define PW_MAP_RANGE_INIT (struct pw_map_range){ 0, } | 
| struct pw_mempool * pw_mempool_new | ( | struct pw_properties * | props | ) | 
Create a new memory pool.
| void pw_mempool_add_listener | ( | struct pw_mempool * | pool, | 
| struct spa_hook * | listener, | ||
| const struct pw_mempool_events * | events, | ||
| void * | data ) | 
Listen for events.
| void pw_mempool_clear | ( | struct pw_mempool * | pool | ) | 
Clear a pool.
| void pw_mempool_destroy | ( | struct pw_mempool * | pool | ) | 
Clear and destroy a pool.
| 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.
Allocate a memory block from the pool.
| pool | the pool to use | 
| flags | memblock flags | 
| type | the requested memory type one of enum spa_data_type | 
| size | size to allocate | 
| struct pw_memblock * pw_mempool_import_block | ( | struct pw_mempool * | pool, | 
| struct pw_memblock * | mem ) | 
Import a block from another pool.
| 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.
| void pw_memblock_free | ( | struct pw_memblock * | block | ) | 
Free a memblock regardless of the refcount and destroy all mappings.
Free a memblock regardless of the refcount and destroy all mappings.
| block | a memblock | 
| PW_API_MEM void pw_memblock_unref | ( | struct pw_memblock * | mem | ) | 
Unref a memblock.
| int pw_mempool_remove_id | ( | struct pw_mempool * | pool, | 
| uint32_t | id ) | 
Remove a memblock for given id.
| struct pw_memblock * pw_mempool_find_ptr | ( | struct pw_mempool * | pool, | 
| const void * | ptr ) | 
Find memblock for given ptr.
| struct pw_memblock * pw_mempool_find_id | ( | struct pw_mempool * | pool, | 
| uint32_t | id ) | 
Find memblock for given id.
| struct pw_memblock * pw_mempool_find_fd | ( | struct pw_mempool * | pool, | 
| int | fd ) | 
Find memblock for given fd.
| 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.
| 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.
| struct pw_memmap * pw_mempool_import_map | ( | struct pw_mempool * | pool, | 
| struct pw_mempool * | other, | ||
| void * | data, | ||
| uint32_t | size, | ||
| uint32_t | tag[5] ) | 
| 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
| int pw_memmap_free | ( | struct pw_memmap * | map | ) | 
Unmap a region.
| PW_API_MEM 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().