Home | History | Annotate | Line # | Download | only in linux
idr.h revision 1.8
      1  1.8  riastrad /*	$NetBSD: idr.h,v 1.8 2021/12/19 01:00:17 riastradh Exp $	*/
      2  1.2  riastrad 
      3  1.2  riastrad /*-
      4  1.2  riastrad  * Copyright (c) 2013 The NetBSD Foundation, Inc.
      5  1.2  riastrad  * All rights reserved.
      6  1.2  riastrad  *
      7  1.2  riastrad  * This code is derived from software contributed to The NetBSD Foundation
      8  1.2  riastrad  * by Taylor R. Campbell.
      9  1.2  riastrad  *
     10  1.2  riastrad  * Redistribution and use in source and binary forms, with or without
     11  1.2  riastrad  * modification, are permitted provided that the following conditions
     12  1.2  riastrad  * are met:
     13  1.2  riastrad  * 1. Redistributions of source code must retain the above copyright
     14  1.2  riastrad  *    notice, this list of conditions and the following disclaimer.
     15  1.2  riastrad  * 2. Redistributions in binary form must reproduce the above copyright
     16  1.2  riastrad  *    notice, this list of conditions and the following disclaimer in the
     17  1.2  riastrad  *    documentation and/or other materials provided with the distribution.
     18  1.2  riastrad  *
     19  1.2  riastrad  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  1.2  riastrad  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  1.2  riastrad  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  1.2  riastrad  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  1.2  riastrad  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  1.2  riastrad  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  1.2  riastrad  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  1.2  riastrad  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  1.2  riastrad  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  1.2  riastrad  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  1.2  riastrad  * POSSIBILITY OF SUCH DAMAGE.
     30  1.2  riastrad  */
     31  1.2  riastrad 
     32  1.2  riastrad #ifndef _LINUX_IDR_H_
     33  1.2  riastrad #define _LINUX_IDR_H_
     34  1.2  riastrad 
     35  1.2  riastrad #include <sys/types.h>
     36  1.2  riastrad #include <sys/rbtree.h>
     37  1.3  riastrad 
     38  1.3  riastrad #include <linux/gfp.h>
     39  1.2  riastrad 
     40  1.2  riastrad /* XXX Stupid expedient algorithm should be replaced by something better.  */
     41  1.2  riastrad 
     42  1.2  riastrad struct idr {
     43  1.3  riastrad 	kmutex_t	idr_lock;
     44  1.3  riastrad 	rb_tree_t	idr_tree;
     45  1.8  riastrad 	int		idr_base;
     46  1.2  riastrad };
     47  1.2  riastrad 
     48  1.2  riastrad /* XXX Make the nm output a little more greppable...  */
     49  1.4  riastrad #define	idr_alloc		linux_idr_alloc
     50  1.4  riastrad #define	idr_destroy		linux_idr_destroy
     51  1.4  riastrad #define	idr_find		linux_idr_find
     52  1.4  riastrad #define	idr_for_each		linux_idr_for_each
     53  1.5  riastrad #define	idr_get_next		linux_idr_get_next
     54  1.2  riastrad #define	idr_init		linux_idr_init
     55  1.8  riastrad #define	idr_init_base		linux_idr_init_base
     56  1.3  riastrad #define	idr_is_empty		linux_idr_is_empty
     57  1.3  riastrad #define	idr_preload		linux_idr_preload
     58  1.3  riastrad #define	idr_preload_end		linux_idr_preload_end
     59  1.4  riastrad #define	idr_remove		linux_idr_remove
     60  1.4  riastrad #define	idr_replace		linux_idr_replace
     61  1.2  riastrad 
     62  1.3  riastrad int	linux_idr_module_init(void);
     63  1.3  riastrad void	linux_idr_module_fini(void);
     64  1.3  riastrad 
     65  1.2  riastrad void	idr_init(struct idr *);
     66  1.8  riastrad void	idr_init_base(struct idr *, int);
     67  1.2  riastrad void	idr_destroy(struct idr *);
     68  1.3  riastrad bool	idr_is_empty(struct idr *);
     69  1.2  riastrad void	*idr_find(struct idr *, int);
     70  1.5  riastrad void	*idr_get_next(struct idr *, int *);
     71  1.2  riastrad void	*idr_replace(struct idr *, void *, int);
     72  1.2  riastrad void	idr_remove(struct idr *, int);
     73  1.3  riastrad void	idr_preload(gfp_t);
     74  1.3  riastrad int	idr_alloc(struct idr *, void *, int, int, gfp_t);
     75  1.3  riastrad void	idr_preload_end(void);
     76  1.2  riastrad int	idr_for_each(struct idr *, int (*)(int, void *, void *), void *);
     77  1.2  riastrad 
     78  1.5  riastrad #define	idr_for_each_entry(IDR, ENTRY, ID)				      \
     79  1.5  riastrad 	for ((ID) = 0; ((ENTRY) = idr_get_next((IDR), &(ID))) != NULL; (ID)++)
     80  1.5  riastrad 
     81  1.3  riastrad struct ida {
     82  1.3  riastrad 	struct idr	ida_idr;
     83  1.3  riastrad };
     84  1.3  riastrad 
     85  1.3  riastrad static inline void
     86  1.3  riastrad ida_init(struct ida *ida)
     87  1.3  riastrad {
     88  1.3  riastrad 
     89  1.3  riastrad 	idr_init(&ida->ida_idr);
     90  1.3  riastrad }
     91  1.3  riastrad 
     92  1.3  riastrad static inline void
     93  1.3  riastrad ida_destroy(struct ida *ida)
     94  1.3  riastrad {
     95  1.3  riastrad 
     96  1.3  riastrad 	idr_destroy(&ida->ida_idr);
     97  1.3  riastrad }
     98  1.3  riastrad 
     99  1.3  riastrad static inline void
    100  1.3  riastrad ida_remove(struct ida *ida, int id)
    101  1.3  riastrad {
    102  1.3  riastrad 
    103  1.3  riastrad 	idr_remove(&ida->ida_idr, id);
    104  1.3  riastrad }
    105  1.3  riastrad 
    106  1.3  riastrad static inline int
    107  1.3  riastrad ida_simple_get(struct ida *ida, unsigned start, unsigned end, gfp_t gfp)
    108  1.3  riastrad {
    109  1.3  riastrad 	int id;
    110  1.3  riastrad 
    111  1.3  riastrad 	KASSERT(start <= INT_MAX);
    112  1.3  riastrad 	KASSERT(end <= INT_MAX);
    113  1.3  riastrad 
    114  1.3  riastrad 	idr_preload(gfp);
    115  1.3  riastrad 	id = idr_alloc(&ida->ida_idr, NULL, start, end, gfp);
    116  1.3  riastrad 	idr_preload_end();
    117  1.3  riastrad 
    118  1.3  riastrad 	return id;
    119  1.3  riastrad }
    120  1.3  riastrad 
    121  1.6  riastrad static inline void
    122  1.6  riastrad ida_simple_remove(struct ida *ida, unsigned int id)
    123  1.6  riastrad {
    124  1.6  riastrad 
    125  1.6  riastrad 	KASSERT((int)id >= 0);
    126  1.6  riastrad 	ida_remove(ida, id);
    127  1.6  riastrad }
    128  1.6  riastrad 
    129  1.2  riastrad #endif  /* _LINUX_IDR_H_ */
    130