Section 3: library functions
ck_bitmap_test – determine if the bit at the specified index is set LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_bitmap.h Ft bool Fn ck_bitmap_test ck_bitmap_t *bitmap unsigned int n DescriptionThe Fn ck_bitmap_test determines if the bit at the offset specified by the argument Fa n is set to 1 Return ValuesThis function returns true if the bit…
ck_bitmap_size – returns necessary number of bytes for bitmap LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_bitmap.h Ft unsigned int Fn ck_bitmap_size unsigned int n_bits DescriptionThe Fn ck_bitmap_size function returns the number of bytes that are necessary to allocate for a bitmap that will contain the number of bits specified by Fa n_bits . This function is…
ck_bitmap_set – set the bit at the specified index LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_bitmap.h Ft void Fn ck_bitmap_set ck_bitmap_t *bitmap unsigned int n DescriptionThe Fn ck_bitmap_set sets the bit at offset specified by the argument Fa n to 1 Return ValuesThis function has no return value. See Alsock_bitmap_base3, ck_bitmap_size3, ck_bitmap_init3, ck_bitmap_reset3, ck_bitmap_clear3, ck_bitmap_test3, ck_bitmap_bits3,…
ck_bitmap_reset – resets the bit at the specified index LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_bitmap.h Ft void Fn ck_bitmap_reset ck_bitmap_t *bitmap unsigned int n DescriptionThe Fn ck_bitmap_reset resets the bit at offset specified by the argument Fa n to 0 Return ValuesThis function has no return value. See Alsock_bitmap_base3, ck_bitmap_size3, ck_bitmap_init3, ck_bitmap_set3, ck_bitmap_clear3, ck_bitmap_test3, ck_bitmap_bits3,…
ck_bitmap_next – iterate to the next set bit in bitmap LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_bitmap.h Ft bool Fn ck_bitmap_next ck_bitmap_t *bitmap ck_bitmap_iterator_t iterator unsigned int *bit DescriptionThe Fn ck_bitmap_next function will increment the iterator object pointed to by Fa iterator to point to the next set bit in the bitmap. If Fn ck_bitmap_next returns…
ck_bitmap_iterator_init – initialize bitmap iterator LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft void Fn ck_bitmap_iterator_init ck_bitmap_iterator_t *iterator ck_bitmap_t *bitmap DescriptionThe Fn ck_bitmap_iterator_init function will initialize the object pointed to by the Fa iterator argument for use with Fa bitmap . An iterator is used to iterate through set bitmap bits with the ck_bitmap_next3 function. Return…
ck_bitmap_init – initialize a bitmap LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_bitmap.h Ft void Fn ck_bitmap_init ck_bitmap_t *bitmap unsigned int n_bits bool set DescriptionThe Fn ck_bitmap_init function initializes the bitmap pointed to by the Fa bitmap pointer. The argument Fa n_bits specifies the number of bits that are to be stored in the bitmap. The argument…
ck_bitmap_clear – reset all bits LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_bitmap.h Ft void Fn ck_bitmap_clear ck_bitmap_t *bitmap DescriptionThe Fn ck_bitmap_clear function sets all bits in the bitmap pointed to by Fa bitmap to 0. Return ValuesThis function has no return value. See Alsock_bitmap_base3, ck_bitmap_size3, ck_bitmap_init3, ck_bitmap_set3, ck_bitmap_reset3, ck_bitmap_test3, ck_bitmap_bits3, ck_bitmap_buffer3 Additional information available at http://concurrencykit.org/
ck_bitmap_buffer – returns pointer to bit array LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_bitmap.h Ft void * Fn ck_bitmap_buffer ck_bitmap_t *bitmap DescriptionThe Fn ck_bitmap_buffer functions returns a pointer to the actual bit array. For ck_bitmap pointers, the bit array is of type CK_BITMAP_WORD[] and consists of ck_bitmap_base(bitmap) / sizeof(CK_BITMAP_WORD) elements. On currently supported 64-bit platforms CK_BITMAP_WORD…
ck_bitmap_bts – set the bit at the specified index and fetch its original value LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_bitmap.h Ft bool Fn ck_bitmap_bts ck_bitmap_t *bitmap unsigned int n DescriptionFn ck_bitmap_bts sets the bit at the offset specified by the argument Fa n to 1 and fetches its original value. Return ValuesThis function returns the…
ck_bitmap_bits – return number of addressable bits in bitmap LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_bitmap.h Ft unsigned int Fn ck_bitmap_bits ck_bitmap_t *bitmap DescriptionThe Fn ck_bitmap_bits function returns the maximum number of addressable bits in the object pointed to by Fa bitmap . Return ValuesThis function returns a non-zero value. See Alsock_bitmap_base3, ck_bitmap_size3, ck_bitmap_init3, ck_bitmap_set3, ck_bitmap_reset3,…
ck_bitmap_base – determine the size of a bit array in bytes LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_bitmap.h Ft unsigned int Fn ck_bitmap_base unsigned int n_bits DescriptionThe Fn ck_bitmap_base function returns the number of bytes that would be used to store the number of bits specified by Fa n_bits . Return ValuesThis function returns a non-zero…
ck_array_remove – attempt immediate or deferred removal of a pointer from an array LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_array.h Ft bool Fn ck_array_remove ck_array_t *array void *pointer DescriptionThe Fn ck_array_remove 3 function will attempt to remove the value of Fa pointer into the array pointed to by Fa array . The operation is also free…
ck_array_put_unique – attempt immediate or deferred insertion of a unique pointer into array LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_array.h Ft int Fn ck_array_put_unique ck_array_t *array void *pointer DescriptionThe Fn ck_array_put_unique 3 function will attempt to insert the value of Fa pointer into the array pointed to by Fa array . This function may incur additional…
ck_array_put – attempt immediate or deferred insertion of a pointer into array LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_array.h Ft bool Fn ck_array_put ck_array_t *array void *pointer DescriptionThe Fn ck_array_put 3 function will attempt to insert the value of Fa pointer into the array pointed to by Fa array . This function may incur additional memory…
ck_array_length – returns the number of pointers committed to an array LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_array.h Ft unsigned int Fn ck_array_length ck_array_t *array DescriptionThe Fn ck_array_length 3 function returns the number of items a concurrent traversal operation would encounter at completion time. Return ValuesThe number of traversal-visible pointers is returned. See Alsock_array_commit3, ck_array_put3, ck_array_put_unique3,…
ck_array_initialized – indicates whether an array was recently initialized or deinitialized LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_array.h Ft bool Fn ck_array_initialized ck_array_t *array DescriptionThe Fn ck_array_initialized 3 can be used to determine whether an array was recently initialized with Fn ck_array_init 3 or deinitialized with Fn ck_array_deinit 3 . Behavior is undefined if a user…
ck_array_init – initialize a pointer array LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_array.h Ft bool Fn ck_array_init ck_array_t *array unsigned int mode struct ck_malloc *allocator unsigned int initial_length DescriptionThe Fn ck_array_init 3 function initializes the array pointed to by the argument Fa array . The mode value must be CK_ARRAY_MODE_SPMC The Fa allocator argument must point…
ck_array_deinit – destroy and deinitialize a pointer array LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_array.h Ft void Fn ck_array_deinit ck_array_t *array bool defer DescriptionThe Fn ck_array_deinit 3 destroys the memory associated with the array pointed to by Fa array . The Fa defer argument is true if the allocator must destroy the memory using safe memory…
ck_array_commit – linearization point for mutations before commit call LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_array.h Ft bool Fn ck_array_commit ck_array_t *array DescriptionThe Fn ck_array_commit 3 function will commit any pending put or remove operations associated with the array. The function may end up requesting the safe reclamation of memory actively being iterated upon by other…