blob: b3afafe46fffbca7d7afff3b645b47e1c6faae23 [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
Jeff Moyer26fb1582007-10-16 01:24:49 -070030/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 * Radix tree node cache.
32 */
Matthew Wilcox58d6ea32017-11-10 15:15:08 -050033struct kmem_cache *radix_tree_node_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35/*
Nick Piggin55368052012-05-29 15:07:34 -070036 * The radix tree is variable-height, so an insert operation not only has
37 * to build the branch to its corresponding item, it also has to build the
38 * branch to existing items if the size has to be increased (by
39 * radix_tree_extend).
40 *
41 * The worst case is a zero height tree with just a single item at index 0,
42 * and then inserting an item at index ULONG_MAX. This requires 2 new branches
43 * of RADIX_TREE_MAX_PATH size to be created, with only the root node shared.
44 * Hence:
45 */
46#define RADIX_TREE_PRELOAD_SIZE (RADIX_TREE_MAX_PATH * 2 - 1)
47
48/*
Matthew Wilcox0a835c42016-12-20 10:27:56 -050049 * The IDR does not have to be as high as the radix tree since it uses
50 * signed integers, not unsigned longs.
51 */
52#define IDR_INDEX_BITS (8 /* CHAR_BIT */ * sizeof(int) - 1)
53#define IDR_MAX_PATH (DIV_ROUND_UP(IDR_INDEX_BITS, \
54 RADIX_TREE_MAP_SHIFT))
55#define IDR_PRELOAD_SIZE (IDR_MAX_PATH * 2 - 1)
56
57/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 * Per-cpu pool of preloaded nodes
59 */
Sebastian Andrzej Siewiorcfa67052020-05-27 22:11:14 +020060DEFINE_PER_CPU(struct radix_tree_preload, radix_tree_preloads) = {
61 .lock = INIT_LOCAL_LOCK(lock),
Linus Torvalds1da177e2005-04-16 15:20:36 -070062};
Sebastian Andrzej Siewiorcfa67052020-05-27 22:11:14 +020063EXPORT_PER_CPU_SYMBOL_GPL(radix_tree_preloads);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
Matthew Wilcox148deab2016-12-14 15:08:49 -080065static inline struct radix_tree_node *entry_to_node(void *ptr)
66{
67 return (void *)((unsigned long)ptr & ~RADIX_TREE_INTERNAL_NODE);
68}
69
Matthew Wilcoxa4db4dc2016-05-20 17:03:24 -070070static inline void *node_to_entry(void *ptr)
Nick Piggin27d20fd2010-11-11 14:05:19 -080071{
Matthew Wilcox30ff46cc2016-05-20 17:03:22 -070072 return (void *)((unsigned long)ptr | RADIX_TREE_INTERNAL_NODE);
Nick Piggin27d20fd2010-11-11 14:05:19 -080073}
74
Matthew Wilcox02c02bf2017-11-03 23:09:45 -040075#define RADIX_TREE_RETRY XA_RETRY_ENTRY
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070076
Matthew Wilcoxd7b62722017-02-13 15:58:24 -050077static inline unsigned long
78get_slot_offset(const struct radix_tree_node *parent, void __rcu **slot)
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070079{
Matthew Wilcox76f070b2018-08-18 07:05:50 -040080 return parent ? slot - parent->slots : 0;
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070081}
82
Matthew Wilcox35534c82016-12-19 17:43:19 -050083static unsigned int radix_tree_descend(const struct radix_tree_node *parent,
Matthew Wilcox9e85d812016-05-20 17:03:48 -070084 struct radix_tree_node **nodep, unsigned long index)
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070085{
Matthew Wilcox9e85d812016-05-20 17:03:48 -070086 unsigned int offset = (index >> parent->shift) & RADIX_TREE_MAP_MASK;
Matthew Wilcoxd7b62722017-02-13 15:58:24 -050087 void __rcu **entry = rcu_dereference_raw(parent->slots[offset]);
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070088
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070089 *nodep = (void *)entry;
90 return offset;
91}
92
Matthew Wilcox35534c82016-12-19 17:43:19 -050093static inline gfp_t root_gfp_mask(const struct radix_tree_root *root)
Nick Piggin612d6c12006-06-23 02:03:22 -070094{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -050095 return root->xa_flags & (__GFP_BITS_MASK & ~GFP_ZONEMASK);
Nick Piggin612d6c12006-06-23 02:03:22 -070096}
97
Nick Piggin643b52b2008-06-12 15:21:52 -070098static inline void tag_set(struct radix_tree_node *node, unsigned int tag,
99 int offset)
100{
101 __set_bit(offset, node->tags[tag]);
102}
103
104static inline void tag_clear(struct radix_tree_node *node, unsigned int tag,
105 int offset)
106{
107 __clear_bit(offset, node->tags[tag]);
108}
109
Matthew Wilcox35534c82016-12-19 17:43:19 -0500110static inline int tag_get(const struct radix_tree_node *node, unsigned int tag,
Nick Piggin643b52b2008-06-12 15:21:52 -0700111 int offset)
112{
113 return test_bit(offset, node->tags[tag]);
114}
115
Matthew Wilcox35534c82016-12-19 17:43:19 -0500116static inline void root_tag_set(struct radix_tree_root *root, unsigned tag)
Nick Piggin643b52b2008-06-12 15:21:52 -0700117{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500118 root->xa_flags |= (__force gfp_t)(1 << (tag + ROOT_TAG_SHIFT));
Nick Piggin643b52b2008-06-12 15:21:52 -0700119}
120
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700121static inline void root_tag_clear(struct radix_tree_root *root, unsigned tag)
Nick Piggin643b52b2008-06-12 15:21:52 -0700122{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500123 root->xa_flags &= (__force gfp_t)~(1 << (tag + ROOT_TAG_SHIFT));
Nick Piggin643b52b2008-06-12 15:21:52 -0700124}
125
126static inline void root_tag_clear_all(struct radix_tree_root *root)
127{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500128 root->xa_flags &= (__force gfp_t)((1 << ROOT_TAG_SHIFT) - 1);
Nick Piggin643b52b2008-06-12 15:21:52 -0700129}
130
Matthew Wilcox35534c82016-12-19 17:43:19 -0500131static inline int root_tag_get(const struct radix_tree_root *root, unsigned tag)
Nick Piggin643b52b2008-06-12 15:21:52 -0700132{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500133 return (__force int)root->xa_flags & (1 << (tag + ROOT_TAG_SHIFT));
Nick Piggin643b52b2008-06-12 15:21:52 -0700134}
135
Matthew Wilcox35534c82016-12-19 17:43:19 -0500136static inline unsigned root_tags_get(const struct radix_tree_root *root)
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700137{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500138 return (__force unsigned)root->xa_flags >> ROOT_TAG_SHIFT;
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500139}
140
141static inline bool is_idr(const struct radix_tree_root *root)
142{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500143 return !!(root->xa_flags & ROOT_IS_IDR);
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700144}
145
Nick Piggin643b52b2008-06-12 15:21:52 -0700146/*
147 * Returns 1 if any slot in the node has this tag set.
148 * Otherwise returns 0.
149 */
Matthew Wilcox35534c82016-12-19 17:43:19 -0500150static inline int any_tag_set(const struct radix_tree_node *node,
151 unsigned int tag)
Nick Piggin643b52b2008-06-12 15:21:52 -0700152{
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700153 unsigned idx;
Nick Piggin643b52b2008-06-12 15:21:52 -0700154 for (idx = 0; idx < RADIX_TREE_TAG_LONGS; idx++) {
155 if (node->tags[tag][idx])
156 return 1;
157 }
158 return 0;
159}
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700160
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500161static inline void all_tag_set(struct radix_tree_node *node, unsigned int tag)
162{
163 bitmap_fill(node->tags[tag], RADIX_TREE_MAP_SIZE);
164}
165
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700166/**
167 * radix_tree_find_next_bit - find the next set bit in a memory region
168 *
Randy Dunlapc95c2d32021-04-16 15:46:26 -0700169 * @node: where to begin the search
170 * @tag: the tag index
171 * @offset: the bitnumber to start searching at
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700172 *
173 * Unrollable variant of find_next_bit() for constant size arrays.
174 * Tail bits starting from size to roundup(size, BITS_PER_LONG) must be zero.
175 * Returns next bit offset, or size if nothing found.
176 */
177static __always_inline unsigned long
Matthew Wilcoxbc412fc2016-12-14 15:08:40 -0800178radix_tree_find_next_bit(struct radix_tree_node *node, unsigned int tag,
179 unsigned long offset)
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700180{
Matthew Wilcoxbc412fc2016-12-14 15:08:40 -0800181 const unsigned long *addr = node->tags[tag];
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700182
Matthew Wilcoxbc412fc2016-12-14 15:08:40 -0800183 if (offset < RADIX_TREE_MAP_SIZE) {
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700184 unsigned long tmp;
185
186 addr += offset / BITS_PER_LONG;
187 tmp = *addr >> (offset % BITS_PER_LONG);
188 if (tmp)
189 return __ffs(tmp) + offset;
190 offset = (offset + BITS_PER_LONG) & ~(BITS_PER_LONG - 1);
Matthew Wilcoxbc412fc2016-12-14 15:08:40 -0800191 while (offset < RADIX_TREE_MAP_SIZE) {
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700192 tmp = *++addr;
193 if (tmp)
194 return __ffs(tmp) + offset;
195 offset += BITS_PER_LONG;
196 }
197 }
Matthew Wilcoxbc412fc2016-12-14 15:08:40 -0800198 return RADIX_TREE_MAP_SIZE;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700199}
200
Matthew Wilcox268f42d2016-12-14 15:08:55 -0800201static unsigned int iter_offset(const struct radix_tree_iter *iter)
202{
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400203 return iter->index & RADIX_TREE_MAP_MASK;
Matthew Wilcox268f42d2016-12-14 15:08:55 -0800204}
205
Matthew Wilcox218ed752016-12-14 15:08:43 -0800206/*
207 * The maximum index which can be stored in a radix tree
208 */
209static inline unsigned long shift_maxindex(unsigned int shift)
210{
211 return (RADIX_TREE_MAP_SIZE << shift) - 1;
212}
213
Matthew Wilcox35534c82016-12-19 17:43:19 -0500214static inline unsigned long node_maxindex(const struct radix_tree_node *node)
Matthew Wilcox218ed752016-12-14 15:08:43 -0800215{
216 return shift_maxindex(node->shift);
217}
218
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500219static unsigned long next_index(unsigned long index,
220 const struct radix_tree_node *node,
221 unsigned long offset)
222{
223 return (index & ~node_maxindex(node)) + (offset << node->shift);
224}
225
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226/*
227 * This assumes that the caller has performed appropriate preallocation, and
228 * that the caller has pinned this thread of control to the current CPU.
229 */
230static struct radix_tree_node *
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500231radix_tree_node_alloc(gfp_t gfp_mask, struct radix_tree_node *parent,
Matthew Wilcoxd58275b2017-01-16 17:10:21 -0500232 struct radix_tree_root *root,
Matthew Wilcoxe8de4342016-12-14 15:09:31 -0800233 unsigned int shift, unsigned int offset,
Matthew Wilcox01959df2017-11-09 09:23:56 -0500234 unsigned int count, unsigned int nr_values)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235{
Nick Piggine2848a02008-02-04 22:29:10 -0800236 struct radix_tree_node *ret = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
Jan Kara5e4c0d972013-09-11 14:26:05 -0700238 /*
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700239 * Preload code isn't irq safe and it doesn't make sense to use
240 * preloading during an interrupt anyway as all the allocations have
241 * to be atomic. So just do normal allocation when in interrupt.
Jan Kara5e4c0d972013-09-11 14:26:05 -0700242 */
Mel Gormand0164ad2015-11-06 16:28:21 -0800243 if (!gfpflags_allow_blocking(gfp_mask) && !in_interrupt()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 struct radix_tree_preload *rtp;
245
Nick Piggine2848a02008-02-04 22:29:10 -0800246 /*
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700247 * Even if the caller has preloaded, try to allocate from the
Vladimir Davydov05eb6e72016-08-02 14:03:01 -0700248 * cache first for the new node to get accounted to the memory
249 * cgroup.
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700250 */
251 ret = kmem_cache_alloc(radix_tree_node_cachep,
Vladimir Davydov05eb6e72016-08-02 14:03:01 -0700252 gfp_mask | __GFP_NOWARN);
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700253 if (ret)
254 goto out;
255
256 /*
Nick Piggine2848a02008-02-04 22:29:10 -0800257 * Provided the caller has preloaded here, we will always
258 * succeed in getting a node here (and never reach
259 * kmem_cache_alloc)
260 */
Christoph Lameter7c8e0182014-06-04 16:07:56 -0700261 rtp = this_cpu_ptr(&radix_tree_preloads);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 if (rtp->nr) {
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700263 ret = rtp->nodes;
Matthew Wilcox1293d5c2017-01-16 16:41:29 -0500264 rtp->nodes = ret->parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 rtp->nr--;
266 }
Catalin Marinasce80b062014-06-06 14:38:18 -0700267 /*
268 * Update the allocation stack trace as this is more useful
269 * for debugging.
270 */
271 kmemleak_update_trace(ret);
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700272 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 }
Vladimir Davydov05eb6e72016-08-02 14:03:01 -0700274 ret = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700275out:
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700276 BUG_ON(radix_tree_is_internal_node(ret));
Matthew Wilcoxe8de4342016-12-14 15:09:31 -0800277 if (ret) {
Matthew Wilcoxe8de4342016-12-14 15:09:31 -0800278 ret->shift = shift;
279 ret->offset = offset;
280 ret->count = count;
Matthew Wilcox01959df2017-11-09 09:23:56 -0500281 ret->nr_values = nr_values;
Matthew Wilcoxd58275b2017-01-16 17:10:21 -0500282 ret->parent = parent;
Matthew Wilcox01959df2017-11-09 09:23:56 -0500283 ret->array = root;
Matthew Wilcoxe8de4342016-12-14 15:09:31 -0800284 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 return ret;
286}
287
Matthew Wilcox58d6ea32017-11-10 15:15:08 -0500288void radix_tree_node_rcu_free(struct rcu_head *head)
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800289{
290 struct radix_tree_node *node =
291 container_of(head, struct radix_tree_node, rcu_head);
Nick Piggin643b52b2008-06-12 15:21:52 -0700292
293 /*
Matthew Wilcox175542f2016-12-14 15:08:58 -0800294 * Must only free zeroed nodes into the slab. We can be left with
295 * non-NULL entries by radix_tree_free_nodes, so clear the entries
296 * and tags here.
Nick Piggin643b52b2008-06-12 15:21:52 -0700297 */
Matthew Wilcox175542f2016-12-14 15:08:58 -0800298 memset(node->slots, 0, sizeof(node->slots));
299 memset(node->tags, 0, sizeof(node->tags));
Matthew Wilcox91d9c052016-12-14 15:08:34 -0800300 INIT_LIST_HEAD(&node->private_list);
Nick Piggin643b52b2008-06-12 15:21:52 -0700301
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800302 kmem_cache_free(radix_tree_node_cachep, node);
303}
304
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305static inline void
306radix_tree_node_free(struct radix_tree_node *node)
307{
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800308 call_rcu(&node->rcu_head, radix_tree_node_rcu_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309}
310
311/*
312 * Load up this CPU's radix_tree_node buffer with sufficient objects to
313 * ensure that the addition of a single element in the tree cannot fail. On
314 * success, return zero, with preemption disabled. On error, return -ENOMEM
315 * with preemption not disabled.
David Howellsb34df792009-11-19 18:11:14 +0000316 *
317 * To make use of this facility, the radix tree must be initialised without
Mel Gormand0164ad2015-11-06 16:28:21 -0800318 * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 */
Eric Dumazetbc9ae222017-09-08 16:15:54 -0700320static __must_check int __radix_tree_preload(gfp_t gfp_mask, unsigned nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321{
322 struct radix_tree_preload *rtp;
323 struct radix_tree_node *node;
324 int ret = -ENOMEM;
325
Vladimir Davydov05eb6e72016-08-02 14:03:01 -0700326 /*
Randy Dunlape0656502020-10-15 20:11:04 -0700327 * Nodes preloaded by one cgroup can be used by another cgroup, so
Vladimir Davydov05eb6e72016-08-02 14:03:01 -0700328 * they should never be accounted to any particular memory cgroup.
329 */
330 gfp_mask &= ~__GFP_ACCOUNT;
331
Sebastian Andrzej Siewiorcfa67052020-05-27 22:11:14 +0200332 local_lock(&radix_tree_preloads.lock);
Christoph Lameter7c8e0182014-06-04 16:07:56 -0700333 rtp = this_cpu_ptr(&radix_tree_preloads);
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -0700334 while (rtp->nr < nr) {
Sebastian Andrzej Siewiorcfa67052020-05-27 22:11:14 +0200335 local_unlock(&radix_tree_preloads.lock);
Christoph Lameter488514d2008-04-28 02:12:05 -0700336 node = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 if (node == NULL)
338 goto out;
Sebastian Andrzej Siewiorcfa67052020-05-27 22:11:14 +0200339 local_lock(&radix_tree_preloads.lock);
Christoph Lameter7c8e0182014-06-04 16:07:56 -0700340 rtp = this_cpu_ptr(&radix_tree_preloads);
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -0700341 if (rtp->nr < nr) {
Matthew Wilcox1293d5c2017-01-16 16:41:29 -0500342 node->parent = rtp->nodes;
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700343 rtp->nodes = node;
344 rtp->nr++;
345 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 kmem_cache_free(radix_tree_node_cachep, node);
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700347 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 }
349 ret = 0;
350out:
351 return ret;
352}
Jan Kara5e4c0d972013-09-11 14:26:05 -0700353
354/*
355 * Load up this CPU's radix_tree_node buffer with sufficient objects to
356 * ensure that the addition of a single element in the tree cannot fail. On
357 * success, return zero, with preemption disabled. On error, return -ENOMEM
358 * with preemption not disabled.
359 *
360 * To make use of this facility, the radix tree must be initialised without
Mel Gormand0164ad2015-11-06 16:28:21 -0800361 * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
Jan Kara5e4c0d972013-09-11 14:26:05 -0700362 */
363int radix_tree_preload(gfp_t gfp_mask)
364{
365 /* Warn on non-sensical use... */
Mel Gormand0164ad2015-11-06 16:28:21 -0800366 WARN_ON_ONCE(!gfpflags_allow_blocking(gfp_mask));
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -0700367 return __radix_tree_preload(gfp_mask, RADIX_TREE_PRELOAD_SIZE);
Jan Kara5e4c0d972013-09-11 14:26:05 -0700368}
David Chinnerd7f09232007-07-14 16:05:04 +1000369EXPORT_SYMBOL(radix_tree_preload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
Nick Piggin6e954b92006-01-08 01:01:40 -0800371/*
Jan Kara5e4c0d972013-09-11 14:26:05 -0700372 * The same as above function, except we don't guarantee preloading happens.
373 * We do it, if we decide it helps. On success, return zero with preemption
374 * disabled. On error, return -ENOMEM with preemption not disabled.
375 */
376int radix_tree_maybe_preload(gfp_t gfp_mask)
377{
Mel Gormand0164ad2015-11-06 16:28:21 -0800378 if (gfpflags_allow_blocking(gfp_mask))
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -0700379 return __radix_tree_preload(gfp_mask, RADIX_TREE_PRELOAD_SIZE);
Jan Kara5e4c0d972013-09-11 14:26:05 -0700380 /* Preloading doesn't help anything with this gfp mask, skip it */
Sebastian Andrzej Siewiorcfa67052020-05-27 22:11:14 +0200381 local_lock(&radix_tree_preloads.lock);
Jan Kara5e4c0d972013-09-11 14:26:05 -0700382 return 0;
383}
384EXPORT_SYMBOL(radix_tree_maybe_preload);
385
Matthew Wilcox35534c82016-12-19 17:43:19 -0500386static unsigned radix_tree_load_root(const struct radix_tree_root *root,
Matthew Wilcox1456a432016-05-20 17:02:08 -0700387 struct radix_tree_node **nodep, unsigned long *maxindex)
388{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500389 struct radix_tree_node *node = rcu_dereference_raw(root->xa_head);
Matthew Wilcox1456a432016-05-20 17:02:08 -0700390
391 *nodep = node;
392
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700393 if (likely(radix_tree_is_internal_node(node))) {
Matthew Wilcox4dd6c092016-05-20 17:03:27 -0700394 node = entry_to_node(node);
Matthew Wilcox1456a432016-05-20 17:02:08 -0700395 *maxindex = node_maxindex(node);
Matthew Wilcoxc12e51b2016-05-20 17:03:10 -0700396 return node->shift + RADIX_TREE_MAP_SHIFT;
Matthew Wilcox1456a432016-05-20 17:02:08 -0700397 }
398
399 *maxindex = 0;
400 return 0;
401}
402
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403/*
404 * Extend a radix tree so it can store key @index.
405 */
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500406static int radix_tree_extend(struct radix_tree_root *root, gfp_t gfp,
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700407 unsigned long index, unsigned int shift)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408{
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500409 void *entry;
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700410 unsigned int maxshift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 int tag;
412
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700413 /* Figure out what the shift should be. */
414 maxshift = shift;
415 while (index > shift_maxindex(maxshift))
416 maxshift += RADIX_TREE_MAP_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500418 entry = rcu_dereference_raw(root->xa_head);
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500419 if (!entry && (!is_idr(root) || root_tag_get(root, IDR_FREE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 do {
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500423 struct radix_tree_node *node = radix_tree_node_alloc(gfp, NULL,
Matthew Wilcoxd58275b2017-01-16 17:10:21 -0500424 root, shift, 0, 1, 0);
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700425 if (!node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 return -ENOMEM;
427
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500428 if (is_idr(root)) {
429 all_tag_set(node, IDR_FREE);
430 if (!root_tag_get(root, IDR_FREE)) {
431 tag_clear(node, IDR_FREE, 0);
432 root_tag_set(root, IDR_FREE);
433 }
434 } else {
435 /* Propagate the aggregated tag info to the new child */
436 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
437 if (root_tag_get(root, tag))
438 tag_set(node, tag, 0);
439 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 }
441
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700442 BUG_ON(shift > BITS_PER_LONG);
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500443 if (radix_tree_is_internal_node(entry)) {
444 entry_to_node(entry)->parent = node;
Matthew Wilcox3159f942017-11-03 13:30:42 -0400445 } else if (xa_is_value(entry)) {
Matthew Wilcox01959df2017-11-09 09:23:56 -0500446 /* Moving a value entry root->xa_head to a node */
447 node->nr_values = 1;
Johannes Weinerf7942432016-12-12 16:43:41 -0800448 }
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500449 /*
450 * entry was already in the radix tree, so we do not need
451 * rcu_assign_pointer here
452 */
453 node->slots[0] = (void __rcu *)entry;
454 entry = node_to_entry(node);
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500455 rcu_assign_pointer(root->xa_head, entry);
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700456 shift += RADIX_TREE_MAP_SHIFT;
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700457 } while (shift <= maxshift);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458out:
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700459 return maxshift + RADIX_TREE_MAP_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460}
461
462/**
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800463 * radix_tree_shrink - shrink radix tree to minimum height
Randy Dunlapc95c2d32021-04-16 15:46:26 -0700464 * @root: radix tree root
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800465 */
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400466static inline bool radix_tree_shrink(struct radix_tree_root *root)
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800467{
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500468 bool shrunk = false;
469
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800470 for (;;) {
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500471 struct radix_tree_node *node = rcu_dereference_raw(root->xa_head);
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800472 struct radix_tree_node *child;
473
474 if (!radix_tree_is_internal_node(node))
475 break;
476 node = entry_to_node(node);
477
478 /*
479 * The candidate node has more than one child, or its child
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400480 * is not at the leftmost slot, we cannot shrink.
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800481 */
482 if (node->count != 1)
483 break;
Matthew Wilcox12320d02017-02-13 15:22:48 -0500484 child = rcu_dereference_raw(node->slots[0]);
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800485 if (!child)
486 break;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800487
Matthew Wilcox66ee6202018-06-25 06:56:50 -0400488 /*
489 * For an IDR, we must not shrink entry 0 into the root in
490 * case somebody calls idr_replace() with a pointer that
491 * appears to be an internal entry
492 */
493 if (!node->shift && is_idr(root))
494 break;
495
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800496 if (radix_tree_is_internal_node(child))
497 entry_to_node(child)->parent = NULL;
498
499 /*
500 * We don't need rcu_assign_pointer(), since we are simply
501 * moving the node from one part of the tree to another: if it
502 * was safe to dereference the old pointer to it
503 * (node->slots[0]), it will be safe to dereference the new
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500504 * one (root->xa_head) as far as dependent read barriers go.
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800505 */
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500506 root->xa_head = (void __rcu *)child;
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500507 if (is_idr(root) && !tag_get(node, IDR_FREE, 0))
508 root_tag_clear(root, IDR_FREE);
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800509
510 /*
511 * We have a dilemma here. The node's slot[0] must not be
512 * NULLed in case there are concurrent lookups expecting to
513 * find the item. However if this was a bottom-level node,
514 * then it may be subject to the slot pointer being visible
515 * to callers dereferencing it. If item corresponding to
516 * slot[0] is subsequently deleted, these callers would expect
517 * their slot to become empty sooner or later.
518 *
519 * For example, lockless pagecache will look up a slot, deref
520 * the page pointer, and if the page has 0 refcount it means it
521 * was concurrently deleted from pagecache so try the deref
522 * again. Fortunately there is already a requirement for logic
523 * to retry the entire slot lookup -- the indirect pointer
524 * problem (replacing direct root node with an indirect pointer
525 * also results in a stale slot). So tag the slot as indirect
526 * to force callers to retry.
527 */
Johannes Weiner4d693d02016-12-12 16:43:49 -0800528 node->count = 0;
529 if (!radix_tree_is_internal_node(child)) {
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500530 node->slots[0] = (void __rcu *)RADIX_TREE_RETRY;
Johannes Weiner4d693d02016-12-12 16:43:49 -0800531 }
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800532
Johannes Weinerea07b862017-01-06 19:21:43 -0500533 WARN_ON_ONCE(!list_empty(&node->private_list));
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800534 radix_tree_node_free(node);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500535 shrunk = true;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800536 }
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500537
538 return shrunk;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800539}
540
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500541static bool delete_node(struct radix_tree_root *root,
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400542 struct radix_tree_node *node)
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800543{
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500544 bool deleted = false;
545
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800546 do {
547 struct radix_tree_node *parent;
548
549 if (node->count) {
Matthew Wilcox12320d02017-02-13 15:22:48 -0500550 if (node_to_entry(node) ==
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500551 rcu_dereference_raw(root->xa_head))
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400552 deleted |= radix_tree_shrink(root);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500553 return deleted;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800554 }
555
556 parent = node->parent;
557 if (parent) {
558 parent->slots[node->offset] = NULL;
559 parent->count--;
560 } else {
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500561 /*
562 * Shouldn't the tags already have all been cleared
563 * by the caller?
564 */
565 if (!is_idr(root))
566 root_tag_clear_all(root);
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500567 root->xa_head = NULL;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800568 }
569
Johannes Weinerea07b862017-01-06 19:21:43 -0500570 WARN_ON_ONCE(!list_empty(&node->private_list));
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800571 radix_tree_node_free(node);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500572 deleted = true;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800573
574 node = parent;
575 } while (node);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500576
577 return deleted;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800578}
579
580/**
Johannes Weiner139e5612014-04-03 14:47:54 -0700581 * __radix_tree_create - create a slot in a radix tree
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 * @root: radix tree root
583 * @index: index key
Johannes Weiner139e5612014-04-03 14:47:54 -0700584 * @nodep: returns node
585 * @slotp: returns slot
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 *
Johannes Weiner139e5612014-04-03 14:47:54 -0700587 * Create, if necessary, and return the node and slot for an item
588 * at position @index in the radix tree @root.
589 *
590 * Until there is more than one item in the tree, no nodes are
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500591 * allocated and @root->xa_head is used as a direct slot instead of
Johannes Weiner139e5612014-04-03 14:47:54 -0700592 * pointing to a node, in which case *@nodep will be NULL.
593 *
594 * Returns -ENOMEM, or 0 for success.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 */
Matthew Wilcox74d60952017-11-17 10:01:45 -0500596static int __radix_tree_create(struct radix_tree_root *root,
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400597 unsigned long index, struct radix_tree_node **nodep,
598 void __rcu ***slotp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599{
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700600 struct radix_tree_node *node = NULL, *child;
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500601 void __rcu **slot = (void __rcu **)&root->xa_head;
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700602 unsigned long maxindex;
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700603 unsigned int shift, offset = 0;
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400604 unsigned long max = index;
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500605 gfp_t gfp = root_gfp_mask(root);
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700606
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700607 shift = radix_tree_load_root(root, &child, &maxindex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
609 /* Make sure the tree is high enough. */
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700610 if (max > maxindex) {
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500611 int error = radix_tree_extend(root, gfp, max, shift);
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700612 if (error < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 return error;
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700614 shift = error;
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500615 child = rcu_dereference_raw(root->xa_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 }
617
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400618 while (shift > 0) {
Matthew Wilcoxc12e51b2016-05-20 17:03:10 -0700619 shift -= RADIX_TREE_MAP_SHIFT;
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700620 if (child == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 /* Have to add a child node. */
Matthew Wilcoxd58275b2017-01-16 17:10:21 -0500622 child = radix_tree_node_alloc(gfp, node, root, shift,
Matthew Wilcoxe8de4342016-12-14 15:09:31 -0800623 offset, 0, 0);
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700624 if (!child)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 return -ENOMEM;
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700626 rcu_assign_pointer(*slot, node_to_entry(child));
627 if (node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 node->count++;
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700629 } else if (!radix_tree_is_internal_node(child))
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700630 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
632 /* Go a level down */
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700633 node = entry_to_node(child);
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700634 offset = radix_tree_descend(node, &child, index);
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700635 slot = &node->slots[offset];
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700636 }
637
Johannes Weiner139e5612014-04-03 14:47:54 -0700638 if (nodep)
639 *nodep = node;
640 if (slotp)
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700641 *slotp = slot;
Johannes Weiner139e5612014-04-03 14:47:54 -0700642 return 0;
643}
644
Matthew Wilcox175542f2016-12-14 15:08:58 -0800645/*
646 * Free any nodes below this node. The tree is presumed to not need
647 * shrinking, and any user data in the tree is presumed to not need a
648 * destructor called on it. If we need to add a destructor, we can
649 * add that functionality later. Note that we may not clear tags or
650 * slots from the tree as an RCU walker may still have a pointer into
651 * this subtree. We could replace the entries with RADIX_TREE_RETRY,
652 * but we'll still have to clear those in rcu_free.
653 */
654static void radix_tree_free_nodes(struct radix_tree_node *node)
655{
656 unsigned offset = 0;
657 struct radix_tree_node *child = entry_to_node(node);
658
659 for (;;) {
Matthew Wilcox12320d02017-02-13 15:22:48 -0500660 void *entry = rcu_dereference_raw(child->slots[offset]);
Matthew Wilcox02c02bf2017-11-03 23:09:45 -0400661 if (xa_is_node(entry) && child->shift) {
Matthew Wilcox175542f2016-12-14 15:08:58 -0800662 child = entry_to_node(entry);
663 offset = 0;
664 continue;
665 }
666 offset++;
667 while (offset == RADIX_TREE_MAP_SIZE) {
668 struct radix_tree_node *old = child;
669 offset = child->offset + 1;
670 child = child->parent;
Matthew Wilcoxdd040b62017-01-24 15:18:16 -0800671 WARN_ON_ONCE(!list_empty(&old->private_list));
Matthew Wilcox175542f2016-12-14 15:08:58 -0800672 radix_tree_node_free(old);
673 if (old == entry_to_node(node))
674 return;
675 }
676 }
677}
678
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500679static inline int insert_entries(struct radix_tree_node *node,
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400680 void __rcu **slot, void *item, bool replace)
Matthew Wilcox175542f2016-12-14 15:08:58 -0800681{
682 if (*slot)
683 return -EEXIST;
684 rcu_assign_pointer(*slot, item);
685 if (node) {
686 node->count++;
Matthew Wilcox3159f942017-11-03 13:30:42 -0400687 if (xa_is_value(item))
Matthew Wilcox01959df2017-11-09 09:23:56 -0500688 node->nr_values++;
Matthew Wilcox175542f2016-12-14 15:08:58 -0800689 }
690 return 1;
691}
Matthew Wilcox175542f2016-12-14 15:08:58 -0800692
Johannes Weiner139e5612014-04-03 14:47:54 -0700693/**
Randy Dunlapc95c2d32021-04-16 15:46:26 -0700694 * radix_tree_insert - insert into a radix tree
Johannes Weiner139e5612014-04-03 14:47:54 -0700695 * @root: radix tree root
696 * @index: index key
697 * @item: item to insert
698 *
699 * Insert an item into the radix tree at position @index.
700 */
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400701int radix_tree_insert(struct radix_tree_root *root, unsigned long index,
702 void *item)
Johannes Weiner139e5612014-04-03 14:47:54 -0700703{
704 struct radix_tree_node *node;
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500705 void __rcu **slot;
Johannes Weiner139e5612014-04-03 14:47:54 -0700706 int error;
707
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700708 BUG_ON(radix_tree_is_internal_node(item));
Johannes Weiner139e5612014-04-03 14:47:54 -0700709
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400710 error = __radix_tree_create(root, index, &node, &slot);
Johannes Weiner139e5612014-04-03 14:47:54 -0700711 if (error)
712 return error;
Matthew Wilcox175542f2016-12-14 15:08:58 -0800713
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400714 error = insert_entries(node, slot, item, false);
Matthew Wilcox175542f2016-12-14 15:08:58 -0800715 if (error < 0)
716 return error;
Christoph Lameter201b6262005-09-06 15:16:46 -0700717
Nick Piggin612d6c12006-06-23 02:03:22 -0700718 if (node) {
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700719 unsigned offset = get_slot_offset(node, slot);
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700720 BUG_ON(tag_get(node, 0, offset));
721 BUG_ON(tag_get(node, 1, offset));
722 BUG_ON(tag_get(node, 2, offset));
Nick Piggin612d6c12006-06-23 02:03:22 -0700723 } else {
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700724 BUG_ON(root_tags_get(root));
Nick Piggin612d6c12006-06-23 02:03:22 -0700725 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 return 0;
728}
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400729EXPORT_SYMBOL(radix_tree_insert);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730
Johannes Weiner139e5612014-04-03 14:47:54 -0700731/**
732 * __radix_tree_lookup - lookup an item in a radix tree
733 * @root: radix tree root
734 * @index: index key
735 * @nodep: returns node
736 * @slotp: returns slot
737 *
738 * Lookup and return the item at position @index in the radix
739 * tree @root.
740 *
741 * Until there is more than one item in the tree, no nodes are
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500742 * allocated and @root->xa_head is used as a direct slot instead of
Johannes Weiner139e5612014-04-03 14:47:54 -0700743 * pointing to a node, in which case *@nodep will be NULL.
Hans Reisera4331362005-11-07 00:59:29 -0800744 */
Matthew Wilcox35534c82016-12-19 17:43:19 -0500745void *__radix_tree_lookup(const struct radix_tree_root *root,
746 unsigned long index, struct radix_tree_node **nodep,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500747 void __rcu ***slotp)
Hans Reisera4331362005-11-07 00:59:29 -0800748{
Johannes Weiner139e5612014-04-03 14:47:54 -0700749 struct radix_tree_node *node, *parent;
Matthew Wilcox85829952016-05-20 17:02:20 -0700750 unsigned long maxindex;
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500751 void __rcu **slot;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800752
Matthew Wilcox85829952016-05-20 17:02:20 -0700753 restart:
754 parent = NULL;
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500755 slot = (void __rcu **)&root->xa_head;
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700756 radix_tree_load_root(root, &node, &maxindex);
Matthew Wilcox85829952016-05-20 17:02:20 -0700757 if (index > maxindex)
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800758 return NULL;
759
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700760 while (radix_tree_is_internal_node(node)) {
Matthew Wilcox85829952016-05-20 17:02:20 -0700761 unsigned offset;
Johannes Weiner139e5612014-04-03 14:47:54 -0700762
Matthew Wilcox4dd6c092016-05-20 17:03:27 -0700763 parent = entry_to_node(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700764 offset = radix_tree_descend(parent, &node, index);
Matthew Wilcox85829952016-05-20 17:02:20 -0700765 slot = parent->slots + offset;
Matthew Wilcoxeff38602018-12-06 08:19:13 -0500766 if (node == RADIX_TREE_RETRY)
767 goto restart;
Matthew Wilcox66ee6202018-06-25 06:56:50 -0400768 if (parent->shift == 0)
769 break;
Matthew Wilcox85829952016-05-20 17:02:20 -0700770 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800771
Johannes Weiner139e5612014-04-03 14:47:54 -0700772 if (nodep)
773 *nodep = parent;
774 if (slotp)
775 *slotp = slot;
776 return node;
Huang Shijieb72b71c2009-06-16 15:33:42 -0700777}
778
779/**
780 * radix_tree_lookup_slot - lookup a slot in a radix tree
781 * @root: radix tree root
782 * @index: index key
783 *
784 * Returns: the slot corresponding to the position @index in the
785 * radix tree @root. This is useful for update-if-exists operations.
786 *
787 * This function can be called under rcu_read_lock iff the slot is not
788 * modified by radix_tree_replace_slot, otherwise it must be called
789 * exclusive from other writers. Any dereference of the slot must be done
790 * using radix_tree_deref_slot.
791 */
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500792void __rcu **radix_tree_lookup_slot(const struct radix_tree_root *root,
Matthew Wilcox35534c82016-12-19 17:43:19 -0500793 unsigned long index)
Huang Shijieb72b71c2009-06-16 15:33:42 -0700794{
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500795 void __rcu **slot;
Johannes Weiner139e5612014-04-03 14:47:54 -0700796
797 if (!__radix_tree_lookup(root, index, NULL, &slot))
798 return NULL;
799 return slot;
Hans Reisera4331362005-11-07 00:59:29 -0800800}
801EXPORT_SYMBOL(radix_tree_lookup_slot);
802
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803/**
804 * radix_tree_lookup - perform lookup operation on a radix tree
805 * @root: radix tree root
806 * @index: index key
807 *
808 * Lookup the item at the position @index in the radix tree @root.
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800809 *
810 * This function can be called under rcu_read_lock, however the caller
811 * must manage lifetimes of leaf nodes (eg. RCU may also be used to free
812 * them safely). No RCU barriers are required to access or modify the
813 * returned item, however.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 */
Matthew Wilcox35534c82016-12-19 17:43:19 -0500815void *radix_tree_lookup(const struct radix_tree_root *root, unsigned long index)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816{
Johannes Weiner139e5612014-04-03 14:47:54 -0700817 return __radix_tree_lookup(root, index, NULL, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818}
819EXPORT_SYMBOL(radix_tree_lookup);
820
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500821static void replace_slot(void __rcu **slot, void *item,
Matthew Wilcox01959df2017-11-09 09:23:56 -0500822 struct radix_tree_node *node, int count, int values)
Johannes Weiner6d75f362016-12-12 16:43:43 -0800823{
Matthew Wilcox01959df2017-11-09 09:23:56 -0500824 if (node && (count || values)) {
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800825 node->count += count;
Matthew Wilcox01959df2017-11-09 09:23:56 -0500826 node->nr_values += values;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800827 }
Johannes Weiner6d75f362016-12-12 16:43:43 -0800828
829 rcu_assign_pointer(*slot, item);
830}
831
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500832static bool node_tag_get(const struct radix_tree_root *root,
833 const struct radix_tree_node *node,
834 unsigned int tag, unsigned int offset)
Matthew Wilcoxa90eb3a2016-12-14 15:09:07 -0800835{
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500836 if (node)
837 return tag_get(node, tag, offset);
838 return root_tag_get(root, tag);
839}
Matthew Wilcoxa90eb3a2016-12-14 15:09:07 -0800840
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500841/*
842 * IDR users want to be able to store NULL in the tree, so if the slot isn't
843 * free, don't adjust the count, even if it's transitioning between NULL and
844 * non-NULL. For the IDA, we mark slots as being IDR_FREE while they still
845 * have empty bits, but it only stores NULL in slots when they're being
846 * deleted.
847 */
848static int calculate_count(struct radix_tree_root *root,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500849 struct radix_tree_node *node, void __rcu **slot,
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500850 void *item, void *old)
851{
852 if (is_idr(root)) {
853 unsigned offset = get_slot_offset(node, slot);
854 bool free = node_tag_get(root, node, IDR_FREE, offset);
855 if (!free)
856 return 0;
857 if (!old)
858 return 1;
Matthew Wilcoxa90eb3a2016-12-14 15:09:07 -0800859 }
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500860 return !!item - !!old;
Matthew Wilcoxa90eb3a2016-12-14 15:09:07 -0800861}
862
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863/**
Johannes Weinerf7942432016-12-12 16:43:41 -0800864 * __radix_tree_replace - replace item in a slot
Johannes Weiner4d693d02016-12-12 16:43:49 -0800865 * @root: radix tree root
866 * @node: pointer to tree node
867 * @slot: pointer to slot in @node
868 * @item: new item to store in the slot.
Johannes Weinerf7942432016-12-12 16:43:41 -0800869 *
870 * For use with __radix_tree_lookup(). Caller must hold tree write locked
871 * across slot lookup and replacement.
872 */
873void __radix_tree_replace(struct radix_tree_root *root,
874 struct radix_tree_node *node,
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400875 void __rcu **slot, void *item)
Johannes Weinerf7942432016-12-12 16:43:41 -0800876{
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500877 void *old = rcu_dereference_raw(*slot);
Matthew Wilcox01959df2017-11-09 09:23:56 -0500878 int values = !!xa_is_value(item) - !!xa_is_value(old);
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500879 int count = calculate_count(root, node, slot, item, old);
880
Johannes Weiner6d75f362016-12-12 16:43:43 -0800881 /*
Matthew Wilcox01959df2017-11-09 09:23:56 -0500882 * This function supports replacing value entries and
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800883 * deleting entries, but that needs accounting against the
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500884 * node unless the slot is root->xa_head.
Johannes Weiner6d75f362016-12-12 16:43:43 -0800885 */
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500886 WARN_ON_ONCE(!node && (slot != (void __rcu **)&root->xa_head) &&
Matthew Wilcox01959df2017-11-09 09:23:56 -0500887 (count || values));
888 replace_slot(slot, item, node, count, values);
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800889
Johannes Weiner4d693d02016-12-12 16:43:49 -0800890 if (!node)
891 return;
892
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400893 delete_node(root, node);
Johannes Weiner6d75f362016-12-12 16:43:43 -0800894}
Johannes Weinerf7942432016-12-12 16:43:41 -0800895
Johannes Weiner6d75f362016-12-12 16:43:43 -0800896/**
897 * radix_tree_replace_slot - replace item in a slot
898 * @root: radix tree root
899 * @slot: pointer to slot
900 * @item: new item to store in the slot.
901 *
Matthew Wilcox7b8d0462017-12-01 22:13:06 -0500902 * For use with radix_tree_lookup_slot() and
Johannes Weiner6d75f362016-12-12 16:43:43 -0800903 * radix_tree_gang_lookup_tag_slot(). Caller must hold tree write locked
904 * across slot lookup and replacement.
905 *
906 * NOTE: This cannot be used to switch between non-entries (empty slots),
Matthew Wilcox01959df2017-11-09 09:23:56 -0500907 * regular entries, and value entries, as that requires accounting
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800908 * inside the radix tree node. When switching from one type of entry or
Matthew Wilcoxe157b552016-12-14 15:09:01 -0800909 * deleting, use __radix_tree_lookup() and __radix_tree_replace() or
910 * radix_tree_iter_replace().
Johannes Weiner6d75f362016-12-12 16:43:43 -0800911 */
912void radix_tree_replace_slot(struct radix_tree_root *root,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500913 void __rcu **slot, void *item)
Johannes Weiner6d75f362016-12-12 16:43:43 -0800914{
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400915 __radix_tree_replace(root, NULL, slot, item);
Johannes Weinerf7942432016-12-12 16:43:41 -0800916}
Song Liu10257d72017-01-11 10:00:51 -0800917EXPORT_SYMBOL(radix_tree_replace_slot);
Johannes Weinerf7942432016-12-12 16:43:41 -0800918
Matthew Wilcoxe157b552016-12-14 15:09:01 -0800919/**
920 * radix_tree_iter_replace - replace item in a slot
921 * @root: radix tree root
Randy Dunlapc95c2d32021-04-16 15:46:26 -0700922 * @iter: iterator state
Matthew Wilcoxe157b552016-12-14 15:09:01 -0800923 * @slot: pointer to slot
924 * @item: new item to store in the slot.
925 *
Matthew Wilcox2956c662018-05-19 16:47:47 -0400926 * For use with radix_tree_for_each_slot().
927 * Caller must hold tree write locked.
Matthew Wilcoxe157b552016-12-14 15:09:01 -0800928 */
929void radix_tree_iter_replace(struct radix_tree_root *root,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500930 const struct radix_tree_iter *iter,
931 void __rcu **slot, void *item)
Matthew Wilcoxe157b552016-12-14 15:09:01 -0800932{
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400933 __radix_tree_replace(root, iter->node, slot, item);
Matthew Wilcoxe157b552016-12-14 15:09:01 -0800934}
935
Matthew Wilcox30b888b2017-01-28 09:55:20 -0500936static void node_tag_set(struct radix_tree_root *root,
937 struct radix_tree_node *node,
938 unsigned int tag, unsigned int offset)
939{
940 while (node) {
941 if (tag_get(node, tag, offset))
942 return;
943 tag_set(node, tag, offset);
944 offset = node->offset;
945 node = node->parent;
946 }
947
948 if (!root_tag_get(root, tag))
949 root_tag_set(root, tag);
950}
951
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952/**
953 * radix_tree_tag_set - set a tag on a radix tree node
954 * @root: radix tree root
955 * @index: index key
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700956 * @tag: tag index
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 *
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800958 * Set the search tag (which must be < RADIX_TREE_MAX_TAGS)
959 * corresponding to @index in the radix tree. From
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 * the root all the way down to the leaf node.
961 *
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700962 * Returns the address of the tagged item. Setting a tag on a not-present
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 * item is a bug.
964 */
965void *radix_tree_tag_set(struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800966 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967{
Ross Zwislerfb969902016-05-20 17:02:32 -0700968 struct radix_tree_node *node, *parent;
969 unsigned long maxindex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700971 radix_tree_load_root(root, &node, &maxindex);
Ross Zwislerfb969902016-05-20 17:02:32 -0700972 BUG_ON(index > maxindex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700974 while (radix_tree_is_internal_node(node)) {
Ross Zwislerfb969902016-05-20 17:02:32 -0700975 unsigned offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976
Matthew Wilcox4dd6c092016-05-20 17:03:27 -0700977 parent = entry_to_node(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700978 offset = radix_tree_descend(parent, &node, index);
Ross Zwislerfb969902016-05-20 17:02:32 -0700979 BUG_ON(!node);
980
981 if (!tag_get(parent, tag, offset))
982 tag_set(parent, tag, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 }
984
Nick Piggin612d6c12006-06-23 02:03:22 -0700985 /* set the root's tag bit */
Ross Zwislerfb969902016-05-20 17:02:32 -0700986 if (!root_tag_get(root, tag))
Nick Piggin612d6c12006-06-23 02:03:22 -0700987 root_tag_set(root, tag);
988
Ross Zwislerfb969902016-05-20 17:02:32 -0700989 return node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990}
991EXPORT_SYMBOL(radix_tree_tag_set);
992
Matthew Wilcoxd604c322016-05-20 17:03:45 -0700993static void node_tag_clear(struct radix_tree_root *root,
994 struct radix_tree_node *node,
995 unsigned int tag, unsigned int offset)
996{
997 while (node) {
998 if (!tag_get(node, tag, offset))
999 return;
1000 tag_clear(node, tag, offset);
1001 if (any_tag_set(node, tag))
1002 return;
1003
1004 offset = node->offset;
1005 node = node->parent;
1006 }
1007
1008 /* clear the root's tag bit */
1009 if (root_tag_get(root, tag))
1010 root_tag_clear(root, tag);
1011}
1012
Matthew Wilcox268f42d2016-12-14 15:08:55 -08001013/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 * radix_tree_tag_clear - clear a tag on a radix tree node
1015 * @root: radix tree root
1016 * @index: index key
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001017 * @tag: tag index
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 *
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001019 * Clear the search tag (which must be < RADIX_TREE_MAX_TAGS)
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001020 * corresponding to @index in the radix tree. If this causes
1021 * the leaf node to have no tags set then clear the tag in the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022 * next-to-leaf node, etc.
1023 *
1024 * Returns the address of the tagged item on success, else NULL. ie:
1025 * has the same return value and semantics as radix_tree_lookup().
1026 */
1027void *radix_tree_tag_clear(struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001028 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029{
Ross Zwisler00f47b52016-05-20 17:02:35 -07001030 struct radix_tree_node *node, *parent;
1031 unsigned long maxindex;
Kees Cook3f649ab2020-06-03 13:09:38 -07001032 int offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001034 radix_tree_load_root(root, &node, &maxindex);
Ross Zwisler00f47b52016-05-20 17:02:35 -07001035 if (index > maxindex)
1036 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037
Ross Zwisler00f47b52016-05-20 17:02:35 -07001038 parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039
Matthew Wilcoxb194d162016-05-20 17:03:30 -07001040 while (radix_tree_is_internal_node(node)) {
Matthew Wilcox4dd6c092016-05-20 17:03:27 -07001041 parent = entry_to_node(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001042 offset = radix_tree_descend(parent, &node, index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 }
1044
Matthew Wilcoxd604c322016-05-20 17:03:45 -07001045 if (node)
1046 node_tag_clear(root, parent, tag, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047
Ross Zwisler00f47b52016-05-20 17:02:35 -07001048 return node;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049}
1050EXPORT_SYMBOL(radix_tree_tag_clear);
1051
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052/**
Matthew Wilcox30b888b2017-01-28 09:55:20 -05001053 * radix_tree_iter_tag_clear - clear a tag on the current iterator entry
1054 * @root: radix tree root
1055 * @iter: iterator state
1056 * @tag: tag to clear
1057 */
1058void radix_tree_iter_tag_clear(struct radix_tree_root *root,
1059 const struct radix_tree_iter *iter, unsigned int tag)
1060{
1061 node_tag_clear(root, iter->node, tag, iter_offset(iter));
1062}
1063
1064/**
Marcelo Tosatti32605a12005-09-06 15:16:48 -07001065 * radix_tree_tag_get - get a tag on a radix tree node
1066 * @root: radix tree root
1067 * @index: index key
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001068 * @tag: tag index (< RADIX_TREE_MAX_TAGS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 *
Marcelo Tosatti32605a12005-09-06 15:16:48 -07001070 * Return values:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 *
Nick Piggin612d6c12006-06-23 02:03:22 -07001072 * 0: tag not present or not set
1073 * 1: tag set
David Howellsce826532010-04-06 22:36:20 +01001074 *
1075 * Note that the return value of this function may not be relied on, even if
1076 * the RCU lock is held, unless tag modification and node deletion are excluded
1077 * from concurrency.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078 */
Matthew Wilcox35534c82016-12-19 17:43:19 -05001079int radix_tree_tag_get(const struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001080 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081{
Ross Zwisler4589ba62016-05-20 17:02:38 -07001082 struct radix_tree_node *node, *parent;
1083 unsigned long maxindex;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084
Nick Piggin612d6c12006-06-23 02:03:22 -07001085 if (!root_tag_get(root, tag))
1086 return 0;
1087
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001088 radix_tree_load_root(root, &node, &maxindex);
Ross Zwisler4589ba62016-05-20 17:02:38 -07001089 if (index > maxindex)
1090 return 0;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001091
Matthew Wilcoxb194d162016-05-20 17:03:30 -07001092 while (radix_tree_is_internal_node(node)) {
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001093 unsigned offset;
Ross Zwisler4589ba62016-05-20 17:02:38 -07001094
Matthew Wilcox4dd6c092016-05-20 17:03:27 -07001095 parent = entry_to_node(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001096 offset = radix_tree_descend(parent, &node, index);
Ross Zwisler4589ba62016-05-20 17:02:38 -07001097
Ross Zwisler4589ba62016-05-20 17:02:38 -07001098 if (!tag_get(parent, tag, offset))
1099 return 0;
1100 if (node == RADIX_TREE_RETRY)
1101 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102 }
Ross Zwisler4589ba62016-05-20 17:02:38 -07001103
1104 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105}
1106EXPORT_SYMBOL(radix_tree_tag_get);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107
Matthew Wilcox148deab2016-12-14 15:08:49 -08001108/* Construct iter->tags bit-mask from node->tags[tag] array */
1109static void set_iter_tags(struct radix_tree_iter *iter,
1110 struct radix_tree_node *node, unsigned offset,
1111 unsigned tag)
1112{
1113 unsigned tag_long = offset / BITS_PER_LONG;
1114 unsigned tag_bit = offset % BITS_PER_LONG;
1115
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001116 if (!node) {
1117 iter->tags = 1;
1118 return;
1119 }
1120
Matthew Wilcox148deab2016-12-14 15:08:49 -08001121 iter->tags = node->tags[tag][tag_long] >> tag_bit;
1122
1123 /* This never happens if RADIX_TREE_TAG_LONGS == 1 */
1124 if (tag_long < RADIX_TREE_TAG_LONGS - 1) {
1125 /* Pick tags from next element */
1126 if (tag_bit)
1127 iter->tags |= node->tags[tag][tag_long + 1] <<
1128 (BITS_PER_LONG - tag_bit);
1129 /* Clip chunk size, here only BITS_PER_LONG tags */
1130 iter->next_index = __radix_tree_iter_add(iter, BITS_PER_LONG);
1131 }
1132}
1133
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001134void __rcu **radix_tree_iter_resume(void __rcu **slot,
1135 struct radix_tree_iter *iter)
Matthew Wilcox148deab2016-12-14 15:08:49 -08001136{
Matthew Wilcox148deab2016-12-14 15:08:49 -08001137 slot++;
1138 iter->index = __radix_tree_iter_add(iter, 1);
Matthew Wilcox148deab2016-12-14 15:08:49 -08001139 iter->next_index = iter->index;
1140 iter->tags = 0;
1141 return NULL;
1142}
1143EXPORT_SYMBOL(radix_tree_iter_resume);
1144
Fengguang Wu6df8ba42007-10-16 01:24:33 -07001145/**
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001146 * radix_tree_next_chunk - find next chunk of slots for iteration
1147 *
1148 * @root: radix tree root
1149 * @iter: iterator state
1150 * @flags: RADIX_TREE_ITER_* flags and tag index
1151 * Returns: pointer to chunk first slot, or NULL if iteration is over
1152 */
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001153void __rcu **radix_tree_next_chunk(const struct radix_tree_root *root,
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001154 struct radix_tree_iter *iter, unsigned flags)
1155{
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001156 unsigned tag = flags & RADIX_TREE_ITER_TAG_MASK;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001157 struct radix_tree_node *node, *child;
Ross Zwisler21ef5332016-05-20 17:02:26 -07001158 unsigned long index, offset, maxindex;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001159
1160 if ((flags & RADIX_TREE_ITER_TAGGED) && !root_tag_get(root, tag))
1161 return NULL;
1162
1163 /*
1164 * Catch next_index overflow after ~0UL. iter->index never overflows
1165 * during iterating; it can be zero only at the beginning.
1166 * And we cannot overflow iter->next_index in a single step,
1167 * because RADIX_TREE_MAP_SHIFT < BITS_PER_LONG.
Konstantin Khlebnikovfffaee32012-06-05 21:36:33 +04001168 *
1169 * This condition also used by radix_tree_next_slot() to stop
Matthew Wilcox91b9677c2016-12-14 15:08:31 -08001170 * contiguous iterating, and forbid switching to the next chunk.
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001171 */
1172 index = iter->next_index;
1173 if (!index && iter->index)
1174 return NULL;
1175
Ross Zwisler21ef5332016-05-20 17:02:26 -07001176 restart:
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001177 radix_tree_load_root(root, &child, &maxindex);
Ross Zwisler21ef5332016-05-20 17:02:26 -07001178 if (index > maxindex)
1179 return NULL;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001180 if (!child)
1181 return NULL;
Ross Zwisler21ef5332016-05-20 17:02:26 -07001182
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001183 if (!radix_tree_is_internal_node(child)) {
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001184 /* Single-slot tree */
Ross Zwisler21ef5332016-05-20 17:02:26 -07001185 iter->index = index;
1186 iter->next_index = maxindex + 1;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001187 iter->tags = 1;
Matthew Wilcox268f42d2016-12-14 15:08:55 -08001188 iter->node = NULL;
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -05001189 return (void __rcu **)&root->xa_head;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001190 }
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001191
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001192 do {
1193 node = entry_to_node(child);
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001194 offset = radix_tree_descend(node, &child, index);
Ross Zwisler21ef5332016-05-20 17:02:26 -07001195
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001196 if ((flags & RADIX_TREE_ITER_TAGGED) ?
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001197 !tag_get(node, tag, offset) : !child) {
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001198 /* Hole detected */
1199 if (flags & RADIX_TREE_ITER_CONTIG)
1200 return NULL;
1201
1202 if (flags & RADIX_TREE_ITER_TAGGED)
Matthew Wilcoxbc412fc2016-12-14 15:08:40 -08001203 offset = radix_tree_find_next_bit(node, tag,
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001204 offset + 1);
1205 else
1206 while (++offset < RADIX_TREE_MAP_SIZE) {
Matthew Wilcox12320d02017-02-13 15:22:48 -05001207 void *slot = rcu_dereference_raw(
1208 node->slots[offset]);
Ross Zwisler21ef5332016-05-20 17:02:26 -07001209 if (slot)
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001210 break;
1211 }
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001212 index &= ~node_maxindex(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001213 index += offset << node->shift;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001214 /* Overflow after ~0UL */
1215 if (!index)
1216 return NULL;
1217 if (offset == RADIX_TREE_MAP_SIZE)
1218 goto restart;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001219 child = rcu_dereference_raw(node->slots[offset]);
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001220 }
1221
Matthew Wilcoxe157b552016-12-14 15:09:01 -08001222 if (!child)
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001223 goto restart;
Matthew Wilcoxe157b552016-12-14 15:09:01 -08001224 if (child == RADIX_TREE_RETRY)
1225 break;
Matthew Wilcox66ee6202018-06-25 06:56:50 -04001226 } while (node->shift && radix_tree_is_internal_node(child));
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001227
1228 /* Update the iterator state */
Matthew Wilcox3a08cd52018-09-22 16:14:30 -04001229 iter->index = (index &~ node_maxindex(node)) | offset;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001230 iter->next_index = (index | node_maxindex(node)) + 1;
Matthew Wilcox268f42d2016-12-14 15:08:55 -08001231 iter->node = node;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001232
Matthew Wilcox148deab2016-12-14 15:08:49 -08001233 if (flags & RADIX_TREE_ITER_TAGGED)
1234 set_iter_tags(iter, node, offset, tag);
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001235
1236 return node->slots + offset;
1237}
1238EXPORT_SYMBOL(radix_tree_next_chunk);
1239
1240/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 * radix_tree_gang_lookup - perform multiple lookup on a radix tree
1242 * @root: radix tree root
1243 * @results: where the results of the lookup are placed
1244 * @first_index: start the lookup from this key
1245 * @max_items: place up to this many items at *results
1246 *
1247 * Performs an index-ascending scan of the tree for present items. Places
1248 * them at *@results and returns the number of items which were placed at
1249 * *@results.
1250 *
1251 * The implementation is naive.
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001252 *
1253 * Like radix_tree_lookup, radix_tree_gang_lookup may be called under
1254 * rcu_read_lock. In this case, rather than the returned results being
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001255 * an atomic snapshot of the tree at a single point in time, the
1256 * semantics of an RCU protected gang lookup are as though multiple
1257 * radix_tree_lookups have been issued in individual locks, and results
1258 * stored in 'results'.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259 */
1260unsigned int
Matthew Wilcox35534c82016-12-19 17:43:19 -05001261radix_tree_gang_lookup(const struct radix_tree_root *root, void **results,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 unsigned long first_index, unsigned int max_items)
1263{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001264 struct radix_tree_iter iter;
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001265 void __rcu **slot;
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001266 unsigned int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001268 if (unlikely(!max_items))
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001269 return 0;
1270
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001271 radix_tree_for_each_slot(slot, root, &iter, first_index) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001272 results[ret] = rcu_dereference_raw(*slot);
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001273 if (!results[ret])
1274 continue;
Matthew Wilcoxb194d162016-05-20 17:03:30 -07001275 if (radix_tree_is_internal_node(results[ret])) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001276 slot = radix_tree_iter_retry(&iter);
1277 continue;
1278 }
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001279 if (++ret == max_items)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001282
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 return ret;
1284}
1285EXPORT_SYMBOL(radix_tree_gang_lookup);
1286
Nick Piggin47feff22008-07-25 19:45:29 -07001287/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 * radix_tree_gang_lookup_tag - perform multiple lookup on a radix tree
1289 * based on a tag
1290 * @root: radix tree root
1291 * @results: where the results of the lookup are placed
1292 * @first_index: start the lookup from this key
1293 * @max_items: place up to this many items at *results
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001294 * @tag: the tag index (< RADIX_TREE_MAX_TAGS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295 *
1296 * Performs an index-ascending scan of the tree for present items which
1297 * have the tag indexed by @tag set. Places the items at *@results and
1298 * returns the number of items which were placed at *@results.
1299 */
1300unsigned int
Matthew Wilcox35534c82016-12-19 17:43:19 -05001301radix_tree_gang_lookup_tag(const struct radix_tree_root *root, void **results,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001302 unsigned long first_index, unsigned int max_items,
1303 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001305 struct radix_tree_iter iter;
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001306 void __rcu **slot;
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001307 unsigned int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001309 if (unlikely(!max_items))
Nick Piggin612d6c12006-06-23 02:03:22 -07001310 return 0;
1311
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001312 radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001313 results[ret] = rcu_dereference_raw(*slot);
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001314 if (!results[ret])
1315 continue;
Matthew Wilcoxb194d162016-05-20 17:03:30 -07001316 if (radix_tree_is_internal_node(results[ret])) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001317 slot = radix_tree_iter_retry(&iter);
1318 continue;
1319 }
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001320 if (++ret == max_items)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001323
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 return ret;
1325}
1326EXPORT_SYMBOL(radix_tree_gang_lookup_tag);
1327
1328/**
Nick Piggin47feff22008-07-25 19:45:29 -07001329 * radix_tree_gang_lookup_tag_slot - perform multiple slot lookup on a
1330 * radix tree based on a tag
1331 * @root: radix tree root
1332 * @results: where the results of the lookup are placed
1333 * @first_index: start the lookup from this key
1334 * @max_items: place up to this many items at *results
1335 * @tag: the tag index (< RADIX_TREE_MAX_TAGS)
1336 *
1337 * Performs an index-ascending scan of the tree for present items which
1338 * have the tag indexed by @tag set. Places the slots at *@results and
1339 * returns the number of slots which were placed at *@results.
1340 */
1341unsigned int
Matthew Wilcox35534c82016-12-19 17:43:19 -05001342radix_tree_gang_lookup_tag_slot(const struct radix_tree_root *root,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001343 void __rcu ***results, unsigned long first_index,
Matthew Wilcox35534c82016-12-19 17:43:19 -05001344 unsigned int max_items, unsigned int tag)
Nick Piggin47feff22008-07-25 19:45:29 -07001345{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001346 struct radix_tree_iter iter;
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001347 void __rcu **slot;
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001348 unsigned int ret = 0;
Nick Piggin47feff22008-07-25 19:45:29 -07001349
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001350 if (unlikely(!max_items))
Nick Piggin47feff22008-07-25 19:45:29 -07001351 return 0;
1352
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001353 radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
1354 results[ret] = slot;
1355 if (++ret == max_items)
Nick Piggin47feff22008-07-25 19:45:29 -07001356 break;
Nick Piggin47feff22008-07-25 19:45:29 -07001357 }
1358
1359 return ret;
1360}
1361EXPORT_SYMBOL(radix_tree_gang_lookup_tag_slot);
1362
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001363static bool __radix_tree_delete(struct radix_tree_root *root,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001364 struct radix_tree_node *node, void __rcu **slot)
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001365{
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001366 void *old = rcu_dereference_raw(*slot);
Matthew Wilcox01959df2017-11-09 09:23:56 -05001367 int values = xa_is_value(old) ? -1 : 0;
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001368 unsigned offset = get_slot_offset(node, slot);
1369 int tag;
1370
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001371 if (is_idr(root))
1372 node_tag_set(root, node, IDR_FREE, offset);
1373 else
1374 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++)
1375 node_tag_clear(root, node, tag, offset);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001376
Matthew Wilcox01959df2017-11-09 09:23:56 -05001377 replace_slot(slot, NULL, node, -1, values);
Matthew Wilcox1cf56f92018-04-09 16:24:45 -04001378 return node && delete_node(root, node);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001379}
1380
Johannes Weiner139e5612014-04-03 14:47:54 -07001381/**
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001382 * radix_tree_iter_delete - delete the entry at this iterator position
1383 * @root: radix tree root
1384 * @iter: iterator state
1385 * @slot: pointer to slot
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 *
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001387 * Delete the entry at the position currently pointed to by the iterator.
1388 * This may result in the current node being freed; if it is, the iterator
1389 * is advanced so that it will not reference the freed memory. This
1390 * function may be called without any locking if there are no other threads
1391 * which can access this tree.
1392 */
1393void radix_tree_iter_delete(struct radix_tree_root *root,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001394 struct radix_tree_iter *iter, void __rcu **slot)
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001395{
1396 if (__radix_tree_delete(root, iter->node, slot))
1397 iter->index = iter->next_index;
1398}
Chris Wilsond1b48c12017-08-16 09:52:08 +01001399EXPORT_SYMBOL(radix_tree_iter_delete);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001400
1401/**
1402 * radix_tree_delete_item - delete an item from a radix tree
1403 * @root: radix tree root
1404 * @index: index key
1405 * @item: expected item
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406 *
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001407 * Remove @item at @index from the radix tree rooted at @root.
1408 *
1409 * Return: the deleted entry, or %NULL if it was not present
1410 * or the entry at the given @index was not @item.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411 */
Johannes Weiner53c59f22014-04-03 14:47:39 -07001412void *radix_tree_delete_item(struct radix_tree_root *root,
1413 unsigned long index, void *item)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414{
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001415 struct radix_tree_node *node = NULL;
Matthew Wilcox7a4deea2018-05-25 14:47:24 -07001416 void __rcu **slot = NULL;
Johannes Weiner139e5612014-04-03 14:47:54 -07001417 void *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418
Johannes Weiner139e5612014-04-03 14:47:54 -07001419 entry = __radix_tree_lookup(root, index, &node, &slot);
Matthew Wilcox7a4deea2018-05-25 14:47:24 -07001420 if (!slot)
1421 return NULL;
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001422 if (!entry && (!is_idr(root) || node_tag_get(root, node, IDR_FREE,
1423 get_slot_offset(node, slot))))
Johannes Weiner139e5612014-04-03 14:47:54 -07001424 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425
Johannes Weiner139e5612014-04-03 14:47:54 -07001426 if (item && entry != item)
1427 return NULL;
1428
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001429 __radix_tree_delete(root, node, slot);
Christoph Lameter201b6262005-09-06 15:16:46 -07001430
Johannes Weiner139e5612014-04-03 14:47:54 -07001431 return entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432}
Johannes Weiner53c59f22014-04-03 14:47:39 -07001433EXPORT_SYMBOL(radix_tree_delete_item);
1434
1435/**
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001436 * radix_tree_delete - delete an entry from a radix tree
1437 * @root: radix tree root
1438 * @index: index key
Johannes Weiner53c59f22014-04-03 14:47:39 -07001439 *
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001440 * Remove the entry at @index from the radix tree rooted at @root.
Johannes Weiner53c59f22014-04-03 14:47:39 -07001441 *
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001442 * Return: The deleted entry, or %NULL if it was not present.
Johannes Weiner53c59f22014-04-03 14:47:39 -07001443 */
1444void *radix_tree_delete(struct radix_tree_root *root, unsigned long index)
1445{
1446 return radix_tree_delete_item(root, index, NULL);
1447}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448EXPORT_SYMBOL(radix_tree_delete);
1449
1450/**
1451 * radix_tree_tagged - test whether any items in the tree are tagged
1452 * @root: radix tree root
1453 * @tag: tag to test
1454 */
Matthew Wilcox35534c82016-12-19 17:43:19 -05001455int radix_tree_tagged(const struct radix_tree_root *root, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456{
Nick Piggin612d6c12006-06-23 02:03:22 -07001457 return root_tag_get(root, tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458}
1459EXPORT_SYMBOL(radix_tree_tagged);
1460
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001461/**
1462 * idr_preload - preload for idr_alloc()
1463 * @gfp_mask: allocation mask to use for preloading
1464 *
1465 * Preallocate memory to use for the next call to idr_alloc(). This function
1466 * returns with preemption disabled. It will be enabled by idr_preload_end().
1467 */
1468void idr_preload(gfp_t gfp_mask)
1469{
Eric Dumazetbc9ae222017-09-08 16:15:54 -07001470 if (__radix_tree_preload(gfp_mask, IDR_PRELOAD_SIZE))
Sebastian Andrzej Siewiorcfa67052020-05-27 22:11:14 +02001471 local_lock(&radix_tree_preloads.lock);
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001472}
1473EXPORT_SYMBOL(idr_preload);
1474
Matthew Wilcox460488c2017-11-28 15:16:24 -05001475void __rcu **idr_get_free(struct radix_tree_root *root,
Chris Mi388f79f2017-08-30 02:31:57 -04001476 struct radix_tree_iter *iter, gfp_t gfp,
1477 unsigned long max)
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001478{
1479 struct radix_tree_node *node = NULL, *child;
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -05001480 void __rcu **slot = (void __rcu **)&root->xa_head;
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001481 unsigned long maxindex, start = iter->next_index;
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001482 unsigned int shift, offset = 0;
1483
1484 grow:
1485 shift = radix_tree_load_root(root, &child, &maxindex);
1486 if (!radix_tree_tagged(root, IDR_FREE))
1487 start = max(start, maxindex + 1);
1488 if (start > max)
1489 return ERR_PTR(-ENOSPC);
1490
1491 if (start > maxindex) {
1492 int error = radix_tree_extend(root, gfp, start, shift);
1493 if (error < 0)
1494 return ERR_PTR(error);
1495 shift = error;
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -05001496 child = rcu_dereference_raw(root->xa_head);
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001497 }
Matthew Wilcox66ee6202018-06-25 06:56:50 -04001498 if (start == 0 && shift == 0)
1499 shift = RADIX_TREE_MAP_SHIFT;
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001500
1501 while (shift) {
1502 shift -= RADIX_TREE_MAP_SHIFT;
1503 if (child == NULL) {
1504 /* Have to add a child node. */
Matthew Wilcoxd58275b2017-01-16 17:10:21 -05001505 child = radix_tree_node_alloc(gfp, node, root, shift,
1506 offset, 0, 0);
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001507 if (!child)
1508 return ERR_PTR(-ENOMEM);
1509 all_tag_set(child, IDR_FREE);
1510 rcu_assign_pointer(*slot, node_to_entry(child));
1511 if (node)
1512 node->count++;
1513 } else if (!radix_tree_is_internal_node(child))
1514 break;
1515
1516 node = entry_to_node(child);
1517 offset = radix_tree_descend(node, &child, start);
1518 if (!tag_get(node, IDR_FREE, offset)) {
1519 offset = radix_tree_find_next_bit(node, IDR_FREE,
1520 offset + 1);
1521 start = next_index(start, node, offset);
Matthew Wilcox (Oracle)b7e9728f2019-11-02 00:25:08 -04001522 if (start > max || start == 0)
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001523 return ERR_PTR(-ENOSPC);
1524 while (offset == RADIX_TREE_MAP_SIZE) {
1525 offset = node->offset + 1;
1526 node = node->parent;
1527 if (!node)
1528 goto grow;
1529 shift = node->shift;
1530 }
1531 child = rcu_dereference_raw(node->slots[offset]);
1532 }
1533 slot = &node->slots[offset];
1534 }
1535
1536 iter->index = start;
1537 if (node)
1538 iter->next_index = 1 + min(max, (start | node_maxindex(node)));
1539 else
1540 iter->next_index = 1;
1541 iter->node = node;
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001542 set_iter_tags(iter, node, offset, IDR_FREE);
1543
1544 return slot;
1545}
1546
1547/**
1548 * idr_destroy - release all internal memory from an IDR
1549 * @idr: idr handle
1550 *
1551 * After this function is called, the IDR is empty, and may be reused or
1552 * the data structure containing it may be freed.
1553 *
1554 * A typical clean-up sequence for objects stored in an idr tree will use
1555 * idr_for_each() to free all objects, if necessary, then idr_destroy() to
1556 * free the memory used to keep track of those objects.
1557 */
1558void idr_destroy(struct idr *idr)
1559{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -05001560 struct radix_tree_node *node = rcu_dereference_raw(idr->idr_rt.xa_head);
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001561 if (radix_tree_is_internal_node(node))
1562 radix_tree_free_nodes(node);
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -05001563 idr->idr_rt.xa_head = NULL;
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001564 root_tag_set(&idr->idr_rt, IDR_FREE);
1565}
1566EXPORT_SYMBOL(idr_destroy);
1567
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568static void
Johannes Weiner449dd692014-04-03 14:47:56 -07001569radix_tree_node_ctor(void *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570{
Johannes Weiner449dd692014-04-03 14:47:56 -07001571 struct radix_tree_node *node = arg;
1572
1573 memset(node, 0, sizeof(*node));
1574 INIT_LIST_HEAD(&node->private_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575}
1576
Sebastian Andrzej Siewiord544abd2016-11-03 15:50:01 +01001577static int radix_tree_cpu_dead(unsigned int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578{
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001579 struct radix_tree_preload *rtp;
1580 struct radix_tree_node *node;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001582 /* Free per-cpu pool of preloaded nodes */
Sebastian Andrzej Siewiord544abd2016-11-03 15:50:01 +01001583 rtp = &per_cpu(radix_tree_preloads, cpu);
1584 while (rtp->nr) {
1585 node = rtp->nodes;
Matthew Wilcox1293d5c2017-01-16 16:41:29 -05001586 rtp->nodes = node->parent;
Sebastian Andrzej Siewiord544abd2016-11-03 15:50:01 +01001587 kmem_cache_free(radix_tree_node_cachep, node);
1588 rtp->nr--;
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001589 }
Sebastian Andrzej Siewiord544abd2016-11-03 15:50:01 +01001590 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592
1593void __init radix_tree_init(void)
1594{
Sebastian Andrzej Siewiord544abd2016-11-03 15:50:01 +01001595 int ret;
Michal Hocko7e784422017-05-03 14:53:09 -07001596
1597 BUILD_BUG_ON(RADIX_TREE_MAX_TAGS + __GFP_BITS_SHIFT > 32);
Matthew Wilcoxfa290cd2018-04-10 16:36:28 -07001598 BUILD_BUG_ON(ROOT_IS_IDR & ~GFP_ZONEMASK);
Matthew Wilcox02c02bf2017-11-03 23:09:45 -04001599 BUILD_BUG_ON(XA_CHUNK_SIZE > 255);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600 radix_tree_node_cachep = kmem_cache_create("radix_tree_node",
1601 sizeof(struct radix_tree_node), 0,
Christoph Lameter488514d2008-04-28 02:12:05 -07001602 SLAB_PANIC | SLAB_RECLAIM_ACCOUNT,
1603 radix_tree_node_ctor);
Sebastian Andrzej Siewiord544abd2016-11-03 15:50:01 +01001604 ret = cpuhp_setup_state_nocalls(CPUHP_RADIX_DEAD, "lib/radix:dead",
1605 NULL, radix_tree_cpu_dead);
1606 WARN_ON(ret < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607}