1*0Sstevel@tonic-gate /* 2*0Sstevel@tonic-gate * CDDL HEADER START 3*0Sstevel@tonic-gate * 4*0Sstevel@tonic-gate * The contents of this file are subject to the terms of the 5*0Sstevel@tonic-gate * Common Development and Distribution License, Version 1.0 only 6*0Sstevel@tonic-gate * (the "License"). You may not use this file except in compliance 7*0Sstevel@tonic-gate * with the License. 8*0Sstevel@tonic-gate * 9*0Sstevel@tonic-gate * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10*0Sstevel@tonic-gate * or http://www.opensolaris.org/os/licensing. 11*0Sstevel@tonic-gate * See the License for the specific language governing permissions 12*0Sstevel@tonic-gate * and limitations under the License. 13*0Sstevel@tonic-gate * 14*0Sstevel@tonic-gate * When distributing Covered Code, include this CDDL HEADER in each 15*0Sstevel@tonic-gate * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16*0Sstevel@tonic-gate * If applicable, add the following below this CDDL HEADER, with the 17*0Sstevel@tonic-gate * fields enclosed by brackets "[]" replaced with your own identifying 18*0Sstevel@tonic-gate * information: Portions Copyright [yyyy] [name of copyright owner] 19*0Sstevel@tonic-gate * 20*0Sstevel@tonic-gate * CDDL HEADER END 21*0Sstevel@tonic-gate */ 22*0Sstevel@tonic-gate /* 23*0Sstevel@tonic-gate * Copyright 2005 Sun Microsystems, Inc. All rights reserved. 24*0Sstevel@tonic-gate * Use is subject to license terms. 25*0Sstevel@tonic-gate */ 26*0Sstevel@tonic-gate 27*0Sstevel@tonic-gate #ifndef _SYS_MODHASH_H 28*0Sstevel@tonic-gate #define _SYS_MODHASH_H 29*0Sstevel@tonic-gate 30*0Sstevel@tonic-gate #pragma ident "%Z%%M% %I% %E% SMI" 31*0Sstevel@tonic-gate 32*0Sstevel@tonic-gate /* 33*0Sstevel@tonic-gate * Generic hash implementation for the kernel. 34*0Sstevel@tonic-gate */ 35*0Sstevel@tonic-gate 36*0Sstevel@tonic-gate #ifdef __cplusplus 37*0Sstevel@tonic-gate extern "C" { 38*0Sstevel@tonic-gate #endif 39*0Sstevel@tonic-gate 40*0Sstevel@tonic-gate #ifdef _KERNEL 41*0Sstevel@tonic-gate 42*0Sstevel@tonic-gate #include <sys/types.h> 43*0Sstevel@tonic-gate 44*0Sstevel@tonic-gate /* 45*0Sstevel@tonic-gate * Opaque data types for storing keys and values 46*0Sstevel@tonic-gate */ 47*0Sstevel@tonic-gate typedef void *mod_hash_val_t; 48*0Sstevel@tonic-gate typedef void *mod_hash_key_t; 49*0Sstevel@tonic-gate 50*0Sstevel@tonic-gate /* 51*0Sstevel@tonic-gate * Opaque data type for reservation 52*0Sstevel@tonic-gate */ 53*0Sstevel@tonic-gate typedef void *mod_hash_hndl_t; 54*0Sstevel@tonic-gate 55*0Sstevel@tonic-gate /* 56*0Sstevel@tonic-gate * Opaque type for hash itself. 57*0Sstevel@tonic-gate */ 58*0Sstevel@tonic-gate struct mod_hash; 59*0Sstevel@tonic-gate typedef struct mod_hash mod_hash_t; 60*0Sstevel@tonic-gate 61*0Sstevel@tonic-gate /* 62*0Sstevel@tonic-gate * String hash table 63*0Sstevel@tonic-gate */ 64*0Sstevel@tonic-gate mod_hash_t *mod_hash_create_strhash(char *, size_t, void (*)(mod_hash_val_t)); 65*0Sstevel@tonic-gate void mod_hash_destroy_strhash(mod_hash_t *); 66*0Sstevel@tonic-gate int mod_hash_strkey_cmp(mod_hash_key_t, mod_hash_key_t); 67*0Sstevel@tonic-gate void mod_hash_strkey_dtor(mod_hash_key_t); 68*0Sstevel@tonic-gate void mod_hash_strval_dtor(mod_hash_val_t); 69*0Sstevel@tonic-gate uint_t mod_hash_bystr(void *, mod_hash_key_t); 70*0Sstevel@tonic-gate 71*0Sstevel@tonic-gate /* 72*0Sstevel@tonic-gate * Pointer hash table 73*0Sstevel@tonic-gate */ 74*0Sstevel@tonic-gate mod_hash_t *mod_hash_create_ptrhash(char *, size_t, void (*)(mod_hash_val_t), 75*0Sstevel@tonic-gate size_t); 76*0Sstevel@tonic-gate void mod_hash_destroy_ptrhash(mod_hash_t *); 77*0Sstevel@tonic-gate int mod_hash_ptrkey_cmp(mod_hash_key_t, mod_hash_key_t); 78*0Sstevel@tonic-gate uint_t mod_hash_byptr(void *, mod_hash_key_t); 79*0Sstevel@tonic-gate 80*0Sstevel@tonic-gate /* 81*0Sstevel@tonic-gate * ID hash table 82*0Sstevel@tonic-gate */ 83*0Sstevel@tonic-gate mod_hash_t *mod_hash_create_idhash(char *, size_t, void (*)(mod_hash_val_t)); 84*0Sstevel@tonic-gate void mod_hash_destroy_idhash(mod_hash_t *); 85*0Sstevel@tonic-gate int mod_hash_idkey_cmp(mod_hash_key_t, mod_hash_key_t); 86*0Sstevel@tonic-gate uint_t mod_hash_byid(void *, mod_hash_key_t); 87*0Sstevel@tonic-gate uint_t mod_hash_iddata_gen(size_t); 88*0Sstevel@tonic-gate 89*0Sstevel@tonic-gate /* 90*0Sstevel@tonic-gate * Hash management functions 91*0Sstevel@tonic-gate */ 92*0Sstevel@tonic-gate mod_hash_t *mod_hash_create_extended(char *, size_t, void (*)(mod_hash_key_t), 93*0Sstevel@tonic-gate void (*)(mod_hash_val_t), uint_t (*)(void *, mod_hash_key_t), void *, 94*0Sstevel@tonic-gate int (*)(mod_hash_key_t, mod_hash_key_t), int); 95*0Sstevel@tonic-gate 96*0Sstevel@tonic-gate void mod_hash_destroy_hash(mod_hash_t *); 97*0Sstevel@tonic-gate void mod_hash_clear(mod_hash_t *); 98*0Sstevel@tonic-gate 99*0Sstevel@tonic-gate /* 100*0Sstevel@tonic-gate * Null key and value destructors 101*0Sstevel@tonic-gate */ 102*0Sstevel@tonic-gate void mod_hash_null_keydtor(mod_hash_key_t); 103*0Sstevel@tonic-gate void mod_hash_null_valdtor(mod_hash_val_t); 104*0Sstevel@tonic-gate 105*0Sstevel@tonic-gate /* 106*0Sstevel@tonic-gate * Basic hash operations 107*0Sstevel@tonic-gate */ 108*0Sstevel@tonic-gate 109*0Sstevel@tonic-gate /* 110*0Sstevel@tonic-gate * Error codes for insert, remove, find, destroy. 111*0Sstevel@tonic-gate */ 112*0Sstevel@tonic-gate #define MH_ERR_NOMEM -1 113*0Sstevel@tonic-gate #define MH_ERR_DUPLICATE -2 114*0Sstevel@tonic-gate #define MH_ERR_NOTFOUND -3 115*0Sstevel@tonic-gate 116*0Sstevel@tonic-gate /* 117*0Sstevel@tonic-gate * Return codes for hash walkers 118*0Sstevel@tonic-gate */ 119*0Sstevel@tonic-gate #define MH_WALK_CONTINUE 0 120*0Sstevel@tonic-gate #define MH_WALK_TERMINATE 1 121*0Sstevel@tonic-gate 122*0Sstevel@tonic-gate /* 123*0Sstevel@tonic-gate * Basic hash operations 124*0Sstevel@tonic-gate */ 125*0Sstevel@tonic-gate int mod_hash_insert(mod_hash_t *, mod_hash_key_t, mod_hash_val_t); 126*0Sstevel@tonic-gate int mod_hash_replace(mod_hash_t *, mod_hash_key_t, mod_hash_val_t); 127*0Sstevel@tonic-gate int mod_hash_remove(mod_hash_t *, mod_hash_key_t, mod_hash_val_t *); 128*0Sstevel@tonic-gate int mod_hash_destroy(mod_hash_t *, mod_hash_key_t); 129*0Sstevel@tonic-gate int mod_hash_find(mod_hash_t *, mod_hash_key_t, mod_hash_val_t *); 130*0Sstevel@tonic-gate int mod_hash_find_cb(mod_hash_t *, mod_hash_key_t, mod_hash_val_t *, 131*0Sstevel@tonic-gate void (*)(mod_hash_key_t, mod_hash_val_t)); 132*0Sstevel@tonic-gate void mod_hash_walk(mod_hash_t *, 133*0Sstevel@tonic-gate uint_t (*)(mod_hash_key_t, mod_hash_val_t *, void *), void *); 134*0Sstevel@tonic-gate 135*0Sstevel@tonic-gate /* 136*0Sstevel@tonic-gate * Reserving hash operations 137*0Sstevel@tonic-gate */ 138*0Sstevel@tonic-gate int mod_hash_reserve(mod_hash_t *, mod_hash_hndl_t *); 139*0Sstevel@tonic-gate int mod_hash_reserve_nosleep(mod_hash_t *, mod_hash_hndl_t *); 140*0Sstevel@tonic-gate void mod_hash_cancel(mod_hash_t *, mod_hash_hndl_t *); 141*0Sstevel@tonic-gate int mod_hash_insert_reserve(mod_hash_t *, mod_hash_key_t, mod_hash_val_t, 142*0Sstevel@tonic-gate mod_hash_hndl_t); 143*0Sstevel@tonic-gate 144*0Sstevel@tonic-gate #endif /* _KERNEL */ 145*0Sstevel@tonic-gate 146*0Sstevel@tonic-gate #ifdef __cplusplus 147*0Sstevel@tonic-gate } 148*0Sstevel@tonic-gate #endif 149*0Sstevel@tonic-gate 150*0Sstevel@tonic-gate #endif /* _SYS_MODHASH_H */ 151