CK_HS_GC(3) BSD Library Functions Manual CK_HS_GC(3)NAMEck_hs_gc — perform maintenance on a hash set
LIBRARY
Concurrency Kit (libck, -lck)
SYNOPSIS
#include <ck_hs.h>
bool
ck_hs_gc(ck_hs_t *hs, unsigned long cycles, unsigned long seed);
DESCRIPTION
The ck_hs_gc(3) function will perform various maintenance routines on the
hash set pointed to by hs, including defragmentation of probe sequences
with respect to tombstones and in the case that the delete workload hint
has been passed, recalculation of probe sequence bounds. The cycles argu‐
ment is used to indicate how many hash set entries should be subject to
attempted maintenance. If cycles is 0, then maintenance is performed on
the complete hash set. The seed argument determines the start location of
the maintenance process. If cycles is non-zero, it is recommended that
seed is some random value. If the delete hint has been passed, the func‐
tion will require an additional 12% of memory (with respect to existing
memory usage of the set), until operation completion.
RETURN VALUES
Upon successful completion, ck_hs_gc(3) returns true and otherwise
returns false on failure due to memory allocation failure.
ERRORS
This function will only return false if there are internal memory alloca‐
tion failures.
SEE ALSOck_hs_init(3), ck_hs_move(3), ck_hs_destroy(3), CK_HS_HASH(3),
ck_hs_iterator_init(3), ck_hs_next(3), ck_hs_get(3), ck_hs_put(3),
ck_hs_put_unique(3), ck_hs_grow(3), ck_hs_rebuild(3), ck_hs_set(3),
ck_hs_fas(3), ck_hs_remove(3), ck_hs_count(3), ck_hs_reset(3),
ck_hs_reset_size(3), ck_hs_stat(3)
Additional information available at http://concurrencykit.org/
December 17, 2013
