source: mainline/kernel/generic/include/adt/hash_table.h@ 8bb0af7f

/*
 * Copyright (c) 2006 Jakub Jermar
 * Copyright (c) 2012 Adam Hraska
 *
 * All rights reserved.
 *
 * 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.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 */

/** @addtogroup kernel_generic
 * @{
 */
/** @file
 */

#ifndef KERNEL_HASH_TABLE_H_
#define KERNEL_HASH_TABLE_H_

#include <adt/list.h>
#include <stdbool.h>
#include <macros.h>
#include <member.h>

/** Opaque hash table link type. */
typedef struct ht_link {
        link_t link;
} ht_link_t;

/** Set of operations for hash table. */
typedef struct {
        /** Returns the hash of the key stored in the item (ie its lookup key). */
        size_t (*hash)(const ht_link_t *item);

        /** Returns the hash of the key. */
        size_t (*key_hash)(const void *key);

        /** True if the items are equal (have the same lookup keys). */
        bool (*equal)(const ht_link_t *item1, const ht_link_t *item2);

        /** Returns true if the key is equal to the item's lookup key. */
        bool (*key_equal)(const void *key, const ht_link_t *item);

        /** Hash table item removal callback.
         *
         * Must not invoke any mutating functions of the hash table.
         *
         * @param item Item that was removed from the hash table.
         */
        void (*remove_callback)(ht_link_t *item);
} hash_table_ops_t;

/** Hash table structure. */
typedef struct {
        hash_table_ops_t *op;
        list_t *bucket;
        size_t bucket_cnt;
        size_t full_item_cnt;
        size_t item_cnt;
        size_t max_load;
        bool apply_ongoing;
} hash_table_t;

#define hash_table_get_inst(item, type, member) \
        member_to_inst((item), type, member)

extern bool hash_table_create(hash_table_t *, size_t, size_t,
    hash_table_ops_t *);
extern void hash_table_destroy(hash_table_t *);

extern bool hash_table_empty(hash_table_t *);
extern size_t hash_table_size(hash_table_t *);

extern void hash_table_clear(hash_table_t *);
extern void hash_table_insert(hash_table_t *, ht_link_t *);
extern bool hash_table_insert_unique(hash_table_t *, ht_link_t *);
extern ht_link_t *hash_table_find(const hash_table_t *, const void *);
extern ht_link_t *hash_table_find_next(const hash_table_t *, ht_link_t *,
    ht_link_t *);
extern size_t hash_table_remove(hash_table_t *, const void *);
extern void hash_table_remove_item(hash_table_t *, ht_link_t *);
extern void hash_table_apply(hash_table_t *, bool (*)(ht_link_t *, void *),
    void *);

#endif

/** @}
 */