This function allows for explicit execution of all deferred callbacks in an epoch_record. The primary motivation is currently for performance profiling but there are other use-cases where best-effort semantics could be applied.ck_pring
Samy Al Bahra
12 years ago
parent
281b5ad045
commit
4132ec4998
@ -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/
|
||||
Loading…
Reference in new issue