|
|
|
|
.\"
|
|
|
|
|
.\" 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 July 18, 2013
|
|
|
|
|
.Dt CK_HS_MOVE 3
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm ck_hs_move
|
|
|
|
|
.Nd move one from hash set to another
|
|
|
|
|
.Sh LIBRARY
|
|
|
|
|
Concurrency Kit (libck, \-lck)
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.In ck_hs.h
|
|
|
|
|
.Ft bool
|
|
|
|
|
.Fn ck_hs_move "ck_hs_t *destination" "ck_hs_t *source" "ck_hs_hash_cb_t *hash_cb" "ck_hs_compare_cb_t *compare_cb" "struct ck_malloc *m"
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Fn ck_hs_move 3
|
|
|
|
|
function will initialize
|
|
|
|
|
.Fa source
|
|
|
|
|
from
|
|
|
|
|
.Fa destination .
|
|
|
|
|
The hash function is set to
|
|
|
|
|
.Fa hash_cb ,
|
|
|
|
|
comparison function to
|
|
|
|
|
.Fa compare_cb
|
|
|
|
|
and the allocator callbacks to
|
|
|
|
|
.Fa m .
|
|
|
|
|
Further modifications to
|
|
|
|
|
.Fa source
|
|
|
|
|
will result in undefined behavior. Concurrent
|
|
|
|
|
.Xr ck_hs_get 3
|
|
|
|
|
and
|
|
|
|
|
.Xr ck_hs_fas 3
|
|
|
|
|
operations to
|
|
|
|
|
.Fa source
|
|
|
|
|
are legal until the next write operation to
|
|
|
|
|
.Fa destination .
|
|
|
|
|
.Pp
|
|
|
|
|
This operation moves ownership from one hash set object
|
|
|
|
|
to another and re-assigns callback functions to developer-specified
|
|
|
|
|
values. This allows for dynamic configuration of allocation
|
|
|
|
|
callbacks and is necessary for use-cases involving executable code
|
|
|
|
|
which may be unmapped underneath the hash set.
|
|
|
|
|
.Sh RETURN VALUES
|
|
|
|
|
Upon successful completion
|
|
|
|
|
.Fn ck_hs_move 3
|
|
|
|
|
returns true and otherwise returns false to indicate an error.
|
|
|
|
|
.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_put 3 ,
|
|
|
|
|
.Xr ck_hs_set 3 ,
|
|
|
|
|
.Xr ck_hs_fas 3 ,
|
|
|
|
|
.Xr ck_hs_remove 3 ,
|
|
|
|
|
.Xr ck_hs_grow 3 ,
|
|
|
|
|
.Xr ck_hs_count 3 ,
|
|
|
|
|
.Xr ck_hs_reset 3 ,
|
|
|
|
|
.Xr ck_hs_reset_size 3 ,
|
|
|
|
|
.Xr ck_hs_stat 3
|
|
|
|
|
.Pp
|
|
|
|
|
Additional information available at http://concurrencykit.org/
|
