Loading...
Searching...
No Matches
map.h
Go to the documentation of this file.
/* PipeWire */
/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
/* SPDX-License-Identifier: MIT */
#ifndef PIPEWIRE_MAP_H
#define PIPEWIRE_MAP_H
#ifdef __cplusplus
extern "C" {
#endif
#include <string.h>
#include <errno.h>
#include <spa/utils/defs.h>
#include <pipewire/array.h>
union pw_map_item {
uintptr_t next; /* next free index */
void *data; /* data of this item, must be an even address */
};
struct pw_map {
struct pw_array items; /* an array with the map items */
uint32_t free_list; /* first free index */
};
#define PW_MAP_INIT(extend) ((struct pw_map) { PW_ARRAY_INIT(extend), SPA_ID_INVALID })
#define pw_map_get_size(m) pw_array_get_len(&(m)->items, union pw_map_item)
#define pw_map_get_item(m,id) pw_array_get_unchecked(&(m)->items,id,union pw_map_item)
#define pw_map_item_is_free(item) ((item)->next & 0x1)
#define pw_map_id_is_free(m,id) (pw_map_item_is_free(pw_map_get_item(m,id)))
#define pw_map_check_id(m,id) ((id) < pw_map_get_size(m))
#define pw_map_has_item(m,id) (pw_map_check_id(m,id) && !pw_map_id_is_free(m, id))
#define pw_map_lookup_unchecked(m,id) pw_map_get_item(m,id)->data
#define PW_MAP_ID_TO_PTR(id) (SPA_UINT32_TO_PTR((id)<<1))
#define PW_MAP_PTR_TO_ID(p) (SPA_PTR_TO_UINT32(p)>>1)
static inline void pw_map_init(struct pw_map *map, size_t size, size_t extend)
{
pw_array_init(&map->items, extend * sizeof(union pw_map_item));
pw_array_ensure_size(&map->items, size * sizeof(union pw_map_item));
map->free_list = SPA_ID_INVALID;
}
static inline void pw_map_clear(struct pw_map *map)
{
pw_array_clear(&map->items);
}
static inline void pw_map_reset(struct pw_map *map)
{
pw_array_reset(&map->items);
map->free_list = SPA_ID_INVALID;
}
static inline uint32_t pw_map_insert_new(struct pw_map *map, void *data)
{
union pw_map_item *start, *item;
uint32_t id;
if (map->free_list != SPA_ID_INVALID) {
start = (union pw_map_item *) map->items.data;
item = &start[map->free_list >> 1]; /* lsb always 1, see pw_map_remove */
map->free_list = item->next;
} else {
item = (union pw_map_item *) pw_array_add(&map->items, sizeof(union pw_map_item));
if (item == NULL)
return SPA_ID_INVALID;
start = (union pw_map_item *) map->items.data;
}
item->data = data;
id = (item - start);
return id;
}
static inline int pw_map_insert_at(struct pw_map *map, uint32_t id, void *data)
{
size_t size = pw_map_get_size(map);
union pw_map_item *item;
if (id > size)
return -ENOSPC;
else if (id == size) {
item = (union pw_map_item *) pw_array_add(&map->items, sizeof(union pw_map_item));
if (item == NULL)
return -errno;
} else {
item = pw_map_get_item(map, id);
if (pw_map_item_is_free(item))
return -EINVAL;
}
item->data = data;
return 0;
}
static inline void pw_map_remove(struct pw_map *map, uint32_t id)
{
if (pw_map_id_is_free(map, id))
return;
pw_map_get_item(map, id)->next = map->free_list;
map->free_list = (id << 1) | 1;
}
static inline void *pw_map_lookup(const struct pw_map *map, uint32_t id)
{
if (SPA_LIKELY(pw_map_check_id(map, id))) {
union pw_map_item *item = pw_map_get_item(map, id);
if (!pw_map_item_is_free(item))
return item->data;
}
return NULL;
}
static inline int pw_map_for_each(const struct pw_map *map,
int (*func) (void *item_data, void *data), void *data)
{
union pw_map_item *item;
int res = 0;
pw_array_for_each(item, &map->items) {
if (!pw_map_item_is_free(item))
if ((res = func(item->data, data)) != 0)
break;
}
return res;
}
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* PIPEWIRE_MAP_H */
array.h
pipewire/array.h
defs.h
spa/utils/defs.h
pw_array_ensure_size
static int pw_array_ensure_size(struct pw_array *arr, size_t size)
Make sure size bytes can be added to the array.
Definition array.h:96
pw_array_init
static void pw_array_init(struct pw_array *arr, size_t extend)
Initialize the array with given extend.
Definition array.h:75
pw_array_clear
static void pw_array_clear(struct pw_array *arr)
Clear the array.
Definition array.h:83
pw_array_for_each
#define pw_array_for_each(pos, array)
Definition array.h:57
pw_array_add
static void * pw_array_add(struct pw_array *arr, size_t size)
Add ref size bytes to arr.
Definition array.h:119
pw_array_reset
static void pw_array_reset(struct pw_array *arr)
Reset the array.
Definition array.h:90
pw_map_remove
static void pw_map_remove(struct pw_map *map, uint32_t id)
Remove an item at index.
Definition map.h:185
pw_map_check_id
#define pw_map_check_id(m, id)
Definition map.h:86
pw_map_insert_at
static int pw_map_insert_at(struct pw_map *map, uint32_t id, void *data)
Replace the data in the map at an index.
Definition map.h:160
pw_map_get_size
#define pw_map_get_size(m)
Get the number of currently allocated elements in the map.
Definition map.h:81
pw_map_insert_new
static uint32_t pw_map_insert_new(struct pw_map *map, void *data)
Insert data in the map.
Definition map.h:133
pw_map_for_each
static int pw_map_for_each(const struct pw_map *map, int(*func)(void *item_data, void *data), void *data)
Iterate all map items.
Definition map.h:217
pw_map_reset
static void pw_map_reset(struct pw_map *map)
Reset a map but keep previously allocated storage.
Definition map.h:121
pw_map_clear
static void pw_map_clear(struct pw_map *map)
Clear a map and free the data storage.
Definition map.h:113
pw_map_item_is_free
#define pw_map_item_is_free(item)
Definition map.h:83
pw_map_id_is_free
#define pw_map_id_is_free(m, id)
Definition map.h:84
pw_map_init
static void pw_map_init(struct pw_map *map, size_t size, size_t extend)
Initialize a map.
Definition map.h:103
pw_map_lookup
static void * pw_map_lookup(const struct pw_map *map, uint32_t id)
Find an item in the map.
Definition map.h:199
pw_map_get_item
#define pw_map_get_item(m, id)
Definition map.h:82
SPA_ID_INVALID
#define SPA_ID_INVALID
Definition defs.h:232
SPA_LIKELY
#define SPA_LIKELY(x)
Definition defs.h:349
string.h
spa/utils/string.h
pw_array
Definition array.h:32
pw_array::size
size_t size
length of array in bytes
Definition array.h:34
pw_array::extend
size_t extend
number of bytes to extend with
Definition array.h:36
pw_array::data
void * data
pointer to array data
Definition array.h:33
pw_map
A map.
Definition map.h:66
pw_map::items
struct pw_array items
Definition map.h:67
pw_map::free_list
uint32_t free_list
Definition map.h:68