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