18d59ecb2SHans Petter Selasky /*-
28d59ecb2SHans Petter Selasky * Copyright (c) 2010 Isilon Systems, Inc.
38d59ecb2SHans Petter Selasky * Copyright (c) 2010 iX Systems, Inc.
48d59ecb2SHans Petter Selasky * Copyright (c) 2010 Panasas, Inc.
52d1bee65SHans Petter Selasky * Copyright (c) 2013-2016 Mellanox Technologies, Ltd.
68d59ecb2SHans Petter Selasky * All rights reserved.
78d59ecb2SHans Petter Selasky *
88d59ecb2SHans Petter Selasky * Redistribution and use in source and binary forms, with or without
98d59ecb2SHans Petter Selasky * modification, are permitted provided that the following conditions
108d59ecb2SHans Petter Selasky * are met:
118d59ecb2SHans Petter Selasky * 1. Redistributions of source code must retain the above copyright
128d59ecb2SHans Petter Selasky * notice unmodified, this list of conditions, and the following
138d59ecb2SHans Petter Selasky * disclaimer.
148d59ecb2SHans Petter Selasky * 2. Redistributions in binary form must reproduce the above copyright
158d59ecb2SHans Petter Selasky * notice, this list of conditions and the following disclaimer in the
168d59ecb2SHans Petter Selasky * documentation and/or other materials provided with the distribution.
178d59ecb2SHans Petter Selasky *
188d59ecb2SHans Petter Selasky * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
198d59ecb2SHans Petter Selasky * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
208d59ecb2SHans Petter Selasky * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
218d59ecb2SHans Petter Selasky * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
228d59ecb2SHans Petter Selasky * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
238d59ecb2SHans Petter Selasky * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
248d59ecb2SHans Petter Selasky * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
258d59ecb2SHans Petter Selasky * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
268d59ecb2SHans Petter Selasky * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
278d59ecb2SHans Petter Selasky * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
288d59ecb2SHans Petter Selasky */
29307f78f3SVladimir Kondratyev #ifndef _LINUXKPI_LINUX_IDR_H_
30307f78f3SVladimir Kondratyev #define _LINUXKPI_LINUX_IDR_H_
318d59ecb2SHans Petter Selasky
328e7baabcSHans Petter Selasky #include <sys/param.h>
338e7baabcSHans Petter Selasky #include <sys/lock.h>
34c7312643SVladimir Kondratyev #include <sys/limits.h>
358e7baabcSHans Petter Selasky #include <sys/mutex.h>
368e7baabcSHans Petter Selasky
378e7baabcSHans Petter Selasky #include <linux/types.h>
388d59ecb2SHans Petter Selasky
398d59ecb2SHans Petter Selasky #define IDR_BITS 5
408d59ecb2SHans Petter Selasky #define IDR_SIZE (1 << IDR_BITS)
418d59ecb2SHans Petter Selasky #define IDR_MASK (IDR_SIZE - 1)
428d59ecb2SHans Petter Selasky
438d59ecb2SHans Petter Selasky #define MAX_ID_SHIFT ((sizeof(int) * NBBY) - 1)
448d59ecb2SHans Petter Selasky #define MAX_ID_BIT (1U << MAX_ID_SHIFT)
458d59ecb2SHans Petter Selasky #define MAX_ID_MASK (MAX_ID_BIT - 1)
468d59ecb2SHans Petter Selasky #define MAX_LEVEL (MAX_ID_SHIFT + IDR_BITS - 1) / IDR_BITS
478d59ecb2SHans Petter Selasky
488d59ecb2SHans Petter Selasky #define MAX_IDR_SHIFT (sizeof(int)*8 - 1)
498d59ecb2SHans Petter Selasky #define MAX_IDR_BIT (1U << MAX_IDR_SHIFT)
508d59ecb2SHans Petter Selasky #define MAX_IDR_MASK (MAX_IDR_BIT - 1)
518d59ecb2SHans Petter Selasky
528d59ecb2SHans Petter Selasky struct idr_layer {
538d59ecb2SHans Petter Selasky unsigned long bitmap;
548d59ecb2SHans Petter Selasky struct idr_layer *ary[IDR_SIZE];
558d59ecb2SHans Petter Selasky };
568d59ecb2SHans Petter Selasky
578d59ecb2SHans Petter Selasky struct idr {
588d59ecb2SHans Petter Selasky struct mtx lock;
598d59ecb2SHans Petter Selasky struct idr_layer *top;
608d59ecb2SHans Petter Selasky struct idr_layer *free;
618d59ecb2SHans Petter Selasky int layers;
622d1bee65SHans Petter Selasky int next_cyclic_id;
638d59ecb2SHans Petter Selasky };
648d59ecb2SHans Petter Selasky
65fd42d623SHans Petter Selasky /* NOTE: It is the applications responsibility to destroy the IDR */
668d59ecb2SHans Petter Selasky #define DEFINE_IDR(name) \
678d59ecb2SHans Petter Selasky struct idr name; \
688d59ecb2SHans Petter Selasky SYSINIT(name##_idr_sysinit, SI_SUB_DRIVERS, SI_ORDER_FIRST, \
69fd42d623SHans Petter Selasky idr_init, &(name))
70fd42d623SHans Petter Selasky
71fd42d623SHans Petter Selasky /* NOTE: It is the applications responsibility to destroy the IDA */
72fd42d623SHans Petter Selasky #define DEFINE_IDA(name) \
73fd42d623SHans Petter Selasky struct ida name; \
74fd42d623SHans Petter Selasky SYSINIT(name##_ida_sysinit, SI_SUB_DRIVERS, SI_ORDER_FIRST, \
75fd42d623SHans Petter Selasky ida_init, &(name))
768d59ecb2SHans Petter Selasky
77427cefdeSHans Petter Selasky void idr_preload(gfp_t gfp_mask);
78427cefdeSHans Petter Selasky void idr_preload_end(void);
798d59ecb2SHans Petter Selasky void *idr_find(struct idr *idp, int id);
80fd42d623SHans Petter Selasky void *idr_get_next(struct idr *idp, int *nextid);
8169d6653bSHans Petter Selasky bool idr_is_empty(struct idr *idp);
828d59ecb2SHans Petter Selasky int idr_pre_get(struct idr *idp, gfp_t gfp_mask);
838d59ecb2SHans Petter Selasky int idr_get_new(struct idr *idp, void *ptr, int *id);
848d59ecb2SHans Petter Selasky int idr_get_new_above(struct idr *idp, void *ptr, int starting_id, int *id);
858d59ecb2SHans Petter Selasky void *idr_replace(struct idr *idp, void *ptr, int id);
8669d6653bSHans Petter Selasky void *idr_remove(struct idr *idp, int id);
878d59ecb2SHans Petter Selasky void idr_remove_all(struct idr *idp);
888d59ecb2SHans Petter Selasky void idr_destroy(struct idr *idp);
898d59ecb2SHans Petter Selasky void idr_init(struct idr *idp);
902d1bee65SHans Petter Selasky int idr_alloc(struct idr *idp, void *ptr, int start, int end, gfp_t);
912d1bee65SHans Petter Selasky int idr_alloc_cyclic(struct idr *idp, void *ptr, int start, int end, gfp_t);
92fd42d623SHans Petter Selasky int idr_for_each(struct idr *idp, int (*fn)(int id, void *p, void *data), void *data);
93fd42d623SHans Petter Selasky
94fd42d623SHans Petter Selasky #define idr_for_each_entry(idp, entry, id) \
95fd42d623SHans Petter Selasky for ((id) = 0; ((entry) = idr_get_next(idp, &(id))) != NULL; ++(id))
96fd42d623SHans Petter Selasky
97fd42d623SHans Petter Selasky #define IDA_CHUNK_SIZE 128 /* 128 bytes per chunk */
98fd42d623SHans Petter Selasky #define IDA_BITMAP_LONGS (IDA_CHUNK_SIZE / sizeof(long) - 1)
99fd42d623SHans Petter Selasky #define IDA_BITMAP_BITS (IDA_BITMAP_LONGS * sizeof(long) * 8)
100fd42d623SHans Petter Selasky
101fd42d623SHans Petter Selasky struct ida_bitmap {
102fd42d623SHans Petter Selasky long nr_busy;
103fd42d623SHans Petter Selasky unsigned long bitmap[IDA_BITMAP_LONGS];
104fd42d623SHans Petter Selasky };
105fd42d623SHans Petter Selasky
106fd42d623SHans Petter Selasky struct ida {
107fd42d623SHans Petter Selasky struct idr idr;
108fd42d623SHans Petter Selasky struct ida_bitmap *free_bitmap;
109fd42d623SHans Petter Selasky };
110fd42d623SHans Petter Selasky
111fd42d623SHans Petter Selasky int ida_pre_get(struct ida *ida, gfp_t gfp_mask);
112fd42d623SHans Petter Selasky int ida_get_new_above(struct ida *ida, int starting_id, int *p_id);
113fd42d623SHans Petter Selasky void ida_remove(struct ida *ida, int id);
114fd42d623SHans Petter Selasky void ida_destroy(struct ida *ida);
115fd42d623SHans Petter Selasky void ida_init(struct ida *ida);
116fd42d623SHans Petter Selasky
117fd42d623SHans Petter Selasky int ida_simple_get(struct ida *ida, unsigned int start, unsigned int end,
118fd42d623SHans Petter Selasky gfp_t gfp_mask);
119fd42d623SHans Petter Selasky void ida_simple_remove(struct ida *ida, unsigned int id);
120fd42d623SHans Petter Selasky
1217d595f6bSHans Petter Selasky static inline void
ida_free(struct ida * ida,int id)1227d595f6bSHans Petter Selasky ida_free(struct ida *ida, int id)
1237d595f6bSHans Petter Selasky {
1247d595f6bSHans Petter Selasky
1257d595f6bSHans Petter Selasky ida_remove(ida, id);
1267d595f6bSHans Petter Selasky }
1277d595f6bSHans Petter Selasky
128fd42d623SHans Petter Selasky static inline int
ida_get_new(struct ida * ida,int * p_id)129fd42d623SHans Petter Selasky ida_get_new(struct ida *ida, int *p_id)
130fd42d623SHans Petter Selasky {
131be34cfc5SSlava Shwartsman
132fd42d623SHans Petter Selasky return (ida_get_new_above(ida, 0, p_id));
133fd42d623SHans Petter Selasky }
1348d59ecb2SHans Petter Selasky
135839b4bf2SHans Petter Selasky static inline int
ida_alloc_min(struct ida * ida,unsigned int min,gfp_t gfp)136c7312643SVladimir Kondratyev ida_alloc_min(struct ida *ida, unsigned int min, gfp_t gfp)
137c7312643SVladimir Kondratyev {
138c7312643SVladimir Kondratyev return (ida_simple_get(ida, min, UINT_MAX, gfp));
139c7312643SVladimir Kondratyev }
140c7312643SVladimir Kondratyev
141c7312643SVladimir Kondratyev static inline int
ida_alloc_max(struct ida * ida,unsigned int max,gfp_t gfp)142839b4bf2SHans Petter Selasky ida_alloc_max(struct ida *ida, unsigned int max, gfp_t gfp)
143839b4bf2SHans Petter Selasky {
144839b4bf2SHans Petter Selasky
145839b4bf2SHans Petter Selasky return (ida_simple_get(ida, 0, max, gfp));
146839b4bf2SHans Petter Selasky }
147839b4bf2SHans Petter Selasky
ida_alloc(struct ida * ida,gfp_t gfp)148d98f2712SAlex Richardson static inline int ida_alloc(struct ida *ida, gfp_t gfp)
149d98f2712SAlex Richardson {
150d98f2712SAlex Richardson return (ida_alloc_max(ida, ~0u, gfp));
151d98f2712SAlex Richardson }
152d98f2712SAlex Richardson
153be34cfc5SSlava Shwartsman static inline bool
ida_is_empty(struct ida * ida)154be34cfc5SSlava Shwartsman ida_is_empty(struct ida *ida)
155be34cfc5SSlava Shwartsman {
156be34cfc5SSlava Shwartsman
157be34cfc5SSlava Shwartsman return (idr_is_empty(&ida->idr));
158be34cfc5SSlava Shwartsman }
159be34cfc5SSlava Shwartsman
160307f78f3SVladimir Kondratyev #endif /* _LINUXKPI_LINUX_IDR_H_ */
161