summaryrefslogtreecommitdiff
path: root/src/gallium/auxiliary/cso_cache/cso_hash.h
blob: 84b45a5963ebc96be230c9a81cb7f0812d6254f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
/**************************************************************************
 *
 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 **************************************************************************/

/**
 This file provides a hash implementation that is capable of dealing
 with collisions. It stores colliding entries in linked list. All
 functions operating on the hash return an iterator. The iterator
 itself points to the collision list. If there wasn't any collision
 the list will have just one entry, otherwise client code should
 iterate over the entries to find the exact entry among ones that
 had the same key (e.g. memcmp could be used on the data to check
 that)
*/
 /*
  * Authors:
  *   Zack Rusin <zack@tungstengraphics.com>
  */

#ifndef CSO_HASH_H
#define CSO_HASH_H


#ifdef	__cplusplus
extern "C" {
#endif

struct cso_hash;
struct cso_node;

struct cso_hash_iter {
   struct cso_hash *hash;
   struct cso_node  *node;
};

struct cso_hash *cso_hash_create(void);
void             cso_hash_delete(struct cso_hash *hash);

int              cso_hash_size(struct cso_hash *hash);

struct cso_hash_iter cso_hash_insert(struct cso_hash *hash, unsigned key,
                                     void *data);
void  *cso_hash_take(struct cso_hash *hash, unsigned key);

struct cso_hash_iter cso_hash_first_node(struct cso_hash *hash);
struct cso_hash_iter cso_hash_find(struct cso_hash *hash, unsigned key);


int       cso_hash_iter_is_null(struct cso_hash_iter iter);
unsigned  cso_hash_iter_key(struct cso_hash_iter iter);
void     *cso_hash_iter_data(struct cso_hash_iter iter);

struct cso_hash_iter cso_hash_iter_next(struct cso_hash_iter iter);
struct cso_hash_iter cso_hash_iter_prev(struct cso_hash_iter iter);


/* KW: a convenience routine: 
 */
void *cso_hash_find_data_from_template( struct cso_hash *hash,
				        unsigned hash_key, 
				        void *templ,
				        int size );


#ifdef	__cplusplus
}
#endif

#endif