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 #include <vppinfra/mheap.h>
  50
  51
  52 typedef struct
  53 {
  54   /** Bitmap of indices of free objects. */
  55   uword *free_bitmap;
  56
  57   /** Vector of free indices.  One element for each set bit in bitmap. */
  58   u32 *free_indices;
  59
  60   /* The following fields are set for fixed-size, preallocated pools */
  61
  62   /** Maximum size of the pool, in elements */
  63   u32 max_elts;
  64
  65   /** mmap segment info: base + length */
  66   u8 *mmap_base;
  67   u64 mmap_size;
  68
  69 } pool_header_t;
  70
  71 /** Align pool header so that pointers are naturally aligned. */
  72 #define pool_aligned_header_bytes \
  73   vec_aligned_header_bytes (sizeof (pool_header_t), sizeof (void *))
  74
  75 /** Get pool header from user pool pointer */
  76 always_inline pool_header_t *
  77 pool_header (void *v)
  78 {
  79   return vec_aligned_header (v, sizeof (pool_header_t), sizeof (void *));
  80 }
  81
  82 extern void _pool_init_fixed (void **, u32, u32);
  83 extern void fpool_free (void *);
  84
  85 /** initialize a fixed-size, preallocated pool */
  86 #define pool_init_fixed(pool,max_elts)                  \
  87 {                                                       \
  88   _pool_init_fixed((void **)&(pool),sizeof(pool[0]),max_elts);  \
  89 }
  90
  91 /** Validate a pool */
  92 always_inline void
  93 pool_validate (void *v)
  94 {
  95   pool_header_t *p = pool_header (v);
  96   uword i, n_free_bitmap;
  97
  98   if (!v)
  99     return;
 100
 101   n_free_bitmap = clib_bitmap_count_set_bits (p->free_bitmap);
 102   ASSERT (n_free_bitmap == vec_len (p->free_indices));
 103   for (i = 0; i < vec_len (p->free_indices); i++)
 104     ASSERT (clib_bitmap_get (p->free_bitmap, p->free_indices[i]) == 1);
 105 }
 106
 107 always_inline void
 108 pool_header_validate_index (void *v, uword index)
 109 {
 110   pool_header_t *p = pool_header (v);
 111
 112   if (v)
 113     vec_validate (p->free_bitmap, index / BITS (uword));
 114 }
 115
 116 #define pool_validate_index(v,i)                                \
 117 do {                                                            \
 118   uword __pool_validate_index = (i);                            \
 119   vec_validate_ha ((v), __pool_validate_index,                  \
 120                    pool_aligned_header_bytes, /* align */ 0);   \
 121   pool_header_validate_index ((v), __pool_validate_index);      \
 122 } while (0)
 123
 124 /** Number of active elements in a pool.
 125  * @return Number of active elements in a pool
 126  */
 127 always_inline uword
 128 pool_elts (void *v)
 129 {
 130   uword ret = vec_len (v);
 131   if (v)
 132     ret -= vec_len (pool_header (v)->free_indices);
 133   return ret;
 134 }
 135
 136 /** Number of elements in pool vector.
 137
 138     @note You probably want to call pool_elts() instead.
 139 */
 140 #define pool_len(p)     vec_len(p)
 141
 142 /** Number of elements in pool vector (usable as an lvalue)
 143
 144     @note You probably don't want to use this macro.
 145 */
 146 #define _pool_len(p)    _vec_len(p)
 147
 148 /** Memory usage of pool header. */
 149 always_inline uword
 150 pool_header_bytes (void *v)
 151 {
 152   pool_header_t *p = pool_header (v);
 153
 154   if (!v)
 155     return 0;
 156
 157   return vec_bytes (p->free_bitmap) + vec_bytes (p->free_indices);
 158 }
 159
 160 /** Memory usage of pool. */
 161 #define pool_bytes(P) (vec_bytes (P) + pool_header_bytes (P))
 162
 163 /** Local variable naming macro. */
 164 #define _pool_var(v) _pool_##v
 165
 166 /** Queries whether pool has at least N_FREE free elements. */
 167 always_inline uword
 168 pool_free_elts (void *v)
 169 {
 170   pool_header_t *p = pool_header (v);
 171   uword n_free = 0;
 172
 173   if (v)
 174     {
 175       n_free += vec_len (p->free_indices);
 176
 177       /* Space left at end of vector? */
 178       n_free += vec_capacity (v, sizeof (p[0])) - vec_len (v);
 179     }
 180
 181   return n_free;
 182 }
 183
 184 /** Allocate an object E from a pool P (general version).
 185
 186    First search free list.  If nothing is free extend vector of objects.
 187 */
 188 #define _pool_get_aligned_internal(P,E,A,Z)                             \
 189 do {                                                                    \
 190   pool_header_t * _pool_var (p) = pool_header (P);                      \
 191   uword _pool_var (l);                                                  \
 192                                                                         \
 193   STATIC_ASSERT(A==0 || ((A % sizeof(P[0]))==0) || ((sizeof(P[0]) % A) == 0), \
 194                 "Pool aligned alloc of incorrectly sized object");      \
 195   _pool_var (l) = 0;                                                    \
 196   if (P)                                                                \
 197     _pool_var (l) = vec_len (_pool_var (p)->free_indices);              \
 198                                                                         \
 199   if (_pool_var (l) > 0)                                                \
 200     {                                                                   \
 201       /* Return free element from free list. */                         \
 202       uword _pool_var (i) = _pool_var (p)->free_indices[_pool_var (l) - 1]; \
 203       (E) = (P) + _pool_var (i);                                        \
 204       _pool_var (p)->free_bitmap =                                      \
 205         clib_bitmap_andnoti_notrim (_pool_var (p)->free_bitmap,        \
 206                                      _pool_var (i));                    \
 207       _vec_len (_pool_var (p)->free_indices) = _pool_var (l) - 1;       \
 208     }                                                                   \
 209   else                                                                  \
 210     {                                                                   \
 211       /* fixed-size, preallocated pools cannot expand */                \
 212       if ((P) && _pool_var(p)->max_elts)                                \
 213         {                                                               \
 214           clib_warning ("can't expand fixed-size pool");                \
 215           os_out_of_memory();                                           \
 216         }                                                               \
 217       /* Nothing on free list, make a new element and return it. */     \
 218       P = _vec_resize (P,                                               \
 219                        /* length_increment */ 1,                        \
 220                        /* new size */ (vec_len (P) + 1) * sizeof (P[0]), \
 221                        pool_aligned_header_bytes,                       \
 222                        /* align */ (A));                                \
 223       E = vec_end (P) - 1;                                              \
 224     }                                                                   \
 225   if (Z)                                                                \
 226     memset(E, 0, sizeof(*E));                                           \
 227 } while (0)
 228
 229 /** Allocate an object E from a pool P with alignment A */
 230 #define pool_get_aligned(P,E,A) _pool_get_aligned_internal(P,E,A,0)
 231
 232 /** Allocate an object E from a pool P with alignment A and zero it */
 233 #define pool_get_aligned_zero(P,E,A) _pool_get_aligned_internal(P,E,A,1)
 234
 235 /** Allocate an object E from a pool P (unspecified alignment). */
 236 #define pool_get(P,E) pool_get_aligned(P,E,0)
 237
 238 /** Allocate an object E from a pool P and zero it */
 239 #define pool_get_zero(P,E) pool_get_aligned_zero(P,E,0)
 240
 241 /** See if pool_get will expand the pool or not */
 242 #define pool_get_aligned_will_expand(P,YESNO,A)                         \
 243 do {                                                                    \
 244   pool_header_t * _pool_var (p) = pool_header (P);                      \
 245   uword _pool_var (l);                                                  \
 246                                                                         \
 247   _pool_var (l) = 0;                                                    \
 248   if (P)                                                                \
 249     {                                                                   \
 250       if (_pool_var (p)->max_elts)                                      \
 251         _pool_var (l) = _pool_var (p)->max_elts;                        \
 252       else                                                              \
 253         _pool_var (l) = vec_len (_pool_var (p)->free_indices);          \
 254     }                                                                   \
 255                                                                         \
 256   /* Free elements, certainly won't expand */                           \
 257   if (_pool_var (l) > 0)                                                \
 258       YESNO=0;                                                          \
 259   else                                                                  \
 260     {                                                                   \
 261       /* Nothing on free list, make a new element and return it. */     \
 262       YESNO = _vec_resize_will_expand                                   \
 263         (P,                                                             \
 264          /* length_increment */ 1,                                      \
 265          /* new size */ (vec_len (P) + 1) * sizeof (P[0]),              \
 266          pool_aligned_header_bytes,                                     \
 267          /* align */ (A));                                              \
 268     }                                                                   \
 269 } while (0)
 270
 271 /** Tell the caller if pool get will expand the pool */
 272 #define pool_get_will_expand(P,YESNO) pool_get_aligned_will_expand(P,YESNO,0)
 273
 274 /** Use free bitmap to query whether given element is free. */
 275 #define pool_is_free(P,E)                                               \
 276 ({                                                                      \
 277   pool_header_t * _pool_var (p) = pool_header (P);                      \
 278   uword _pool_var (i) = (E) - (P);                                      \
 279   (_pool_var (i) < vec_len (P)) ? clib_bitmap_get (_pool_var (p)->free_bitmap, _pool_i) : 1; \
 280 })
 281
 282 /** Use free bitmap to query whether given index is free */
 283 #define pool_is_free_index(P,I) pool_is_free((P),(P)+(I))
 284
 285 /** Free an object E in pool P. */
 286 #define pool_put(P,E)                                                   \
 287 do {                                                                    \
 288   pool_header_t * _pool_var (p) = pool_header (P);                      \
 289   uword _pool_var (l) = (E) - (P);                                      \
 290   ASSERT (vec_is_member (P, E));                                        \
 291   ASSERT (! pool_is_free (P, E));                                       \
 292                                                                         \
 293   /* Add element to free bitmap and to free list. */                    \
 294   _pool_var (p)->free_bitmap =                                          \
 295     clib_bitmap_ori_notrim (_pool_var (p)->free_bitmap,                 \
 296                              _pool_var (l));                            \
 297                                                                         \
 298   /* Preallocated pool? */                                              \
 299   if (_pool_var (p)->max_elts)                                          \
 300     {                                                                   \
 301       ASSERT(_pool_var(l) < _pool_var (p)->max_elts);                   \
 302       _pool_var(p)->free_indices[_vec_len(_pool_var(p)->free_indices)] = \
 303                                  _pool_var(l);                          \
 304       _vec_len(_pool_var(p)->free_indices) += 1;                        \
 305     }                                                                   \
 306   else                                                                  \
 307     vec_add1 (_pool_var (p)->free_indices, _pool_var (l));              \
 308 } while (0)
 309
 310 /** Free pool element with given index. */
 311 #define pool_put_index(p,i)                     \
 312 do {                                            \
 313   typeof (p) _e = (p) + (i);                    \
 314   pool_put (p, _e);                             \
 315 } while (0)
 316
 317 /** Allocate N more free elements to pool (general version). */
 318 #define pool_alloc_aligned(P,N,A)                                       \
 319 do {                                                                    \
 320   pool_header_t * _p;                                                   \
 321                                                                         \
 322   if ((P))                                                              \
 323     {                                                                   \
 324       _p = pool_header (P);                                             \
 325       if (_p->max_elts)                                                 \
 326         {                                                               \
 327            clib_warning ("Can't expand fixed-size pool");               \
 328            os_out_of_memory();                                          \
 329         }                                                               \
 330     }                                                                   \
 331                                                                         \
 332   (P) = _vec_resize ((P), 0, (vec_len (P) + (N)) * sizeof (P[0]),       \
 333                      pool_aligned_header_bytes,                         \
 334                      (A));                                              \
 335   _p = pool_header (P);                                                 \
 336   vec_resize (_p->free_indices, (N));                                   \
 337   _vec_len (_p->free_indices) -= (N);                                   \
 338 } while (0)
 339
 340 /** Allocate N more free elements to pool (unspecified alignment). */
 341 #define pool_alloc(P,N) pool_alloc_aligned(P,N,0)
 342
 343 /**
 344  * Return copy of pool with alignment
 345  *
 346  * @param P pool to copy
 347  * @param A alignment (may be zero)
 348  * @return copy of pool
 349  */
 350 #define pool_dup_aligned(P,A)                                           \
 351 ({                                                                      \
 352   typeof (P) _pool_var (new) = 0;                                       \
 353   pool_header_t * _pool_var (ph), * _pool_var (new_ph);                 \
 354   u32 _pool_var (n) = pool_len (P);                                     \
 355   _pool_var (new) = _vec_resize (_pool_var (new), _pool_var (n),        \
 356                                  _pool_var (n) * sizeof ((P)[0]),       \
 357                                  pool_aligned_header_bytes, (A));       \
 358   clib_memcpy_fast (_pool_var (new), (P),                               \
 359                     _pool_var (n) * sizeof ((P)[0]));                   \
 360   _pool_var (ph) = pool_header (P);                                     \
 361   _pool_var (new_ph) = pool_header (_pool_var (new));                   \
 362   _pool_var (new_ph)->free_bitmap =                                     \
 363     clib_bitmap_dup (_pool_var (ph)->free_bitmap);                      \
 364   _pool_var (new_ph)->free_indices =                                    \
 365     vec_dup (_pool_var (ph)->free_indices);                             \
 366   _pool_var (new_ph)->max_elts = _pool_var (ph)->max_elts;              \
 367   _pool_var (new);                                                      \
 368 })
 369
 370 /**
 371  * Return copy of pool without alignment
 372  *
 373  * @param P pool to copy
 374  * @return copy of pool
 375  */
 376 #define pool_dup(P) pool_dup_aligned(P, 0)
 377
 378 /** Low-level free pool operator (do not call directly). */
 379 always_inline void *
 380 _pool_free (void *v)
 381 {
 382   pool_header_t *p = pool_header (v);
 383   if (!v)
 384     return v;
 385   clib_bitmap_free (p->free_bitmap);
 386
 387   if (p->max_elts)
 388     {
 389       int rv;
 390
 391       rv = munmap (p->mmap_base, p->mmap_size);
 392       if (rv)
 393         clib_unix_warning ("munmap");
 394     }
 395   else
 396     {
 397       vec_free (p->free_indices);
 398       vec_free_h (v, pool_aligned_header_bytes);
 399     }
 400   return 0;
 401 }
 402
 403 /** Free a pool. */
 404 #define pool_free(p) (p) = _pool_free(p)
 405
 406 /** Optimized iteration through pool.
 407
 408     @param LO pointer to first element in chunk
 409     @param HI pointer to last element in chunk
 410     @param POOL pool to iterate across
 411     @param BODY operation to perform
 412
 413     Optimized version which assumes that BODY is smart enough to
 414     process multiple (LOW,HI) chunks. See also pool_foreach().
 415  */
 416 #define pool_foreach_region(LO,HI,POOL,BODY)                            \
 417 do {                                                                    \
 418   uword _pool_var (i), _pool_var (lo), _pool_var (hi), _pool_var (len); \
 419   uword _pool_var (bl), * _pool_var (b);                                \
 420   pool_header_t * _pool_var (p);                                        \
 421                                                                         \
 422   _pool_var (p) = pool_header (POOL);                                   \
 423   _pool_var (b) = (POOL) ? _pool_var (p)->free_bitmap : 0;              \
 424   _pool_var (bl) = vec_len (_pool_var (b));                             \
 425   _pool_var (len) = vec_len (POOL);                                     \
 426   _pool_var (lo) = 0;                                                   \
 427                                                                         \
 428   for (_pool_var (i) = 0;                                               \
 429        _pool_var (i) <= _pool_var (bl);                                 \
 430        _pool_var (i)++)                                                 \
 431     {                                                                   \
 432       uword _pool_var (m), _pool_var (f);                               \
 433       _pool_var (m) = (_pool_var (i) < _pool_var (bl)                   \
 434                        ? _pool_var (b) [_pool_var (i)]                  \
 435                        : 1);                                            \
 436       while (_pool_var (m) != 0)                                        \
 437         {                                                               \
 438           _pool_var (f) = first_set (_pool_var (m));                    \
 439           _pool_var (hi) = (_pool_var (i) * BITS (_pool_var (b)[0])     \
 440                             + min_log2 (_pool_var (f)));                \
 441           _pool_var (hi) = (_pool_var (i) < _pool_var (bl)              \
 442                             ? _pool_var (hi) : _pool_var (len));        \
 443           _pool_var (m) ^= _pool_var (f);                               \
 444           if (_pool_var (hi) > _pool_var (lo))                          \
 445             {                                                           \
 446               (LO) = _pool_var (lo);                                    \
 447               (HI) = _pool_var (hi);                                    \
 448               do { BODY; } while (0);                                   \
 449             }                                                           \
 450           _pool_var (lo) = _pool_var (hi) + 1;                          \
 451         }                                                               \
 452     }                                                                   \
 453 } while (0)
 454
 455 /** Iterate through pool.
 456
 457     @param VAR A variable of same type as pool vector to be used as an
 458                iterator.
 459     @param POOL The pool to iterate across.
 460     @param BODY The operation to perform, typically a code block. See
 461                 the example below.
 462
 463     This macro will call @c BODY with each active pool element.
 464
 465     It is a bad idea to allocate or free pool element from within
 466     @c pool_foreach. Build a vector of indices and dispose of them later.
 467     Or call pool_flush.
 468
 469
 470     @par Example
 471     @code{.c}
 472     proc_t *procs;   // a pool of processes.
 473     proc_t *proc;    // pointer to one process; used as the iterator.
 474
 475     pool_foreach (proc, procs, ({
 476         if (proc->state != PROC_STATE_RUNNING)
 477             continue;
 478
 479         // check a running proc in some way
 480         ...
 481     }));
 482     @endcode
 483
 484     @warning Because @c pool_foreach is a macro, syntax errors can be
 485     difficult to find inside @c BODY, let alone actual code bugs. One
 486     can temporarily split a complex @c pool_foreach into a trivial
 487     @c pool_foreach which builds a vector of active indices, and a
 488     vec_foreach() (or plain for-loop) to walk the active index vector.
 489  */
 490 #define pool_foreach(VAR,POOL,BODY)                                     \
 491 do {                                                                    \
 492   uword _pool_foreach_lo, _pool_foreach_hi;                             \
 493   pool_foreach_region (_pool_foreach_lo, _pool_foreach_hi, (POOL),      \
 494     ({                                                                  \
 495       for ((VAR) = (POOL) + _pool_foreach_lo;                           \
 496            (VAR) < (POOL) + _pool_foreach_hi;                           \
 497            (VAR)++)                                                     \
 498         do { BODY; } while (0);                                         \
 499     }));                                                                \
 500 } while (0)
 501
 502 /** Returns pointer to element at given index.
 503
 504     ASSERTs that the supplied index is valid.
 505     Even though one can write correct code of the form
 506     @code
 507         p = pool_base + index;
 508     @endcode
 509     use of @c pool_elt_at_index is strongly suggested.
 510  */
 511 #define pool_elt_at_index(p,i)                  \
 512 ({                                              \
 513   typeof (p) _e = (p) + (i);                    \
 514   ASSERT (! pool_is_free (p, _e));              \
 515   _e;                                           \
 516 })
 517
 518 /** Return next occupied pool index after @c i, useful for safe iteration. */
 519 #define pool_next_index(P,I)                                            \
 520 ({                                                                      \
 521   pool_header_t * _pool_var (p) = pool_header (P);                      \
 522   uword _pool_var (rv) = (I) + 1;                                       \
 523                                                                         \
 524   _pool_var(rv) =                                                       \
 525     (_pool_var (rv) < vec_len (P) ?                                     \
 526      clib_bitmap_next_clear (_pool_var (p)->free_bitmap, _pool_var(rv)) \
 527      : ~0);                                                             \
 528   _pool_var(rv) =                                                       \
 529     (_pool_var (rv) < vec_len (P) ?                                     \
 530      _pool_var (rv) : ~0);                                              \
 531   _pool_var(rv);                                                        \
 532 })
 533
 534 /** Iterate pool by index. */
 535 #define pool_foreach_index(i,v,body)            \
 536   for ((i) = 0; (i) < vec_len (v); (i)++)       \
 537     {                                           \
 538       if (! pool_is_free_index ((v), (i)))      \
 539         do { body; } while (0);                 \
 540     }
 541
 542 /**
 543  * @brief Remove all elements from a pool in a safe way
 544  *
 545  * @param VAR each element in the pool
 546  * @param POOL The pool to flush
 547  * @param BODY The actions to perform on each element before it is returned to
 548  *        the pool. i.e. before it is 'freed'
 549  */
 550 #define pool_flush(VAR, POOL, BODY)                     \
 551 {                                                       \
 552   uword *_pool_var(ii), *_pool_var(dv) = NULL;          \
 553                                                         \
 554   pool_foreach((VAR), (POOL),                           \
 555   ({                                                    \
 556     vec_add1(_pool_var(dv), (VAR) - (POOL));            \
 557   }));                                                  \
 558   vec_foreach(_pool_var(ii), _pool_var(dv))             \
 559   {                                                     \
 560     (VAR) = pool_elt_at_index((POOL), *_pool_var(ii));  \
 561     do { BODY; } while (0);                             \
 562     pool_put((POOL), (VAR));                            \
 563   }                                                     \
 564   vec_free(_pool_var(dv));                              \
 565 }
 566
 567 #endif /* included_pool_h */
 568
 569 /*
 570  * fd.io coding-style-patch-verification: ON
 571  *
 572  * Local Variables:
 573  * eval: (c-set-style "gnu")
 574  * End:
 575  */