blob: 2ee6ae3b0ade09d197d3cb8859db3b7c570f51e5 [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/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 * Per-cpu pool of preloaded nodes
60 */
61struct radix_tree_preload {
Matthew Wilcox2fcd9002016-05-20 17:03:04 -070062 unsigned nr;
Matthew Wilcox1293d5c2017-01-16 16:41:29 -050063 /* nodes->parent points to next preallocated node */
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -070064 struct radix_tree_node *nodes;
Linus Torvalds1da177e2005-04-16 15:20:36 -070065};
Harvey Harrison8cef7d52009-01-06 14:40:50 -080066static DEFINE_PER_CPU(struct radix_tree_preload, radix_tree_preloads) = { 0, };
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
Matthew Wilcox148deab2016-12-14 15:08:49 -080068static inline struct radix_tree_node *entry_to_node(void *ptr)
69{
70 return (void *)((unsigned long)ptr & ~RADIX_TREE_INTERNAL_NODE);
71}
72
Matthew Wilcoxa4db4dc2016-05-20 17:03:24 -070073static inline void *node_to_entry(void *ptr)
Nick Piggin27d20fd2010-11-11 14:05:19 -080074{
Matthew Wilcox30ff46cc2016-05-20 17:03:22 -070075 return (void *)((unsigned long)ptr | RADIX_TREE_INTERNAL_NODE);
Nick Piggin27d20fd2010-11-11 14:05:19 -080076}
77
Matthew Wilcox02c02bf2017-11-03 23:09:45 -040078#define RADIX_TREE_RETRY XA_RETRY_ENTRY
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070079
Matthew Wilcoxd7b62722017-02-13 15:58:24 -050080static inline unsigned long
81get_slot_offset(const struct radix_tree_node *parent, void __rcu **slot)
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070082{
Matthew Wilcox76f070b2018-08-18 07:05:50 -040083 return parent ? slot - parent->slots : 0;
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070084}
85
Matthew Wilcox35534c82016-12-19 17:43:19 -050086static unsigned int radix_tree_descend(const struct radix_tree_node *parent,
Matthew Wilcox9e85d812016-05-20 17:03:48 -070087 struct radix_tree_node **nodep, unsigned long index)
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070088{
Matthew Wilcox9e85d812016-05-20 17:03:48 -070089 unsigned int offset = (index >> parent->shift) & RADIX_TREE_MAP_MASK;
Matthew Wilcoxd7b62722017-02-13 15:58:24 -050090 void __rcu **entry = rcu_dereference_raw(parent->slots[offset]);
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070091
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070092 *nodep = (void *)entry;
93 return offset;
94}
95
Matthew Wilcox35534c82016-12-19 17:43:19 -050096static inline gfp_t root_gfp_mask(const struct radix_tree_root *root)
Nick Piggin612d6c12006-06-23 02:03:22 -070097{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -050098 return root->xa_flags & (__GFP_BITS_MASK & ~GFP_ZONEMASK);
Nick Piggin612d6c12006-06-23 02:03:22 -070099}
100
Nick Piggin643b52b2008-06-12 15:21:52 -0700101static inline void tag_set(struct radix_tree_node *node, unsigned int tag,
102 int offset)
103{
104 __set_bit(offset, node->tags[tag]);
105}
106
107static inline void tag_clear(struct radix_tree_node *node, unsigned int tag,
108 int offset)
109{
110 __clear_bit(offset, node->tags[tag]);
111}
112
Matthew Wilcox35534c82016-12-19 17:43:19 -0500113static inline int tag_get(const struct radix_tree_node *node, unsigned int tag,
Nick Piggin643b52b2008-06-12 15:21:52 -0700114 int offset)
115{
116 return test_bit(offset, node->tags[tag]);
117}
118
Matthew Wilcox35534c82016-12-19 17:43:19 -0500119static inline void root_tag_set(struct radix_tree_root *root, unsigned tag)
Nick Piggin643b52b2008-06-12 15:21:52 -0700120{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500121 root->xa_flags |= (__force gfp_t)(1 << (tag + ROOT_TAG_SHIFT));
Nick Piggin643b52b2008-06-12 15:21:52 -0700122}
123
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700124static inline void root_tag_clear(struct radix_tree_root *root, unsigned tag)
Nick Piggin643b52b2008-06-12 15:21:52 -0700125{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500126 root->xa_flags &= (__force gfp_t)~(1 << (tag + ROOT_TAG_SHIFT));
Nick Piggin643b52b2008-06-12 15:21:52 -0700127}
128
129static inline void root_tag_clear_all(struct radix_tree_root *root)
130{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500131 root->xa_flags &= (__force gfp_t)((1 << ROOT_TAG_SHIFT) - 1);
Nick Piggin643b52b2008-06-12 15:21:52 -0700132}
133
Matthew Wilcox35534c82016-12-19 17:43:19 -0500134static inline int root_tag_get(const struct radix_tree_root *root, unsigned tag)
Nick Piggin643b52b2008-06-12 15:21:52 -0700135{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500136 return (__force int)root->xa_flags & (1 << (tag + ROOT_TAG_SHIFT));
Nick Piggin643b52b2008-06-12 15:21:52 -0700137}
138
Matthew Wilcox35534c82016-12-19 17:43:19 -0500139static inline unsigned root_tags_get(const struct radix_tree_root *root)
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700140{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500141 return (__force unsigned)root->xa_flags >> ROOT_TAG_SHIFT;
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500142}
143
144static inline bool is_idr(const struct radix_tree_root *root)
145{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500146 return !!(root->xa_flags & ROOT_IS_IDR);
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700147}
148
Nick Piggin643b52b2008-06-12 15:21:52 -0700149/*
150 * Returns 1 if any slot in the node has this tag set.
151 * Otherwise returns 0.
152 */
Matthew Wilcox35534c82016-12-19 17:43:19 -0500153static inline int any_tag_set(const struct radix_tree_node *node,
154 unsigned int tag)
Nick Piggin643b52b2008-06-12 15:21:52 -0700155{
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700156 unsigned idx;
Nick Piggin643b52b2008-06-12 15:21:52 -0700157 for (idx = 0; idx < RADIX_TREE_TAG_LONGS; idx++) {
158 if (node->tags[tag][idx])
159 return 1;
160 }
161 return 0;
162}
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700163
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500164static inline void all_tag_set(struct radix_tree_node *node, unsigned int tag)
165{
166 bitmap_fill(node->tags[tag], RADIX_TREE_MAP_SIZE);
167}
168
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700169/**
170 * radix_tree_find_next_bit - find the next set bit in a memory region
171 *
172 * @addr: The address to base the search on
173 * @size: The bitmap size in bits
174 * @offset: The bitnumber to start searching at
175 *
176 * Unrollable variant of find_next_bit() for constant size arrays.
177 * Tail bits starting from size to roundup(size, BITS_PER_LONG) must be zero.
178 * Returns next bit offset, or size if nothing found.
179 */
180static __always_inline unsigned long
Matthew Wilcoxbc412fc2016-12-14 15:08:40 -0800181radix_tree_find_next_bit(struct radix_tree_node *node, unsigned int tag,
182 unsigned long offset)
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700183{
Matthew Wilcoxbc412fc2016-12-14 15:08:40 -0800184 const unsigned long *addr = node->tags[tag];
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700185
Matthew Wilcoxbc412fc2016-12-14 15:08:40 -0800186 if (offset < RADIX_TREE_MAP_SIZE) {
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700187 unsigned long tmp;
188
189 addr += offset / BITS_PER_LONG;
190 tmp = *addr >> (offset % BITS_PER_LONG);
191 if (tmp)
192 return __ffs(tmp) + offset;
193 offset = (offset + BITS_PER_LONG) & ~(BITS_PER_LONG - 1);
Matthew Wilcoxbc412fc2016-12-14 15:08:40 -0800194 while (offset < RADIX_TREE_MAP_SIZE) {
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700195 tmp = *++addr;
196 if (tmp)
197 return __ffs(tmp) + offset;
198 offset += BITS_PER_LONG;
199 }
200 }
Matthew Wilcoxbc412fc2016-12-14 15:08:40 -0800201 return RADIX_TREE_MAP_SIZE;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700202}
203
Matthew Wilcox268f42d2016-12-14 15:08:55 -0800204static unsigned int iter_offset(const struct radix_tree_iter *iter)
205{
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400206 return iter->index & RADIX_TREE_MAP_MASK;
Matthew Wilcox268f42d2016-12-14 15:08:55 -0800207}
208
Matthew Wilcox218ed752016-12-14 15:08:43 -0800209/*
210 * The maximum index which can be stored in a radix tree
211 */
212static inline unsigned long shift_maxindex(unsigned int shift)
213{
214 return (RADIX_TREE_MAP_SIZE << shift) - 1;
215}
216
Matthew Wilcox35534c82016-12-19 17:43:19 -0500217static inline unsigned long node_maxindex(const struct radix_tree_node *node)
Matthew Wilcox218ed752016-12-14 15:08:43 -0800218{
219 return shift_maxindex(node->shift);
220}
221
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500222static unsigned long next_index(unsigned long index,
223 const struct radix_tree_node *node,
224 unsigned long offset)
225{
226 return (index & ~node_maxindex(node)) + (offset << node->shift);
227}
228
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229/*
230 * This assumes that the caller has performed appropriate preallocation, and
231 * that the caller has pinned this thread of control to the current CPU.
232 */
233static struct radix_tree_node *
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500234radix_tree_node_alloc(gfp_t gfp_mask, struct radix_tree_node *parent,
Matthew Wilcoxd58275b2017-01-16 17:10:21 -0500235 struct radix_tree_root *root,
Matthew Wilcoxe8de4342016-12-14 15:09:31 -0800236 unsigned int shift, unsigned int offset,
Matthew Wilcox01959df2017-11-09 09:23:56 -0500237 unsigned int count, unsigned int nr_values)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238{
Nick Piggine2848a02008-02-04 22:29:10 -0800239 struct radix_tree_node *ret = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
Jan Kara5e4c0d972013-09-11 14:26:05 -0700241 /*
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700242 * Preload code isn't irq safe and it doesn't make sense to use
243 * preloading during an interrupt anyway as all the allocations have
244 * to be atomic. So just do normal allocation when in interrupt.
Jan Kara5e4c0d972013-09-11 14:26:05 -0700245 */
Mel Gormand0164ad2015-11-06 16:28:21 -0800246 if (!gfpflags_allow_blocking(gfp_mask) && !in_interrupt()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 struct radix_tree_preload *rtp;
248
Nick Piggine2848a02008-02-04 22:29:10 -0800249 /*
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700250 * Even if the caller has preloaded, try to allocate from the
Vladimir Davydov05eb6e72016-08-02 14:03:01 -0700251 * cache first for the new node to get accounted to the memory
252 * cgroup.
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700253 */
254 ret = kmem_cache_alloc(radix_tree_node_cachep,
Vladimir Davydov05eb6e72016-08-02 14:03:01 -0700255 gfp_mask | __GFP_NOWARN);
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700256 if (ret)
257 goto out;
258
259 /*
Nick Piggine2848a02008-02-04 22:29:10 -0800260 * Provided the caller has preloaded here, we will always
261 * succeed in getting a node here (and never reach
262 * kmem_cache_alloc)
263 */
Christoph Lameter7c8e0182014-06-04 16:07:56 -0700264 rtp = this_cpu_ptr(&radix_tree_preloads);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 if (rtp->nr) {
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700266 ret = rtp->nodes;
Matthew Wilcox1293d5c2017-01-16 16:41:29 -0500267 rtp->nodes = ret->parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 rtp->nr--;
269 }
Catalin Marinasce80b062014-06-06 14:38:18 -0700270 /*
271 * Update the allocation stack trace as this is more useful
272 * for debugging.
273 */
274 kmemleak_update_trace(ret);
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700275 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 }
Vladimir Davydov05eb6e72016-08-02 14:03:01 -0700277 ret = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700278out:
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700279 BUG_ON(radix_tree_is_internal_node(ret));
Matthew Wilcoxe8de4342016-12-14 15:09:31 -0800280 if (ret) {
Matthew Wilcoxe8de4342016-12-14 15:09:31 -0800281 ret->shift = shift;
282 ret->offset = offset;
283 ret->count = count;
Matthew Wilcox01959df2017-11-09 09:23:56 -0500284 ret->nr_values = nr_values;
Matthew Wilcoxd58275b2017-01-16 17:10:21 -0500285 ret->parent = parent;
Matthew Wilcox01959df2017-11-09 09:23:56 -0500286 ret->array = root;
Matthew Wilcoxe8de4342016-12-14 15:09:31 -0800287 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 return ret;
289}
290
Matthew Wilcox58d6ea32017-11-10 15:15:08 -0500291void radix_tree_node_rcu_free(struct rcu_head *head)
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800292{
293 struct radix_tree_node *node =
294 container_of(head, struct radix_tree_node, rcu_head);
Nick Piggin643b52b2008-06-12 15:21:52 -0700295
296 /*
Matthew Wilcox175542f2016-12-14 15:08:58 -0800297 * Must only free zeroed nodes into the slab. We can be left with
298 * non-NULL entries by radix_tree_free_nodes, so clear the entries
299 * and tags here.
Nick Piggin643b52b2008-06-12 15:21:52 -0700300 */
Matthew Wilcox175542f2016-12-14 15:08:58 -0800301 memset(node->slots, 0, sizeof(node->slots));
302 memset(node->tags, 0, sizeof(node->tags));
Matthew Wilcox91d9c052016-12-14 15:08:34 -0800303 INIT_LIST_HEAD(&node->private_list);
Nick Piggin643b52b2008-06-12 15:21:52 -0700304
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800305 kmem_cache_free(radix_tree_node_cachep, node);
306}
307
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308static inline void
309radix_tree_node_free(struct radix_tree_node *node)
310{
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800311 call_rcu(&node->rcu_head, radix_tree_node_rcu_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312}
313
314/*
315 * Load up this CPU's radix_tree_node buffer with sufficient objects to
316 * ensure that the addition of a single element in the tree cannot fail. On
317 * success, return zero, with preemption disabled. On error, return -ENOMEM
318 * with preemption not disabled.
David Howellsb34df792009-11-19 18:11:14 +0000319 *
320 * To make use of this facility, the radix tree must be initialised without
Mel Gormand0164ad2015-11-06 16:28:21 -0800321 * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 */
Eric Dumazetbc9ae222017-09-08 16:15:54 -0700323static __must_check int __radix_tree_preload(gfp_t gfp_mask, unsigned nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324{
325 struct radix_tree_preload *rtp;
326 struct radix_tree_node *node;
327 int ret = -ENOMEM;
328
Vladimir Davydov05eb6e72016-08-02 14:03:01 -0700329 /*
330 * Nodes preloaded by one cgroup can be be used by another cgroup, so
331 * they should never be accounted to any particular memory cgroup.
332 */
333 gfp_mask &= ~__GFP_ACCOUNT;
334
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 preempt_disable();
Christoph Lameter7c8e0182014-06-04 16:07:56 -0700336 rtp = this_cpu_ptr(&radix_tree_preloads);
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -0700337 while (rtp->nr < nr) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 preempt_enable();
Christoph Lameter488514d2008-04-28 02:12:05 -0700339 node = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 if (node == NULL)
341 goto out;
342 preempt_disable();
Christoph Lameter7c8e0182014-06-04 16:07:56 -0700343 rtp = this_cpu_ptr(&radix_tree_preloads);
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -0700344 if (rtp->nr < nr) {
Matthew Wilcox1293d5c2017-01-16 16:41:29 -0500345 node->parent = rtp->nodes;
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700346 rtp->nodes = node;
347 rtp->nr++;
348 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 kmem_cache_free(radix_tree_node_cachep, node);
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700350 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 }
352 ret = 0;
353out:
354 return ret;
355}
Jan Kara5e4c0d972013-09-11 14:26:05 -0700356
357/*
358 * Load up this CPU's radix_tree_node buffer with sufficient objects to
359 * ensure that the addition of a single element in the tree cannot fail. On
360 * success, return zero, with preemption disabled. On error, return -ENOMEM
361 * with preemption not disabled.
362 *
363 * To make use of this facility, the radix tree must be initialised without
Mel Gormand0164ad2015-11-06 16:28:21 -0800364 * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
Jan Kara5e4c0d972013-09-11 14:26:05 -0700365 */
366int radix_tree_preload(gfp_t gfp_mask)
367{
368 /* Warn on non-sensical use... */
Mel Gormand0164ad2015-11-06 16:28:21 -0800369 WARN_ON_ONCE(!gfpflags_allow_blocking(gfp_mask));
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -0700370 return __radix_tree_preload(gfp_mask, RADIX_TREE_PRELOAD_SIZE);
Jan Kara5e4c0d972013-09-11 14:26:05 -0700371}
David Chinnerd7f09232007-07-14 16:05:04 +1000372EXPORT_SYMBOL(radix_tree_preload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
Nick Piggin6e954b92006-01-08 01:01:40 -0800374/*
Jan Kara5e4c0d972013-09-11 14:26:05 -0700375 * The same as above function, except we don't guarantee preloading happens.
376 * We do it, if we decide it helps. On success, return zero with preemption
377 * disabled. On error, return -ENOMEM with preemption not disabled.
378 */
379int radix_tree_maybe_preload(gfp_t gfp_mask)
380{
Mel Gormand0164ad2015-11-06 16:28:21 -0800381 if (gfpflags_allow_blocking(gfp_mask))
Kirill A. Shutemovc78c66d2016-07-26 15:26:02 -0700382 return __radix_tree_preload(gfp_mask, RADIX_TREE_PRELOAD_SIZE);
Jan Kara5e4c0d972013-09-11 14:26:05 -0700383 /* Preloading doesn't help anything with this gfp mask, skip it */
384 preempt_disable();
385 return 0;
386}
387EXPORT_SYMBOL(radix_tree_maybe_preload);
388
Matthew Wilcox35534c82016-12-19 17:43:19 -0500389static unsigned radix_tree_load_root(const struct radix_tree_root *root,
Matthew Wilcox1456a432016-05-20 17:02:08 -0700390 struct radix_tree_node **nodep, unsigned long *maxindex)
391{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500392 struct radix_tree_node *node = rcu_dereference_raw(root->xa_head);
Matthew Wilcox1456a432016-05-20 17:02:08 -0700393
394 *nodep = node;
395
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700396 if (likely(radix_tree_is_internal_node(node))) {
Matthew Wilcox4dd6c092016-05-20 17:03:27 -0700397 node = entry_to_node(node);
Matthew Wilcox1456a432016-05-20 17:02:08 -0700398 *maxindex = node_maxindex(node);
Matthew Wilcoxc12e51b2016-05-20 17:03:10 -0700399 return node->shift + RADIX_TREE_MAP_SHIFT;
Matthew Wilcox1456a432016-05-20 17:02:08 -0700400 }
401
402 *maxindex = 0;
403 return 0;
404}
405
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406/*
407 * Extend a radix tree so it can store key @index.
408 */
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500409static int radix_tree_extend(struct radix_tree_root *root, gfp_t gfp,
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700410 unsigned long index, unsigned int shift)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411{
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500412 void *entry;
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700413 unsigned int maxshift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 int tag;
415
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700416 /* Figure out what the shift should be. */
417 maxshift = shift;
418 while (index > shift_maxindex(maxshift))
419 maxshift += RADIX_TREE_MAP_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500421 entry = rcu_dereference_raw(root->xa_head);
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500422 if (!entry && (!is_idr(root) || root_tag_get(root, IDR_FREE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 do {
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500426 struct radix_tree_node *node = radix_tree_node_alloc(gfp, NULL,
Matthew Wilcoxd58275b2017-01-16 17:10:21 -0500427 root, shift, 0, 1, 0);
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700428 if (!node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 return -ENOMEM;
430
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500431 if (is_idr(root)) {
432 all_tag_set(node, IDR_FREE);
433 if (!root_tag_get(root, IDR_FREE)) {
434 tag_clear(node, IDR_FREE, 0);
435 root_tag_set(root, IDR_FREE);
436 }
437 } else {
438 /* Propagate the aggregated tag info to the new child */
439 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
440 if (root_tag_get(root, tag))
441 tag_set(node, tag, 0);
442 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 }
444
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700445 BUG_ON(shift > BITS_PER_LONG);
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500446 if (radix_tree_is_internal_node(entry)) {
447 entry_to_node(entry)->parent = node;
Matthew Wilcox3159f942017-11-03 13:30:42 -0400448 } else if (xa_is_value(entry)) {
Matthew Wilcox01959df2017-11-09 09:23:56 -0500449 /* Moving a value entry root->xa_head to a node */
450 node->nr_values = 1;
Johannes Weinerf7942432016-12-12 16:43:41 -0800451 }
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500452 /*
453 * entry was already in the radix tree, so we do not need
454 * rcu_assign_pointer here
455 */
456 node->slots[0] = (void __rcu *)entry;
457 entry = node_to_entry(node);
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500458 rcu_assign_pointer(root->xa_head, entry);
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700459 shift += RADIX_TREE_MAP_SHIFT;
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700460 } while (shift <= maxshift);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461out:
Matthew Wilcoxd0891262016-05-20 17:03:19 -0700462 return maxshift + RADIX_TREE_MAP_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463}
464
465/**
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800466 * radix_tree_shrink - shrink radix tree to minimum height
467 * @root radix tree root
468 */
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400469static inline bool radix_tree_shrink(struct radix_tree_root *root)
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800470{
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500471 bool shrunk = false;
472
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800473 for (;;) {
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500474 struct radix_tree_node *node = rcu_dereference_raw(root->xa_head);
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800475 struct radix_tree_node *child;
476
477 if (!radix_tree_is_internal_node(node))
478 break;
479 node = entry_to_node(node);
480
481 /*
482 * The candidate node has more than one child, or its child
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400483 * is not at the leftmost slot, we cannot shrink.
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800484 */
485 if (node->count != 1)
486 break;
Matthew Wilcox12320d02017-02-13 15:22:48 -0500487 child = rcu_dereference_raw(node->slots[0]);
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800488 if (!child)
489 break;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800490
Matthew Wilcox66ee6202018-06-25 06:56:50 -0400491 /*
492 * For an IDR, we must not shrink entry 0 into the root in
493 * case somebody calls idr_replace() with a pointer that
494 * appears to be an internal entry
495 */
496 if (!node->shift && is_idr(root))
497 break;
498
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800499 if (radix_tree_is_internal_node(child))
500 entry_to_node(child)->parent = NULL;
501
502 /*
503 * We don't need rcu_assign_pointer(), since we are simply
504 * moving the node from one part of the tree to another: if it
505 * was safe to dereference the old pointer to it
506 * (node->slots[0]), it will be safe to dereference the new
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500507 * one (root->xa_head) as far as dependent read barriers go.
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800508 */
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500509 root->xa_head = (void __rcu *)child;
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500510 if (is_idr(root) && !tag_get(node, IDR_FREE, 0))
511 root_tag_clear(root, IDR_FREE);
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800512
513 /*
514 * We have a dilemma here. The node's slot[0] must not be
515 * NULLed in case there are concurrent lookups expecting to
516 * find the item. However if this was a bottom-level node,
517 * then it may be subject to the slot pointer being visible
518 * to callers dereferencing it. If item corresponding to
519 * slot[0] is subsequently deleted, these callers would expect
520 * their slot to become empty sooner or later.
521 *
522 * For example, lockless pagecache will look up a slot, deref
523 * the page pointer, and if the page has 0 refcount it means it
524 * was concurrently deleted from pagecache so try the deref
525 * again. Fortunately there is already a requirement for logic
526 * to retry the entire slot lookup -- the indirect pointer
527 * problem (replacing direct root node with an indirect pointer
528 * also results in a stale slot). So tag the slot as indirect
529 * to force callers to retry.
530 */
Johannes Weiner4d693d02016-12-12 16:43:49 -0800531 node->count = 0;
532 if (!radix_tree_is_internal_node(child)) {
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500533 node->slots[0] = (void __rcu *)RADIX_TREE_RETRY;
Johannes Weiner4d693d02016-12-12 16:43:49 -0800534 }
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800535
Johannes Weinerea07b862017-01-06 19:21:43 -0500536 WARN_ON_ONCE(!list_empty(&node->private_list));
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800537 radix_tree_node_free(node);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500538 shrunk = true;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800539 }
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500540
541 return shrunk;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800542}
543
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500544static bool delete_node(struct radix_tree_root *root,
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400545 struct radix_tree_node *node)
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800546{
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500547 bool deleted = false;
548
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800549 do {
550 struct radix_tree_node *parent;
551
552 if (node->count) {
Matthew Wilcox12320d02017-02-13 15:22:48 -0500553 if (node_to_entry(node) ==
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500554 rcu_dereference_raw(root->xa_head))
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400555 deleted |= radix_tree_shrink(root);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500556 return deleted;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800557 }
558
559 parent = node->parent;
560 if (parent) {
561 parent->slots[node->offset] = NULL;
562 parent->count--;
563 } else {
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500564 /*
565 * Shouldn't the tags already have all been cleared
566 * by the caller?
567 */
568 if (!is_idr(root))
569 root_tag_clear_all(root);
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500570 root->xa_head = NULL;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800571 }
572
Johannes Weinerea07b862017-01-06 19:21:43 -0500573 WARN_ON_ONCE(!list_empty(&node->private_list));
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800574 radix_tree_node_free(node);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500575 deleted = true;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800576
577 node = parent;
578 } while (node);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -0500579
580 return deleted;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800581}
582
583/**
Johannes Weiner139e5612014-04-03 14:47:54 -0700584 * __radix_tree_create - create a slot in a radix tree
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 * @root: radix tree root
586 * @index: index key
Johannes Weiner139e5612014-04-03 14:47:54 -0700587 * @nodep: returns node
588 * @slotp: returns slot
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 *
Johannes Weiner139e5612014-04-03 14:47:54 -0700590 * Create, if necessary, and return the node and slot for an item
591 * at position @index in the radix tree @root.
592 *
593 * Until there is more than one item in the tree, no nodes are
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500594 * allocated and @root->xa_head is used as a direct slot instead of
Johannes Weiner139e5612014-04-03 14:47:54 -0700595 * pointing to a node, in which case *@nodep will be NULL.
596 *
597 * Returns -ENOMEM, or 0 for success.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 */
Matthew Wilcox74d60952017-11-17 10:01:45 -0500599static int __radix_tree_create(struct radix_tree_root *root,
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400600 unsigned long index, struct radix_tree_node **nodep,
601 void __rcu ***slotp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602{
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700603 struct radix_tree_node *node = NULL, *child;
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500604 void __rcu **slot = (void __rcu **)&root->xa_head;
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700605 unsigned long maxindex;
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700606 unsigned int shift, offset = 0;
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400607 unsigned long max = index;
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500608 gfp_t gfp = root_gfp_mask(root);
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700609
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700610 shift = radix_tree_load_root(root, &child, &maxindex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
612 /* Make sure the tree is high enough. */
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700613 if (max > maxindex) {
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500614 int error = radix_tree_extend(root, gfp, max, shift);
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700615 if (error < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 return error;
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700617 shift = error;
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500618 child = rcu_dereference_raw(root->xa_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 }
620
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400621 while (shift > 0) {
Matthew Wilcoxc12e51b2016-05-20 17:03:10 -0700622 shift -= RADIX_TREE_MAP_SHIFT;
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700623 if (child == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 /* Have to add a child node. */
Matthew Wilcoxd58275b2017-01-16 17:10:21 -0500625 child = radix_tree_node_alloc(gfp, node, root, shift,
Matthew Wilcoxe8de4342016-12-14 15:09:31 -0800626 offset, 0, 0);
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700627 if (!child)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 return -ENOMEM;
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700629 rcu_assign_pointer(*slot, node_to_entry(child));
630 if (node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 node->count++;
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700632 } else if (!radix_tree_is_internal_node(child))
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700633 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634
635 /* Go a level down */
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700636 node = entry_to_node(child);
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700637 offset = radix_tree_descend(node, &child, index);
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700638 slot = &node->slots[offset];
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700639 }
640
Johannes Weiner139e5612014-04-03 14:47:54 -0700641 if (nodep)
642 *nodep = node;
643 if (slotp)
Matthew Wilcox89148aa2016-05-20 17:03:42 -0700644 *slotp = slot;
Johannes Weiner139e5612014-04-03 14:47:54 -0700645 return 0;
646}
647
Matthew Wilcox175542f2016-12-14 15:08:58 -0800648/*
649 * Free any nodes below this node. The tree is presumed to not need
650 * shrinking, and any user data in the tree is presumed to not need a
651 * destructor called on it. If we need to add a destructor, we can
652 * add that functionality later. Note that we may not clear tags or
653 * slots from the tree as an RCU walker may still have a pointer into
654 * this subtree. We could replace the entries with RADIX_TREE_RETRY,
655 * but we'll still have to clear those in rcu_free.
656 */
657static void radix_tree_free_nodes(struct radix_tree_node *node)
658{
659 unsigned offset = 0;
660 struct radix_tree_node *child = entry_to_node(node);
661
662 for (;;) {
Matthew Wilcox12320d02017-02-13 15:22:48 -0500663 void *entry = rcu_dereference_raw(child->slots[offset]);
Matthew Wilcox02c02bf2017-11-03 23:09:45 -0400664 if (xa_is_node(entry) && child->shift) {
Matthew Wilcox175542f2016-12-14 15:08:58 -0800665 child = entry_to_node(entry);
666 offset = 0;
667 continue;
668 }
669 offset++;
670 while (offset == RADIX_TREE_MAP_SIZE) {
671 struct radix_tree_node *old = child;
672 offset = child->offset + 1;
673 child = child->parent;
Matthew Wilcoxdd040b62017-01-24 15:18:16 -0800674 WARN_ON_ONCE(!list_empty(&old->private_list));
Matthew Wilcox175542f2016-12-14 15:08:58 -0800675 radix_tree_node_free(old);
676 if (old == entry_to_node(node))
677 return;
678 }
679 }
680}
681
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500682static inline int insert_entries(struct radix_tree_node *node,
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400683 void __rcu **slot, void *item, bool replace)
Matthew Wilcox175542f2016-12-14 15:08:58 -0800684{
685 if (*slot)
686 return -EEXIST;
687 rcu_assign_pointer(*slot, item);
688 if (node) {
689 node->count++;
Matthew Wilcox3159f942017-11-03 13:30:42 -0400690 if (xa_is_value(item))
Matthew Wilcox01959df2017-11-09 09:23:56 -0500691 node->nr_values++;
Matthew Wilcox175542f2016-12-14 15:08:58 -0800692 }
693 return 1;
694}
Matthew Wilcox175542f2016-12-14 15:08:58 -0800695
Johannes Weiner139e5612014-04-03 14:47:54 -0700696/**
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700697 * __radix_tree_insert - insert into a radix tree
Johannes Weiner139e5612014-04-03 14:47:54 -0700698 * @root: radix tree root
699 * @index: index key
700 * @item: item to insert
701 *
702 * Insert an item into the radix tree at position @index.
703 */
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400704int radix_tree_insert(struct radix_tree_root *root, unsigned long index,
705 void *item)
Johannes Weiner139e5612014-04-03 14:47:54 -0700706{
707 struct radix_tree_node *node;
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500708 void __rcu **slot;
Johannes Weiner139e5612014-04-03 14:47:54 -0700709 int error;
710
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700711 BUG_ON(radix_tree_is_internal_node(item));
Johannes Weiner139e5612014-04-03 14:47:54 -0700712
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400713 error = __radix_tree_create(root, index, &node, &slot);
Johannes Weiner139e5612014-04-03 14:47:54 -0700714 if (error)
715 return error;
Matthew Wilcox175542f2016-12-14 15:08:58 -0800716
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400717 error = insert_entries(node, slot, item, false);
Matthew Wilcox175542f2016-12-14 15:08:58 -0800718 if (error < 0)
719 return error;
Christoph Lameter201b6262005-09-06 15:16:46 -0700720
Nick Piggin612d6c12006-06-23 02:03:22 -0700721 if (node) {
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700722 unsigned offset = get_slot_offset(node, slot);
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700723 BUG_ON(tag_get(node, 0, offset));
724 BUG_ON(tag_get(node, 1, offset));
725 BUG_ON(tag_get(node, 2, offset));
Nick Piggin612d6c12006-06-23 02:03:22 -0700726 } else {
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700727 BUG_ON(root_tags_get(root));
Nick Piggin612d6c12006-06-23 02:03:22 -0700728 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 return 0;
731}
Matthew Wilcox3a08cd52018-09-22 16:14:30 -0400732EXPORT_SYMBOL(radix_tree_insert);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733
Johannes Weiner139e5612014-04-03 14:47:54 -0700734/**
735 * __radix_tree_lookup - lookup an item in a radix tree
736 * @root: radix tree root
737 * @index: index key
738 * @nodep: returns node
739 * @slotp: returns slot
740 *
741 * Lookup and return the item at position @index in the radix
742 * tree @root.
743 *
744 * Until there is more than one item in the tree, no nodes are
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500745 * allocated and @root->xa_head is used as a direct slot instead of
Johannes Weiner139e5612014-04-03 14:47:54 -0700746 * pointing to a node, in which case *@nodep will be NULL.
Hans Reisera4331362005-11-07 00:59:29 -0800747 */
Matthew Wilcox35534c82016-12-19 17:43:19 -0500748void *__radix_tree_lookup(const struct radix_tree_root *root,
749 unsigned long index, struct radix_tree_node **nodep,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500750 void __rcu ***slotp)
Hans Reisera4331362005-11-07 00:59:29 -0800751{
Johannes Weiner139e5612014-04-03 14:47:54 -0700752 struct radix_tree_node *node, *parent;
Matthew Wilcox85829952016-05-20 17:02:20 -0700753 unsigned long maxindex;
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500754 void __rcu **slot;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800755
Matthew Wilcox85829952016-05-20 17:02:20 -0700756 restart:
757 parent = NULL;
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500758 slot = (void __rcu **)&root->xa_head;
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700759 radix_tree_load_root(root, &node, &maxindex);
Matthew Wilcox85829952016-05-20 17:02:20 -0700760 if (index > maxindex)
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800761 return NULL;
762
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700763 while (radix_tree_is_internal_node(node)) {
Matthew Wilcox85829952016-05-20 17:02:20 -0700764 unsigned offset;
Johannes Weiner139e5612014-04-03 14:47:54 -0700765
Matthew Wilcox4dd6c092016-05-20 17:03:27 -0700766 parent = entry_to_node(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700767 offset = radix_tree_descend(parent, &node, index);
Matthew Wilcox85829952016-05-20 17:02:20 -0700768 slot = parent->slots + offset;
Matthew Wilcoxeff38602018-12-06 08:19:13 -0500769 if (node == RADIX_TREE_RETRY)
770 goto restart;
Matthew Wilcox66ee6202018-06-25 06:56:50 -0400771 if (parent->shift == 0)
772 break;
Matthew Wilcox85829952016-05-20 17:02:20 -0700773 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800774
Johannes Weiner139e5612014-04-03 14:47:54 -0700775 if (nodep)
776 *nodep = parent;
777 if (slotp)
778 *slotp = slot;
779 return node;
Huang Shijieb72b71c2009-06-16 15:33:42 -0700780}
781
782/**
783 * radix_tree_lookup_slot - lookup a slot in a radix tree
784 * @root: radix tree root
785 * @index: index key
786 *
787 * Returns: the slot corresponding to the position @index in the
788 * radix tree @root. This is useful for update-if-exists operations.
789 *
790 * This function can be called under rcu_read_lock iff the slot is not
791 * modified by radix_tree_replace_slot, otherwise it must be called
792 * exclusive from other writers. Any dereference of the slot must be done
793 * using radix_tree_deref_slot.
794 */
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500795void __rcu **radix_tree_lookup_slot(const struct radix_tree_root *root,
Matthew Wilcox35534c82016-12-19 17:43:19 -0500796 unsigned long index)
Huang Shijieb72b71c2009-06-16 15:33:42 -0700797{
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500798 void __rcu **slot;
Johannes Weiner139e5612014-04-03 14:47:54 -0700799
800 if (!__radix_tree_lookup(root, index, NULL, &slot))
801 return NULL;
802 return slot;
Hans Reisera4331362005-11-07 00:59:29 -0800803}
804EXPORT_SYMBOL(radix_tree_lookup_slot);
805
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806/**
807 * radix_tree_lookup - perform lookup operation on a radix tree
808 * @root: radix tree root
809 * @index: index key
810 *
811 * Lookup the item at the position @index in the radix tree @root.
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800812 *
813 * This function can be called under rcu_read_lock, however the caller
814 * must manage lifetimes of leaf nodes (eg. RCU may also be used to free
815 * them safely). No RCU barriers are required to access or modify the
816 * returned item, however.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 */
Matthew Wilcox35534c82016-12-19 17:43:19 -0500818void *radix_tree_lookup(const struct radix_tree_root *root, unsigned long index)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819{
Johannes Weiner139e5612014-04-03 14:47:54 -0700820 return __radix_tree_lookup(root, index, NULL, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821}
822EXPORT_SYMBOL(radix_tree_lookup);
823
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500824static void replace_slot(void __rcu **slot, void *item,
Matthew Wilcox01959df2017-11-09 09:23:56 -0500825 struct radix_tree_node *node, int count, int values)
Johannes Weiner6d75f362016-12-12 16:43:43 -0800826{
Matthew Wilcox01959df2017-11-09 09:23:56 -0500827 if (node && (count || values)) {
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800828 node->count += count;
Matthew Wilcox01959df2017-11-09 09:23:56 -0500829 node->nr_values += values;
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800830 }
Johannes Weiner6d75f362016-12-12 16:43:43 -0800831
832 rcu_assign_pointer(*slot, item);
833}
834
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500835static bool node_tag_get(const struct radix_tree_root *root,
836 const struct radix_tree_node *node,
837 unsigned int tag, unsigned int offset)
Matthew Wilcoxa90eb3a2016-12-14 15:09:07 -0800838{
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500839 if (node)
840 return tag_get(node, tag, offset);
841 return root_tag_get(root, tag);
842}
Matthew Wilcoxa90eb3a2016-12-14 15:09:07 -0800843
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500844/*
845 * IDR users want to be able to store NULL in the tree, so if the slot isn't
846 * free, don't adjust the count, even if it's transitioning between NULL and
847 * non-NULL. For the IDA, we mark slots as being IDR_FREE while they still
848 * have empty bits, but it only stores NULL in slots when they're being
849 * deleted.
850 */
851static int calculate_count(struct radix_tree_root *root,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500852 struct radix_tree_node *node, void __rcu **slot,
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500853 void *item, void *old)
854{
855 if (is_idr(root)) {
856 unsigned offset = get_slot_offset(node, slot);
857 bool free = node_tag_get(root, node, IDR_FREE, offset);
858 if (!free)
859 return 0;
860 if (!old)
861 return 1;
Matthew Wilcoxa90eb3a2016-12-14 15:09:07 -0800862 }
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500863 return !!item - !!old;
Matthew Wilcoxa90eb3a2016-12-14 15:09:07 -0800864}
865
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866/**
Johannes Weinerf7942432016-12-12 16:43:41 -0800867 * __radix_tree_replace - replace item in a slot
Johannes Weiner4d693d02016-12-12 16:43:49 -0800868 * @root: radix tree root
869 * @node: pointer to tree node
870 * @slot: pointer to slot in @node
871 * @item: new item to store in the slot.
Johannes Weinerf7942432016-12-12 16:43:41 -0800872 *
873 * For use with __radix_tree_lookup(). Caller must hold tree write locked
874 * across slot lookup and replacement.
875 */
876void __radix_tree_replace(struct radix_tree_root *root,
877 struct radix_tree_node *node,
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400878 void __rcu **slot, void *item)
Johannes Weinerf7942432016-12-12 16:43:41 -0800879{
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500880 void *old = rcu_dereference_raw(*slot);
Matthew Wilcox01959df2017-11-09 09:23:56 -0500881 int values = !!xa_is_value(item) - !!xa_is_value(old);
Matthew Wilcox0a835c42016-12-20 10:27:56 -0500882 int count = calculate_count(root, node, slot, item, old);
883
Johannes Weiner6d75f362016-12-12 16:43:43 -0800884 /*
Matthew Wilcox01959df2017-11-09 09:23:56 -0500885 * This function supports replacing value entries and
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800886 * deleting entries, but that needs accounting against the
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500887 * node unless the slot is root->xa_head.
Johannes Weiner6d75f362016-12-12 16:43:43 -0800888 */
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -0500889 WARN_ON_ONCE(!node && (slot != (void __rcu **)&root->xa_head) &&
Matthew Wilcox01959df2017-11-09 09:23:56 -0500890 (count || values));
891 replace_slot(slot, item, node, count, values);
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800892
Johannes Weiner4d693d02016-12-12 16:43:49 -0800893 if (!node)
894 return;
895
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400896 delete_node(root, node);
Johannes Weiner6d75f362016-12-12 16:43:43 -0800897}
Johannes Weinerf7942432016-12-12 16:43:41 -0800898
Johannes Weiner6d75f362016-12-12 16:43:43 -0800899/**
900 * radix_tree_replace_slot - replace item in a slot
901 * @root: radix tree root
902 * @slot: pointer to slot
903 * @item: new item to store in the slot.
904 *
Matthew Wilcox7b8d0462017-12-01 22:13:06 -0500905 * For use with radix_tree_lookup_slot() and
Johannes Weiner6d75f362016-12-12 16:43:43 -0800906 * radix_tree_gang_lookup_tag_slot(). Caller must hold tree write locked
907 * across slot lookup and replacement.
908 *
909 * NOTE: This cannot be used to switch between non-entries (empty slots),
Matthew Wilcox01959df2017-11-09 09:23:56 -0500910 * regular entries, and value entries, as that requires accounting
Johannes Weinerf4b109c2016-12-12 16:43:46 -0800911 * inside the radix tree node. When switching from one type of entry or
Matthew Wilcoxe157b552016-12-14 15:09:01 -0800912 * deleting, use __radix_tree_lookup() and __radix_tree_replace() or
913 * radix_tree_iter_replace().
Johannes Weiner6d75f362016-12-12 16:43:43 -0800914 */
915void radix_tree_replace_slot(struct radix_tree_root *root,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500916 void __rcu **slot, void *item)
Johannes Weiner6d75f362016-12-12 16:43:43 -0800917{
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400918 __radix_tree_replace(root, NULL, slot, item);
Johannes Weinerf7942432016-12-12 16:43:41 -0800919}
Song Liu10257d72017-01-11 10:00:51 -0800920EXPORT_SYMBOL(radix_tree_replace_slot);
Johannes Weinerf7942432016-12-12 16:43:41 -0800921
Matthew Wilcoxe157b552016-12-14 15:09:01 -0800922/**
923 * radix_tree_iter_replace - replace item in a slot
924 * @root: radix tree root
925 * @slot: pointer to slot
926 * @item: new item to store in the slot.
927 *
Matthew Wilcox2956c662018-05-19 16:47:47 -0400928 * For use with radix_tree_for_each_slot().
929 * Caller must hold tree write locked.
Matthew Wilcoxe157b552016-12-14 15:09:01 -0800930 */
931void radix_tree_iter_replace(struct radix_tree_root *root,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -0500932 const struct radix_tree_iter *iter,
933 void __rcu **slot, void *item)
Matthew Wilcoxe157b552016-12-14 15:09:01 -0800934{
Matthew Wilcox1cf56f92018-04-09 16:24:45 -0400935 __radix_tree_replace(root, iter->node, slot, item);
Matthew Wilcoxe157b552016-12-14 15:09:01 -0800936}
937
Matthew Wilcox30b888b2017-01-28 09:55:20 -0500938static void node_tag_set(struct radix_tree_root *root,
939 struct radix_tree_node *node,
940 unsigned int tag, unsigned int offset)
941{
942 while (node) {
943 if (tag_get(node, tag, offset))
944 return;
945 tag_set(node, tag, offset);
946 offset = node->offset;
947 node = node->parent;
948 }
949
950 if (!root_tag_get(root, tag))
951 root_tag_set(root, tag);
952}
953
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954/**
955 * radix_tree_tag_set - set a tag on a radix tree node
956 * @root: radix tree root
957 * @index: index key
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700958 * @tag: tag index
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 *
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800960 * Set the search tag (which must be < RADIX_TREE_MAX_TAGS)
961 * corresponding to @index in the radix tree. From
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 * the root all the way down to the leaf node.
963 *
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700964 * Returns the address of the tagged item. Setting a tag on a not-present
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 * item is a bug.
966 */
967void *radix_tree_tag_set(struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800968 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969{
Ross Zwislerfb969902016-05-20 17:02:32 -0700970 struct radix_tree_node *node, *parent;
971 unsigned long maxindex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700973 radix_tree_load_root(root, &node, &maxindex);
Ross Zwislerfb969902016-05-20 17:02:32 -0700974 BUG_ON(index > maxindex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975
Matthew Wilcoxb194d162016-05-20 17:03:30 -0700976 while (radix_tree_is_internal_node(node)) {
Ross Zwislerfb969902016-05-20 17:02:32 -0700977 unsigned offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978
Matthew Wilcox4dd6c092016-05-20 17:03:27 -0700979 parent = entry_to_node(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -0700980 offset = radix_tree_descend(parent, &node, index);
Ross Zwislerfb969902016-05-20 17:02:32 -0700981 BUG_ON(!node);
982
983 if (!tag_get(parent, tag, offset))
984 tag_set(parent, tag, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 }
986
Nick Piggin612d6c12006-06-23 02:03:22 -0700987 /* set the root's tag bit */
Ross Zwislerfb969902016-05-20 17:02:32 -0700988 if (!root_tag_get(root, tag))
Nick Piggin612d6c12006-06-23 02:03:22 -0700989 root_tag_set(root, tag);
990
Ross Zwislerfb969902016-05-20 17:02:32 -0700991 return node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992}
993EXPORT_SYMBOL(radix_tree_tag_set);
994
Matthew Wilcoxd604c322016-05-20 17:03:45 -0700995static void node_tag_clear(struct radix_tree_root *root,
996 struct radix_tree_node *node,
997 unsigned int tag, unsigned int offset)
998{
999 while (node) {
1000 if (!tag_get(node, tag, offset))
1001 return;
1002 tag_clear(node, tag, offset);
1003 if (any_tag_set(node, tag))
1004 return;
1005
1006 offset = node->offset;
1007 node = node->parent;
1008 }
1009
1010 /* clear the root's tag bit */
1011 if (root_tag_get(root, tag))
1012 root_tag_clear(root, tag);
1013}
1014
Matthew Wilcox268f42d2016-12-14 15:08:55 -08001015/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 * radix_tree_tag_clear - clear a tag on a radix tree node
1017 * @root: radix tree root
1018 * @index: index key
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001019 * @tag: tag index
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 *
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001021 * Clear the search tag (which must be < RADIX_TREE_MAX_TAGS)
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001022 * corresponding to @index in the radix tree. If this causes
1023 * the leaf node to have no tags set then clear the tag in the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 * next-to-leaf node, etc.
1025 *
1026 * Returns the address of the tagged item on success, else NULL. ie:
1027 * has the same return value and semantics as radix_tree_lookup().
1028 */
1029void *radix_tree_tag_clear(struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001030 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031{
Ross Zwisler00f47b52016-05-20 17:02:35 -07001032 struct radix_tree_node *node, *parent;
1033 unsigned long maxindex;
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001034 int uninitialized_var(offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001036 radix_tree_load_root(root, &node, &maxindex);
Ross Zwisler00f47b52016-05-20 17:02:35 -07001037 if (index > maxindex)
1038 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039
Ross Zwisler00f47b52016-05-20 17:02:35 -07001040 parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041
Matthew Wilcoxb194d162016-05-20 17:03:30 -07001042 while (radix_tree_is_internal_node(node)) {
Matthew Wilcox4dd6c092016-05-20 17:03:27 -07001043 parent = entry_to_node(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001044 offset = radix_tree_descend(parent, &node, index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 }
1046
Matthew Wilcoxd604c322016-05-20 17:03:45 -07001047 if (node)
1048 node_tag_clear(root, parent, tag, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049
Ross Zwisler00f47b52016-05-20 17:02:35 -07001050 return node;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051}
1052EXPORT_SYMBOL(radix_tree_tag_clear);
1053
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054/**
Matthew Wilcox30b888b2017-01-28 09:55:20 -05001055 * radix_tree_iter_tag_clear - clear a tag on the current iterator entry
1056 * @root: radix tree root
1057 * @iter: iterator state
1058 * @tag: tag to clear
1059 */
1060void radix_tree_iter_tag_clear(struct radix_tree_root *root,
1061 const struct radix_tree_iter *iter, unsigned int tag)
1062{
1063 node_tag_clear(root, iter->node, tag, iter_offset(iter));
1064}
1065
1066/**
Marcelo Tosatti32605a12005-09-06 15:16:48 -07001067 * radix_tree_tag_get - get a tag on a radix tree node
1068 * @root: radix tree root
1069 * @index: index key
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001070 * @tag: tag index (< RADIX_TREE_MAX_TAGS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 *
Marcelo Tosatti32605a12005-09-06 15:16:48 -07001072 * Return values:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 *
Nick Piggin612d6c12006-06-23 02:03:22 -07001074 * 0: tag not present or not set
1075 * 1: tag set
David Howellsce826532010-04-06 22:36:20 +01001076 *
1077 * Note that the return value of this function may not be relied on, even if
1078 * the RCU lock is held, unless tag modification and node deletion are excluded
1079 * from concurrency.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 */
Matthew Wilcox35534c82016-12-19 17:43:19 -05001081int radix_tree_tag_get(const struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001082 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083{
Ross Zwisler4589ba62016-05-20 17:02:38 -07001084 struct radix_tree_node *node, *parent;
1085 unsigned long maxindex;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086
Nick Piggin612d6c12006-06-23 02:03:22 -07001087 if (!root_tag_get(root, tag))
1088 return 0;
1089
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001090 radix_tree_load_root(root, &node, &maxindex);
Ross Zwisler4589ba62016-05-20 17:02:38 -07001091 if (index > maxindex)
1092 return 0;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001093
Matthew Wilcoxb194d162016-05-20 17:03:30 -07001094 while (radix_tree_is_internal_node(node)) {
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001095 unsigned offset;
Ross Zwisler4589ba62016-05-20 17:02:38 -07001096
Matthew Wilcox4dd6c092016-05-20 17:03:27 -07001097 parent = entry_to_node(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001098 offset = radix_tree_descend(parent, &node, index);
Ross Zwisler4589ba62016-05-20 17:02:38 -07001099
Ross Zwisler4589ba62016-05-20 17:02:38 -07001100 if (!tag_get(parent, tag, offset))
1101 return 0;
1102 if (node == RADIX_TREE_RETRY)
1103 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104 }
Ross Zwisler4589ba62016-05-20 17:02:38 -07001105
1106 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107}
1108EXPORT_SYMBOL(radix_tree_tag_get);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109
Matthew Wilcox148deab2016-12-14 15:08:49 -08001110/* Construct iter->tags bit-mask from node->tags[tag] array */
1111static void set_iter_tags(struct radix_tree_iter *iter,
1112 struct radix_tree_node *node, unsigned offset,
1113 unsigned tag)
1114{
1115 unsigned tag_long = offset / BITS_PER_LONG;
1116 unsigned tag_bit = offset % BITS_PER_LONG;
1117
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001118 if (!node) {
1119 iter->tags = 1;
1120 return;
1121 }
1122
Matthew Wilcox148deab2016-12-14 15:08:49 -08001123 iter->tags = node->tags[tag][tag_long] >> tag_bit;
1124
1125 /* This never happens if RADIX_TREE_TAG_LONGS == 1 */
1126 if (tag_long < RADIX_TREE_TAG_LONGS - 1) {
1127 /* Pick tags from next element */
1128 if (tag_bit)
1129 iter->tags |= node->tags[tag][tag_long + 1] <<
1130 (BITS_PER_LONG - tag_bit);
1131 /* Clip chunk size, here only BITS_PER_LONG tags */
1132 iter->next_index = __radix_tree_iter_add(iter, BITS_PER_LONG);
1133 }
1134}
1135
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001136void __rcu **radix_tree_iter_resume(void __rcu **slot,
1137 struct radix_tree_iter *iter)
Matthew Wilcox148deab2016-12-14 15:08:49 -08001138{
Matthew Wilcox148deab2016-12-14 15:08:49 -08001139 slot++;
1140 iter->index = __radix_tree_iter_add(iter, 1);
Matthew Wilcox148deab2016-12-14 15:08:49 -08001141 iter->next_index = iter->index;
1142 iter->tags = 0;
1143 return NULL;
1144}
1145EXPORT_SYMBOL(radix_tree_iter_resume);
1146
Fengguang Wu6df8ba42007-10-16 01:24:33 -07001147/**
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001148 * radix_tree_next_chunk - find next chunk of slots for iteration
1149 *
1150 * @root: radix tree root
1151 * @iter: iterator state
1152 * @flags: RADIX_TREE_ITER_* flags and tag index
1153 * Returns: pointer to chunk first slot, or NULL if iteration is over
1154 */
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001155void __rcu **radix_tree_next_chunk(const struct radix_tree_root *root,
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001156 struct radix_tree_iter *iter, unsigned flags)
1157{
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001158 unsigned tag = flags & RADIX_TREE_ITER_TAG_MASK;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001159 struct radix_tree_node *node, *child;
Ross Zwisler21ef5332016-05-20 17:02:26 -07001160 unsigned long index, offset, maxindex;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001161
1162 if ((flags & RADIX_TREE_ITER_TAGGED) && !root_tag_get(root, tag))
1163 return NULL;
1164
1165 /*
1166 * Catch next_index overflow after ~0UL. iter->index never overflows
1167 * during iterating; it can be zero only at the beginning.
1168 * And we cannot overflow iter->next_index in a single step,
1169 * because RADIX_TREE_MAP_SHIFT < BITS_PER_LONG.
Konstantin Khlebnikovfffaee32012-06-05 21:36:33 +04001170 *
1171 * This condition also used by radix_tree_next_slot() to stop
Matthew Wilcox91b9677c2016-12-14 15:08:31 -08001172 * contiguous iterating, and forbid switching to the next chunk.
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001173 */
1174 index = iter->next_index;
1175 if (!index && iter->index)
1176 return NULL;
1177
Ross Zwisler21ef5332016-05-20 17:02:26 -07001178 restart:
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001179 radix_tree_load_root(root, &child, &maxindex);
Ross Zwisler21ef5332016-05-20 17:02:26 -07001180 if (index > maxindex)
1181 return NULL;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001182 if (!child)
1183 return NULL;
Ross Zwisler21ef5332016-05-20 17:02:26 -07001184
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001185 if (!radix_tree_is_internal_node(child)) {
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001186 /* Single-slot tree */
Ross Zwisler21ef5332016-05-20 17:02:26 -07001187 iter->index = index;
1188 iter->next_index = maxindex + 1;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001189 iter->tags = 1;
Matthew Wilcox268f42d2016-12-14 15:08:55 -08001190 iter->node = NULL;
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -05001191 return (void __rcu **)&root->xa_head;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001192 }
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001193
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001194 do {
1195 node = entry_to_node(child);
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001196 offset = radix_tree_descend(node, &child, index);
Ross Zwisler21ef5332016-05-20 17:02:26 -07001197
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001198 if ((flags & RADIX_TREE_ITER_TAGGED) ?
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001199 !tag_get(node, tag, offset) : !child) {
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001200 /* Hole detected */
1201 if (flags & RADIX_TREE_ITER_CONTIG)
1202 return NULL;
1203
1204 if (flags & RADIX_TREE_ITER_TAGGED)
Matthew Wilcoxbc412fc2016-12-14 15:08:40 -08001205 offset = radix_tree_find_next_bit(node, tag,
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001206 offset + 1);
1207 else
1208 while (++offset < RADIX_TREE_MAP_SIZE) {
Matthew Wilcox12320d02017-02-13 15:22:48 -05001209 void *slot = rcu_dereference_raw(
1210 node->slots[offset]);
Ross Zwisler21ef5332016-05-20 17:02:26 -07001211 if (slot)
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001212 break;
1213 }
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001214 index &= ~node_maxindex(node);
Matthew Wilcox9e85d812016-05-20 17:03:48 -07001215 index += offset << node->shift;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001216 /* Overflow after ~0UL */
1217 if (!index)
1218 return NULL;
1219 if (offset == RADIX_TREE_MAP_SIZE)
1220 goto restart;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001221 child = rcu_dereference_raw(node->slots[offset]);
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001222 }
1223
Matthew Wilcoxe157b552016-12-14 15:09:01 -08001224 if (!child)
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001225 goto restart;
Matthew Wilcoxe157b552016-12-14 15:09:01 -08001226 if (child == RADIX_TREE_RETRY)
1227 break;
Matthew Wilcox66ee6202018-06-25 06:56:50 -04001228 } while (node->shift && radix_tree_is_internal_node(child));
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001229
1230 /* Update the iterator state */
Matthew Wilcox3a08cd52018-09-22 16:14:30 -04001231 iter->index = (index &~ node_maxindex(node)) | offset;
Matthew Wilcox8c1244d2016-05-20 17:03:36 -07001232 iter->next_index = (index | node_maxindex(node)) + 1;
Matthew Wilcox268f42d2016-12-14 15:08:55 -08001233 iter->node = node;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001234
Matthew Wilcox148deab2016-12-14 15:08:49 -08001235 if (flags & RADIX_TREE_ITER_TAGGED)
1236 set_iter_tags(iter, node, offset, tag);
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07001237
1238 return node->slots + offset;
1239}
1240EXPORT_SYMBOL(radix_tree_next_chunk);
1241
1242/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243 * radix_tree_gang_lookup - perform multiple lookup on a radix tree
1244 * @root: radix tree root
1245 * @results: where the results of the lookup are placed
1246 * @first_index: start the lookup from this key
1247 * @max_items: place up to this many items at *results
1248 *
1249 * Performs an index-ascending scan of the tree for present items. Places
1250 * them at *@results and returns the number of items which were placed at
1251 * *@results.
1252 *
1253 * The implementation is naive.
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001254 *
1255 * Like radix_tree_lookup, radix_tree_gang_lookup may be called under
1256 * rcu_read_lock. In this case, rather than the returned results being
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001257 * an atomic snapshot of the tree at a single point in time, the
1258 * semantics of an RCU protected gang lookup are as though multiple
1259 * radix_tree_lookups have been issued in individual locks, and results
1260 * stored in 'results'.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 */
1262unsigned int
Matthew Wilcox35534c82016-12-19 17:43:19 -05001263radix_tree_gang_lookup(const struct radix_tree_root *root, void **results,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264 unsigned long first_index, unsigned int max_items)
1265{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001266 struct radix_tree_iter iter;
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001267 void __rcu **slot;
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001268 unsigned int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001270 if (unlikely(!max_items))
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001271 return 0;
1272
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001273 radix_tree_for_each_slot(slot, root, &iter, first_index) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001274 results[ret] = rcu_dereference_raw(*slot);
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001275 if (!results[ret])
1276 continue;
Matthew Wilcoxb194d162016-05-20 17:03:30 -07001277 if (radix_tree_is_internal_node(results[ret])) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001278 slot = radix_tree_iter_retry(&iter);
1279 continue;
1280 }
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001281 if (++ret == max_items)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001284
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 return ret;
1286}
1287EXPORT_SYMBOL(radix_tree_gang_lookup);
1288
Nick Piggin47feff22008-07-25 19:45:29 -07001289/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290 * radix_tree_gang_lookup_tag - perform multiple lookup on a radix tree
1291 * based on a tag
1292 * @root: radix tree root
1293 * @results: where the results of the lookup are placed
1294 * @first_index: start the lookup from this key
1295 * @max_items: place up to this many items at *results
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001296 * @tag: the tag index (< RADIX_TREE_MAX_TAGS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297 *
1298 * Performs an index-ascending scan of the tree for present items which
1299 * have the tag indexed by @tag set. Places the items at *@results and
1300 * returns the number of items which were placed at *@results.
1301 */
1302unsigned int
Matthew Wilcox35534c82016-12-19 17:43:19 -05001303radix_tree_gang_lookup_tag(const struct radix_tree_root *root, void **results,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001304 unsigned long first_index, unsigned int max_items,
1305 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001307 struct radix_tree_iter iter;
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001308 void __rcu **slot;
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001309 unsigned int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001311 if (unlikely(!max_items))
Nick Piggin612d6c12006-06-23 02:03:22 -07001312 return 0;
1313
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001314 radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001315 results[ret] = rcu_dereference_raw(*slot);
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001316 if (!results[ret])
1317 continue;
Matthew Wilcoxb194d162016-05-20 17:03:30 -07001318 if (radix_tree_is_internal_node(results[ret])) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001319 slot = radix_tree_iter_retry(&iter);
1320 continue;
1321 }
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001322 if (++ret == max_items)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001325
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 return ret;
1327}
1328EXPORT_SYMBOL(radix_tree_gang_lookup_tag);
1329
1330/**
Nick Piggin47feff22008-07-25 19:45:29 -07001331 * radix_tree_gang_lookup_tag_slot - perform multiple slot lookup on a
1332 * radix tree based on a tag
1333 * @root: radix tree root
1334 * @results: where the results of the lookup are placed
1335 * @first_index: start the lookup from this key
1336 * @max_items: place up to this many items at *results
1337 * @tag: the tag index (< RADIX_TREE_MAX_TAGS)
1338 *
1339 * Performs an index-ascending scan of the tree for present items which
1340 * have the tag indexed by @tag set. Places the slots at *@results and
1341 * returns the number of slots which were placed at *@results.
1342 */
1343unsigned int
Matthew Wilcox35534c82016-12-19 17:43:19 -05001344radix_tree_gang_lookup_tag_slot(const struct radix_tree_root *root,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001345 void __rcu ***results, unsigned long first_index,
Matthew Wilcox35534c82016-12-19 17:43:19 -05001346 unsigned int max_items, unsigned int tag)
Nick Piggin47feff22008-07-25 19:45:29 -07001347{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001348 struct radix_tree_iter iter;
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001349 void __rcu **slot;
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001350 unsigned int ret = 0;
Nick Piggin47feff22008-07-25 19:45:29 -07001351
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001352 if (unlikely(!max_items))
Nick Piggin47feff22008-07-25 19:45:29 -07001353 return 0;
1354
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001355 radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
1356 results[ret] = slot;
1357 if (++ret == max_items)
Nick Piggin47feff22008-07-25 19:45:29 -07001358 break;
Nick Piggin47feff22008-07-25 19:45:29 -07001359 }
1360
1361 return ret;
1362}
1363EXPORT_SYMBOL(radix_tree_gang_lookup_tag_slot);
1364
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001365static bool __radix_tree_delete(struct radix_tree_root *root,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001366 struct radix_tree_node *node, void __rcu **slot)
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001367{
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001368 void *old = rcu_dereference_raw(*slot);
Matthew Wilcox01959df2017-11-09 09:23:56 -05001369 int values = xa_is_value(old) ? -1 : 0;
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001370 unsigned offset = get_slot_offset(node, slot);
1371 int tag;
1372
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001373 if (is_idr(root))
1374 node_tag_set(root, node, IDR_FREE, offset);
1375 else
1376 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++)
1377 node_tag_clear(root, node, tag, offset);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001378
Matthew Wilcox01959df2017-11-09 09:23:56 -05001379 replace_slot(slot, NULL, node, -1, values);
Matthew Wilcox1cf56f92018-04-09 16:24:45 -04001380 return node && delete_node(root, node);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001381}
1382
Johannes Weiner139e5612014-04-03 14:47:54 -07001383/**
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001384 * radix_tree_iter_delete - delete the entry at this iterator position
1385 * @root: radix tree root
1386 * @iter: iterator state
1387 * @slot: pointer to slot
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 *
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001389 * Delete the entry at the position currently pointed to by the iterator.
1390 * This may result in the current node being freed; if it is, the iterator
1391 * is advanced so that it will not reference the freed memory. This
1392 * function may be called without any locking if there are no other threads
1393 * which can access this tree.
1394 */
1395void radix_tree_iter_delete(struct radix_tree_root *root,
Matthew Wilcoxd7b62722017-02-13 15:58:24 -05001396 struct radix_tree_iter *iter, void __rcu **slot)
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001397{
1398 if (__radix_tree_delete(root, iter->node, slot))
1399 iter->index = iter->next_index;
1400}
Chris Wilsond1b48c12017-08-16 09:52:08 +01001401EXPORT_SYMBOL(radix_tree_iter_delete);
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001402
1403/**
1404 * radix_tree_delete_item - delete an item from a radix tree
1405 * @root: radix tree root
1406 * @index: index key
1407 * @item: expected item
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 *
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001409 * Remove @item at @index from the radix tree rooted at @root.
1410 *
1411 * Return: the deleted entry, or %NULL if it was not present
1412 * or the entry at the given @index was not @item.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 */
Johannes Weiner53c59f22014-04-03 14:47:39 -07001414void *radix_tree_delete_item(struct radix_tree_root *root,
1415 unsigned long index, void *item)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416{
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001417 struct radix_tree_node *node = NULL;
Matthew Wilcox7a4deea2018-05-25 14:47:24 -07001418 void __rcu **slot = NULL;
Johannes Weiner139e5612014-04-03 14:47:54 -07001419 void *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420
Johannes Weiner139e5612014-04-03 14:47:54 -07001421 entry = __radix_tree_lookup(root, index, &node, &slot);
Matthew Wilcox7a4deea2018-05-25 14:47:24 -07001422 if (!slot)
1423 return NULL;
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001424 if (!entry && (!is_idr(root) || node_tag_get(root, node, IDR_FREE,
1425 get_slot_offset(node, slot))))
Johannes Weiner139e5612014-04-03 14:47:54 -07001426 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427
Johannes Weiner139e5612014-04-03 14:47:54 -07001428 if (item && entry != item)
1429 return NULL;
1430
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001431 __radix_tree_delete(root, node, slot);
Christoph Lameter201b6262005-09-06 15:16:46 -07001432
Johannes Weiner139e5612014-04-03 14:47:54 -07001433 return entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434}
Johannes Weiner53c59f22014-04-03 14:47:39 -07001435EXPORT_SYMBOL(radix_tree_delete_item);
1436
1437/**
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001438 * radix_tree_delete - delete an entry from a radix tree
1439 * @root: radix tree root
1440 * @index: index key
Johannes Weiner53c59f22014-04-03 14:47:39 -07001441 *
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001442 * Remove the entry at @index from the radix tree rooted at @root.
Johannes Weiner53c59f22014-04-03 14:47:39 -07001443 *
Matthew Wilcox0ac398e2017-01-28 09:56:22 -05001444 * Return: The deleted entry, or %NULL if it was not present.
Johannes Weiner53c59f22014-04-03 14:47:39 -07001445 */
1446void *radix_tree_delete(struct radix_tree_root *root, unsigned long index)
1447{
1448 return radix_tree_delete_item(root, index, NULL);
1449}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450EXPORT_SYMBOL(radix_tree_delete);
1451
1452/**
1453 * radix_tree_tagged - test whether any items in the tree are tagged
1454 * @root: radix tree root
1455 * @tag: tag to test
1456 */
Matthew Wilcox35534c82016-12-19 17:43:19 -05001457int radix_tree_tagged(const struct radix_tree_root *root, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458{
Nick Piggin612d6c12006-06-23 02:03:22 -07001459 return root_tag_get(root, tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460}
1461EXPORT_SYMBOL(radix_tree_tagged);
1462
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001463/**
1464 * idr_preload - preload for idr_alloc()
1465 * @gfp_mask: allocation mask to use for preloading
1466 *
1467 * Preallocate memory to use for the next call to idr_alloc(). This function
1468 * returns with preemption disabled. It will be enabled by idr_preload_end().
1469 */
1470void idr_preload(gfp_t gfp_mask)
1471{
Eric Dumazetbc9ae222017-09-08 16:15:54 -07001472 if (__radix_tree_preload(gfp_mask, IDR_PRELOAD_SIZE))
1473 preempt_disable();
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001474}
1475EXPORT_SYMBOL(idr_preload);
1476
Matthew Wilcox460488c2017-11-28 15:16:24 -05001477void __rcu **idr_get_free(struct radix_tree_root *root,
Chris Mi388f79f2017-08-30 02:31:57 -04001478 struct radix_tree_iter *iter, gfp_t gfp,
1479 unsigned long max)
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001480{
1481 struct radix_tree_node *node = NULL, *child;
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -05001482 void __rcu **slot = (void __rcu **)&root->xa_head;
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001483 unsigned long maxindex, start = iter->next_index;
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001484 unsigned int shift, offset = 0;
1485
1486 grow:
1487 shift = radix_tree_load_root(root, &child, &maxindex);
1488 if (!radix_tree_tagged(root, IDR_FREE))
1489 start = max(start, maxindex + 1);
1490 if (start > max)
1491 return ERR_PTR(-ENOSPC);
1492
1493 if (start > maxindex) {
1494 int error = radix_tree_extend(root, gfp, start, shift);
1495 if (error < 0)
1496 return ERR_PTR(error);
1497 shift = error;
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -05001498 child = rcu_dereference_raw(root->xa_head);
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001499 }
Matthew Wilcox66ee6202018-06-25 06:56:50 -04001500 if (start == 0 && shift == 0)
1501 shift = RADIX_TREE_MAP_SHIFT;
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001502
1503 while (shift) {
1504 shift -= RADIX_TREE_MAP_SHIFT;
1505 if (child == NULL) {
1506 /* Have to add a child node. */
Matthew Wilcoxd58275b2017-01-16 17:10:21 -05001507 child = radix_tree_node_alloc(gfp, node, root, shift,
1508 offset, 0, 0);
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001509 if (!child)
1510 return ERR_PTR(-ENOMEM);
1511 all_tag_set(child, IDR_FREE);
1512 rcu_assign_pointer(*slot, node_to_entry(child));
1513 if (node)
1514 node->count++;
1515 } else if (!radix_tree_is_internal_node(child))
1516 break;
1517
1518 node = entry_to_node(child);
1519 offset = radix_tree_descend(node, &child, start);
1520 if (!tag_get(node, IDR_FREE, offset)) {
1521 offset = radix_tree_find_next_bit(node, IDR_FREE,
1522 offset + 1);
1523 start = next_index(start, node, offset);
Matthew Wilcox (Oracle)b7e9728f2019-11-02 00:25:08 -04001524 if (start > max || start == 0)
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001525 return ERR_PTR(-ENOSPC);
1526 while (offset == RADIX_TREE_MAP_SIZE) {
1527 offset = node->offset + 1;
1528 node = node->parent;
1529 if (!node)
1530 goto grow;
1531 shift = node->shift;
1532 }
1533 child = rcu_dereference_raw(node->slots[offset]);
1534 }
1535 slot = &node->slots[offset];
1536 }
1537
1538 iter->index = start;
1539 if (node)
1540 iter->next_index = 1 + min(max, (start | node_maxindex(node)));
1541 else
1542 iter->next_index = 1;
1543 iter->node = node;
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001544 set_iter_tags(iter, node, offset, IDR_FREE);
1545
1546 return slot;
1547}
1548
1549/**
1550 * idr_destroy - release all internal memory from an IDR
1551 * @idr: idr handle
1552 *
1553 * After this function is called, the IDR is empty, and may be reused or
1554 * the data structure containing it may be freed.
1555 *
1556 * A typical clean-up sequence for objects stored in an idr tree will use
1557 * idr_for_each() to free all objects, if necessary, then idr_destroy() to
1558 * free the memory used to keep track of those objects.
1559 */
1560void idr_destroy(struct idr *idr)
1561{
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -05001562 struct radix_tree_node *node = rcu_dereference_raw(idr->idr_rt.xa_head);
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001563 if (radix_tree_is_internal_node(node))
1564 radix_tree_free_nodes(node);
Matthew Wilcoxf8d5d0c2017-11-07 16:30:10 -05001565 idr->idr_rt.xa_head = NULL;
Matthew Wilcox0a835c42016-12-20 10:27:56 -05001566 root_tag_set(&idr->idr_rt, IDR_FREE);
1567}
1568EXPORT_SYMBOL(idr_destroy);
1569
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570static void
Johannes Weiner449dd692014-04-03 14:47:56 -07001571radix_tree_node_ctor(void *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572{
Johannes Weiner449dd692014-04-03 14:47:56 -07001573 struct radix_tree_node *node = arg;
1574
1575 memset(node, 0, sizeof(*node));
1576 INIT_LIST_HEAD(&node->private_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577}
1578
Sebastian Andrzej Siewiord544abd2016-11-03 15:50:01 +01001579static int radix_tree_cpu_dead(unsigned int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580{
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001581 struct radix_tree_preload *rtp;
1582 struct radix_tree_node *node;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001584 /* Free per-cpu pool of preloaded nodes */
Sebastian Andrzej Siewiord544abd2016-11-03 15:50:01 +01001585 rtp = &per_cpu(radix_tree_preloads, cpu);
1586 while (rtp->nr) {
1587 node = rtp->nodes;
Matthew Wilcox1293d5c2017-01-16 16:41:29 -05001588 rtp->nodes = node->parent;
Sebastian Andrzej Siewiord544abd2016-11-03 15:50:01 +01001589 kmem_cache_free(radix_tree_node_cachep, node);
1590 rtp->nr--;
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001591 }
Sebastian Andrzej Siewiord544abd2016-11-03 15:50:01 +01001592 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594
1595void __init radix_tree_init(void)
1596{
Sebastian Andrzej Siewiord544abd2016-11-03 15:50:01 +01001597 int ret;
Michal Hocko7e784422017-05-03 14:53:09 -07001598
1599 BUILD_BUG_ON(RADIX_TREE_MAX_TAGS + __GFP_BITS_SHIFT > 32);
Matthew Wilcoxfa290cd2018-04-10 16:36:28 -07001600 BUILD_BUG_ON(ROOT_IS_IDR & ~GFP_ZONEMASK);
Matthew Wilcox02c02bf2017-11-03 23:09:45 -04001601 BUILD_BUG_ON(XA_CHUNK_SIZE > 255);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602 radix_tree_node_cachep = kmem_cache_create("radix_tree_node",
1603 sizeof(struct radix_tree_node), 0,
Christoph Lameter488514d2008-04-28 02:12:05 -07001604 SLAB_PANIC | SLAB_RECLAIM_ACCOUNT,
1605 radix_tree_node_ctor);
Sebastian Andrzej Siewiord544abd2016-11-03 15:50:01 +01001606 ret = cpuhp_setup_state_nocalls(CPUHP_RADIX_DEAD, "lib/radix:dead",
1607 NULL, radix_tree_cpu_dead);
1608 WARN_ON(ret < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609}