summaryrefslogtreecommitdiff
path: root/usr/src/cmd/isns/isnsd/htable.c
blob: d7c49ddcdebd4f13a832f9c4387680167588177f (plain)
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
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <pthread.h>
#include <libelf.h>
#include <libelf.h>

#include "isns_server.h"
#include "isns_cache.h"
#include "isns_htab.h"
#include "isns_log.h"

#define	UID_REUSABLE(T, X)	((T) - (X)->t >= ONE_DAY)

/*
 * external variables.
 */
extern int cache_flag;

/*
 * ****************************************************************************
 * avl_search:
 *	search a node from an AVL tree.
 *
 * tab	- the hash table.
 * uid	- the object UID.
 * return - the node which matches the object UID.
 *
 * ****************************************************************************
 */
static htab_itemx_t *
avl_search(
	const htab_t *tab,
	const uint32_t uid
)
{
	htab_itemx_t *x = tab->avlt;

	while (x != NULL) {
		if (x->uid > uid) {
			x = x->l;
		} else if (x->uid < uid) {
			x = x->r;
		} else {
			break;
		}
	}

	return (x);
}

/*
 * ****************************************************************************
 * avl_search_next:
 *	search a node from an AVL tree, the object UID of the node
 *	is next to the previous object UID.
 *
 * tab	- the hash table.
 * uid	- the previous object UID.
 * return - the next node.
 *
 * ****************************************************************************
 */
static htab_itemx_t *
avl_search_next(
	const htab_t *tab,
	const uint32_t uid
)
{
	htab_itemx_t *p = NULL;
	htab_itemx_t *x = tab->avlt;

	while (x != NULL) {
		if (x->uid > uid) {
			p = x;
			x = x->l;
		} else if (x->uid <= uid) {
			x = x->r;
		}
	}

	return (p);
}

/*
 * ****************************************************************************
 * avl_ll:
 *	perform LL balance rotation on an AVL tree (or the subtree).
 *
 * a	- the left child.
 * b	- the right child.
 * return - the new root.
 *
 * ****************************************************************************
 */
static htab_itemx_t *
avl_ll(
	htab_itemx_t *a,
	htab_itemx_t *b
)
{
	/* rotate right */
	a->l = b->r;
	a->bf = 0;
	b->r = a;
	b->bf = 0;

	return (b);
}

/*
 * ****************************************************************************
 * avl_rr:
 *	perform RR balance rotation on an AVL tree (or the subtree).
 *
 * a	- the left child.
 * b	- the right child.
 * return - the new root.
 *
 * ****************************************************************************
 */
static htab_itemx_t *
avl_rr(
	htab_itemx_t *a,
	htab_itemx_t *b
)
{
	/* rotate left */
	a->r = b->l;
	a->bf = 0;
	b->l = a;
	b->bf = 0;

	return (b);
}

/*
 * ****************************************************************************
 * avl_lr:
 *	perform LR balance rotation on an AVL tree (or the subtree).
 *
 * a	- the left child.
 * b	- the right child.
 * return - the new root.
 *
 * ****************************************************************************
 */
static htab_itemx_t *
avl_lr(
	htab_itemx_t *a,
	htab_itemx_t *b
)
{
	htab_itemx_t *c;

	c = b->r;

	/* rotate left and then right */
	a->l = c->r;
	c->r = a;
	b->r = c->l;
	c->l = b;

	/* update balance factor */
	switch (c->bf) {
	case -1:
		/* on c's right */
		a->bf = 0;
		b->bf = 1;
		break;
	case 0:
		/* on c itself */
		a->bf = 0;
		b->bf = 0;
		break;
	case 1:
		/* on c's left */
		a->bf = -1;
		b->bf = 0;
		break;
	}
	c->bf = 0;

	return (c);
}

/*
 * ****************************************************************************
 * avl_rl:
 *	perform RL balance rotation on an AVL tree (or the subtree).
 *
 * a	- the left child.
 * b	- the right child.
 * return - the new root.
 *
 * ****************************************************************************
 */
static htab_itemx_t *
avl_rl(
	htab_itemx_t *a,
	htab_itemx_t *b
)
{
	htab_itemx_t *c;

	c = b->l;

	/* rotate right and then left */
	a->r = c->l;
	c->l = a;
	b->l = c->r;
	c->r = b;

	/* update balance factor */
	switch (c->bf) {
	case -1:
		/* on c's right */
		a->bf = 1;
		b->bf = 0;
		break;
	case 0:
		/* on c itself */
		a->bf = 0;
		b->bf = 0;
		break;
	case 1:
		/* on c's left */
		a->bf = 0;
		b->bf = -1;
		break;
	}
	c->bf = 0;

	return (c);
}

/*
 * ****************************************************************************
 * avl_insert:
 *	insert a node into an AVL tree.
 *
 * tab	- the hash table.
 * x	- the node being added.
 *
 * ****************************************************************************
 */
static void
avl_insert(
	htab_t *tab,
	htab_itemx_t *x
)
{
	htab_itemx_t *f, *a, *p, *q, *b, *c;
	int d;

	/* initialize the new one */
	x->bf = 0;
	x->l = NULL;
	x->r = NULL;

	if (tab->avlt == NULL) {
		tab->avlt = x;
	} else {
		/* locate the position */
		f = NULL;
		a = tab->avlt;
		p = tab->avlt;
		q = NULL;
		while (p != NULL) {
			if (p->bf != 0) {
				a = p;
				f = q;
			}
			q = p;
			if (x->uid < q->uid) {
				p = p->l;
			} else {
				p = p->r;
			}
		}
		/* insert it */
		if (x->uid < q->uid) {
			q->l = x;
		} else {
			q->r = x;
		}
		/* update the balance factor between a to x */
		if (x->uid < a->uid) {
			p = a->l;
			d = 1;
		} else {
			p = a->r;
			d = -1;
		}
		b = p;
		while (p != x) {
			if (x->uid < p->uid) {
				p->bf = 1;
				p = p->l;
			} else {
				p->bf = -1;
				p = p->r;
			}
		}
		/* brance is not broken */
		if (a->bf == 0) {
			a->bf = d;
			goto bal_done;
		} else if (a->bf + d == 0) {
			a->bf = 0;
			goto bal_done;
		}
		/* rotate the tree */
		if (d == 1) {
			if (b->bf == 1) {
				/* LL rotate */
				c = avl_ll(a, b);
			} else if (b->bf == -1) {
				/* LR rotate */
				c = avl_lr(a, b);
			}
		} else {
			if (b->bf == -1) {
				/* RR rotate */
				c = avl_rr(a, b);
			} else if (b->bf == 1) {
				/* RL rotate */
				c = avl_rl(a, b);
			}
		}
		/* update the parent */
		if (f == NULL) {
			tab->avlt = c;
		} else if (f->l == a) {
			f->l = c;
		} else if (f->r == a) {
			f->r = c;
		}
	}

bal_done:
	if (x->uid > tab->buid) {
		tab->buid = x->uid;
	}
}

/*
 * ****************************************************************************
 * new_uid:
 *	allocate new node(s) of the avl tree.
 *
 * tab	- the hash table.
 * uid	- the UID of the node.
 * return - the newly allocated UID node.
 *
 * ****************************************************************************
 */
static htab_itemx_t *
new_uid(
	htab_t *tab,
	uint32_t uid
)
{
	htab_itemx_t *x = NULL;

	uint32_t start, end;

	/* overflow happened */
	if (uid == 0) {
		/* search for an unused one */
		uid ++;
		while (uid != 0 &&
		    avl_search(tab, uid) != NULL) {
			uid ++;
		}
		if (uid == 0) {
			/* all are used up, sigh! */
			return (NULL);
		}
	}

	/* check if there is a gap and the gap needs to be filled up */
	if (uid > tab->buid &&
	    (tab->flags & UID_FLAGS_SEQ) != 0) {
		start = tab->buid + 1;
	} else {
		start = uid;
	}
	end = uid;

	/* make new UID(s) */
	do {
		if (x != NULL) {
			x->hval = BAD_HVAL_MASK;
			x->t = 0;
			/* put it to the start of the fifo list */
			x->n = tab->list;
			tab->list = x;
			if (tab->tail == NULL) {
				tab->tail = x;
			}
		}
		x = (htab_itemx_t *)malloc(sizeof (htab_itemx_t));
		if (x != NULL) {
			x->uid = start;
			x->n = NULL;
			/* insert it to the tree */
			avl_insert(tab, x);
		}
		start ++;
	} while (x != NULL && start <= end && start != 0);

	return (x);
}

/*
 * ****************************************************************************
 * uid_insert:
 *	insert a new UID node to the avl tree.
 *
 * tab	- the hash table.
 * uid_p- the pointer of the UID.
 * hval	- the hash value of the new node.
 * return -	0: no UID value assigned;
 *		1: assigned an UID.
 *		-1: no memory.
 *		-2: invalid UID.
 *
 * ****************************************************************************
 */
static int
uid_insert(
	htab_t *tab,
	uint32_t *const uid_p,
	const uint32_t hval
)
{
	int assignx = 0;

	uint32_t uid = *uid_p;

	htab_itemx_t *x, *n;

	if (uid != 0) {
		/* search the existing one from the tree */
		x = avl_search(tab, uid);
		if (x == NULL) {
			x = new_uid(tab, uid);
		} else if (!BAD_HVAL(x->hval) &&
		    x->hval != hval) {
			/* the item with this uid will override an */
			/* existing item, we treat this as an error */
			return (-2);
		}
	} else {
		/* assign a value */
		x = tab->list;
		/* strip off the used ones */
		while (x != NULL &&
		    !BAD_HVAL(x->hval)) {
			n = x->n;
			x->n = NULL;
			x = n;
		}

		if (x == NULL ||
		    UID_REUSABLE(tab->c->timestamp(), x) == 0) {
			/* none is available, make a new one */
			tab->list = x;
			x = new_uid(tab, tab->buid + 1);
		} else {
			n = x->n;
			x->n = NULL;
			tab->list = n;
		}
		/* update the available list */
		if (tab->list == NULL) {
			tab->tail = NULL;
		}
		assignx = 1;
		if (x != NULL) {
			*uid_p = x->uid;
		}
	}

	if (x == NULL) {
		return (-1); /* no memory */
	}

	x->hval = hval;
	x->t = 0; /* registration initial time */

	return (assignx);
}

/*
 * ****************************************************************************
 * enlarge_htab:
 *	enlarge the hash table when it gets too full.
 *
 * tab	- the hash table.
 *
 * ****************************************************************************
 */
static void
enlarge_htab(
	htab_t *tab
)
{
	htab_item_t **items;
	uint16_t logsize;
	uint32_t oldsz, newsz, mask;
	htab_item_t *item, *tmp, **itemp;
	uint16_t i;
	uint32_t j;

	uint32_t uid;

	/* enlarge the logsize by one */
	logsize = tab->logsize + 1;
	newsz = (1 << logsize);
	items = (htab_item_t **)calloc(
	    newsz * tab->chunks, sizeof (htab_item_t *));
	/* re-hash all items to the new table */
	if (items != NULL) {
		mask = newsz - 1;
		oldsz = (1 << tab->logsize);
		i = 0;
		while (i < tab->chunks) {
			j = 0;
			while (j < oldsz) {
				item = tab->items[(i * oldsz) + j];
				while (item != NULL) {
					tmp = item->next;
					itemp = &items[(i * newsz) +
					    (item->hval & mask)];
					uid = tab->c->get_uid(item->p);
					while (*itemp != NULL &&
					    tab->c->get_uid((*itemp)->p) >
					    uid) {
						itemp = &(*itemp)->next;
					}
					item->next = *itemp;
					*itemp = item;
					item = tmp;
				}
				j ++;
			}
			i ++;
		}
		free(tab->items);
		tab->items = items;
		tab->logsize = logsize;
		tab->mask = mask;
	} else {
		isnslog(LOG_DEBUG, "enlarge_htab", "calloc() failed.");
	}
}

/*
 * ****************************************************************************
 * htab_init:
 *	some generic initialization for the hash table.
 *
 * ****************************************************************************
 */
void
htab_init(
)
{
	/* do nothing */
}

/*
 * ****************************************************************************
 * htab_create:
 *	create a new hash table.
 *
 * flags - UID_FLAGS_SEQ: the UID in the table needs to be sequential.
 * logsize - the hash table logsize.
 * chunks  - the number of seperated chunks of the table.
 * return  - the newly created hash table.
 *
 * ****************************************************************************
 */
htab_t *
htab_create(
	int flags,
	uint16_t logsize,
	uint16_t chunks
)
{
	htab_t *tab = NULL;
	htab_item_t **items = NULL;
	uint32_t count;

	/* do not enlarge it if the logsize reaches the maximum */
	if (logsize <= MAX_LOGSIZE &&
	    chunks > 0) {
		tab = (htab_t *)calloc(1, sizeof (htab_t));
		if (tab != NULL) {
			count = (1 << logsize);
			items = (htab_item_t **)calloc(
			    count * chunks, sizeof (htab_item_t *));
			if (items != NULL) {
				tab->flags = flags;
				tab->items = items;
				tab->logsize = logsize;
				tab->chunks = chunks;
				tab->mask = count - 1;
				tab->count = 1; /* reserve one */
				tab->avlt = NULL;
				tab->buid = 0;
				tab->list = NULL;
				tab->tail = NULL;
			} else {
				free(tab);
				tab = NULL;
			}
		}
	}

	return (tab);
}

/*
 * ****************************************************************************
 * htab_compute_hval:
 *	compute a hash value for the specified key.
 *
 * key - the key of the hash.
 * return - the hash value.
 *
 * ****************************************************************************
 */
uint32_t
htab_compute_hval(
	const uchar_t *key
)
{
	/* use classic Dan Bernstein hash alorigthm */
	uint32_t hash = 5381;
	int c;

	while ((c = *key++) != 0) {
		hash = ((hash << 5) + hash) + c;
	}

	return (hash);
}

/*
 * ****************************************************************************
 * htab_add:
 *	add an object to the hash table.
 *
 * tab	- the hash table.
 * p	- the object.
 * flag	- 0: not an association object; otherwise association object.
 * uid_p- pointer of UID for returning.
 * update_p - pointer of update flag for returning.
 * return - error code.
 *
 * ****************************************************************************
 */
int
htab_add(
	htab_t *tab,
	void *p,
	int flag,
	uint32_t *uid_p,
	int *update_p
)
{
	int ec = 0;

	htab_item_t *items = NULL, **itemp;
	uint32_t chunksz;
	uint32_t flags = 0;
	uint32_t hval;
	uint32_t uid = 0;
	int i;

	/* compute the hash value */
	hval = VALID_HVAL(tab->c->get_hval(p, 0, &flags));

	/* check for duplicate */
	items = tab->items[hval & tab->mask];
	while (items != NULL) {
		if (tab->c->cmp(items->p, p, 0) == 0) {
			if (flag == 0) {
				ec = tab->c->replace_hook(items->p, p, uid_p,
				    update_p == NULL ? 1 : 0);
			}
			if (update_p != NULL) {
				*update_p = 1;
			}
			items = NULL;
			goto add_done;
		}
		items = items->next;
	}

	/* add new object */
	if (update_p != NULL) {
		*update_p = 0;
	}

	/* make new items for the object */
	items = (htab_item_t *)calloc(tab->chunks, sizeof (htab_item_t));

	if (items == NULL ||
	    tab->count == 0 ||
	    (++tab->count) == 0) {
		/* no memory or table is full */
		ec = ISNS_RSP_INTERNAL_ERROR;
		goto add_done;
	}

	/* check if the table needs is too full */
	chunksz = (1 << tab->logsize);
	if (tab->count >= (chunksz * HASH_RATIO) &&
	    tab->logsize < MAX_LOGSIZE) {
		enlarge_htab(tab);
		chunksz = (1 << tab->logsize);
	}

	/* put the UID of the object to the avl tree */
	uid = tab->c->get_uid(p);
	switch (uid_insert(tab, &uid, hval)) {
	case -2:
		ec = ISNS_RSP_INVALID_REGIS;
		goto add_done;
	case -1:
		ec = ISNS_RSP_INTERNAL_ERROR;
		goto add_done;
	case 0:
		break;
	case 1:
		tab->c->set_uid(p, uid);
		break;
	default:
		break;
	}

	/* update data store before putting to hash table */
	if (flag == 0) {
		/* not association object */
		ec = tab->c->add_hook(p);
	}

	/* put the object to the table */
	for (i = 0; ec == 0; ) {
		items[i].hval = hval;
		items[i].p = p;
		itemp = &tab->items[(i * chunksz) + (hval & tab->mask)];
		while (*itemp != NULL &&
		    tab->c->get_uid((*itemp)->p) > uid) {
			itemp = &(*itemp)->next;
		}
		items[i].next = *itemp;
		*itemp = &items[i];
		i ++;
		if (i < tab->chunks) {
			hval = VALID_HVAL(tab->c->get_hval(p, i, &flags));
		} else {
			break;
		}
	}

	/* cache has been successfully updated */
	SET_CACHE_UPDATED();

	/* successfully added */
	items = NULL;

	if (ec == 0) {
		/* perform the Default DD behavior */
		tab->c->ddd(p, '+');

		/* set the return uid */
		if (uid_p != NULL) {
			*uid_p = uid;
		}
	}
add_done:
	if (ec != 0 && items != NULL) {
		free(items);
	}

	return (ec);
}

/*
 * ****************************************************************************
 * htab_remove:
 *	remove an object from the hash table.
 *
 * tab	- the hash table.
 * p	- the lookup control for the object.
 * uid	- the UID of the object.
 * clone_flag - indicate if the removing is for an association object.
 * return - the removed object.
 *
 * ****************************************************************************
 */
isns_obj_t *
htab_remove(
	htab_t *tab,
	void *p,
	uint32_t uid,
	int clone_flag
)
{
	void *zhizi = NULL;
	void *clone = NULL;
	htab_item_t *items = NULL;
	htab_item_t *item, **itemp;
	htab_itemx_t *x = NULL;
	uint32_t chunksz;
	uint32_t flags;
	uint32_t hval;
	int i;

	/* get the object hash value */
	if (uid != 0) {
		x = avl_search(tab, uid);
		if (x != NULL && !BAD_HVAL(x->hval)) {
			hval = x->hval;
		} else {
			goto remove_done;
		}
	} else {
		flags = 0 | FLAGS_CTRL_MASK;
		hval = VALID_HVAL(tab->c->get_hval(p, 0, &flags));
	}

	/* search the object from the table */
	flags = 0;
	chunksz = (1 << tab->logsize);
	for (i = 0; ; ) {
		itemp = &tab->items[(i * chunksz) + (hval & tab->mask)];
		item = *itemp;
		while (item != NULL) {
			/* found it */
			if (tab->c->cmp(item->p, p, 1) == 0) {
				/* make an association object if the object */
				/* has membership in user-defined DD(s). */
				if (i == 0) {
					if ((clone = tab->c->clone(item->p,
					    clone_flag)) == NULL) {
						tab->c->ddd(item->p, '-');
						tab->count --;
						items = item;
						zhizi = item->p;
					}
				}
				if (clone == NULL) {
					/* remove it */
					*itemp = item->next;
				} else if (clone == item->p) {
					/* itself is an association object */
					goto remove_done;
				} else {
					/* replace it with association */
					zhizi = item->p;
					item->p = clone;
				}
				if (i == 0) {
					/* obj has been removed or updated */
					SET_CACHE_UPDATED();
				}
				break;
			}
			itemp = &item->next;
			item = *itemp;
		}
		i ++;
		if (zhizi != NULL && i < tab->chunks) {
			hval = VALID_HVAL(tab->c->get_hval(
			    zhizi, i, &flags));
		} else {
			break;
		}
	}

	/* update the node in the avl tree */
	if (items != NULL) {
		if (x == NULL) {
			uid = tab->c->get_uid(zhizi);
			ASSERT(uid != 0);
			x = avl_search(tab, uid);
		}
		ASSERT(x != NULL && !BAD_HVAL(x->hval));
		/* mark the uid item as invalid */
		x->hval |= BAD_HVAL_MASK;
		/* update the timestamp */
		x->t = tab->c->timestamp();
		/* put it to the end of fifo list */
		if (tab->list != NULL) {
			tab->tail->n = x;
		} else {
			tab->list = x;
		}
		tab->tail = x;
	}

remove_done:
	if (items != NULL) {
		free(items);
	}

	return (zhizi);
}

/*
 * ****************************************************************************
 * htab_lookup:
 *	lookup an object from the hash table.
 *
 * tab	- the hash table.
 * p	- the lookup control for the item.
 * uid	- the UID of the object.
 * uid_p- the pointer of UID for returning.
 * callback - callback function if the object is found.
 * rekey - flag that indicates if the callback function will update
 *		the key of the object.
 * return - error code.
 *
 * ****************************************************************************
 */
int
htab_lookup(
	htab_t *tab,
	void *p,
	uint32_t uid,
	uint32_t *uid_p,
	int (*callback)(void *, void *),
	int rekey
)
{
	uint32_t ret = 0;
	void *zhizi = NULL;
	htab_item_t *item, **itemp;
	htab_itemx_t *x = NULL;
	uint32_t chunksz;
	uint32_t flags = 0 | FLAGS_CTRL_MASK;
	uint32_t hval;
	int i;

	/* compute the hash value */
	if (uid != 0) {
		x = avl_search(tab, uid);
		if (x != NULL) {
			hval = x->hval;
		} else {
			hval = BAD_HVAL_MASK;
		}
	} else {
		hval = VALID_HVAL(tab->c->get_hval(p, 0, &flags));
	}

	/* find the object */
	if (!BAD_HVAL(hval)) {
		i = flags & FLAGS_CHUNK_MASK;
		chunksz = (1 << tab->logsize);
		itemp = &tab->items[(i * chunksz) + (hval & tab->mask)];
		item = *itemp;
		while (item != NULL) {
			if (tab->c->cmp(item->p, p, 1) == 0) {
				zhizi = item->p;
				break;
			}
			itemp = &item->next;
			item = *itemp;
		}
	}

	/* found it */
	if (zhizi != NULL) {
		/* set the return uid */
		if (uid_p != NULL) {
			*uid_p = tab->c->get_uid(zhizi);
		}
		/* invoke callback */
		if (callback != NULL) {
			ret = callback(zhizi, p);
		}
		if (rekey != 0 && ret == 0) {
			/* Rekey works for one-chunk hash table only. */
			ASSERT(tab->chunks == 1 && x != NULL);
			/* remove from previous slot */
			*itemp = item->next;
			/* add it to the new slot */
			flags = 0;
			hval = VALID_HVAL(tab->c->get_hval(zhizi, 0, &flags));
			x->hval = hval;
			item->hval = hval;
			itemp = &tab->items[(hval & tab->mask)];
			while (*itemp != NULL &&
			    (tab->c->get_uid((*itemp)->p) >
			    tab->c->get_uid(zhizi))) {
				itemp = &(*itemp)->next;
			}
			item->next = *itemp;
			*itemp = item;
		}
	} else if (uid_p != NULL) {
		/* set the return uid to 0 */
		*uid_p = 0;
	}

	return (ret);
}

/*
 * ****************************************************************************
 * htab_get_next:
 *	get the next object UID from the hash table.
 *
 * tab	- the hash table.
 * uid	- the previous objet UID.
 * return - the next object UID.
 *
 * ****************************************************************************
 */
uint32_t
htab_get_next(
	htab_t *tab,
	uint32_t uid
)
{
	htab_itemx_t *x;

	do {
		/* search the next node from the avl tree */
		x = avl_search_next(tab, uid);
		if (x != NULL) {
			uid = x->uid;
			/* validate the node */
			if (!BAD_HVAL(x->hval)) {
				return (uid);
			}
		}
	} while (x != NULL);

	/* no more node is available */
	return (0);
}

/*
 * ****************************************************************************
 * htab_dump:
 *	dump all objects stored in the hash table for debug purpose.
 *
 * tab	- the hash table.
 *
 * ****************************************************************************
 */
#ifdef DEBUG
void
htab_dump(
	htab_t *tab
)
{
	uint32_t chunksz;
	htab_item_t *items;

	uint32_t i;

	chunksz = (1 << tab->logsize);

	for (i = 0; i < chunksz; i++) {
		items = tab->items[i];
		while (items != NULL) {
			tab->c->dump(items->p);
			items = items->next;
		}
	}
}
#endif