src/vppinfra/pool.h

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 /*
  16   Copyright (c) 2001, 2002, 2003, 2004 Eliot Dresselhaus
  17
  18   Permission is hereby granted, free of charge, to any person obtaining
  19   a copy of this software and associated documentation files (the
  20   "Software"), to deal in the Software without restriction, including
  21   without limitation the rights to use, copy, modify, merge, publish,
  22   distribute, sublicense, and/or sell copies of the Software, and to
  23   permit persons to whom the Software is furnished to do so, subject to
  24   the following conditions:
  25
  26   The above copyright notice and this permission notice shall be
  27   included in all copies or substantial portions of the Software.
  28
  29   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  30   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  31   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  32   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  33   LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  34   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  35   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  36 */
  37 /** @file
  38  * @brief Fixed length block allocator.
  39    Pools are built from clib vectors and bitmaps. Use pools when
  40    repeatedly allocating and freeing fixed-size data. Pools are
  41    fast, and avoid memory fragmentation.
  42  */
  43
  44 #ifndef included_pool_h
  45 #define included_pool_h
  46
  47 #include <vppinfra/bitmap.h>
  48 #include <vppinfra/error.h>
  49
  50
  51 typedef struct
  52 {
  53   /** Bitmap of indices of free objects. */
  54   uword *free_bitmap;
  55
  56   /** Vector of free indices.  One element for each set bit in bitmap. */
  57   u32 *free_indices;
  58
  59   /* The following fields are set for fixed-size, preallocated pools */
  60
  61   /** Maximum size of the pool, in elements */
  62   u32 max_elts;
  63
  64 } pool_header_t;
  65
  66 /** Get pool header from user pool pointer */
  67 always_inline pool_header_t *
  68 pool_header (void *v)
  69 {
  70   return vec_header (v);
  71 }
  72
  73 void _pool_init_fixed (void **pool_ptr, uword elt_sz, uword max_elts,
  74                        uword align);
  75
  76 /** initialize a fixed-size, preallocated pool */
  77 #define pool_init_fixed(P, E)                                                 \
  78   _pool_init_fixed ((void **) &(P), _vec_elt_sz (P), E, _vec_align (P, 0));
  79
  80 /** Validate a pool */
  81 always_inline void
  82 pool_validate (void *v)
  83 {
  84   pool_header_t *p = pool_header (v);
  85   uword i, n_free_bitmap;
  86
  87   if (!v)
  88     return;
  89
  90   n_free_bitmap = clib_bitmap_count_set_bits (p->free_bitmap);
  91   ASSERT (n_free_bitmap == vec_len (p->free_indices));
  92   for (i = 0; i < vec_len (p->free_indices); i++)
  93     ASSERT (clib_bitmap_get (p->free_bitmap, p->free_indices[i]) == 1);
  94 }
  95
  96 /** Number of active elements in a pool.
  97  * @return Number of active elements in a pool
  98  */
  99 always_inline uword
 100 pool_elts (void *v)
 101 {
 102   uword ret = vec_len (v);
 103   if (v)
 104     ret -= vec_len (pool_header (v)->free_indices);
 105   return ret;
 106 }
 107
 108 /** Number of elements in pool vector.
 109
 110     @note You probably want to call pool_elts() instead.
 111 */
 112 #define pool_len(p)     vec_len(p)
 113
 114 /** Number of elements in pool vector (usable as an lvalue)
 115
 116     @note You probably don't want to use this macro.
 117 */
 118 #define _pool_len(p)    _vec_len(p)
 119
 120 /** Memory usage of pool header. */
 121 always_inline uword
 122 pool_header_bytes (void *v)
 123 {
 124   pool_header_t *p = pool_header (v);
 125
 126   if (!v)
 127     return 0;
 128
 129   return vec_bytes (p->free_bitmap) + vec_bytes (p->free_indices);
 130 }
 131
 132 /** Memory usage of pool. */
 133 #define pool_bytes(P) (vec_bytes (P) + pool_header_bytes (P))
 134
 135 /** Local variable naming macro. */
 136 #define _pool_var(v) _pool_##v
 137
 138 /** Number of elements that can fit into pool with current allocation */
 139 #define pool_max_len(P) vec_max_len (P)
 140
 141 /** Number of free elements in pool */
 142 static_always_inline uword
 143 _pool_free_elts (void *p, uword elt_sz)
 144 {
 145   pool_header_t *ph;
 146   uword n_free;
 147
 148   if (p == 0)
 149     return 0;
 150
 151   ph = pool_header (p);
 152
 153   n_free = vec_len (ph->free_indices);
 154
 155   /* Fixed-size pools have max_elts set non-zero */
 156   if (ph->max_elts == 0)
 157     n_free += _vec_max_len (p, elt_sz) - vec_len (p);
 158
 159   return n_free;
 160 }
 161
 162 #define pool_free_elts(P) _pool_free_elts ((void *) (P), _vec_elt_sz (P))
 163
 164 /** Allocate an object E from a pool P (general version).
 165
 166    First search free list.  If nothing is free extend vector of objects.
 167 */
 168
 169 static_always_inline void
 170 _pool_get (void **pp, void **ep, uword align, int zero, uword elt_sz)
 171 {
 172   uword len = 0;
 173   void *p = pp[0];
 174   void *e;
 175   vec_attr_t va = { .hdr_sz = sizeof (pool_header_t),
 176                     .elt_sz = elt_sz,
 177                     .align = align };
 178
 179   if (p)
 180     {
 181       pool_header_t *ph = pool_header (p);
 182       uword n_free = vec_len (ph->free_indices);
 183
 184       if (n_free)
 185         {
 186           uword index = ph->free_indices[n_free - 1];
 187           e = p + index * elt_sz;
 188           ph->free_bitmap =
 189             clib_bitmap_andnoti_notrim (ph->free_bitmap, index);
 190           vec_set_len (ph->free_indices, n_free - 1);
 191           clib_mem_unpoison (e, elt_sz);
 192           goto done;
 193         }
 194
 195       if (ph->max_elts)
 196         {
 197           clib_warning ("can't expand fixed-size pool");
 198           os_out_of_memory ();
 199         }
 200     }
 201
 202   len = vec_len (p);
 203
 204   /* Nothing on free list, make a new element and return it. */
 205   p = _vec_realloc_internal (p, len + 1, &va);
 206   e = p + len * elt_sz;
 207
 208   _vec_update_pointer (pp, p);
 209
 210 done:
 211   ep[0] = e;
 212   if (zero)
 213     clib_memset_u8 (e, 0, elt_sz);
 214 }
 215
 216 #define _pool_get_aligned_internal(P, E, A, Z)                                \
 217   _pool_get ((void **) &(P), (void **) &(E), _vec_align (P, A), Z,            \
 218              _vec_elt_sz (P))
 219
 220 /** Allocate an object E from a pool P with alignment A */
 221 #define pool_get_aligned(P,E,A) _pool_get_aligned_internal(P,E,A,0)
 222
 223 /** Allocate an object E from a pool P with alignment A and zero it */
 224 #define pool_get_aligned_zero(P,E,A) _pool_get_aligned_internal(P,E,A,1)
 225
 226 /** Allocate an object E from a pool P (unspecified alignment). */
 227 #define pool_get(P,E) pool_get_aligned(P,E,0)
 228
 229 /** Allocate an object E from a pool P and zero it */
 230 #define pool_get_zero(P,E) pool_get_aligned_zero(P,E,0)
 231
 232 always_inline int
 233 _pool_get_will_expand (void *p, uword elt_sz)
 234 {
 235   pool_header_t *ph;
 236   uword len;
 237
 238   if (p == 0)
 239     return 1;
 240
 241   ph = pool_header (p);
 242
 243   if (ph->max_elts)
 244     len = ph->max_elts;
 245   else
 246     len = vec_len (ph->free_indices);
 247
 248   /* Free elements, certainly won't expand */
 249   if (len > 0)
 250     return 0;
 251
 252   return _vec_resize_will_expand (p, 1, elt_sz);
 253 }
 254
 255 #define pool_get_will_expand(P) _pool_get_will_expand (P, sizeof ((P)[0]))
 256
 257 always_inline int
 258 _pool_put_will_expand (void *p, uword index, uword elt_sz)
 259 {
 260   pool_header_t *ph = pool_header (p);
 261
 262   if (clib_bitmap_will_expand (ph->free_bitmap, index))
 263     return 1;
 264
 265   if (vec_resize_will_expand (ph->free_indices, 1))
 266     return 1;
 267
 268   return 0;
 269 }
 270
 271 #define pool_put_will_expand(P, E)                                            \
 272   _pool_put_will_expand (P, (E) - (P), sizeof ((P)[0]))
 273
 274 /** Use free bitmap to query whether given element is free. */
 275 static_always_inline int
 276 pool_is_free_index (void *p, uword index)
 277 {
 278   pool_header_t *ph = pool_header (p);
 279   return index < vec_len (p) ? clib_bitmap_get (ph->free_bitmap, index) : 1;
 280 }
 281
 282 #define pool_is_free(P, E) pool_is_free_index ((void *) (P), (E) - (P))
 283
 284 /** Free an object E in pool P. */
 285 static_always_inline void
 286 _pool_put_index (void *p, uword index, uword elt_sz)
 287 {
 288   pool_header_t *ph = pool_header (p);
 289
 290   ASSERT (index < ph->max_elts ? ph->max_elts : vec_len (p));
 291   ASSERT (!pool_is_free_index (p, index));
 292
 293   /* Add element to free bitmap and to free list. */
 294   ph->free_bitmap = clib_bitmap_ori_notrim (ph->free_bitmap, index);
 295
 296   /* Preallocated pool? */
 297   if (ph->max_elts)
 298     {
 299       u32 len = _vec_len (ph->free_indices);
 300       vec_set_len (ph->free_indices, len + 1);
 301       ph->free_indices[len] = index;
 302     }
 303   else
 304     vec_add1 (ph->free_indices, index);
 305
 306   clib_mem_poison (p + index * elt_sz, elt_sz);
 307 }
 308
 309 #define pool_put_index(P, I) _pool_put_index ((void *) (P), I, _vec_elt_sz (P))
 310 #define pool_put(P, E)       pool_put_index (P, (E) - (P))
 311
 312 /** Allocate N more free elements to pool (general version). */
 313
 314 static_always_inline void
 315 _pool_alloc (void **pp, uword n_elts, uword align, void *heap, uword elt_sz)
 316 {
 317   pool_header_t *ph = pool_header (pp[0]);
 318   uword len = vec_len (pp[0]);
 319   const vec_attr_t va = { .hdr_sz = sizeof (pool_header_t),
 320                           .elt_sz = elt_sz,
 321                           .align = align,
 322                           .heap = heap };
 323
 324   if (ph && ph->max_elts)
 325     {
 326       clib_warning ("Can't expand fixed-size pool");
 327       os_out_of_memory ();
 328     }
 329
 330   pp[0] = _vec_resize_internal (pp[0], len + n_elts, &va);
 331   _vec_set_len (pp[0], len, elt_sz);
 332   clib_mem_poison (pp[0] + len * elt_sz, n_elts * elt_sz);
 333
 334   ph = pool_header (pp[0]);
 335   vec_resize (ph->free_indices, n_elts);
 336   vec_dec_len (ph->free_indices, n_elts);
 337   clib_bitmap_validate (ph->free_bitmap, (len + n_elts) ?: 1);
 338 }
 339
 340 #define pool_alloc_aligned_heap(P, N, A, H)                                   \
 341   _pool_alloc ((void **) &(P), N, _vec_align (P, A), H, _vec_elt_sz (P))
 342
 343 #define pool_alloc_heap(P, N, H)    pool_alloc_aligned_heap (P, N, 0, H)
 344 #define pool_alloc_aligned(P, N, A) pool_alloc_aligned_heap (P, N, A, 0)
 345 #define pool_alloc(P, N)            pool_alloc_aligned_heap (P, N, 0, 0)
 346
 347 static_always_inline void *
 348 _pool_dup (void *p, uword align, uword elt_sz)
 349 {
 350   pool_header_t *nph, *ph = pool_header (p);
 351   uword len = vec_len (p);
 352   const vec_attr_t va = { .hdr_sz = sizeof (pool_header_t),
 353                           .elt_sz = elt_sz,
 354                           .align = align };
 355   void *n;
 356
 357   if (ph && ph->max_elts)
 358     {
 359       clib_warning ("Can't expand fixed-size pool");
 360       os_out_of_memory ();
 361     }
 362
 363   n = _vec_alloc_internal (len, &va);
 364   nph = pool_header (n);
 365   clib_memset_u8 (nph, 0, sizeof (vec_header_t));
 366
 367   if (len)
 368     {
 369       u32 *fi;
 370       vec_foreach (fi, ph->free_indices)
 371         clib_mem_unpoison (p + elt_sz * fi[0], elt_sz);
 372
 373       clib_memcpy_fast (n, p, len * elt_sz);
 374
 375       nph->free_bitmap = clib_bitmap_dup (ph->free_bitmap);
 376       nph->free_indices = vec_dup (ph->free_indices);
 377
 378       vec_foreach (fi, ph->free_indices)
 379         {
 380           uword offset = elt_sz * fi[0];
 381           clib_mem_poison (p + offset, elt_sz);
 382           clib_mem_poison (n + offset, elt_sz);
 383         }
 384     }
 385
 386   return n;
 387 }
 388
 389 /**
 390  * Return copy of pool with alignment
 391  *
 392  * @param P pool to copy
 393  * @param A alignment (may be zero)
 394  * @return copy of pool
 395  */
 396
 397 #define pool_dup_aligned(P, A)                                                \
 398   _pool_dup (P, _vec_align (P, A), _vec_elt_sz (P))
 399
 400 /**
 401  * Return copy of pool without alignment
 402  *
 403  * @param P pool to copy
 404  * @return copy of pool
 405  */
 406 #define pool_dup(P) pool_dup_aligned(P,0)
 407
 408 /** Low-level free pool operator (do not call directly). */
 409 always_inline void
 410 _pool_free (void **v)
 411 {
 412   pool_header_t *p = pool_header (v[0]);
 413   if (!p)
 414     return;
 415
 416   clib_bitmap_free (p->free_bitmap);
 417
 418   vec_free (p->free_indices);
 419   _vec_free (v);
 420 }
 421 #define pool_free(p) _pool_free ((void **) &(p))
 422
 423 static_always_inline uword
 424 pool_get_first_index (void *pool)
 425 {
 426   pool_header_t *h = pool_header (pool);
 427   return clib_bitmap_first_clear (h->free_bitmap);
 428 }
 429
 430 static_always_inline uword
 431 pool_get_next_index (void *pool, uword last)
 432 {
 433   pool_header_t *h = pool_header (pool);
 434   return clib_bitmap_next_clear (h->free_bitmap, last + 1);
 435 }
 436
 437 /** Optimized iteration through pool.
 438
 439     @param LO pointer to first element in chunk
 440     @param HI pointer to last element in chunk
 441     @param POOL pool to iterate across
 442     @param BODY operation to perform
 443
 444     Optimized version which assumes that BODY is smart enough to
 445     process multiple (LOW,HI) chunks. See also pool_foreach().
 446  */
 447 #define pool_foreach_region(LO,HI,POOL,BODY)                            \
 448 do {                                                                    \
 449   uword _pool_var (i), _pool_var (lo), _pool_var (hi), _pool_var (len); \
 450   uword _pool_var (bl), * _pool_var (b);                                \
 451   pool_header_t * _pool_var (p);                                        \
 452                                                                         \
 453   _pool_var (p) = pool_header (POOL);                                   \
 454   _pool_var (b) = (POOL) ? _pool_var (p)->free_bitmap : 0;              \
 455   _pool_var (bl) = vec_len (_pool_var (b));                             \
 456   _pool_var (len) = vec_len (POOL);                                     \
 457   _pool_var (lo) = 0;                                                   \
 458                                                                         \
 459   for (_pool_var (i) = 0;                                               \
 460        _pool_var (i) <= _pool_var (bl);                                 \
 461        _pool_var (i)++)                                                 \
 462     {                                                                   \
 463       uword _pool_var (m), _pool_var (f);                               \
 464       _pool_var (m) = (_pool_var (i) < _pool_var (bl)                   \
 465                        ? _pool_var (b) [_pool_var (i)]                  \
 466                        : 1);                                            \
 467       while (_pool_var (m) != 0)                                        \
 468         {                                                               \
 469           _pool_var (f) = first_set (_pool_var (m));                    \
 470           _pool_var (hi) = (_pool_var (i) * BITS (_pool_var (b)[0])     \
 471                             + min_log2 (_pool_var (f)));                \
 472           _pool_var (hi) = (_pool_var (i) < _pool_var (bl)              \
 473                             ? _pool_var (hi) : _pool_var (len));        \
 474           _pool_var (m) ^= _pool_var (f);                               \
 475           if (_pool_var (hi) > _pool_var (lo))                          \
 476             {                                                           \
 477               (LO) = _pool_var (lo);                                    \
 478               (HI) = _pool_var (hi);                                    \
 479               do { BODY; } while (0);                                   \
 480             }                                                           \
 481           _pool_var (lo) = _pool_var (hi) + 1;                          \
 482         }                                                               \
 483     }                                                                   \
 484 } while (0)
 485
 486 /** Iterate through pool.
 487
 488     @param VAR A variable of same type as pool vector to be used as an
 489                iterator.
 490     @param POOL The pool to iterate across.
 491     @param BODY The operation to perform, typically a code block. See
 492                 the example below.
 493
 494     This macro will call @c BODY with each active pool element.
 495
 496     It is a bad idea to allocate or free pool element from within
 497     @c pool_foreach. Build a vector of indices and dispose of them later.
 498     Or call pool_flush.
 499
 500
 501     @par Example
 502     @code{.c}
 503     proc_t *procs;   // a pool of processes.
 504     proc_t *proc;    // pointer to one process; used as the iterator.
 505
 506     pool_foreach (proc, procs, ({
 507         if (proc->state != PROC_STATE_RUNNING)
 508             continue;
 509
 510         // check a running proc in some way
 511         ...
 512     }));
 513     @endcode
 514
 515     @warning Because @c pool_foreach is a macro, syntax errors can be
 516     difficult to find inside @c BODY, let alone actual code bugs. One
 517     can temporarily split a complex @c pool_foreach into a trivial
 518     @c pool_foreach which builds a vector of active indices, and a
 519     vec_foreach() (or plain for-loop) to walk the active index vector.
 520  */
 521
 522 #define pool_foreach(VAR,POOL)                                          \
 523   if (POOL)                                                             \
 524     for (VAR = POOL + pool_get_first_index (POOL);                      \
 525          VAR < vec_end (POOL);                                          \
 526          VAR = POOL + pool_get_next_index (POOL, VAR - POOL))
 527
 528 /** Returns pointer to element at given index.
 529
 530     ASSERTs that the supplied index is valid.
 531     Even though one can write correct code of the form
 532     @code
 533         p = pool_base + index;
 534     @endcode
 535     use of @c pool_elt_at_index is strongly suggested.
 536  */
 537 #define pool_elt_at_index(p,i)                  \
 538 ({                                              \
 539   typeof (p) _e = (p) + (i);                    \
 540   ASSERT (! pool_is_free (p, _e));              \
 541   _e;                                           \
 542 })
 543
 544 /** Return next occupied pool index after @c i, useful for safe iteration. */
 545 #define pool_next_index(P,I)                                            \
 546 ({                                                                      \
 547   pool_header_t * _pool_var (p) = pool_header (P);                      \
 548   uword _pool_var (rv) = (I) + 1;                                       \
 549                                                                         \
 550   _pool_var(rv) =                                                       \
 551     (_pool_var (rv) < vec_len (P) ?                                     \
 552      clib_bitmap_next_clear (_pool_var (p)->free_bitmap, _pool_var(rv)) \
 553      : ~0);                                                             \
 554   _pool_var(rv) =                                                       \
 555     (_pool_var (rv) < vec_len (P) ?                                     \
 556      _pool_var (rv) : ~0);                                              \
 557   _pool_var(rv);                                                        \
 558 })
 559
 560 #define pool_foreach_index(i, v)                                              \
 561   if (v)                                                                      \
 562     for (i = pool_get_first_index (v); i < vec_len (v);                       \
 563          i = pool_get_next_index (v, i))
 564
 565 /* Iterate pool by index from s to e */
 566 #define pool_foreach_stepping_index(i, s, e, v)                               \
 567   for ((i) =                                                                  \
 568          (pool_is_free_index ((v), (s)) ? pool_get_next_index ((v), (s)) :    \
 569                                                 (s));                               \
 570        (i) < (e); (i) = pool_get_next_index ((v), (i)))
 571
 572 /* works only for pool of pointers, e is declared inside macro */
 573 #define pool_foreach_pointer(e, p)                                            \
 574   if (p)                                                                      \
 575     for (typeof ((p)[0]) *_t = (p) + pool_get_first_index (p), (e) = *_t,     \
 576                          *_end = vec_end (p);                                 \
 577          _t < _end; _t = (p) + pool_get_next_index (p, _t - (p)),             \
 578                          (e) = _t < _end ? *_t : (e))
 579
 580 /**
 581  * @brief Remove all elements from a pool in a safe way
 582  *
 583  * @param VAR each element in the pool
 584  * @param POOL The pool to flush
 585  * @param BODY The actions to perform on each element before it is returned to
 586  *        the pool. i.e. before it is 'freed'
 587  */
 588 #define pool_flush(VAR, POOL, BODY)                     \
 589 {                                                       \
 590   uword *_pool_var(ii), *_pool_var(dv) = NULL;          \
 591                                                         \
 592   pool_foreach((VAR), (POOL))                          \
 593   {                                                     \
 594     vec_add1(_pool_var(dv), (VAR) - (POOL));            \
 595   }                                                     \
 596   vec_foreach(_pool_var(ii), _pool_var(dv))             \
 597   {                                                     \
 598     (VAR) = pool_elt_at_index((POOL), *_pool_var(ii));  \
 599     do { BODY; } while (0);                             \
 600     pool_put((POOL), (VAR));                            \
 601   }                                                     \
 602   vec_free(_pool_var(dv));                              \
 603 }
 604
 605 #endif /* included_pool_h */
 606
 607 /*
 608  * fd.io coding-style-patch-verification: ON
 609  *
 610  * Local Variables:
 611  * eval: (c-set-style "gnu")
 612  * End:
 613  */