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(P,E,A)                                         \
 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       clib_bitmap_set_no_check (_pool_var (p)->free_bitmap,             \
 205                                 _pool_var (i), 0);                      \
 206       _vec_len (_pool_var (p)->free_indices) = _pool_var (l) - 1;       \
 207     }                                                                   \
 208   else                                                                  \
 209     {                                                                   \
 210       /* fixed-size, preallocated pools cannot expand */                \
 211       if ((P) && _pool_var(p)->max_elts)                                \
 212         {                                                               \
 213           clib_warning ("can't expand fixed-size pool");                \
 214           os_out_of_memory();                                           \
 215         }                                                               \
 216       /* Nothing on free list, make a new element and return it. */     \
 217       P = _vec_resize (P,                                               \
 218                        /* length_increment */ 1,                        \
 219                        /* new size */ (vec_len (P) + 1) * sizeof (P[0]), \
 220                        pool_aligned_header_bytes,                       \
 221                        /* align */ (A));                                \
 222       E = vec_end (P) - 1;                                              \
 223       pool_validate_index (P, vec_len(P)-1);                            \
 224     }                                                                   \
 225 } while (0)
 226
 227 /** Allocate an object E from a pool P (unspecified alignment). */
 228 #define pool_get(P,E) pool_get_aligned(P,E,0)
 229
 230 /** See if pool_get will expand the pool or not */
 231 #define pool_get_aligned_will_expand(P,YESNO,A)                         \
 232 do {                                                                    \
 233   pool_header_t * _pool_var (p) = pool_header (P);                      \
 234   uword _pool_var (l);                                                  \
 235                                                                         \
 236   _pool_var (l) = 0;                                                    \
 237   if (P)                                                                \
 238     {                                                                   \
 239       if (_pool_var (p)->max_elts)                                      \
 240         _pool_var (l) = _pool_var (p)->max_elts;                        \
 241       else                                                              \
 242         _pool_var (l) = vec_len (_pool_var (p)->free_indices);          \
 243     }                                                                   \
 244                                                                         \
 245   /* Free elements, certainly won't expand */                           \
 246   if (_pool_var (l) > 0)                                                \
 247       YESNO=0;                                                          \
 248   else                                                                  \
 249     {                                                                   \
 250       /* Nothing on free list, make a new element and return it. */     \
 251       YESNO = _vec_resize_will_expand                                   \
 252         (P,                                                             \
 253          /* length_increment */ 1,                                      \
 254          /* new size */ (vec_len (P) + 1) * sizeof (P[0]),              \
 255          pool_aligned_header_bytes,                                     \
 256          /* align */ (A));                                              \
 257     }                                                                   \
 258 } while (0)
 259
 260 #define pool_get_will_expand(P,YESNO) pool_get_aligned_will_expand(P,YESNO,0)
 261
 262 /** Use free bitmap to query whether given element is free. */
 263 #define pool_is_free(P,E)                                               \
 264 ({                                                                      \
 265   pool_header_t * _pool_var (p) = pool_header (P);                      \
 266   uword _pool_var (i) = (E) - (P);                                      \
 267   (_pool_var (i) < vec_len (P)) ? clib_bitmap_get_no_check (_pool_var (p)->free_bitmap, _pool_i) : 1; \
 268 })
 269
 270 /** Use free bitmap to query whether given index is free */
 271 #define pool_is_free_index(P,I) pool_is_free((P),(P)+(I))
 272
 273 /** Free an object E in pool P. */
 274 #define pool_put(P,E)                                                   \
 275 do {                                                                    \
 276   pool_header_t * _pool_var (p) = pool_header (P);                      \
 277   uword _pool_var (l) = (E) - (P);                                      \
 278   ASSERT (vec_is_member (P, E));                                        \
 279   ASSERT (! pool_is_free (P, E));                                       \
 280                                                                         \
 281   /* Add element to free bitmap and to free list. */                    \
 282   clib_bitmap_set_no_check (_pool_var (p)->free_bitmap,                 \
 283                             _pool_var (l), 1);                          \
 284                                                                         \
 285   /* Preallocated pool? */                                              \
 286   if (_pool_var (p)->max_elts)                                          \
 287     {                                                                   \
 288       ASSERT(_pool_var(l) < _pool_var (p)->max_elts);                   \
 289       _pool_var(p)->free_indices[_vec_len(_pool_var(p)->free_indices)] = \
 290                                  _pool_var(l);                          \
 291       _vec_len(_pool_var(p)->free_indices) += 1;                        \
 292     }                                                                   \
 293   else                                                                  \
 294     vec_add1 (_pool_var (p)->free_indices, _pool_var (l));              \
 295 } while (0)
 296
 297 /** Free pool element with given index. */
 298 #define pool_put_index(p,i)                     \
 299 do {                                            \
 300   typeof (p) _e = (p) + (i);                    \
 301   pool_put (p, _e);                             \
 302 } while (0)
 303
 304 /** Allocate N more free elements to pool (general version). */
 305 #define pool_alloc_aligned(P,N,A)                                       \
 306 do {                                                                    \
 307   pool_header_t * _p;                                                   \
 308                                                                         \
 309   if ((P))                                                              \
 310     {                                                                   \
 311       _p = pool_header (P);                                             \
 312       if (_p->max_elts)                                                 \
 313         {                                                               \
 314            clib_warning ("Can't expand fixed-size pool");               \
 315            os_out_of_memory();                                          \
 316         }                                                               \
 317     }                                                                   \
 318                                                                         \
 319   (P) = _vec_resize ((P), 0, (vec_len (P) + (N)) * sizeof (P[0]),       \
 320                      pool_aligned_header_bytes,                         \
 321                      (A));                                              \
 322   _p = pool_header (P);                                                 \
 323   vec_resize (_p->free_indices, (N));                                   \
 324   _vec_len (_p->free_indices) -= (N);                                   \
 325 } while (0)
 326
 327 /** Allocate N more free elements to pool (unspecified alignment). */
 328 #define pool_alloc(P,N) pool_alloc_aligned(P,N,0)
 329
 330 /** Low-level free pool operator (do not call directly). */
 331 always_inline void *
 332 _pool_free (void *v)
 333 {
 334   pool_header_t *p = pool_header (v);
 335   if (!v)
 336     return v;
 337   clib_bitmap_free (p->free_bitmap);
 338
 339   if (p->max_elts)
 340     {
 341       int rv;
 342
 343       rv = munmap (p->mmap_base, p->mmap_size);
 344       if (rv)
 345         clib_unix_warning ("munmap");
 346     }
 347   else
 348     {
 349       vec_free (p->free_indices);
 350       vec_free_h (v, pool_aligned_header_bytes);
 351     }
 352   return 0;
 353 }
 354
 355 /** Free a pool. */
 356 #define pool_free(p) (p) = _pool_free(p)
 357
 358 /** Optimized iteration through pool.
 359
 360     @param LO pointer to first element in chunk
 361     @param HI pointer to last element in chunk
 362     @param POOL pool to iterate across
 363     @param BODY operation to perform
 364
 365     Optimized version which assumes that BODY is smart enough to
 366     process multiple (LOW,HI) chunks. See also pool_foreach().
 367  */
 368 #define pool_foreach_region(LO,HI,POOL,BODY)                            \
 369 do {                                                                    \
 370   uword _pool_var (i), _pool_var (lo), _pool_var (hi), _pool_var (len); \
 371   uword _pool_var (bl), * _pool_var (b);                                \
 372   pool_header_t * _pool_var (p);                                        \
 373                                                                         \
 374   _pool_var (p) = pool_header (POOL);                                   \
 375   _pool_var (b) = (POOL) ? _pool_var (p)->free_bitmap : 0;              \
 376   _pool_var (bl) = vec_len (_pool_var (b));                             \
 377   _pool_var (len) = vec_len (POOL);                                     \
 378   _pool_var (lo) = 0;                                                   \
 379                                                                         \
 380   for (_pool_var (i) = 0;                                               \
 381        _pool_var (i) <= _pool_var (bl);                                 \
 382        _pool_var (i)++)                                                 \
 383     {                                                                   \
 384       uword _pool_var (m), _pool_var (f);                               \
 385       _pool_var (m) = (_pool_var (i) < _pool_var (bl)                   \
 386                        ? _pool_var (b) [_pool_var (i)]                  \
 387                        : 1);                                            \
 388       while (_pool_var (m) != 0)                                        \
 389         {                                                               \
 390           _pool_var (f) = first_set (_pool_var (m));                    \
 391           _pool_var (hi) = (_pool_var (i) * BITS (_pool_var (b)[0])     \
 392                             + min_log2 (_pool_var (f)));                \
 393           _pool_var (hi) = (_pool_var (i) < _pool_var (bl)              \
 394                             ? _pool_var (hi) : _pool_var (len));        \
 395           _pool_var (m) ^= _pool_var (f);                               \
 396           if (_pool_var (hi) > _pool_var (lo))                          \
 397             {                                                           \
 398               (LO) = _pool_var (lo);                                    \
 399               (HI) = _pool_var (hi);                                    \
 400               do { BODY; } while (0);                                   \
 401             }                                                           \
 402           _pool_var (lo) = _pool_var (hi) + 1;                          \
 403         }                                                               \
 404     }                                                                   \
 405 } while (0)
 406
 407 /** Iterate through pool.
 408
 409     @param VAR A variable of same type as pool vector to be used as an
 410                iterator.
 411     @param POOL The pool to iterate across.
 412     @param BODY The operation to perform, typically a code block. See
 413                 the example below.
 414
 415     This macro will call @c BODY with each active pool element.
 416
 417     It is a bad idea to allocate or free pool element from within
 418     @c pool_foreach. Build a vector of indices and dispose of them later.
 419     Or call pool_flush.
 420
 421
 422     @par Example
 423     @code{.c}
 424     proc_t *procs;   // a pool of processes.
 425     proc_t *proc;    // pointer to one process; used as the iterator.
 426
 427     pool_foreach (proc, procs, ({
 428         if (proc->state != PROC_STATE_RUNNING)
 429             continue;
 430
 431         // check a running proc in some way
 432         ...
 433     }));
 434     @endcode
 435
 436     @warning Because @c pool_foreach is a macro, syntax errors can be
 437     difficult to find inside @c BODY, let alone actual code bugs. One
 438     can temporarily split a complex @c pool_foreach into a trivial
 439     @c pool_foreach which builds a vector of active indices, and a
 440     vec_foreach() (or plain for-loop) to walk the active index vector.
 441  */
 442 #define pool_foreach(VAR,POOL,BODY)                                     \
 443 do {                                                                    \
 444   uword _pool_foreach_lo, _pool_foreach_hi;                             \
 445   pool_foreach_region (_pool_foreach_lo, _pool_foreach_hi, (POOL),      \
 446     ({                                                                  \
 447       for ((VAR) = (POOL) + _pool_foreach_lo;                           \
 448            (VAR) < (POOL) + _pool_foreach_hi;                           \
 449            (VAR)++)                                                     \
 450         do { BODY; } while (0);                                         \
 451     }));                                                                \
 452 } while (0)
 453
 454 /** Returns pointer to element at given index.
 455
 456     ASSERTs that the supplied index is valid.
 457     Even though one can write correct code of the form
 458     @code
 459         p = pool_base + index;
 460     @endcode
 461     use of @c pool_elt_at_index is strongly suggested.
 462  */
 463 #define pool_elt_at_index(p,i)                  \
 464 ({                                              \
 465   typeof (p) _e = (p) + (i);                    \
 466   ASSERT (! pool_is_free (p, _e));              \
 467   _e;                                           \
 468 })
 469
 470 /** Return next occupied pool index after @c i, useful for safe iteration. */
 471 #define pool_next_index(P,I)                                            \
 472 ({                                                                      \
 473   pool_header_t * _pool_var (p) = pool_header (P);                      \
 474   uword _pool_var (rv) = (I) + 1;                                       \
 475                                                                         \
 476   _pool_var(rv) =                                                       \
 477     (_pool_var (rv) < vec_len (P) ?                                     \
 478      clib_bitmap_next_clear (_pool_var (p)->free_bitmap, _pool_var(rv)) \
 479      : ~0);                                                             \
 480   _pool_var(rv) =                                                       \
 481     (_pool_var (rv) < vec_len (P) ?                                     \
 482      _pool_var (rv) : ~0);                                              \
 483   _pool_var(rv);                                                        \
 484 })
 485
 486 /** Iterate pool by index. */
 487 #define pool_foreach_index(i,v,body)            \
 488   for ((i) = 0; (i) < vec_len (v); (i)++)       \
 489     {                                           \
 490       if (! pool_is_free_index ((v), (i)))      \
 491         do { body; } while (0);                 \
 492     }
 493
 494 /**
 495  * @brief Remove all elemenets from a pool in a safe way
 496  *
 497  * @param VAR each element in the pool
 498  * @param POOL The pool to flush
 499  * @param BODY The actions to perform on each element before it is returned to
 500  *        the pool. i.e. before it is 'freed'
 501  */
 502 #define pool_flush(VAR, POOL, BODY)                     \
 503 {                                                       \
 504   uword *_pool_var(ii), *_pool_var(dv) = NULL;          \
 505                                                         \
 506   pool_foreach((VAR), (POOL),                           \
 507   ({                                                    \
 508     vec_add1(_pool_var(dv), (VAR) - (POOL));            \
 509   }));                                                  \
 510   vec_foreach(_pool_var(ii), _pool_var(dv))             \
 511   {                                                     \
 512     (VAR) = pool_elt_at_index((POOL), *_pool_var(ii));  \
 513     do { BODY; } while (0);                             \
 514     pool_put((POOL), (VAR));                            \
 515   }                                                     \
 516   vec_free(_pool_var(dv));                              \
 517 }
 518
 519 #endif /* included_pool_h */
 520
 521 /*
 522  * fd.io coding-style-patch-verification: ON
 523  *
 524  * Local Variables:
 525  * eval: (c-set-style "gnu")
 526  * End:
 527  */