SAFE public projects git trees. - safe/jmp/linux-2.6/blob - lib/idr.c

   1 /*
   2  * 2002-10-18  written by Jim Houston jim.houston@ccur.com
   3  *      Copyright (C) 2002 by Concurrent Computer Corporation
   4  *      Distributed under the GNU GPL license version 2.
   5  *
   6  * Modified by George Anzinger to reuse immediately and to use
   7  * find bit instructions.  Also removed _irq on spinlocks.
   8  *
   9  * Small id to pointer translation service.
  10  *
  11  * It uses a radix tree like structure as a sparse array indexed
  12  * by the id to obtain the pointer.  The bitmap makes allocating
  13  * a new id quick.
  14  *
  15  * You call it to allocate an id (an int) an associate with that id a
  16  * pointer or what ever, we treat it as a (void *).  You can pass this
  17  * id to a user for him to pass back at a later time.  You then pass
  18  * that id to this code and it returns your pointer.
  19
  20  * You can release ids at any time. When all ids are released, most of
  21  * the memory is returned (we keep IDR_FREE_MAX) in a local pool so we
  22  * don't need to go to the memory "store" during an id allocate, just
  23  * so you don't need to be too concerned about locking and conflicts
  24  * with the slab allocator.
  25  */
  26
  27 #ifndef TEST                        // to test in user space...
  28 #include <linux/slab.h>
  29 #include <linux/init.h>
  30 #include <linux/module.h>
  31 #endif
  32 #include <linux/err.h>
  33 #include <linux/string.h>
  34 #include <linux/idr.h>
  35
  36 static struct kmem_cache *idr_layer_cache;
  37
  38 static struct idr_layer *alloc_layer(struct idr *idp)
  39 {
  40         struct idr_layer *p;
  41         unsigned long flags;
  42
  43         spin_lock_irqsave(&idp->lock, flags);
  44         if ((p = idp->id_free)) {
  45                 idp->id_free = p->ary[0];
  46                 idp->id_free_cnt--;
  47                 p->ary[0] = NULL;
  48         }
  49         spin_unlock_irqrestore(&idp->lock, flags);
  50         return(p);
  51 }
  52
  53 /* only called when idp->lock is held */
  54 static void __free_layer(struct idr *idp, struct idr_layer *p)
  55 {
  56         p->ary[0] = idp->id_free;
  57         idp->id_free = p;
  58         idp->id_free_cnt++;
  59 }
  60
  61 static void free_layer(struct idr *idp, struct idr_layer *p)
  62 {
  63         unsigned long flags;
  64
  65         /*
  66          * Depends on the return element being zeroed.
  67          */
  68         spin_lock_irqsave(&idp->lock, flags);
  69         __free_layer(idp, p);
  70         spin_unlock_irqrestore(&idp->lock, flags);
  71 }
  72
  73 static void idr_mark_full(struct idr_layer **pa, int id)
  74 {
  75         struct idr_layer *p = pa[0];
  76         int l = 0;
  77
  78         __set_bit(id & IDR_MASK, &p->bitmap);
  79         /*
  80          * If this layer is full mark the bit in the layer above to
  81          * show that this part of the radix tree is full.  This may
  82          * complete the layer above and require walking up the radix
  83          * tree.
  84          */
  85         while (p->bitmap == IDR_FULL) {
  86                 if (!(p = pa[++l]))
  87                         break;
  88                 id = id >> IDR_BITS;
  89                 __set_bit((id & IDR_MASK), &p->bitmap);
  90         }
  91 }
  92
  93 /**
  94  * idr_pre_get - reserver resources for idr allocation
  95  * @idp:        idr handle
  96  * @gfp_mask:   memory allocation flags
  97  *
  98  * This function should be called prior to locking and calling the
  99  * following function.  It preallocates enough memory to satisfy
 100  * the worst possible allocation.
 101  *
 102  * If the system is REALLY out of memory this function returns 0,
 103  * otherwise 1.
 104  */
 105 int idr_pre_get(struct idr *idp, gfp_t gfp_mask)
 106 {
 107         while (idp->id_free_cnt < IDR_FREE_MAX) {
 108                 struct idr_layer *new;
 109                 new = kmem_cache_alloc(idr_layer_cache, gfp_mask);
 110                 if (new == NULL)
 111                         return (0);
 112                 free_layer(idp, new);
 113         }
 114         return 1;
 115 }
 116 EXPORT_SYMBOL(idr_pre_get);
 117
 118 static int sub_alloc(struct idr *idp, int *starting_id, struct idr_layer **pa)
 119 {
 120         int n, m, sh;
 121         struct idr_layer *p, *new;
 122         int l, id, oid;
 123         long bm;
 124
 125         id = *starting_id;
 126  restart:
 127         p = idp->top;
 128         l = idp->layers;
 129         pa[l--] = NULL;
 130         while (1) {
 131                 /*
 132                  * We run around this while until we reach the leaf node...
 133                  */
 134                 n = (id >> (IDR_BITS*l)) & IDR_MASK;
 135                 bm = ~p->bitmap;
 136                 m = find_next_bit(&bm, IDR_SIZE, n);
 137                 if (m == IDR_SIZE) {
 138                         /* no space available go back to previous layer. */
 139                         l++;
 140                         oid = id;
 141                         id = (id | ((1 << (IDR_BITS * l)) - 1)) + 1;
 142
 143                         /* if already at the top layer, we need to grow */
 144                         if (!(p = pa[l])) {
 145                                 *starting_id = id;
 146                                 return -2;
 147                         }
 148
 149                         /* If we need to go up one layer, continue the
 150                          * loop; otherwise, restart from the top.
 151                          */
 152                         sh = IDR_BITS * (l + 1);
 153                         if (oid >> sh == id >> sh)
 154                                 continue;
 155                         else
 156                                 goto restart;
 157                 }
 158                 if (m != n) {
 159                         sh = IDR_BITS*l;
 160                         id = ((id >> sh) ^ n ^ m) << sh;
 161                 }
 162                 if ((id >= MAX_ID_BIT) || (id < 0))
 163                         return -3;
 164                 if (l == 0)
 165                         break;
 166                 /*
 167                  * Create the layer below if it is missing.
 168                  */
 169                 if (!p->ary[m]) {
 170                         if (!(new = alloc_layer(idp)))
 171                                 return -1;
 172                         p->ary[m] = new;
 173                         p->count++;
 174                 }
 175                 pa[l--] = p;
 176                 p = p->ary[m];
 177         }
 178
 179         pa[l] = p;
 180         return id;
 181 }
 182
 183 static int idr_get_empty_slot(struct idr *idp, int starting_id,
 184                               struct idr_layer **pa)
 185 {
 186         struct idr_layer *p, *new;
 187         int layers, v, id;
 188         unsigned long flags;
 189
 190         id = starting_id;
 191 build_up:
 192         p = idp->top;
 193         layers = idp->layers;
 194         if (unlikely(!p)) {
 195                 if (!(p = alloc_layer(idp)))
 196                         return -1;
 197                 layers = 1;
 198         }
 199         /*
 200          * Add a new layer to the top of the tree if the requested
 201          * id is larger than the currently allocated space.
 202          */
 203         while ((layers < (MAX_LEVEL - 1)) && (id >= (1 << (layers*IDR_BITS)))) {
 204                 layers++;
 205                 if (!p->count)
 206                         continue;
 207                 if (!(new = alloc_layer(idp))) {
 208                         /*
 209                          * The allocation failed.  If we built part of
 210                          * the structure tear it down.
 211                          */
 212                         spin_lock_irqsave(&idp->lock, flags);
 213                         for (new = p; p && p != idp->top; new = p) {
 214                                 p = p->ary[0];
 215                                 new->ary[0] = NULL;
 216                                 new->bitmap = new->count = 0;
 217                                 __free_layer(idp, new);
 218                         }
 219                         spin_unlock_irqrestore(&idp->lock, flags);
 220                         return -1;
 221                 }
 222                 new->ary[0] = p;
 223                 new->count = 1;
 224                 if (p->bitmap == IDR_FULL)
 225                         __set_bit(0, &new->bitmap);
 226                 p = new;
 227         }
 228         idp->top = p;
 229         idp->layers = layers;
 230         v = sub_alloc(idp, &id, pa);
 231         if (v == -2)
 232                 goto build_up;
 233         return(v);
 234 }
 235
 236 static int idr_get_new_above_int(struct idr *idp, void *ptr, int starting_id)
 237 {
 238         struct idr_layer *pa[MAX_LEVEL];
 239         int id;
 240
 241         id = idr_get_empty_slot(idp, starting_id, pa);
 242         if (id >= 0) {
 243                 /*
 244                  * Successfully found an empty slot.  Install the user
 245                  * pointer and mark the slot full.
 246                  */
 247                 pa[0]->ary[id & IDR_MASK] = (struct idr_layer *)ptr;
 248                 pa[0]->count++;
 249                 idr_mark_full(pa, id);
 250         }
 251
 252         return id;
 253 }
 254
 255 /**
 256  * idr_get_new_above - allocate new idr entry above or equal to a start id
 257  * @idp: idr handle
 258  * @ptr: pointer you want associated with the ide
 259  * @start_id: id to start search at
 260  * @id: pointer to the allocated handle
 261  *
 262  * This is the allocate id function.  It should be called with any
 263  * required locks.
 264  *
 265  * If memory is required, it will return -EAGAIN, you should unlock
 266  * and go back to the idr_pre_get() call.  If the idr is full, it will
 267  * return -ENOSPC.
 268  *
 269  * @id returns a value in the range 0 ... 0x7fffffff
 270  */
 271 int idr_get_new_above(struct idr *idp, void *ptr, int starting_id, int *id)
 272 {
 273         int rv;
 274
 275         rv = idr_get_new_above_int(idp, ptr, starting_id);
 276         /*
 277          * This is a cheap hack until the IDR code can be fixed to
 278          * return proper error values.
 279          */
 280         if (rv < 0) {
 281                 if (rv == -1)
 282                         return -EAGAIN;
 283                 else /* Will be -3 */
 284                         return -ENOSPC;
 285         }
 286         *id = rv;
 287         return 0;
 288 }
 289 EXPORT_SYMBOL(idr_get_new_above);
 290
 291 /**
 292  * idr_get_new - allocate new idr entry
 293  * @idp: idr handle
 294  * @ptr: pointer you want associated with the ide
 295  * @id: pointer to the allocated handle
 296  *
 297  * This is the allocate id function.  It should be called with any
 298  * required locks.
 299  *
 300  * If memory is required, it will return -EAGAIN, you should unlock
 301  * and go back to the idr_pre_get() call.  If the idr is full, it will
 302  * return -ENOSPC.
 303  *
 304  * @id returns a value in the range 0 ... 0x7fffffff
 305  */
 306 int idr_get_new(struct idr *idp, void *ptr, int *id)
 307 {
 308         int rv;
 309
 310         rv = idr_get_new_above_int(idp, ptr, 0);
 311         /*
 312          * This is a cheap hack until the IDR code can be fixed to
 313          * return proper error values.
 314          */
 315         if (rv < 0) {
 316                 if (rv == -1)
 317                         return -EAGAIN;
 318                 else /* Will be -3 */
 319                         return -ENOSPC;
 320         }
 321         *id = rv;
 322         return 0;
 323 }
 324 EXPORT_SYMBOL(idr_get_new);
 325
 326 static void idr_remove_warning(int id)
 327 {
 328         printk("idr_remove called for id=%d which is not allocated.\n", id);
 329         dump_stack();
 330 }
 331
 332 static void sub_remove(struct idr *idp, int shift, int id)
 333 {
 334         struct idr_layer *p = idp->top;
 335         struct idr_layer **pa[MAX_LEVEL];
 336         struct idr_layer ***paa = &pa[0];
 337         int n;
 338
 339         *paa = NULL;
 340         *++paa = &idp->top;
 341
 342         while ((shift > 0) && p) {
 343                 n = (id >> shift) & IDR_MASK;
 344                 __clear_bit(n, &p->bitmap);
 345                 *++paa = &p->ary[n];
 346                 p = p->ary[n];
 347                 shift -= IDR_BITS;
 348         }
 349         n = id & IDR_MASK;
 350         if (likely(p != NULL && test_bit(n, &p->bitmap))){
 351                 __clear_bit(n, &p->bitmap);
 352                 p->ary[n] = NULL;
 353                 while(*paa && ! --((**paa)->count)){
 354                         free_layer(idp, **paa);
 355                         **paa-- = NULL;
 356                 }
 357                 if (!*paa)
 358                         idp->layers = 0;
 359         } else
 360                 idr_remove_warning(id);
 361 }
 362
 363 /**
 364  * idr_remove - remove the given id and free it's slot
 365  * @idp: idr handle
 366  * @id: unique key
 367  */
 368 void idr_remove(struct idr *idp, int id)
 369 {
 370         struct idr_layer *p;
 371
 372         /* Mask off upper bits we don't use for the search. */
 373         id &= MAX_ID_MASK;
 374
 375         sub_remove(idp, (idp->layers - 1) * IDR_BITS, id);
 376         if (idp->top && idp->top->count == 1 && (idp->layers > 1) &&
 377             idp->top->ary[0]) {  // We can drop a layer
 378
 379                 p = idp->top->ary[0];
 380                 idp->top->bitmap = idp->top->count = 0;
 381                 free_layer(idp, idp->top);
 382                 idp->top = p;
 383                 --idp->layers;
 384         }
 385         while (idp->id_free_cnt >= IDR_FREE_MAX) {
 386                 p = alloc_layer(idp);
 387                 kmem_cache_free(idr_layer_cache, p);
 388                 return;
 389         }
 390 }
 391 EXPORT_SYMBOL(idr_remove);
 392
 393 /**
 394  * idr_destroy - release all cached layers within an idr tree
 395  * idp: idr handle
 396  */
 397 void idr_destroy(struct idr *idp)
 398 {
 399         while (idp->id_free_cnt) {
 400                 struct idr_layer *p = alloc_layer(idp);
 401                 kmem_cache_free(idr_layer_cache, p);
 402         }
 403 }
 404 EXPORT_SYMBOL(idr_destroy);
 405
 406 /**
 407  * idr_find - return pointer for given id
 408  * @idp: idr handle
 409  * @id: lookup key
 410  *
 411  * Return the pointer given the id it has been registered with.  A %NULL
 412  * return indicates that @id is not valid or you passed %NULL in
 413  * idr_get_new().
 414  *
 415  * The caller must serialize idr_find() vs idr_get_new() and idr_remove().
 416  */
 417 void *idr_find(struct idr *idp, int id)
 418 {
 419         int n;
 420         struct idr_layer *p;
 421
 422         n = idp->layers * IDR_BITS;
 423         p = idp->top;
 424
 425         /* Mask off upper bits we don't use for the search. */
 426         id &= MAX_ID_MASK;
 427
 428         if (id >= (1 << n))
 429                 return NULL;
 430
 431         while (n > 0 && p) {
 432                 n -= IDR_BITS;
 433                 p = p->ary[(id >> n) & IDR_MASK];
 434         }
 435         return((void *)p);
 436 }
 437 EXPORT_SYMBOL(idr_find);
 438
 439 /**
 440  * idr_replace - replace pointer for given id
 441  * @idp: idr handle
 442  * @ptr: pointer you want associated with the id
 443  * @id: lookup key
 444  *
 445  * Replace the pointer registered with an id and return the old value.
 446  * A -ENOENT return indicates that @id was not found.
 447  * A -EINVAL return indicates that @id was not within valid constraints.
 448  *
 449  * The caller must serialize vs idr_find(), idr_get_new(), and idr_remove().
 450  */
 451 void *idr_replace(struct idr *idp, void *ptr, int id)
 452 {
 453         int n;
 454         struct idr_layer *p, *old_p;
 455
 456         n = idp->layers * IDR_BITS;
 457         p = idp->top;
 458
 459         id &= MAX_ID_MASK;
 460
 461         if (id >= (1 << n))
 462                 return ERR_PTR(-EINVAL);
 463
 464         n -= IDR_BITS;
 465         while ((n > 0) && p) {
 466                 p = p->ary[(id >> n) & IDR_MASK];
 467                 n -= IDR_BITS;
 468         }
 469
 470         n = id & IDR_MASK;
 471         if (unlikely(p == NULL || !test_bit(n, &p->bitmap)))
 472                 return ERR_PTR(-ENOENT);
 473
 474         old_p = p->ary[n];
 475         p->ary[n] = ptr;
 476
 477         return old_p;
 478 }
 479 EXPORT_SYMBOL(idr_replace);
 480
 481 static void idr_cache_ctor(void * idr_layer, struct kmem_cache *idr_layer_cache,
 482                 unsigned long flags)
 483 {
 484         memset(idr_layer, 0, sizeof(struct idr_layer));
 485 }
 486
 487 static  int init_id_cache(void)
 488 {
 489         if (!idr_layer_cache)
 490                 idr_layer_cache = kmem_cache_create("idr_layer_cache",
 491                         sizeof(struct idr_layer), 0, 0, idr_cache_ctor, NULL);
 492         return 0;
 493 }
 494
 495 /**
 496  * idr_init - initialize idr handle
 497  * @idp:        idr handle
 498  *
 499  * This function is use to set up the handle (@idp) that you will pass
 500  * to the rest of the functions.
 501  */
 502 void idr_init(struct idr *idp)
 503 {
 504         init_id_cache();
 505         memset(idp, 0, sizeof(struct idr));
 506         spin_lock_init(&idp->lock);
 507 }
 508 EXPORT_SYMBOL(idr_init);