mirror of
https://gitlab.freedesktop.org/pipewire/pipewire
synced 2024-09-06 00:40:34 +00:00
![Peter Hutterer](/assets/img/avatar_default.png)
Re-using an id after removing it is a bug in the caller but there are two cases where we corrupt the free list without warning: Removing an object twice: id = pw_map_insert_new(object); pw_map_remove(map, id); pw_map_remove(map, id); And inserting an element at an index previously removed: id = pw_map_insert_new(object); pw_map_remove(map, id); pw_map_insert_at(map, id, new_object); The latter is arguably valid code, or at least it'll look like it's valid code. For both cases, check if the id to remove/insert at is a free item and handle that accordingly.
258 lines
6.9 KiB
C
258 lines
6.9 KiB
C
/* PipeWire
|
|
*
|
|
* Copyright © 2021 Red Hat, Inc.
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
#include "pwtest.h"
|
|
|
|
#include <pipewire/map.h>
|
|
|
|
|
|
PWTEST(map_add_remove)
|
|
{
|
|
struct pw_map map = PW_MAP_INIT(2);
|
|
int a, b, c;
|
|
void *p1 = &a, *p2 = &b, *p3 = &c;
|
|
uint32_t idx1, idx2, idx3;
|
|
|
|
idx1 = pw_map_insert_new(&map, p1);
|
|
idx2 = pw_map_insert_new(&map, p2);
|
|
idx3 = pw_map_insert_new(&map, p3);
|
|
|
|
/* This is implementation-defined behavior and
|
|
* may change in the future */
|
|
pwtest_int_eq(idx1, 0U);
|
|
pwtest_int_eq(idx2, 1U);
|
|
pwtest_int_eq(idx3, 2U);
|
|
|
|
/* public API */
|
|
pwtest_ptr_eq(p1, pw_map_lookup(&map, idx1));
|
|
pwtest_ptr_eq(p2, pw_map_lookup(&map, idx2));
|
|
pwtest_ptr_eq(p3, pw_map_lookup(&map, idx3));
|
|
|
|
pw_map_remove(&map, idx1);
|
|
pwtest_ptr_null(pw_map_lookup(&map, idx1));
|
|
pwtest_ptr_eq(p2, pw_map_lookup(&map, idx2));
|
|
pwtest_ptr_eq(p3, pw_map_lookup(&map, idx3));
|
|
|
|
pw_map_remove(&map, idx2);
|
|
pwtest_ptr_null(pw_map_lookup(&map, idx1));
|
|
pwtest_ptr_null(pw_map_lookup(&map, idx2));
|
|
pwtest_ptr_eq(p3, pw_map_lookup(&map, idx3));
|
|
|
|
pw_map_remove(&map, idx3);
|
|
pwtest_ptr_null(pw_map_lookup(&map, idx1));
|
|
pwtest_ptr_null(pw_map_lookup(&map, idx2));
|
|
pwtest_ptr_null(pw_map_lookup(&map, idx3));
|
|
|
|
idx1 = pw_map_insert_new(&map, p1);
|
|
idx2 = pw_map_insert_new(&map, p2);
|
|
idx3 = pw_map_insert_new(&map, p3);
|
|
|
|
/* This is implementation-defined behavior and
|
|
* may change in the future */
|
|
pwtest_int_eq(idx3, 0U);
|
|
pwtest_int_eq(idx2, 1U);
|
|
pwtest_int_eq(idx1, 2U);
|
|
|
|
pw_map_clear(&map);
|
|
|
|
return PWTEST_PASS;
|
|
}
|
|
|
|
PWTEST(map_insert)
|
|
{
|
|
struct pw_map map = PW_MAP_INIT(2);
|
|
int a, b, c, d;
|
|
void *p1 = &a, *p2 = &b, *p3 = &c, *p4 = &d;
|
|
uint32_t idx1, idx2, idx3;
|
|
int rc;
|
|
size_t sz;
|
|
|
|
idx1 = pw_map_insert_new(&map, p1);
|
|
idx2 = pw_map_insert_new(&map, p2);
|
|
idx3 = pw_map_insert_new(&map, p3);
|
|
|
|
pwtest_ptr_eq(p1, pw_map_lookup(&map, idx1));
|
|
pwtest_ptr_eq(p2, pw_map_lookup(&map, idx2));
|
|
pwtest_ptr_eq(p3, pw_map_lookup(&map, idx3));
|
|
sz = pw_map_get_size(&map);
|
|
pwtest_int_eq(sz, 3U);
|
|
|
|
/* overwrite */
|
|
rc = pw_map_insert_at(&map, idx1, p4);
|
|
pwtest_neg_errno_ok(rc);
|
|
pwtest_ptr_eq(p4, pw_map_lookup(&map, idx1));
|
|
sz = pw_map_get_size(&map);
|
|
pwtest_int_eq(sz, 3U);
|
|
|
|
/* overwrite */
|
|
rc = pw_map_insert_at(&map, idx2, p4);
|
|
pwtest_neg_errno_ok(rc);
|
|
pwtest_ptr_eq(p4, pw_map_lookup(&map, idx2));
|
|
sz = pw_map_get_size(&map);
|
|
pwtest_int_eq(sz, 3U);
|
|
|
|
/* out of bounds */
|
|
rc = pw_map_insert_at(&map, 10000, p4);
|
|
pwtest_neg_errno(rc, -ENOSPC);
|
|
|
|
/* if id is the map size, the item is appended */
|
|
rc = pw_map_insert_at(&map, idx3 + 1, &p4);
|
|
pwtest_neg_errno_ok(rc);
|
|
sz = pw_map_get_size(&map);
|
|
pwtest_int_eq(sz, 4U);
|
|
|
|
pw_map_clear(&map);
|
|
|
|
return PWTEST_PASS;
|
|
}
|
|
|
|
PWTEST(map_size)
|
|
{
|
|
struct pw_map map = PW_MAP_INIT(2);
|
|
int a, b, c;
|
|
void *p1 = &a, *p2 = &b, *p3 = &c;
|
|
uint32_t idx1;
|
|
size_t sz;
|
|
|
|
idx1 = pw_map_insert_new(&map, p1);
|
|
sz = pw_map_get_size(&map);
|
|
pwtest_int_eq(sz, 1U);
|
|
pw_map_insert_new(&map, p2);
|
|
sz = pw_map_get_size(&map);
|
|
pwtest_int_eq(sz, 2U);
|
|
pw_map_insert_new(&map, p3);
|
|
sz = pw_map_get_size(&map);
|
|
pwtest_int_eq(sz, 3U);
|
|
|
|
/* Removing does not alter the size */
|
|
pw_map_remove(&map, idx1);
|
|
sz = pw_map_get_size(&map);
|
|
pwtest_int_eq(sz, 3U);
|
|
|
|
pw_map_clear(&map);
|
|
|
|
return PWTEST_PASS;
|
|
}
|
|
|
|
PWTEST(map_double_remove)
|
|
{
|
|
struct pw_map map = PW_MAP_INIT(2);
|
|
int a, b, c;
|
|
void *p1 = &a, *p2 = &b, *p3 = &c;
|
|
|
|
uint32_t idx1, idx2, idx3;
|
|
|
|
idx1 = pw_map_insert_new(&map, p1);
|
|
idx2 = pw_map_insert_new(&map, p2);
|
|
idx3 = pw_map_insert_new(&map, p3);
|
|
|
|
pw_map_remove(&map, idx1); /* idx1 in the free list */
|
|
pw_map_remove(&map, idx2); /* idx1 and 2 in the free list */
|
|
pw_map_remove(&map, idx2); /* should be a noop */
|
|
idx1 = pw_map_insert_new(&map, p1);
|
|
idx2 = pw_map_insert_new(&map, p2);
|
|
|
|
pwtest_ptr_eq(p1, pw_map_lookup(&map, idx1));
|
|
pwtest_ptr_eq(p2, pw_map_lookup(&map, idx2));
|
|
pwtest_ptr_eq(p3, pw_map_lookup(&map, idx3));
|
|
|
|
pw_map_clear(&map);
|
|
|
|
return PWTEST_PASS;
|
|
}
|
|
|
|
PWTEST(map_insert_at_free)
|
|
{
|
|
struct pw_map map = PW_MAP_INIT(2);
|
|
int data[3] = {1, 2, 3};
|
|
int new_data = 4;
|
|
int *ptr[3] = {&data[0], &data[1], &data[3]};
|
|
int *new_ptr = &new_data;
|
|
int idx[3];
|
|
int rc;
|
|
|
|
/* Test cases, for an item at idx:
|
|
* 1. remove at idx, then reinsert
|
|
* 2. remove at idx, remove another item, reinsert
|
|
* 3. remove another item, remove at idx, reinsert
|
|
* 4. remove another item, remove at index, remove another item, reinsert
|
|
*
|
|
* The indices are the respective 2 bits from the iteration counter,
|
|
* we use index 3 to indicate skipping that step to handle cases 1-3.
|
|
*/
|
|
int iteration = pwtest_get_iteration(current_test);
|
|
int item_idx = iteration & 0x3;
|
|
int before_idx = (iteration >> 2) & 0x3;
|
|
int after_idx = (iteration >> 4) & 0x3;
|
|
const int SKIP = 3;
|
|
|
|
if (item_idx == SKIP)
|
|
return PWTEST_PASS;
|
|
|
|
idx[0] = pw_map_insert_new(&map, ptr[0]);
|
|
idx[1] = pw_map_insert_new(&map, ptr[1]);
|
|
idx[2] = pw_map_insert_new(&map, ptr[2]);
|
|
|
|
if (before_idx != SKIP) {
|
|
before_idx = idx[before_idx];
|
|
pw_map_remove(&map, before_idx);
|
|
}
|
|
pw_map_remove(&map, item_idx);
|
|
if (after_idx != SKIP) {
|
|
after_idx = idx[after_idx];
|
|
pw_map_remove(&map, after_idx);
|
|
}
|
|
|
|
rc = pw_map_insert_at(&map, item_idx, &new_data);
|
|
pwtest_neg_errno_ok(rc);
|
|
pwtest_ptr_eq(new_ptr, pw_map_lookup(&map, item_idx));
|
|
|
|
if (before_idx != SKIP && before_idx != item_idx) {
|
|
rc = pw_map_insert_at(&map, before_idx, &ptr[before_idx]);
|
|
pwtest_neg_errno_ok(rc);
|
|
pwtest_ptr_eq(&ptr[before_idx], pw_map_lookup(&map, before_idx));
|
|
}
|
|
|
|
if (after_idx != SKIP && after_idx != item_idx) {
|
|
rc = pw_map_insert_at(&map, after_idx, &ptr[after_idx]);
|
|
pwtest_neg_errno_ok(rc);
|
|
pwtest_ptr_eq(&ptr[after_idx], pw_map_lookup(&map, after_idx));
|
|
}
|
|
|
|
pw_map_clear(&map);
|
|
|
|
return PWTEST_PASS;
|
|
}
|
|
|
|
PWTEST_SUITE(pw_map)
|
|
{
|
|
pwtest_add(map_add_remove, PWTEST_NOARG);
|
|
pwtest_add(map_insert, PWTEST_NOARG);
|
|
pwtest_add(map_size, PWTEST_NOARG);
|
|
pwtest_add(map_double_remove, PWTEST_NOARG);
|
|
pwtest_add(map_insert_at_free, PWTEST_ARG_RANGE, 0, 63);
|
|
|
|
return PWTEST_PASS;
|
|
}
|