usermode/library/common/chhash.h

Go to the documentation of this file.

/*
    Copyright (C) 2011 Computer Sciences Department, 
    University of Wisconsin -- Madison

    ----------------------------------------------------------------------

    This file is part of Mnemosyne: Lightweight Persistent Memory, 
    originally developed at the University of Wisconsin -- Madison.

    Mnemosyne was originally developed primarily by Haris Volos
    with contributions from Andres Jaan Tack.

    ----------------------------------------------------------------------

    Mnemosyne is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License
    as published by the Free Software Foundation, version 2
    of the License.
 
    Mnemosyne is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, 
    Boston, MA  02110-1301, USA.

### END HEADER ###
*/

#ifndef _M_HASH_H
#define _M_HASH_H

#include "mtypes.h"
#include "result.h"

#define HASH_FACTOR 4

/* Opaque structure used to represent hash table. */
typedef struct m_chhash_s m_chhash_t;

/* Opaque structure used to represent hash table iterator. */
typedef struct m_chhash_iter_s m_chhash_iter_t;

typedef uintptr_t m_chhash_key_t;
typedef void *m_chhash_value_t;
typedef struct m_chhash_bucket_s m_chhash_bucket_t;

struct m_chhash_iter_s {
        m_chhash_t        *chhash;
        unsigned int      index;
        m_chhash_bucket_t *bucket;
};


m_result_t m_chhash_create(m_chhash_t**, unsigned int, bool);
m_result_t m_chhash_destroy(m_chhash_t**);
m_result_t m_chhash_add(m_chhash_t*, m_chhash_key_t, m_chhash_value_t);
m_result_t m_chhash_lookup(m_chhash_t*, m_chhash_key_t, m_chhash_value_t *);
m_result_t m_chhash_remove(m_chhash_t*, m_chhash_key_t, m_chhash_value_t *);
void m_chhash_iter_init(m_chhash_t *chhash, m_chhash_iter_t *iter);
m_result_t m_chhash_iter_next(m_chhash_iter_t *iter, m_chhash_key_t *key, m_chhash_value_t *value);
void m_chhash_print(m_chhash_t *);
#endif

---