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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 Copyright (c) 2001, 2002, 2003, 2004 Eliot Dresselhaus
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:
26 The above copyright notice and this permission notice shall be
27 included in all copies or substantial portions of the Software.
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.
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.
44 #ifndef included_pool_h
45 #define included_pool_h
47 #include <vppinfra/bitmap.h>
48 #include <vppinfra/error.h>
49 #include <vppinfra/mheap.h>
54 /** Bitmap of indices of free objects. */
57 /** Vector of free indices. One element for each set bit in bitmap. */
60 /* The following fields are set for fixed-size, preallocated pools */
62 /** Maximum size of the pool, in elements */
65 /** mmap segment info: base + length */
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 *))
75 /** Get pool header from user pool pointer */
76 always_inline pool_header_t *
79 return vec_aligned_header (v, sizeof (pool_header_t), sizeof (void *));
82 extern void _pool_init_fixed (void **, u32, u32);
83 extern void fpool_free (void *);
85 /** initialize a fixed-size, preallocated pool */
86 #define pool_init_fixed(pool,max_elts) \
88 _pool_init_fixed((void **)&(pool),sizeof(pool[0]),max_elts); \
91 /** Validate a pool */
93 pool_validate (void *v)
95 pool_header_t *p = pool_header (v);
96 uword i, n_free_bitmap;
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);
108 pool_header_validate_index (void *v, uword index)
110 pool_header_t *p = pool_header (v);
113 vec_validate (p->free_bitmap, index / BITS (uword));
116 #define pool_validate_index(v,i) \
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); \
124 /** Number of active elements in a pool.
125 * @return Number of active elements in a pool
130 uword ret = vec_len (v);
132 ret -= vec_len (pool_header (v)->free_indices);
136 /** Number of elements in pool vector.
138 @note You probably want to call pool_elts() instead.
140 #define pool_len(p) vec_len(p)
142 /** Number of elements in pool vector (usable as an lvalue)
144 @note You probably don't want to use this macro.
146 #define _pool_len(p) _vec_len(p)
148 /** Memory usage of pool header. */
150 pool_header_bytes (void *v)
152 pool_header_t *p = pool_header (v);
157 return vec_bytes (p->free_bitmap) + vec_bytes (p->free_indices);
160 /** Memory usage of pool. */
161 #define pool_bytes(P) (vec_bytes (P) + pool_header_bytes (P))
163 /** Local variable naming macro. */
164 #define _pool_var(v) _pool_##v
166 /** Queries whether pool has at least N_FREE free elements. */
168 pool_free_elts (void *v)
170 pool_header_t *p = pool_header (v);
175 n_free += vec_len (p->free_indices);
177 /* Space left at end of vector? */
178 n_free += vec_capacity (v, sizeof (p[0])) - vec_len (v);
184 /** Allocate an object E from a pool P (general version).
186 First search free list. If nothing is free extend vector of objects.
188 #define pool_get_aligned(P,E,A) \
190 pool_header_t * _pool_var (p) = pool_header (P); \
191 uword _pool_var (l); \
193 STATIC_ASSERT(A==0 || ((A % sizeof(P[0]))==0) || ((sizeof(P[0]) % A) == 0), \
194 "Pool aligned alloc of incorrectly sized object"); \
197 _pool_var (l) = vec_len (_pool_var (p)->free_indices); \
199 if (_pool_var (l) > 0) \
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, \
207 _vec_len (_pool_var (p)->free_indices) = _pool_var (l) - 1; \
211 /* fixed-size, preallocated pools cannot expand */ \
212 if ((P) && _pool_var(p)->max_elts) \
214 clib_warning ("can't expand fixed-size pool"); \
215 os_out_of_memory(); \
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, \
223 E = vec_end (P) - 1; \
227 /** Allocate an object E from a pool P (unspecified alignment). */
228 #define pool_get(P,E) pool_get_aligned(P,E,0)
230 /** See if pool_get will expand the pool or not */
231 #define pool_get_aligned_will_expand(P,YESNO,A) \
233 pool_header_t * _pool_var (p) = pool_header (P); \
234 uword _pool_var (l); \
239 if (_pool_var (p)->max_elts) \
240 _pool_var (l) = _pool_var (p)->max_elts; \
242 _pool_var (l) = vec_len (_pool_var (p)->free_indices); \
245 /* Free elements, certainly won't expand */ \
246 if (_pool_var (l) > 0) \
250 /* Nothing on free list, make a new element and return it. */ \
251 YESNO = _vec_resize_will_expand \
253 /* length_increment */ 1, \
254 /* new size */ (vec_len (P) + 1) * sizeof (P[0]), \
255 pool_aligned_header_bytes, \
260 #define pool_get_will_expand(P,YESNO) pool_get_aligned_will_expand(P,YESNO,0)
262 /** Use free bitmap to query whether given element is free. */
263 #define pool_is_free(P,E) \
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 (_pool_var (p)->free_bitmap, _pool_i) : 1; \
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))
273 /** Free an object E in pool P. */
274 #define pool_put(P,E) \
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)); \
281 /* Add element to free bitmap and to free list. */ \
282 _pool_var (p)->free_bitmap = \
283 clib_bitmap_ori_notrim (_pool_var (p)->free_bitmap, \
286 /* Preallocated pool? */ \
287 if (_pool_var (p)->max_elts) \
289 ASSERT(_pool_var(l) < _pool_var (p)->max_elts); \
290 _pool_var(p)->free_indices[_vec_len(_pool_var(p)->free_indices)] = \
292 _vec_len(_pool_var(p)->free_indices) += 1; \
295 vec_add1 (_pool_var (p)->free_indices, _pool_var (l)); \
298 /** Free pool element with given index. */
299 #define pool_put_index(p,i) \
301 typeof (p) _e = (p) + (i); \
305 /** Allocate N more free elements to pool (general version). */
306 #define pool_alloc_aligned(P,N,A) \
308 pool_header_t * _p; \
312 _p = pool_header (P); \
315 clib_warning ("Can't expand fixed-size pool"); \
316 os_out_of_memory(); \
320 (P) = _vec_resize ((P), 0, (vec_len (P) + (N)) * sizeof (P[0]), \
321 pool_aligned_header_bytes, \
323 _p = pool_header (P); \
324 vec_resize (_p->free_indices, (N)); \
325 _vec_len (_p->free_indices) -= (N); \
328 /** Allocate N more free elements to pool (unspecified alignment). */
329 #define pool_alloc(P,N) pool_alloc_aligned(P,N,0)
331 /** Low-level free pool operator (do not call directly). */
335 pool_header_t *p = pool_header (v);
338 clib_bitmap_free (p->free_bitmap);
344 rv = munmap (p->mmap_base, p->mmap_size);
346 clib_unix_warning ("munmap");
350 vec_free (p->free_indices);
351 vec_free_h (v, pool_aligned_header_bytes);
357 #define pool_free(p) (p) = _pool_free(p)
359 /** Optimized iteration through pool.
361 @param LO pointer to first element in chunk
362 @param HI pointer to last element in chunk
363 @param POOL pool to iterate across
364 @param BODY operation to perform
366 Optimized version which assumes that BODY is smart enough to
367 process multiple (LOW,HI) chunks. See also pool_foreach().
369 #define pool_foreach_region(LO,HI,POOL,BODY) \
371 uword _pool_var (i), _pool_var (lo), _pool_var (hi), _pool_var (len); \
372 uword _pool_var (bl), * _pool_var (b); \
373 pool_header_t * _pool_var (p); \
375 _pool_var (p) = pool_header (POOL); \
376 _pool_var (b) = (POOL) ? _pool_var (p)->free_bitmap : 0; \
377 _pool_var (bl) = vec_len (_pool_var (b)); \
378 _pool_var (len) = vec_len (POOL); \
379 _pool_var (lo) = 0; \
381 for (_pool_var (i) = 0; \
382 _pool_var (i) <= _pool_var (bl); \
385 uword _pool_var (m), _pool_var (f); \
386 _pool_var (m) = (_pool_var (i) < _pool_var (bl) \
387 ? _pool_var (b) [_pool_var (i)] \
389 while (_pool_var (m) != 0) \
391 _pool_var (f) = first_set (_pool_var (m)); \
392 _pool_var (hi) = (_pool_var (i) * BITS (_pool_var (b)[0]) \
393 + min_log2 (_pool_var (f))); \
394 _pool_var (hi) = (_pool_var (i) < _pool_var (bl) \
395 ? _pool_var (hi) : _pool_var (len)); \
396 _pool_var (m) ^= _pool_var (f); \
397 if (_pool_var (hi) > _pool_var (lo)) \
399 (LO) = _pool_var (lo); \
400 (HI) = _pool_var (hi); \
401 do { BODY; } while (0); \
403 _pool_var (lo) = _pool_var (hi) + 1; \
408 /** Iterate through pool.
410 @param VAR A variable of same type as pool vector to be used as an
412 @param POOL The pool to iterate across.
413 @param BODY The operation to perform, typically a code block. See
416 This macro will call @c BODY with each active pool element.
418 It is a bad idea to allocate or free pool element from within
419 @c pool_foreach. Build a vector of indices and dispose of them later.
425 proc_t *procs; // a pool of processes.
426 proc_t *proc; // pointer to one process; used as the iterator.
428 pool_foreach (proc, procs, ({
429 if (proc->state != PROC_STATE_RUNNING)
432 // check a running proc in some way
437 @warning Because @c pool_foreach is a macro, syntax errors can be
438 difficult to find inside @c BODY, let alone actual code bugs. One
439 can temporarily split a complex @c pool_foreach into a trivial
440 @c pool_foreach which builds a vector of active indices, and a
441 vec_foreach() (or plain for-loop) to walk the active index vector.
443 #define pool_foreach(VAR,POOL,BODY) \
445 uword _pool_foreach_lo, _pool_foreach_hi; \
446 pool_foreach_region (_pool_foreach_lo, _pool_foreach_hi, (POOL), \
448 for ((VAR) = (POOL) + _pool_foreach_lo; \
449 (VAR) < (POOL) + _pool_foreach_hi; \
451 do { BODY; } while (0); \
455 /** Returns pointer to element at given index.
457 ASSERTs that the supplied index is valid.
458 Even though one can write correct code of the form
460 p = pool_base + index;
462 use of @c pool_elt_at_index is strongly suggested.
464 #define pool_elt_at_index(p,i) \
466 typeof (p) _e = (p) + (i); \
467 ASSERT (! pool_is_free (p, _e)); \
471 /** Return next occupied pool index after @c i, useful for safe iteration. */
472 #define pool_next_index(P,I) \
474 pool_header_t * _pool_var (p) = pool_header (P); \
475 uword _pool_var (rv) = (I) + 1; \
478 (_pool_var (rv) < vec_len (P) ? \
479 clib_bitmap_next_clear (_pool_var (p)->free_bitmap, _pool_var(rv)) \
482 (_pool_var (rv) < vec_len (P) ? \
483 _pool_var (rv) : ~0); \
487 /** Iterate pool by index. */
488 #define pool_foreach_index(i,v,body) \
489 for ((i) = 0; (i) < vec_len (v); (i)++) \
491 if (! pool_is_free_index ((v), (i))) \
492 do { body; } while (0); \
496 * @brief Remove all elemenets from a pool in a safe way
498 * @param VAR each element in the pool
499 * @param POOL The pool to flush
500 * @param BODY The actions to perform on each element before it is returned to
501 * the pool. i.e. before it is 'freed'
503 #define pool_flush(VAR, POOL, BODY) \
505 uword *_pool_var(ii), *_pool_var(dv) = NULL; \
507 pool_foreach((VAR), (POOL), \
509 vec_add1(_pool_var(dv), (VAR) - (POOL)); \
511 vec_foreach(_pool_var(ii), _pool_var(dv)) \
513 (VAR) = pool_elt_at_index((POOL), *_pool_var(ii)); \
514 do { BODY; } while (0); \
515 pool_put((POOL), (VAR)); \
517 vec_free(_pool_var(dv)); \
520 #endif /* included_pool_h */
523 * fd.io coding-style-patch-verification: ON
526 * eval: (c-set-style "gnu")