map.h
Go to the documentation of this file.
/* PipeWire
* Copyright (C) 2016 Wim Taymans <wim.taymans@gmail.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __PIPEWIRE_MAP_H__
#define __PIPEWIRE_MAP_H__
#ifdef __cplusplus
extern "C" {
#endif
#include <string.h>
#include <spa/utils/defs.h>
#include <pipewire/array.h>
union pw_map_item {
uint32_t next;
void *data;
};
struct pw_map {
struct pw_array items;
uint32_t free_list;
};
#define PW_MAP_INIT(extend) (struct pw_map) { PW_ARRAY_INIT(extend), 0 }
#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);
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 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];
map->free_list = item->next;
} else {
item = (union pw_map_item *) pw_array_add(&map->items, sizeof(union pw_map_item));
if (!item)
return SPA_ID_INVALID;
start = (union pw_map_item *) map->items.data;
}
item->data = data;
id = (item - start);
return id;
}
static inline bool 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 false;
else if (id == size)
item = (union pw_map_item *) pw_array_add(&map->items, sizeof(union pw_map_item));
else
item = pw_map_get_item(map, id);
item->data = data;
return true;
}
static inline void pw_map_remove(struct pw_map *map, uint32_t id)
{
pw_map_get_item(map, id)->next = map->free_list;
map->free_list = (id << 1) | 1;
}
static inline void *pw_map_lookup(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(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__ */
pw_map::pw_map_clear
static void pw_map_clear(struct pw_map *map)
Clear a map.
Definition: map.h:81
pw_map_get_size
#define pw_map_get_size(m)
Definition: map.h:51
pw_map::pw_map_insert_at
static bool pw_map_insert_at(struct pw_map *map, uint32_t id, void *data)
Insert data in the map at an index.
Definition: map.h:119
pw_map::free_list
uint32_t free_list
the free items
Definition: map.h:46
pw_map_get_item
#define pw_map_get_item(m, id)
Definition: map.h:52
pw_array_for_each
#define pw_array_for_each(pos, array)
Definition: array.h:56
pw_map::pw_map_for_each
static int pw_map_for_each(struct pw_map *map, int(*func)(void *item_data, void *data), void *data)
Iterate all map items.
Definition: map.h:171
pw_array::data
void * data
pointer to array data
Definition: array.h:37
pw_map_item::next
uint32_t next
next free index
Definition: map.h:39
array.h
pw_map_item_is_free
#define pw_map_item_is_free(item)
Definition: map.h:53
pw_map::pw_map_init
static void pw_map_init(struct pw_map *map, size_t size, size_t extend)
Initialize a map.
Definition: map.h:70
pw_map_check_id
#define pw_map_check_id(m, id)
Definition: map.h:55
pw_array::pw_array_init
static void pw_array_init(struct pw_array *arr, size_t extend)
Initialize the array with given extend.
Definition: array.h:62
pw_array::pw_array_ensure_size
static bool pw_array_ensure_size(struct pw_array *arr, size_t size)
Make sure size bytes can be added to the array.
Definition: array.h:76
pw_map::pw_map_lookup
static void * pw_map_lookup(struct pw_map *map, uint32_t id)
Find an item in the map.
Definition: map.h:152
pw_array
An array object.
Definition: array.h:36
pw_map_item
An entry in the map.
Definition: map.h:38
pw_map::pw_map_remove
static void pw_map_remove(struct pw_map *map, uint32_t id)
Remove an item at index.
Definition: map.h:140
pw_array::extend
size_t extend
number of bytes to extend with
Definition: array.h:40
pw_map::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:92
pw_map_item::data
void * data
data of this item, must be an even address
Definition: map.h:40
pw_array::size
size_t size
length of array in bytes
Definition: array.h:38
pw_map::items
struct pw_array items
an array with the map items
Definition: map.h:45
pw_map
A map.
Definition: map.h:44