|
|
|
|
.\"
|
|
|
|
|
.\" Copyright 2013 Brendon Scheinman.
|
|
|
|
|
.\" 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 February 24, 2013.
|
|
|
|
|
.Dt CK_RWCOHORT_INSTANCE 3
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm CK_RWCOHORT_INSTANCE
|
|
|
|
|
.Nd declare an instance of a cohort-based reader-writer lock type
|
|
|
|
|
.Sh LIBRARY
|
|
|
|
|
Concurrency Kit (libck, \-lck)
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.In ck_cohort.h
|
|
|
|
|
.Fn CK_RWCOHORT_NEUTRAL_INSTANCE "COHORT_NAME cohort_name"
|
|
|
|
|
.Fn CK_RWCOHORT_RP_INSTANCE "COHORT_NAME cohort_name"
|
|
|
|
|
.Fn CK_RWCOHORT_WP_INSTANCE "COHORT_NAME cohort_name"
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The user must use this macro to declare instances of lock types that they have
|
|
|
|
|
defined using the
|
|
|
|
|
.Xr CK_RWCOHORT_PROTOTYPE 3
|
|
|
|
|
macro. The cohort_name must be the same as the one used in the prototype macro.
|
|
|
|
|
For instance, if CK_RWCOHORT_PROTOTYPE was called with the name "foo", the
|
|
|
|
|
CK_RWCOHORT_INSTANCE macro should be called as
|
|
|
|
|
.br
|
|
|
|
|
CK_RWCOHORT_INSTANCE(foo) cohort;
|
|
|
|
|
.Pp
|
|
|
|
|
This macro should also be used when allocating memory for cohorts. For instance,
|
|
|
|
|
to allocate a block of 4 cohorts:
|
|
|
|
|
.br
|
|
|
|
|
CK_RWCOHORT_WP_INSTANCE(foo) *cohorts = malloc(4 * sizeof(CK_RWCOHORT_WP_INSTANCE(foo)));
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr ck_rwcohort 3 ,
|
|
|
|
|
.Xr CK_RWCOHORT_PROTOTYPE 3 ,
|
|
|
|
|
.Xr CK_RWCOHORT_TRYLOCK_PROTOTYPE 3 ,
|
|
|
|
|
.Xr CK_RWCOHORT_INSTANCE 3 ,
|
|
|
|
|
.Xr CK_RWCOHORT_INITIALIZER 3 ,
|
|
|
|
|
.Xr CK_RWCOHORT_LOCK 3 ,
|
|
|
|
|
.Xr CK_RWCOHORT_UNLOCK 3 ,
|
|
|
|
|
.Xr CK_RWCOHORT_LOCKED 3 ,
|
|
|
|
|
.Xr CK_RWCOHORT_TRYLOCK 3 ,
|
|
|
|
|
.Pp
|
|
|
|
|
Additional information available at http://concurrencykit.org/
|
