tomato/toxcore/list.c
Green Sky aae086cc65 Squashed 'external/toxcore/c-toxcore/' changes from e2c01e457b..b03b571272
b03b571272 fix: flaky tcp test This only fixes the symptoms, not the real problem. Sometimes or consistently on some platforms a socket might need a moment before it can be written to.
32e67ab4c2 cleanup: use typedef for private message ID's in callback
7b1db6adc1 feat: add message IDs to private group messages
99e0bcc27d refactor: Observers/ignored peers can now send and receive custom packets
b3c3c49d26 fix: Disable IPv6 in Windows cross-compilation tests
e742deddff feat: Check hashes of Windows dependencies when cross-compiling
dfb9a0b02b fix: Test the current Windows Dockerfile, not an old Dockerhub image
14de93ccec chore: Use WineHQ's Wine as Debian Bookworm's crashes
ed37616249 docs: Update the Windows cross-compilation section
9bb79c174f cleanup: Remove a couple of unnecessary misc_tools dependencies
19475adb70 chore: Statically link OpenMP into the cracker fun util on Windows
1be311e51f feat: Build the fun utils when cross-compiling to Windows
88133f8446 chore: Strip Windows binaries
3cc0ae7535 refactor: Copy over all of the required static dependencies
c4fa8f7fb1 feat: Generate .def, .exp and .lib files when building for Windows
74bbac5363 feat: Let CMake create the dll instead of doing so ourselves
246642e9ae feat: Harden Windows cross-compilation
8d431c0d11 chore: Bump Windows build dependency versions
e519f7998b fix: Remove unnecessary wsock32 dependency on Windows
ed2b60c217 chore: Use a specific non-broken slimcc version.
d7f21010a1 chore: Update github actions.
e71a68b7f2 docs: Update the list of CMake options
77e08876ff chore: Remove mod and founder from group API naming scheme
12bc042767 docs: add the experimental api build option to INSTALL.md
e1fa5cae96 refactor: Rename Queries to Query to align with other enums.
be82a3ea30 fix: Correct type for conference offline peer numbers.
0627c36716 test: Add pkgsrc build.
92578afe4b test: Add FreeBSD VM action on GitHub.
52ece0f57b test: Build toxcore on NetBSD (VM).
3fe8ee2c11 chore: Only install tox_private.h on request.
9a8dfa06ab fix: save_compatibility_test failing on big-endian systems
86f5e55578 fix: Don't serve files from websockify.
710eb674a5 fix: Correctly pass extended public keys to group moderation code.
021db7031c refactor: Use `struct`s for extended public/secret keys.
a1e999fd80 chore: Compile libsodium reference implementation with compcert.
fbe3c19cf5 cleanup: correct a few nullable annotations
623e3ee5c3 cleanup: Don't use `memcpy` to cast arbitrary `struct`s to `uint8_t[]`.
c71567dc18 fix: Pass array, not array pointer, to `memcmp`.
9b46a08144 cleanup: Never pass `void*` directly to `memcpy`.
5d7b7a7bbc refactor: Use tox rng to seed the keypair generation.
961891d568 cleanup: Small improvements found by PVS Studio.
8201019f0d chore: Disable NGC saving by default, enable through Tox_Options.
5dd9ee3f65 cleanup: Replace pointer arithmetic with explicit `&arr[i]`.
ca4606d49d refactor: Use strong typedef for NGC peer id.
442213b722 cleanup: Simplify custom packet length check in NGC.
08d3393def fix: Correct a few potential null derefs in bootstrap daemon.
b9877b32b0 fix: Add missing memunlock of local variable when it goes out of scope.
dab5fe44b9 fix: Zero out stack-allocated secret key before return.
f058103299 refactor: Make prune_gc_sanctions_list more obviously correct.
3ba7a0dec9 docs: Add static analysis tool list to README.
8d0811a0f3 docs: Run prettier-markdown on markdown files.
969e3a2bfc refactor: Fix network test not using the strong typedef
93c83fbc7c refactor: Use strong typedef instead of struct for `Socket`.
9fe18b176f fix: Fix some false positive from PVS Studio.
7c44379ccb cleanup: Check that WINXP macro exists before comparing it.
5c93231bef refactor: Make tox mutex non-recursive.
aacff73939 docs: Fix up doxyfile.
d55fc85ff5 docs: Add more documentation to crypto_core.
5bdaaaedb6 refactor: Remove `Tox *` from `tox_dispatch`.
e202341e76 refactor: Don't rely on tox_dispatch passing tox in tests.
34df938f52 chore: Use C++ mode for clang-tidy.
8b05296a78 chore: Check that both gtest and gmock exist for tests.
42010660e1 test: Add slimcc compiler compatibility test.
b473630321 chore: Add some comments to the astyle config.
b7404f24f6 cleanup: Remove implicit bool conversions.
4e2dba4d9f chore: Reformat sources with astyle.
4359e3a6bc chore: Rename C++ headers to .hh suffixes.
0c05566e58 cleanup: Further `#include` cleanups.
8d29935b7a chore: Only check the bootstrap daemon checksum on release.
f70e588bc6 cleanup: Add more `const` where possible.
511bfe39c8 cleanup: Use Bazel modules to enforce proper `#include` hygiene.
1710a0d091 refactor: Move pack/unpack `IP_Port` from DHT into network module.
a975943564 chore: Really fix coverage docker image build.
c08409390f chore: Fix post-submit coverage image.
39aadf8922 fix: Don't use `memcmp` to compare `IP_Port`s.
d94246a906 fix: partially fix a bug that prevented group part messages from sending.
eeaa039222 chore: Fix rpm build; add a CI check for it.
8328449c1a chore: Speed up docker builds a bit by reducing layer count.
d6d67d56f3 cleanup: Add `const` where possible in auto tests.
6aa9e6850d cleanup: Minor cleanup of event unpack code.
bdf460a3a9 refactor: Rename `system_{memory,...}` to `os_{memory,...}`.
203e1af81e fix: a few off by one errors in group autotests
5c093c4888 cleanup: Remove all uses of `SIZEOF_VLA`.
662c2140f3 test: Add goblint static analyser.
8f07755834 cleanup: Use `memzero(x, s)` instead of `memset(x, 0, s)`.
a7258e40cf cleanup: Use explicit 0 instead of `PACKET_ID_PADDING`.
6370d0f15d cleanup: Expand the `Tox_Options` accessor macros.
14a1a0b9bd cleanup: Remove plan9 support.
a05dccad13 test: Add a simple new/delete test for Tox.
1cdcf938b9 cleanup: Add comment after every `#endif`.
ba99d4dc4b test: Fix comment I broke in the events test PR.
e07248debb refactor: Migrate auto_tests to new events API.
bdd42b5452 refactor: Add common msgpack array packer with callback.
3c659f5288 cleanup: Rename group to conference in groupav documentation.
89957be230 cleanup: Ensure handler params are named after callback params.
c650d9d345 refactor: Pass `this` pointer as first param to s11n callbacks.
e7fb91ddb8 refactor: Allow NULL pointers for byte arrays in events.
5e2c8cabc1 cleanup: make some improvements to group moderation test
259de4867e cleanup: Remove `bin_pack_{new,free}`.
21a8ff5895 cleanup: skip a do_gc iteration before removing peers marked for deletion
16809dc36e feat: Add dht_get_nodes_response event to the events system.

git-subtree-dir: external/toxcore/c-toxcore
git-subtree-split: b03b5712720de9a9901ea12fd741f177327a7021
2024-03-07 23:12:55 +01:00

255 lines
6.1 KiB
C

/* SPDX-License-Identifier: GPL-3.0-or-later
* Copyright © 2016-2018 The TokTok team.
* Copyright © 2014 Tox project.
*/
/**
* Simple struct with functions to create a list which associates ids with data
* - Allows for finding ids associated with data such as IPs or public keys in a short time
* - Should only be used if there are relatively few add/remove calls to the list
*/
#include "list.h"
#include <assert.h>
#include <stdbool.h>
#include <stdlib.h>
#include <string.h>
#include "attributes.h"
#include "ccompat.h"
/**
* Basically, the elements in the list are placed in order so that they can be searched for easily
* - each element is seen as a big-endian integer when ordering them
* - the ids array is maintained so that each id always matches
* - the search algorithm cuts down the time to find the id associated with a piece of data
* at the cost of slow add/remove functions for large lists
* - Starts at `1/2` of the array, compares the element in the array with the data,
* then moves `+/- 1/4` of the array depending on whether the value is greater or lower,
* then `+- 1/8`, etc, until the value is matched or its position where it should be in the array is found
* - some considerations since the array size is never perfect
*/
static int32_t list_index(uint32_t i)
{
return ~i;
}
/** @brief Find data in list
*
* @retval >=0 index of data in array
* @retval <0 no match, returns index (return value is `list_index(index)`) where
* the data should be inserted
*/
non_null()
static int find(const BS_List *list, const uint8_t *data)
{
// should work well, but could be improved
if (list->n == 0) {
return list_index(0);
}
uint32_t i = list->n / 2; // current position in the array
uint32_t delta = i / 2; // how much we move in the array
if (delta == 0) {
delta = 1;
}
int d = -1; // used to determine if closest match is found
// closest match is found if we move back to where we have already been
while (true) {
const int r = list->cmp_callback(data, list->data + list->element_size * i, list->element_size);
if (r == 0) {
return i;
}
if (r > 0) {
// data is greater
// move down
i += delta;
if (d == 0 || i == list->n) {
// reached bottom of list, or closest match
return list_index(i);
}
delta = delta / 2;
if (delta == 0) {
delta = 1;
d = 1;
}
} else {
// data is smaller
if (d == 1 || i == 0) {
// reached top or list or closest match
return list_index(i);
}
// move up
i -= delta;
delta = delta / 2;
if (delta == 0) {
delta = 1;
d = 0;
}
}
}
}
/**
* Resizes the list.
*
* @return true on success.
*/
non_null()
static bool resize(BS_List *list, uint32_t new_size)
{
if (new_size == 0) {
bs_list_free(list);
return true;
}
uint8_t *data = (uint8_t *)realloc(list->data, list->element_size * new_size);
if (data == nullptr) {
return false;
}
list->data = data;
int *ids = (int *)realloc(list->ids, new_size * sizeof(int));
if (ids == nullptr) {
return false;
}
list->ids = ids;
return true;
}
int bs_list_init(BS_List *list, uint32_t element_size, uint32_t initial_capacity, bs_list_cmp_cb *cmp_callback)
{
// set initial values
list->n = 0;
list->element_size = element_size;
list->capacity = 0;
list->data = nullptr;
list->ids = nullptr;
list->cmp_callback = cmp_callback;
if (initial_capacity != 0) {
if (!resize(list, initial_capacity)) {
return 0;
}
}
list->capacity = initial_capacity;
return 1;
}
void bs_list_free(BS_List *list)
{
if (list == nullptr) {
return;
}
// free both arrays
free(list->data);
list->data = nullptr;
free(list->ids);
list->ids = nullptr;
}
int bs_list_find(const BS_List *list, const uint8_t *data)
{
const int r = find(list, data);
// return only -1 and positive values
if (r < 0) {
return -1;
}
return list->ids[r];
}
bool bs_list_add(BS_List *list, const uint8_t *data, int id)
{
// find where the new element should be inserted
// see: return value of find()
int i = find(list, data);
if (i >= 0) {
// already in list
return false;
}
i = ~i;
// increase the size of the arrays if needed
if (list->n == list->capacity) {
// 1.5 * n + 1
const uint32_t new_capacity = list->n + list->n / 2 + 1;
if (!resize(list, new_capacity)) {
return false;
}
list->capacity = new_capacity;
}
// insert data to element array
assert(list->data != nullptr);
memmove(list->data + (i + 1) * list->element_size, list->data + i * list->element_size,
(list->n - i) * list->element_size);
memcpy(list->data + i * list->element_size, data, list->element_size);
// insert id to id array
memmove(&list->ids[i + 1], &list->ids[i], (list->n - i) * sizeof(int));
list->ids[i] = id;
// increase n
++list->n;
return true;
}
bool bs_list_remove(BS_List *list, const uint8_t *data, int id)
{
const int i = find(list, data);
if (i < 0) {
return false;
}
if (list->ids[i] != id) {
// this should never happen
return false;
}
// decrease the size of the arrays if needed
if (list->n < list->capacity / 2) {
const uint32_t new_capacity = list->capacity / 2;
if (resize(list, new_capacity)) {
list->capacity = new_capacity;
}
}
--list->n;
memmove(list->data + i * list->element_size, list->data + (i + 1) * list->element_size,
(list->n - i) * list->element_size);
memmove(&list->ids[i], &list->ids[i + 1], (list->n - i) * sizeof(int));
return true;
}