- remove some now unnecessary firm_config.h
[libfirm] / include / libfirm / adt / hashptr.h
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief       Hash function for pointers
23  * @author      Michael Beck, Sebastian Hack
24  * @version     $Id$
25  */
26 #ifndef FIRM_ADT_HASHPTR_H
27 #define FIRM_ADT_HASHPTR_H
28
29 #define _FIRM_FNV_OFFSET_BASIS 2166136261U
30 #define _FIRM_FNV_FNV_PRIME 16777619U
31
32 /* Computing x * _FIRM_FNV_FNV_PRIME */
33 #define _FIRM_FNV_TIMES_PRIME(x) ((x) * _FIRM_FNV_FNV_PRIME)
34
35 static inline unsigned firm_fnv_hash(const unsigned char *data, unsigned bytes)
36 {
37         unsigned i;
38         unsigned hash = _FIRM_FNV_OFFSET_BASIS;
39
40         for(i = 0; i < bytes; ++i) {
41                 hash = _FIRM_FNV_TIMES_PRIME(hash);
42                 hash ^= data[i];
43         }
44
45         return hash;
46 }
47
48 static inline unsigned firm_fnv_hash_str(const char *data)
49 {
50         unsigned i;
51         unsigned hash = _FIRM_FNV_OFFSET_BASIS;
52
53         for(i = 0; data[i] != '\0'; ++i) {
54                 hash = _FIRM_FNV_TIMES_PRIME(hash);
55                 hash ^= data[i];
56         }
57
58         return hash;
59 }
60
61 /**
62  * hash a pointer value: Pointer addresses are mostly aligned to 4
63  * or 8 bytes. So we remove the lowest 3 bits
64  */
65 #define HASH_PTR(ptr)    ((unsigned)(((char *) (ptr) - (char *)0) >> 3))
66
67 /**
68  * Hash a string.
69  * @param str The string (can be const).
70  * @param len The length of the string.
71  * @return A hash value for the string.
72  */
73 #define HASH_STR(str,len) firm_fnv_hash((const unsigned char *) (str), (len))
74
75 #ifdef _MSC_VER
76 #pragma warning(disable:4307)
77 #endif /* _MSC_VER */
78
79 static inline unsigned _hash_combine(unsigned x, unsigned y)
80 {
81   unsigned hash = _FIRM_FNV_TIMES_PRIME(_FIRM_FNV_OFFSET_BASIS);
82   hash ^= x;
83   hash  = _FIRM_FNV_TIMES_PRIME(hash);
84   hash ^= y;
85   return hash;
86 }
87
88 #ifdef _MSC_VER
89 #pragma warning(default:4307)
90 #endif /* _MSC_VER */
91
92 /**
93  * Make one hash value out of two others.
94  * @param a One hash value.
95  * @param b Another hash value.
96  * @return A hash value computed from the both.
97  */
98 #define HASH_COMBINE(a,b) _hash_combine(a, b)
99
100 #endif