Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 381 lines (319 sloc) 16.994 kb
573b460 @andigutmans Zend Library
andigutmans authored
1 /*
2 +----------------------------------------------------------------------+
3 | Zend Engine |
4 +----------------------------------------------------------------------+
08659c2 MFH: Bump copyright year, 3 of 3.
Sebastian Bergmann authored
5 | Copyright (c) 1998-2009 Zend Technologies Ltd. (http://www.zend.com) |
573b460 @andigutmans Zend Library
andigutmans authored
6 +----------------------------------------------------------------------+
d863d52 Update headers.
Sebastian Bergmann authored
7 | This source file is subject to version 2.00 of the Zend license, |
b5b1117 @zsuraski License update
zsuraski authored
8 | that is bundled with this package in the file LICENSE, and is |
f68c7ff updating license information in the headers.
James Cox authored
9 | available through the world-wide-web at the following url: |
d863d52 Update headers.
Sebastian Bergmann authored
10 | http://www.zend.com/license/2_00.txt. |
b5b1117 @zsuraski License update
zsuraski authored
11 | If you did not receive a copy of the Zend license and are unable to |
12 | obtain it through the world-wide-web, please send a note to |
13 | license@zend.com so we can mail you a copy immediately. |
573b460 @andigutmans Zend Library
andigutmans authored
14 +----------------------------------------------------------------------+
15 | Authors: Andi Gutmans <andi@zend.com> |
16 | Zeev Suraski <zeev@zend.com> |
17 +----------------------------------------------------------------------+
18 */
19
333406b - Added some missing CVS $Id$ tags, headers and footers.
foobar authored
20 /* $Id$ */
21
a617217 Replace macros which begin with an underscore through an appropiately
Sascha Schumann authored
22 #ifndef ZEND_HASH_H
23 #define ZEND_HASH_H
573b460 @andigutmans Zend Library
andigutmans authored
24
25 #include <sys/types.h>
90f43c7 @andigutmans - This should improve performance on Windows
andigutmans authored
26 #include "zend.h"
573b460 @andigutmans Zend Library
andigutmans authored
27
28 #define HASH_KEY_IS_STRING 1
29 #define HASH_KEY_IS_LONG 2
30 #define HASH_KEY_NON_EXISTANT 3
31
32 #define HASH_UPDATE (1<<0)
33 #define HASH_ADD (1<<1)
34 #define HASH_NEXT_INSERT (1<<2)
35
36 #define HASH_DEL_KEY 0
37 #define HASH_DEL_INDEX 1
2ecf4bb Lazy EG(active_symbol_table) initialization
Dmitry Stogov authored
38 #define HASH_DEL_KEY_QUICK 2
573b460 @andigutmans Zend Library
andigutmans authored
39
37a7693 Fixed bug #44100 (Inconsistent handling of static array declarations …
Dmitry Stogov authored
40 #define HASH_UPDATE_KEY_IF_NONE 0
41 #define HASH_UPDATE_KEY_IF_BEFORE 1
42 #define HASH_UPDATE_KEY_IF_AFTER 2
43 #define HASH_UPDATE_KEY_ANYWAY 3
44
6c810b0 Improved memory usage by movig constants to read only memory. (Dmitry…
Dmitry Stogov authored
45 typedef ulong (*hash_func_t)(const char *arKey, uint nKeyLength);
3bdddb4 MFZE1
Sebastian Bergmann authored
46 typedef int (*compare_func_t)(const void *, const void * TSRMLS_DC);
47 typedef void (*sort_func_t)(void *, size_t, register size_t, compare_func_t TSRMLS_DC);
62114c1 @zsuraski Destructors no longer return ints, the low level problem it was inten…
zsuraski authored
48 typedef void (*dtor_func_t)(void *pDest);
9f51f15 @zsuraski - Stop passing list/plist to internal functions
zsuraski authored
49 typedef void (*copy_ctor_func_t)(void *pElement);
e062dff @zsuraski - Implement public/protected/private methods.
zsuraski authored
50 typedef void (*copy_ctor_param_func_t)(void *pElement, void *pParam);
62114c1 @zsuraski Destructors no longer return ints, the low level problem it was inten…
zsuraski authored
51
9b916e6 rename hastable -> _hashtable to avoid clashes
Thies C. Arntzen authored
52 struct _hashtable;
573b460 @andigutmans Zend Library
andigutmans authored
53
54 typedef struct bucket {
55 ulong h; /* Used for numeric indexing */
56 uint nKeyLength;
57 void *pData;
58 void *pDataPtr;
59 struct bucket *pListNext;
60 struct bucket *pListLast;
61 struct bucket *pNext;
aa73f6b @andigutmans - Hopefully fix the hash problem.
andigutmans authored
62 struct bucket *pLast;
573b460 @andigutmans Zend Library
andigutmans authored
63 char arKey[1]; /* Must be last element */
64 } Bucket;
65
9b916e6 rename hastable -> _hashtable to avoid clashes
Thies C. Arntzen authored
66 typedef struct _hashtable {
573b460 @andigutmans Zend Library
andigutmans authored
67 uint nTableSize;
2f8fa8c @andigutmans - Merge faster hash implementation.
andigutmans authored
68 uint nTableMask;
573b460 @andigutmans Zend Library
andigutmans authored
69 uint nNumOfElements;
70 ulong nNextFreeElement;
71 Bucket *pInternalPointer; /* Used for element traversal */
72 Bucket *pListHead;
73 Bucket *pListTail;
74 Bucket **arBuckets;
62114c1 @zsuraski Destructors no longer return ints, the low level problem it was inten…
zsuraski authored
75 dtor_func_t pDestructor;
38cdb8e @zsuraski Avoid crashing with recursive applies - limit apply nest level to 3 (…
zsuraski authored
76 zend_bool persistent;
77 unsigned char nApplyCount;
1263932 @zsuraski Disable the hash_apply() protection on hashes that persist across req…
zsuraski authored
78 zend_bool bApplyProtection;
c93a189 if ZEND_DEBUG mode is on we'll now see warnings when a HashTable is …
Thies C. Arntzen authored
79 #if ZEND_DEBUG
80 int inconsistent;
81 #endif
573b460 @andigutmans Zend Library
andigutmans authored
82 } HashTable;
83
471947b @zsuraski Reimplement PPP properties
zsuraski authored
84
85 typedef struct _zend_hash_key {
86 char *arKey;
87 uint nKeyLength;
88 ulong h;
89 } zend_hash_key;
90
91
45c1235 @zsuraski Fix prototype (may have caused stack corruption)
zsuraski authored
92 typedef zend_bool (*merge_checker_func_t)(HashTable *target_ht, void *source_data, zend_hash_key *hash_key, void *pParam);
471947b @zsuraski Reimplement PPP properties
zsuraski authored
93
a32c54b Introduced a way to traverse hashes through external pointers.
Andrei Zmievski authored
94 typedef Bucket* HashPosition;
95
fd4650b @zsuraski Add zend_hash_get_current_key_type()
zsuraski authored
96 BEGIN_EXTERN_C()
97
573b460 @andigutmans Zend Library
andigutmans authored
98 /* startup/shutdown */
91b0d03 @zsuraski Add tracking for hashtable allocation
zsuraski authored
99 ZEND_API int _zend_hash_init(HashTable *ht, uint nSize, hash_func_t pHashFunction, dtor_func_t pDestructor, zend_bool persistent ZEND_FILE_LINE_DC);
100 ZEND_API int _zend_hash_init_ex(HashTable *ht, uint nSize, hash_func_t pHashFunction, dtor_func_t pDestructor, zend_bool persistent, zend_bool bApplyProtection ZEND_FILE_LINE_DC);
573b460 @andigutmans Zend Library
andigutmans authored
101 ZEND_API void zend_hash_destroy(HashTable *ht);
102 ZEND_API void zend_hash_clean(HashTable *ht);
91b0d03 @zsuraski Add tracking for hashtable allocation
zsuraski authored
103 #define zend_hash_init(ht, nSize, pHashFunction, pDestructor, persistent) _zend_hash_init((ht), (nSize), (pHashFunction), (pDestructor), (persistent) ZEND_FILE_LINE_CC)
104 #define zend_hash_init_ex(ht, nSize, pHashFunction, pDestructor, persistent, bApplyProtection) _zend_hash_init_ex((ht), (nSize), (pHashFunction), (pDestructor), (persistent), (bApplyProtection) ZEND_FILE_LINE_CC)
573b460 @andigutmans Zend Library
andigutmans authored
105
106 /* additions/updates/changes */
6c810b0 Improved memory usage by movig constants to read only memory. (Dmitry…
Dmitry Stogov authored
107 ZEND_API int _zend_hash_add_or_update(HashTable *ht, const char *arKey, uint nKeyLength, void *pData, uint nDataSize, void **pDest, int flag ZEND_FILE_LINE_DC);
4f6c95d @zsuraski Whitespace
zsuraski authored
108 #define zend_hash_update(ht, arKey, nKeyLength, pData, nDataSize, pDest) \
0dba58c @zsuraski Improve tracking
zsuraski authored
109 _zend_hash_add_or_update(ht, arKey, nKeyLength, pData, nDataSize, pDest, HASH_UPDATE ZEND_FILE_LINE_CC)
4f6c95d @zsuraski Whitespace
zsuraski authored
110 #define zend_hash_add(ht, arKey, nKeyLength, pData, nDataSize, pDest) \
0dba58c @zsuraski Improve tracking
zsuraski authored
111 _zend_hash_add_or_update(ht, arKey, nKeyLength, pData, nDataSize, pDest, HASH_ADD ZEND_FILE_LINE_CC)
4f6c95d @zsuraski Whitespace
zsuraski authored
112
6c810b0 Improved memory usage by movig constants to read only memory. (Dmitry…
Dmitry Stogov authored
113 ZEND_API int _zend_hash_quick_add_or_update(HashTable *ht, const char *arKey, uint nKeyLength, ulong h, void *pData, uint nDataSize, void **pDest, int flag ZEND_FILE_LINE_DC);
4f6c95d @zsuraski Whitespace
zsuraski authored
114 #define zend_hash_quick_update(ht, arKey, nKeyLength, h, pData, nDataSize, pDest) \
0dba58c @zsuraski Improve tracking
zsuraski authored
115 _zend_hash_quick_add_or_update(ht, arKey, nKeyLength, h, pData, nDataSize, pDest, HASH_UPDATE ZEND_FILE_LINE_CC)
4f6c95d @zsuraski Whitespace
zsuraski authored
116 #define zend_hash_quick_add(ht, arKey, nKeyLength, h, pData, nDataSize, pDest) \
0dba58c @zsuraski Improve tracking
zsuraski authored
117 _zend_hash_quick_add_or_update(ht, arKey, nKeyLength, h, pData, nDataSize, pDest, HASH_ADD ZEND_FILE_LINE_CC)
573b460 @andigutmans Zend Library
andigutmans authored
118
0dba58c @zsuraski Improve tracking
zsuraski authored
119 ZEND_API int _zend_hash_index_update_or_next_insert(HashTable *ht, ulong h, void *pData, uint nDataSize, void **pDest, int flag ZEND_FILE_LINE_DC);
4f6c95d @zsuraski Whitespace
zsuraski authored
120 #define zend_hash_index_update(ht, h, pData, nDataSize, pDest) \
0dba58c @zsuraski Improve tracking
zsuraski authored
121 _zend_hash_index_update_or_next_insert(ht, h, pData, nDataSize, pDest, HASH_UPDATE ZEND_FILE_LINE_CC)
4f6c95d @zsuraski Whitespace
zsuraski authored
122 #define zend_hash_next_index_insert(ht, pData, nDataSize, pDest) \
0dba58c @zsuraski Improve tracking
zsuraski authored
123 _zend_hash_index_update_or_next_insert(ht, 0, pData, nDataSize, pDest, HASH_NEXT_INSERT ZEND_FILE_LINE_CC)
573b460 @andigutmans Zend Library
andigutmans authored
124
6c810b0 Improved memory usage by movig constants to read only memory. (Dmitry…
Dmitry Stogov authored
125 ZEND_API int zend_hash_add_empty_element(HashTable *ht, const char *arKey, uint nKeyLength);
755207a @zsuraski Implement zend_hash_add_empty_element() using the existing infrastruc…
zsuraski authored
126
c14baee @zsuraski Avoid going over huge lists of functions, classes and constants.
zsuraski authored
127
128 #define ZEND_HASH_APPLY_KEEP 0
129 #define ZEND_HASH_APPLY_REMOVE 1<<0
130 #define ZEND_HASH_APPLY_STOP 1<<1
131
7deb44e @zsuraski Some cleanup
zsuraski authored
132 typedef int (*apply_func_t)(void *pDest TSRMLS_DC);
133 typedef int (*apply_func_arg_t)(void *pDest, void *argument TSRMLS_DC);
0fbe6a0 @felipensp - MFH: Added TSRMLS_DC to apply_func_args_t and zend_hash_apply_with_…
felipensp authored
134 typedef int (*apply_func_args_t)(void *pDest TSRMLS_DC, int num_args, va_list args, zend_hash_key *hash_key);
b51aa1f Made an alias for hash apply with arguments.
Andrei Zmievski authored
135
ee08b81 @zsuraski - Make zend_hash_apply() (and friends) reentrant and much, much quicker
zsuraski authored
136 ZEND_API void zend_hash_graceful_destroy(HashTable *ht);
bf5bb84 MFZE1: make sure the resource-list is always consistent during shutdo…
Sebastian Bergmann authored
137 ZEND_API void zend_hash_graceful_reverse_destroy(HashTable *ht);
d76cf1d @zsuraski More TSRMLS_FETCH work
zsuraski authored
138 ZEND_API void zend_hash_apply(HashTable *ht, apply_func_t apply_func TSRMLS_DC);
139 ZEND_API void zend_hash_apply_with_argument(HashTable *ht, apply_func_arg_t apply_func, void * TSRMLS_DC);
0fbe6a0 @felipensp - MFH: Added TSRMLS_DC to apply_func_args_t and zend_hash_apply_with_…
felipensp authored
140 ZEND_API void zend_hash_apply_with_arguments(HashTable *ht TSRMLS_DC, apply_func_args_t apply_func, int, ...);
746ce67 @andigutmans - Add hash_apply_with_arguments()
andigutmans authored
141
c14baee @zsuraski Avoid going over huge lists of functions, classes and constants.
zsuraski authored
142 /* This function should be used with special care (in other words,
143 * it should usually not be used). When used with the ZEND_HASH_APPLY_STOP
144 * return value, it assumes things about the order of the elements in the hash.
145 * Also, it does not provide the same kind of reentrancy protection that
146 * the standard apply functions do.
147 */
148 ZEND_API void zend_hash_reverse_apply(HashTable *ht, apply_func_t apply_func TSRMLS_DC);
573b460 @andigutmans Zend Library
andigutmans authored
149
150
151 /* Deletes */
6c810b0 Improved memory usage by movig constants to read only memory. (Dmitry…
Dmitry Stogov authored
152 ZEND_API int zend_hash_del_key_or_index(HashTable *ht, const char *arKey, uint nKeyLength, ulong h, int flag);
4f6c95d @zsuraski Whitespace
zsuraski authored
153 #define zend_hash_del(ht, arKey, nKeyLength) \
154 zend_hash_del_key_or_index(ht, arKey, nKeyLength, 0, HASH_DEL_KEY)
2ecf4bb Lazy EG(active_symbol_table) initialization
Dmitry Stogov authored
155 #define zend_hash_quick_del(ht, arKey, nKeyLength, h) \
156 zend_hash_del_key_or_index(ht, arKey, nKeyLength, h, HASH_DEL_KEY_QUICK)
4f6c95d @zsuraski Whitespace
zsuraski authored
157 #define zend_hash_index_del(ht, h) \
158 zend_hash_del_key_or_index(ht, NULL, 0, h, HASH_DEL_INDEX)
573b460 @andigutmans Zend Library
andigutmans authored
159
6c810b0 Improved memory usage by movig constants to read only memory. (Dmitry…
Dmitry Stogov authored
160 ZEND_API ulong zend_get_hash_value(const char *arKey, uint nKeyLength);
573b460 @andigutmans Zend Library
andigutmans authored
161
162 /* Data retreival */
cf7384a @felipensp - MFH: Constness (Added const qualifier to several function parameters)
felipensp authored
163 ZEND_API int zend_hash_find(const HashTable *ht, const char *arKey, uint nKeyLength, void **pData);
164 ZEND_API int zend_hash_quick_find(const HashTable *ht, const char *arKey, uint nKeyLength, ulong h, void **pData);
165 ZEND_API int zend_hash_index_find(const HashTable *ht, ulong h, void **pData);
573b460 @andigutmans Zend Library
andigutmans authored
166
167 /* Misc */
cf7384a @felipensp - MFH: Constness (Added const qualifier to several function parameters)
felipensp authored
168 ZEND_API int zend_hash_exists(const HashTable *ht, const char *arKey, uint nKeyLength);
169 ZEND_API int zend_hash_quick_exists(const HashTable *ht, const char *arKey, uint nKeyLength, ulong h);
170 ZEND_API int zend_hash_index_exists(const HashTable *ht, ulong h);
171 ZEND_API ulong zend_hash_next_free_element(const HashTable *ht);
573b460 @andigutmans Zend Library
andigutmans authored
172
cf90932 @zsuraski Improve infrastructure of numeric handling of elements in symbol tables.
zsuraski authored
173
573b460 @andigutmans Zend Library
andigutmans authored
174 /* traversing */
184118d Make it a macro
Marcus Boerger authored
175 #define zend_hash_has_more_elements_ex(ht, pos) \
176 (zend_hash_get_current_key_type_ex(ht, pos) == HASH_KEY_NON_EXISTANT ? FAILURE : SUCCESS)
ee286fe Make zend_hash_move_forward()/zenv_hash_move_backwards() a little sma…
Andrei Zmievski authored
177 ZEND_API int zend_hash_move_forward_ex(HashTable *ht, HashPosition *pos);
178 ZEND_API int zend_hash_move_backwards_ex(HashTable *ht, HashPosition *pos);
cf7384a @felipensp - MFH: Constness (Added const qualifier to several function parameters)
felipensp authored
179 ZEND_API int zend_hash_get_current_key_ex(const HashTable *ht, char **str_index, uint *str_length, ulong *num_index, zend_bool duplicate, HashPosition *pos);
a32c54b Introduced a way to traverse hashes through external pointers.
Andrei Zmievski authored
180 ZEND_API int zend_hash_get_current_key_type_ex(HashTable *ht, HashPosition *pos);
181 ZEND_API int zend_hash_get_current_data_ex(HashTable *ht, void **pData, HashPosition *pos);
182 ZEND_API void zend_hash_internal_pointer_reset_ex(HashTable *ht, HashPosition *pos);
183 ZEND_API void zend_hash_internal_pointer_end_ex(HashTable *ht, HashPosition *pos);
37a7693 Fixed bug #44100 (Inconsistent handling of static array declarations …
Dmitry Stogov authored
184 ZEND_API int zend_hash_update_current_key_ex(HashTable *ht, int key_type, const char *str_index, uint str_length, ulong num_index, int mode, HashPosition *pos);
a32c54b Introduced a way to traverse hashes through external pointers.
Andrei Zmievski authored
185
e470e22 - Fixed bug #35106 (nested foreach fails when array variable has a re…
Dmitry Stogov authored
186 typedef struct _HashPointer {
187 HashPosition pos;
188 ulong h;
189 } HashPointer;
190
cf7384a @felipensp - MFH: Constness (Added const qualifier to several function parameters)
felipensp authored
191 ZEND_API int zend_hash_get_pointer(const HashTable *ht, HashPointer *ptr);
e470e22 - Fixed bug #35106 (nested foreach fails when array variable has a re…
Dmitry Stogov authored
192 ZEND_API int zend_hash_set_pointer(HashTable *ht, const HashPointer *ptr);
193
892c1fb Add missing function to ease implementations
Marcus Boerger authored
194 #define zend_hash_has_more_elements(ht) \
195 zend_hash_has_more_elements_ex(ht, NULL)
a32c54b Introduced a way to traverse hashes through external pointers.
Andrei Zmievski authored
196 #define zend_hash_move_forward(ht) \
197 zend_hash_move_forward_ex(ht, NULL)
198 #define zend_hash_move_backwards(ht) \
199 zend_hash_move_backwards_ex(ht, NULL)
36eaad2 @zsuraski Allow get_current_key() not to return the key itself, instead of a du…
zsuraski authored
200 #define zend_hash_get_current_key(ht, str_index, num_index, duplicate) \
201 zend_hash_get_current_key_ex(ht, str_index, NULL, num_index, duplicate, NULL)
a32c54b Introduced a way to traverse hashes through external pointers.
Andrei Zmievski authored
202 #define zend_hash_get_current_key_type(ht) \
203 zend_hash_get_current_key_type_ex(ht, NULL)
204 #define zend_hash_get_current_data(ht, pData) \
205 zend_hash_get_current_data_ex(ht, pData, NULL)
206 #define zend_hash_internal_pointer_reset(ht) \
207 zend_hash_internal_pointer_reset_ex(ht, NULL)
208 #define zend_hash_internal_pointer_end(ht) \
209 zend_hash_internal_pointer_end_ex(ht, NULL)
d9c1a38 Fixed bug #28072 (static array with some constant keys will be incorr…
Dmitry Stogov authored
210 #define zend_hash_update_current_key(ht, key_type, str_index, str_length, num_index) \
37a7693 Fixed bug #44100 (Inconsistent handling of static array declarations …
Dmitry Stogov authored
211 zend_hash_update_current_key_ex(ht, key_type, str_index, str_length, num_index, HASH_UPDATE_KEY_ANYWAY, NULL)
573b460 @andigutmans Zend Library
andigutmans authored
212
213 /* Copying, merging and sorting */
9f51f15 @zsuraski - Stop passing list/plist to internal functions
zsuraski authored
214 ZEND_API void zend_hash_copy(HashTable *target, HashTable *source, copy_ctor_func_t pCopyConstructor, void *tmp, uint size);
0dba58c @zsuraski Improve tracking
zsuraski authored
215 ZEND_API void _zend_hash_merge(HashTable *target, HashTable *source, copy_ctor_func_t pCopyConstructor, void *tmp, uint size, int overwrite ZEND_FILE_LINE_DC);
471947b @zsuraski Reimplement PPP properties
zsuraski authored
216 ZEND_API void zend_hash_merge_ex(HashTable *target, HashTable *source, copy_ctor_func_t pCopyConstructor, uint size, merge_checker_func_t pMergeSource, void *pParam);
3bdddb4 MFZE1
Sebastian Bergmann authored
217 ZEND_API int zend_hash_sort(HashTable *ht, sort_func_t sort_func, compare_func_t compare_func, int renumber TSRMLS_DC);
8ce8324 @zsuraski More TSRMLS_FETCH annihilation
zsuraski authored
218 ZEND_API int zend_hash_compare(HashTable *ht1, HashTable *ht2, compare_func_t compar, zend_bool ordered TSRMLS_DC);
cf7384a @felipensp - MFH: Constness (Added const qualifier to several function parameters)
felipensp authored
219 ZEND_API int zend_hash_minmax(const HashTable *ht, compare_func_t compar, int flag, void **pData TSRMLS_DC);
573b460 @andigutmans Zend Library
andigutmans authored
220
0dba58c @zsuraski Improve tracking
zsuraski authored
221 #define zend_hash_merge(target, source, pCopyConstructor, tmp, size, overwrite) \
222 _zend_hash_merge(target, source, pCopyConstructor, tmp, size, overwrite ZEND_FILE_LINE_CC)
223
cf7384a @felipensp - MFH: Constness (Added const qualifier to several function parameters)
felipensp authored
224 ZEND_API int zend_hash_num_elements(const HashTable *ht);
573b460 @andigutmans Zend Library
andigutmans authored
225
3964c92 Made zend_hash_rehash() callable from outside.
Andrei Zmievski authored
226 ZEND_API int zend_hash_rehash(HashTable *ht);
573b460 @andigutmans Zend Library
andigutmans authored
227
1186d51 @andigutmans - Add a loop unrolled version of the hash function and a bit of an
andigutmans authored
228 /*
229 * DJBX33A (Daniel J. Bernstein, Times 33 with Addition)
230 *
231 * This is Daniel J. Bernstein's popular `times 33' hash function as
232 * posted by him years ago on comp.lang.c. It basically uses a function
233 * like ``hash(i) = hash(i-1) * 33 + str[i]''. This is one of the best
234 * known hash functions for strings. Because it is both computed very
235 * fast and distributes very well.
236 *
237 * The magic of number 33, i.e. why it works better than many other
238 * constants, prime or not, has never been adequately explained by
239 * anyone. So I try an explanation: if one experimentally tests all
240 * multipliers between 1 and 256 (as RSE did now) one detects that even
241 * numbers are not useable at all. The remaining 128 odd numbers
242 * (except for the number 1) work more or less all equally well. They
243 * all distribute in an acceptable way and this way fill a hash table
244 * with an average percent of approx. 86%.
245 *
246 * If one compares the Chi^2 values of the variants, the number 33 not
247 * even has the best value. But the number 33 and a few other equally
248 * good numbers like 17, 31, 63, 127 and 129 have nevertheless a great
249 * advantage to the remaining numbers in the large set of possible
250 * multipliers: their multiply operation can be replaced by a faster
251 * operation based on just one shift plus either a single addition
252 * or subtraction operation. And because a hash function has to both
253 * distribute good _and_ has to be very fast to compute, those few
254 * numbers should be preferred and seems to be the reason why Daniel J.
255 * Bernstein also preferred it.
256 *
257 *
258 * -- Ralf S. Engelschall <rse@engelschall.com>
259 */
260
6c810b0 Improved memory usage by movig constants to read only memory. (Dmitry…
Dmitry Stogov authored
261 static inline ulong zend_inline_hash_func(const char *arKey, uint nKeyLength)
b98acd6 @andigutmans - Move inline_zend_hash_func() to header file
andigutmans authored
262 {
1186d51 @andigutmans - Add a loop unrolled version of the hash function and a bit of an
andigutmans authored
263 register ulong hash = 5381;
264
265 /* variant with the hash unrolled eight times */
266 for (; nKeyLength >= 8; nKeyLength -= 8) {
267 hash = ((hash << 5) + hash) + *arKey++;
268 hash = ((hash << 5) + hash) + *arKey++;
269 hash = ((hash << 5) + hash) + *arKey++;
270 hash = ((hash << 5) + hash) + *arKey++;
271 hash = ((hash << 5) + hash) + *arKey++;
272 hash = ((hash << 5) + hash) + *arKey++;
273 hash = ((hash << 5) + hash) + *arKey++;
274 hash = ((hash << 5) + hash) + *arKey++;
275 }
276 switch (nKeyLength) {
277 case 7: hash = ((hash << 5) + hash) + *arKey++; /* fallthrough... */
278 case 6: hash = ((hash << 5) + hash) + *arKey++; /* fallthrough... */
279 case 5: hash = ((hash << 5) + hash) + *arKey++; /* fallthrough... */
280 case 4: hash = ((hash << 5) + hash) + *arKey++; /* fallthrough... */
281 case 3: hash = ((hash << 5) + hash) + *arKey++; /* fallthrough... */
282 case 2: hash = ((hash << 5) + hash) + *arKey++; /* fallthrough... */
283 case 1: hash = ((hash << 5) + hash) + *arKey++; break;
90f43c7 @andigutmans - This should improve performance on Windows
andigutmans authored
284 case 0: break;
285 EMPTY_SWITCH_DEFAULT_CASE()
b98acd6 @andigutmans - Move inline_zend_hash_func() to header file
andigutmans authored
286 }
1186d51 @andigutmans - Add a loop unrolled version of the hash function and a bit of an
andigutmans authored
287 return hash;
b98acd6 @andigutmans - Move inline_zend_hash_func() to header file
andigutmans authored
288 }
289
1186d51 @andigutmans - Add a loop unrolled version of the hash function and a bit of an
andigutmans authored
290
6c810b0 Improved memory usage by movig constants to read only memory. (Dmitry…
Dmitry Stogov authored
291 ZEND_API ulong zend_hash_func(const char *arKey, uint nKeyLength);
573b460 @andigutmans Zend Library
andigutmans authored
292
9353650 Fix warnings surfacing in maintainer-mode.
Stig S. Bakken authored
293 #if ZEND_DEBUG
573b460 @andigutmans Zend Library
andigutmans authored
294 /* debug */
cf7384a @felipensp - MFH: Constness (Added const qualifier to several function parameters)
felipensp authored
295 void zend_hash_display_pListTail(const HashTable *ht);
296 void zend_hash_display(const HashTable *ht);
573b460 @andigutmans Zend Library
andigutmans authored
297 #endif
298
fd4650b @zsuraski Add zend_hash_get_current_key_type()
zsuraski authored
299 END_EXTERN_C()
300
0a14a32 @zsuraski Add useful macros
zsuraski authored
301 #define ZEND_INIT_SYMTABLE(ht) \
302 ZEND_INIT_SYMTABLE_EX(ht, 2, 0)
303
304 #define ZEND_INIT_SYMTABLE_EX(ht, n, persistent) \
305 zend_hash_init(ht, n, NULL, ZVAL_PTR_DTOR, persistent)
306
d3b4270 Better fix for bug #45877 (smaller and faster)
Dmitry Stogov authored
307 #define ZEND_HANDLE_NUMERIC(key, length, func) do { \
308 register const char *tmp = key; \
309 const char *end = key + length - 1; \
310 long idx; \
311 \
312 if (*tmp == '-') { \
313 tmp++; \
314 } \
315 if ((*tmp >= '1' && *tmp <= '9' && (end - tmp) < MAX_LENGTH_OF_LONG) || \
316 (*tmp == '0' && (end - tmp) == 1)) { \
317 /* possibly a numeric index without leading zeroes */ \
318 idx = (*tmp++ - '0'); \
319 while (1) { \
320 if (tmp == end && *tmp == '\0') { /* a numeric index */ \
321 if (*key == '-') { \
322 idx = -idx; \
323 if (idx > 0) { /* overflow */ \
324 break; \
325 } \
326 } else if (idx < 0) { /* overflow */ \
327 break; \
328 } \
329 return func; \
330 } else if (*tmp >= '0' && *tmp <= '9') { \
331 idx = (idx * 10) + (*tmp++ - '0'); \
332 } else { \
333 break; \
334 } \
335 } \
336 } \
337 } while (0)
e89977f @zsuraski Go back to ZE1-like code
zsuraski authored
338
6c810b0 Improved memory usage by movig constants to read only memory. (Dmitry…
Dmitry Stogov authored
339 static inline int zend_symtable_update(HashTable *ht, const char *arKey, uint nKeyLength, void *pData, uint nDataSize, void **pDest) \
cf90932 @zsuraski Improve infrastructure of numeric handling of elements in symbol tables.
zsuraski authored
340 {
b101ee1 @tony2001 MFH: rename macros
tony2001 authored
341 ZEND_HANDLE_NUMERIC(arKey, nKeyLength, zend_hash_index_update(ht, idx, pData, nDataSize, pDest));
e89977f @zsuraski Go back to ZE1-like code
zsuraski authored
342 return zend_hash_update(ht, arKey, nKeyLength, pData, nDataSize, pDest);
cf90932 @zsuraski Improve infrastructure of numeric handling of elements in symbol tables.
zsuraski authored
343 }
344
345
6c810b0 Improved memory usage by movig constants to read only memory. (Dmitry…
Dmitry Stogov authored
346 static inline int zend_symtable_del(HashTable *ht, const char *arKey, uint nKeyLength)
cf90932 @zsuraski Improve infrastructure of numeric handling of elements in symbol tables.
zsuraski authored
347 {
d3b4270 Better fix for bug #45877 (smaller and faster)
Dmitry Stogov authored
348 ZEND_HANDLE_NUMERIC(arKey, nKeyLength, zend_hash_index_del(ht, idx));
e89977f @zsuraski Go back to ZE1-like code
zsuraski authored
349 return zend_hash_del(ht, arKey, nKeyLength);
cf90932 @zsuraski Improve infrastructure of numeric handling of elements in symbol tables.
zsuraski authored
350 }
351
352
6c810b0 Improved memory usage by movig constants to read only memory. (Dmitry…
Dmitry Stogov authored
353 static inline int zend_symtable_find(HashTable *ht, const char *arKey, uint nKeyLength, void **pData)
cf90932 @zsuraski Improve infrastructure of numeric handling of elements in symbol tables.
zsuraski authored
354 {
b101ee1 @tony2001 MFH: rename macros
tony2001 authored
355 ZEND_HANDLE_NUMERIC(arKey, nKeyLength, zend_hash_index_find(ht, idx, pData));
e89977f @zsuraski Go back to ZE1-like code
zsuraski authored
356 return zend_hash_find(ht, arKey, nKeyLength, pData);
cf90932 @zsuraski Improve infrastructure of numeric handling of elements in symbol tables.
zsuraski authored
357 }
358
359
6c810b0 Improved memory usage by movig constants to read only memory. (Dmitry…
Dmitry Stogov authored
360 static inline int zend_symtable_exists(HashTable *ht, const char *arKey, uint nKeyLength)
cf90932 @zsuraski Improve infrastructure of numeric handling of elements in symbol tables.
zsuraski authored
361 {
b101ee1 @tony2001 MFH: rename macros
tony2001 authored
362 ZEND_HANDLE_NUMERIC(arKey, nKeyLength, zend_hash_index_exists(ht, idx));
e89977f @zsuraski Go back to ZE1-like code
zsuraski authored
363 return zend_hash_exists(ht, arKey, nKeyLength);
cf90932 @zsuraski Improve infrastructure of numeric handling of elements in symbol tables.
zsuraski authored
364 }
365
37a7693 Fixed bug #44100 (Inconsistent handling of static array declarations …
Dmitry Stogov authored
366 static inline int zend_symtable_update_current_key(HashTable *ht, const char *arKey, uint nKeyLength, int mode)
9ee0707 Fixed bug #35509 (string constant as array key has different behavior…
Dmitry Stogov authored
367 {
37a7693 Fixed bug #44100 (Inconsistent handling of static array declarations …
Dmitry Stogov authored
368 ZEND_HANDLE_NUMERIC(arKey, nKeyLength, zend_hash_update_current_key_ex(ht, HASH_KEY_IS_LONG, NULL, 0, idx, mode, NULL));
369 return zend_hash_update_current_key_ex(ht, HASH_KEY_IS_STRING, arKey, nKeyLength, 0, mode, NULL);
9ee0707 Fixed bug #35509 (string constant as array key has different behavior…
Dmitry Stogov authored
370 }
371
a617217 Replace macros which begin with an underscore through an appropiately
Sascha Schumann authored
372 #endif /* ZEND_HASH_H */
333406b - Added some missing CVS $Id$ tags, headers and footers.
foobar authored
373
374 /*
375 * Local variables:
376 * tab-width: 4
377 * c-basic-offset: 4
378 * indent-tabs-mode: t
379 * End:
380 */
Something went wrong with that request. Please try again.