blob: 883ef3755a1cb390ae06efab84a483f4978bd574 [file] [log] [blame]
Yury Norov8f6f19d2015-04-16 12:43:16 -07001/* bit search implementation
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 *
3 * Copyright (C) 2004 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
5 *
Yury Norov8f6f19d2015-04-16 12:43:16 -07006 * Copyright (C) 2008 IBM Corporation
7 * 'find_last_bit' is written by Rusty Russell <rusty@rustcorp.com.au>
8 * (Inspired by David Howell's find_next_bit implementation)
9 *
Yury Norov2c57a0e2015-04-16 12:43:13 -070010 * Rewritten by Yury Norov <yury.norov@gmail.com> to decrease
11 * size and improve performance, 2015.
12 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License
15 * as published by the Free Software Foundation; either version
16 * 2 of the License, or (at your option) any later version.
17 */
18
19#include <linux/bitops.h>
Yury Norov8f6f19d2015-04-16 12:43:16 -070020#include <linux/bitmap.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050021#include <linux/export.h>
Yury Norov2c57a0e2015-04-16 12:43:13 -070022#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
Yury Norov2c57a0e2015-04-16 12:43:13 -070024#if !defined(find_next_bit) || !defined(find_next_zero_bit)
25
26/*
27 * This is a common helper function for find_next_bit and
28 * find_next_zero_bit. The difference is the "invert" argument, which
29 * is XORed with each fetched word before searching it for one bits.
30 */
31static unsigned long _find_next_bit(const unsigned long *addr,
32 unsigned long nbits, unsigned long start, unsigned long invert)
33{
34 unsigned long tmp;
35
Matthew Wilcoxe4afd2e2017-02-24 15:00:58 -080036 if (unlikely(start >= nbits))
Yury Norov2c57a0e2015-04-16 12:43:13 -070037 return nbits;
38
39 tmp = addr[start / BITS_PER_LONG] ^ invert;
40
41 /* Handle 1st word. */
42 tmp &= BITMAP_FIRST_WORD_MASK(start);
43 start = round_down(start, BITS_PER_LONG);
44
45 while (!tmp) {
46 start += BITS_PER_LONG;
47 if (start >= nbits)
48 return nbits;
49
50 tmp = addr[start / BITS_PER_LONG] ^ invert;
51 }
52
53 return min(start + __ffs(tmp), nbits);
54}
55#endif
Akinobu Mitac7f612c2006-03-26 01:39:11 -080056
Akinobu Mita19de85e2011-05-26 16:26:09 -070057#ifndef find_next_bit
Alexander van Heukelum64970b62008-03-11 16:17:19 +010058/*
59 * Find the next set bit in a memory region.
Akinobu Mitac7f612c2006-03-26 01:39:11 -080060 */
Thomas Gleixnerfee4b192008-04-29 12:01:02 +020061unsigned long find_next_bit(const unsigned long *addr, unsigned long size,
62 unsigned long offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -070063{
Yury Norov2c57a0e2015-04-16 12:43:13 -070064 return _find_next_bit(addr, size, offset, 0UL);
Linus Torvalds1da177e2005-04-16 15:20:36 -070065}
Thomas Gleixnerfee4b192008-04-29 12:01:02 +020066EXPORT_SYMBOL(find_next_bit);
Akinobu Mita19de85e2011-05-26 16:26:09 -070067#endif
Akinobu Mitac7f612c2006-03-26 01:39:11 -080068
Akinobu Mita19de85e2011-05-26 16:26:09 -070069#ifndef find_next_zero_bit
Thomas Gleixnerfee4b192008-04-29 12:01:02 +020070unsigned long find_next_zero_bit(const unsigned long *addr, unsigned long size,
71 unsigned long offset)
Akinobu Mitac7f612c2006-03-26 01:39:11 -080072{
Yury Norov2c57a0e2015-04-16 12:43:13 -070073 return _find_next_bit(addr, size, offset, ~0UL);
Akinobu Mitac7f612c2006-03-26 01:39:11 -080074}
Thomas Gleixnerfee4b192008-04-29 12:01:02 +020075EXPORT_SYMBOL(find_next_zero_bit);
Akinobu Mita19de85e2011-05-26 16:26:09 -070076#endif
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +020077
Akinobu Mita19de85e2011-05-26 16:26:09 -070078#ifndef find_first_bit
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +020079/*
80 * Find the first set bit in a memory region.
81 */
Thomas Gleixnerfee4b192008-04-29 12:01:02 +020082unsigned long find_first_bit(const unsigned long *addr, unsigned long size)
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +020083{
Yury Norov2c57a0e2015-04-16 12:43:13 -070084 unsigned long idx;
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +020085
Yury Norov2c57a0e2015-04-16 12:43:13 -070086 for (idx = 0; idx * BITS_PER_LONG < size; idx++) {
87 if (addr[idx])
88 return min(idx * BITS_PER_LONG + __ffs(addr[idx]), size);
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +020089 }
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +020090
Yury Norov2c57a0e2015-04-16 12:43:13 -070091 return size;
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +020092}
Thomas Gleixnerfee4b192008-04-29 12:01:02 +020093EXPORT_SYMBOL(find_first_bit);
Akinobu Mita19de85e2011-05-26 16:26:09 -070094#endif
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +020095
Akinobu Mita19de85e2011-05-26 16:26:09 -070096#ifndef find_first_zero_bit
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +020097/*
98 * Find the first cleared bit in a memory region.
99 */
Thomas Gleixnerfee4b192008-04-29 12:01:02 +0200100unsigned long find_first_zero_bit(const unsigned long *addr, unsigned long size)
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +0200101{
Yury Norov2c57a0e2015-04-16 12:43:13 -0700102 unsigned long idx;
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +0200103
Yury Norov2c57a0e2015-04-16 12:43:13 -0700104 for (idx = 0; idx * BITS_PER_LONG < size; idx++) {
105 if (addr[idx] != ~0UL)
106 return min(idx * BITS_PER_LONG + ffz(addr[idx]), size);
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +0200107 }
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +0200108
Yury Norov2c57a0e2015-04-16 12:43:13 -0700109 return size;
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +0200110}
Thomas Gleixnerfee4b192008-04-29 12:01:02 +0200111EXPORT_SYMBOL(find_first_zero_bit);
Akinobu Mita19de85e2011-05-26 16:26:09 -0700112#endif
Akinobu Mita930ae742006-03-26 01:39:15 -0800113
Yury Norov8f6f19d2015-04-16 12:43:16 -0700114#ifndef find_last_bit
115unsigned long find_last_bit(const unsigned long *addr, unsigned long size)
116{
117 if (size) {
118 unsigned long val = BITMAP_LAST_WORD_MASK(size);
119 unsigned long idx = (size-1) / BITS_PER_LONG;
120
121 do {
122 val &= addr[idx];
123 if (val)
124 return idx * BITS_PER_LONG + __fls(val);
125
126 val = ~0ul;
127 } while (idx--);
128 }
129 return size;
130}
131EXPORT_SYMBOL(find_last_bit);
132#endif
133
Akinobu Mita930ae742006-03-26 01:39:15 -0800134#ifdef __BIG_ENDIAN
135
Yury Norov2c57a0e2015-04-16 12:43:13 -0700136#if !defined(find_next_bit_le) || !defined(find_next_zero_bit_le)
137static unsigned long _find_next_bit_le(const unsigned long *addr,
138 unsigned long nbits, unsigned long start, unsigned long invert)
139{
140 unsigned long tmp;
141
Matthew Wilcoxe4afd2e2017-02-24 15:00:58 -0800142 if (unlikely(start >= nbits))
Yury Norov2c57a0e2015-04-16 12:43:13 -0700143 return nbits;
144
145 tmp = addr[start / BITS_PER_LONG] ^ invert;
146
147 /* Handle 1st word. */
Yury Norov4eb9d5b2020-01-30 22:16:40 -0800148 tmp &= swab(BITMAP_FIRST_WORD_MASK(start));
Yury Norov2c57a0e2015-04-16 12:43:13 -0700149 start = round_down(start, BITS_PER_LONG);
150
151 while (!tmp) {
152 start += BITS_PER_LONG;
153 if (start >= nbits)
154 return nbits;
155
156 tmp = addr[start / BITS_PER_LONG] ^ invert;
157 }
158
Yury Norov4eb9d5b2020-01-30 22:16:40 -0800159 return min(start + __ffs(swab(tmp)), nbits);
Yury Norov2c57a0e2015-04-16 12:43:13 -0700160}
161#endif
162
Akinobu Mita19de85e2011-05-26 16:26:09 -0700163#ifndef find_next_zero_bit_le
Akinobu Mitaa56560b2011-03-23 16:41:50 -0700164unsigned long find_next_zero_bit_le(const void *addr, unsigned
Akinobu Mita930ae742006-03-26 01:39:15 -0800165 long size, unsigned long offset)
166{
Yury Norov2c57a0e2015-04-16 12:43:13 -0700167 return _find_next_bit_le(addr, size, offset, ~0UL);
Akinobu Mita930ae742006-03-26 01:39:15 -0800168}
Akinobu Mitac4945b92011-03-23 16:41:47 -0700169EXPORT_SYMBOL(find_next_zero_bit_le);
Akinobu Mita19de85e2011-05-26 16:26:09 -0700170#endif
Akinobu Mita930ae742006-03-26 01:39:15 -0800171
Akinobu Mita19de85e2011-05-26 16:26:09 -0700172#ifndef find_next_bit_le
Akinobu Mitaa56560b2011-03-23 16:41:50 -0700173unsigned long find_next_bit_le(const void *addr, unsigned
Aneesh Kumar K.Vaa02ad62008-01-28 23:58:27 -0500174 long size, unsigned long offset)
175{
Yury Norov2c57a0e2015-04-16 12:43:13 -0700176 return _find_next_bit_le(addr, size, offset, 0UL);
Aneesh Kumar K.Vaa02ad62008-01-28 23:58:27 -0500177}
Akinobu Mitac4945b92011-03-23 16:41:47 -0700178EXPORT_SYMBOL(find_next_bit_le);
Akinobu Mita19de85e2011-05-26 16:26:09 -0700179#endif
Akinobu Mita06649962011-03-23 16:41:59 -0700180
Akinobu Mita930ae742006-03-26 01:39:15 -0800181#endif /* __BIG_ENDIAN */