1e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin/************************************************************************** 2e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * 3e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas. 4e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * All Rights Reserved. 5e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * 6e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * Permission is hereby granted, free of charge, to any person obtaining a 7e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * copy of this software and associated documentation files (the 8e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * "Software"), to deal in the Software without restriction, including 9e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * without limitation the rights to use, copy, modify, merge, publish, 10e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * distribute, sub license, and/or sell copies of the Software, and to 11e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * permit persons to whom the Software is furnished to do so, subject to 12e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * the following conditions: 13e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * 14e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * The above copyright notice and this permission notice (including the 15e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * next paragraph) shall be included in all copies or substantial portions 16e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * of the Software. 17e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * 18e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 19e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 20e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 21e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR 22e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 23e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 24e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 25e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin * 26e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin **************************************************************************/ 27e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin 28a1d56728655a3fc87360b45ac8b348bcfdf6ac15Zack Rusin/** 29e584eb888fac90783c5f62333a39e6735be3e488José Fonseca * @file 30e584eb888fac90783c5f62333a39e6735be3e488José Fonseca * Hash table implementation. 31e584eb888fac90783c5f62333a39e6735be3e488José Fonseca * 32e584eb888fac90783c5f62333a39e6735be3e488José Fonseca * This file provides a hash implementation that is capable of dealing 33e584eb888fac90783c5f62333a39e6735be3e488José Fonseca * with collisions. It stores colliding entries in linked list. All 34e584eb888fac90783c5f62333a39e6735be3e488José Fonseca * functions operating on the hash return an iterator. The iterator 35e584eb888fac90783c5f62333a39e6735be3e488José Fonseca * itself points to the collision list. If there wasn't any collision 36e584eb888fac90783c5f62333a39e6735be3e488José Fonseca * the list will have just one entry, otherwise client code should 37e584eb888fac90783c5f62333a39e6735be3e488José Fonseca * iterate over the entries to find the exact entry among ones that 38e584eb888fac90783c5f62333a39e6735be3e488José Fonseca * had the same key (e.g. memcmp could be used on the data to check 39e584eb888fac90783c5f62333a39e6735be3e488José Fonseca * that) 40e584eb888fac90783c5f62333a39e6735be3e488José Fonseca * 41e584eb888fac90783c5f62333a39e6735be3e488José Fonseca * @author Zack Rusin <zack@tungstengraphics.com> 42e584eb888fac90783c5f62333a39e6735be3e488José Fonseca */ 43e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin 44e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin#ifndef CSO_HASH_H 45e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin#define CSO_HASH_H 46e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin 474fe186f8dc4fc7eeab3b1069c886458cfc2e517cAlan Hourihane#include "pipe/p_compiler.h" 48901b03e84dce21f4241375da179b2199a3162e0cJosé Fonseca 49901b03e84dce21f4241375da179b2199a3162e0cJosé Fonseca#ifdef __cplusplus 50901b03e84dce21f4241375da179b2199a3162e0cJosé Fonsecaextern "C" { 51901b03e84dce21f4241375da179b2199a3162e0cJosé Fonseca#endif 52901b03e84dce21f4241375da179b2199a3162e0cJosé Fonseca 53e584eb888fac90783c5f62333a39e6735be3e488José Fonseca 54e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusinstruct cso_hash; 55e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusinstruct cso_node; 56e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin 57e584eb888fac90783c5f62333a39e6735be3e488José Fonseca 58e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusinstruct cso_hash_iter { 59e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin struct cso_hash *hash; 60e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin struct cso_node *node; 61e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin}; 62e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin 63e584eb888fac90783c5f62333a39e6735be3e488José Fonseca 64e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusinstruct cso_hash *cso_hash_create(void); 657838aaffdb9d34427ebcb73aac585c85d9622018Zack Rusinvoid cso_hash_delete(struct cso_hash *hash); 667838aaffdb9d34427ebcb73aac585c85d9622018Zack Rusin 67e584eb888fac90783c5f62333a39e6735be3e488José Fonseca 687838aaffdb9d34427ebcb73aac585c85d9622018Zack Rusinint cso_hash_size(struct cso_hash *hash); 69e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin 70e584eb888fac90783c5f62333a39e6735be3e488José Fonseca 71e584eb888fac90783c5f62333a39e6735be3e488José Fonseca/** 72a889928d85ac8ba7e1a7fe15393858a9422cf750Zack Rusin * Adds a data with the given key to the hash. If entry with the given 73a889928d85ac8ba7e1a7fe15393858a9422cf750Zack Rusin * key is already in the hash, this current entry is instered before it 74a889928d85ac8ba7e1a7fe15393858a9422cf750Zack Rusin * in the collision list. 75a889928d85ac8ba7e1a7fe15393858a9422cf750Zack Rusin * Function returns iterator pointing to the inserted item in the hash. 76e584eb888fac90783c5f62333a39e6735be3e488José Fonseca */ 77e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusinstruct cso_hash_iter cso_hash_insert(struct cso_hash *hash, unsigned key, 78e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin void *data); 79a889928d85ac8ba7e1a7fe15393858a9422cf750Zack Rusin/** 80a889928d85ac8ba7e1a7fe15393858a9422cf750Zack Rusin * Removes the item pointed to by the current iterator from the hash. 81a889928d85ac8ba7e1a7fe15393858a9422cf750Zack Rusin * Note that the data itself is not erased and if it was a malloc'ed pointer 82a889928d85ac8ba7e1a7fe15393858a9422cf750Zack Rusin * it will have to be freed after calling this function by the callee. 83a889928d85ac8ba7e1a7fe15393858a9422cf750Zack Rusin * Function returns iterator pointing to the item after the removed one in 84a889928d85ac8ba7e1a7fe15393858a9422cf750Zack Rusin * the hash. 85a889928d85ac8ba7e1a7fe15393858a9422cf750Zack Rusin */ 86a889928d85ac8ba7e1a7fe15393858a9422cf750Zack Rusinstruct cso_hash_iter cso_hash_erase(struct cso_hash *hash, struct cso_hash_iter iter); 87e584eb888fac90783c5f62333a39e6735be3e488José Fonseca 88e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusinvoid *cso_hash_take(struct cso_hash *hash, unsigned key); 89e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin 90e584eb888fac90783c5f62333a39e6735be3e488José Fonseca 91a889928d85ac8ba7e1a7fe15393858a9422cf750Zack Rusin 92e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusinstruct cso_hash_iter cso_hash_first_node(struct cso_hash *hash); 93e584eb888fac90783c5f62333a39e6735be3e488José Fonseca 94e584eb888fac90783c5f62333a39e6735be3e488José Fonseca/** 95e584eb888fac90783c5f62333a39e6735be3e488José Fonseca * Return an iterator pointing to the first entry in the collision list. 96e584eb888fac90783c5f62333a39e6735be3e488José Fonseca */ 97e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusinstruct cso_hash_iter cso_hash_find(struct cso_hash *hash, unsigned key); 98e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin 994fe186f8dc4fc7eeab3b1069c886458cfc2e517cAlan Hourihane/** 1004fe186f8dc4fc7eeab3b1069c886458cfc2e517cAlan Hourihane * Returns true if a value with the given key exists in the hash 1014fe186f8dc4fc7eeab3b1069c886458cfc2e517cAlan Hourihane */ 1024fe186f8dc4fc7eeab3b1069c886458cfc2e517cAlan Hourihaneboolean cso_hash_contains(struct cso_hash *hash, unsigned key); 1034fe186f8dc4fc7eeab3b1069c886458cfc2e517cAlan Hourihane 104e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin 105e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusinint cso_hash_iter_is_null(struct cso_hash_iter iter); 106e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusinunsigned cso_hash_iter_key(struct cso_hash_iter iter); 107e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusinvoid *cso_hash_iter_data(struct cso_hash_iter iter); 108e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin 109e584eb888fac90783c5f62333a39e6735be3e488José Fonseca 110e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusinstruct cso_hash_iter cso_hash_iter_next(struct cso_hash_iter iter); 111e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusinstruct cso_hash_iter cso_hash_iter_prev(struct cso_hash_iter iter); 112e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin 1136c597238b2e168b63738ac8cc9167c1d09185aadJosé Fonseca 114e584eb888fac90783c5f62333a39e6735be3e488José Fonseca/** 1155fcd84ab39318a371253b1a7285bc657fb82efedZack Rusin * Convenience routine to iterate over the collision list while doing a memory 116e584eb888fac90783c5f62333a39e6735be3e488José Fonseca * comparison to see which entry in the list is a direct copy of our template 117e584eb888fac90783c5f62333a39e6735be3e488José Fonseca * and returns that entry. 118a889928d85ac8ba7e1a7fe15393858a9422cf750Zack Rusin */ 1196c597238b2e168b63738ac8cc9167c1d09185aadJosé Fonsecavoid *cso_hash_find_data_from_template( struct cso_hash *hash, 1205fcd84ab39318a371253b1a7285bc657fb82efedZack Rusin unsigned hash_key, 1216c597238b2e168b63738ac8cc9167c1d09185aadJosé Fonseca void *templ, 1226c597238b2e168b63738ac8cc9167c1d09185aadJosé Fonseca int size ); 1236c597238b2e168b63738ac8cc9167c1d09185aadJosé Fonseca 1246c597238b2e168b63738ac8cc9167c1d09185aadJosé Fonseca 125901b03e84dce21f4241375da179b2199a3162e0cJosé Fonseca#ifdef __cplusplus 126901b03e84dce21f4241375da179b2199a3162e0cJosé Fonseca} 127901b03e84dce21f4241375da179b2199a3162e0cJosé Fonseca#endif 128901b03e84dce21f4241375da179b2199a3162e0cJosé Fonseca 129e16c045b83f5c5b4f4064df67623bb76b46b6619Zack Rusin#endif 130