switch_hashtable.h File Reference

#include "switch.h"

Include dependency graph for switch_hashtable.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	switch_hashtable_insert(_h, _k, _v, _f)   switch_hashtable_insert_destructor(_h, _k, _v, _f, NULL)
#define	DEFINE_HASHTABLE_INSERT(fnname, keytype, valuetype)
#define	DEFINE_HASHTABLE_SEARCH(fnname, keytype, valuetype)
#define	DEFINE_HASHTABLE_REMOVE(fnname, keytype, valuetype)
#define	switch_hashtable_first(_h)   switch_hashtable_first_iter(_h, NULL)

Typedefs
typedef struct switch_hashtable	switch_hashtable_t
typedef struct switch_hashtable_iterator	switch_hashtable_iterator_t

Enumerations
enum	hashtable_flag_t { HASHTABLE_FLAG_NONE = 0, HASHTABLE_FLAG_FREE_KEY = (1 << 0), HASHTABLE_FLAG_FREE_VALUE = (1 << 1), HASHTABLE_DUP_CHECK = (1 << 2) }

Functions
switch_status_t	switch_create_hashtable (switch_hashtable_t **hp, unsigned int minsize, unsigned int(*hashfunction)(void *), int(*key_eq_fn)(void *, void *))
int	switch_hashtable_insert_destructor (switch_hashtable_t *h, void *k, void *v, hashtable_flag_t flags, hashtable_destructor_t destructor)
void *	switch_hashtable_search (switch_hashtable_t *h, void *k)
void *	switch_hashtable_remove (switch_hashtable_t *h, void *k)
unsigned int	switch_hashtable_count (switch_hashtable_t *h)
void	switch_hashtable_destroy (switch_hashtable_t **h)
switch_hashtable_iterator_t *	switch_hashtable_first_iter (switch_hashtable_t *h, switch_hashtable_iterator_t *it)
switch_hashtable_iterator_t *	switch_hashtable_next (switch_hashtable_iterator_t **iP)
void	switch_hashtable_this (switch_hashtable_iterator_t *i, const void **key, switch_ssize_t *klen, void **val)
void	switch_hashtable_this_val (switch_hashtable_iterator_t *i, void *val)
static uint32_t	switch_hash_default_int (void *ky)
static int	switch_hash_equalkeys_int (void *k1, void *k2)
static int	switch_hash_equalkeys (void *k1, void *k2)
static int	switch_hash_equalkeys_ci (void *k1, void *k2)
static uint32_t	switch_hash_default (void *ky)
static uint32_t	switch_hash_default_ci (void *ky)

Macro Definition Documentation

#define DEFINE_HASHTABLE_INSERT	(		fnname,
			keytype,
			valuetype
	)

Value:

int fnname (switch_hashtable_t *h, keytype *k, valuetype *v)    \
        {                                                                                                                       \
		return hashtable_insert(h,k,v);                                                       \
        }

Definition at line 130 of file switch_hashtable.h.

#define DEFINE_HASHTABLE_REMOVE	(		fnname,
			keytype,
			valuetype
	)

Value:

valuetype * fnname (switch_hashtable_t *h, keytype *k)  \
        {                                                                                                               \
		return (valuetype *) (hashtable_remove(h,k));         \
        }

Definition at line 166 of file switch_hashtable.h.

#define DEFINE_HASHTABLE_SEARCH	(		fnname,
			keytype,
			valuetype
	)

Value:

valuetype * fnname (switch_hashtable_t *h, keytype *k)  \
        {                                                                                                               \
		return (valuetype *) (hashtable_search(h,k));         \
        }

Definition at line 148 of file switch_hashtable.h.

#define switch_hashtable_first

(

_h

)

switch_hashtable_first_iter(_h, NULL)

Definition at line 196 of file switch_hashtable.h.

#define switch_hashtable_insert	(		_h,
			_k,
			_v,
			_f
	)		switch_hashtable_insert_destructor(_h, _k, _v, _f, NULL)

Definition at line 128 of file switch_hashtable.h.

Typedef Documentation

typedef struct switch_hashtable_iterator switch_hashtable_iterator_t

Definition at line 25 of file switch_hashtable.h.

typedef struct switch_hashtable switch_hashtable_t

Definition at line 24 of file switch_hashtable.h.

Enumeration Type Documentation

enum hashtable_flag_t

Enumerator
HASHTABLE_FLAG_NONE
HASHTABLE_FLAG_FREE_KEY
HASHTABLE_FLAG_FREE_VALUE
HASHTABLE_DUP_CHECK

Definition at line 119 of file switch_hashtable.h.

             {
        HASHTABLE_FLAG_NONE = 0,
        HASHTABLE_FLAG_FREE_KEY = (1 << 0),
        HASHTABLE_FLAG_FREE_VALUE = (1 << 1),
        HASHTABLE_DUP_CHECK = (1 << 2)
} hashtable_flag_t;

Function Documentation

switch_status_t switch_create_hashtable	(	switch_hashtable_t **	hp,
		unsigned int	minsize,
		unsigned int(*)(void *)	hashfunction,
		int(*)(void *, void *)	key_eq_fn
	)

Definition at line 56 of file switch_hashtable.c.

References switch_hashtable::entrycount, switch_hashtable::eqfn, entry::h, switch_hashtable::hashfn, switch_hashtable::loadlimit, memset(), prime_table_length, switch_hashtable::primeindex, primes, SWITCH_STATUS_FALSE, SWITCH_STATUS_SUCCESS, switch_hashtable::table, and switch_hashtable::tablelength.

Referenced by switch_core_hash_init_case(), and switch_core_inthash_init().

{
        switch_hashtable_t *h;
        unsigned int pindex, size = primes[0];

        /* Check requested hashtable isn't too large */
        if (minsize > (1u << 30)) {*hp = NULL; return SWITCH_STATUS_FALSE;}
        /* Enforce size as prime */
        for (pindex=0; pindex < prime_table_length; pindex++) {
                if (primes[pindex] > minsize) { 
                        size = primes[pindex]; 
                        break; 
                }
        }
        h = (switch_hashtable_t *) malloc(sizeof(switch_hashtable_t));

        if (NULL == h) abort(); /*oom*/

        h->table = (struct entry **)malloc(sizeof(struct entry*) * size);

        if (NULL == h->table) abort(); /*oom*/

        memset(h->table, 0, size * sizeof(struct entry *));
        h->tablelength  = size;
        h->primeindex   = pindex;
        h->entrycount   = 0;
        h->hashfn       = hashf;
        h->eqfn         = eqf;
        h->loadlimit    = (unsigned int) ceil(size * max_load_factor);

        *hp = h;
        return SWITCH_STATUS_SUCCESS;
}

static uint32_t switch_hash_default ( void *  ky )

inlinestatic

Definition at line 224 of file switch_hashtable.h.

References hash.

Referenced by switch_core_hash_init_case().

{
        unsigned char *str = (unsigned char *) ky;
        uint32_t hash = 0;
    int c;
        
        while ((c = *str)) {
                str++;
        hash = c + (hash << 6) + (hash << 16) - hash;
        }

    return hash;
}

static uint32_t switch_hash_default_ci ( void *  ky )

inlinestatic

Definition at line 238 of file switch_hashtable.h.

References hash, and switch_tolower().

Referenced by switch_core_hash_init_case().

{
        unsigned char *str = (unsigned char *) ky;
        uint32_t hash = 0;
    int c;
        
        while ((c = switch_tolower(*str))) {
                str++;
        hash = c + (hash << 6) + (hash << 16) - hash;
        }

    return hash;
}

static uint32_t switch_hash_default_int ( void *  ky )

inlinestatic

Definition at line 201 of file switch_hashtable.h.

Referenced by switch_core_inthash_init().

                                                         {
        uint32_t x = *((uint32_t *)ky);
        x = ((x >> 16) ^ x) * 0x45d9f3b;
        x = ((x >> 16) ^ x) * 0x45d9f3b;
        x = ((x >> 16) ^ x);
        return x;
}

static int switch_hash_equalkeys ( void *  k1, void *  k2  )

inlinestatic

Definition at line 214 of file switch_hashtable.h.

Referenced by switch_core_hash_init_case().

{
    return strcmp((char *) k1, (char *) k2) ? 0 : 1;
}

static int switch_hash_equalkeys_ci ( void *  k1, void *  k2  )

inlinestatic

Definition at line 219 of file switch_hashtable.h.

Referenced by switch_core_hash_init_case().

{
    return strcasecmp((char *) k1, (char *) k2) ? 0 : 1;
}

static int switch_hash_equalkeys_int ( void *  k1, void *  k2  )

inlinestatic

Definition at line 209 of file switch_hashtable.h.

Referenced by switch_core_inthash_init().

{
    return *(uint32_t *)k1 == *(uint32_t *)k2;
}

unsigned int switch_hashtable_count

(

switch_hashtable_t *

h

)

Definition at line 151 of file switch_hashtable.c.

{
        return h->entrycount;
}

void switch_hashtable_destroy

(

switch_hashtable_t **

h

)

Definition at line 253 of file switch_hashtable.c.

References entry::destructor, entry::flags, freekey, HASHTABLE_FLAG_FREE_KEY, HASHTABLE_FLAG_FREE_VALUE, entry::k, entry::next, switch_safe_free, and entry::v.

Referenced by switch_core_hash_destroy(), and switch_core_inthash_destroy().

{
        unsigned int i;
        struct entry *e, *f;
        struct entry **table = (*h)->table;

        for (i = 0; i < (*h)->tablelength; i++) {
                e = table[i];
                while (NULL != e) {
                        f = e; e = e->next; 

                        if (f->flags & HASHTABLE_FLAG_FREE_KEY) {
                                freekey(f->k); 
                        }
                        
                        if (f->flags & HASHTABLE_FLAG_FREE_VALUE) {
                                switch_safe_free(f->v); 
                        } else if (f->destructor) {
                                f->destructor(f->v);
                                f->v = NULL;
                        }
                        switch_safe_free(f); 
                }
        }

        switch_safe_free((*h)->table);
        free(*h);
        *h = NULL;
}

switch_hashtable_iterator_t* switch_hashtable_first_iter	(	switch_hashtable_t *	h,
		switch_hashtable_iterator_t *	it
	)

Definition at line 316 of file switch_hashtable.c.

References switch_hashtable_iterator::e, entry::h, switch_hashtable_iterator::h, switch_hashtable_iterator::pos, switch_assert, switch_hashtable_next(), and switch_zmalloc.

Referenced by switch_core_hash_first_iter().

{
        switch_hashtable_iterator_t *iterator;

        if (it) {
                iterator = it;
        } else {
                switch_zmalloc(iterator, sizeof(*iterator));
        }

        switch_assert(iterator);

        iterator->pos = 0;
        iterator->e = NULL;
        iterator->h = h;

        return switch_hashtable_next(&iterator);
}

int switch_hashtable_insert_destructor	(	switch_hashtable_t *	h,
		void *	k,
		void *	v,
		hashtable_flag_t	flags,
		hashtable_destructor_t	destructor
	)

Definition at line 194 of file switch_hashtable.c.

References _switch_hashtable_remove(), entry::destructor, entry::flags, entry::h, hash, HASHTABLE_DUP_CHECK, hashtable_expand(), indexFor(), entry::k, entry::next, and entry::v.

Referenced by switch_core_hash_insert_destructor(), and switch_core_inthash_insert().

{
        struct entry *e;
        unsigned int hashvalue = hash(h, k);
        unsigned index = indexFor(h->tablelength, hashvalue);

        if (flags & HASHTABLE_DUP_CHECK) {
                _switch_hashtable_remove(h, k, hashvalue, index);
        }

        if (++(h->entrycount) > h->loadlimit)
                {
                        /* Ignore the return value. If expand fails, we should
                         * still try cramming just this value into the existing table
                         * -- we may not have memory for a larger table, but one more
                         * element may be ok. Next time we insert, we'll try expanding again.*/
                        hashtable_expand(h);
                        index = indexFor(h->tablelength, hashvalue);
                }
        e = (struct entry *)malloc(sizeof(struct entry));
        if (NULL == e) { --(h->entrycount); return 0; } /*oom*/
        e->h = hashvalue;
        e->k = k;
        e->v = v;
        e->flags = flags;
        e->destructor = destructor;
        e->next = h->table[index];
        h->table[index] = e;
        return -1;
}

switch_hashtable_iterator_t* switch_hashtable_next

(

switch_hashtable_iterator_t **

iP

)

Definition at line 283 of file switch_hashtable.c.

References switch_hashtable_iterator::e, switch_hashtable_iterator::h, entry::next, switch_hashtable_iterator::pos, switch_hashtable::table, and switch_hashtable::tablelength.

Referenced by switch_core_hash_next(), and switch_hashtable_first_iter().

{

        switch_hashtable_iterator_t *i = *iP;
        
        if (i->e) {
                if ((i->e = i->e->next) != 0) { 
                        return i;
                } else {
                        i->pos++;
                }
        }

        while(i->pos < i->h->tablelength && !i->h->table[i->pos]) {
                i->pos++;
        }
        
        if (i->pos >= i->h->tablelength) {
                goto end;
        }
        
        if ((i->e = i->h->table[i->pos]) != 0) { 
                return i;
        }

 end:

        free(i);
        *iP = NULL;

        return NULL;
}

void* switch_hashtable_remove	(	switch_hashtable_t *	h,
		void *	k
	)

Definition at line 244 of file switch_hashtable.c.

References _switch_hashtable_remove(), hash, and indexFor().

Referenced by switch_core_hash_delete(), and switch_core_inthash_delete().

{
        unsigned int hashvalue = hash(h,k);
        return _switch_hashtable_remove(h, k, hashvalue, indexFor(h->tablelength,hashvalue));
}

void* switch_hashtable_search	(	switch_hashtable_t *	h,
		void *	k
	)

Definition at line 227 of file switch_hashtable.c.

References entry::h, hash, indexFor(), entry::k, entry::next, and entry::v.

Referenced by switch_core_hash_find(), and switch_core_inthash_find().

{
        struct entry *e;
        unsigned int hashvalue, index;
        hashvalue = hash(h,k);
        index = indexFor(h->tablelength,hashvalue);
        e = h->table[index];
        while (NULL != e) {
                /* Check hash value to short circuit heavier comparison */
                if ((hashvalue == e->h) && (h->eqfn(k, e->k))) return e->v;
                e = e->next;
        }
        return NULL;
}

void switch_hashtable_this	(	switch_hashtable_iterator_t *	i,
		const void **	key,
		switch_ssize_t *	klen,
		void **	val
	)

Definition at line 342 of file switch_hashtable.c.

Referenced by switch_core_hash_this().

{
        if (i->e) {
                if (key) {
                        *key = i->e->k;
                }
                if (klen) {
                        *klen = (int)strlen(i->e->k);
                }
                if (val) {
                        *val = i->e->v;
                }
        } else {
                if (key) {
                        *key = NULL;
                }
                if (klen) {
                        *klen = 0;
                }
                if (val) {
                        *val = NULL;
                }
        }
}

void switch_hashtable_this_val	(	switch_hashtable_iterator_t *	i,
		void *	val
	)

Definition at line 335 of file switch_hashtable.c.

Referenced by switch_core_hash_this_val().

{
        if (i->e) {
                i->e->v = val;
        }
}