xref: /dragonfly/sys/sys/idr.h (revision 8accc937)
1 /*
2  * Copyright (c) 2005-2012 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Jeffrey Hsu.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  */
35 
36 /**
37  * IDR is a small Integer ID management library that provides an interface to
38  * map integers with some pointer that can later be retrieved.
39  *
40  * NOTE: Pointer mapped by integer can't be NULL.
41  *
42  */
43 
44 
45 #ifndef _IDR_H_
46 #define _IDR_H_
47 
48 #ifdef _KERNEL
49 
50 #include <sys/spinlock.h>
51 
52 struct idr_node {
53 	void	*data;
54 	char	 reserved;
55 	int	 allocated;
56 };
57 
58 struct idr {
59 	struct	    idr_node *idr_nodes;
60 	int	    idr_count;
61 	int	    idr_lastindex;
62 	int	    idr_freeindex;
63 	int	    idr_nexpands;
64 	int	    idr_maxwant;
65 	struct	    spinlock idr_spin;
66 };
67 
68 void	*idr_find(struct idr *idp, int id);
69 void	*idr_replace(struct idr *idp, void *ptr, int id);
70 void	 idr_remove(struct idr *idp, int id);
71 void	 idr_remove_all(struct idr *idp);
72 void	 idr_destroy(struct idr *idp);
73 int	 idr_for_each(struct idr *idp, int (*fn)(int id, void *p, void *data), void *data);
74 int	 idr_get_new(struct idr *idp, void *ptr, int *id);
75 int	 idr_get_new_above(struct idr *idp, void *ptr, int sid, int *id);
76 int	 idr_pre_get(struct idr *idp);
77 
78 void	 idr_init1(struct idr *idp, int size);
79 void	 idr_init(struct idr *idp);
80 
81 
82 #endif /* _KERNEL */
83 
84 #endif /* _IDR_H_ */
85