blob: 18c1dfbb1765487a3df6bd5792c8d6e599fed15c [file] [log] [blame]
Thomas Gleixnerde6cc652019-05-27 08:55:02 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * Copyright (C) 2001 Momchil Velikov
4 * Portions Copyright (C) 2001 Christoph Hellwig
Christoph Lametercde53532008-07-04 09:59:22 -07005 * Copyright (C) 2005 SGI, Christoph Lameter
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08006 * Copyright (C) 2006 Nick Piggin
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07007 * Copyright (C) 2012 Konstantin Khlebnikov
Matthew Wilcox6b053b82016-05-20 17:02:58 -07008 * Copyright (C) 2016 Intel, Matthew Wilcox
9 * Copyright (C) 2016 Intel, Ross Zwisler
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 */
11
Matthew Wilcox0a835c42016-12-20 10:27:56 -050012#include <linux/bitmap.h>
13#include <linux/bitops.h>
Matthew Wilcox460488c2017-11-28 15:16:24 -050014#include <linux/bug.h>
Matthew Wilcoxe157b552016-12-14 15:09:01 -080015#include <linux/cpu.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/errno.h>
Matthew Wilcox0a835c42016-12-20 10:27:56 -050017#include <linux/export.h>
18#include <linux/idr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/init.h>
20#include <linux/kernel.h>
Catalin Marinasce80b062014-06-06 14:38:18 -070021#include <linux/kmemleak.h>
Matthew Wilcox0a835c42016-12-20 10:27:56 -050022#include <linux/percpu.h>
Frederic Weisbecker92cf2112015-05-12 16:41:46 +020023#include <linux/preempt.h> /* in_interrupt() */
Matthew Wilcox0a835c42016-12-20 10:27:56 -050024#include <linux/radix-tree.h>
25#include <linux/rcupdate.h>
26#include <linux/slab.h>
27#include <linux/string.h>
Matthew Wilcox02c02bf2017-11-03 23:09:45 -040028#include <linux/xarray.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
30
Jeff Moyer26fb1582007-10-16 01:24:49 -070031/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070032 * Radix tree node cache.
33 */
Matthew Wilcox58d6ea32017-11-10 15:15:08 -050034struct kmem_cache *radix_tree_node_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
36/*
Nick Piggin55368052012-05-29 15:07:34 -070037 * The radix tree is variable-height, so an insert operation not only has
38 * to build the branch to its corresponding item, it also has to build the
39 * branch to existing items if the size has to be increased (by
40 * radix_tree_extend).
41 *
42 * The worst case is a zero height tree with just a single item at index 0,
43 * and then inserting an item at index ULONG_MAX. This requires 2 new branches
44 * of RADIX_TREE_MAX_PATH size to be created, with only the root node shared.
45 * Hence:
46 */
47#define RADIX_TREE_PRELOAD_SIZE (RADIX_TREE_MAX_PATH * 2 - 1)
48
49/*
Matthew Wilcox0a835c42016-12-20 10:27:56 -050050 * The IDR does not have to be as high as the radix tree since it uses
51 * signed integers, not unsigned longs.
52 */
53#define IDR_INDEX_BITS (8 /* CHAR_BIT */ * sizeof(int) - 1)
54#define IDR_MAX_PATH (DIV_ROUND_UP(IDR_INDEX_BITS, \
55 RADIX_TREE_MAP_SHIFT))
56#define IDR_PRELOAD_SIZE (IDR_MAX_PATH * 2 - 1)
57
58/*
Matthew Wilcox7ad3d4d2016-12-16 11:55:56 -050059 * The IDA is even shorter since it uses a bitmap at the last level.
60 */
61#define IDA_INDEX_BITS (8 * sizeof(int) - 1 - ilog2(IDA_BITMAP_BITS))
62#define IDA_MAX_PATH (DIV_ROUND_UP(IDA_INDEX_BITS, \
63 RADIX_TREE_MAP_SHIFT))
64#define IDA_PRELOAD_SIZE (IDA_MAX_PATH * 2 - 1)
65
66/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 * Per-cpu pool of preloaded nodes
68 */
69struct radix_tree_preload {
Matthew Wilcox2fcd9002016-05-20 17:03:04 -070070 unsigned nr;
Matthew Wilcox1293d5c2017-01-16 16:41:29 -050071 /* nodes->parent points to next preallocated node */
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -070072 struct radix_tree_node *nodes;
Linus Torvalds1da177e2005-04-16 15:20:36 -070073};
Harvey Harrison8cef7d52009-01-06 14:40:50 -080074static DEFINE_PER_CPU(struct radix_tree_preload, radix_tree_preloads) = { 0, };
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
Matthew Wilcox148deab2016-12-14 15:08:49 -080076static inline struct radix_tree_node *entry_to_node(void *ptr)
77{
78 return (void *)((unsigned long)ptr & ~RADIX_TREE_INTERNAL_NODE);
79}
80
Matthew Wilcoxa4db4dc2016-05-20 17:03:24 -070081static inline void *node_to_entry(void *ptr)
Nick Piggin27d20fd2010-11-11 14:05:19 -080082{
Matthew Wilcox30ff46cc2016-05-20 17:03:22 -070083 return (void *)((unsigned long)ptr | RADIX_TREE_INTERNAL_NODE);
Nick Piggin27d20fd2010-11-11 14:05:19 -080084}
85
Matthew Wilcox02c02bf2017-11-03 23:09:45 -040086#define RADIX_TREE_RETRY XA_RETRY_ENTRY
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070087
Matthew Wilcoxd7b62722017-02-13 15:58:24 -050088static inline unsigned long
89get_slot_offset(const struct radix_tree_node *parent, void __rcu **slot)
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070090{
Matthew Wilcox76f070b2018-08-18 07:05:50 -040091 return parent ? slot - parent->slots : 0;
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070092}
93
Matthew Wilcox35534c82016-12-19 17:43:19 -050094static unsigned int radix_tree_descend(const struct radix_tree_node *parent,
Matthew Wilcox9e85d812016-05-20 17:03:48 -070095 struct radix_tree_node **nodep, unsigned long index)
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070096{
Matthew Wilcox9e85d812016-05-20 17:03:48 -070097 unsigned int offset = (index >> parent->shift) & RADIX_TREE_MAP_MASK;
Matthew Wilcoxd7b62722017-02-13 15:58:24 -050098 void __rcu **entry = rcu_dereference_raw(parent->slots[offset]);
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070099
Matthew Wilcoxdb050f22016-05-20 17:01:57 -0700100 *nodep = (void *)entry;
101 return offset;
102}
103
Matthew Wilcox35534c82016-12-19 17:43:19 -0500104static inline gfp_t root_gfp_mask(const struct radix_tree_root *root)
Nick Piggin612d6c12006-06-23 02:03:22 -0700105{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500106 return root->xa_flags & (__GFP_BITS_MASK & ~GFP_ZONEMASK);
Nick Piggin612d6c12006-06-23 02:03:22 -0700107}
108
Nick Piggin643b52b2008-06-12 15:21:52 -0700109static inline void tag_set(struct radix_tree_node *node, unsigned int tag,
110 int offset)
111{
112 __set_bit(offset, node->tags[tag]);
113}
114
115static inline void tag_clear(struct radix_tree_node *node, unsigned int tag,
116 int offset)
117{
118 __clear_bit(offset, node->tags[tag]);
119}
120
Matthew Wilcox35534c82016-12-19 17:43:19 -0500121static inline int tag_get(const struct radix_tree_node *node, unsigned int tag,
Nick Piggin643b52b2008-06-12 15:21:52 -0700122 int offset)
123{
124 return test_bit(offset, node->tags[tag]);
125}
126
Matthew Wilcox35534c82016-12-19 17:43:19 -0500127static inline void root_tag_set(struct radix_tree_root *root, unsigned tag)
Nick Piggin643b52b2008-06-12 15:21:52 -0700128{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500129 root->xa_flags |= (__force gfp_t)(1 << (tag + ROOT_TAG_SHIFT));
Nick Piggin643b52b2008-06-12 15:21:52 -0700130}
131
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700132static inline void root_tag_clear(struct radix_tree_root *root, unsigned tag)
Nick Piggin643b52b2008-06-12 15:21:52 -0700133{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500134 root->xa_flags &= (__force gfp_t)~(1 << (tag + ROOT_TAG_SHIFT));
Nick Piggin643b52b2008-06-12 15:21:52 -0700135}
136
137static inline void root_tag_clear_all(struct radix_tree_root *root)
138{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500139 root->xa_flags &= (__force gfp_t)((1 << ROOT_TAG_SHIFT) - 1);
Nick Piggin643b52b2008-06-12 15:21:52 -0700140}
141
Matthew Wilcox35534c82016-12-19 17:43:19 -0500142static inline int root_tag_get(const struct radix_tree_root *root, unsigned tag)
Nick Piggin643b52b2008-06-12 15:21:52 -0700143{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500144 return (__force int)root->xa_flags & (1 << (tag + ROOT_TAG_SHIFT));
Nick Piggin643b52b2008-06-12 15:21:52 -0700145}
146
Matthew Wilcox35534c82016-12-19 17:43:19 -0500147static inline unsigned root_tags_get(const struct radix_tree_root *root)
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700148{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500149 return (__force unsigned)root->xa_flags >> ROOT_TAG_SHIFT;
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500150}
151
152static inline bool is_idr(const struct radix_tree_root *root)
153{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500154 return !!(root->xa_flags & ROOT_IS_IDR);
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700155}
156
Nick Piggin643b52b2008-06-12 15:21:52 -0700157/*
158 * Returns 1 if any slot in the node has this tag set.
159 * Otherwise returns 0.
160 */
Matthew Wilcox35534c82016-12-19 17:43:19 -0500161static inline int any_tag_set(const struct radix_tree_node *node,
162 unsigned int tag)
Nick Piggin643b52b2008-06-12 15:21:52 -0700163{
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700164 unsigned idx;
Nick Piggin643b52b2008-06-12 15:21:52 -0700165 for (idx = 0; idx < RADIX_TREE_TAG_LONGS; idx++) {
166 if (node->tags[tag][idx])
167 return 1;
168 }
169 return 0;
170}
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700171
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500172static inline void all_tag_set(struct radix_tree_node *node, unsigned int tag)
173{
174 bitmap_fill(node->tags[tag], RADIX_TREE_MAP_SIZE);
175}
176
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700177/**
178 * radix_tree_find_next_bit - find the next set bit in a memory region
179 *
180 * @addr: The address to base the search on
181 * @size: The bitmap size in bits
182 * @offset: The bitnumber to start searching at
183 *
184 * Unrollable variant of find_next_bit() for constant size arrays.
185 * Tail bits starting from size to roundup(size, BITS_PER_LONG) must be zero.
186 * Returns next bit offset, or size if nothing found.
187 */
188static __always_inline unsigned long
Matthew Wilcoxbc412fc2016-12-14 15:08:40 -0800189radix_tree_find_next_bit(struct radix_tree_node *node, unsigned int tag,
190 unsigned long offset)
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700191{
Matthew Wilcoxbc412fc2016-12-14 15:08:40 -0800192 const unsigned long *addr = node->tags[tag];
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700193
Matthew Wilcoxbc412fc2016-12-14 15:08:40 -0800194 if (offset < RADIX_TREE_MAP_SIZE) {
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700195 unsigned long tmp;
196
197 addr += offset / BITS_PER_LONG;
198 tmp = *addr >> (offset % BITS_PER_LONG);
199 if (tmp)
200 return __ffs(tmp) + offset;
201 offset = (offset + BITS_PER_LONG) & ~(BITS_PER_LONG - 1);
Matthew Wilcoxbc412fc2016-12-14 15:08:40 -0800202 while (offset < RADIX_TREE_MAP_SIZE) {
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700203 tmp = *++addr;
204 if (tmp)
205 return __ffs(tmp) + offset;
206 offset += BITS_PER_LONG;
207 }
208 }
Matthew Wilcoxbc412fc2016-12-14 15:08:40 -0800209 return RADIX_TREE_MAP_SIZE;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700210}
211
Matthew Wilcox268f42d2016-12-14 15:08:55 -0800212static unsigned int iter_offset(const struct radix_tree_iter *iter)
213{
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400214 return iter->index & RADIX_TREE_MAP_MASK;
Matthew Wilcox268f42d2016-12-14 15:08:55 -0800215}
216
Matthew Wilcox218ed752016-12-14 15:08:43 -0800217/*
218 * The maximum index which can be stored in a radix tree
219 */
220static inline unsigned long shift_maxindex(unsigned int shift)
221{
222 return (RADIX_TREE_MAP_SIZE << shift) - 1;
223}
224
Matthew Wilcox35534c82016-12-19 17:43:19 -0500225static inline unsigned long node_maxindex(const struct radix_tree_node *node)
Matthew Wilcox218ed752016-12-14 15:08:43 -0800226{
227 return shift_maxindex(node->shift);
228}
229
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500230static unsigned long next_index(unsigned long index,
231 const struct radix_tree_node *node,
232 unsigned long offset)
233{
234 return (index & ~node_maxindex(node)) + (offset << node->shift);
235}
236
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237/*
238 * This assumes that the caller has performed appropriate preallocation, and
239 * that the caller has pinned this thread of control to the current CPU.
240 */
241static struct radix_tree_node *
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500242radix_tree_node_alloc(gfp_t gfp_mask, struct radix_tree_node *parent,
Matthew Wilcoxd58275b2017-01-16 17:10:21 -0500243 struct radix_tree_root *root,
Matthew Wilcoxe8de4342016-12-14 15:09:31 -0800244 unsigned int shift, unsigned int offset,
Matthew Wilcox01959df2017-11-09 09:23:56 -0500245 unsigned int count, unsigned int nr_values)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246{
Nick Piggine2848a02008-02-04 22:29:10 -0800247 struct radix_tree_node *ret = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
Jan Kara5e4c0d972013-09-11 14:26:05 -0700249 /*
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700250 * Preload code isn't irq safe and it doesn't make sense to use
251 * preloading during an interrupt anyway as all the allocations have
252 * to be atomic. So just do normal allocation when in interrupt.
Jan Kara5e4c0d972013-09-11 14:26:05 -0700253 */
Mel Gormand0164ad2015-11-06 16:28:21 -0800254 if (!gfpflags_allow_blocking(gfp_mask) && !in_interrupt()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 struct radix_tree_preload *rtp;
256
Nick Piggine2848a02008-02-04 22:29:10 -0800257 /*
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700258 * Even if the caller has preloaded, try to allocate from the
Vladimir Davydov05eb6e72016-08-02 14:03:01 -0700259 * cache first for the new node to get accounted to the memory
260 * cgroup.
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700261 */
262 ret = kmem_cache_alloc(radix_tree_node_cachep,
Vladimir Davydov05eb6e72016-08-02 14:03:01 -0700263 gfp_mask | __GFP_NOWARN);
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700264 if (ret)
265 goto out;
266
267 /*
Nick Piggine2848a02008-02-04 22:29:10 -0800268 * Provided the caller has preloaded here, we will always
269 * succeed in getting a node here (and never reach
270 * kmem_cache_alloc)
271 */
Christoph Lameter7c8e0182014-06-04 16:07:56 -0700272 rtp = this_cpu_ptr(&radix_tree_preloads);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 if (rtp->nr) {
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700274 ret = rtp->nodes;
Matthew Wilcox1293d5c2017-01-16 16:41:29 -0500275 rtp->nodes = ret->parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 rtp->nr--;
277 }
Catalin Marinasce80b062014-06-06 14:38:18 -0700278 /*
279 * Update the allocation stack trace as this is more useful
280 * for debugging.
281 */
282 kmemleak_update_trace(ret);
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700283 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 }
Vladimir Davydov05eb6e72016-08-02 14:03:01 -0700285 ret = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700286out:
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700287 BUG_ON(radix_tree_is_internal_node(ret));
Matthew Wilcoxe8de4342016-12-14 15:09:31 -0800288 if (ret) {
Matthew Wilcoxe8de4342016-12-14 15:09:31 -0800289 ret->shift = shift;
290 ret->offset = offset;
291 ret->count = count;
Matthew Wilcox01959df2017-11-09 09:23:56 -0500292 ret->nr_values = nr_values;
Matthew Wilcoxd58275b2017-01-16 17:10:21 -0500293 ret->parent = parent;
Matthew Wilcox01959df2017-11-09 09:23:56 -0500294 ret->array = root;
Matthew Wilcoxe8de4342016-12-14 15:09:31 -0800295 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 return ret;
297}
298
Matthew Wilcox58d6ea32017-11-10 15:15:08 -0500299void radix_tree_node_rcu_free(struct rcu_head *head)
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800300{
301 struct radix_tree_node *node =
302 container_of(head, struct radix_tree_node, rcu_head);
Nick Piggin643b52b2008-06-12 15:21:52 -0700303
304 /*
Matthew Wilcox175542f2016-12-14 15:08:58 -0800305 * Must only free zeroed nodes into the slab. We can be left with
306 * non-NULL entries by radix_tree_free_nodes, so clear the entries
307 * and tags here.
Nick Piggin643b52b2008-06-12 15:21:52 -0700308 */
Matthew Wilcox175542f2016-12-14 15:08:58 -0800309 memset(node->slots, 0, sizeof(node->slots));
310 memset(node->tags, 0, sizeof(node->tags));
Matthew Wilcox91d9c052016-12-14 15:08:34 -0800311 INIT_LIST_HEAD(&node->private_list);
Nick Piggin643b52b2008-06-12 15:21:52 -0700312
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800313 kmem_cache_free(radix_tree_node_cachep, node);
314}
315
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316static inline void
317radix_tree_node_free(struct radix_tree_node *node)
318{
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800319 call_rcu(&node->rcu_head, radix_tree_node_rcu_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320}
321
322/*
323 * Load up this CPU's radix_tree_node buffer with sufficient objects to
324 * ensure that the addition of a single element in the tree cannot fail. On
325 * success, return zero, with preemption disabled. On error, return -ENOMEM
326 * with preemption not disabled.
David Howellsb34df792009-11-19 18:11:14 +0000327 *
328 * To make use of this facility, the radix tree must be initialised without
Mel Gormand0164ad2015-11-06 16:28:21 -0800329 * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 */
Eric Dumazetbc9ae222017-09-08 16:15:54 -0700331static __must_check int __radix_tree_preload(gfp_t gfp_mask, unsigned nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332{
333 struct radix_tree_preload *rtp;
334 struct radix_tree_node *node;
335 int ret = -ENOMEM;
336
Vladimir Davydov05eb6e72016-08-02 14:03:01 -0700337 /*
338 * Nodes preloaded by one cgroup can be be used by another cgroup, so
339 * they should never be accounted to any particular memory cgroup.
340 */
341 gfp_mask &= ~__GFP_ACCOUNT;
342
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 preempt_disable();
Christoph Lameter7c8e0182014-06-04 16:07:56 -0700344 rtp = this_cpu_ptr(&radix_tree_preloads);
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -0700345 while (rtp->nr < nr) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 preempt_enable();
Christoph Lameter488514d2008-04-28 02:12:05 -0700347 node = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 if (node == NULL)
349 goto out;
350 preempt_disable();
Christoph Lameter7c8e0182014-06-04 16:07:56 -0700351 rtp = this_cpu_ptr(&radix_tree_preloads);
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -0700352 if (rtp->nr < nr) {
Matthew Wilcox1293d5c2017-01-16 16:41:29 -0500353 node->parent = rtp->nodes;
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700354 rtp->nodes = node;
355 rtp->nr++;
356 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 kmem_cache_free(radix_tree_node_cachep, node);
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700358 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 }
360 ret = 0;
361out:
362 return ret;
363}
Jan Kara5e4c0d972013-09-11 14:26:05 -0700364
365/*
366 * Load up this CPU's radix_tree_node buffer with sufficient objects to
367 * ensure that the addition of a single element in the tree cannot fail. On
368 * success, return zero, with preemption disabled. On error, return -ENOMEM
369 * with preemption not disabled.
370 *
371 * To make use of this facility, the radix tree must be initialised without
Mel Gormand0164ad2015-11-06 16:28:21 -0800372 * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
Jan Kara5e4c0d972013-09-11 14:26:05 -0700373 */
374int radix_tree_preload(gfp_t gfp_mask)
375{
376 /* Warn on non-sensical use... */
Mel Gormand0164ad2015-11-06 16:28:21 -0800377 WARN_ON_ONCE(!gfpflags_allow_blocking(gfp_mask));
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -0700378 return __radix_tree_preload(gfp_mask, RADIX_TREE_PRELOAD_SIZE);
Jan Kara5e4c0d972013-09-11 14:26:05 -0700379}
David Chinnerd7f09232007-07-14 16:05:04 +1000380EXPORT_SYMBOL(radix_tree_preload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
Nick Piggin6e954b92006-01-08 01:01:40 -0800382/*
Jan Kara5e4c0d972013-09-11 14:26:05 -0700383 * The same as above function, except we don't guarantee preloading happens.
384 * We do it, if we decide it helps. On success, return zero with preemption
385 * disabled. On error, return -ENOMEM with preemption not disabled.
386 */
387int radix_tree_maybe_preload(gfp_t gfp_mask)
388{
Mel Gormand0164ad2015-11-06 16:28:21 -0800389 if (gfpflags_allow_blocking(gfp_mask))
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -0700390 return __radix_tree_preload(gfp_mask, RADIX_TREE_PRELOAD_SIZE);
Jan Kara5e4c0d972013-09-11 14:26:05 -0700391 /* Preloading doesn't help anything with this gfp mask, skip it */
392 preempt_disable();
393 return 0;
394}
395EXPORT_SYMBOL(radix_tree_maybe_preload);
396
Matthew Wilcox35534c82016-12-19 17:43:19 -0500397static unsigned radix_tree_load_root(const struct radix_tree_root *root,
Matthew Wilcox1456a432016-05-20 17:02:08 -0700398 struct radix_tree_node **nodep, unsigned long *maxindex)
399{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500400 struct radix_tree_node *node = rcu_dereference_raw(root->xa_head);
Matthew Wilcox1456a432016-05-20 17:02:08 -0700401
402 *nodep = node;
403
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700404 if (likely(radix_tree_is_internal_node(node))) {
Matthew Wilcox4dd6c092016-05-20 17:03:27 -0700405 node = entry_to_node(node);
Matthew Wilcox1456a432016-05-20 17:02:08 -0700406 *maxindex = node_maxindex(node);
Matthew Wilcoxc12e51b2016-05-20 17:03:10 -0700407 return node->shift + RADIX_TREE_MAP_SHIFT;
Matthew Wilcox1456a432016-05-20 17:02:08 -0700408 }
409
410 *maxindex = 0;
411 return 0;
412}
413
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414/*
415 * Extend a radix tree so it can store key @index.
416 */
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500417static int radix_tree_extend(struct radix_tree_root *root, gfp_t gfp,
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700418 unsigned long index, unsigned int shift)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419{
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500420 void *entry;
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700421 unsigned int maxshift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 int tag;
423
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700424 /* Figure out what the shift should be. */
425 maxshift = shift;
426 while (index > shift_maxindex(maxshift))
427 maxshift += RADIX_TREE_MAP_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500429 entry = rcu_dereference_raw(root->xa_head);
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500430 if (!entry && (!is_idr(root) || root_tag_get(root, IDR_FREE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 do {
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500434 struct radix_tree_node *node = radix_tree_node_alloc(gfp, NULL,
Matthew Wilcoxd58275b2017-01-16 17:10:21 -0500435 root, shift, 0, 1, 0);
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700436 if (!node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 return -ENOMEM;
438
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500439 if (is_idr(root)) {
440 all_tag_set(node, IDR_FREE);
441 if (!root_tag_get(root, IDR_FREE)) {
442 tag_clear(node, IDR_FREE, 0);
443 root_tag_set(root, IDR_FREE);
444 }
445 } else {
446 /* Propagate the aggregated tag info to the new child */
447 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
448 if (root_tag_get(root, tag))
449 tag_set(node, tag, 0);
450 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 }
452
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700453 BUG_ON(shift > BITS_PER_LONG);
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500454 if (radix_tree_is_internal_node(entry)) {
455 entry_to_node(entry)->parent = node;
Matthew Wilcox3159f942017-11-03 13:30:42 -0400456 } else if (xa_is_value(entry)) {
Matthew Wilcox01959df2017-11-09 09:23:56 -0500457 /* Moving a value entry root->xa_head to a node */
458 node->nr_values = 1;
Johannes Weinerf7942432016-12-12 16:43:41 -0800459 }
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500460 /*
461 * entry was already in the radix tree, so we do not need
462 * rcu_assign_pointer here
463 */
464 node->slots[0] = (void __rcu *)entry;
465 entry = node_to_entry(node);
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500466 rcu_assign_pointer(root->xa_head, entry);
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700467 shift += RADIX_TREE_MAP_SHIFT;
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700468 } while (shift <= maxshift);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469out:
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700470 return maxshift + RADIX_TREE_MAP_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471}
472
473/**
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800474 * radix_tree_shrink - shrink radix tree to minimum height
475 * @root radix tree root
476 */
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400477static inline bool radix_tree_shrink(struct radix_tree_root *root)
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800478{
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500479 bool shrunk = false;
480
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800481 for (;;) {
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500482 struct radix_tree_node *node = rcu_dereference_raw(root->xa_head);
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800483 struct radix_tree_node *child;
484
485 if (!radix_tree_is_internal_node(node))
486 break;
487 node = entry_to_node(node);
488
489 /*
490 * The candidate node has more than one child, or its child
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400491 * is not at the leftmost slot, we cannot shrink.
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800492 */
493 if (node->count != 1)
494 break;
Matthew Wilcox12320d02017-02-13 15:22:48 -0500495 child = rcu_dereference_raw(node->slots[0]);
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800496 if (!child)
497 break;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800498
Matthew Wilcox66ee6202018-06-25 06:56:50 -0400499 /*
500 * For an IDR, we must not shrink entry 0 into the root in
501 * case somebody calls idr_replace() with a pointer that
502 * appears to be an internal entry
503 */
504 if (!node->shift && is_idr(root))
505 break;
506
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800507 if (radix_tree_is_internal_node(child))
508 entry_to_node(child)->parent = NULL;
509
510 /*
511 * We don't need rcu_assign_pointer(), since we are simply
512 * moving the node from one part of the tree to another: if it
513 * was safe to dereference the old pointer to it
514 * (node->slots[0]), it will be safe to dereference the new
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500515 * one (root->xa_head) as far as dependent read barriers go.
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800516 */
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500517 root->xa_head = (void __rcu *)child;
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500518 if (is_idr(root) && !tag_get(node, IDR_FREE, 0))
519 root_tag_clear(root, IDR_FREE);
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800520
521 /*
522 * We have a dilemma here. The node's slot[0] must not be
523 * NULLed in case there are concurrent lookups expecting to
524 * find the item. However if this was a bottom-level node,
525 * then it may be subject to the slot pointer being visible
526 * to callers dereferencing it. If item corresponding to
527 * slot[0] is subsequently deleted, these callers would expect
528 * their slot to become empty sooner or later.
529 *
530 * For example, lockless pagecache will look up a slot, deref
531 * the page pointer, and if the page has 0 refcount it means it
532 * was concurrently deleted from pagecache so try the deref
533 * again. Fortunately there is already a requirement for logic
534 * to retry the entire slot lookup -- the indirect pointer
535 * problem (replacing direct root node with an indirect pointer
536 * also results in a stale slot). So tag the slot as indirect
537 * to force callers to retry.
538 */
Johannes Weiner4d693d02016-12-12 16:43:49 -0800539 node->count = 0;
540 if (!radix_tree_is_internal_node(child)) {
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500541 node->slots[0] = (void __rcu *)RADIX_TREE_RETRY;
Johannes Weiner4d693d02016-12-12 16:43:49 -0800542 }
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800543
Johannes Weinerea07b862017-01-06 19:21:43 -0500544 WARN_ON_ONCE(!list_empty(&node->private_list));
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800545 radix_tree_node_free(node);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500546 shrunk = true;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800547 }
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500548
549 return shrunk;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800550}
551
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500552static bool delete_node(struct radix_tree_root *root,
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400553 struct radix_tree_node *node)
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800554{
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500555 bool deleted = false;
556
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800557 do {
558 struct radix_tree_node *parent;
559
560 if (node->count) {
Matthew Wilcox12320d02017-02-13 15:22:48 -0500561 if (node_to_entry(node) ==
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500562 rcu_dereference_raw(root->xa_head))
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400563 deleted |= radix_tree_shrink(root);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500564 return deleted;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800565 }
566
567 parent = node->parent;
568 if (parent) {
569 parent->slots[node->offset] = NULL;
570 parent->count--;
571 } else {
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500572 /*
573 * Shouldn't the tags already have all been cleared
574 * by the caller?
575 */
576 if (!is_idr(root))
577 root_tag_clear_all(root);
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500578 root->xa_head = NULL;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800579 }
580
Johannes Weinerea07b862017-01-06 19:21:43 -0500581 WARN_ON_ONCE(!list_empty(&node->private_list));
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800582 radix_tree_node_free(node);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500583 deleted = true;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800584
585 node = parent;
586 } while (node);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500587
588 return deleted;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800589}
590
591/**
Johannes Weiner139e5612014-04-03 14:47:54 -0700592 * __radix_tree_create - create a slot in a radix tree
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 * @root: radix tree root
594 * @index: index key
Johannes Weiner139e5612014-04-03 14:47:54 -0700595 * @nodep: returns node
596 * @slotp: returns slot
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 *
Johannes Weiner139e5612014-04-03 14:47:54 -0700598 * Create, if necessary, and return the node and slot for an item
599 * at position @index in the radix tree @root.
600 *
601 * Until there is more than one item in the tree, no nodes are
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500602 * allocated and @root->xa_head is used as a direct slot instead of
Johannes Weiner139e5612014-04-03 14:47:54 -0700603 * pointing to a node, in which case *@nodep will be NULL.
604 *
605 * Returns -ENOMEM, or 0 for success.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 */
Matthew Wilcox74d60952017-11-17 10:01:45 -0500607static int __radix_tree_create(struct radix_tree_root *root,
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400608 unsigned long index, struct radix_tree_node **nodep,
609 void __rcu ***slotp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610{
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700611 struct radix_tree_node *node = NULL, *child;
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500612 void __rcu **slot = (void __rcu **)&root->xa_head;
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700613 unsigned long maxindex;
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700614 unsigned int shift, offset = 0;
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400615 unsigned long max = index;
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500616 gfp_t gfp = root_gfp_mask(root);
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700617
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700618 shift = radix_tree_load_root(root, &child, &maxindex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
620 /* Make sure the tree is high enough. */
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700621 if (max > maxindex) {
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500622 int error = radix_tree_extend(root, gfp, max, shift);
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700623 if (error < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 return error;
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700625 shift = error;
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500626 child = rcu_dereference_raw(root->xa_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 }
628
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400629 while (shift > 0) {
Matthew Wilcoxc12e51b2016-05-20 17:03:10 -0700630 shift -= RADIX_TREE_MAP_SHIFT;
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700631 if (child == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 /* Have to add a child node. */
Matthew Wilcoxd58275b2017-01-16 17:10:21 -0500633 child = radix_tree_node_alloc(gfp, node, root, shift,
Matthew Wilcoxe8de4342016-12-14 15:09:31 -0800634 offset, 0, 0);
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700635 if (!child)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 return -ENOMEM;
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700637 rcu_assign_pointer(*slot, node_to_entry(child));
638 if (node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 node->count++;
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700640 } else if (!radix_tree_is_internal_node(child))
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700641 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642
643 /* Go a level down */
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700644 node = entry_to_node(child);
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700645 offset = radix_tree_descend(node, &child, index);
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700646 slot = &node->slots[offset];
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700647 }
648
Johannes Weiner139e5612014-04-03 14:47:54 -0700649 if (nodep)
650 *nodep = node;
651 if (slotp)
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700652 *slotp = slot;
Johannes Weiner139e5612014-04-03 14:47:54 -0700653 return 0;
654}
655
Matthew Wilcox175542f2016-12-14 15:08:58 -0800656/*
657 * Free any nodes below this node. The tree is presumed to not need
658 * shrinking, and any user data in the tree is presumed to not need a
659 * destructor called on it. If we need to add a destructor, we can
660 * add that functionality later. Note that we may not clear tags or
661 * slots from the tree as an RCU walker may still have a pointer into
662 * this subtree. We could replace the entries with RADIX_TREE_RETRY,
663 * but we'll still have to clear those in rcu_free.
664 */
665static void radix_tree_free_nodes(struct radix_tree_node *node)
666{
667 unsigned offset = 0;
668 struct radix_tree_node *child = entry_to_node(node);
669
670 for (;;) {
Matthew Wilcox12320d02017-02-13 15:22:48 -0500671 void *entry = rcu_dereference_raw(child->slots[offset]);
Matthew Wilcox02c02bf2017-11-03 23:09:45 -0400672 if (xa_is_node(entry) && child->shift) {
Matthew Wilcox175542f2016-12-14 15:08:58 -0800673 child = entry_to_node(entry);
674 offset = 0;
675 continue;
676 }
677 offset++;
678 while (offset == RADIX_TREE_MAP_SIZE) {
679 struct radix_tree_node *old = child;
680 offset = child->offset + 1;
681 child = child->parent;
Matthew Wilcoxdd040b62017-01-24 15:18:16 -0800682 WARN_ON_ONCE(!list_empty(&old->private_list));
Matthew Wilcox175542f2016-12-14 15:08:58 -0800683 radix_tree_node_free(old);
684 if (old == entry_to_node(node))
685 return;
686 }
687 }
688}
689
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500690static inline int insert_entries(struct radix_tree_node *node,
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400691 void __rcu **slot, void *item, bool replace)
Matthew Wilcox175542f2016-12-14 15:08:58 -0800692{
693 if (*slot)
694 return -EEXIST;
695 rcu_assign_pointer(*slot, item);
696 if (node) {
697 node->count++;
Matthew Wilcox3159f942017-11-03 13:30:42 -0400698 if (xa_is_value(item))
Matthew Wilcox01959df2017-11-09 09:23:56 -0500699 node->nr_values++;
Matthew Wilcox175542f2016-12-14 15:08:58 -0800700 }
701 return 1;
702}
Matthew Wilcox175542f2016-12-14 15:08:58 -0800703
Johannes Weiner139e5612014-04-03 14:47:54 -0700704/**
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700705 * __radix_tree_insert - insert into a radix tree
Johannes Weiner139e5612014-04-03 14:47:54 -0700706 * @root: radix tree root
707 * @index: index key
708 * @item: item to insert
709 *
710 * Insert an item into the radix tree at position @index.
711 */
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400712int radix_tree_insert(struct radix_tree_root *root, unsigned long index,
713 void *item)
Johannes Weiner139e5612014-04-03 14:47:54 -0700714{
715 struct radix_tree_node *node;
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500716 void __rcu **slot;
Johannes Weiner139e5612014-04-03 14:47:54 -0700717 int error;
718
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700719 BUG_ON(radix_tree_is_internal_node(item));
Johannes Weiner139e5612014-04-03 14:47:54 -0700720
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400721 error = __radix_tree_create(root, index, &node, &slot);
Johannes Weiner139e5612014-04-03 14:47:54 -0700722 if (error)
723 return error;
Matthew Wilcox175542f2016-12-14 15:08:58 -0800724
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400725 error = insert_entries(node, slot, item, false);
Matthew Wilcox175542f2016-12-14 15:08:58 -0800726 if (error < 0)
727 return error;
Christoph Lameter201b6262005-09-06 15:16:46 -0700728
Nick Piggin612d6c12006-06-23 02:03:22 -0700729 if (node) {
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700730 unsigned offset = get_slot_offset(node, slot);
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700731 BUG_ON(tag_get(node, 0, offset));
732 BUG_ON(tag_get(node, 1, offset));
733 BUG_ON(tag_get(node, 2, offset));
Nick Piggin612d6c12006-06-23 02:03:22 -0700734 } else {
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700735 BUG_ON(root_tags_get(root));
Nick Piggin612d6c12006-06-23 02:03:22 -0700736 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 return 0;
739}
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400740EXPORT_SYMBOL(radix_tree_insert);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741
Johannes Weiner139e5612014-04-03 14:47:54 -0700742/**
743 * __radix_tree_lookup - lookup an item in a radix tree
744 * @root: radix tree root
745 * @index: index key
746 * @nodep: returns node
747 * @slotp: returns slot
748 *
749 * Lookup and return the item at position @index in the radix
750 * tree @root.
751 *
752 * Until there is more than one item in the tree, no nodes are
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500753 * allocated and @root->xa_head is used as a direct slot instead of
Johannes Weiner139e5612014-04-03 14:47:54 -0700754 * pointing to a node, in which case *@nodep will be NULL.
Hans Reisera4331362005-11-07 00:59:29 -0800755 */
Matthew Wilcox35534c82016-12-19 17:43:19 -0500756void *__radix_tree_lookup(const struct radix_tree_root *root,
757 unsigned long index, struct radix_tree_node **nodep,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500758 void __rcu ***slotp)
Hans Reisera4331362005-11-07 00:59:29 -0800759{
Johannes Weiner139e5612014-04-03 14:47:54 -0700760 struct radix_tree_node *node, *parent;
Matthew Wilcox85829952016-05-20 17:02:20 -0700761 unsigned long maxindex;
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500762 void __rcu **slot;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800763
Matthew Wilcox85829952016-05-20 17:02:20 -0700764 restart:
765 parent = NULL;
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500766 slot = (void __rcu **)&root->xa_head;
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700767 radix_tree_load_root(root, &node, &maxindex);
Matthew Wilcox85829952016-05-20 17:02:20 -0700768 if (index > maxindex)
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800769 return NULL;
770
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700771 while (radix_tree_is_internal_node(node)) {
Matthew Wilcox85829952016-05-20 17:02:20 -0700772 unsigned offset;
Johannes Weiner139e5612014-04-03 14:47:54 -0700773
Matthew Wilcox4dd6c092016-05-20 17:03:27 -0700774 parent = entry_to_node(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700775 offset = radix_tree_descend(parent, &node, index);
Matthew Wilcox85829952016-05-20 17:02:20 -0700776 slot = parent->slots + offset;
Matthew Wilcoxeff38602018-12-06 08:19:13 -0500777 if (node == RADIX_TREE_RETRY)
778 goto restart;
Matthew Wilcox66ee6202018-06-25 06:56:50 -0400779 if (parent->shift == 0)
780 break;
Matthew Wilcox85829952016-05-20 17:02:20 -0700781 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800782
Johannes Weiner139e5612014-04-03 14:47:54 -0700783 if (nodep)
784 *nodep = parent;
785 if (slotp)
786 *slotp = slot;
787 return node;
Huang Shijieb72b71c2009-06-16 15:33:42 -0700788}
789
790/**
791 * radix_tree_lookup_slot - lookup a slot in a radix tree
792 * @root: radix tree root
793 * @index: index key
794 *
795 * Returns: the slot corresponding to the position @index in the
796 * radix tree @root. This is useful for update-if-exists operations.
797 *
798 * This function can be called under rcu_read_lock iff the slot is not
799 * modified by radix_tree_replace_slot, otherwise it must be called
800 * exclusive from other writers. Any dereference of the slot must be done
801 * using radix_tree_deref_slot.
802 */
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500803void __rcu **radix_tree_lookup_slot(const struct radix_tree_root *root,
Matthew Wilcox35534c82016-12-19 17:43:19 -0500804 unsigned long index)
Huang Shijieb72b71c2009-06-16 15:33:42 -0700805{
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500806 void __rcu **slot;
Johannes Weiner139e5612014-04-03 14:47:54 -0700807
808 if (!__radix_tree_lookup(root, index, NULL, &slot))
809 return NULL;
810 return slot;
Hans Reisera4331362005-11-07 00:59:29 -0800811}
812EXPORT_SYMBOL(radix_tree_lookup_slot);
813
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814/**
815 * radix_tree_lookup - perform lookup operation on a radix tree
816 * @root: radix tree root
817 * @index: index key
818 *
819 * Lookup the item at the position @index in the radix tree @root.
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800820 *
821 * This function can be called under rcu_read_lock, however the caller
822 * must manage lifetimes of leaf nodes (eg. RCU may also be used to free
823 * them safely). No RCU barriers are required to access or modify the
824 * returned item, however.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 */
Matthew Wilcox35534c82016-12-19 17:43:19 -0500826void *radix_tree_lookup(const struct radix_tree_root *root, unsigned long index)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827{
Johannes Weiner139e5612014-04-03 14:47:54 -0700828 return __radix_tree_lookup(root, index, NULL, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829}
830EXPORT_SYMBOL(radix_tree_lookup);
831
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500832static void replace_slot(void __rcu **slot, void *item,
Matthew Wilcox01959df2017-11-09 09:23:56 -0500833 struct radix_tree_node *node, int count, int values)
Johannes Weiner6d75f362016-12-12 16:43:43 -0800834{
Matthew Wilcox01959df2017-11-09 09:23:56 -0500835 if (node && (count || values)) {
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800836 node->count += count;
Matthew Wilcox01959df2017-11-09 09:23:56 -0500837 node->nr_values += values;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800838 }
Johannes Weiner6d75f362016-12-12 16:43:43 -0800839
840 rcu_assign_pointer(*slot, item);
841}
842
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500843static bool node_tag_get(const struct radix_tree_root *root,
844 const struct radix_tree_node *node,
845 unsigned int tag, unsigned int offset)
Matthew Wilcoxa90eb3a2016-12-14 15:09:07 -0800846{
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500847 if (node)
848 return tag_get(node, tag, offset);
849 return root_tag_get(root, tag);
850}
Matthew Wilcoxa90eb3a2016-12-14 15:09:07 -0800851
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500852/*
853 * IDR users want to be able to store NULL in the tree, so if the slot isn't
854 * free, don't adjust the count, even if it's transitioning between NULL and
855 * non-NULL. For the IDA, we mark slots as being IDR_FREE while they still
856 * have empty bits, but it only stores NULL in slots when they're being
857 * deleted.
858 */
859static int calculate_count(struct radix_tree_root *root,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500860 struct radix_tree_node *node, void __rcu **slot,
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500861 void *item, void *old)
862{
863 if (is_idr(root)) {
864 unsigned offset = get_slot_offset(node, slot);
865 bool free = node_tag_get(root, node, IDR_FREE, offset);
866 if (!free)
867 return 0;
868 if (!old)
869 return 1;
Matthew Wilcoxa90eb3a2016-12-14 15:09:07 -0800870 }
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500871 return !!item - !!old;
Matthew Wilcoxa90eb3a2016-12-14 15:09:07 -0800872}
873
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874/**
Johannes Weinerf7942432016-12-12 16:43:41 -0800875 * __radix_tree_replace - replace item in a slot
Johannes Weiner4d693d02016-12-12 16:43:49 -0800876 * @root: radix tree root
877 * @node: pointer to tree node
878 * @slot: pointer to slot in @node
879 * @item: new item to store in the slot.
Johannes Weinerf7942432016-12-12 16:43:41 -0800880 *
881 * For use with __radix_tree_lookup(). Caller must hold tree write locked
882 * across slot lookup and replacement.
883 */
884void __radix_tree_replace(struct radix_tree_root *root,
885 struct radix_tree_node *node,
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400886 void __rcu **slot, void *item)
Johannes Weinerf7942432016-12-12 16:43:41 -0800887{
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500888 void *old = rcu_dereference_raw(*slot);
Matthew Wilcox01959df2017-11-09 09:23:56 -0500889 int values = !!xa_is_value(item) - !!xa_is_value(old);
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500890 int count = calculate_count(root, node, slot, item, old);
891
Johannes Weiner6d75f362016-12-12 16:43:43 -0800892 /*
Matthew Wilcox01959df2017-11-09 09:23:56 -0500893 * This function supports replacing value entries and
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800894 * deleting entries, but that needs accounting against the
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500895 * node unless the slot is root->xa_head.
Johannes Weiner6d75f362016-12-12 16:43:43 -0800896 */
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500897 WARN_ON_ONCE(!node && (slot != (void __rcu **)&root->xa_head) &&
Matthew Wilcox01959df2017-11-09 09:23:56 -0500898 (count || values));
899 replace_slot(slot, item, node, count, values);
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800900
Johannes Weiner4d693d02016-12-12 16:43:49 -0800901 if (!node)
902 return;
903
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400904 delete_node(root, node);
Johannes Weiner6d75f362016-12-12 16:43:43 -0800905}
Johannes Weinerf7942432016-12-12 16:43:41 -0800906
Johannes Weiner6d75f362016-12-12 16:43:43 -0800907/**
908 * radix_tree_replace_slot - replace item in a slot
909 * @root: radix tree root
910 * @slot: pointer to slot
911 * @item: new item to store in the slot.
912 *
Matthew Wilcox7b8d0462017-12-01 22:13:06 -0500913 * For use with radix_tree_lookup_slot() and
Johannes Weiner6d75f362016-12-12 16:43:43 -0800914 * radix_tree_gang_lookup_tag_slot(). Caller must hold tree write locked
915 * across slot lookup and replacement.
916 *
917 * NOTE: This cannot be used to switch between non-entries (empty slots),
Matthew Wilcox01959df2017-11-09 09:23:56 -0500918 * regular entries, and value entries, as that requires accounting
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800919 * inside the radix tree node. When switching from one type of entry or
Matthew Wilcoxe157b552016-12-14 15:09:01 -0800920 * deleting, use __radix_tree_lookup() and __radix_tree_replace() or
921 * radix_tree_iter_replace().
Johannes Weiner6d75f362016-12-12 16:43:43 -0800922 */
923void radix_tree_replace_slot(struct radix_tree_root *root,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500924 void __rcu **slot, void *item)
Johannes Weiner6d75f362016-12-12 16:43:43 -0800925{
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400926 __radix_tree_replace(root, NULL, slot, item);
Johannes Weinerf7942432016-12-12 16:43:41 -0800927}
Song Liu10257d72017-01-11 10:00:51 -0800928EXPORT_SYMBOL(radix_tree_replace_slot);
Johannes Weinerf7942432016-12-12 16:43:41 -0800929
Matthew Wilcoxe157b552016-12-14 15:09:01 -0800930/**
931 * radix_tree_iter_replace - replace item in a slot
932 * @root: radix tree root
933 * @slot: pointer to slot
934 * @item: new item to store in the slot.
935 *
Matthew Wilcox2956c662018-05-19 16:47:47 -0400936 * For use with radix_tree_for_each_slot().
937 * Caller must hold tree write locked.
Matthew Wilcoxe157b552016-12-14 15:09:01 -0800938 */
939void radix_tree_iter_replace(struct radix_tree_root *root,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500940 const struct radix_tree_iter *iter,
941 void __rcu **slot, void *item)
Matthew Wilcoxe157b552016-12-14 15:09:01 -0800942{
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400943 __radix_tree_replace(root, iter->node, slot, item);
Matthew Wilcoxe157b552016-12-14 15:09:01 -0800944}
945
Matthew Wilcox30b888b2017-01-28 09:55:20 -0500946static void node_tag_set(struct radix_tree_root *root,
947 struct radix_tree_node *node,
948 unsigned int tag, unsigned int offset)
949{
950 while (node) {
951 if (tag_get(node, tag, offset))
952 return;
953 tag_set(node, tag, offset);
954 offset = node->offset;
955 node = node->parent;
956 }
957
958 if (!root_tag_get(root, tag))
959 root_tag_set(root, tag);
960}
961
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962/**
963 * radix_tree_tag_set - set a tag on a radix tree node
964 * @root: radix tree root
965 * @index: index key
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700966 * @tag: tag index
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 *
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800968 * Set the search tag (which must be < RADIX_TREE_MAX_TAGS)
969 * corresponding to @index in the radix tree. From
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 * the root all the way down to the leaf node.
971 *
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700972 * Returns the address of the tagged item. Setting a tag on a not-present
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 * item is a bug.
974 */
975void *radix_tree_tag_set(struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800976 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977{
Ross Zwislerfb969902016-05-20 17:02:32 -0700978 struct radix_tree_node *node, *parent;
979 unsigned long maxindex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700981 radix_tree_load_root(root, &node, &maxindex);
Ross Zwislerfb969902016-05-20 17:02:32 -0700982 BUG_ON(index > maxindex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700984 while (radix_tree_is_internal_node(node)) {
Ross Zwislerfb969902016-05-20 17:02:32 -0700985 unsigned offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986
Matthew Wilcox4dd6c092016-05-20 17:03:27 -0700987 parent = entry_to_node(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700988 offset = radix_tree_descend(parent, &node, index);
Ross Zwislerfb969902016-05-20 17:02:32 -0700989 BUG_ON(!node);
990
991 if (!tag_get(parent, tag, offset))
992 tag_set(parent, tag, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 }
994
Nick Piggin612d6c12006-06-23 02:03:22 -0700995 /* set the root's tag bit */
Ross Zwislerfb969902016-05-20 17:02:32 -0700996 if (!root_tag_get(root, tag))
Nick Piggin612d6c12006-06-23 02:03:22 -0700997 root_tag_set(root, tag);
998
Ross Zwislerfb969902016-05-20 17:02:32 -0700999 return node;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000}
1001EXPORT_SYMBOL(radix_tree_tag_set);
1002
Matthew Wilcoxd604c322016-05-20 17:03:45 -07001003static void node_tag_clear(struct radix_tree_root *root,
1004 struct radix_tree_node *node,
1005 unsigned int tag, unsigned int offset)
1006{
1007 while (node) {
1008 if (!tag_get(node, tag, offset))
1009 return;
1010 tag_clear(node, tag, offset);
1011 if (any_tag_set(node, tag))
1012 return;
1013
1014 offset = node->offset;
1015 node = node->parent;
1016 }
1017
1018 /* clear the root's tag bit */
1019 if (root_tag_get(root, tag))
1020 root_tag_clear(root, tag);
1021}
1022
Matthew Wilcox268f42d2016-12-14 15:08:55 -08001023/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 * radix_tree_tag_clear - clear a tag on a radix tree node
1025 * @root: radix tree root
1026 * @index: index key
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001027 * @tag: tag index
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 *
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001029 * Clear the search tag (which must be < RADIX_TREE_MAX_TAGS)
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001030 * corresponding to @index in the radix tree. If this causes
1031 * the leaf node to have no tags set then clear the tag in the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 * next-to-leaf node, etc.
1033 *
1034 * Returns the address of the tagged item on success, else NULL. ie:
1035 * has the same return value and semantics as radix_tree_lookup().
1036 */
1037void *radix_tree_tag_clear(struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001038 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039{
Ross Zwisler00f47b52016-05-20 17:02:35 -07001040 struct radix_tree_node *node, *parent;
1041 unsigned long maxindex;
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001042 int uninitialized_var(offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001044 radix_tree_load_root(root, &node, &maxindex);
Ross Zwisler00f47b52016-05-20 17:02:35 -07001045 if (index > maxindex)
1046 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047
Ross Zwisler00f47b52016-05-20 17:02:35 -07001048 parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049
Matthew Wilcoxb194d162016-05-20 17:03:30 -07001050 while (radix_tree_is_internal_node(node)) {
Matthew Wilcox4dd6c092016-05-20 17:03:27 -07001051 parent = entry_to_node(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001052 offset = radix_tree_descend(parent, &node, index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 }
1054
Matthew Wilcoxd604c322016-05-20 17:03:45 -07001055 if (node)
1056 node_tag_clear(root, parent, tag, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057
Ross Zwisler00f47b52016-05-20 17:02:35 -07001058 return node;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059}
1060EXPORT_SYMBOL(radix_tree_tag_clear);
1061
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062/**
Matthew Wilcox30b888b2017-01-28 09:55:20 -05001063 * radix_tree_iter_tag_clear - clear a tag on the current iterator entry
1064 * @root: radix tree root
1065 * @iter: iterator state
1066 * @tag: tag to clear
1067 */
1068void radix_tree_iter_tag_clear(struct radix_tree_root *root,
1069 const struct radix_tree_iter *iter, unsigned int tag)
1070{
1071 node_tag_clear(root, iter->node, tag, iter_offset(iter));
1072}
1073
1074/**
Marcelo Tosatti32605a12005-09-06 15:16:48 -07001075 * radix_tree_tag_get - get a tag on a radix tree node
1076 * @root: radix tree root
1077 * @index: index key
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001078 * @tag: tag index (< RADIX_TREE_MAX_TAGS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 *
Marcelo Tosatti32605a12005-09-06 15:16:48 -07001080 * Return values:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 *
Nick Piggin612d6c12006-06-23 02:03:22 -07001082 * 0: tag not present or not set
1083 * 1: tag set
David Howellsce826532010-04-06 22:36:20 +01001084 *
1085 * Note that the return value of this function may not be relied on, even if
1086 * the RCU lock is held, unless tag modification and node deletion are excluded
1087 * from concurrency.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 */
Matthew Wilcox35534c82016-12-19 17:43:19 -05001089int radix_tree_tag_get(const struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001090 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091{
Ross Zwisler4589ba62016-05-20 17:02:38 -07001092 struct radix_tree_node *node, *parent;
1093 unsigned long maxindex;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094
Nick Piggin612d6c12006-06-23 02:03:22 -07001095 if (!root_tag_get(root, tag))
1096 return 0;
1097
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001098 radix_tree_load_root(root, &node, &maxindex);
Ross Zwisler4589ba62016-05-20 17:02:38 -07001099 if (index > maxindex)
1100 return 0;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001101
Matthew Wilcoxb194d162016-05-20 17:03:30 -07001102 while (radix_tree_is_internal_node(node)) {
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001103 unsigned offset;
Ross Zwisler4589ba62016-05-20 17:02:38 -07001104
Matthew Wilcox4dd6c092016-05-20 17:03:27 -07001105 parent = entry_to_node(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001106 offset = radix_tree_descend(parent, &node, index);
Ross Zwisler4589ba62016-05-20 17:02:38 -07001107
Ross Zwisler4589ba62016-05-20 17:02:38 -07001108 if (!tag_get(parent, tag, offset))
1109 return 0;
1110 if (node == RADIX_TREE_RETRY)
1111 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 }
Ross Zwisler4589ba62016-05-20 17:02:38 -07001113
1114 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115}
1116EXPORT_SYMBOL(radix_tree_tag_get);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117
Matthew Wilcox148deab2016-12-14 15:08:49 -08001118/* Construct iter->tags bit-mask from node->tags[tag] array */
1119static void set_iter_tags(struct radix_tree_iter *iter,
1120 struct radix_tree_node *node, unsigned offset,
1121 unsigned tag)
1122{
1123 unsigned tag_long = offset / BITS_PER_LONG;
1124 unsigned tag_bit = offset % BITS_PER_LONG;
1125
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001126 if (!node) {
1127 iter->tags = 1;
1128 return;
1129 }
1130
Matthew Wilcox148deab2016-12-14 15:08:49 -08001131 iter->tags = node->tags[tag][tag_long] >> tag_bit;
1132
1133 /* This never happens if RADIX_TREE_TAG_LONGS == 1 */
1134 if (tag_long < RADIX_TREE_TAG_LONGS - 1) {
1135 /* Pick tags from next element */
1136 if (tag_bit)
1137 iter->tags |= node->tags[tag][tag_long + 1] <<
1138 (BITS_PER_LONG - tag_bit);
1139 /* Clip chunk size, here only BITS_PER_LONG tags */
1140 iter->next_index = __radix_tree_iter_add(iter, BITS_PER_LONG);
1141 }
1142}
1143
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001144void __rcu **radix_tree_iter_resume(void __rcu **slot,
1145 struct radix_tree_iter *iter)
Matthew Wilcox148deab2016-12-14 15:08:49 -08001146{
Matthew Wilcox148deab2016-12-14 15:08:49 -08001147 slot++;
1148 iter->index = __radix_tree_iter_add(iter, 1);
Matthew Wilcox148deab2016-12-14 15:08:49 -08001149 iter->next_index = iter->index;
1150 iter->tags = 0;
1151 return NULL;
1152}
1153EXPORT_SYMBOL(radix_tree_iter_resume);
1154
Fengguang Wu6df8ba42007-10-16 01:24:33 -07001155/**
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001156 * radix_tree_next_chunk - find next chunk of slots for iteration
1157 *
1158 * @root: radix tree root
1159 * @iter: iterator state
1160 * @flags: RADIX_TREE_ITER_* flags and tag index
1161 * Returns: pointer to chunk first slot, or NULL if iteration is over
1162 */
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001163void __rcu **radix_tree_next_chunk(const struct radix_tree_root *root,
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001164 struct radix_tree_iter *iter, unsigned flags)
1165{
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001166 unsigned tag = flags & RADIX_TREE_ITER_TAG_MASK;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001167 struct radix_tree_node *node, *child;
Ross Zwisler21ef5332016-05-20 17:02:26 -07001168 unsigned long index, offset, maxindex;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001169
1170 if ((flags & RADIX_TREE_ITER_TAGGED) && !root_tag_get(root, tag))
1171 return NULL;
1172
1173 /*
1174 * Catch next_index overflow after ~0UL. iter->index never overflows
1175 * during iterating; it can be zero only at the beginning.
1176 * And we cannot overflow iter->next_index in a single step,
1177 * because RADIX_TREE_MAP_SHIFT < BITS_PER_LONG.
Konstantin Khlebnikovfffaee32012-06-05 21:36:33 +04001178 *
1179 * This condition also used by radix_tree_next_slot() to stop
Matthew Wilcox91b9677c2016-12-14 15:08:31 -08001180 * contiguous iterating, and forbid switching to the next chunk.
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001181 */
1182 index = iter->next_index;
1183 if (!index && iter->index)
1184 return NULL;
1185
Ross Zwisler21ef5332016-05-20 17:02:26 -07001186 restart:
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001187 radix_tree_load_root(root, &child, &maxindex);
Ross Zwisler21ef5332016-05-20 17:02:26 -07001188 if (index > maxindex)
1189 return NULL;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001190 if (!child)
1191 return NULL;
Ross Zwisler21ef5332016-05-20 17:02:26 -07001192
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001193 if (!radix_tree_is_internal_node(child)) {
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001194 /* Single-slot tree */
Ross Zwisler21ef5332016-05-20 17:02:26 -07001195 iter->index = index;
1196 iter->next_index = maxindex + 1;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001197 iter->tags = 1;
Matthew Wilcox268f42d2016-12-14 15:08:55 -08001198 iter->node = NULL;
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -05001199 return (void __rcu **)&root->xa_head;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001200 }
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001201
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001202 do {
1203 node = entry_to_node(child);
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001204 offset = radix_tree_descend(node, &child, index);
Ross Zwisler21ef5332016-05-20 17:02:26 -07001205
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001206 if ((flags & RADIX_TREE_ITER_TAGGED) ?
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001207 !tag_get(node, tag, offset) : !child) {
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001208 /* Hole detected */
1209 if (flags & RADIX_TREE_ITER_CONTIG)
1210 return NULL;
1211
1212 if (flags & RADIX_TREE_ITER_TAGGED)
Matthew Wilcoxbc412fc2016-12-14 15:08:40 -08001213 offset = radix_tree_find_next_bit(node, tag,
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001214 offset + 1);
1215 else
1216 while (++offset < RADIX_TREE_MAP_SIZE) {
Matthew Wilcox12320d02017-02-13 15:22:48 -05001217 void *slot = rcu_dereference_raw(
1218 node->slots[offset]);
Ross Zwisler21ef5332016-05-20 17:02:26 -07001219 if (slot)
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001220 break;
1221 }
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001222 index &= ~node_maxindex(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001223 index += offset << node->shift;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001224 /* Overflow after ~0UL */
1225 if (!index)
1226 return NULL;
1227 if (offset == RADIX_TREE_MAP_SIZE)
1228 goto restart;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001229 child = rcu_dereference_raw(node->slots[offset]);
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001230 }
1231
Matthew Wilcoxe157b552016-12-14 15:09:01 -08001232 if (!child)
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001233 goto restart;
Matthew Wilcoxe157b552016-12-14 15:09:01 -08001234 if (child == RADIX_TREE_RETRY)
1235 break;
Matthew Wilcox66ee6202018-06-25 06:56:50 -04001236 } while (node->shift && radix_tree_is_internal_node(child));
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001237
1238 /* Update the iterator state */
Matthew Wilcox3a08cd52018-09-22 16:14:30 -04001239 iter->index = (index &~ node_maxindex(node)) | offset;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001240 iter->next_index = (index | node_maxindex(node)) + 1;
Matthew Wilcox268f42d2016-12-14 15:08:55 -08001241 iter->node = node;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001242
Matthew Wilcox148deab2016-12-14 15:08:49 -08001243 if (flags & RADIX_TREE_ITER_TAGGED)
1244 set_iter_tags(iter, node, offset, tag);
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001245
1246 return node->slots + offset;
1247}
1248EXPORT_SYMBOL(radix_tree_next_chunk);
1249
1250/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251 * radix_tree_gang_lookup - perform multiple lookup on a radix tree
1252 * @root: radix tree root
1253 * @results: where the results of the lookup are placed
1254 * @first_index: start the lookup from this key
1255 * @max_items: place up to this many items at *results
1256 *
1257 * Performs an index-ascending scan of the tree for present items. Places
1258 * them at *@results and returns the number of items which were placed at
1259 * *@results.
1260 *
1261 * The implementation is naive.
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001262 *
1263 * Like radix_tree_lookup, radix_tree_gang_lookup may be called under
1264 * rcu_read_lock. In this case, rather than the returned results being
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001265 * an atomic snapshot of the tree at a single point in time, the
1266 * semantics of an RCU protected gang lookup are as though multiple
1267 * radix_tree_lookups have been issued in individual locks, and results
1268 * stored in 'results'.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 */
1270unsigned int
Matthew Wilcox35534c82016-12-19 17:43:19 -05001271radix_tree_gang_lookup(const struct radix_tree_root *root, void **results,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 unsigned long first_index, unsigned int max_items)
1273{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001274 struct radix_tree_iter iter;
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001275 void __rcu **slot;
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001276 unsigned int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001278 if (unlikely(!max_items))
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001279 return 0;
1280
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001281 radix_tree_for_each_slot(slot, root, &iter, first_index) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001282 results[ret] = rcu_dereference_raw(*slot);
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001283 if (!results[ret])
1284 continue;
Matthew Wilcoxb194d162016-05-20 17:03:30 -07001285 if (radix_tree_is_internal_node(results[ret])) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001286 slot = radix_tree_iter_retry(&iter);
1287 continue;
1288 }
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001289 if (++ret == max_items)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001292
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 return ret;
1294}
1295EXPORT_SYMBOL(radix_tree_gang_lookup);
1296
Nick Piggin47feff22008-07-25 19:45:29 -07001297/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298 * radix_tree_gang_lookup_tag - perform multiple lookup on a radix tree
1299 * based on a tag
1300 * @root: radix tree root
1301 * @results: where the results of the lookup are placed
1302 * @first_index: start the lookup from this key
1303 * @max_items: place up to this many items at *results
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001304 * @tag: the tag index (< RADIX_TREE_MAX_TAGS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305 *
1306 * Performs an index-ascending scan of the tree for present items which
1307 * have the tag indexed by @tag set. Places the items at *@results and
1308 * returns the number of items which were placed at *@results.
1309 */
1310unsigned int
Matthew Wilcox35534c82016-12-19 17:43:19 -05001311radix_tree_gang_lookup_tag(const struct radix_tree_root *root, void **results,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001312 unsigned long first_index, unsigned int max_items,
1313 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001315 struct radix_tree_iter iter;
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001316 void __rcu **slot;
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001317 unsigned int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001319 if (unlikely(!max_items))
Nick Piggin612d6c12006-06-23 02:03:22 -07001320 return 0;
1321
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001322 radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001323 results[ret] = rcu_dereference_raw(*slot);
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001324 if (!results[ret])
1325 continue;
Matthew Wilcoxb194d162016-05-20 17:03:30 -07001326 if (radix_tree_is_internal_node(results[ret])) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001327 slot = radix_tree_iter_retry(&iter);
1328 continue;
1329 }
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001330 if (++ret == max_items)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001333
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334 return ret;
1335}
1336EXPORT_SYMBOL(radix_tree_gang_lookup_tag);
1337
1338/**
Nick Piggin47feff22008-07-25 19:45:29 -07001339 * radix_tree_gang_lookup_tag_slot - perform multiple slot lookup on a
1340 * radix tree based on a tag
1341 * @root: radix tree root
1342 * @results: where the results of the lookup are placed
1343 * @first_index: start the lookup from this key
1344 * @max_items: place up to this many items at *results
1345 * @tag: the tag index (< RADIX_TREE_MAX_TAGS)
1346 *
1347 * Performs an index-ascending scan of the tree for present items which
1348 * have the tag indexed by @tag set. Places the slots at *@results and
1349 * returns the number of slots which were placed at *@results.
1350 */
1351unsigned int
Matthew Wilcox35534c82016-12-19 17:43:19 -05001352radix_tree_gang_lookup_tag_slot(const struct radix_tree_root *root,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001353 void __rcu ***results, unsigned long first_index,
Matthew Wilcox35534c82016-12-19 17:43:19 -05001354 unsigned int max_items, unsigned int tag)
Nick Piggin47feff22008-07-25 19:45:29 -07001355{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001356 struct radix_tree_iter iter;
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001357 void __rcu **slot;
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001358 unsigned int ret = 0;
Nick Piggin47feff22008-07-25 19:45:29 -07001359
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001360 if (unlikely(!max_items))
Nick Piggin47feff22008-07-25 19:45:29 -07001361 return 0;
1362
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001363 radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
1364 results[ret] = slot;
1365 if (++ret == max_items)
Nick Piggin47feff22008-07-25 19:45:29 -07001366 break;
Nick Piggin47feff22008-07-25 19:45:29 -07001367 }
1368
1369 return ret;
1370}
1371EXPORT_SYMBOL(radix_tree_gang_lookup_tag_slot);
1372
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001373static bool __radix_tree_delete(struct radix_tree_root *root,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001374 struct radix_tree_node *node, void __rcu **slot)
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001375{
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001376 void *old = rcu_dereference_raw(*slot);
Matthew Wilcox01959df2017-11-09 09:23:56 -05001377 int values = xa_is_value(old) ? -1 : 0;
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001378 unsigned offset = get_slot_offset(node, slot);
1379 int tag;
1380
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001381 if (is_idr(root))
1382 node_tag_set(root, node, IDR_FREE, offset);
1383 else
1384 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++)
1385 node_tag_clear(root, node, tag, offset);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001386
Matthew Wilcox01959df2017-11-09 09:23:56 -05001387 replace_slot(slot, NULL, node, -1, values);
Matthew Wilcox1cf56f92018-04-09 16:24:45 -04001388 return node && delete_node(root, node);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001389}
1390
Johannes Weiner139e5612014-04-03 14:47:54 -07001391/**
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001392 * radix_tree_iter_delete - delete the entry at this iterator position
1393 * @root: radix tree root
1394 * @iter: iterator state
1395 * @slot: pointer to slot
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 *
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001397 * Delete the entry at the position currently pointed to by the iterator.
1398 * This may result in the current node being freed; if it is, the iterator
1399 * is advanced so that it will not reference the freed memory. This
1400 * function may be called without any locking if there are no other threads
1401 * which can access this tree.
1402 */
1403void radix_tree_iter_delete(struct radix_tree_root *root,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001404 struct radix_tree_iter *iter, void __rcu **slot)
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001405{
1406 if (__radix_tree_delete(root, iter->node, slot))
1407 iter->index = iter->next_index;
1408}
Chris Wilsond1b48c12017-08-16 09:52:08 +01001409EXPORT_SYMBOL(radix_tree_iter_delete);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001410
1411/**
1412 * radix_tree_delete_item - delete an item from a radix tree
1413 * @root: radix tree root
1414 * @index: index key
1415 * @item: expected item
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 *
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001417 * Remove @item at @index from the radix tree rooted at @root.
1418 *
1419 * Return: the deleted entry, or %NULL if it was not present
1420 * or the entry at the given @index was not @item.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 */
Johannes Weiner53c59f22014-04-03 14:47:39 -07001422void *radix_tree_delete_item(struct radix_tree_root *root,
1423 unsigned long index, void *item)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424{
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001425 struct radix_tree_node *node = NULL;
Matthew Wilcox7a4deea2018-05-25 14:47:24 -07001426 void __rcu **slot = NULL;
Johannes Weiner139e5612014-04-03 14:47:54 -07001427 void *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428
Johannes Weiner139e5612014-04-03 14:47:54 -07001429 entry = __radix_tree_lookup(root, index, &node, &slot);
Matthew Wilcox7a4deea2018-05-25 14:47:24 -07001430 if (!slot)
1431 return NULL;
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001432 if (!entry && (!is_idr(root) || node_tag_get(root, node, IDR_FREE,
1433 get_slot_offset(node, slot))))
Johannes Weiner139e5612014-04-03 14:47:54 -07001434 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435
Johannes Weiner139e5612014-04-03 14:47:54 -07001436 if (item && entry != item)
1437 return NULL;
1438
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001439 __radix_tree_delete(root, node, slot);
Christoph Lameter201b6262005-09-06 15:16:46 -07001440
Johannes Weiner139e5612014-04-03 14:47:54 -07001441 return entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442}
Johannes Weiner53c59f22014-04-03 14:47:39 -07001443EXPORT_SYMBOL(radix_tree_delete_item);
1444
1445/**
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001446 * radix_tree_delete - delete an entry from a radix tree
1447 * @root: radix tree root
1448 * @index: index key
Johannes Weiner53c59f22014-04-03 14:47:39 -07001449 *
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001450 * Remove the entry at @index from the radix tree rooted at @root.
Johannes Weiner53c59f22014-04-03 14:47:39 -07001451 *
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001452 * Return: The deleted entry, or %NULL if it was not present.
Johannes Weiner53c59f22014-04-03 14:47:39 -07001453 */
1454void *radix_tree_delete(struct radix_tree_root *root, unsigned long index)
1455{
1456 return radix_tree_delete_item(root, index, NULL);
1457}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458EXPORT_SYMBOL(radix_tree_delete);
1459
1460/**
1461 * radix_tree_tagged - test whether any items in the tree are tagged
1462 * @root: radix tree root
1463 * @tag: tag to test
1464 */
Matthew Wilcox35534c82016-12-19 17:43:19 -05001465int radix_tree_tagged(const struct radix_tree_root *root, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466{
Nick Piggin612d6c12006-06-23 02:03:22 -07001467 return root_tag_get(root, tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468}
1469EXPORT_SYMBOL(radix_tree_tagged);
1470
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001471/**
1472 * idr_preload - preload for idr_alloc()
1473 * @gfp_mask: allocation mask to use for preloading
1474 *
1475 * Preallocate memory to use for the next call to idr_alloc(). This function
1476 * returns with preemption disabled. It will be enabled by idr_preload_end().
1477 */
1478void idr_preload(gfp_t gfp_mask)
1479{
Eric Dumazetbc9ae222017-09-08 16:15:54 -07001480 if (__radix_tree_preload(gfp_mask, IDR_PRELOAD_SIZE))
1481 preempt_disable();
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001482}
1483EXPORT_SYMBOL(idr_preload);
1484
Matthew Wilcox460488c2017-11-28 15:16:24 -05001485void __rcu **idr_get_free(struct radix_tree_root *root,
Chris Mi388f79f2017-08-30 02:31:57 -04001486 struct radix_tree_iter *iter, gfp_t gfp,
1487 unsigned long max)
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001488{
1489 struct radix_tree_node *node = NULL, *child;
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -05001490 void __rcu **slot = (void __rcu **)&root->xa_head;
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001491 unsigned long maxindex, start = iter->next_index;
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001492 unsigned int shift, offset = 0;
1493
1494 grow:
1495 shift = radix_tree_load_root(root, &child, &maxindex);
1496 if (!radix_tree_tagged(root, IDR_FREE))
1497 start = max(start, maxindex + 1);
1498 if (start > max)
1499 return ERR_PTR(-ENOSPC);
1500
1501 if (start > maxindex) {
1502 int error = radix_tree_extend(root, gfp, start, shift);
1503 if (error < 0)
1504 return ERR_PTR(error);
1505 shift = error;
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -05001506 child = rcu_dereference_raw(root->xa_head);
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001507 }
Matthew Wilcox66ee6202018-06-25 06:56:50 -04001508 if (start == 0 && shift == 0)
1509 shift = RADIX_TREE_MAP_SHIFT;
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001510
1511 while (shift) {
1512 shift -= RADIX_TREE_MAP_SHIFT;
1513 if (child == NULL) {
1514 /* Have to add a child node. */
Matthew Wilcoxd58275b2017-01-16 17:10:21 -05001515 child = radix_tree_node_alloc(gfp, node, root, shift,
1516 offset, 0, 0);
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001517 if (!child)
1518 return ERR_PTR(-ENOMEM);
1519 all_tag_set(child, IDR_FREE);
1520 rcu_assign_pointer(*slot, node_to_entry(child));
1521 if (node)
1522 node->count++;
1523 } else if (!radix_tree_is_internal_node(child))
1524 break;
1525
1526 node = entry_to_node(child);
1527 offset = radix_tree_descend(node, &child, start);
1528 if (!tag_get(node, IDR_FREE, offset)) {
1529 offset = radix_tree_find_next_bit(node, IDR_FREE,
1530 offset + 1);
1531 start = next_index(start, node, offset);
1532 if (start > max)
1533 return ERR_PTR(-ENOSPC);
1534 while (offset == RADIX_TREE_MAP_SIZE) {
1535 offset = node->offset + 1;
1536 node = node->parent;
1537 if (!node)
1538 goto grow;
1539 shift = node->shift;
1540 }
1541 child = rcu_dereference_raw(node->slots[offset]);
1542 }
1543 slot = &node->slots[offset];
1544 }
1545
1546 iter->index = start;
1547 if (node)
1548 iter->next_index = 1 + min(max, (start | node_maxindex(node)));
1549 else
1550 iter->next_index = 1;
1551 iter->node = node;
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001552 set_iter_tags(iter, node, offset, IDR_FREE);
1553
1554 return slot;
1555}
1556
1557/**
1558 * idr_destroy - release all internal memory from an IDR
1559 * @idr: idr handle
1560 *
1561 * After this function is called, the IDR is empty, and may be reused or
1562 * the data structure containing it may be freed.
1563 *
1564 * A typical clean-up sequence for objects stored in an idr tree will use
1565 * idr_for_each() to free all objects, if necessary, then idr_destroy() to
1566 * free the memory used to keep track of those objects.
1567 */
1568void idr_destroy(struct idr *idr)
1569{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -05001570 struct radix_tree_node *node = rcu_dereference_raw(idr->idr_rt.xa_head);
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001571 if (radix_tree_is_internal_node(node))
1572 radix_tree_free_nodes(node);
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -05001573 idr->idr_rt.xa_head = NULL;
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001574 root_tag_set(&idr->idr_rt, IDR_FREE);
1575}
1576EXPORT_SYMBOL(idr_destroy);
1577
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578static void
Johannes Weiner449dd692014-04-03 14:47:56 -07001579radix_tree_node_ctor(void *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580{
Johannes Weiner449dd692014-04-03 14:47:56 -07001581 struct radix_tree_node *node = arg;
1582
1583 memset(node, 0, sizeof(*node));
1584 INIT_LIST_HEAD(&node->private_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585}
1586
Sebastian Andrzej Siewiord544abd2016-11-03 15:50:01 +01001587static int radix_tree_cpu_dead(unsigned int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588{
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001589 struct radix_tree_preload *rtp;
1590 struct radix_tree_node *node;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001592 /* Free per-cpu pool of preloaded nodes */
Sebastian Andrzej Siewiord544abd2016-11-03 15:50:01 +01001593 rtp = &per_cpu(radix_tree_preloads, cpu);
1594 while (rtp->nr) {
1595 node = rtp->nodes;
Matthew Wilcox1293d5c2017-01-16 16:41:29 -05001596 rtp->nodes = node->parent;
Sebastian Andrzej Siewiord544abd2016-11-03 15:50:01 +01001597 kmem_cache_free(radix_tree_node_cachep, node);
1598 rtp->nr--;
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001599 }
Sebastian Andrzej Siewiord544abd2016-11-03 15:50:01 +01001600 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602
1603void __init radix_tree_init(void)
1604{
Sebastian Andrzej Siewiord544abd2016-11-03 15:50:01 +01001605 int ret;
Michal Hocko7e784422017-05-03 14:53:09 -07001606
1607 BUILD_BUG_ON(RADIX_TREE_MAX_TAGS + __GFP_BITS_SHIFT > 32);
Matthew Wilcoxfa290cd2018-04-10 16:36:28 -07001608 BUILD_BUG_ON(ROOT_IS_IDR & ~GFP_ZONEMASK);
Matthew Wilcox02c02bf2017-11-03 23:09:45 -04001609 BUILD_BUG_ON(XA_CHUNK_SIZE > 255);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 radix_tree_node_cachep = kmem_cache_create("radix_tree_node",
1611 sizeof(struct radix_tree_node), 0,
Christoph Lameter488514d2008-04-28 02:12:05 -07001612 SLAB_PANIC | SLAB_RECLAIM_ACCOUNT,
1613 radix_tree_node_ctor);
Sebastian Andrzej Siewiord544abd2016-11-03 15:50:01 +01001614 ret = cpuhp_setup_state_nocalls(CPUHP_RADIX_DEAD, "lib/radix:dead",
1615 NULL, radix_tree_cpu_dead);
1616 WARN_ON(ret < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617}