xref: /freebsd/sys/compat/linuxkpi/common/include/linux/log2.h (revision 8d59ecb214f7e078e57d35b865f33efc5d7cdf4d)
1*8d59ecb2SHans Petter Selasky /*-
2*8d59ecb2SHans Petter Selasky  * Copyright (c) 2010 Isilon Systems, Inc.
3*8d59ecb2SHans Petter Selasky  * Copyright (c) 2010 iX Systems, Inc.
4*8d59ecb2SHans Petter Selasky  * Copyright (c) 2010 Panasas, Inc.
5*8d59ecb2SHans Petter Selasky  * Copyright (c) 2013-2015 Mellanox Technologies, Ltd.
6*8d59ecb2SHans Petter Selasky  * All rights reserved.
7*8d59ecb2SHans Petter Selasky  *
8*8d59ecb2SHans Petter Selasky  * Redistribution and use in source and binary forms, with or without
9*8d59ecb2SHans Petter Selasky  * modification, are permitted provided that the following conditions
10*8d59ecb2SHans Petter Selasky  * are met:
11*8d59ecb2SHans Petter Selasky  * 1. Redistributions of source code must retain the above copyright
12*8d59ecb2SHans Petter Selasky  *    notice unmodified, this list of conditions, and the following
13*8d59ecb2SHans Petter Selasky  *    disclaimer.
14*8d59ecb2SHans Petter Selasky  * 2. Redistributions in binary form must reproduce the above copyright
15*8d59ecb2SHans Petter Selasky  *    notice, this list of conditions and the following disclaimer in the
16*8d59ecb2SHans Petter Selasky  *    documentation and/or other materials provided with the distribution.
17*8d59ecb2SHans Petter Selasky  *
18*8d59ecb2SHans Petter Selasky  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19*8d59ecb2SHans Petter Selasky  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20*8d59ecb2SHans Petter Selasky  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21*8d59ecb2SHans Petter Selasky  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22*8d59ecb2SHans Petter Selasky  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23*8d59ecb2SHans Petter Selasky  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24*8d59ecb2SHans Petter Selasky  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25*8d59ecb2SHans Petter Selasky  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26*8d59ecb2SHans Petter Selasky  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27*8d59ecb2SHans Petter Selasky  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*8d59ecb2SHans Petter Selasky  *
29*8d59ecb2SHans Petter Selasky  * $FreeBSD$
30*8d59ecb2SHans Petter Selasky  */
31*8d59ecb2SHans Petter Selasky #ifndef	_LINUX_LOG2_H_
32*8d59ecb2SHans Petter Selasky #define	_LINUX_LOG2_H_
33*8d59ecb2SHans Petter Selasky 
34*8d59ecb2SHans Petter Selasky #include <linux/types.h>
35*8d59ecb2SHans Petter Selasky 
36*8d59ecb2SHans Petter Selasky #include <sys/libkern.h>
37*8d59ecb2SHans Petter Selasky 
38*8d59ecb2SHans Petter Selasky static inline unsigned long
39*8d59ecb2SHans Petter Selasky roundup_pow_of_two(unsigned long x)
40*8d59ecb2SHans Petter Selasky {
41*8d59ecb2SHans Petter Selasky 	return (1UL << flsl(x - 1));
42*8d59ecb2SHans Petter Selasky }
43*8d59ecb2SHans Petter Selasky 
44*8d59ecb2SHans Petter Selasky static inline int
45*8d59ecb2SHans Petter Selasky is_power_of_2(unsigned long n)
46*8d59ecb2SHans Petter Selasky {
47*8d59ecb2SHans Petter Selasky 	return (n == roundup_pow_of_two(n));
48*8d59ecb2SHans Petter Selasky }
49*8d59ecb2SHans Petter Selasky 
50*8d59ecb2SHans Petter Selasky static inline unsigned long
51*8d59ecb2SHans Petter Selasky rounddown_pow_of_two(unsigned long x)
52*8d59ecb2SHans Petter Selasky {
53*8d59ecb2SHans Petter Selasky         return (1UL << (flsl(x) - 1));
54*8d59ecb2SHans Petter Selasky }
55*8d59ecb2SHans Petter Selasky 
56*8d59ecb2SHans Petter Selasky #define	ilog2(n)				\
57*8d59ecb2SHans Petter Selasky (						\
58*8d59ecb2SHans Petter Selasky 	__builtin_constant_p(n) ? (		\
59*8d59ecb2SHans Petter Selasky 		(n) < 1 ? -1 :			\
60*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 63) ? 63 :	\
61*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 62) ? 62 :	\
62*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 61) ? 61 :	\
63*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 60) ? 60 :	\
64*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 59) ? 59 :	\
65*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 58) ? 58 :	\
66*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 57) ? 57 :	\
67*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 56) ? 56 :	\
68*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 55) ? 55 :	\
69*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 54) ? 54 :	\
70*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 53) ? 53 :	\
71*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 52) ? 52 :	\
72*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 51) ? 51 :	\
73*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 50) ? 50 :	\
74*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 49) ? 49 :	\
75*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 48) ? 48 :	\
76*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 47) ? 47 :	\
77*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 46) ? 46 :	\
78*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 45) ? 45 :	\
79*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 44) ? 44 :	\
80*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 43) ? 43 :	\
81*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 42) ? 42 :	\
82*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 41) ? 41 :	\
83*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 40) ? 40 :	\
84*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 39) ? 39 :	\
85*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 38) ? 38 :	\
86*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 37) ? 37 :	\
87*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 36) ? 36 :	\
88*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 35) ? 35 :	\
89*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 34) ? 34 :	\
90*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 33) ? 33 :	\
91*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 32) ? 32 :	\
92*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 31) ? 31 :	\
93*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 30) ? 30 :	\
94*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 29) ? 29 :	\
95*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 28) ? 28 :	\
96*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 27) ? 27 :	\
97*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 26) ? 26 :	\
98*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 25) ? 25 :	\
99*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 24) ? 24 :	\
100*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 23) ? 23 :	\
101*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 22) ? 22 :	\
102*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 21) ? 21 :	\
103*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 20) ? 20 :	\
104*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 19) ? 19 :	\
105*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 18) ? 18 :	\
106*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 17) ? 17 :	\
107*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 16) ? 16 :	\
108*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 15) ? 15 :	\
109*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 14) ? 14 :	\
110*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 13) ? 13 :	\
111*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 12) ? 12 :	\
112*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 11) ? 11 :	\
113*8d59ecb2SHans Petter Selasky 		(n) & (1ULL << 10) ? 10 :	\
114*8d59ecb2SHans Petter Selasky 		(n) & (1ULL <<  9) ?  9 :	\
115*8d59ecb2SHans Petter Selasky 		(n) & (1ULL <<  8) ?  8 :	\
116*8d59ecb2SHans Petter Selasky 		(n) & (1ULL <<  7) ?  7 :	\
117*8d59ecb2SHans Petter Selasky 		(n) & (1ULL <<  6) ?  6 :	\
118*8d59ecb2SHans Petter Selasky 		(n) & (1ULL <<  5) ?  5 :	\
119*8d59ecb2SHans Petter Selasky 		(n) & (1ULL <<  4) ?  4 :	\
120*8d59ecb2SHans Petter Selasky 		(n) & (1ULL <<  3) ?  3 :	\
121*8d59ecb2SHans Petter Selasky 		(n) & (1ULL <<  2) ?  2 :	\
122*8d59ecb2SHans Petter Selasky 		(n) & (1ULL <<  1) ?  1 :	\
123*8d59ecb2SHans Petter Selasky 		(n) & (1ULL <<  0) ?  0 :	\
124*8d59ecb2SHans Petter Selasky 		-1) :				\
125*8d59ecb2SHans Petter Selasky 	(sizeof(n) <= 4) ?			\
126*8d59ecb2SHans Petter Selasky 	fls((u32)(n)) - 1 : flsll((u64)(n)) - 1	\
127*8d59ecb2SHans Petter Selasky )
128*8d59ecb2SHans Petter Selasky 
129*8d59ecb2SHans Petter Selasky #define	order_base_2(x) ilog2(roundup_pow_of_two(x))
130*8d59ecb2SHans Petter Selasky 
131*8d59ecb2SHans Petter Selasky #endif	/* _LINUX_LOG2_H_ */
132