hash_table.c
/* -*- c-basic-offset: 4; indent-tabs-mode: nil -*- */
/* ====================================================================
* Copyright (c) 1999-2004 Carnegie Mellon University. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. 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.
*
* This work was supported in part by funding from the Defense Advanced
* Research Projects Agency and the National Science Foundation of the
* United States of America, and the CMU Sphinx Speech Consortium.
*
* THIS SOFTWARE IS PROVIDED BY CARNEGIE MELLON UNIVERSITY ``AS IS'' AND
* ANY EXPRESSED 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 CARNEGIE MELLON UNIVERSITY
* NOR ITS EMPLOYEES 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.
*
* ====================================================================
*
*/
/*
* hash.c -- Hash table module.
*
* **********************************************
* CMU ARPA Speech Project
*
* Copyright (c) 1999 Carnegie Mellon University.
* ALL RIGHTS RESERVED.
* **********************************************
*
* HISTORY
* $Log: hash.c,v $
* Revision 1.5 2005/06/22 03:04:01 arthchan2003
* 1, Implemented hash_delete and hash_display, 2, Fixed doxygen documentation, 3, Added keyword.
*
* Revision 1.9 2005/05/25 06:17:53 archan
* Delete the test code in cmd_ln.c and fixed platform specific code of hash.c
*
* Revision 1.8 2005/05/24 01:10:54 archan
* Fix a bug when the value only appear in the hash but there is no chain. Also make sure that prev was initialized to NULL. All success cases were tested, but not tested with the deletion is tested.
*
* Revision 1.6 2005/05/24 00:00:45 archan
* Added basic functionalities to hash_t: 1, display and 2, delete a key from a hash. \n
*
* Revision 1.5 2005/05/11 07:01:38 archan
* Added comments on the usage of the current implementation of hash tables.
*
* Revision 1.4 2005/05/03 04:09:11 archan
* Implemented the heart of word copy search. For every ci-phone, every word end, a tree will be allocated to preserve its pathscore. This is different from 3.5 or below, only the best score for a particular ci-phone, regardless of the word-ends will be preserved at every frame. The graph propagation will not collect unused word tree at this point. srch_WST_propagate_wd_lv2 is also as the most stupid in the century. But well, after all, everything needs a start. I will then really get the results from the search and see how it looks.
*
* Revision 1.3 2005/03/30 01:22:48 archan
* Fixed mistakes in last updates. Add
*
*
* 05-May-1999 M K Ravishankar (rkm@cs.cmu.edu) at Carnegie Mellon
* Removed hash_key2hash(). Added hash_enter_bkey() and hash_lookup_bkey(),
* and len attribute to hash_entry_t.
*
* 30-Apr-1999 M K Ravishankar (rkm@cs.cmu.edu) at Carnegie Mellon
* Added hash_key2hash().
*
* 18-Jun-97 M K Ravishankar (rkm@cs.cmu.edu) at Carnegie Mellon
* Included case sensitive/insensitive option. Removed local, static
* maintenance of all hash tables.
*
* 31-Jul-95 M K Ravishankar (rkm@cs.cmu.edu) at Carnegie Mellon
* Created.
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#ifdef _MSC_VER
#pragma warning (disable: 4018)
#endif
#include "sphinxbase/hash_table.h"
#include "sphinxbase/err.h"
#include "sphinxbase/ckd_alloc.h"
#include "sphinxbase/case.h"
#if 0
static void
prime_sieve(int32 max)
{
char *notprime;
int32 p, pp;
notprime = (char *) ckd_calloc(max + 1, 1);
p = 2;
for (;;) {
printf("%d\n", p);
for (pp = p + p; pp <= max; pp += p)
notprime[pp] = 1;
for (++p; (p <= max) && notprime[p]; p++);
if (p > max)
break;
}
}
#endif
/*
* HACK!! Initial hash table size is restricted by this set of primes. (Of course,
* collision resolution by chaining will accommodate more entries indefinitely, but
* efficiency will drop.)
*/
const int32 prime[] = {
101, 211, 307, 401, 503, 601, 701, 809, 907,
1009, 1201, 1601, 2003, 2411, 3001, 4001, 5003, 6007, 7001, 8009,
9001,
10007, 12007, 16001, 20011, 24001, 30011, 40009, 50021, 60013,
70001, 80021, 90001,
100003, 120011, 160001, 200003, 240007, 300007, 400009, 500009,
600011, 700001, 800011, 900001,
-1
};
static int32
prime_size(int32 size)
{
int32 i;
for (i = 0; (prime[i] > 0) && (prime[i] < size); i++);
if (prime[i] <= 0) {
E_WARN("Very large hash table requested (%d entries)\n", size);
--i;
}
return (prime[i]);
}
hash_table_t *
hash_table_new(int32 size, int32 casearg)
{
hash_table_t *h;
h = (hash_table_t *) ckd_calloc(1, sizeof(hash_table_t));
h->size = prime_size(size + (size >> 1));
h->nocase = (casearg == HASH_CASE_NO);
h->table = (hash_entry_t *) ckd_calloc(h->size, sizeof(hash_entry_t));
/* The above calloc clears h->table[*].key and .next to NULL, i.e. an empty table */
return h;
}
/*
* Compute hash value for given key string.
* Somewhat tuned for English text word strings.
*/
static uint32
key2hash(hash_table_t * h, const char *key)
{
register const char *cp;
/*register char c; */
register unsigned char c;
register int32 s;
register uint32 hash;
hash = 0;
s = 0;
if (h->nocase) {
for (cp = key; *cp; cp++) {
c = *cp;
c = UPPER_CASE(c);
hash += c << s;
s += 5;
if (s >= 25)
s -= 24;
}
}
else {
for (cp = key; *cp; cp++) {
hash += (*cp) << s;
s += 5;
if (s >= 25)
s -= 24;
}
}
return (hash % h->size);
}
static char *
makekey(uint8 * data, int32 len, char *key)
{
int32 i, j;
if (!key)
key = (char *) ckd_calloc(len * 2 + 1, sizeof(char));
for (i = 0, j = 0; i < len; i++, j += 2) {
key[j] = 'A' + (data[i] & 0x000f);
key[j + 1] = 'J' + ((data[i] >> 4) & 0x000f);
}
key[j] = '\0';
return key;
}
static int32
keycmp_nocase(hash_entry_t * entry, const char *key)
{
char c1, c2;
int32 i;
const char *str;
str = entry->key;
for (i = 0; i < entry->len; i++) {
c1 = *(str++);
c1 = UPPER_CASE(c1);
c2 = *(key++);
c2 = UPPER_CASE(c2);
if (c1 != c2)
return (c1 - c2);
}
return 0;
}
static int32
keycmp_case(hash_entry_t * entry, const char *key)
{
char c1, c2;
int32 i;
const char *str;
str = entry->key;
for (i = 0; i < entry->len; i++) {
c1 = *(str++);
c2 = *(key++);
if (c1 != c2)
return (c1 - c2);
}
return 0;
}
/*
* Lookup entry with hash-value hash in table h for given key
* Return value: hash_entry_t for key
*/
static hash_entry_t *
lookup(hash_table_t * h, uint32 hash, const char *key, size_t len)
{
hash_entry_t *entry;
entry = &(h->table[hash]);
if (entry->key == NULL)
return NULL;
if (h->nocase) {
while (entry && ((entry->len != len)
|| (keycmp_nocase(entry, key) != 0)))
entry = entry->next;
}
else {
while (entry && ((entry->len != len)
|| (keycmp_case(entry, key) != 0)))
entry = entry->next;
}
return entry;
}
int32
hash_table_lookup(hash_table_t * h, const char *key, void ** val)
{
hash_entry_t *entry;
uint32 hash;
int32 len;
hash = key2hash(h, key);
len = strlen(key);
entry = lookup(h, hash, key, len);
if (entry) {
if (val)
*val = entry->val;
return 0;
}
else
return -1;
}
int32
hash_table_lookup_int32(hash_table_t * h, const char *key, int32 *val)
{
void *vval;
int32 rv;
rv = hash_table_lookup(h, key, &vval);
if (rv != 0)
return rv;
if (val)
*val = (int32)(long)vval;
return 0;
}
int32
hash_table_lookup_bkey(hash_table_t * h, const char *key, size_t len, void ** val)
{
hash_entry_t *entry;
uint32 hash;
char *str;
str = makekey((uint8 *) key, len, NULL);
hash = key2hash(h, str);
ckd_free(str);
entry = lookup(h, hash, key, len);
if (entry) {
if (val)
*val = entry->val;
return 0;
}
else
return -1;
}
int32
hash_table_lookup_bkey_int32(hash_table_t * h, const char *key, size_t len, int32 *val)
{
void *vval;
int32 rv;
rv = hash_table_lookup_bkey(h, key, len, &vval);
if (rv != 0)
return rv;
if (val)
*val = (int32)(long)vval;
return 0;
}
static void *
enter(hash_table_t * h, uint32 hash, const char *key, size_t len, void *val, int32 replace)
{
hash_entry_t *cur, *new;
if ((cur = lookup(h, hash, key, len)) != NULL) {
void *oldval;
/* Key already exists. */
oldval = cur->val;
if (replace) {
/* Replace the pointer if replacement is requested,
* because this might be a different instance of the same
* string (this verges on magic, sorry) */
cur->key = key;
cur->val = val;
}
return oldval;
}
cur = &(h->table[hash]);
if (cur->key == NULL) {
/* Empty slot at hashed location; add this entry */
cur->key = key;
cur->len = len;
cur->val = val;
/* Added by ARCHAN at 20050515. This allows deletion could work. */
cur->next = NULL;
}
else {
/* Key collision; create new entry and link to hashed location */
new = (hash_entry_t *) ckd_calloc(1, sizeof(hash_entry_t));
new->key = key;
new->len = len;
new->val = val;
new->next = cur->next;
cur->next = new;
}
++h->inuse;
return val;
}
/* 20050523 Added by ARCHAN to delete a key from a hash table */
static void *
delete(hash_table_t * h, uint32 hash, const char *key, size_t len)
{
hash_entry_t *entry, *prev;
void *val;
prev = NULL;
entry = &(h->table[hash]);
if (entry->key == NULL)
return NULL;
if (h->nocase) {
while (entry && ((entry->len != len)
|| (keycmp_nocase(entry, key) != 0))) {
prev = entry;
entry = entry->next;
}
}
else {
while (entry && ((entry->len != len)
|| (keycmp_case(entry, key) != 0))) {
prev = entry;
entry = entry->next;
}
}
if (entry == NULL)
return NULL;
/* At this point, entry will be the one required to be deleted, prev
will contain the previous entry
*/
val = entry->val;
if (prev == NULL) {
/* That is to say the entry in the hash table (not the chain) matched the key. */
/* We will then copy the things from the next entry to the hash table */
prev = entry;
if (entry->next) { /* There is a next entry, great, copy it. */
entry = entry->next;
prev->key = entry->key;
prev->len = entry->len;
prev->val = entry->val;
prev->next = entry->next;
ckd_free(entry);
}
else { /* There is not a next entry, just set the key to null */
prev->key = NULL;
prev->len = 0;
prev->next = NULL;
}
}
else { /* This case is simple */
prev->next = entry->next;
ckd_free(entry);
}
/* Do wiring and free the entry */
--h->inuse;
return val;
}
void
hash_table_empty(hash_table_t *h)
{
hash_entry_t *e, *e2;
int32 i;
for (i = 0; i < h->size; i++) {
/* Free collision lists. */
for (e = h->table[i].next; e; e = e2) {
e2 = e->next;
ckd_free((void *) e);
}
memset(&h->table[i], 0, sizeof(h->table[i]));
}
h->inuse = 0;
}
void *
hash_table_enter(hash_table_t * h, const char *key, void *val)
{
uint32 hash;
size_t len;
hash = key2hash(h, key);
len = strlen(key);
return (enter(h, hash, key, len, val, 0));
}
void *
hash_table_replace(hash_table_t * h, const char *key, void *val)
{
uint32 hash;
size_t len;
hash = key2hash(h, key);
len = strlen(key);
return (enter(h, hash, key, len, val, 1));
}
void *
hash_table_delete(hash_table_t * h, const char *key)
{
uint32 hash;
size_t len;
hash = key2hash(h, key);
len = strlen(key);
return (delete(h, hash, key, len));
}
void *
hash_table_enter_bkey(hash_table_t * h, const char *key, size_t len, void *val)
{
uint32 hash;
char *str;
str = makekey((uint8 *) key, len, NULL);
hash = key2hash(h, str);
ckd_free(str);
return (enter(h, hash, key, len, val, 0));
}
void *
hash_table_replace_bkey(hash_table_t * h, const char *key, size_t len, void *val)
{
uint32 hash;
char *str;
str = makekey((uint8 *) key, len, NULL);
hash = key2hash(h, str);
ckd_free(str);
return (enter(h, hash, key, len, val, 1));
}
void *
hash_table_delete_bkey(hash_table_t * h, const char *key, size_t len)
{
uint32 hash;
char *str;
str = makekey((uint8 *) key, len, NULL);
hash = key2hash(h, str);
ckd_free(str);
return (delete(h, hash, key, len));
}
void
hash_table_display(hash_table_t * h, int32 showdisplay)
{
hash_entry_t *e;
int i, j;
j = 0;
E_INFOCONT("Hash with chaining representation of the hash table\n");
for (i = 0; i < h->size; i++) {
e = &(h->table[i]);
if (e->key != NULL) {
E_INFOCONT("|key:");
if (showdisplay)
E_INFOCONT("%s", e->key);
else
E_INFOCONT("%p", e->key);
E_INFOCONT("|len:%d|val=%ld|->", e->len, (long)e->val);
if (e->next == NULL) {
E_INFOCONT("NULL\n");
}
j++;
for (e = e->next; e; e = e->next) {
E_INFOCONT("|key:");
if (showdisplay)
E_INFOCONT("%s", e->key);
E_INFOCONT("|len:%d|val=%ld|->", e->len, (long)e->val);
if (e->next == NULL) {
E_INFOCONT("NULL\n");
}
j++;
}
}
}
E_INFOCONT("The total number of keys =%d\n", j);
}
glist_t
hash_table_tolist(hash_table_t * h, int32 * count)
{
glist_t g;
hash_entry_t *e;
int32 i, j;
g = NULL;
j = 0;
for (i = 0; i < h->size; i++) {
e = &(h->table[i]);
if (e->key != NULL) {
g = glist_add_ptr(g, (void *) e);
j++;
for (e = e->next; e; e = e->next) {
g = glist_add_ptr(g, (void *) e);
j++;
}
}
}
if (count)
*count = j;
return g;
}
hash_iter_t *
hash_table_iter(hash_table_t *h)
{
hash_iter_t *itor;
itor = ckd_calloc(1, sizeof(*itor));
itor->ht = h;
return hash_table_iter_next(itor);
}
hash_iter_t *
hash_table_iter_next(hash_iter_t *itor)
{
/* If there is an entry, walk down its list. */
if (itor->ent)
itor->ent = itor->ent->next;
/* If we got to the end of the chain, or we had no entry, scan
* forward in the table to find the next non-empty bucket. */
if (itor->ent == NULL) {
while (itor->idx < itor->ht->size
&& itor->ht->table[itor->idx].key == NULL)
++itor->idx;
/* If we did not find one then delete the iterator and
* return NULL. */
if (itor->idx == itor->ht->size) {
hash_table_iter_free(itor);
return NULL;
}
/* Otherwise use this next entry. */
itor->ent = itor->ht->table + itor->idx;
/* Increase idx for the next time around. */
++itor->idx;
}
return itor;
}
void
hash_table_iter_free(hash_iter_t *itor)
{
ckd_free(itor);
}
void
hash_table_free(hash_table_t * h)
{
hash_entry_t *e, *e2;
int32 i;
if (h == NULL)
return;
/* Free additional entries created for key collision cases */
for (i = 0; i < h->size; i++) {
for (e = h->table[i].next; e; e = e2) {
e2 = e->next;
ckd_free((void *) e);
}
}
ckd_free((void *) h->table);
ckd_free((void *) h);
}
hash_table_delete_bkey
SPHINXBASE_EXPORT void * hash_table_delete_bkey(hash_table_t *h, const char *key, size_t len)
Like hash_table_delete, but with an explicitly specified key length, instead of a NULL-terminated...
Definition: hash_table.c:568
hash_table_lookup_int32
SPHINXBASE_EXPORT int32 hash_table_lookup_int32(hash_table_t *h, const char *key, int32 *val)
Look up a 32-bit integer value in a hash table.
Definition: hash_table.c:329
hash_table_enter_bkey
SPHINXBASE_EXPORT void * hash_table_enter_bkey(hash_table_t *h, const char *key, size_t len, void *val)
Like hash_table_enter, but with an explicitly specified key length, instead of a NULL-terminated, C-style key string.
Definition: hash_table.c:542
hash_iter_s::ent
hash_entry_t * ent
Current entry in that table.
Definition: hash_table.h:170
hash_table_lookup
SPHINXBASE_EXPORT int32 hash_table_lookup(hash_table_t *h, const char *key, void **val)
Look up a key in a hash table and optionally return the associated value.
Definition: hash_table.c:309
ckd_calloc
#define ckd_calloc(n, sz)
Macros to simplify the use of above functions.
Definition: ckd_alloc.h:248
hash_table_display
SPHINXBASE_EXPORT void hash_table_display(hash_table_t *h, int32 showkey)
Display a hash-with-chaining representation on the screen.
Definition: hash_table.c:581
hash_table_lookup_bkey
SPHINXBASE_EXPORT int32 hash_table_lookup_bkey(hash_table_t *h, const char *key, size_t len, void **val)
Like hash_lookup, but with an explicitly specified key length, instead of a NULL-terminated, C-style key string.
Definition: hash_table.c:344
hash_table_replace
SPHINXBASE_EXPORT void * hash_table_replace(hash_table_t *h, const char *key, void *val)
Add a new entry with given key and value to hash table h.
Definition: hash_table.c:519
ckd_alloc.h
Sphinx's memory allocation/deallocation routines.
hash_entry_s::next
struct hash_entry_s * next
Value associated with above key.
Definition: hash_table.h:156
hash_table_iter_free
SPHINXBASE_EXPORT void hash_table_iter_free(hash_iter_t *itor)
Delete an unfinished iterator.
Definition: hash_table.c:689
hash_table_tolist
SPHINXBASE_EXPORT glist_t hash_table_tolist(hash_table_t *h, int32 *count)
Build a glist of valid hash_entry_t pointers from the given hash table.
Definition: hash_table.c:623
gnode_s
A node in a generic list.
Definition: glist.h:100
hash_table_iter
SPHINXBASE_EXPORT hash_iter_t * hash_table_iter(hash_table_t *h)
Start iterating over key-value pairs in a hash table.
Definition: hash_table.c:653
hash_table_new
SPHINXBASE_EXPORT hash_table_t * hash_table_new(int32 size, int32 casearg)
Allocate a new hash table for a given expected size.
Definition: hash_table.c:158
hash_table_empty
SPHINXBASE_EXPORT void hash_table_empty(hash_table_t *h)
Delete all entries from a hash_table.
Definition: hash_table.c:490
ckd_free
SPHINXBASE_EXPORT void ckd_free(void *ptr)
Test and free a 1-D array.
Definition: ckd_alloc.c:241
glist_add_ptr
SPHINXBASE_EXPORT glist_t glist_add_ptr(glist_t g, void *ptr)
Create and prepend a new list node, with the given user-defined data, at the HEAD of the given generi...
Definition: glist.c:74
E_WARN
#define E_WARN
Print warning information to standard error stream.
Definition: err.h:164
UPPER_CASE
#define UPPER_CASE(c)
Return upper case form for c.
Definition: case.h:92
hash_table_free
SPHINXBASE_EXPORT void hash_table_free(hash_table_t *h)
Free the specified hash table; the caller is responsible for freeing the key strings pointed to by th...
Definition: hash_table.c:695
hash_entry_s
A note by ARCHAN at 20050510: Technically what we use is so-called "hash table with buckets" which is...
Definition: hash_table.h:149
hash_table_t
Definition: hash_table.h:159
hash_table_lookup_bkey_int32
SPHINXBASE_EXPORT int32 hash_table_lookup_bkey_int32(hash_table_t *h, const char *key, size_t len, int32 *val)
Look up a 32-bit integer value in a hash table.
Definition: hash_table.c:365
hash_table_t::inuse
int32 inuse
Primary hash table size, (is a prime#); NOTE: This is the number of primary entries ALLOCATED...
Definition: hash_table.h:164
hash_entry_s::len
size_t len
Key string, NULL if this is an empty slot.
Definition: hash_table.h:153
hash_iter_s::idx
size_t idx
Index of next bucket to search.
Definition: hash_table.h:171
hash_iter_s::ht
hash_table_t * ht
Hash table we are iterating over.
Definition: hash_table.h:169
hash_table_t::size
int32 size
Primary hash table, excluding entries that collide.
Definition: hash_table.h:161
E_INFOCONT
#define E_INFOCONT
Print logging information without header, to standard error stream.
Definition: err.h:153
err.h
Implementation of logging routines.
hash_iter_s
Definition: hash_table.h:168
hash_table_enter
SPHINXBASE_EXPORT void * hash_table_enter(hash_table_t *h, const char *key, void *val)
Try to add a new entry with given key and associated value to hash table h.
Definition: hash_table.c:508
hash_table_iter_next
SPHINXBASE_EXPORT hash_iter_t * hash_table_iter_next(hash_iter_t *itor)
Get the next key-value pair in iteration.
Definition: hash_table.c:663
hash_table_delete
SPHINXBASE_EXPORT void * hash_table_delete(hash_table_t *h, const char *key)
Delete an entry with given key and associated value to hash table h.
Definition: hash_table.c:530
hash_table.h
Hash table implementation.
hash_entry_s::val
void * val
Key-length; the key string does not have to be a C-style NULL terminated string; it can have arbitrar...
Definition: hash_table.h:155
hash_table_replace_bkey
SPHINXBASE_EXPORT void * hash_table_replace_bkey(hash_table_t *h, const char *key, size_t len, void *val)
Like hash_table_replace, but with an explicitly specified key length, instead of a NULL-terminated...
Definition: hash_table.c:555
hash_table_t::nocase
int32 nocase
Number of valid entries in the table.
Definition: hash_table.h:165
case.h
Locale-independent implementation of case swapping operation.