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 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 #ifndef included_vec_h
39 #define included_vec_h
41 #include <vppinfra/clib.h> /* word, etc */
42 #include <vppinfra/mem.h> /* clib_mem_free */
43 #include <vppinfra/string.h> /* memcpy, memmove */
44 #include <vppinfra/vec_bootstrap.h>
48 CLIB vectors are ubiquitous dynamically resized arrays with by user
49 defined "headers". Many CLIB data structures (e.g. hash, heap,
50 pool) are vectors with various different headers.
52 The memory layout looks like this:
55 user header (aligned to uword boundary)
56 vector length: number of elements
57 user's pointer-> vector element #0
62 The user pointer contains the address of vector element # 0. Null
63 pointer vectors are valid and mean a zero length vector.
65 You can reset the length of an allocated vector to zero via the
66 vec_reset_length(v) macro, or by setting the vector length field to
67 zero (e.g. _vec_len (v) = 0). Vec_reset_length(v) preferred: it
68 understands Null pointers.
70 Typically, the header is not present. Headers allow for other
71 data structures to be built atop CLIB vectors.
73 Users may specify the alignment for data elements via the
76 Vectors elements can be any C type e.g. (int, double, struct bar).
77 This is also true for data types built atop vectors (e.g. heap,
80 Many macros have _a variants supporting alignment of vector data
81 and _h variants supporting non zero length vector headers.
82 The _ha variants support both.
84 Standard programming error: memorize a pointer to the ith element
85 of a vector then expand it. Vectors expand by 3/2, so such code
86 may appear to work for a period of time. Memorize vector indices
90 /** \brief Low-level resize allocation function, usually not called directly
92 @param v pointer to a vector
93 @param length_increment length increment in elements
94 @param data_bytes requested size in bytes
95 @param header_bytes header size in bytes (may be zero)
96 @param data_align alignment (may be zero)
97 @return v_prime pointer to resized vector, may or may not equal v
99 void *vec_resize_allocate_memory (void *v,
100 word length_increment,
102 uword header_bytes, uword data_align);
104 /** \brief Low-level vector resize function, usually not called directly
106 @param v pointer to a vector
107 @param length_increment length increment in elements
108 @param data_bytes requested size in bytes
109 @param header_bytes header size in bytes (may be zero)
110 @param data_align alignment (may be zero)
111 @return v_prime pointer to resized vector, may or may not equal v
115 _vec_resize (void *v,
116 word length_increment,
117 uword data_bytes, uword header_bytes, uword data_align)
119 vec_header_t *vh = _vec_find (v);
120 uword new_data_bytes, aligned_header_bytes;
122 aligned_header_bytes = vec_header_bytes (header_bytes);
124 new_data_bytes = data_bytes + aligned_header_bytes;
126 if (PREDICT_TRUE (v != 0))
128 void *p = v - aligned_header_bytes;
130 /* Vector header must start heap object. */
131 ASSERT (clib_mem_is_heap_object (p));
133 /* Typically we'll not need to resize. */
134 if (new_data_bytes <= clib_mem_size (p))
136 vh->len += length_increment;
141 /* Slow path: call helper function. */
142 return vec_resize_allocate_memory (v, length_increment, data_bytes,
144 clib_max (sizeof (vec_header_t),
148 /** \brief Predicate function, says whether the supplied vector is a clib heap
149 object (general version).
151 @param v pointer to a vector
152 @param header_bytes vector header size in bytes (may be zero)
155 uword clib_mem_is_vec_h (void *v, uword header_bytes);
158 /** \brief Predicate function, says whether the supplied vector is a clib heap
161 @param v pointer to a vector
165 clib_mem_is_vec (void *v)
167 return clib_mem_is_vec_h (v, 0);
170 /* Local variable naming macro (prevents collisions with other macro naming). */
171 #define _v(var) _vec_##var
173 /** \brief Resize a vector (general version).
174 Add N elements to end of given vector V, return pointer to start of vector.
175 Vector will have room for H header bytes and will have user's data aligned
176 at alignment A (rounded to next power of 2).
178 @param V pointer to a vector
179 @param N number of elements to add
180 @param H header size in bytes (may be zero)
181 @param A alignment (may be zero)
182 @return V (value-result macro parameter)
185 #define vec_resize_ha(V,N,H,A) \
188 word _v(l) = vec_len (V); \
189 V = _vec_resize ((V), _v(n), (_v(l) + _v(n)) * sizeof ((V)[0]), (H), (A)); \
192 /** \brief Resize a vector (no header, unspecified alignment)
193 Add N elements to end of given vector V, return pointer to start of vector.
194 Vector will have room for H header bytes and will have user's data aligned
195 at alignment A (rounded to next power of 2).
197 @param V pointer to a vector
198 @param N number of elements to add
199 @return V (value-result macro parameter)
201 #define vec_resize(V,N) vec_resize_ha(V,N,0,0)
203 /** \brief Resize a vector (no header, alignment specified).
204 Add N elements to end of given vector V, return pointer to start of vector.
205 Vector will have room for H header bytes and will have user's data aligned
206 at alignment A (rounded to next power of 2).
208 @param V pointer to a vector
209 @param N number of elements to add
210 @param A alignment (may be zero)
211 @return V (value-result macro parameter)
214 #define vec_resize_aligned(V,N,A) vec_resize_ha(V,N,0,A)
216 /** \brief Allocate space for N more elements
218 @param V pointer to a vector
219 @param N number of elements to add
220 @param H header size in bytes (may be zero)
221 @param A alignment (may be zero)
222 @return V (value-result macro parameter)
225 #define vec_alloc_ha(V,N,H,A) \
227 uword _v(l) = vec_len (V); \
228 vec_resize_ha (V, N, H, A); \
229 _vec_len (V) = _v(l); \
232 /** \brief Allocate space for N more elements
233 (no header, unspecified alignment)
235 @param V pointer to a vector
236 @param N number of elements to add
237 @return V (value-result macro parameter)
239 #define vec_alloc(V,N) vec_alloc_ha(V,N,0,0)
241 /** \brief Allocate space for N more elements (no header, given alignment)
242 @param V pointer to a vector
243 @param N number of elements to add
244 @param A alignment (may be zero)
245 @return V (value-result macro parameter)
248 #define vec_alloc_aligned(V,N,A) vec_alloc_ha(V,N,0,A)
250 /** \brief Create new vector of given type and length (general version).
251 @param T type of elements in new vector
252 @param N number of elements to add
253 @param H header size in bytes (may be zero)
254 @param A alignment (may be zero)
257 #define vec_new_ha(T,N,H,A) \
260 _vec_resize ((T *) 0, _v(n), _v(n) * sizeof (T), (H), (A)); \
263 /** \brief Create new vector of given type and length
264 (unspecified alignment, no header).
266 @param T type of elements in new vector
267 @param N number of elements to add
270 #define vec_new(T,N) vec_new_ha(T,N,0,0)
271 /** \brief Create new vector of given type and length
272 (alignment specified, no header).
274 @param T type of elements in new vector
275 @param N number of elements to add
276 @param A alignment (may be zero)
279 #define vec_new_aligned(T,N,A) vec_new_ha(T,N,0,A)
281 /** \brief Free vector's memory (general version)
283 @param V pointer to a vector
284 @param H size of header in bytes
285 @return V (value-result parameter, V=0)
287 #define vec_free_h(V,H) \
291 clib_mem_free (vec_header ((V), (H))); \
296 /** \brief Free vector's memory (no header).
297 @param V pointer to a vector
298 @return V (value-result parameter, V=0)
300 #define vec_free(V) vec_free_h(V,0)
302 /**\brief Free vector user header (syntactic sugar)
303 @param h vector header
306 #define vec_free_header(h) clib_mem_free (h)
308 /** \brief Return copy of vector (general version).
310 @param V pointer to a vector
311 @param H size of header in bytes
312 @param A alignment (may be zero)
314 @return Vdup copy of vector
317 #define vec_dup_ha(V,H,A) \
319 __typeof__ ((V)[0]) * _v(v) = 0; \
320 uword _v(l) = vec_len (V); \
323 vec_resize_ha (_v(v), _v(l), (H), (A)); \
324 clib_memcpy (_v(v), (V), _v(l) * sizeof ((V)[0]));\
329 /** \brief Return copy of vector (no header, no alignment)
331 @param V pointer to a vector
332 @return Vdup copy of vector
334 #define vec_dup(V) vec_dup_ha(V,0,0)
336 /** \brief Return copy of vector (no header, alignment specified).
338 @param V pointer to a vector
339 @param A alignment (may be zero)
341 @return Vdup copy of vector
343 #define vec_dup_aligned(V,A) vec_dup_ha(V,0,A)
345 /** \brief Copy a vector, memcpy wrapper. Assumes sizeof(SRC[0]) ==
348 @param DST destination
351 #define vec_copy(DST,SRC) clib_memcpy (DST, SRC, vec_len (DST) * \
354 /** \brief Clone a vector. Make a new vector with the
355 same size as a given vector but possibly with a different type.
357 @param NEW_V pointer to new vector
358 @param OLD_V pointer to old vector
360 #define vec_clone(NEW_V,OLD_V) \
363 (NEW_V) = _vec_resize ((NEW_V), vec_len (OLD_V), \
364 vec_len (OLD_V) * sizeof ((NEW_V)[0]), (0), (0)); \
367 /** \brief Make sure vector is long enough for given index (general version).
369 @param V (possibly NULL) pointer to a vector.
370 @param I vector index which will be valid upon return
371 @param H header size in bytes (may be zero)
372 @param A alignment (may be zero)
373 @return V (value-result macro parameter)
376 #define vec_validate_ha(V,I,H,A) \
379 word _v(l) = vec_len (V); \
380 if (_v(i) >= _v(l)) \
382 vec_resize_ha ((V), 1 + (_v(i) - _v(l)), (H), (A)); \
383 /* Must zero new space since user may have previously \
384 used e.g. _vec_len (v) -= 10 */ \
385 memset ((V) + _v(l), 0, (1 + (_v(i) - _v(l))) * sizeof ((V)[0])); \
389 /** \brief Make sure vector is long enough for given index
390 (no header, unspecified alignment)
392 @param V (possibly NULL) pointer to a vector.
393 @param I vector index which will be valid upon return
394 @return V (value-result macro parameter)
396 #define vec_validate(V,I) vec_validate_ha(V,I,0,0)
398 /** \brief Make sure vector is long enough for given index
399 (no header, specified alignment)
401 @param V (possibly NULL) pointer to a vector.
402 @param I vector index which will be valid upon return
403 @param A alignment (may be zero)
404 @return V (value-result macro parameter)
407 #define vec_validate_aligned(V,I,A) vec_validate_ha(V,I,0,A)
409 /** \brief Make sure vector is long enough for given index
410 and initialize empty space (general version)
412 @param V (possibly NULL) pointer to a vector.
413 @param I vector index which will be valid upon return
414 @param INIT initial value (can be a complex expression!)
415 @param H header size in bytes (may be zero)
416 @param A alignment (may be zero)
417 @return V (value-result macro parameter)
419 #define vec_validate_init_empty_ha(V,I,INIT,H,A) \
422 word _v(l) = vec_len (V); \
423 if (_v(i) >= _v(l)) \
425 vec_resize_ha ((V), 1 + (_v(i) - _v(l)), (H), (A)); \
426 while (_v(l) <= _v(i)) \
428 (V)[_v(l)] = (INIT); \
434 /** \brief Make sure vector is long enough for given index
435 and initialize empty space (no header, unspecified alignment)
437 @param V (possibly NULL) pointer to a vector.
438 @param I vector index which will be valid upon return
439 @param INIT initial value (can be a complex expression!)
440 @param H header size in bytes (may be zero)
441 @param A alignment (may be zero)
442 @return V (value-result macro parameter)
445 #define vec_validate_init_empty(V,I,INIT) \
446 vec_validate_init_empty_ha(V,I,INIT,0,0)
448 /** \brief Make sure vector is long enough for given index
449 and initialize empty space (no header, alignment alignment)
451 @param V (possibly NULL) pointer to a vector.
452 @param I vector index which will be valid upon return
453 @param INIT initial value (can be a complex expression!)
454 @param H header size in bytes (may be zero)
455 @param A alignment (may be zero)
456 @return V (value-result macro parameter)
458 #define vec_validate_init_empty_aligned(V,I,A) \
459 vec_validate_init_empty_ha(V,I,INIT,0,A)
461 /** \brief Add 1 element to end of vector (general version).
463 @param V pointer to a vector
464 @param E element to add
465 @param H header size in bytes (may be zero)
466 @param A alignment (may be zero)
467 @return V (value-result macro parameter)
469 #define vec_add1_ha(V,E,H,A) \
471 word _v(l) = vec_len (V); \
472 V = _vec_resize ((V), 1, (_v(l) + 1) * sizeof ((V)[0]), (H), (A)); \
476 /** \brief Add 1 element to end of vector (unspecified alignment).
478 @param V pointer to a vector
479 @param E element to add
480 @return V (value-result macro parameter)
482 #define vec_add1(V,E) vec_add1_ha(V,E,0,0)
484 /** \brief Add 1 element to end of vector (alignment specified).
486 @param V pointer to a vector
487 @param E element to add
488 @param H header size in bytes (may be zero)
489 @param A alignment (may be zero)
490 @return V (value-result macro parameter)
492 #define vec_add1_aligned(V,E,A) vec_add1_ha(V,E,0,A)
494 /** \brief Add N elements to end of vector V,
495 return pointer to new elements in P. (general version)
497 @param V pointer to a vector
498 @param P pointer to new vector element(s)
499 @param N number of elements to add
500 @param H header size in bytes (may be zero)
501 @param A alignment (may be zero)
502 @return V and P (value-result macro parameters)
504 #define vec_add2_ha(V,P,N,H,A) \
507 word _v(l) = vec_len (V); \
508 V = _vec_resize ((V), _v(n), (_v(l) + _v(n)) * sizeof ((V)[0]), (H), (A)); \
512 /** \brief Add N elements to end of vector V,
513 return pointer to new elements in P. (no header, unspecified alignment)
515 @param V pointer to a vector
516 @param P pointer to new vector element(s)
517 @param N number of elements to add
518 @return V and P (value-result macro parameters)
521 #define vec_add2(V,P,N) vec_add2_ha(V,P,N,0,0)
523 /** \brief Add N elements to end of vector V,
524 return pointer to new elements in P. (no header, alignment specified)
526 @param V pointer to a vector
527 @param P pointer to new vector element(s)
528 @param N number of elements to add
529 @param A alignment (may be zero)
530 @return V and P (value-result macro parameters)
533 #define vec_add2_aligned(V,P,N,A) vec_add2_ha(V,P,N,0,A)
535 /** \brief Add N elements to end of vector V (general version)
537 @param V pointer to a vector
538 @param E pointer to element(s) to add
539 @param N number of elements to add
540 @param H header size in bytes (may be zero)
541 @param A alignment (may be zero)
542 @return V (value-result macro parameter)
544 #define vec_add_ha(V,E,N,H,A) \
547 word _v(l) = vec_len (V); \
548 V = _vec_resize ((V), _v(n), (_v(l) + _v(n)) * sizeof ((V)[0]), (H), (A)); \
549 clib_memcpy ((V) + _v(l), (E), _v(n) * sizeof ((V)[0])); \
552 /** \brief Add N elements to end of vector V (no header, unspecified alignment)
554 @param V pointer to a vector
555 @param E pointer to element(s) to add
556 @param N number of elements to add
557 @return V (value-result macro parameter)
559 #define vec_add(V,E,N) vec_add_ha(V,E,N,0,0)
561 /** \brief Add N elements to end of vector V (no header, specified alignment)
563 @param V pointer to a vector
564 @param E pointer to element(s) to add
565 @param N number of elements to add
566 @param A alignment (may be zero)
567 @return V (value-result macro parameter)
569 #define vec_add_aligned(V,E,N,A) vec_add_ha(V,E,N,0,A)
571 /** \brief Returns last element of a vector and decrements its length
573 @param V pointer to a vector
574 @return E element removed from the end of the vector
578 uword _v(l) = vec_len (V); \
579 ASSERT (_v(l) > 0); \
581 _vec_len (V) = _v (l); \
585 /** \brief Set E to the last element of a vector, decrement vector length
586 @param V pointer to a vector
587 @param E pointer to the last vector element
588 @return E element removed from the end of the vector
589 (value-result macro parameter
592 #define vec_pop2(V,E) \
594 uword _v(l) = vec_len (V); \
595 if (_v(l) > 0) (E) = vec_pop (V); \
599 /** \brief Insert N vector elements starting at element M,
600 initialize new elements (general version).
602 @param V (possibly NULL) pointer to a vector.
603 @param N number of elements to insert
604 @param M insertion point
605 @param INIT initial value (can be a complex expression!)
606 @param H header size in bytes (may be zero)
607 @param A alignment (may be zero)
608 @return V (value-result macro parameter)
610 #define vec_insert_init_empty_ha(V,N,M,INIT,H,A) \
612 word _v(l) = vec_len (V); \
615 V = _vec_resize ((V), \
617 (_v(l) + _v(n))*sizeof((V)[0]), \
619 ASSERT (_v(m) <= _v(l)); \
620 memmove ((V) + _v(m) + _v(n), \
622 (_v(l) - _v(m)) * sizeof ((V)[0])); \
623 memset ((V) + _v(m), INIT, _v(n) * sizeof ((V)[0])); \
626 /** \brief Insert N vector elements starting at element M,
627 initialize new elements to zero (general version)
629 @param V (possibly NULL) pointer to a vector.
630 @param N number of elements to insert
631 @param M insertion point
632 @param H header size in bytes (may be zero)
633 @param A alignment (may be zero)
634 @return V (value-result macro parameter)
636 #define vec_insert_ha(V,N,M,H,A) vec_insert_init_empty_ha(V,N,M,0,H,A)
638 /** \brief Insert N vector elements starting at element M,
639 initialize new elements to zero (no header, unspecified alignment)
641 @param V (possibly NULL) pointer to a vector.
642 @param N number of elements to insert
643 @param M insertion point
644 @return V (value-result macro parameter)
646 #define vec_insert(V,N,M) vec_insert_ha(V,N,M,0,0)
648 /** \brief Insert N vector elements starting at element M,
649 initialize new elements to zero (no header, alignment specified)
651 @param V (possibly NULL) pointer to a vector.
652 @param N number of elements to insert
653 @param M insertion point
654 @param A alignment (may be zero)
655 @return V (value-result macro parameter)
657 #define vec_insert_aligned(V,N,M,A) vec_insert_ha(V,N,M,0,A)
659 /** \brief Insert N vector elements starting at element M,
660 initialize new elements (no header, unspecified alignment)
662 @param V (possibly NULL) pointer to a vector.
663 @param N number of elements to insert
664 @param M insertion point
665 @param INIT initial value (can be a complex expression!)
666 @return V (value-result macro parameter)
669 #define vec_insert_init_empty(V,N,M,INIT) \
670 vec_insert_init_empty_ha(V,N,M,INIT,0,0)
671 /* Resize vector by N elements starting from element M, initialize new elements to INIT (alignment specified, no header). */
673 /** \brief Insert N vector elements starting at element M,
674 initialize new elements (no header, specified alignment)
676 @param V (possibly NULL) pointer to a vector.
677 @param N number of elements to insert
678 @param M insertion point
679 @param INIT initial value (can be a complex expression!)
680 @param A alignment (may be zero)
681 @return V (value-result macro parameter)
683 #define vec_insert_init_empty_aligned(V,N,M,INIT,A) \
684 vec_insert_init_empty_ha(V,N,M,INIT,0,A)
686 /** \brief Insert N vector elements starting at element M,
687 insert given elements (general version)
689 @param V (possibly NULL) pointer to a vector.
690 @param E element(s) to insert
691 @param N number of elements to insert
692 @param M insertion point
693 @param H header size in bytes (may be zero)
694 @param A alignment (may be zero)
695 @return V (value-result macro parameter)
698 #define vec_insert_elts_ha(V,E,N,M,H,A) \
700 word _v(l) = vec_len (V); \
703 V = _vec_resize ((V), \
705 (_v(l) + _v(n))*sizeof((V)[0]), \
707 ASSERT (_v(m) <= _v(l)); \
708 memmove ((V) + _v(m) + _v(n), \
710 (_v(l) - _v(m)) * sizeof ((V)[0])); \
711 clib_memcpy ((V) + _v(m), (E), \
712 _v(n) * sizeof ((V)[0])); \
715 /** \brief Insert N vector elements starting at element M,
716 insert given elements (no header, unspecified alignment)
718 @param V (possibly NULL) pointer to a vector.
719 @param E element(s) to insert
720 @param N number of elements to insert
721 @param M insertion point
722 @return V (value-result macro parameter)
724 #define vec_insert_elts(V,E,N,M) vec_insert_elts_ha(V,E,N,M,0,0)
726 /** \brief Insert N vector elements starting at element M,
727 insert given elements (no header, specified alignment)
729 @param V (possibly NULL) pointer to a vector.
730 @param E element(s) to insert
731 @param N number of elements to insert
732 @param M insertion point
733 @param A alignment (may be zero)
734 @return V (value-result macro parameter)
736 #define vec_insert_elts_aligned(V,E,N,M,A) vec_insert_elts_ha(V,E,N,M,0,A)
738 /** \brief Delete N elements starting at element M
740 @param V pointer to a vector
741 @param N number of elements to delete
742 @param M first element to delete
743 @return V (value-result macro parameter)
745 #define vec_delete(V,N,M) \
747 word _v(l) = vec_len (V); \
750 /* Copy over deleted elements. */ \
751 if (_v(l) - _v(n) - _v(m) > 0) \
752 memmove ((V) + _v(m), (V) + _v(m) + _v(n), \
753 (_v(l) - _v(n) - _v(m)) * sizeof ((V)[0])); \
754 /* Zero empty space at end (for future re-allocation). */ \
756 memset ((V) + _v(l) - _v(n), 0, _v(n) * sizeof ((V)[0])); \
757 _vec_len (V) -= _v(n); \
760 /** \brief Delete the element at index I
762 @param V pointer to a vector
763 @param I index to delete
765 #define vec_del1(v,i) \
767 uword _vec_del_l = _vec_len (v) - 1; \
768 uword _vec_del_i = (i); \
769 if (_vec_del_i < _vec_del_l) \
770 (v)[_vec_del_i] = (v)[_vec_del_l]; \
771 _vec_len (v) = _vec_del_l; \
774 /** \brief Append v2 after v1. Result in v1.
775 @param V1 target vector
776 @param V2 vector to append
779 #define vec_append(v1,v2) \
781 uword _v(l1) = vec_len (v1); \
782 uword _v(l2) = vec_len (v2); \
784 v1 = _vec_resize ((v1), _v(l2), \
785 (_v(l1) + _v(l2)) * sizeof ((v1)[0]), 0, 0); \
786 clib_memcpy ((v1) + _v(l1), (v2), _v(l2) * sizeof ((v2)[0])); \
789 /** \brief Append v2 after v1. Result in v1. Specified alignment.
790 @param V1 target vector
791 @param V2 vector to append
792 @param align required alignment
795 #define vec_append_aligned(v1,v2,align) \
797 uword _v(l1) = vec_len (v1); \
798 uword _v(l2) = vec_len (v2); \
800 v1 = _vec_resize ((v1), _v(l2), \
801 (_v(l1) + _v(l2)) * sizeof ((v1)[0]), 0, align); \
802 clib_memcpy ((v1) + _v(l1), (v2), _v(l2) * sizeof ((v2)[0])); \
805 /** \brief Prepend v2 before v1. Result in v1.
806 @param V1 target vector
807 @param V2 vector to prepend
810 #define vec_prepend(v1,v2) \
812 uword _v(l1) = vec_len (v1); \
813 uword _v(l2) = vec_len (v2); \
815 v1 = _vec_resize ((v1), _v(l2), \
816 (_v(l1) + _v(l2)) * sizeof ((v1)[0]), 0, 0); \
817 memmove ((v1) + _v(l2), (v1), _v(l1) * sizeof ((v1)[0])); \
818 clib_memcpy ((v1), (v2), _v(l2) * sizeof ((v2)[0])); \
821 /** \brief Prepend v2 before v1. Result in v1. Specified alignment
822 @param V1 target vector
823 @param V2 vector to prepend
824 @param align required alignment
827 #define vec_prepend_aligned(v1,v2,align) \
829 uword _v(l1) = vec_len (v1); \
830 uword _v(l2) = vec_len (v2); \
832 v1 = _vec_resize ((v1), _v(l2), \
833 (_v(l1) + _v(l2)) * sizeof ((v1)[0]), 0, align); \
834 memmove ((v1) + _v(l2), (v1), _v(l1) * sizeof ((v1)[0])); \
835 clib_memcpy ((v1), (v2), _v(l2) * sizeof ((v2)[0])); \
839 /** \brief Zero all vector elements. Null-pointer tolerant.
840 @param var Vector to zero
842 #define vec_zero(var) \
845 memset ((var), 0, vec_len (var) * sizeof ((var)[0])); \
848 /** \brief Set all vector elements to given value. Null-pointer tolerant.
849 @param v vector to set
850 @param val value for each vector element
852 #define vec_set(v,val) \
855 __typeof__ ((v)[0]) _val = (val); \
856 for (_v(i) = 0; _v(i) < vec_len (v); _v(i)++) \
861 #include <stdlib.h> /* for qsort */
864 /** \brief Compare two vectors, not NULL-pointer tolerant
866 @param v1 Pointer to a vector
867 @param v2 Pointer to a vector
868 @return 1 if equal, 0 if unequal
870 #define vec_is_equal(v1,v2) \
871 (vec_len (v1) == vec_len (v2) && ! memcmp ((v1), (v2), vec_len (v1) * sizeof ((v1)[0])))
873 /** \brief Compare two vectors (only applicable to vectors of signed numbers).
874 Used in qsort compare functions.
876 @param v1 Pointer to a vector
877 @param v2 Pointer to a vector
880 #define vec_cmp(v1,v2) \
882 word _v(i), _v(cmp), _v(l); \
883 _v(l) = clib_min (vec_len (v1), vec_len (v2)); \
885 for (_v(i) = 0; _v(i) < _v(l); _v(i)++) { \
886 _v(cmp) = (v1)[_v(i)] - (v2)[_v(i)]; \
890 if (_v(cmp) == 0 && _v(l) > 0) \
891 _v(cmp) = vec_len(v1) - vec_len(v2); \
892 (_v(cmp) < 0 ? -1 : (_v(cmp) > 0 ? +1 : 0)); \
895 /** \brief Search a vector for the index of the entry that matches.
897 @param v1 Pointer to a vector
898 @param v2 Entry to match
899 @return index of match or ~0
901 #define vec_search(v,E) \
904 while (_v(i) < vec_len(v)) \
910 if (_v(i) == vec_len(v)) \
915 /** \brief Sort a vector using the supplied element comparison function
917 @param vec vector to sort
918 @param f comparison function
920 #define vec_sort_with_function(vec,f) \
922 qsort (vec, vec_len (vec), sizeof (vec[0]), (void *) (f)); \
925 /** \brief Make a vector containing a NULL terminated c-string.
927 @param V (possibly NULL) pointer to a vector.
928 @param S pointer to string buffer.
929 @param L string length (NOT including the terminating NULL; a la strlen())
931 #define vec_validate_init_c_string(V, S, L) \
933 vec_reset_length (V); \
934 vec_validate ((V), (L)); \
936 clib_memcpy ((V), (S), (L)); \
941 /** \brief Test whether a vector is a NULL terminated c-string.
943 @param V (possibly NULL) pointer to a vector.
944 @return BOOLEAN indicating if the vector c-string is null terminated.
946 #define vec_c_string_is_terminated(V) \
947 (((V) != 0) && (vec_len (V) != 0) && ((V)[vec_len ((V)) - 1] == 0))
949 /** \brief (If necessary) NULL terminate a vector containing a c-string.
951 @param V (possibly NULL) pointer to a vector.
952 @return V (value-result macro parameter)
954 #define vec_terminate_c_string(V) \
956 u32 vl = vec_len ((V)); \
957 if (!vec_c_string_is_terminated(V)) \
959 vec_validate ((V), vl); \
964 #endif /* included_vec_h */
968 * fd.io coding-style-patch-verification: ON
971 * eval: (c-set-style "gnu")