|
|
|
|
.\"
|
|
|
|
|
.\" 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 September 17, 2012
|
|
|
|
|
.Dt CK_HS_STAT 3
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm ck_hs_stat
|
|
|
|
|
.Nd get hash set status
|
|
|
|
|
.Sh LIBRARY
|
|
|
|
|
Concurrency Kit (libck, \-lck)
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.In ck_hs.h
|
|
|
|
|
.Ft void
|
|
|
|
|
.Fn ck_hs_stat "ck_hs_t *hs" "struct ck_hs_stat *st"
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Fn ck_hs_stat 3
|
|
|
|
|
function will store various hash set statistics in
|
|
|
|
|
the object pointed to by
|
|
|
|
|
.Fa st .
|
|
|
|
|
The ck_hs_stat structure is defined as follows:
|
|
|
|
|
.Bd -literal -offset indent
|
|
|
|
|
struct ck_hs_stat {
|
|
|
|
|
unsigned long tombstones; /* Current number of tombstones in hash set. */
|
|
|
|
|
unsigned long n_entries; /* Current number of keys in hash set. */
|
|
|
|
|
unsigned int probe_maximum; /* Longest read-side probe sequence. */
|
|
|
|
|
};
|
|
|
|
|
.Ed
|
|
|
|
|
.Sh RETURN VALUES
|
|
|
|
|
.Fn ck_hs_stat 3
|
|
|
|
|
has no return value.
|
|
|
|
|
.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
|
|
|
|
|
.Pp
|
|
|
|
|
Additional information available at http://concurrencykit.org/
|
