mem.h
Go to the documentation of this file.
/* PipeWire
*
* Copyright © 2018 Wim Taymans
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
#ifndef PIPEWIRE_MEM_H
#define PIPEWIRE_MEM_H
#include <pipewire/properties.h>
#ifdef __cplusplus
extern "C" {
#endif
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_READWRITE = PW_MEMBLOCK_FLAG_READABLE | PW_MEMBLOCK_FLAG_WRITABLE,
};
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,
};
struct pw_memchunk;
struct pw_mempool {
struct pw_properties *props;
};
struct pw_memblock {
struct pw_mempool *pool;
uint32_t id;
int ref;
uint32_t flags;
uint32_t type;
int fd;
uint32_t size;
struct pw_memmap *map;
};
struct pw_memmap {
struct pw_memblock *block;
void *ptr;
uint32_t flags;
uint32_t offset;
uint32_t size;
uint32_t tag[5];
};
struct pw_mempool_events {
#define PW_VERSION_MEMPOOL_EVENTS 0
uint32_t version;
void (*destroy) (void *data);
void (*added) (void *data, struct pw_memblock *block);
void (*removed) (void *data, struct pw_memblock *block);
};
struct pw_mempool *pw_mempool_new(struct pw_properties *props);
void pw_mempool_add_listener(struct pw_mempool *pool,
struct spa_hook *listener,
const struct pw_mempool_events *events,
void *data);
void pw_mempool_clear(struct pw_mempool *pool);
void pw_mempool_destroy(struct pw_mempool *pool);
struct pw_memblock * pw_mempool_alloc(struct pw_mempool *pool,
enum pw_memblock_flags flags, uint32_t type, size_t size);
struct pw_memblock * pw_mempool_import_block(struct pw_mempool *pool,
struct pw_memblock *mem);
struct pw_memblock * pw_mempool_import(struct pw_mempool *pool,
enum pw_memblock_flags flags, uint32_t type, int fd);
void pw_memblock_free(struct pw_memblock *mem);
static inline void pw_memblock_unref(struct pw_memblock *mem)
{
if (--mem->ref == 0)
pw_memblock_free(mem);
}
int pw_mempool_remove_id(struct pw_mempool *pool, uint32_t id);
struct pw_memblock * pw_mempool_find_ptr(struct pw_mempool *pool, const void *ptr);
struct pw_memblock * pw_mempool_find_id(struct pw_mempool *pool, uint32_t id);
struct pw_memblock * pw_mempool_find_fd(struct pw_mempool *pool, int 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]);
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]);
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);
int pw_memmap_free(struct pw_memmap *map);
struct pw_map_range {
uint32_t start;
uint32_t offset;
uint32_t size;
};
#define PW_MAP_RANGE_INIT (struct pw_map_range){ 0, }
static inline void pw_map_range_init(struct pw_map_range *range,
uint32_t offset, uint32_t size,
uint32_t page_size)
{
range->offset = SPA_ROUND_DOWN_N(offset, page_size);
range->start = offset - range->offset;
range->size = SPA_ROUND_UP_N(range->start + size, page_size);
}
#ifdef __cplusplus
}
#endif
#endif /* PIPEWIRE_MEM_H */
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:358
pw_memmap_flags
pw_memmap_flags
Definition: mem.h:60
pw_memmap_free
int pw_memmap_free(struct pw_memmap *map)
Unmap a region.
Definition: mem.c:420
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:468
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:608
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:672
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:190
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:735
pw_memblock_unref
static void pw_memblock_unref(struct pw_memblock *mem)
Unref a memblock.
Definition: mem.h:151
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:202
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:619
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:754
pw_mempool_clear
void pw_mempool_clear(struct pw_mempool *pool)
Clear a pool.
Definition: mem.c:159
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:695
pw_memblock_flags
pw_memblock_flags
Flags passed to pw_mempool_alloc()
Definition: mem.h:48
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:405
pw_mempool_destroy
void pw_mempool_destroy(struct pw_mempool *pool)
Clear and destroy a pool.
Definition: mem.c:172
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:571
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:768
pw_mempool_new
struct pw_mempool * pw_mempool_new(struct pw_properties *props)
Create a new memory pool.
Definition: mem.c:135
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:780
PW_MEMMAP_FLAG_LOCKED
@ PW_MEMMAP_FLAG_LOCKED
lock the memory into RAM
Definition: mem.h:67
PW_MEMMAP_FLAG_READ
@ PW_MEMMAP_FLAG_READ
map in read mode
Definition: mem.h:62
PW_MEMMAP_FLAG_READWRITE
@ PW_MEMMAP_FLAG_READWRITE
Definition: mem.h:68
PW_MEMMAP_FLAG_WRITE
@ PW_MEMMAP_FLAG_WRITE
map in write mode
Definition: mem.h:63
PW_MEMMAP_FLAG_NONE
@ PW_MEMMAP_FLAG_NONE
Definition: mem.h:61
PW_MEMMAP_FLAG_TWICE
@ PW_MEMMAP_FLAG_TWICE
map the same area twice after each other, creating a circular ringbuffer
Definition: mem.h:64
PW_MEMMAP_FLAG_PRIVATE
@ PW_MEMMAP_FLAG_PRIVATE
writes will be private
Definition: mem.h:66
PW_MEMBLOCK_FLAG_READWRITE
@ PW_MEMBLOCK_FLAG_READWRITE
Definition: mem.h:57
PW_MEMBLOCK_FLAG_MAP
@ PW_MEMBLOCK_FLAG_MAP
mmap the fd
Definition: mem.h:53
PW_MEMBLOCK_FLAG_DONT_NOTIFY
@ PW_MEMBLOCK_FLAG_DONT_NOTIFY
don't notify events
Definition: mem.h:55
PW_MEMBLOCK_FLAG_READABLE
@ PW_MEMBLOCK_FLAG_READABLE
memory is readable
Definition: mem.h:50
PW_MEMBLOCK_FLAG_SEAL
@ PW_MEMBLOCK_FLAG_SEAL
seal the fd
Definition: mem.h:52
PW_MEMBLOCK_FLAG_WRITABLE
@ PW_MEMBLOCK_FLAG_WRITABLE
memory is writable
Definition: mem.h:51
PW_MEMBLOCK_FLAG_NONE
@ PW_MEMBLOCK_FLAG_NONE
Definition: mem.h:49
PW_MEMBLOCK_FLAG_DONT_CLOSE
@ PW_MEMBLOCK_FLAG_DONT_CLOSE
don't close fd
Definition: mem.h:54
SPA_ROUND_UP_N
#define SPA_ROUND_UP_N(num, align)
Definition: defs.h:296
SPA_ROUND_DOWN_N
#define SPA_ROUND_DOWN_N(num, align)
Definition: defs.h:294
properties.h
pipewire/properties.h
pw_map_range
parameters to map a memory range
Definition: mem.h:191
pw_map_range::size
uint32_t size
page aligned offset to map
Definition: mem.h:194
pw_map_range::offset
uint32_t offset
offset in first page with start of data
Definition: mem.h:193
pw_memblock
Memory block structure.
Definition: mem.h:83
pw_memblock::id
uint32_t id
unique id
Definition: mem.h:85
pw_memblock::fd
int fd
fd
Definition: mem.h:89
pw_memblock::pool
struct pw_mempool * pool
owner pool
Definition: mem.h:84
pw_memblock::flags
uint32_t flags
flags for the memory block on of enum pw_memblock_flags
Definition: mem.h:87
pw_memblock::size
uint32_t size
size of memory
Definition: mem.h:90
pw_memblock::type
uint32_t type
type of the fd, one of enum spa_data_type
Definition: mem.h:88
pw_memblock::ref
int ref
refcount
Definition: mem.h:86
pw_memblock::map
struct pw_memmap * map
optional map when PW_MEMBLOCK_FLAG_MAP was given
Definition: mem.h:91
pw_memchunk
pw_memmap
a mapped region of a pw_memblock
Definition: mem.h:95
pw_memmap::offset
uint32_t offset
offset in memblock
Definition: mem.h:99
pw_memmap::ptr
void * ptr
mapped pointer
Definition: mem.h:97
pw_memmap::flags
uint32_t flags
flags for the mapping on of enum pw_memmap_flags
Definition: mem.h:98
pw_memmap::size
uint32_t size
size in memblock
Definition: mem.h:100
pw_memmap::block
struct pw_memblock * block
owner memblock
Definition: mem.h:96
pw_memmap::tag
uint32_t tag[5]
user tag
Definition: mem.h:101
pw_mempool_events
Definition: mem.h:104
pw_mempool_events::removed
void(* removed)(void *data, struct pw_memblock *block)
a memory block is removed from the pool
Definition: mem.h:116
pw_mempool_events::destroy
void(* destroy)(void *data)
the pool is destroyed
Definition: mem.h:110
pw_mempool_events::added
void(* added)(void *data, struct pw_memblock *block)
a new memory block is added to the pool
Definition: mem.h:113
pw_mempool_events::version
uint32_t version
Definition: mem.h:107
pw_mempool
A memory pool is a collection of pw_memblocks.
Definition: mem.h:77
pw_properties
Definition: properties.h:53
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:342