git.rot13.org Git - linux/blob - include/linux/radix-tree.h

   1 /*
   2  * Copyright (C) 2001 Momchil Velikov
   3  * Portions Copyright (C) 2001 Christoph Hellwig
   4  * Copyright (C) 2006 Nick Piggin
   5  * Copyright (C) 2012 Konstantin Khlebnikov
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License as
   9  * published by the Free Software Foundation; either version 2, or (at
  10  * your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  */
  21 #ifndef _LINUX_RADIX_TREE_H
  22 #define _LINUX_RADIX_TREE_H
  23
  24 #include <linux/bitops.h>
  25 #include <linux/preempt.h>
  26 #include <linux/types.h>
  27 #include <linux/bug.h>
  28 #include <linux/kernel.h>
  29 #include <linux/rcupdate.h>
  30
  31 /*
  32  * The bottom two bits of the slot determine how the remaining bits in the
  33  * slot are interpreted:
  34  *
  35  * 00 - data pointer
  36  * 01 - internal entry
  37  * 10 - exceptional entry
  38  * 11 - this bit combination is currently unused/reserved
  39  *
  40  * The internal entry may be a pointer to the next level in the tree, a
  41  * sibling entry, or an indicator that the entry in this slot has been moved
  42  * to another location in the tree and the lookup should be restarted.  While
  43  * NULL fits the 'data pointer' pattern, it means that there is no entry in
  44  * the tree for this index (no matter what level of the tree it is found at).
  45  * This means that you cannot store NULL in the tree as a value for the index.
  46  */
  47 #define RADIX_TREE_ENTRY_MASK           3UL
  48 #define RADIX_TREE_INTERNAL_NODE        1UL
  49
  50 /*
  51  * Most users of the radix tree store pointers but shmem/tmpfs stores swap
  52  * entries in the same tree.  They are marked as exceptional entries to
  53  * distinguish them from pointers to struct page.
  54  * EXCEPTIONAL_ENTRY tests the bit, EXCEPTIONAL_SHIFT shifts content past it.
  55  */
  56 #define RADIX_TREE_EXCEPTIONAL_ENTRY    2
  57 #define RADIX_TREE_EXCEPTIONAL_SHIFT    2
  58
  59 static inline bool radix_tree_is_internal_node(void *ptr)
  60 {
  61         return ((unsigned long)ptr & RADIX_TREE_ENTRY_MASK) ==
  62                                 RADIX_TREE_INTERNAL_NODE;
  63 }
  64
  65 /*** radix-tree API starts here ***/
  66
  67 #define RADIX_TREE_MAX_TAGS 3
  68
  69 #ifndef RADIX_TREE_MAP_SHIFT
  70 #define RADIX_TREE_MAP_SHIFT    (CONFIG_BASE_SMALL ? 4 : 6)
  71 #endif
  72
  73 #define RADIX_TREE_MAP_SIZE     (1UL << RADIX_TREE_MAP_SHIFT)
  74 #define RADIX_TREE_MAP_MASK     (RADIX_TREE_MAP_SIZE-1)
  75
  76 #define RADIX_TREE_TAG_LONGS    \
  77         ((RADIX_TREE_MAP_SIZE + BITS_PER_LONG - 1) / BITS_PER_LONG)
  78
  79 #define RADIX_TREE_INDEX_BITS  (8 /* CHAR_BIT */ * sizeof(unsigned long))
  80 #define RADIX_TREE_MAX_PATH (DIV_ROUND_UP(RADIX_TREE_INDEX_BITS, \
  81                                           RADIX_TREE_MAP_SHIFT))
  82
  83 struct radix_tree_node {
  84         unsigned char   shift;          /* Bits remaining in each slot */
  85         unsigned char   offset;         /* Slot offset in parent */
  86         unsigned char   count;          /* Total entry count */
  87         unsigned char   exceptional;    /* Exceptional entry count */
  88         struct radix_tree_node *parent;         /* Used when ascending tree */
  89         void *private_data;                     /* For tree user */
  90         union {
  91                 struct list_head private_list;  /* For tree user */
  92                 struct rcu_head rcu_head;       /* Used when freeing node */
  93         };
  94         void __rcu      *slots[RADIX_TREE_MAP_SIZE];
  95         unsigned long   tags[RADIX_TREE_MAX_TAGS][RADIX_TREE_TAG_LONGS];
  96 };
  97
  98 /* root tags are stored in gfp_mask, shifted by __GFP_BITS_SHIFT */
  99 struct radix_tree_root {
 100         gfp_t                   gfp_mask;
 101         struct radix_tree_node  __rcu *rnode;
 102 };
 103
 104 #define RADIX_TREE_INIT(mask)   {                                       \
 105         .gfp_mask = (mask),                                             \
 106         .rnode = NULL,                                                  \
 107 }
 108
 109 #define RADIX_TREE(name, mask) \
 110         struct radix_tree_root name = RADIX_TREE_INIT(mask)
 111
 112 #define INIT_RADIX_TREE(root, mask)                                     \
 113 do {                                                                    \
 114         (root)->gfp_mask = (mask);                                      \
 115         (root)->rnode = NULL;                                           \
 116 } while (0)
 117
 118 static inline bool radix_tree_empty(struct radix_tree_root *root)
 119 {
 120         return root->rnode == NULL;
 121 }
 122
 123 /**
 124  * struct radix_tree_iter - radix tree iterator state
 125  *
 126  * @index:      index of current slot
 127  * @next_index: one beyond the last index for this chunk
 128  * @tags:       bit-mask for tag-iterating
 129  * @node:       node that contains current slot
 130  * @shift:      shift for the node that holds our slots
 131  *
 132  * This radix tree iterator works in terms of "chunks" of slots.  A chunk is a
 133  * subinterval of slots contained within one radix tree leaf node.  It is
 134  * described by a pointer to its first slot and a struct radix_tree_iter
 135  * which holds the chunk's position in the tree and its size.  For tagged
 136  * iteration radix_tree_iter also holds the slots' bit-mask for one chosen
 137  * radix tree tag.
 138  */
 139 struct radix_tree_iter {
 140         unsigned long   index;
 141         unsigned long   next_index;
 142         unsigned long   tags;
 143         struct radix_tree_node *node;
 144 #ifdef CONFIG_RADIX_TREE_MULTIORDER
 145         unsigned int    shift;
 146 #endif
 147 };
 148
 149 static inline unsigned int iter_shift(const struct radix_tree_iter *iter)
 150 {
 151 #ifdef CONFIG_RADIX_TREE_MULTIORDER
 152         return iter->shift;
 153 #else
 154         return 0;
 155 #endif
 156 }
 157
 158 /**
 159  * Radix-tree synchronization
 160  *
 161  * The radix-tree API requires that users provide all synchronisation (with
 162  * specific exceptions, noted below).
 163  *
 164  * Synchronization of access to the data items being stored in the tree, and
 165  * management of their lifetimes must be completely managed by API users.
 166  *
 167  * For API usage, in general,
 168  * - any function _modifying_ the tree or tags (inserting or deleting
 169  *   items, setting or clearing tags) must exclude other modifications, and
 170  *   exclude any functions reading the tree.
 171  * - any function _reading_ the tree or tags (looking up items or tags,
 172  *   gang lookups) must exclude modifications to the tree, but may occur
 173  *   concurrently with other readers.
 174  *
 175  * The notable exceptions to this rule are the following functions:
 176  * __radix_tree_lookup
 177  * radix_tree_lookup
 178  * radix_tree_lookup_slot
 179  * radix_tree_tag_get
 180  * radix_tree_gang_lookup
 181  * radix_tree_gang_lookup_slot
 182  * radix_tree_gang_lookup_tag
 183  * radix_tree_gang_lookup_tag_slot
 184  * radix_tree_tagged
 185  *
 186  * The first 8 functions are able to be called locklessly, using RCU. The
 187  * caller must ensure calls to these functions are made within rcu_read_lock()
 188  * regions. Other readers (lock-free or otherwise) and modifications may be
 189  * running concurrently.
 190  *
 191  * It is still required that the caller manage the synchronization and lifetimes
 192  * of the items. So if RCU lock-free lookups are used, typically this would mean
 193  * that the items have their own locks, or are amenable to lock-free access; and
 194  * that the items are freed by RCU (or only freed after having been deleted from
 195  * the radix tree *and* a synchronize_rcu() grace period).
 196  *
 197  * (Note, rcu_assign_pointer and rcu_dereference are not needed to control
 198  * access to data items when inserting into or looking up from the radix tree)
 199  *
 200  * Note that the value returned by radix_tree_tag_get() may not be relied upon
 201  * if only the RCU read lock is held.  Functions to set/clear tags and to
 202  * delete nodes running concurrently with it may affect its result such that
 203  * two consecutive reads in the same locked section may return different
 204  * values.  If reliability is required, modification functions must also be
 205  * excluded from concurrency.
 206  *
 207  * radix_tree_tagged is able to be called without locking or RCU.
 208  */
 209
 210 /**
 211  * radix_tree_deref_slot        - dereference a slot
 212  * @pslot:      pointer to slot, returned by radix_tree_lookup_slot
 213  * Returns:     item that was stored in that slot with any direct pointer flag
 214  *              removed.
 215  *
 216  * For use with radix_tree_lookup_slot().  Caller must hold tree at least read
 217  * locked across slot lookup and dereference. Not required if write lock is
 218  * held (ie. items cannot be concurrently inserted).
 219  *
 220  * radix_tree_deref_retry must be used to confirm validity of the pointer if
 221  * only the read lock is held.
 222  */
 223 static inline void *radix_tree_deref_slot(void **pslot)
 224 {
 225         return rcu_dereference(*pslot);
 226 }
 227
 228 /**
 229  * radix_tree_deref_slot_protected      - dereference a slot without RCU lock but with tree lock held
 230  * @pslot:      pointer to slot, returned by radix_tree_lookup_slot
 231  * Returns:     item that was stored in that slot with any direct pointer flag
 232  *              removed.
 233  *
 234  * Similar to radix_tree_deref_slot but only used during migration when a pages
 235  * mapping is being moved. The caller does not hold the RCU read lock but it
 236  * must hold the tree lock to prevent parallel updates.
 237  */
 238 static inline void *radix_tree_deref_slot_protected(void **pslot,
 239                                                         spinlock_t *treelock)
 240 {
 241         return rcu_dereference_protected(*pslot, lockdep_is_held(treelock));
 242 }
 243
 244 /**
 245  * radix_tree_deref_retry       - check radix_tree_deref_slot
 246  * @arg:        pointer returned by radix_tree_deref_slot
 247  * Returns:     0 if retry is not required, otherwise retry is required
 248  *
 249  * radix_tree_deref_retry must be used with radix_tree_deref_slot.
 250  */
 251 static inline int radix_tree_deref_retry(void *arg)
 252 {
 253         return unlikely(radix_tree_is_internal_node(arg));
 254 }
 255
 256 /**
 257  * radix_tree_exceptional_entry - radix_tree_deref_slot gave exceptional entry?
 258  * @arg:        value returned by radix_tree_deref_slot
 259  * Returns:     0 if well-aligned pointer, non-0 if exceptional entry.
 260  */
 261 static inline int radix_tree_exceptional_entry(void *arg)
 262 {
 263         /* Not unlikely because radix_tree_exception often tested first */
 264         return (unsigned long)arg & RADIX_TREE_EXCEPTIONAL_ENTRY;
 265 }
 266
 267 /**
 268  * radix_tree_exception - radix_tree_deref_slot returned either exception?
 269  * @arg:        value returned by radix_tree_deref_slot
 270  * Returns:     0 if well-aligned pointer, non-0 if either kind of exception.
 271  */
 272 static inline int radix_tree_exception(void *arg)
 273 {
 274         return unlikely((unsigned long)arg & RADIX_TREE_ENTRY_MASK);
 275 }
 276
 277 int __radix_tree_create(struct radix_tree_root *root, unsigned long index,
 278                         unsigned order, struct radix_tree_node **nodep,
 279                         void ***slotp);
 280 int __radix_tree_insert(struct radix_tree_root *, unsigned long index,
 281                         unsigned order, void *);
 282 static inline int radix_tree_insert(struct radix_tree_root *root,
 283                         unsigned long index, void *entry)
 284 {
 285         return __radix_tree_insert(root, index, 0, entry);
 286 }
 287 void *__radix_tree_lookup(struct radix_tree_root *root, unsigned long index,
 288                           struct radix_tree_node **nodep, void ***slotp);
 289 void *radix_tree_lookup(struct radix_tree_root *, unsigned long);
 290 void **radix_tree_lookup_slot(struct radix_tree_root *, unsigned long);
 291 typedef void (*radix_tree_update_node_t)(struct radix_tree_node *, void *);
 292 void __radix_tree_replace(struct radix_tree_root *root,
 293                           struct radix_tree_node *node,
 294                           void **slot, void *item,
 295                           radix_tree_update_node_t update_node, void *private);
 296 void radix_tree_replace_slot(struct radix_tree_root *root,
 297                              void **slot, void *item);
 298 void __radix_tree_delete_node(struct radix_tree_root *root,
 299                               struct radix_tree_node *node);
 300 void *radix_tree_delete_item(struct radix_tree_root *, unsigned long, void *);
 301 void *radix_tree_delete(struct radix_tree_root *, unsigned long);
 302 void radix_tree_clear_tags(struct radix_tree_root *root,
 303                            struct radix_tree_node *node,
 304                            void **slot);
 305 unsigned int radix_tree_gang_lookup(struct radix_tree_root *root,
 306                         void **results, unsigned long first_index,
 307                         unsigned int max_items);
 308 unsigned int radix_tree_gang_lookup_slot(struct radix_tree_root *root,
 309                         void ***results, unsigned long *indices,
 310                         unsigned long first_index, unsigned int max_items);
 311 int radix_tree_preload(gfp_t gfp_mask);
 312 int radix_tree_maybe_preload(gfp_t gfp_mask);
 313 int radix_tree_maybe_preload_order(gfp_t gfp_mask, int order);
 314 void radix_tree_init(void);
 315 void *radix_tree_tag_set(struct radix_tree_root *root,
 316                         unsigned long index, unsigned int tag);
 317 void *radix_tree_tag_clear(struct radix_tree_root *root,
 318                         unsigned long index, unsigned int tag);
 319 int radix_tree_tag_get(struct radix_tree_root *root,
 320                         unsigned long index, unsigned int tag);
 321 void radix_tree_iter_tag_set(struct radix_tree_root *root,
 322                 const struct radix_tree_iter *iter, unsigned int tag);
 323 unsigned int
 324 radix_tree_gang_lookup_tag(struct radix_tree_root *root, void **results,
 325                 unsigned long first_index, unsigned int max_items,
 326                 unsigned int tag);
 327 unsigned int
 328 radix_tree_gang_lookup_tag_slot(struct radix_tree_root *root, void ***results,
 329                 unsigned long first_index, unsigned int max_items,
 330                 unsigned int tag);
 331 int radix_tree_tagged(struct radix_tree_root *root, unsigned int tag);
 332
 333 static inline void radix_tree_preload_end(void)
 334 {
 335         preempt_enable();
 336 }
 337
 338 int radix_tree_join(struct radix_tree_root *, unsigned long index,
 339                         unsigned new_order, void *);
 340
 341 #define RADIX_TREE_ITER_TAG_MASK        0x00FF  /* tag index in lower byte */
 342 #define RADIX_TREE_ITER_TAGGED          0x0100  /* lookup tagged slots */
 343 #define RADIX_TREE_ITER_CONTIG          0x0200  /* stop at first hole */
 344
 345 /**
 346  * radix_tree_iter_init - initialize radix tree iterator
 347  *
 348  * @iter:       pointer to iterator state
 349  * @start:      iteration starting index
 350  * Returns:     NULL
 351  */
 352 static __always_inline void **
 353 radix_tree_iter_init(struct radix_tree_iter *iter, unsigned long start)
 354 {
 355         /*
 356          * Leave iter->tags uninitialized. radix_tree_next_chunk() will fill it
 357          * in the case of a successful tagged chunk lookup.  If the lookup was
 358          * unsuccessful or non-tagged then nobody cares about ->tags.
 359          *
 360          * Set index to zero to bypass next_index overflow protection.
 361          * See the comment in radix_tree_next_chunk() for details.
 362          */
 363         iter->index = 0;
 364         iter->next_index = start;
 365         return NULL;
 366 }
 367
 368 /**
 369  * radix_tree_next_chunk - find next chunk of slots for iteration
 370  *
 371  * @root:       radix tree root
 372  * @iter:       iterator state
 373  * @flags:      RADIX_TREE_ITER_* flags and tag index
 374  * Returns:     pointer to chunk first slot, or NULL if there no more left
 375  *
 376  * This function looks up the next chunk in the radix tree starting from
 377  * @iter->next_index.  It returns a pointer to the chunk's first slot.
 378  * Also it fills @iter with data about chunk: position in the tree (index),
 379  * its end (next_index), and constructs a bit mask for tagged iterating (tags).
 380  */
 381 void **radix_tree_next_chunk(struct radix_tree_root *root,
 382                              struct radix_tree_iter *iter, unsigned flags);
 383
 384 /**
 385  * radix_tree_iter_retry - retry this chunk of the iteration
 386  * @iter:       iterator state
 387  *
 388  * If we iterate over a tree protected only by the RCU lock, a race
 389  * against deletion or creation may result in seeing a slot for which
 390  * radix_tree_deref_retry() returns true.  If so, call this function
 391  * and continue the iteration.
 392  */
 393 static inline __must_check
 394 void **radix_tree_iter_retry(struct radix_tree_iter *iter)
 395 {
 396         iter->next_index = iter->index;
 397         iter->tags = 0;
 398         return NULL;
 399 }
 400
 401 static inline unsigned long
 402 __radix_tree_iter_add(struct radix_tree_iter *iter, unsigned long slots)
 403 {
 404         return iter->index + (slots << iter_shift(iter));
 405 }
 406
 407 /**
 408  * radix_tree_iter_resume - resume iterating when the chunk may be invalid
 409  * @slot: pointer to current slot
 410  * @iter: iterator state
 411  * Returns: New slot pointer
 412  *
 413  * If the iterator needs to release then reacquire a lock, the chunk may
 414  * have been invalidated by an insertion or deletion.  Call this function
 415  * before releasing the lock to continue the iteration from the next index.
 416  */
 417 void **__must_check radix_tree_iter_resume(void **slot,
 418                                         struct radix_tree_iter *iter);
 419
 420 /**
 421  * radix_tree_chunk_size - get current chunk size
 422  *
 423  * @iter:       pointer to radix tree iterator
 424  * Returns:     current chunk size
 425  */
 426 static __always_inline long
 427 radix_tree_chunk_size(struct radix_tree_iter *iter)
 428 {
 429         return (iter->next_index - iter->index) >> iter_shift(iter);
 430 }
 431
 432 #ifdef CONFIG_RADIX_TREE_MULTIORDER
 433 void ** __radix_tree_next_slot(void **slot, struct radix_tree_iter *iter,
 434                                 unsigned flags);
 435 #else
 436 /* Can't happen without sibling entries, but the compiler can't tell that */
 437 static inline void ** __radix_tree_next_slot(void **slot,
 438                                 struct radix_tree_iter *iter, unsigned flags)
 439 {
 440         return slot;
 441 }
 442 #endif
 443
 444 /**
 445  * radix_tree_next_slot - find next slot in chunk
 446  *
 447  * @slot:       pointer to current slot
 448  * @iter:       pointer to interator state
 449  * @flags:      RADIX_TREE_ITER_*, should be constant
 450  * Returns:     pointer to next slot, or NULL if there no more left
 451  *
 452  * This function updates @iter->index in the case of a successful lookup.
 453  * For tagged lookup it also eats @iter->tags.
 454  *
 455  * There are several cases where 'slot' can be passed in as NULL to this
 456  * function.  These cases result from the use of radix_tree_iter_resume() or
 457  * radix_tree_iter_retry().  In these cases we don't end up dereferencing
 458  * 'slot' because either:
 459  * a) we are doing tagged iteration and iter->tags has been set to 0, or
 460  * b) we are doing non-tagged iteration, and iter->index and iter->next_index
 461  *    have been set up so that radix_tree_chunk_size() returns 1 or 0.
 462  */
 463 static __always_inline void **
 464 radix_tree_next_slot(void **slot, struct radix_tree_iter *iter, unsigned flags)
 465 {
 466         if (flags & RADIX_TREE_ITER_TAGGED) {
 467                 iter->tags >>= 1;
 468                 if (unlikely(!iter->tags))
 469                         return NULL;
 470                 if (likely(iter->tags & 1ul)) {
 471                         iter->index = __radix_tree_iter_add(iter, 1);
 472                         slot++;
 473                         goto found;
 474                 }
 475                 if (!(flags & RADIX_TREE_ITER_CONTIG)) {
 476                         unsigned offset = __ffs(iter->tags);
 477
 478                         iter->tags >>= offset++;
 479                         iter->index = __radix_tree_iter_add(iter, offset);
 480                         slot += offset;
 481                         goto found;
 482                 }
 483         } else {
 484                 long count = radix_tree_chunk_size(iter);
 485
 486                 while (--count > 0) {
 487                         slot++;
 488                         iter->index = __radix_tree_iter_add(iter, 1);
 489
 490                         if (likely(*slot))
 491                                 goto found;
 492                         if (flags & RADIX_TREE_ITER_CONTIG) {
 493                                 /* forbid switching to the next chunk */
 494                                 iter->next_index = 0;
 495                                 break;
 496                         }
 497                 }
 498         }
 499         return NULL;
 500
 501  found:
 502         if (unlikely(radix_tree_is_internal_node(*slot)))
 503                 return __radix_tree_next_slot(slot, iter, flags);
 504         return slot;
 505 }
 506
 507 /**
 508  * radix_tree_for_each_slot - iterate over non-empty slots
 509  *
 510  * @slot:       the void** variable for pointer to slot
 511  * @root:       the struct radix_tree_root pointer
 512  * @iter:       the struct radix_tree_iter pointer
 513  * @start:      iteration starting index
 514  *
 515  * @slot points to radix tree slot, @iter->index contains its index.
 516  */
 517 #define radix_tree_for_each_slot(slot, root, iter, start)               \
 518         for (slot = radix_tree_iter_init(iter, start) ;                 \
 519              slot || (slot = radix_tree_next_chunk(root, iter, 0)) ;    \
 520              slot = radix_tree_next_slot(slot, iter, 0))
 521
 522 /**
 523  * radix_tree_for_each_contig - iterate over contiguous slots
 524  *
 525  * @slot:       the void** variable for pointer to slot
 526  * @root:       the struct radix_tree_root pointer
 527  * @iter:       the struct radix_tree_iter pointer
 528  * @start:      iteration starting index
 529  *
 530  * @slot points to radix tree slot, @iter->index contains its index.
 531  */
 532 #define radix_tree_for_each_contig(slot, root, iter, start)             \
 533         for (slot = radix_tree_iter_init(iter, start) ;                 \
 534              slot || (slot = radix_tree_next_chunk(root, iter,          \
 535                                 RADIX_TREE_ITER_CONTIG)) ;              \
 536              slot = radix_tree_next_slot(slot, iter,                    \
 537                                 RADIX_TREE_ITER_CONTIG))
 538
 539 /**
 540  * radix_tree_for_each_tagged - iterate over tagged slots
 541  *
 542  * @slot:       the void** variable for pointer to slot
 543  * @root:       the struct radix_tree_root pointer
 544  * @iter:       the struct radix_tree_iter pointer
 545  * @start:      iteration starting index
 546  * @tag:        tag index
 547  *
 548  * @slot points to radix tree slot, @iter->index contains its index.
 549  */
 550 #define radix_tree_for_each_tagged(slot, root, iter, start, tag)        \
 551         for (slot = radix_tree_iter_init(iter, start) ;                 \
 552              slot || (slot = radix_tree_next_chunk(root, iter,          \
 553                               RADIX_TREE_ITER_TAGGED | tag)) ;          \
 554              slot = radix_tree_next_slot(slot, iter,                    \
 555                                 RADIX_TREE_ITER_TAGGED | tag))
 556
 557 #endif /* _LINUX_RADIX_TREE_H */