properly mark symbols in the public API to be exported. This allows us to use -fvisib...
[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 #include "../begin.h"
30
31 #define _FIRM_FNV_OFFSET_BASIS 2166136261U
32 #define _FIRM_FNV_FNV_PRIME 16777619U
33
34 /* Computing x * _FIRM_FNV_FNV_PRIME */
35 #define _FIRM_FNV_TIMES_PRIME(x) ((x) * _FIRM_FNV_FNV_PRIME)
36
37 static inline unsigned firm_fnv_hash(const unsigned char *data, unsigned bytes)
38 {
39         unsigned i;
40         unsigned hash = _FIRM_FNV_OFFSET_BASIS;
41
42         for(i = 0; i < bytes; ++i) {
43                 hash = _FIRM_FNV_TIMES_PRIME(hash);
44                 hash ^= data[i];
45         }
46
47         return hash;
48 }
49
50 static inline unsigned firm_fnv_hash_str(const char *data)
51 {
52         unsigned i;
53         unsigned hash = _FIRM_FNV_OFFSET_BASIS;
54
55         for(i = 0; data[i] != '\0'; ++i) {
56                 hash = _FIRM_FNV_TIMES_PRIME(hash);
57                 hash ^= data[i];
58         }
59
60         return hash;
61 }
62
63 /**
64  * hash a pointer value: Pointer addresses are mostly aligned to 4
65  * or 8 bytes. So we remove the lowest 3 bits
66  */
67 #define HASH_PTR(ptr)    ((unsigned)(((char *) (ptr) - (char *)0) >> 3))
68
69 static inline unsigned hash_ptr(const void *ptr)
70 {
71         return HASH_PTR(ptr);
72 }
73
74 /**
75  * Hash a string.
76  * @param str The string (can be const).
77  * @param len The length of the string.
78  * @return A hash value for the string.
79  */
80 #define HASH_STR(str,len) firm_fnv_hash((const unsigned char *) (str), (len))
81
82 #ifdef _MSC_VER
83 #pragma warning(disable:4307)
84 #endif /* _MSC_VER */
85
86 static inline unsigned _hash_combine(unsigned x, unsigned y)
87 {
88         unsigned hash = _FIRM_FNV_TIMES_PRIME(_FIRM_FNV_OFFSET_BASIS);
89         hash ^= x;
90         hash  = _FIRM_FNV_TIMES_PRIME(hash);
91         hash ^= y;
92         return hash;
93 }
94
95 #ifdef _MSC_VER
96 #pragma warning(default:4307)
97 #endif /* _MSC_VER */
98
99 /**
100  * Make one hash value out of two others.
101  * @param a One hash value.
102  * @param b Another hash value.
103  * @return A hash value computed from the both.
104  */
105 #define HASH_COMBINE(a,b) _hash_combine(a, b)
106
107 #include "../end.h"
108
109 #endif