Section 3: library functions
NAME ck_rwcohort – generalized interface for reader-writer locks using cohort locks LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rwcohort.h In each of the following macros, "STRATEGY" should be replaced with either "NEUTRAL", "RP", or "WP" depending on which locking strategy the user prefers. RP and WP represent reader preference and writer preference, respectively, while NEUTRAL…
NAME ck_ring_trydequeue_spmc – dequeue from bounded FIFO and allow for spurious failure LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ring.h Ft bool Fn ck_ring_trydequeue_spmc ck_ring_t *ring ck_ring_buffer_t *buffer void *result DESCRIPTION The Fn ck_ring_trydequeue_spmc 3 function attempts to dequeue a pointer from the bounded buffer pointed to by Fa ring in FIFO fashion. The pointer…
NAME ck_ring_size – return number of pointers enqueued in bounded FIFO LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ring.h Ft unsigned int Fn ck_ring_size ck_ring_t *ring DESCRIPTION The Fn ck_ring_size 3 function returns the number of pointers currently enqueued in the buffer pointed to by Fa ring . SEE ALSO ck_ring_init3, ck_ring_enqueue_spmc3, ck_ring_dequeue_spmc3, ck_ring_trydequeue_spmc3, ck_ring_enqueue_spmc_size3,…
NAME ck_ring_init – initialize bounded FIFO LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ring.h Ft void Fn ck_ring_init ck_ring_t *ring unsigned int size DESCRIPTION The Fn ck_ring_init function initializes a bounded FIFO buffer pointed to by Fa ring for the storage of up to Fa size number of pointers. The Fa size argument must be…
NAME ck_ring_enqueue_spsc_size – enqueue pointer into bounded FIFO and return size of buffer LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ring.h Ft bool Fn ck_ring_enqueue_spsc_size ck_ring_t *ring ck_ring_buffer_t *buffer void *entry unsigned int *size DESCRIPTION The Fn ck_ring_enqueue_spsc_size 3 function enqueues the pointer Fa entry into the bounded buffer pointed to by Fa ring in…
NAME ck_ring_enqueue_spsc – enqueue pointer into bounded FIFO LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ring.h Ft bool Fn ck_ring_enqueue_spsc ck_ring_t *ring ck_ring_buffer_t *buffer void *entry DESCRIPTION The Fn ck_ring_enqueue_spsc 3 function enqueues the pointer Fa entry into the bounded buffer pointed to by Fa ring in FIFO fashion. The buffer pointed to by Fa…
NAME ck_ring_enqueue_spmc_size – enqueue pointer into bounded FIFO and return size of buffer LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ring.h Ft bool Fn ck_ring_enqueue_spmc_size ck_ring_t *ring ck_ring_buffer_t *buffer void *entry unsigned int *length DESCRIPTION The Fn ck_ring_enqueue_spmc 3 function enqueues the pointer Fa entry into the bounded buffer pointed to by Fa ring in…
NAME ck_ring_enqueue_spmc – enqueue pointer into bounded FIFO LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ring.h Ft bool Fn ck_ring_enqueue_spmc ck_ring_t *ring ck_ring_buffer_t *buffer void *entry DESCRIPTION The Fn ck_ring_enqueue_spmc 3 function enqueues the pointer Fa entry into the bounded buffer pointed to by Fa ring in FIFO fashion. The buffer pointed to by Fa…
NAME ck_ring_dequeue_spsc – dequeue pointer from bounded FIFO LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ring.h Ft bool Fn ck_ring_dequeue_spsc ck_ring_t *ring ck_ring_buffer_t *buffer void *result DESCRIPTION The Fn ck_ring_dequeue_spsc 3 function dequeues a pointer from the bounded buffer pointed to by Fa ring in FIFO fashion. The pointer is stored in the pointer pointed…
NAME ck_ring_dequeue_spmc – dequeue pointer from bounded FIFO LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ring.h Ft bool Fn ck_ring_dequeue_spmc ck_ring_t *ring ck_ring_buffer_t *buffer void *result DESCRIPTION The Fn ck_ring_dequeue_spmc 3 function dequeues a pointer from the bounded buffer pointed to by Fa ring in FIFO fashion. The pointer is stored in the pointer pointed…
NAME ck_ring_capacity – returns number of pointer slots in bounded FIFO LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ring.h Ft unsigned int Fn ck_ring_capacity ck_ring_t *ring DESCRIPTION The Fn ck_ring_capacity 3 function returns the number of pointers that can be held in the buffer pointed to by Fa ring . Note that a ring can…
NAME ck_rhs_stat – get hash set status LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h Ft void Fn ck_rhs_stat ck_rhs_t *hs struct ck_rhs_stat *st DESCRIPTION The Fn ck_rhs_stat 3 function will store various hash set statistics in the object pointed to by Fa st . The ck_rhs_stat structure is defined as follows: struct ck_rhs_stat {…
NAME ck_rhs_set – store key into a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h Ft bool Fn ck_rhs_set ck_rhs_t *hs unsigned long hash const void *key void **previous DESCRIPTION The Fn ck_rhs_set 3 function will store the key specified by the Fa key argument in the hash set pointed to by the…
NAME ck_rhs_reset_size – remove all keys from a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h Ft bool Fn ck_rhs_reset_size ck_rhs_t *hs unsigned long size DESCRIPTION The Fn ck_rhs_reset_size 3 function will remove all keys stored in the hash set pointed to by the Fa hs argument and create a new generation of…
NAME ck_rhs_reset – remove all keys from a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h Ft bool Fn ck_rhs_reset ck_rhs_t *hs DESCRIPTION The Fn ck_rhs_reset 3 function will remove all keys stored in the hash set pointed to by the Fa hs argument. RETURN VALUES If successful, Fn ck_rhs_reset 3 will return…
NAME ck_rhs_remove – remove key from a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h Ft void * Fn ck_rhs_remove ck_rhs_t *hs unsigned long hash const void *key DESCRIPTION The Fn ck_rhs_remove 3 function will attempt to remove the key specified by the Fa key argument in the hash set pointed to by…
NAME ck_rhs_rebuild – rebuild a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h Ft bool Fn ck_rhs_rebuild ck_rhs_t *hs DESCRIPTION The Fn ck_rhs_rebuild 3 function will regenerate the hash set pointed to by Fa hs . This has the side-effect of pruning degradatory side-effects of workloads that are delete heavy. The regenerated hash…
NAME ck_rhs_put_unique – unconditionally store unique key into a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h Ft bool Fn ck_rhs_put_unique ck_rhs_t *hs unsigned long hash const void *key DESCRIPTION The Fn ck_rhs_put_unique 3 function will store the key specified by the Fa key argument in the hash set pointed to by the…
NAME ck_rhs_put – store unique key into a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h Ft bool Fn ck_rhs_put ck_rhs_t *hs unsigned long hash const void *key DESCRIPTION The Fn ck_rhs_put 3 function will store the key specified by the Fa key argument in the hash set pointed to by the Fa…
NAME ck_rhs_next – iterate to next entry in hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_rhs.h Ft bool Fn ck_rhs_next ck_rhs_t *hs ck_rhs_iterator_t *iterator void **entry DESCRIPTION The Fn ck_rhs_next 3 function will increment the iterator object pointed to by Fa iterator to point to the next non-empty hash set entry. If Fn…