blob: 0d1d23ea7925b36a21c9aedc3dabfa5d064dd591 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Copyright (C) 2001 Momchil Velikov
3 * Portions Copyright (C) 2001 Christoph Hellwig
Christoph Lametercde53532008-07-04 09:59:22 -07004 * Copyright (C) 2005 SGI, Christoph Lameter
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08005 * Copyright (C) 2006 Nick Piggin
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07006 * Copyright (C) 2012 Konstantin Khlebnikov
Matthew Wilcox6b053b82016-05-20 17:02:58 -07007 * Copyright (C) 2016 Intel, Matthew Wilcox
8 * Copyright (C) 2016 Intel, Ross Zwisler
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation; either version 2, or (at
13 * your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 */
24
25#include <linux/errno.h>
26#include <linux/init.h>
27#include <linux/kernel.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050028#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/radix-tree.h>
30#include <linux/percpu.h>
31#include <linux/slab.h>
Catalin Marinasce80b062014-06-06 14:38:18 -070032#include <linux/kmemleak.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <linux/cpu.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/string.h>
35#include <linux/bitops.h>
Nick Piggin7cf9c2c2006-12-06 20:33:44 -080036#include <linux/rcupdate.h>
Frederic Weisbecker92cf2112015-05-12 16:41:46 +020037#include <linux/preempt.h> /* in_interrupt() */
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -070040/* Number of nodes in fully populated tree of given height */
41static unsigned long height_to_maxnodes[RADIX_TREE_MAX_PATH + 1] __read_mostly;
42
Jeff Moyer26fb1582007-10-16 01:24:49 -070043/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 * Radix tree node cache.
45 */
Christoph Lametere18b8902006-12-06 20:33:20 -080046static struct kmem_cache *radix_tree_node_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48/*
Nick Piggin55368052012-05-29 15:07:34 -070049 * The radix tree is variable-height, so an insert operation not only has
50 * to build the branch to its corresponding item, it also has to build the
51 * branch to existing items if the size has to be increased (by
52 * radix_tree_extend).
53 *
54 * The worst case is a zero height tree with just a single item at index 0,
55 * and then inserting an item at index ULONG_MAX. This requires 2 new branches
56 * of RADIX_TREE_MAX_PATH size to be created, with only the root node shared.
57 * Hence:
58 */
59#define RADIX_TREE_PRELOAD_SIZE (RADIX_TREE_MAX_PATH * 2 - 1)
60
61/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 * Per-cpu pool of preloaded nodes
63 */
64struct radix_tree_preload {
Matthew Wilcox2fcd9002016-05-20 17:03:04 -070065 unsigned nr;
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -070066 /* nodes->private_data points to next preallocated node */
67 struct radix_tree_node *nodes;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068};
Harvey Harrison8cef7d52009-01-06 14:40:50 -080069static DEFINE_PER_CPU(struct radix_tree_preload, radix_tree_preloads) = { 0, };
Linus Torvalds1da177e2005-04-16 15:20:36 -070070
Matthew Wilcoxa4db4dc2016-05-20 17:03:24 -070071static inline void *node_to_entry(void *ptr)
Nick Piggin27d20fd2010-11-11 14:05:19 -080072{
Matthew Wilcox30ff46cc2016-05-20 17:03:22 -070073 return (void *)((unsigned long)ptr | RADIX_TREE_INTERNAL_NODE);
Nick Piggin27d20fd2010-11-11 14:05:19 -080074}
75
Matthew Wilcoxa4db4dc2016-05-20 17:03:24 -070076#define RADIX_TREE_RETRY node_to_entry(NULL)
Matthew Wilcoxafe0e392016-05-20 17:02:17 -070077
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070078#ifdef CONFIG_RADIX_TREE_MULTIORDER
79/* Sibling slots point directly to another slot in the same node */
80static inline bool is_sibling_entry(struct radix_tree_node *parent, void *node)
81{
82 void **ptr = node;
83 return (parent->slots <= ptr) &&
84 (ptr < parent->slots + RADIX_TREE_MAP_SIZE);
85}
86#else
87static inline bool is_sibling_entry(struct radix_tree_node *parent, void *node)
88{
89 return false;
90}
91#endif
92
93static inline unsigned long get_slot_offset(struct radix_tree_node *parent,
94 void **slot)
95{
96 return slot - parent->slots;
97}
98
Matthew Wilcox9e85d812016-05-20 17:03:48 -070099static unsigned int radix_tree_descend(struct radix_tree_node *parent,
100 struct radix_tree_node **nodep, unsigned long index)
Matthew Wilcoxdb050f22016-05-20 17:01:57 -0700101{
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700102 unsigned int offset = (index >> parent->shift) & RADIX_TREE_MAP_MASK;
Matthew Wilcoxdb050f22016-05-20 17:01:57 -0700103 void **entry = rcu_dereference_raw(parent->slots[offset]);
104
105#ifdef CONFIG_RADIX_TREE_MULTIORDER
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700106 if (radix_tree_is_internal_node(entry)) {
Linus Torvalds8d2c0d32016-09-25 13:32:46 -0700107 if (is_sibling_entry(parent, entry)) {
108 void **sibentry = (void **) entry_to_node(entry);
109 offset = get_slot_offset(parent, sibentry);
110 entry = rcu_dereference_raw(*sibentry);
Matthew Wilcoxdb050f22016-05-20 17:01:57 -0700111 }
112 }
113#endif
114
115 *nodep = (void *)entry;
116 return offset;
117}
118
Nick Piggin612d6c12006-06-23 02:03:22 -0700119static inline gfp_t root_gfp_mask(struct radix_tree_root *root)
120{
121 return root->gfp_mask & __GFP_BITS_MASK;
122}
123
Nick Piggin643b52b2008-06-12 15:21:52 -0700124static inline void tag_set(struct radix_tree_node *node, unsigned int tag,
125 int offset)
126{
127 __set_bit(offset, node->tags[tag]);
128}
129
130static inline void tag_clear(struct radix_tree_node *node, unsigned int tag,
131 int offset)
132{
133 __clear_bit(offset, node->tags[tag]);
134}
135
136static inline int tag_get(struct radix_tree_node *node, unsigned int tag,
137 int offset)
138{
139 return test_bit(offset, node->tags[tag]);
140}
141
142static inline void root_tag_set(struct radix_tree_root *root, unsigned int tag)
143{
144 root->gfp_mask |= (__force gfp_t)(1 << (tag + __GFP_BITS_SHIFT));
145}
146
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700147static inline void root_tag_clear(struct radix_tree_root *root, unsigned tag)
Nick Piggin643b52b2008-06-12 15:21:52 -0700148{
149 root->gfp_mask &= (__force gfp_t)~(1 << (tag + __GFP_BITS_SHIFT));
150}
151
152static inline void root_tag_clear_all(struct radix_tree_root *root)
153{
154 root->gfp_mask &= __GFP_BITS_MASK;
155}
156
157static inline int root_tag_get(struct radix_tree_root *root, unsigned int tag)
158{
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700159 return (__force int)root->gfp_mask & (1 << (tag + __GFP_BITS_SHIFT));
Nick Piggin643b52b2008-06-12 15:21:52 -0700160}
161
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700162static inline unsigned root_tags_get(struct radix_tree_root *root)
163{
164 return (__force unsigned)root->gfp_mask >> __GFP_BITS_SHIFT;
165}
166
Nick Piggin643b52b2008-06-12 15:21:52 -0700167/*
168 * Returns 1 if any slot in the node has this tag set.
169 * Otherwise returns 0.
170 */
171static inline int any_tag_set(struct radix_tree_node *node, unsigned int tag)
172{
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700173 unsigned idx;
Nick Piggin643b52b2008-06-12 15:21:52 -0700174 for (idx = 0; idx < RADIX_TREE_TAG_LONGS; idx++) {
175 if (node->tags[tag][idx])
176 return 1;
177 }
178 return 0;
179}
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700180
181/**
182 * radix_tree_find_next_bit - find the next set bit in a memory region
183 *
184 * @addr: The address to base the search on
185 * @size: The bitmap size in bits
186 * @offset: The bitnumber to start searching at
187 *
188 * Unrollable variant of find_next_bit() for constant size arrays.
189 * Tail bits starting from size to roundup(size, BITS_PER_LONG) must be zero.
190 * Returns next bit offset, or size if nothing found.
191 */
192static __always_inline unsigned long
193radix_tree_find_next_bit(const unsigned long *addr,
194 unsigned long size, unsigned long offset)
195{
196 if (!__builtin_constant_p(size))
197 return find_next_bit(addr, size, offset);
198
199 if (offset < size) {
200 unsigned long tmp;
201
202 addr += offset / BITS_PER_LONG;
203 tmp = *addr >> (offset % BITS_PER_LONG);
204 if (tmp)
205 return __ffs(tmp) + offset;
206 offset = (offset + BITS_PER_LONG) & ~(BITS_PER_LONG - 1);
207 while (offset < size) {
208 tmp = *++addr;
209 if (tmp)
210 return __ffs(tmp) + offset;
211 offset += BITS_PER_LONG;
212 }
213 }
214 return size;
215}
216
Ross Zwisler0796c582016-05-20 17:02:55 -0700217#ifndef __KERNEL__
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700218static void dump_node(struct radix_tree_node *node, unsigned long index)
Matthew Wilcox7cf19af2016-03-17 14:21:57 -0700219{
Ross Zwisler0796c582016-05-20 17:02:55 -0700220 unsigned long i;
Matthew Wilcox7cf19af2016-03-17 14:21:57 -0700221
Matthew Wilcoxc12e51b2016-05-20 17:03:10 -0700222 pr_debug("radix node: %p offset %d tags %lx %lx %lx shift %d count %d parent %p\n",
Matthew Wilcox0c7fa0a2016-05-20 17:03:07 -0700223 node, node->offset,
Ross Zwisler0796c582016-05-20 17:02:55 -0700224 node->tags[0][0], node->tags[1][0], node->tags[2][0],
Matthew Wilcoxc12e51b2016-05-20 17:03:10 -0700225 node->shift, node->count, node->parent);
Matthew Wilcox7cf19af2016-03-17 14:21:57 -0700226
Ross Zwisler0796c582016-05-20 17:02:55 -0700227 for (i = 0; i < RADIX_TREE_MAP_SIZE; i++) {
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700228 unsigned long first = index | (i << node->shift);
229 unsigned long last = first | ((1UL << node->shift) - 1);
Ross Zwisler0796c582016-05-20 17:02:55 -0700230 void *entry = node->slots[i];
231 if (!entry)
232 continue;
233 if (is_sibling_entry(node, entry)) {
234 pr_debug("radix sblng %p offset %ld val %p indices %ld-%ld\n",
235 entry, i,
Matthew Wilcox4dd6c092016-05-20 17:03:27 -0700236 *(void **)entry_to_node(entry),
Ross Zwisler0796c582016-05-20 17:02:55 -0700237 first, last);
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700238 } else if (!radix_tree_is_internal_node(entry)) {
Ross Zwisler0796c582016-05-20 17:02:55 -0700239 pr_debug("radix entry %p offset %ld indices %ld-%ld\n",
240 entry, i, first, last);
241 } else {
Matthew Wilcox4dd6c092016-05-20 17:03:27 -0700242 dump_node(entry_to_node(entry), first);
Ross Zwisler0796c582016-05-20 17:02:55 -0700243 }
244 }
Matthew Wilcox7cf19af2016-03-17 14:21:57 -0700245}
246
247/* For debug */
248static void radix_tree_dump(struct radix_tree_root *root)
249{
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700250 pr_debug("radix root: %p rnode %p tags %x\n",
251 root, root->rnode,
Matthew Wilcox7cf19af2016-03-17 14:21:57 -0700252 root->gfp_mask >> __GFP_BITS_SHIFT);
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700253 if (!radix_tree_is_internal_node(root->rnode))
Matthew Wilcox7cf19af2016-03-17 14:21:57 -0700254 return;
Matthew Wilcox4dd6c092016-05-20 17:03:27 -0700255 dump_node(entry_to_node(root->rnode), 0);
Matthew Wilcox7cf19af2016-03-17 14:21:57 -0700256}
257#endif
258
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259/*
260 * This assumes that the caller has performed appropriate preallocation, and
261 * that the caller has pinned this thread of control to the current CPU.
262 */
263static struct radix_tree_node *
264radix_tree_node_alloc(struct radix_tree_root *root)
265{
Nick Piggine2848a02008-02-04 22:29:10 -0800266 struct radix_tree_node *ret = NULL;
Nick Piggin612d6c12006-06-23 02:03:22 -0700267 gfp_t gfp_mask = root_gfp_mask(root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
Jan Kara5e4c0d972013-09-11 14:26:05 -0700269 /*
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700270 * Preload code isn't irq safe and it doesn't make sense to use
271 * preloading during an interrupt anyway as all the allocations have
272 * to be atomic. So just do normal allocation when in interrupt.
Jan Kara5e4c0d972013-09-11 14:26:05 -0700273 */
Mel Gormand0164ad2015-11-06 16:28:21 -0800274 if (!gfpflags_allow_blocking(gfp_mask) && !in_interrupt()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 struct radix_tree_preload *rtp;
276
Nick Piggine2848a02008-02-04 22:29:10 -0800277 /*
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700278 * Even if the caller has preloaded, try to allocate from the
Vladimir Davydov05eb6e72016-08-02 14:03:01 -0700279 * cache first for the new node to get accounted to the memory
280 * cgroup.
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700281 */
282 ret = kmem_cache_alloc(radix_tree_node_cachep,
Vladimir Davydov05eb6e72016-08-02 14:03:01 -0700283 gfp_mask | __GFP_NOWARN);
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700284 if (ret)
285 goto out;
286
287 /*
Nick Piggine2848a02008-02-04 22:29:10 -0800288 * Provided the caller has preloaded here, we will always
289 * succeed in getting a node here (and never reach
290 * kmem_cache_alloc)
291 */
Christoph Lameter7c8e0182014-06-04 16:07:56 -0700292 rtp = this_cpu_ptr(&radix_tree_preloads);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 if (rtp->nr) {
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700294 ret = rtp->nodes;
295 rtp->nodes = ret->private_data;
296 ret->private_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 rtp->nr--;
298 }
Catalin Marinasce80b062014-06-06 14:38:18 -0700299 /*
300 * Update the allocation stack trace as this is more useful
301 * for debugging.
302 */
303 kmemleak_update_trace(ret);
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700304 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 }
Vladimir Davydov05eb6e72016-08-02 14:03:01 -0700306 ret = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700307out:
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700308 BUG_ON(radix_tree_is_internal_node(ret));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 return ret;
310}
311
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800312static void radix_tree_node_rcu_free(struct rcu_head *head)
313{
314 struct radix_tree_node *node =
315 container_of(head, struct radix_tree_node, rcu_head);
Dave Chinnerb6dd0862010-08-23 10:33:19 +1000316 int i;
Nick Piggin643b52b2008-06-12 15:21:52 -0700317
318 /*
319 * must only free zeroed nodes into the slab. radix_tree_shrink
320 * can leave us with a non-NULL entry in the first slot, so clear
321 * that here to make sure.
322 */
Dave Chinnerb6dd0862010-08-23 10:33:19 +1000323 for (i = 0; i < RADIX_TREE_MAX_TAGS; i++)
324 tag_clear(node, i, 0);
325
Nick Piggin643b52b2008-06-12 15:21:52 -0700326 node->slots[0] = NULL;
327 node->count = 0;
328
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800329 kmem_cache_free(radix_tree_node_cachep, node);
330}
331
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332static inline void
333radix_tree_node_free(struct radix_tree_node *node)
334{
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800335 call_rcu(&node->rcu_head, radix_tree_node_rcu_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336}
337
338/*
339 * Load up this CPU's radix_tree_node buffer with sufficient objects to
340 * ensure that the addition of a single element in the tree cannot fail. On
341 * success, return zero, with preemption disabled. On error, return -ENOMEM
342 * with preemption not disabled.
David Howellsb34df792009-11-19 18:11:14 +0000343 *
344 * To make use of this facility, the radix tree must be initialised without
Mel Gormand0164ad2015-11-06 16:28:21 -0800345 * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 */
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -0700347static int __radix_tree_preload(gfp_t gfp_mask, int nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348{
349 struct radix_tree_preload *rtp;
350 struct radix_tree_node *node;
351 int ret = -ENOMEM;
352
Vladimir Davydov05eb6e72016-08-02 14:03:01 -0700353 /*
354 * Nodes preloaded by one cgroup can be be used by another cgroup, so
355 * they should never be accounted to any particular memory cgroup.
356 */
357 gfp_mask &= ~__GFP_ACCOUNT;
358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 preempt_disable();
Christoph Lameter7c8e0182014-06-04 16:07:56 -0700360 rtp = this_cpu_ptr(&radix_tree_preloads);
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -0700361 while (rtp->nr < nr) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 preempt_enable();
Christoph Lameter488514d2008-04-28 02:12:05 -0700363 node = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 if (node == NULL)
365 goto out;
366 preempt_disable();
Christoph Lameter7c8e0182014-06-04 16:07:56 -0700367 rtp = this_cpu_ptr(&radix_tree_preloads);
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -0700368 if (rtp->nr < nr) {
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700369 node->private_data = rtp->nodes;
370 rtp->nodes = node;
371 rtp->nr++;
372 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 kmem_cache_free(radix_tree_node_cachep, node);
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700374 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 }
376 ret = 0;
377out:
378 return ret;
379}
Jan Kara5e4c0d972013-09-11 14:26:05 -0700380
381/*
382 * Load up this CPU's radix_tree_node buffer with sufficient objects to
383 * ensure that the addition of a single element in the tree cannot fail. On
384 * success, return zero, with preemption disabled. On error, return -ENOMEM
385 * with preemption not disabled.
386 *
387 * To make use of this facility, the radix tree must be initialised without
Mel Gormand0164ad2015-11-06 16:28:21 -0800388 * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
Jan Kara5e4c0d972013-09-11 14:26:05 -0700389 */
390int radix_tree_preload(gfp_t gfp_mask)
391{
392 /* Warn on non-sensical use... */
Mel Gormand0164ad2015-11-06 16:28:21 -0800393 WARN_ON_ONCE(!gfpflags_allow_blocking(gfp_mask));
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -0700394 return __radix_tree_preload(gfp_mask, RADIX_TREE_PRELOAD_SIZE);
Jan Kara5e4c0d972013-09-11 14:26:05 -0700395}
David Chinnerd7f09232007-07-14 16:05:04 +1000396EXPORT_SYMBOL(radix_tree_preload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397
Nick Piggin6e954b92006-01-08 01:01:40 -0800398/*
Jan Kara5e4c0d972013-09-11 14:26:05 -0700399 * The same as above function, except we don't guarantee preloading happens.
400 * We do it, if we decide it helps. On success, return zero with preemption
401 * disabled. On error, return -ENOMEM with preemption not disabled.
402 */
403int radix_tree_maybe_preload(gfp_t gfp_mask)
404{
Mel Gormand0164ad2015-11-06 16:28:21 -0800405 if (gfpflags_allow_blocking(gfp_mask))
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -0700406 return __radix_tree_preload(gfp_mask, RADIX_TREE_PRELOAD_SIZE);
Jan Kara5e4c0d972013-09-11 14:26:05 -0700407 /* Preloading doesn't help anything with this gfp mask, skip it */
408 preempt_disable();
409 return 0;
410}
411EXPORT_SYMBOL(radix_tree_maybe_preload);
412
413/*
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -0700414 * The same as function above, but preload number of nodes required to insert
415 * (1 << order) continuous naturally-aligned elements.
416 */
417int radix_tree_maybe_preload_order(gfp_t gfp_mask, int order)
418{
419 unsigned long nr_subtrees;
420 int nr_nodes, subtree_height;
421
422 /* Preloading doesn't help anything with this gfp mask, skip it */
423 if (!gfpflags_allow_blocking(gfp_mask)) {
424 preempt_disable();
425 return 0;
426 }
427
428 /*
429 * Calculate number and height of fully populated subtrees it takes to
430 * store (1 << order) elements.
431 */
432 nr_subtrees = 1 << order;
433 for (subtree_height = 0; nr_subtrees > RADIX_TREE_MAP_SIZE;
434 subtree_height++)
435 nr_subtrees >>= RADIX_TREE_MAP_SHIFT;
436
437 /*
438 * The worst case is zero height tree with a single item at index 0 and
439 * then inserting items starting at ULONG_MAX - (1 << order).
440 *
441 * This requires RADIX_TREE_MAX_PATH nodes to build branch from root to
442 * 0-index item.
443 */
444 nr_nodes = RADIX_TREE_MAX_PATH;
445
446 /* Plus branch to fully populated subtrees. */
447 nr_nodes += RADIX_TREE_MAX_PATH - subtree_height;
448
449 /* Root node is shared. */
450 nr_nodes--;
451
452 /* Plus nodes required to build subtrees. */
453 nr_nodes += nr_subtrees * height_to_maxnodes[subtree_height];
454
455 return __radix_tree_preload(gfp_mask, nr_nodes);
456}
457
458/*
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700459 * The maximum index which can be stored in a radix tree
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 */
Matthew Wilcoxc12e51b2016-05-20 17:03:10 -0700461static inline unsigned long shift_maxindex(unsigned int shift)
462{
463 return (RADIX_TREE_MAP_SIZE << shift) - 1;
464}
465
Matthew Wilcox1456a432016-05-20 17:02:08 -0700466static inline unsigned long node_maxindex(struct radix_tree_node *node)
467{
Matthew Wilcoxc12e51b2016-05-20 17:03:10 -0700468 return shift_maxindex(node->shift);
Matthew Wilcox1456a432016-05-20 17:02:08 -0700469}
470
471static unsigned radix_tree_load_root(struct radix_tree_root *root,
472 struct radix_tree_node **nodep, unsigned long *maxindex)
473{
474 struct radix_tree_node *node = rcu_dereference_raw(root->rnode);
475
476 *nodep = node;
477
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700478 if (likely(radix_tree_is_internal_node(node))) {
Matthew Wilcox4dd6c092016-05-20 17:03:27 -0700479 node = entry_to_node(node);
Matthew Wilcox1456a432016-05-20 17:02:08 -0700480 *maxindex = node_maxindex(node);
Matthew Wilcoxc12e51b2016-05-20 17:03:10 -0700481 return node->shift + RADIX_TREE_MAP_SHIFT;
Matthew Wilcox1456a432016-05-20 17:02:08 -0700482 }
483
484 *maxindex = 0;
485 return 0;
486}
487
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488/*
489 * Extend a radix tree so it can store key @index.
490 */
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700491static int radix_tree_extend(struct radix_tree_root *root,
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700492 unsigned long index, unsigned int shift)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493{
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800494 struct radix_tree_node *slot;
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700495 unsigned int maxshift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 int tag;
497
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700498 /* Figure out what the shift should be. */
499 maxshift = shift;
500 while (index > shift_maxindex(maxshift))
501 maxshift += RADIX_TREE_MAP_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700503 slot = root->rnode;
504 if (!slot)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 do {
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700508 struct radix_tree_node *node = radix_tree_node_alloc(root);
509
510 if (!node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 return -ENOMEM;
512
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 /* Propagate the aggregated tag info into the new root */
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800514 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
Nick Piggin612d6c12006-06-23 02:03:22 -0700515 if (root_tag_get(root, tag))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 tag_set(node, tag, 0);
517 }
518
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700519 BUG_ON(shift > BITS_PER_LONG);
520 node->shift = shift;
Matthew Wilcox0c7fa0a2016-05-20 17:03:07 -0700521 node->offset = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 node->count = 1;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800523 node->parent = NULL;
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700524 if (radix_tree_is_internal_node(slot))
Matthew Wilcox4dd6c092016-05-20 17:03:27 -0700525 entry_to_node(slot)->parent = node;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800526 node->slots[0] = slot;
Matthew Wilcoxa4db4dc2016-05-20 17:03:24 -0700527 slot = node_to_entry(node);
528 rcu_assign_pointer(root->rnode, slot);
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700529 shift += RADIX_TREE_MAP_SHIFT;
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700530 } while (shift <= maxshift);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531out:
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700532 return maxshift + RADIX_TREE_MAP_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533}
534
535/**
Johannes Weiner139e5612014-04-03 14:47:54 -0700536 * __radix_tree_create - create a slot in a radix tree
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 * @root: radix tree root
538 * @index: index key
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700539 * @order: index occupies 2^order aligned slots
Johannes Weiner139e5612014-04-03 14:47:54 -0700540 * @nodep: returns node
541 * @slotp: returns slot
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 *
Johannes Weiner139e5612014-04-03 14:47:54 -0700543 * Create, if necessary, and return the node and slot for an item
544 * at position @index in the radix tree @root.
545 *
546 * Until there is more than one item in the tree, no nodes are
547 * allocated and @root->rnode is used as a direct slot instead of
548 * pointing to a node, in which case *@nodep will be NULL.
549 *
550 * Returns -ENOMEM, or 0 for success.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 */
Johannes Weiner139e5612014-04-03 14:47:54 -0700552int __radix_tree_create(struct radix_tree_root *root, unsigned long index,
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700553 unsigned order, struct radix_tree_node **nodep,
554 void ***slotp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555{
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700556 struct radix_tree_node *node = NULL, *child;
557 void **slot = (void **)&root->rnode;
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700558 unsigned long maxindex;
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700559 unsigned int shift, offset = 0;
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700560 unsigned long max = index | ((1UL << order) - 1);
561
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700562 shift = radix_tree_load_root(root, &child, &maxindex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
564 /* Make sure the tree is high enough. */
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700565 if (max > maxindex) {
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700566 int error = radix_tree_extend(root, max, shift);
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700567 if (error < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 return error;
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700569 shift = error;
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700570 child = root->rnode;
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700571 if (order == shift)
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700572 shift += RADIX_TREE_MAP_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 }
574
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700575 while (shift > order) {
Matthew Wilcoxc12e51b2016-05-20 17:03:10 -0700576 shift -= RADIX_TREE_MAP_SHIFT;
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700577 if (child == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 /* Have to add a child node. */
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700579 child = radix_tree_node_alloc(root);
580 if (!child)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 return -ENOMEM;
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700582 child->shift = shift;
583 child->offset = offset;
584 child->parent = node;
585 rcu_assign_pointer(*slot, node_to_entry(child));
586 if (node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 node->count++;
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700588 } else if (!radix_tree_is_internal_node(child))
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700589 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
591 /* Go a level down */
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700592 node = entry_to_node(child);
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700593 offset = radix_tree_descend(node, &child, index);
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700594 slot = &node->slots[offset];
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700595 }
596
Matthew Wilcox57578c22016-05-20 17:01:54 -0700597#ifdef CONFIG_RADIX_TREE_MULTIORDER
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700598 /* Insert pointers to the canonical entry */
Matthew Wilcox3b8c00f2016-05-20 17:01:59 -0700599 if (order > shift) {
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700600 unsigned i, n = 1 << (order - shift);
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700601 offset = offset & ~(n - 1);
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700602 slot = &node->slots[offset];
603 child = node_to_entry(slot);
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700604 for (i = 0; i < n; i++) {
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700605 if (slot[i])
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700606 return -EEXIST;
607 }
608
609 for (i = 1; i < n; i++) {
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700610 rcu_assign_pointer(slot[i], child);
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700611 node->count++;
612 }
Nick Piggin612d6c12006-06-23 02:03:22 -0700613 }
Matthew Wilcox57578c22016-05-20 17:01:54 -0700614#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615
Johannes Weiner139e5612014-04-03 14:47:54 -0700616 if (nodep)
617 *nodep = node;
618 if (slotp)
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700619 *slotp = slot;
Johannes Weiner139e5612014-04-03 14:47:54 -0700620 return 0;
621}
622
623/**
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700624 * __radix_tree_insert - insert into a radix tree
Johannes Weiner139e5612014-04-03 14:47:54 -0700625 * @root: radix tree root
626 * @index: index key
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700627 * @order: key covers the 2^order indices around index
Johannes Weiner139e5612014-04-03 14:47:54 -0700628 * @item: item to insert
629 *
630 * Insert an item into the radix tree at position @index.
631 */
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700632int __radix_tree_insert(struct radix_tree_root *root, unsigned long index,
633 unsigned order, void *item)
Johannes Weiner139e5612014-04-03 14:47:54 -0700634{
635 struct radix_tree_node *node;
636 void **slot;
637 int error;
638
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700639 BUG_ON(radix_tree_is_internal_node(item));
Johannes Weiner139e5612014-04-03 14:47:54 -0700640
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700641 error = __radix_tree_create(root, index, order, &node, &slot);
Johannes Weiner139e5612014-04-03 14:47:54 -0700642 if (error)
643 return error;
644 if (*slot != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 return -EEXIST;
Johannes Weiner139e5612014-04-03 14:47:54 -0700646 rcu_assign_pointer(*slot, item);
Christoph Lameter201b6262005-09-06 15:16:46 -0700647
Nick Piggin612d6c12006-06-23 02:03:22 -0700648 if (node) {
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700649 unsigned offset = get_slot_offset(node, slot);
Nick Piggin612d6c12006-06-23 02:03:22 -0700650 node->count++;
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700651 BUG_ON(tag_get(node, 0, offset));
652 BUG_ON(tag_get(node, 1, offset));
653 BUG_ON(tag_get(node, 2, offset));
Nick Piggin612d6c12006-06-23 02:03:22 -0700654 } else {
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700655 BUG_ON(root_tags_get(root));
Nick Piggin612d6c12006-06-23 02:03:22 -0700656 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 return 0;
659}
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700660EXPORT_SYMBOL(__radix_tree_insert);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661
Johannes Weiner139e5612014-04-03 14:47:54 -0700662/**
663 * __radix_tree_lookup - lookup an item in a radix tree
664 * @root: radix tree root
665 * @index: index key
666 * @nodep: returns node
667 * @slotp: returns slot
668 *
669 * Lookup and return the item at position @index in the radix
670 * tree @root.
671 *
672 * Until there is more than one item in the tree, no nodes are
673 * allocated and @root->rnode is used as a direct slot instead of
674 * pointing to a node, in which case *@nodep will be NULL.
Hans Reisera4331362005-11-07 00:59:29 -0800675 */
Johannes Weiner139e5612014-04-03 14:47:54 -0700676void *__radix_tree_lookup(struct radix_tree_root *root, unsigned long index,
677 struct radix_tree_node **nodep, void ***slotp)
Hans Reisera4331362005-11-07 00:59:29 -0800678{
Johannes Weiner139e5612014-04-03 14:47:54 -0700679 struct radix_tree_node *node, *parent;
Matthew Wilcox85829952016-05-20 17:02:20 -0700680 unsigned long maxindex;
Johannes Weiner139e5612014-04-03 14:47:54 -0700681 void **slot;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800682
Matthew Wilcox85829952016-05-20 17:02:20 -0700683 restart:
684 parent = NULL;
685 slot = (void **)&root->rnode;
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700686 radix_tree_load_root(root, &node, &maxindex);
Matthew Wilcox85829952016-05-20 17:02:20 -0700687 if (index > maxindex)
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800688 return NULL;
689
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700690 while (radix_tree_is_internal_node(node)) {
Matthew Wilcox85829952016-05-20 17:02:20 -0700691 unsigned offset;
Johannes Weiner139e5612014-04-03 14:47:54 -0700692
Matthew Wilcox85829952016-05-20 17:02:20 -0700693 if (node == RADIX_TREE_RETRY)
694 goto restart;
Matthew Wilcox4dd6c092016-05-20 17:03:27 -0700695 parent = entry_to_node(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700696 offset = radix_tree_descend(parent, &node, index);
Matthew Wilcox85829952016-05-20 17:02:20 -0700697 slot = parent->slots + offset;
698 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800699
Johannes Weiner139e5612014-04-03 14:47:54 -0700700 if (nodep)
701 *nodep = parent;
702 if (slotp)
703 *slotp = slot;
704 return node;
Huang Shijieb72b71c2009-06-16 15:33:42 -0700705}
706
707/**
708 * radix_tree_lookup_slot - lookup a slot in a radix tree
709 * @root: radix tree root
710 * @index: index key
711 *
712 * Returns: the slot corresponding to the position @index in the
713 * radix tree @root. This is useful for update-if-exists operations.
714 *
715 * This function can be called under rcu_read_lock iff the slot is not
716 * modified by radix_tree_replace_slot, otherwise it must be called
717 * exclusive from other writers. Any dereference of the slot must be done
718 * using radix_tree_deref_slot.
719 */
720void **radix_tree_lookup_slot(struct radix_tree_root *root, unsigned long index)
721{
Johannes Weiner139e5612014-04-03 14:47:54 -0700722 void **slot;
723
724 if (!__radix_tree_lookup(root, index, NULL, &slot))
725 return NULL;
726 return slot;
Hans Reisera4331362005-11-07 00:59:29 -0800727}
728EXPORT_SYMBOL(radix_tree_lookup_slot);
729
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730/**
731 * radix_tree_lookup - perform lookup operation on a radix tree
732 * @root: radix tree root
733 * @index: index key
734 *
735 * Lookup the item at the position @index in the radix tree @root.
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800736 *
737 * This function can be called under rcu_read_lock, however the caller
738 * must manage lifetimes of leaf nodes (eg. RCU may also be used to free
739 * them safely). No RCU barriers are required to access or modify the
740 * returned item, however.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 */
742void *radix_tree_lookup(struct radix_tree_root *root, unsigned long index)
743{
Johannes Weiner139e5612014-04-03 14:47:54 -0700744 return __radix_tree_lookup(root, index, NULL, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745}
746EXPORT_SYMBOL(radix_tree_lookup);
747
748/**
749 * radix_tree_tag_set - set a tag on a radix tree node
750 * @root: radix tree root
751 * @index: index key
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700752 * @tag: tag index
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 *
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800754 * Set the search tag (which must be < RADIX_TREE_MAX_TAGS)
755 * corresponding to @index in the radix tree. From
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 * the root all the way down to the leaf node.
757 *
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700758 * Returns the address of the tagged item. Setting a tag on a not-present
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 * item is a bug.
760 */
761void *radix_tree_tag_set(struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800762 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763{
Ross Zwislerfb969902016-05-20 17:02:32 -0700764 struct radix_tree_node *node, *parent;
765 unsigned long maxindex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700767 radix_tree_load_root(root, &node, &maxindex);
Ross Zwislerfb969902016-05-20 17:02:32 -0700768 BUG_ON(index > maxindex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700770 while (radix_tree_is_internal_node(node)) {
Ross Zwislerfb969902016-05-20 17:02:32 -0700771 unsigned offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
Matthew Wilcox4dd6c092016-05-20 17:03:27 -0700773 parent = entry_to_node(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700774 offset = radix_tree_descend(parent, &node, index);
Ross Zwislerfb969902016-05-20 17:02:32 -0700775 BUG_ON(!node);
776
777 if (!tag_get(parent, tag, offset))
778 tag_set(parent, tag, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 }
780
Nick Piggin612d6c12006-06-23 02:03:22 -0700781 /* set the root's tag bit */
Ross Zwislerfb969902016-05-20 17:02:32 -0700782 if (!root_tag_get(root, tag))
Nick Piggin612d6c12006-06-23 02:03:22 -0700783 root_tag_set(root, tag);
784
Ross Zwislerfb969902016-05-20 17:02:32 -0700785 return node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786}
787EXPORT_SYMBOL(radix_tree_tag_set);
788
Matthew Wilcoxd604c322016-05-20 17:03:45 -0700789static void node_tag_clear(struct radix_tree_root *root,
790 struct radix_tree_node *node,
791 unsigned int tag, unsigned int offset)
792{
793 while (node) {
794 if (!tag_get(node, tag, offset))
795 return;
796 tag_clear(node, tag, offset);
797 if (any_tag_set(node, tag))
798 return;
799
800 offset = node->offset;
801 node = node->parent;
802 }
803
804 /* clear the root's tag bit */
805 if (root_tag_get(root, tag))
806 root_tag_clear(root, tag);
807}
808
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809/**
810 * radix_tree_tag_clear - clear a tag on a radix tree node
811 * @root: radix tree root
812 * @index: index key
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700813 * @tag: tag index
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 *
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800815 * Clear the search tag (which must be < RADIX_TREE_MAX_TAGS)
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700816 * corresponding to @index in the radix tree. If this causes
817 * the leaf node to have no tags set then clear the tag in the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 * next-to-leaf node, etc.
819 *
820 * Returns the address of the tagged item on success, else NULL. ie:
821 * has the same return value and semantics as radix_tree_lookup().
822 */
823void *radix_tree_tag_clear(struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800824 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825{
Ross Zwisler00f47b52016-05-20 17:02:35 -0700826 struct radix_tree_node *node, *parent;
827 unsigned long maxindex;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800828 int uninitialized_var(offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700830 radix_tree_load_root(root, &node, &maxindex);
Ross Zwisler00f47b52016-05-20 17:02:35 -0700831 if (index > maxindex)
832 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833
Ross Zwisler00f47b52016-05-20 17:02:35 -0700834 parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700836 while (radix_tree_is_internal_node(node)) {
Matthew Wilcox4dd6c092016-05-20 17:03:27 -0700837 parent = entry_to_node(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700838 offset = radix_tree_descend(parent, &node, index);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 }
840
Matthew Wilcoxd604c322016-05-20 17:03:45 -0700841 if (node)
842 node_tag_clear(root, parent, tag, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843
Ross Zwisler00f47b52016-05-20 17:02:35 -0700844 return node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845}
846EXPORT_SYMBOL(radix_tree_tag_clear);
847
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848/**
Marcelo Tosatti32605a12005-09-06 15:16:48 -0700849 * radix_tree_tag_get - get a tag on a radix tree node
850 * @root: radix tree root
851 * @index: index key
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700852 * @tag: tag index (< RADIX_TREE_MAX_TAGS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 *
Marcelo Tosatti32605a12005-09-06 15:16:48 -0700854 * Return values:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 *
Nick Piggin612d6c12006-06-23 02:03:22 -0700856 * 0: tag not present or not set
857 * 1: tag set
David Howellsce826532010-04-06 22:36:20 +0100858 *
859 * Note that the return value of this function may not be relied on, even if
860 * the RCU lock is held, unless tag modification and node deletion are excluded
861 * from concurrency.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 */
863int radix_tree_tag_get(struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800864 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865{
Ross Zwisler4589ba62016-05-20 17:02:38 -0700866 struct radix_tree_node *node, *parent;
867 unsigned long maxindex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868
Nick Piggin612d6c12006-06-23 02:03:22 -0700869 if (!root_tag_get(root, tag))
870 return 0;
871
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700872 radix_tree_load_root(root, &node, &maxindex);
Ross Zwisler4589ba62016-05-20 17:02:38 -0700873 if (index > maxindex)
874 return 0;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800875 if (node == NULL)
876 return 0;
877
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700878 while (radix_tree_is_internal_node(node)) {
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700879 unsigned offset;
Ross Zwisler4589ba62016-05-20 17:02:38 -0700880
Matthew Wilcox4dd6c092016-05-20 17:03:27 -0700881 parent = entry_to_node(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700882 offset = radix_tree_descend(parent, &node, index);
Ross Zwisler4589ba62016-05-20 17:02:38 -0700883
884 if (!node)
885 return 0;
886 if (!tag_get(parent, tag, offset))
887 return 0;
888 if (node == RADIX_TREE_RETRY)
889 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 }
Ross Zwisler4589ba62016-05-20 17:02:38 -0700891
892 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893}
894EXPORT_SYMBOL(radix_tree_tag_get);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895
Ross Zwisler21ef5332016-05-20 17:02:26 -0700896static inline void __set_iter_shift(struct radix_tree_iter *iter,
897 unsigned int shift)
898{
899#ifdef CONFIG_RADIX_TREE_MULTIORDER
900 iter->shift = shift;
901#endif
902}
903
Fengguang Wu6df8ba42007-10-16 01:24:33 -0700904/**
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700905 * radix_tree_next_chunk - find next chunk of slots for iteration
906 *
907 * @root: radix tree root
908 * @iter: iterator state
909 * @flags: RADIX_TREE_ITER_* flags and tag index
910 * Returns: pointer to chunk first slot, or NULL if iteration is over
911 */
912void **radix_tree_next_chunk(struct radix_tree_root *root,
913 struct radix_tree_iter *iter, unsigned flags)
914{
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700915 unsigned tag = flags & RADIX_TREE_ITER_TAG_MASK;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -0700916 struct radix_tree_node *node, *child;
Ross Zwisler21ef5332016-05-20 17:02:26 -0700917 unsigned long index, offset, maxindex;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700918
919 if ((flags & RADIX_TREE_ITER_TAGGED) && !root_tag_get(root, tag))
920 return NULL;
921
922 /*
923 * Catch next_index overflow after ~0UL. iter->index never overflows
924 * during iterating; it can be zero only at the beginning.
925 * And we cannot overflow iter->next_index in a single step,
926 * because RADIX_TREE_MAP_SHIFT < BITS_PER_LONG.
Konstantin Khlebnikovfffaee32012-06-05 21:36:33 +0400927 *
928 * This condition also used by radix_tree_next_slot() to stop
929 * contiguous iterating, and forbid swithing to the next chunk.
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700930 */
931 index = iter->next_index;
932 if (!index && iter->index)
933 return NULL;
934
Ross Zwisler21ef5332016-05-20 17:02:26 -0700935 restart:
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700936 radix_tree_load_root(root, &child, &maxindex);
Ross Zwisler21ef5332016-05-20 17:02:26 -0700937 if (index > maxindex)
938 return NULL;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -0700939 if (!child)
940 return NULL;
Ross Zwisler21ef5332016-05-20 17:02:26 -0700941
Matthew Wilcox8c1244d2016-05-20 17:03:36 -0700942 if (!radix_tree_is_internal_node(child)) {
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700943 /* Single-slot tree */
Ross Zwisler21ef5332016-05-20 17:02:26 -0700944 iter->index = index;
945 iter->next_index = maxindex + 1;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700946 iter->tags = 1;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -0700947 __set_iter_shift(iter, 0);
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700948 return (void **)&root->rnode;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -0700949 }
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700950
Matthew Wilcox8c1244d2016-05-20 17:03:36 -0700951 do {
952 node = entry_to_node(child);
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700953 offset = radix_tree_descend(node, &child, index);
Ross Zwisler21ef5332016-05-20 17:02:26 -0700954
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700955 if ((flags & RADIX_TREE_ITER_TAGGED) ?
Matthew Wilcox8c1244d2016-05-20 17:03:36 -0700956 !tag_get(node, tag, offset) : !child) {
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700957 /* Hole detected */
958 if (flags & RADIX_TREE_ITER_CONTIG)
959 return NULL;
960
961 if (flags & RADIX_TREE_ITER_TAGGED)
962 offset = radix_tree_find_next_bit(
963 node->tags[tag],
964 RADIX_TREE_MAP_SIZE,
965 offset + 1);
966 else
967 while (++offset < RADIX_TREE_MAP_SIZE) {
Ross Zwisler21ef5332016-05-20 17:02:26 -0700968 void *slot = node->slots[offset];
969 if (is_sibling_entry(node, slot))
970 continue;
971 if (slot)
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700972 break;
973 }
Matthew Wilcox8c1244d2016-05-20 17:03:36 -0700974 index &= ~node_maxindex(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700975 index += offset << node->shift;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700976 /* Overflow after ~0UL */
977 if (!index)
978 return NULL;
979 if (offset == RADIX_TREE_MAP_SIZE)
980 goto restart;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -0700981 child = rcu_dereference_raw(node->slots[offset]);
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700982 }
983
Matthew Wilcox8c1244d2016-05-20 17:03:36 -0700984 if ((child == NULL) || (child == RADIX_TREE_RETRY))
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700985 goto restart;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -0700986 } while (radix_tree_is_internal_node(child));
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700987
988 /* Update the iterator state */
Matthew Wilcox8c1244d2016-05-20 17:03:36 -0700989 iter->index = (index &~ node_maxindex(node)) | (offset << node->shift);
990 iter->next_index = (index | node_maxindex(node)) + 1;
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700991 __set_iter_shift(iter, node->shift);
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700992
993 /* Construct iter->tags bit-mask from node->tags[tag] array */
994 if (flags & RADIX_TREE_ITER_TAGGED) {
995 unsigned tag_long, tag_bit;
996
997 tag_long = offset / BITS_PER_LONG;
998 tag_bit = offset % BITS_PER_LONG;
999 iter->tags = node->tags[tag][tag_long] >> tag_bit;
1000 /* This never happens if RADIX_TREE_TAG_LONGS == 1 */
1001 if (tag_long < RADIX_TREE_TAG_LONGS - 1) {
1002 /* Pick tags from next element */
1003 if (tag_bit)
1004 iter->tags |= node->tags[tag][tag_long + 1] <<
1005 (BITS_PER_LONG - tag_bit);
1006 /* Clip chunk size, here only BITS_PER_LONG tags */
1007 iter->next_index = index + BITS_PER_LONG;
1008 }
1009 }
1010
1011 return node->slots + offset;
1012}
1013EXPORT_SYMBOL(radix_tree_next_chunk);
1014
1015/**
Jan Karaebf8aa42010-08-09 17:19:11 -07001016 * radix_tree_range_tag_if_tagged - for each item in given range set given
1017 * tag if item has another tag set
1018 * @root: radix tree root
1019 * @first_indexp: pointer to a starting index of a range to scan
1020 * @last_index: last index of a range to scan
1021 * @nr_to_tag: maximum number items to tag
1022 * @iftag: tag index to test
1023 * @settag: tag index to set if tested tag is set
1024 *
1025 * This function scans range of radix tree from first_index to last_index
1026 * (inclusive). For each item in the range if iftag is set, the function sets
1027 * also settag. The function stops either after tagging nr_to_tag items or
1028 * after reaching last_index.
1029 *
Dave Chinner144dcfc2010-08-23 10:33:53 +10001030 * The tags must be set from the leaf level only and propagated back up the
1031 * path to the root. We must do this so that we resolve the full path before
1032 * setting any tags on intermediate nodes. If we set tags as we descend, then
1033 * we can get to the leaf node and find that the index that has the iftag
1034 * set is outside the range we are scanning. This reults in dangling tags and
1035 * can lead to problems with later tag operations (e.g. livelocks on lookups).
1036 *
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001037 * The function returns the number of leaves where the tag was set and sets
Jan Karaebf8aa42010-08-09 17:19:11 -07001038 * *first_indexp to the first unscanned index.
Jan Karad5ed3a42010-08-19 14:13:33 -07001039 * WARNING! *first_indexp can wrap if last_index is ULONG_MAX. Caller must
1040 * be prepared to handle that.
Jan Karaebf8aa42010-08-09 17:19:11 -07001041 */
1042unsigned long radix_tree_range_tag_if_tagged(struct radix_tree_root *root,
1043 unsigned long *first_indexp, unsigned long last_index,
1044 unsigned long nr_to_tag,
1045 unsigned int iftag, unsigned int settag)
1046{
Matthew Wilcoxa8e4da22016-05-20 17:03:39 -07001047 struct radix_tree_node *parent, *node, *child;
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001048 unsigned long maxindex;
Dave Chinner144dcfc2010-08-23 10:33:53 +10001049 unsigned long tagged = 0;
1050 unsigned long index = *first_indexp;
Jan Karaebf8aa42010-08-09 17:19:11 -07001051
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001052 radix_tree_load_root(root, &child, &maxindex);
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001053 last_index = min(last_index, maxindex);
Jan Karaebf8aa42010-08-09 17:19:11 -07001054 if (index > last_index)
1055 return 0;
1056 if (!nr_to_tag)
1057 return 0;
1058 if (!root_tag_get(root, iftag)) {
1059 *first_indexp = last_index + 1;
1060 return 0;
1061 }
Matthew Wilcoxa8e4da22016-05-20 17:03:39 -07001062 if (!radix_tree_is_internal_node(child)) {
Jan Karaebf8aa42010-08-09 17:19:11 -07001063 *first_indexp = last_index + 1;
1064 root_tag_set(root, settag);
1065 return 1;
1066 }
1067
Matthew Wilcoxa8e4da22016-05-20 17:03:39 -07001068 node = entry_to_node(child);
Jan Karaebf8aa42010-08-09 17:19:11 -07001069
1070 for (;;) {
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001071 unsigned offset = radix_tree_descend(node, &child, index);
Matthew Wilcoxa8e4da22016-05-20 17:03:39 -07001072 if (!child)
Jan Karaebf8aa42010-08-09 17:19:11 -07001073 goto next;
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001074 if (!tag_get(node, iftag, offset))
Jan Karaebf8aa42010-08-09 17:19:11 -07001075 goto next;
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001076 /* Sibling slots never have tags set on them */
Matthew Wilcoxa8e4da22016-05-20 17:03:39 -07001077 if (radix_tree_is_internal_node(child)) {
1078 node = entry_to_node(child);
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001079 continue;
Jan Karaebf8aa42010-08-09 17:19:11 -07001080 }
Dave Chinner144dcfc2010-08-23 10:33:53 +10001081
1082 /* tag the leaf */
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001083 tagged++;
1084 tag_set(node, settag, offset);
Dave Chinner144dcfc2010-08-23 10:33:53 +10001085
1086 /* walk back up the path tagging interior nodes */
Matthew Wilcoxa8e4da22016-05-20 17:03:39 -07001087 parent = node;
1088 for (;;) {
1089 offset = parent->offset;
1090 parent = parent->parent;
1091 if (!parent)
Dave Chinner144dcfc2010-08-23 10:33:53 +10001092 break;
Matthew Wilcoxa8e4da22016-05-20 17:03:39 -07001093 /* stop if we find a node with the tag already set */
1094 if (tag_get(parent, settag, offset))
1095 break;
1096 tag_set(parent, settag, offset);
Dave Chinner144dcfc2010-08-23 10:33:53 +10001097 }
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001098 next:
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001099 /* Go to next entry in node */
1100 index = ((index >> node->shift) + 1) << node->shift;
Jan Karad5ed3a42010-08-19 14:13:33 -07001101 /* Overflow can happen when last_index is ~0UL... */
1102 if (index > last_index || !index)
Jan Karaebf8aa42010-08-09 17:19:11 -07001103 break;
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001104 offset = (index >> node->shift) & RADIX_TREE_MAP_MASK;
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001105 while (offset == 0) {
Jan Karaebf8aa42010-08-09 17:19:11 -07001106 /*
1107 * We've fully scanned this node. Go up. Because
1108 * last_index is guaranteed to be in the tree, what
1109 * we do below cannot wander astray.
1110 */
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001111 node = node->parent;
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001112 offset = (index >> node->shift) & RADIX_TREE_MAP_MASK;
Jan Karaebf8aa42010-08-09 17:19:11 -07001113 }
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001114 if (is_sibling_entry(node, node->slots[offset]))
1115 goto next;
1116 if (tagged >= nr_to_tag)
1117 break;
Jan Karaebf8aa42010-08-09 17:19:11 -07001118 }
1119 /*
Toshiyuki Okajimaac15ee62011-01-25 15:07:32 -08001120 * We need not to tag the root tag if there is no tag which is set with
1121 * settag within the range from *first_indexp to last_index.
Jan Karaebf8aa42010-08-09 17:19:11 -07001122 */
Toshiyuki Okajimaac15ee62011-01-25 15:07:32 -08001123 if (tagged > 0)
1124 root_tag_set(root, settag);
Jan Karaebf8aa42010-08-09 17:19:11 -07001125 *first_indexp = index;
1126
1127 return tagged;
1128}
1129EXPORT_SYMBOL(radix_tree_range_tag_if_tagged);
1130
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131/**
1132 * radix_tree_gang_lookup - perform multiple lookup on a radix tree
1133 * @root: radix tree root
1134 * @results: where the results of the lookup are placed
1135 * @first_index: start the lookup from this key
1136 * @max_items: place up to this many items at *results
1137 *
1138 * Performs an index-ascending scan of the tree for present items. Places
1139 * them at *@results and returns the number of items which were placed at
1140 * *@results.
1141 *
1142 * The implementation is naive.
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001143 *
1144 * Like radix_tree_lookup, radix_tree_gang_lookup may be called under
1145 * rcu_read_lock. In this case, rather than the returned results being
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001146 * an atomic snapshot of the tree at a single point in time, the
1147 * semantics of an RCU protected gang lookup are as though multiple
1148 * radix_tree_lookups have been issued in individual locks, and results
1149 * stored in 'results'.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 */
1151unsigned int
1152radix_tree_gang_lookup(struct radix_tree_root *root, void **results,
1153 unsigned long first_index, unsigned int max_items)
1154{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001155 struct radix_tree_iter iter;
1156 void **slot;
1157 unsigned int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001159 if (unlikely(!max_items))
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001160 return 0;
1161
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001162 radix_tree_for_each_slot(slot, root, &iter, first_index) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001163 results[ret] = rcu_dereference_raw(*slot);
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001164 if (!results[ret])
1165 continue;
Matthew Wilcoxb194d162016-05-20 17:03:30 -07001166 if (radix_tree_is_internal_node(results[ret])) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001167 slot = radix_tree_iter_retry(&iter);
1168 continue;
1169 }
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001170 if (++ret == max_items)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001173
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 return ret;
1175}
1176EXPORT_SYMBOL(radix_tree_gang_lookup);
1177
Nick Piggin47feff22008-07-25 19:45:29 -07001178/**
1179 * radix_tree_gang_lookup_slot - perform multiple slot lookup on radix tree
1180 * @root: radix tree root
1181 * @results: where the results of the lookup are placed
Hugh Dickins63286502011-08-03 16:21:18 -07001182 * @indices: where their indices should be placed (but usually NULL)
Nick Piggin47feff22008-07-25 19:45:29 -07001183 * @first_index: start the lookup from this key
1184 * @max_items: place up to this many items at *results
1185 *
1186 * Performs an index-ascending scan of the tree for present items. Places
1187 * their slots at *@results and returns the number of items which were
1188 * placed at *@results.
1189 *
1190 * The implementation is naive.
1191 *
1192 * Like radix_tree_gang_lookup as far as RCU and locking goes. Slots must
1193 * be dereferenced with radix_tree_deref_slot, and if using only RCU
1194 * protection, radix_tree_deref_slot may fail requiring a retry.
1195 */
1196unsigned int
Hugh Dickins63286502011-08-03 16:21:18 -07001197radix_tree_gang_lookup_slot(struct radix_tree_root *root,
1198 void ***results, unsigned long *indices,
Nick Piggin47feff22008-07-25 19:45:29 -07001199 unsigned long first_index, unsigned int max_items)
1200{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001201 struct radix_tree_iter iter;
1202 void **slot;
1203 unsigned int ret = 0;
Nick Piggin47feff22008-07-25 19:45:29 -07001204
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001205 if (unlikely(!max_items))
Nick Piggin47feff22008-07-25 19:45:29 -07001206 return 0;
1207
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001208 radix_tree_for_each_slot(slot, root, &iter, first_index) {
1209 results[ret] = slot;
Hugh Dickins63286502011-08-03 16:21:18 -07001210 if (indices)
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001211 indices[ret] = iter.index;
1212 if (++ret == max_items)
Nick Piggin47feff22008-07-25 19:45:29 -07001213 break;
Nick Piggin47feff22008-07-25 19:45:29 -07001214 }
1215
1216 return ret;
1217}
1218EXPORT_SYMBOL(radix_tree_gang_lookup_slot);
1219
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220/**
1221 * radix_tree_gang_lookup_tag - perform multiple lookup on a radix tree
1222 * based on a tag
1223 * @root: radix tree root
1224 * @results: where the results of the lookup are placed
1225 * @first_index: start the lookup from this key
1226 * @max_items: place up to this many items at *results
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001227 * @tag: the tag index (< RADIX_TREE_MAX_TAGS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 *
1229 * Performs an index-ascending scan of the tree for present items which
1230 * have the tag indexed by @tag set. Places the items at *@results and
1231 * returns the number of items which were placed at *@results.
1232 */
1233unsigned int
1234radix_tree_gang_lookup_tag(struct radix_tree_root *root, void **results,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001235 unsigned long first_index, unsigned int max_items,
1236 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001238 struct radix_tree_iter iter;
1239 void **slot;
1240 unsigned int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001242 if (unlikely(!max_items))
Nick Piggin612d6c12006-06-23 02:03:22 -07001243 return 0;
1244
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001245 radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001246 results[ret] = rcu_dereference_raw(*slot);
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001247 if (!results[ret])
1248 continue;
Matthew Wilcoxb194d162016-05-20 17:03:30 -07001249 if (radix_tree_is_internal_node(results[ret])) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001250 slot = radix_tree_iter_retry(&iter);
1251 continue;
1252 }
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001253 if (++ret == max_items)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001256
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 return ret;
1258}
1259EXPORT_SYMBOL(radix_tree_gang_lookup_tag);
1260
1261/**
Nick Piggin47feff22008-07-25 19:45:29 -07001262 * radix_tree_gang_lookup_tag_slot - perform multiple slot lookup on a
1263 * radix tree based on a tag
1264 * @root: radix tree root
1265 * @results: where the results of the lookup are placed
1266 * @first_index: start the lookup from this key
1267 * @max_items: place up to this many items at *results
1268 * @tag: the tag index (< RADIX_TREE_MAX_TAGS)
1269 *
1270 * Performs an index-ascending scan of the tree for present items which
1271 * have the tag indexed by @tag set. Places the slots at *@results and
1272 * returns the number of slots which were placed at *@results.
1273 */
1274unsigned int
1275radix_tree_gang_lookup_tag_slot(struct radix_tree_root *root, void ***results,
1276 unsigned long first_index, unsigned int max_items,
1277 unsigned int tag)
1278{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001279 struct radix_tree_iter iter;
1280 void **slot;
1281 unsigned int ret = 0;
Nick Piggin47feff22008-07-25 19:45:29 -07001282
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001283 if (unlikely(!max_items))
Nick Piggin47feff22008-07-25 19:45:29 -07001284 return 0;
1285
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001286 radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
1287 results[ret] = slot;
1288 if (++ret == max_items)
Nick Piggin47feff22008-07-25 19:45:29 -07001289 break;
Nick Piggin47feff22008-07-25 19:45:29 -07001290 }
1291
1292 return ret;
1293}
1294EXPORT_SYMBOL(radix_tree_gang_lookup_tag_slot);
1295
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001296#if defined(CONFIG_SHMEM) && defined(CONFIG_SWAP)
1297#include <linux/sched.h> /* for cond_resched() */
1298
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001299struct locate_info {
1300 unsigned long found_index;
1301 bool stop;
1302};
1303
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001304/*
1305 * This linear search is at present only useful to shmem_unuse_inode().
1306 */
1307static unsigned long __locate(struct radix_tree_node *slot, void *item,
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001308 unsigned long index, struct locate_info *info)
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001309{
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001310 unsigned long i;
1311
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001312 do {
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001313 unsigned int shift = slot->shift;
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001314
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001315 for (i = (index >> shift) & RADIX_TREE_MAP_MASK;
1316 i < RADIX_TREE_MAP_SIZE;
1317 i++, index += (1UL << shift)) {
1318 struct radix_tree_node *node =
1319 rcu_dereference_raw(slot->slots[i]);
1320 if (node == RADIX_TREE_RETRY)
1321 goto out;
Matthew Wilcoxb194d162016-05-20 17:03:30 -07001322 if (!radix_tree_is_internal_node(node)) {
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001323 if (node == item) {
1324 info->found_index = index;
1325 info->stop = true;
1326 goto out;
1327 }
1328 continue;
1329 }
Matthew Wilcox4dd6c092016-05-20 17:03:27 -07001330 node = entry_to_node(node);
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001331 if (is_sibling_entry(slot, node))
1332 continue;
1333 slot = node;
1334 break;
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001335 }
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001336 } while (i < RADIX_TREE_MAP_SIZE);
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001337
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001338out:
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001339 if ((index == 0) && (i == RADIX_TREE_MAP_SIZE))
1340 info->stop = true;
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001341 return index;
1342}
1343
1344/**
1345 * radix_tree_locate_item - search through radix tree for item
1346 * @root: radix tree root
1347 * @item: item to be found
1348 *
1349 * Returns index where item was found, or -1 if not found.
1350 * Caller must hold no lock (since this time-consuming function needs
1351 * to be preemptible), and must check afterwards if item is still there.
1352 */
1353unsigned long radix_tree_locate_item(struct radix_tree_root *root, void *item)
1354{
1355 struct radix_tree_node *node;
1356 unsigned long max_index;
1357 unsigned long cur_index = 0;
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001358 struct locate_info info = {
1359 .found_index = -1,
1360 .stop = false,
1361 };
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001362
1363 do {
1364 rcu_read_lock();
1365 node = rcu_dereference_raw(root->rnode);
Matthew Wilcoxb194d162016-05-20 17:03:30 -07001366 if (!radix_tree_is_internal_node(node)) {
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001367 rcu_read_unlock();
1368 if (node == item)
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001369 info.found_index = 0;
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001370 break;
1371 }
1372
Matthew Wilcox4dd6c092016-05-20 17:03:27 -07001373 node = entry_to_node(node);
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001374
1375 max_index = node_maxindex(node);
Hugh Dickins5f30fc92014-03-03 15:38:23 -08001376 if (cur_index > max_index) {
1377 rcu_read_unlock();
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001378 break;
Hugh Dickins5f30fc92014-03-03 15:38:23 -08001379 }
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001380
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001381 cur_index = __locate(node, item, cur_index, &info);
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001382 rcu_read_unlock();
1383 cond_resched();
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001384 } while (!info.stop && cur_index <= max_index);
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001385
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001386 return info.found_index;
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001387}
1388#else
1389unsigned long radix_tree_locate_item(struct radix_tree_root *root, void *item)
1390{
1391 return -1;
1392}
1393#endif /* CONFIG_SHMEM && CONFIG_SWAP */
Nick Piggin47feff22008-07-25 19:45:29 -07001394
1395/**
Matthew Wilcoxd0891262016-05-20 17:03:19 -07001396 * radix_tree_shrink - shrink radix tree to minimum height
Nick Piggina5f51c92006-01-08 01:01:41 -08001397 * @root radix tree root
1398 */
Matthew Wilcoxfb209012016-05-20 17:03:13 -07001399static inline bool radix_tree_shrink(struct radix_tree_root *root)
Nick Piggina5f51c92006-01-08 01:01:41 -08001400{
Matthew Wilcoxfb209012016-05-20 17:03:13 -07001401 bool shrunk = false;
1402
Matthew Wilcoxd0891262016-05-20 17:03:19 -07001403 for (;;) {
Matthew Wilcoxaf49a632016-05-20 17:03:33 -07001404 struct radix_tree_node *node = root->rnode;
1405 struct radix_tree_node *child;
Nick Piggina5f51c92006-01-08 01:01:41 -08001406
Matthew Wilcoxaf49a632016-05-20 17:03:33 -07001407 if (!radix_tree_is_internal_node(node))
Matthew Wilcoxd0891262016-05-20 17:03:19 -07001408 break;
Matthew Wilcoxaf49a632016-05-20 17:03:33 -07001409 node = entry_to_node(node);
Nick Pigginc0bc9872007-10-16 01:24:42 -07001410
1411 /*
1412 * The candidate node has more than one child, or its child
Matthew Wilcoxd0891262016-05-20 17:03:19 -07001413 * is not at the leftmost slot, or the child is a multiorder
1414 * entry, we cannot shrink.
Nick Pigginc0bc9872007-10-16 01:24:42 -07001415 */
Matthew Wilcoxaf49a632016-05-20 17:03:33 -07001416 if (node->count != 1)
Nick Pigginc0bc9872007-10-16 01:24:42 -07001417 break;
Matthew Wilcoxaf49a632016-05-20 17:03:33 -07001418 child = node->slots[0];
1419 if (!child)
Nick Pigginc0bc9872007-10-16 01:24:42 -07001420 break;
Matthew Wilcoxaf49a632016-05-20 17:03:33 -07001421 if (!radix_tree_is_internal_node(child) && node->shift)
Matthew Wilcoxafe0e392016-05-20 17:02:17 -07001422 break;
1423
Matthew Wilcoxaf49a632016-05-20 17:03:33 -07001424 if (radix_tree_is_internal_node(child))
1425 entry_to_node(child)->parent = NULL;
Nick Pigginc0bc9872007-10-16 01:24:42 -07001426
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001427 /*
1428 * We don't need rcu_assign_pointer(), since we are simply
Nick Piggin27d20fd2010-11-11 14:05:19 -08001429 * moving the node from one part of the tree to another: if it
1430 * was safe to dereference the old pointer to it
Matthew Wilcoxaf49a632016-05-20 17:03:33 -07001431 * (node->slots[0]), it will be safe to dereference the new
Nick Piggin27d20fd2010-11-11 14:05:19 -08001432 * one (root->rnode) as far as dependent read barriers go.
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001433 */
Matthew Wilcoxaf49a632016-05-20 17:03:33 -07001434 root->rnode = child;
Nick Piggin27d20fd2010-11-11 14:05:19 -08001435
1436 /*
1437 * We have a dilemma here. The node's slot[0] must not be
1438 * NULLed in case there are concurrent lookups expecting to
1439 * find the item. However if this was a bottom-level node,
1440 * then it may be subject to the slot pointer being visible
1441 * to callers dereferencing it. If item corresponding to
1442 * slot[0] is subsequently deleted, these callers would expect
1443 * their slot to become empty sooner or later.
1444 *
1445 * For example, lockless pagecache will look up a slot, deref
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001446 * the page pointer, and if the page has 0 refcount it means it
Nick Piggin27d20fd2010-11-11 14:05:19 -08001447 * was concurrently deleted from pagecache so try the deref
1448 * again. Fortunately there is already a requirement for logic
1449 * to retry the entire slot lookup -- the indirect pointer
1450 * problem (replacing direct root node with an indirect pointer
1451 * also results in a stale slot). So tag the slot as indirect
1452 * to force callers to retry.
1453 */
Matthew Wilcoxaf49a632016-05-20 17:03:33 -07001454 if (!radix_tree_is_internal_node(child))
1455 node->slots[0] = RADIX_TREE_RETRY;
Nick Piggin27d20fd2010-11-11 14:05:19 -08001456
Matthew Wilcoxaf49a632016-05-20 17:03:33 -07001457 radix_tree_node_free(node);
Matthew Wilcoxfb209012016-05-20 17:03:13 -07001458 shrunk = true;
Nick Piggina5f51c92006-01-08 01:01:41 -08001459 }
Matthew Wilcoxfb209012016-05-20 17:03:13 -07001460
1461 return shrunk;
Nick Piggina5f51c92006-01-08 01:01:41 -08001462}
1463
1464/**
Johannes Weiner139e5612014-04-03 14:47:54 -07001465 * __radix_tree_delete_node - try to free node after clearing a slot
1466 * @root: radix tree root
Johannes Weiner139e5612014-04-03 14:47:54 -07001467 * @node: node containing @index
1468 *
1469 * After clearing the slot at @index in @node from radix tree
1470 * rooted at @root, call this function to attempt freeing the
1471 * node and shrinking the tree.
1472 *
1473 * Returns %true if @node was freed, %false otherwise.
1474 */
Johannes Weiner449dd692014-04-03 14:47:56 -07001475bool __radix_tree_delete_node(struct radix_tree_root *root,
Johannes Weiner139e5612014-04-03 14:47:54 -07001476 struct radix_tree_node *node)
1477{
1478 bool deleted = false;
1479
1480 do {
1481 struct radix_tree_node *parent;
1482
1483 if (node->count) {
Matthew Wilcox4dd6c092016-05-20 17:03:27 -07001484 if (node == entry_to_node(root->rnode))
Matthew Wilcoxfb209012016-05-20 17:03:13 -07001485 deleted |= radix_tree_shrink(root);
Johannes Weiner139e5612014-04-03 14:47:54 -07001486 return deleted;
1487 }
1488
1489 parent = node->parent;
1490 if (parent) {
Matthew Wilcox0c7fa0a2016-05-20 17:03:07 -07001491 parent->slots[node->offset] = NULL;
Johannes Weiner139e5612014-04-03 14:47:54 -07001492 parent->count--;
1493 } else {
1494 root_tag_clear_all(root);
Johannes Weiner139e5612014-04-03 14:47:54 -07001495 root->rnode = NULL;
1496 }
1497
1498 radix_tree_node_free(node);
1499 deleted = true;
1500
1501 node = parent;
1502 } while (node);
1503
1504 return deleted;
1505}
1506
Matthew Wilcox57578c22016-05-20 17:01:54 -07001507static inline void delete_sibling_entries(struct radix_tree_node *node,
1508 void *ptr, unsigned offset)
1509{
1510#ifdef CONFIG_RADIX_TREE_MULTIORDER
1511 int i;
1512 for (i = 1; offset + i < RADIX_TREE_MAP_SIZE; i++) {
1513 if (node->slots[offset + i] != ptr)
1514 break;
1515 node->slots[offset + i] = NULL;
1516 node->count--;
1517 }
1518#endif
1519}
1520
Johannes Weiner139e5612014-04-03 14:47:54 -07001521/**
Johannes Weiner53c59f22014-04-03 14:47:39 -07001522 * radix_tree_delete_item - delete an item from a radix tree
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523 * @root: radix tree root
1524 * @index: index key
Johannes Weiner53c59f22014-04-03 14:47:39 -07001525 * @item: expected item
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526 *
Johannes Weiner53c59f22014-04-03 14:47:39 -07001527 * Remove @item at @index from the radix tree rooted at @root.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 *
Johannes Weiner53c59f22014-04-03 14:47:39 -07001529 * Returns the address of the deleted item, or NULL if it was not present
1530 * or the entry at the given @index was not @item.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531 */
Johannes Weiner53c59f22014-04-03 14:47:39 -07001532void *radix_tree_delete_item(struct radix_tree_root *root,
1533 unsigned long index, void *item)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534{
Johannes Weiner139e5612014-04-03 14:47:54 -07001535 struct radix_tree_node *node;
Matthew Wilcox57578c22016-05-20 17:01:54 -07001536 unsigned int offset;
Johannes Weiner139e5612014-04-03 14:47:54 -07001537 void **slot;
1538 void *entry;
Nick Piggind5274262006-01-08 01:01:41 -08001539 int tag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540
Johannes Weiner139e5612014-04-03 14:47:54 -07001541 entry = __radix_tree_lookup(root, index, &node, &slot);
1542 if (!entry)
1543 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544
Johannes Weiner139e5612014-04-03 14:47:54 -07001545 if (item && entry != item)
1546 return NULL;
1547
1548 if (!node) {
Nick Piggin612d6c12006-06-23 02:03:22 -07001549 root_tag_clear_all(root);
1550 root->rnode = NULL;
Johannes Weiner139e5612014-04-03 14:47:54 -07001551 return entry;
Nick Piggin612d6c12006-06-23 02:03:22 -07001552 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553
Matthew Wilcox29e09672016-05-20 17:02:02 -07001554 offset = get_slot_offset(node, slot);
Johannes Weiner53c59f22014-04-03 14:47:39 -07001555
Matthew Wilcoxd604c322016-05-20 17:03:45 -07001556 /* Clear all tags associated with the item to be deleted. */
1557 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++)
1558 node_tag_clear(root, node, tag, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559
Matthew Wilcoxa4db4dc2016-05-20 17:03:24 -07001560 delete_sibling_entries(node, node_to_entry(slot), offset);
Johannes Weiner139e5612014-04-03 14:47:54 -07001561 node->slots[offset] = NULL;
1562 node->count--;
Nick Piggina5f51c92006-01-08 01:01:41 -08001563
Johannes Weiner449dd692014-04-03 14:47:56 -07001564 __radix_tree_delete_node(root, node);
Christoph Lameter201b6262005-09-06 15:16:46 -07001565
Johannes Weiner139e5612014-04-03 14:47:54 -07001566 return entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567}
Johannes Weiner53c59f22014-04-03 14:47:39 -07001568EXPORT_SYMBOL(radix_tree_delete_item);
1569
1570/**
1571 * radix_tree_delete - delete an item from a radix tree
1572 * @root: radix tree root
1573 * @index: index key
1574 *
1575 * Remove the item at @index from the radix tree rooted at @root.
1576 *
1577 * Returns the address of the deleted item, or NULL if it was not present.
1578 */
1579void *radix_tree_delete(struct radix_tree_root *root, unsigned long index)
1580{
1581 return radix_tree_delete_item(root, index, NULL);
1582}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583EXPORT_SYMBOL(radix_tree_delete);
1584
Johannes Weinerd3798ae2016-10-04 22:02:08 +02001585void radix_tree_clear_tags(struct radix_tree_root *root,
1586 struct radix_tree_node *node,
1587 void **slot)
Matthew Wilcoxd604c322016-05-20 17:03:45 -07001588{
Matthew Wilcoxd604c322016-05-20 17:03:45 -07001589 if (node) {
1590 unsigned int tag, offset = get_slot_offset(node, slot);
1591 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++)
1592 node_tag_clear(root, node, tag, offset);
1593 } else {
1594 /* Clear root node tags */
1595 root->gfp_mask &= __GFP_BITS_MASK;
1596 }
Matthew Wilcoxd604c322016-05-20 17:03:45 -07001597}
1598
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599/**
1600 * radix_tree_tagged - test whether any items in the tree are tagged
1601 * @root: radix tree root
1602 * @tag: tag to test
1603 */
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001604int radix_tree_tagged(struct radix_tree_root *root, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605{
Nick Piggin612d6c12006-06-23 02:03:22 -07001606 return root_tag_get(root, tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607}
1608EXPORT_SYMBOL(radix_tree_tagged);
1609
1610static void
Johannes Weiner449dd692014-04-03 14:47:56 -07001611radix_tree_node_ctor(void *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612{
Johannes Weiner449dd692014-04-03 14:47:56 -07001613 struct radix_tree_node *node = arg;
1614
1615 memset(node, 0, sizeof(*node));
1616 INIT_LIST_HEAD(&node->private_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617}
1618
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -07001619static __init unsigned long __maxindex(unsigned int height)
1620{
1621 unsigned int width = height * RADIX_TREE_MAP_SHIFT;
1622 int shift = RADIX_TREE_INDEX_BITS - width;
1623
1624 if (shift < 0)
1625 return ~0UL;
1626 if (shift >= BITS_PER_LONG)
1627 return 0UL;
1628 return ~0UL >> shift;
1629}
1630
1631static __init void radix_tree_init_maxnodes(void)
1632{
1633 unsigned long height_to_maxindex[RADIX_TREE_MAX_PATH + 1];
1634 unsigned int i, j;
1635
1636 for (i = 0; i < ARRAY_SIZE(height_to_maxindex); i++)
1637 height_to_maxindex[i] = __maxindex(i);
1638 for (i = 0; i < ARRAY_SIZE(height_to_maxnodes); i++) {
1639 for (j = i; j > 0; j--)
1640 height_to_maxnodes[i] += height_to_maxindex[j - 1] + 1;
1641 }
1642}
1643
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644static int radix_tree_callback(struct notifier_block *nfb,
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001645 unsigned long action, void *hcpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646{
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001647 int cpu = (long)hcpu;
1648 struct radix_tree_preload *rtp;
1649 struct radix_tree_node *node;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001651 /* Free per-cpu pool of preloaded nodes */
1652 if (action == CPU_DEAD || action == CPU_DEAD_FROZEN) {
1653 rtp = &per_cpu(radix_tree_preloads, cpu);
1654 while (rtp->nr) {
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -07001655 node = rtp->nodes;
1656 rtp->nodes = node->private_data;
1657 kmem_cache_free(radix_tree_node_cachep, node);
1658 rtp->nr--;
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001659 }
1660 }
1661 return NOTIFY_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663
1664void __init radix_tree_init(void)
1665{
1666 radix_tree_node_cachep = kmem_cache_create("radix_tree_node",
1667 sizeof(struct radix_tree_node), 0,
Christoph Lameter488514d2008-04-28 02:12:05 -07001668 SLAB_PANIC | SLAB_RECLAIM_ACCOUNT,
1669 radix_tree_node_ctor);
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -07001670 radix_tree_init_maxnodes();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 hotcpu_notifier(radix_tree_callback, 0);
1672}