Merge branch 'master' of https://github.com/sbahra/ck
Brendon Scheinman
12 years ago
commit
c5934b47ae
@ -0,0 +1,92 @@
|
|||||||
|
.\"
|
||||||
|
.\" Copyright 2013 Samy Al Bahra.
|
||||||
|
.\" All rights reserved.
|
||||||
|
.\"
|
||||||
|
.\" Redistribution and use in source and binary forms, with or without
|
||||||
|
.\" modification, are permitted provided that the following conditions
|
||||||
|
.\" are met:
|
||||||
|
.\" 1. Redistributions of source code must retain the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer.
|
||||||
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer in the
|
||||||
|
.\" documentation and/or other materials provided with the distribution.
|
||||||
|
.\"
|
||||||
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
||||||
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||||
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
||||||
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||||
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||||
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||||
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||||
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||||
|
.\" SUCH DAMAGE.
|
||||||
|
.\"
|
||||||
|
.\"
|
||||||
|
.Dd May 2, 2013
|
||||||
|
.Dt CK_EPOCH_RECLAIM 3
|
||||||
|
.Sh NAME
|
||||||
|
.Nm ck_epoch_reclaim
|
||||||
|
.Nd immediately execute all deferred callbacks
|
||||||
|
.Sh LIBRARY
|
||||||
|
Concurrency Kit (libck, \-lck)
|
||||||
|
.Sh SYNOPSIS
|
||||||
|
.In ck_epoch.h
|
||||||
|
.Ft void
|
||||||
|
.Fn ck_epoch_reclaim "ck_epoch_record_t *record"
|
||||||
|
.Sh DESCRIPTION
|
||||||
|
The
|
||||||
|
.Fn ck_epoch_reclaim 3
|
||||||
|
function will unconditionally execute all callbacks
|
||||||
|
that have been deferred with
|
||||||
|
.Fn ck_epoch_call 3 .
|
||||||
|
.Sh EXAMPLE
|
||||||
|
.Bd -literal -offset indent
|
||||||
|
|
||||||
|
#include <ck_epoch.h>
|
||||||
|
#include <ck_stack.h>
|
||||||
|
#include <stdlib.h>
|
||||||
|
|
||||||
|
/*
|
||||||
|
* epoch was previously initialized with ck_epoch_init.
|
||||||
|
*/
|
||||||
|
ck_epoch_t *epoch;
|
||||||
|
|
||||||
|
void
|
||||||
|
function(void)
|
||||||
|
{
|
||||||
|
ck_epoch_record_t *record;
|
||||||
|
|
||||||
|
logically_delete(object);
|
||||||
|
ck_epoch_call(epoch, record, &object->epoch_entry, destructor);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Wait until no threads could possibly have a reference to the
|
||||||
|
* object we just deleted.
|
||||||
|
*/
|
||||||
|
ck_epoch_synchronize(epoch, record);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Execute all deferred callbacks.
|
||||||
|
*/
|
||||||
|
ck_epoch_reclaim(record);
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
.Ed
|
||||||
|
.Sh RETURN VALUES
|
||||||
|
This function has no return value.
|
||||||
|
.Sh SEE ALSO
|
||||||
|
.Xr ck_epoch_init 3 ,
|
||||||
|
.Xr ck_epoch_register 3 ,
|
||||||
|
.Xr ck_epoch_unregister 3 ,
|
||||||
|
.Xr ck_epoch_recycle 3 ,
|
||||||
|
.Xr ck_epoch_poll 3 ,
|
||||||
|
.Xr ck_epoch_reclaim 3 ,
|
||||||
|
.Xr ck_epoch_barrier 3 ,
|
||||||
|
.Xr ck_epoch_call 3 ,
|
||||||
|
.Xr ck_epoch_begin 3 ,
|
||||||
|
.Xr ck_epoch_end 3
|
||||||
|
.Pp
|
||||||
|
Additional information available at http://concurrencykit.org/
|
||||||
@ -0,0 +1,75 @@
|
|||||||
|
.\"
|
||||||
|
.\" Copyright 2012-2013 Samy Al Bahra.
|
||||||
|
.\" All rights reserved.
|
||||||
|
.\"
|
||||||
|
.\" Redistribution and use in source and binary forms, with or without
|
||||||
|
.\" modification, are permitted provided that the following conditions
|
||||||
|
.\" are met:
|
||||||
|
.\" 1. Redistributions of source code must retain the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer.
|
||||||
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer in the
|
||||||
|
.\" documentation and/or other materials provided with the distribution.
|
||||||
|
.\"
|
||||||
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
||||||
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||||
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
||||||
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||||
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||||
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||||
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||||
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||||
|
.\" SUCH DAMAGE.
|
||||||
|
.\"
|
||||||
|
.\"
|
||||||
|
.Dd May 5, 2013
|
||||||
|
.Dt CK_HS_RESET_SIZE 3
|
||||||
|
.Sh NAME
|
||||||
|
.Nm ck_hs_reset_size
|
||||||
|
.Nd remove all keys from a hash set
|
||||||
|
.Sh LIBRARY
|
||||||
|
Concurrency Kit (libck, \-lck)
|
||||||
|
.Sh SYNOPSIS
|
||||||
|
.In ck_hs.h
|
||||||
|
.Ft bool
|
||||||
|
.Fn ck_hs_reset_size "ck_hs_t *hs" "unsigned long size"
|
||||||
|
.Sh DESCRIPTION
|
||||||
|
The
|
||||||
|
.Fn ck_hs_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 the hash set that
|
||||||
|
is preallocated for
|
||||||
|
.Fa size
|
||||||
|
entries.
|
||||||
|
.Sh RETURN VALUES
|
||||||
|
If successful,
|
||||||
|
.Fn ck_hs_reset_size 3
|
||||||
|
will return true and will otherwise return false on failure. This
|
||||||
|
function will only fail if a replacement hash set could not be
|
||||||
|
allocated internally.
|
||||||
|
.Sh ERRORS
|
||||||
|
Behavior is undefined if
|
||||||
|
.Fa hs
|
||||||
|
is uninitialized. Behavior is
|
||||||
|
undefined if this function is called by a non-writer
|
||||||
|
thread.
|
||||||
|
.Sh SEE ALSO
|
||||||
|
.Xr ck_hs_init 3 ,
|
||||||
|
.Xr ck_hs_destroy 3 ,
|
||||||
|
.Xr CK_HS_HASH 3 ,
|
||||||
|
.Xr ck_hs_iterator_init 3 ,
|
||||||
|
.Xr ck_hs_next 3 ,
|
||||||
|
.Xr ck_hs_get 3 ,
|
||||||
|
.Xr ck_hs_put 3 ,
|
||||||
|
.Xr ck_hs_set 3 ,
|
||||||
|
.Xr ck_hs_remove 3 ,
|
||||||
|
.Xr ck_hs_grow 3 ,
|
||||||
|
.Xr ck_hs_count 3 ,
|
||||||
|
.Xr ck_hs_reset 3 ,
|
||||||
|
.Xr ck_hs_stat 3
|
||||||
|
.Pp
|
||||||
|
Additional information available at http://concurrencykit.org/
|
||||||
@ -0,0 +1,83 @@
|
|||||||
|
.\"
|
||||||
|
.\" Copyright 2012-2013 Samy Al Bahra.
|
||||||
|
.\" All rights reserved.
|
||||||
|
.\"
|
||||||
|
.\" Redistribution and use in source and binary forms, with or without
|
||||||
|
.\" modification, are permitted provided that the following conditions
|
||||||
|
.\" are met:
|
||||||
|
.\" 1. Redistributions of source code must retain the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer.
|
||||||
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer in the
|
||||||
|
.\" documentation and/or other materials provided with the distribution.
|
||||||
|
.\"
|
||||||
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
||||||
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||||
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
||||||
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||||
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||||
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||||
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||||
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||||
|
.\" SUCH DAMAGE.
|
||||||
|
.\"
|
||||||
|
.\"
|
||||||
|
.Dd May 5, 2013
|
||||||
|
.Dt CK_HT_RESET_SPMC 3
|
||||||
|
.Sh NAME
|
||||||
|
.Nm ck_ht_reset_size_spmc
|
||||||
|
.Nd remove all entries from a hash table and reset size
|
||||||
|
.Sh LIBRARY
|
||||||
|
Concurrency Kit (libck, \-lck)
|
||||||
|
.Sh SYNOPSIS
|
||||||
|
.In ck_ht.h
|
||||||
|
.Ft bool
|
||||||
|
.Fn ck_ht_reset_size_spmc "ck_ht_t *ht" "uint64_t capacity"
|
||||||
|
.Sh DESCRIPTION
|
||||||
|
The
|
||||||
|
.Fn ck_ht_reset_size_spmc
|
||||||
|
function will remove all key-value pairs stored in the hash
|
||||||
|
table pointed to by the
|
||||||
|
.Fa ht
|
||||||
|
argument and create a new generation of the hash table that
|
||||||
|
is preallocated for
|
||||||
|
.Fa capacity
|
||||||
|
entries.
|
||||||
|
.Sh RETURN VALUES
|
||||||
|
If successful,
|
||||||
|
.Fn ck_ht_reset_size_spmc
|
||||||
|
will return
|
||||||
|
.Dv true
|
||||||
|
and will otherwise return
|
||||||
|
.Dv false.
|
||||||
|
This function will only fail if a replacement hash table
|
||||||
|
could not be allocated internally.
|
||||||
|
.Sh SEE ALSO
|
||||||
|
.Xr ck_ht_stat 3 ,
|
||||||
|
.Xr ck_ht_init 3 ,
|
||||||
|
.Xr ck_ht_destroy 3 ,
|
||||||
|
.Xr ck_ht_hash 3 ,
|
||||||
|
.Xr ck_ht_hash_direct 3 ,
|
||||||
|
.Xr ck_ht_set_spmc 3 ,
|
||||||
|
.Xr ck_ht_put_spmc 3 ,
|
||||||
|
.Xr ck_ht_get_spmc 3 ,
|
||||||
|
.Xr ck_ht_grow_spmc 3 ,
|
||||||
|
.Xr ck_ht_remove_spmc 3 ,
|
||||||
|
.Xr ck_ht_count 3 ,
|
||||||
|
.Xr ck_ht_entry_empty 3 ,
|
||||||
|
.Xr ck_ht_entry_key_set 3 ,
|
||||||
|
.Xr ck_ht_entry_key_set_direct 3 ,
|
||||||
|
.Xr ck_ht_entry_key 3 ,
|
||||||
|
.Xr ck_ht_entry_key_length 3 ,
|
||||||
|
.Xr ck_ht_entry_value 3 ,
|
||||||
|
.Xr ck_ht_entry_set 3 ,
|
||||||
|
.Xr ck_ht_entry_set_direct 3 ,
|
||||||
|
.Xr ck_ht_reset_spmc 3 ,
|
||||||
|
.Xr ck_ht_entry_key_direct 3 ,
|
||||||
|
.Xr ck_ht_entry_value_direct 3 ,
|
||||||
|
.Xr ck_ht_iterator_init 3 ,
|
||||||
|
.Xr ck_ht_next 3
|
||||||
|
.Pp
|
||||||
|
Additional information available at http://concurrencykit.org/
|
||||||
@ -0,0 +1,55 @@
|
|||||||
|
.\"
|
||||||
|
.\" Copyright 2012-2013 Samy Al Bahra.
|
||||||
|
.\" All rights reserved.
|
||||||
|
.\"
|
||||||
|
.\" Redistribution and use in source and binary forms, with or without
|
||||||
|
.\" modification, are permitted provided that the following conditions
|
||||||
|
.\" are met:
|
||||||
|
.\" 1. Redistributions of source code must retain the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer.
|
||||||
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer in the
|
||||||
|
.\" documentation and/or other materials provided with the distribution.
|
||||||
|
.\"
|
||||||
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
||||||
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||||
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
||||||
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||||
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||||
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||||
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||||
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||||
|
.\" SUCH DAMAGE.
|
||||||
|
.\"
|
||||||
|
.\"
|
||||||
|
.Dd April 20, 2013
|
||||||
|
.Dt CK_RING_CAPACITY 3
|
||||||
|
.Sh NAME
|
||||||
|
.Nm ck_ring_capacity
|
||||||
|
.Nd returns number of pointer slots in bounded FIFO
|
||||||
|
.Sh LIBRARY
|
||||||
|
Concurrency Kit (libck, \-lck)
|
||||||
|
.Sh SYNOPSIS
|
||||||
|
.In ck_ring.h
|
||||||
|
.Ft unsigned int
|
||||||
|
.Fn ck_ring_capacity "ck_ring_t *ring"
|
||||||
|
.Sh 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 .
|
||||||
|
.Sh SEE ALSO
|
||||||
|
.Xr ck_ring_init 3 ,
|
||||||
|
.Xr ck_ring_enqueue_spmc 3 ,
|
||||||
|
.Xr ck_ring_dequeue_spmc 3 ,
|
||||||
|
.Xr ck_ring_trydequeue_spmc 3 ,
|
||||||
|
.Xr ck_ring_enqueue_spmc_size 3 ,
|
||||||
|
.Xr ck_ring_dequeue_spsc 3 ,
|
||||||
|
.Xr ck_ring_enqueue_spsc 3 ,
|
||||||
|
.Xr ck_ring_enqueue_spsc_size 3 ,
|
||||||
|
.Xr ck_ring_size 3
|
||||||
|
.Pp
|
||||||
|
Additional information available at http://concurrencykit.org/
|
||||||
@ -0,0 +1,55 @@
|
|||||||
|
.\"
|
||||||
|
.\" Copyright 2012-2013 Samy Al Bahra.
|
||||||
|
.\" All rights reserved.
|
||||||
|
.\"
|
||||||
|
.\" Redistribution and use in source and binary forms, with or without
|
||||||
|
.\" modification, are permitted provided that the following conditions
|
||||||
|
.\" are met:
|
||||||
|
.\" 1. Redistributions of source code must retain the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer.
|
||||||
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||||
|
.\" notice, this list of conditions and the following disclaimer in the
|
||||||
|
.\" documentation and/or other materials provided with the distribution.
|
||||||
|
.\"
|
||||||
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
||||||
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||||
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
||||||
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||||
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||||
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||||
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||||
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||||
|
.\" SUCH DAMAGE.
|
||||||
|
.\"
|
||||||
|
.\"
|
||||||
|
.Dd April 20, 2013
|
||||||
|
.Dt CK_RING_SIZE 3
|
||||||
|
.Sh NAME
|
||||||
|
.Nm ck_ring_size
|
||||||
|
.Nd return number of pointers enqueued in bounded FIFO
|
||||||
|
.Sh LIBRARY
|
||||||
|
Concurrency Kit (libck, \-lck)
|
||||||
|
.Sh SYNOPSIS
|
||||||
|
.In ck_ring.h
|
||||||
|
.Ft unsigned int
|
||||||
|
.Fn ck_ring_size "ck_ring_t *ring"
|
||||||
|
.Sh DESCRIPTION
|
||||||
|
The
|
||||||
|
.Fn ck_ring_size 3
|
||||||
|
function returns the number of pointers currently
|
||||||
|
enqueued in the buffer pointed to by
|
||||||
|
.Fa ring .
|
||||||
|
.Sh SEE ALSO
|
||||||
|
.Xr ck_ring_init 3 ,
|
||||||
|
.Xr ck_ring_enqueue_spmc 3 ,
|
||||||
|
.Xr ck_ring_dequeue_spmc 3 ,
|
||||||
|
.Xr ck_ring_trydequeue_spmc 3 ,
|
||||||
|
.Xr ck_ring_enqueue_spmc_size 3 ,
|
||||||
|
.Xr ck_ring_dequeue_spsc 3 ,
|
||||||
|
.Xr ck_ring_enqueue_spsc 3 ,
|
||||||
|
.Xr ck_ring_enqueue_spsc_size 3 ,
|
||||||
|
.Xr ck_ring_capacity 3
|
||||||
|
.Pp
|
||||||
|
Additional information available at http://concurrencykit.org/
|
||||||
Loading…
Reference in new issue