xref: /illumos-gate/usr/src/lib/libpool/common/dict.h (revision 1a2d662a91cee3bf82f41cd47c7ae6f3825d9db2)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright 2003 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef	_DICT_H
28 #define	_DICT_H
29 
30 #ifdef	__cplusplus
31 extern "C" {
32 #endif
33 
34 typedef struct dict_hdl dict_hdl_t;
35 
36 /*
37  * Hash functions
38  */
39 
40 extern uint64_t		hash_buf(const void *, size_t);
41 extern uint64_t		hash_str(const char *);
42 
43 /*
44  * Dictionary functions
45  */
46 extern void		dict_free(dict_hdl_t **);
47 extern uint64_t		dict_length(dict_hdl_t *);
48 extern dict_hdl_t	*dict_new(int (*)(const void *, const void *),
49     uint64_t (*)(const void *));
50 
51 /*
52  * Dictionary entry functions
53  */
54 
55 extern void		*dict_get(dict_hdl_t *, const void *);
56 extern void		*dict_put(dict_hdl_t *, const void *, void *);
57 extern void		*dict_remove(dict_hdl_t *, const void *);
58 
59 extern void		dict_map(dict_hdl_t *,
60     void (*)(const void *, void **, void *), void *);
61 
62 /*
63  * Dictionary conversion
64  */
65 
66 #ifdef	__cplusplus
67 }
68 #endif
69 
70 #endif	/* _DICT_H */
71