slabhash.h

Go to the documentation of this file.

/*
 * util/storage/slabhash.h - hashtable consisting of several smaller tables.
 *
 * Copyright (c) 2007, NLnet Labs. All rights reserved.
 *
 * This software is open source.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * 
 * 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.
 * 
 * Neither the name of the NLNET LABS nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
 * HOLDER 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.
 */

 
#ifndef UTIL_STORAGE_SLABHASH_H
#define UTIL_STORAGE_SLABHASH_H
#include "util/storage/lruhash.h"

#define HASH_DEFAULT_SLABS 4

struct slabhash {
    size_t size;
    uint32_t mask;
    unsigned int shift;
    struct lruhash** array;
};

struct slabhash* slabhash_create(size_t numtables, size_t start_size, 
    size_t maxmem, lruhash_sizefunc_type sizefunc, 
    lruhash_compfunc_type compfunc, lruhash_delkeyfunc_type delkeyfunc, 
    lruhash_deldatafunc_type deldatafunc, void* arg);

void slabhash_delete(struct slabhash* table);

void slabhash_clear(struct slabhash* table);

void slabhash_insert(struct slabhash* table, hashvalue_type hash, 
    struct lruhash_entry* entry, void* data, void* cb_override);

struct lruhash_entry* slabhash_lookup(struct slabhash* table, 
    hashvalue_type hash, void* key, int wr);

void slabhash_remove(struct slabhash* table, hashvalue_type hash, void* key);

void slabhash_status(struct slabhash* table, const char* id, int extended);

size_t slabhash_get_size(struct slabhash* table);

size_t slabhash_get_mem(struct slabhash* table);

struct lruhash* slabhash_gettable(struct slabhash* table, hashvalue_type hash);

void slabhash_setmarkdel(struct slabhash* table, lruhash_markdelfunc_type md);

void slabhash_traverse(struct slabhash* table, int wr,
        void (*func)(struct lruhash_entry*, void*), void* arg);
 
/*
 * Count entries in slabhash.
 * @param table: slabbed hash table;
 * @return the number of items
 */
size_t count_slabhash_entries(struct slabhash* table);
 
/* --- test representation --- */
struct slabhash_testkey {
    int id;
    struct lruhash_entry entry;
};

struct slabhash_testdata {
    int data;
};

size_t test_slabhash_sizefunc(void*, void*);
int test_slabhash_compfunc(void*, void*);
void test_slabhash_delkey(void*, void*);
void test_slabhash_deldata(void*, void*);
/* --- end test representation --- */
 
#endif /* UTIL_STORAGE_SLABHASH_H */