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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
|
/* vi:set ts=8 sts=4 sw=4 noet:
*
* VIM - Vi IMproved by Bram Moolenaar
*
* Do ":help uganda" in Vim to read copying and usage conditions.
* Do ":help credits" in Vim to see a list of people who contributed.
* See README.txt for an overview of the Vim source code.
*/
/*
* hashtab.c: Handling of a hashtable with Vim-specific properties.
*
* Each item in a hashtable has a NUL terminated string key. A key can appear
* only once in the table.
*
* A hash number is computed from the key for quick lookup. When the hashes
* of two different keys point to the same entry an algorithm is used to
* iterate over other entries in the table until the right one is found.
* To make the iteration work removed keys are different from entries where a
* key was never present.
*
* The mechanism has been partly based on how Python Dictionaries are
* implemented. The algorithm is from Knuth Vol. 3, Sec. 6.4.
*
* The hashtable grows to accommodate more entries when needed. At least 1/3
* of the entries is empty to keep the lookup efficient (at the cost of extra
* memory).
*/
#include "vim.h"
#if 0
# define HT_DEBUG // extra checks for table consistency and statistics
static long hash_count_lookup = 0; // count number of hashtab lookups
static long hash_count_perturb = 0; // count number of "misses"
#endif
// Magic value for algorithm that walks through the array.
#define PERTURB_SHIFT 5
static int hash_may_resize(hashtab_T *ht, int minitems);
#if 0 // currently not used
/*
* Create an empty hash table.
* Returns NULL when out of memory.
*/
hashtab_T *
hash_create(void)
{
hashtab_T *ht;
ht = ALLOC_ONE(hashtab_T);
if (ht != NULL)
hash_init(ht);
return ht;
}
#endif
/*
* Initialize an empty hash table.
*/
void
hash_init(hashtab_T *ht)
{
// This zeroes all "ht_" entries and all the "hi_key" in "ht_smallarray".
CLEAR_POINTER(ht);
ht->ht_array = ht->ht_smallarray;
ht->ht_mask = HT_INIT_SIZE - 1;
}
/*
* If "ht->ht_flags" has HTFLAGS_FROZEN then give an error message using
* "command" and return TRUE.
*/
int
check_hashtab_frozen(hashtab_T *ht, char *command)
{
if ((ht->ht_flags & HTFLAGS_FROZEN) == 0)
return FALSE;
semsg(_(e_not_allowed_to_add_or_remove_entries_str), command);
return TRUE;
}
/*
* Free the array of a hash table. Does not free the items it contains!
* If "ht" is not freed then you should call hash_init() next!
*/
void
hash_clear(hashtab_T *ht)
{
if (ht->ht_array != ht->ht_smallarray)
vim_free(ht->ht_array);
}
#if defined(FEAT_SPELL) || defined(FEAT_TERMINAL) || defined(PROTO)
/*
* Free the array of a hash table and all the keys it contains. The keys must
* have been allocated. "off" is the offset from the start of the allocate
* memory to the location of the key (it's always positive).
*/
void
hash_clear_all(hashtab_T *ht, int off)
{
long todo;
hashitem_T *hi;
todo = (long)ht->ht_used;
for (hi = ht->ht_array; todo > 0; ++hi)
{
if (!HASHITEM_EMPTY(hi))
{
vim_free(hi->hi_key - off);
--todo;
}
}
hash_clear(ht);
}
#endif
/*
* Find "key" in hashtable "ht". "key" must not be NULL.
* Always returns a pointer to a hashitem. If the item was not found then
* HASHITEM_EMPTY() is TRUE. The pointer is then the place where the key
* would be added.
* WARNING: The returned pointer becomes invalid when the hashtable is changed
* (adding, setting or removing an item)!
*/
hashitem_T *
hash_find(hashtab_T *ht, char_u *key)
{
return hash_lookup(ht, key, hash_hash(key));
}
/*
* Like hash_find(), but caller computes "hash".
*/
hashitem_T *
hash_lookup(hashtab_T *ht, char_u *key, hash_T hash)
{
hash_T perturb;
hashitem_T *freeitem;
hashitem_T *hi;
unsigned idx;
#ifdef HT_DEBUG
++hash_count_lookup;
#endif
/*
* Quickly handle the most common situations:
* - return if there is no item at all
* - skip over a removed item
* - return if the item matches
*/
idx = (unsigned)(hash & ht->ht_mask);
hi = &ht->ht_array[idx];
if (hi->hi_key == NULL)
return hi;
if (hi->hi_key == HI_KEY_REMOVED)
freeitem = hi;
else if (hi->hi_hash == hash && STRCMP(hi->hi_key, key) == 0)
return hi;
else
freeitem = NULL;
/*
* Need to search through the table to find the key. The algorithm
* to step through the table starts with large steps, gradually becoming
* smaller down to (1/4 table size + 1). This means it goes through all
* table entries in the end.
* When we run into a NULL key it's clear that the key isn't there.
* Return the first available slot found (can be a slot of a removed
* item).
*/
for (perturb = hash; ; perturb >>= PERTURB_SHIFT)
{
#ifdef HT_DEBUG
++hash_count_perturb; // count a "miss" for hashtab lookup
#endif
idx = (unsigned)((idx << 2U) + idx + perturb + 1U);
hi = &ht->ht_array[idx & ht->ht_mask];
if (hi->hi_key == NULL)
return freeitem == NULL ? hi : freeitem;
if (hi->hi_hash == hash
&& hi->hi_key != HI_KEY_REMOVED
&& STRCMP(hi->hi_key, key) == 0)
return hi;
if (hi->hi_key == HI_KEY_REMOVED && freeitem == NULL)
freeitem = hi;
}
}
#if defined(FEAT_EVAL) || defined(FEAT_SYN_HL) || defined(PROTO)
/*
* Print the efficiency of hashtable lookups.
* Useful when trying different hash algorithms.
* Called when exiting.
*/
void
hash_debug_results(void)
{
# ifdef HT_DEBUG
fprintf(stderr, "\r\n\r\n\r\n\r\n");
fprintf(stderr, "Number of hashtable lookups: %ld\r\n", hash_count_lookup);
fprintf(stderr, "Number of perturb loops: %ld\r\n", hash_count_perturb);
fprintf(stderr, "Percentage of perturb loops: %ld%%\r\n",
hash_count_perturb * 100 / hash_count_lookup);
# endif
}
#endif
/*
* Add item with key "key" to hashtable "ht".
* "command" is used for the error message when the hashtab if frozen.
* Returns FAIL when out of memory or the key is already present.
*/
int
hash_add(hashtab_T *ht, char_u *key, char *command)
{
hash_T hash = hash_hash(key);
hashitem_T *hi;
if (check_hashtab_frozen(ht, command))
return FAIL;
hi = hash_lookup(ht, key, hash);
if (!HASHITEM_EMPTY(hi))
{
internal_error("hash_add()");
return FAIL;
}
return hash_add_item(ht, hi, key, hash);
}
/*
* Add item "hi" with "key" to hashtable "ht". "key" must not be NULL and
* "hi" must have been obtained with hash_lookup() and point to an empty item.
* "hi" is invalid after this!
* Returns OK or FAIL (out of memory).
*/
int
hash_add_item(
hashtab_T *ht,
hashitem_T *hi,
char_u *key,
hash_T hash)
{
// If resizing failed before and it fails again we can't add an item.
if ((ht->ht_flags & HTFLAGS_ERROR) && hash_may_resize(ht, 0) == FAIL)
return FAIL;
++ht->ht_used;
++ht->ht_changed;
if (hi->hi_key == NULL)
++ht->ht_filled;
hi->hi_key = key;
hi->hi_hash = hash;
// When the space gets low may resize the array.
return hash_may_resize(ht, 0);
}
#if 0 // not used
/*
* Overwrite hashtable item "hi" with "key". "hi" must point to the item that
* is to be overwritten. Thus the number of items in the hashtable doesn't
* change.
* Although the key must be identical, the pointer may be different, thus it's
* set anyway (the key is part of an item with that key).
* The caller must take care of freeing the old item.
* "hi" is invalid after this!
*/
void
hash_set(hashitem_T *hi, char_u *key)
{
hi->hi_key = key;
}
#endif
/*
* Remove item "hi" from hashtable "ht". "hi" must have been obtained with
* hash_lookup().
* "command" is used for the error message when the hashtab if frozen.
* The caller must take care of freeing the item itself.
*/
int
hash_remove(hashtab_T *ht, hashitem_T *hi, char *command)
{
if (check_hashtab_frozen(ht, command))
return FAIL;
--ht->ht_used;
++ht->ht_changed;
hi->hi_key = HI_KEY_REMOVED;
hash_may_resize(ht, 0);
return OK;
}
/*
* Lock a hashtable: prevent that ht_array changes.
* Don't use this when items are to be added!
* Must call hash_unlock() later.
*/
void
hash_lock(hashtab_T *ht)
{
++ht->ht_locked;
}
#if defined(FEAT_PROP_POPUP) || defined(PROTO)
/*
* Lock a hashtable at the specified number of entries.
* Caller must make sure no more than "size" entries will be added.
* Must call hash_unlock() later.
*/
void
hash_lock_size(hashtab_T *ht, int size)
{
(void)hash_may_resize(ht, size);
++ht->ht_locked;
}
#endif
/*
* Unlock a hashtable: allow ht_array changes again.
* Table will be resized (shrink) when necessary.
* This must balance a call to hash_lock().
*/
void
hash_unlock(hashtab_T *ht)
{
--ht->ht_locked;
(void)hash_may_resize(ht, 0);
}
/*
* Shrink a hashtable when there is too much empty space.
* Grow a hashtable when there is not enough empty space.
* Returns OK or FAIL (out of memory).
*/
static int
hash_may_resize(
hashtab_T *ht,
int minitems) // minimal number of items
{
hashitem_T temparray[HT_INIT_SIZE];
hashitem_T *oldarray, *newarray;
hashitem_T *olditem, *newitem;
unsigned newi;
int todo;
long_u oldsize, newsize;
long_u minsize
|