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 Determine if vector will resize with next allocation
150 @param v pointer to a vector
151 @param length_increment length increment in elements
152 @param data_bytes requested size in bytes
153 @param header_bytes header size in bytes (may be zero)
154 @param data_align alignment (may be zero)
155 @return 1 if vector will resize 0 otherwise
159 _vec_resize_will_expand (void *v,
160 word length_increment,
161 uword data_bytes, uword header_bytes,
164 uword new_data_bytes, aligned_header_bytes;
166 aligned_header_bytes = vec_header_bytes (header_bytes);
168 new_data_bytes = data_bytes + aligned_header_bytes;
170 if (PREDICT_TRUE (v != 0))
172 void *p = v - aligned_header_bytes;
174 /* Vector header must start heap object. */
175 ASSERT (clib_mem_is_heap_object (p));
177 /* Typically we'll not need to resize. */
178 if (new_data_bytes <= clib_mem_size (p))
184 /** \brief Predicate function, says whether the supplied vector is a clib heap
185 object (general version).
187 @param v pointer to a vector
188 @param header_bytes vector header size in bytes (may be zero)
191 uword clib_mem_is_vec_h (void *v, uword header_bytes);
194 /** \brief Predicate function, says whether the supplied vector is a clib heap
197 @param v pointer to a vector
201 clib_mem_is_vec (void *v)
203 return clib_mem_is_vec_h (v, 0);
206 /* Local variable naming macro (prevents collisions with other macro naming). */
207 #define _v(var) _vec_##var
209 /** \brief Resize a vector (general version).
210 Add N elements to end of given vector V, return pointer to start of vector.
211 Vector will have room for H header bytes and will have user's data aligned
212 at alignment A (rounded to next power of 2).
214 @param V pointer to a vector
215 @param N number of elements to add
216 @param H header size in bytes (may be zero)
217 @param A alignment (may be zero)
218 @return V (value-result macro parameter)
221 #define vec_resize_ha(V,N,H,A) \
224 word _v(l) = vec_len (V); \
225 V = _vec_resize ((V), _v(n), (_v(l) + _v(n)) * sizeof ((V)[0]), (H), (A)); \
228 /** \brief Resize a vector (no header, unspecified alignment)
229 Add N elements to end of given vector V, return pointer to start of vector.
230 Vector will have room for H header bytes and will have user's data aligned
231 at alignment A (rounded to next power of 2).
233 @param V pointer to a vector
234 @param N number of elements to add
235 @return V (value-result macro parameter)
237 #define vec_resize(V,N) vec_resize_ha(V,N,0,0)
239 /** \brief Resize a vector (no header, alignment specified).
240 Add N elements to end of given vector V, return pointer to start of vector.
241 Vector will have room for H header bytes and will have user's data aligned
242 at alignment A (rounded to next power of 2).
244 @param V pointer to a vector
245 @param N number of elements to add
246 @param A alignment (may be zero)
247 @return V (value-result macro parameter)
250 #define vec_resize_aligned(V,N,A) vec_resize_ha(V,N,0,A)
252 /** \brief Allocate space for N more elements
254 @param V pointer to a vector
255 @param N number of elements to add
256 @param H header size in bytes (may be zero)
257 @param A alignment (may be zero)
258 @return V (value-result macro parameter)
261 #define vec_alloc_ha(V,N,H,A) \
263 uword _v(l) = vec_len (V); \
264 vec_resize_ha (V, N, H, A); \
265 _vec_len (V) = _v(l); \
268 /** \brief Allocate space for N more elements
269 (no header, unspecified alignment)
271 @param V pointer to a vector
272 @param N number of elements to add
273 @return V (value-result macro parameter)
275 #define vec_alloc(V,N) vec_alloc_ha(V,N,0,0)
277 /** \brief Allocate space for N more elements (no header, given alignment)
278 @param V pointer to a vector
279 @param N number of elements to add
280 @param A alignment (may be zero)
281 @return V (value-result macro parameter)
284 #define vec_alloc_aligned(V,N,A) vec_alloc_ha(V,N,0,A)
286 /** \brief Create new vector of given type and length (general version).
287 @param T type of elements in new vector
288 @param N number of elements to add
289 @param H header size in bytes (may be zero)
290 @param A alignment (may be zero)
293 #define vec_new_ha(T,N,H,A) \
296 _vec_resize ((T *) 0, _v(n), _v(n) * sizeof (T), (H), (A)); \
299 /** \brief Create new vector of given type and length
300 (unspecified alignment, no header).
302 @param T type of elements in new vector
303 @param N number of elements to add
306 #define vec_new(T,N) vec_new_ha(T,N,0,0)
307 /** \brief Create new vector of given type and length
308 (alignment specified, no header).
310 @param T type of elements in new vector
311 @param N number of elements to add
312 @param A alignment (may be zero)
315 #define vec_new_aligned(T,N,A) vec_new_ha(T,N,0,A)
317 /** \brief Free vector's memory (general version)
319 @param V pointer to a vector
320 @param H size of header in bytes
321 @return V (value-result parameter, V=0)
323 #define vec_free_h(V,H) \
327 clib_mem_free (vec_header ((V), (H))); \
332 /** \brief Free vector's memory (no header).
333 @param V pointer to a vector
334 @return V (value-result parameter, V=0)
336 #define vec_free(V) vec_free_h(V,0)
338 /**\brief Free vector user header (syntactic sugar)
339 @param h vector header
342 #define vec_free_header(h) clib_mem_free (h)
344 /** \brief Return copy of vector (general version).
346 @param V pointer to a vector
347 @param H size of header in bytes
348 @param A alignment (may be zero)
350 @return Vdup copy of vector
353 #define vec_dup_ha(V,H,A) \
355 __typeof__ ((V)[0]) * _v(v) = 0; \
356 uword _v(l) = vec_len (V); \
359 vec_resize_ha (_v(v), _v(l), (H), (A)); \
360 clib_memcpy (_v(v), (V), _v(l) * sizeof ((V)[0]));\
365 /** \brief Return copy of vector (no header, no alignment)
367 @param V pointer to a vector
368 @return Vdup copy of vector
370 #define vec_dup(V) vec_dup_ha(V,0,0)
372 /** \brief Return copy of vector (no header, alignment specified).
374 @param V pointer to a vector
375 @param A alignment (may be zero)
377 @return Vdup copy of vector
379 #define vec_dup_aligned(V,A) vec_dup_ha(V,0,A)
381 /** \brief Copy a vector, memcpy wrapper. Assumes sizeof(SRC[0]) ==
384 @param DST destination
387 #define vec_copy(DST,SRC) clib_memcpy (DST, SRC, vec_len (DST) * \
390 /** \brief Clone a vector. Make a new vector with the
391 same size as a given vector but possibly with a different type.
393 @param NEW_V pointer to new vector
394 @param OLD_V pointer to old vector
396 #define vec_clone(NEW_V,OLD_V) \
399 (NEW_V) = _vec_resize ((NEW_V), vec_len (OLD_V), \
400 vec_len (OLD_V) * sizeof ((NEW_V)[0]), (0), (0)); \
403 /** \brief Make sure vector is long enough for given index (general version).
405 @param V (possibly NULL) pointer to a vector.
406 @param I vector index which will be valid upon return
407 @param H header size in bytes (may be zero)
408 @param A alignment (may be zero)
409 @return V (value-result macro parameter)
412 #define vec_validate_ha(V,I,H,A) \
415 word _v(l) = vec_len (V); \
416 if (_v(i) >= _v(l)) \
418 vec_resize_ha ((V), 1 + (_v(i) - _v(l)), (H), (A)); \
419 /* Must zero new space since user may have previously \
420 used e.g. _vec_len (v) -= 10 */ \
421 memset ((V) + _v(l), 0, (1 + (_v(i) - _v(l))) * sizeof ((V)[0])); \
425 /** \brief Make sure vector is long enough for given index
426 (no header, unspecified alignment)
428 @param V (possibly NULL) pointer to a vector.
429 @param I vector index which will be valid upon return
430 @return V (value-result macro parameter)
432 #define vec_validate(V,I) vec_validate_ha(V,I,0,0)
434 /** \brief Make sure vector is long enough for given index
435 (no header, specified alignment)
437 @param V (possibly NULL) pointer to a vector.
438 @param I vector index which will be valid upon return
439 @param A alignment (may be zero)
440 @return V (value-result macro parameter)
443 #define vec_validate_aligned(V,I,A) vec_validate_ha(V,I,0,A)
445 /** \brief Make sure vector is long enough for given index
446 and initialize empty space (general version)
448 @param V (possibly NULL) pointer to a vector.
449 @param I vector index which will be valid upon return
450 @param INIT initial value (can be a complex expression!)
451 @param H header size in bytes (may be zero)
452 @param A alignment (may be zero)
453 @return V (value-result macro parameter)
455 #define vec_validate_init_empty_ha(V,I,INIT,H,A) \
458 word _v(l) = vec_len (V); \
459 if (_v(i) >= _v(l)) \
461 vec_resize_ha ((V), 1 + (_v(i) - _v(l)), (H), (A)); \
462 while (_v(l) <= _v(i)) \
464 (V)[_v(l)] = (INIT); \
470 /** \brief Make sure vector is long enough for given index
471 and initialize empty space (no header, unspecified alignment)
473 @param V (possibly NULL) pointer to a vector.
474 @param I vector index which will be valid upon return
475 @param INIT initial value (can be a complex expression!)
476 @param H header size in bytes (may be zero)
477 @param A alignment (may be zero)
478 @return V (value-result macro parameter)
481 #define vec_validate_init_empty(V,I,INIT) \
482 vec_validate_init_empty_ha(V,I,INIT,0,0)
484 /** \brief Make sure vector is long enough for given index
485 and initialize empty space (no header, alignment alignment)
487 @param V (possibly NULL) pointer to a vector.
488 @param I vector index which will be valid upon return
489 @param INIT initial value (can be a complex expression!)
490 @param H header size in bytes (may be zero)
491 @param A alignment (may be zero)
492 @return V (value-result macro parameter)
494 #define vec_validate_init_empty_aligned(V,I,INIT,A) \
495 vec_validate_init_empty_ha(V,I,INIT,0,A)
497 /** \brief Add 1 element to end of vector (general version).
499 @param V pointer to a vector
500 @param E element to add
501 @param H header size in bytes (may be zero)
502 @param A alignment (may be zero)
503 @return V (value-result macro parameter)
505 #define vec_add1_ha(V,E,H,A) \
507 word _v(l) = vec_len (V); \
508 V = _vec_resize ((V), 1, (_v(l) + 1) * sizeof ((V)[0]), (H), (A)); \
512 /** \brief Add 1 element to end of vector (unspecified alignment).
514 @param V pointer to a vector
515 @param E element to add
516 @return V (value-result macro parameter)
518 #define vec_add1(V,E) vec_add1_ha(V,E,0,0)
520 /** \brief Add 1 element to end of vector (alignment specified).
522 @param V pointer to a vector
523 @param E element to add
524 @param H header size in bytes (may be zero)
525 @param A alignment (may be zero)
526 @return V (value-result macro parameter)
528 #define vec_add1_aligned(V,E,A) vec_add1_ha(V,E,0,A)
530 /** \brief Add N elements to end of vector V,
531 return pointer to new elements in P. (general version)
533 @param V pointer to a vector
534 @param P pointer to new vector element(s)
535 @param N number of elements to add
536 @param H header size in bytes (may be zero)
537 @param A alignment (may be zero)
538 @return V and P (value-result macro parameters)
540 #define vec_add2_ha(V,P,N,H,A) \
543 word _v(l) = vec_len (V); \
544 V = _vec_resize ((V), _v(n), (_v(l) + _v(n)) * sizeof ((V)[0]), (H), (A)); \
548 /** \brief Add N elements to end of vector V,
549 return pointer to new elements in P. (no header, unspecified alignment)
551 @param V pointer to a vector
552 @param P pointer to new vector element(s)
553 @param N number of elements to add
554 @return V and P (value-result macro parameters)
557 #define vec_add2(V,P,N) vec_add2_ha(V,P,N,0,0)
559 /** \brief Add N elements to end of vector V,
560 return pointer to new elements in P. (no header, alignment specified)
562 @param V pointer to a vector
563 @param P pointer to new vector element(s)
564 @param N number of elements to add
565 @param A alignment (may be zero)
566 @return V and P (value-result macro parameters)
569 #define vec_add2_aligned(V,P,N,A) vec_add2_ha(V,P,N,0,A)
571 /** \brief Add N elements to end of vector V (general version)
573 @param V pointer to a vector
574 @param E pointer to element(s) to add
575 @param N number of elements to add
576 @param H header size in bytes (may be zero)
577 @param A alignment (may be zero)
578 @return V (value-result macro parameter)
580 #define vec_add_ha(V,E,N,H,A) \
583 word _v(l) = vec_len (V); \
584 V = _vec_resize ((V), _v(n), (_v(l) + _v(n)) * sizeof ((V)[0]), (H), (A)); \
585 clib_memcpy ((V) + _v(l), (E), _v(n) * sizeof ((V)[0])); \
588 /** \brief Add N elements to end of vector V (no header, unspecified alignment)
590 @param V pointer to a vector
591 @param E pointer to element(s) to add
592 @param N number of elements to add
593 @return V (value-result macro parameter)
595 #define vec_add(V,E,N) vec_add_ha(V,E,N,0,0)
597 /** \brief Add N elements to end of vector V (no header, specified alignment)
599 @param V pointer to a vector
600 @param E pointer to element(s) to add
601 @param N number of elements to add
602 @param A alignment (may be zero)
603 @return V (value-result macro parameter)
605 #define vec_add_aligned(V,E,N,A) vec_add_ha(V,E,N,0,A)
607 /** \brief Returns last element of a vector and decrements its length
609 @param V pointer to a vector
610 @return E element removed from the end of the vector
614 uword _v(l) = vec_len (V); \
615 ASSERT (_v(l) > 0); \
617 _vec_len (V) = _v (l); \
621 /** \brief Set E to the last element of a vector, decrement vector length
622 @param V pointer to a vector
623 @param E pointer to the last vector element
624 @return E element removed from the end of the vector
625 (value-result macro parameter
628 #define vec_pop2(V,E) \
630 uword _v(l) = vec_len (V); \
631 if (_v(l) > 0) (E) = vec_pop (V); \
635 /** \brief Insert N vector elements starting at element M,
636 initialize new elements (general version).
638 @param V (possibly NULL) pointer to a vector.
639 @param N number of elements to insert
640 @param M insertion point
641 @param INIT initial value (can be a complex expression!)
642 @param H header size in bytes (may be zero)
643 @param A alignment (may be zero)
644 @return V (value-result macro parameter)
646 #define vec_insert_init_empty_ha(V,N,M,INIT,H,A) \
648 word _v(l) = vec_len (V); \
651 V = _vec_resize ((V), \
653 (_v(l) + _v(n))*sizeof((V)[0]), \
655 ASSERT (_v(m) <= _v(l)); \
656 memmove ((V) + _v(m) + _v(n), \
658 (_v(l) - _v(m)) * sizeof ((V)[0])); \
659 memset ((V) + _v(m), INIT, _v(n) * sizeof ((V)[0])); \
662 /** \brief Insert N vector elements starting at element M,
663 initialize new elements to zero (general version)
665 @param V (possibly NULL) pointer to a vector.
666 @param N number of elements to insert
667 @param M insertion point
668 @param H header size in bytes (may be zero)
669 @param A alignment (may be zero)
670 @return V (value-result macro parameter)
672 #define vec_insert_ha(V,N,M,H,A) vec_insert_init_empty_ha(V,N,M,0,H,A)
674 /** \brief Insert N vector elements starting at element M,
675 initialize new elements to zero (no header, unspecified alignment)
677 @param V (possibly NULL) pointer to a vector.
678 @param N number of elements to insert
679 @param M insertion point
680 @return V (value-result macro parameter)
682 #define vec_insert(V,N,M) vec_insert_ha(V,N,M,0,0)
684 /** \brief Insert N vector elements starting at element M,
685 initialize new elements to zero (no header, alignment specified)
687 @param V (possibly NULL) pointer to a vector.
688 @param N number of elements to insert
689 @param M insertion point
690 @param A alignment (may be zero)
691 @return V (value-result macro parameter)
693 #define vec_insert_aligned(V,N,M,A) vec_insert_ha(V,N,M,0,A)
695 /** \brief Insert N vector elements starting at element M,
696 initialize new elements (no header, unspecified alignment)
698 @param V (possibly NULL) pointer to a vector.
699 @param N number of elements to insert
700 @param M insertion point
701 @param INIT initial value (can be a complex expression!)
702 @return V (value-result macro parameter)
705 #define vec_insert_init_empty(V,N,M,INIT) \
706 vec_insert_init_empty_ha(V,N,M,INIT,0,0)
707 /* Resize vector by N elements starting from element M, initialize new elements to INIT (alignment specified, no header). */
709 /** \brief Insert N vector elements starting at element M,
710 initialize new elements (no header, specified alignment)
712 @param V (possibly NULL) pointer to a vector.
713 @param N number of elements to insert
714 @param M insertion point
715 @param INIT initial value (can be a complex expression!)
716 @param A alignment (may be zero)
717 @return V (value-result macro parameter)
719 #define vec_insert_init_empty_aligned(V,N,M,INIT,A) \
720 vec_insert_init_empty_ha(V,N,M,INIT,0,A)
722 /** \brief Insert N vector elements starting at element M,
723 insert given elements (general version)
725 @param V (possibly NULL) pointer to a vector.
726 @param E element(s) to insert
727 @param N number of elements to insert
728 @param M insertion point
729 @param H header size in bytes (may be zero)
730 @param A alignment (may be zero)
731 @return V (value-result macro parameter)
734 #define vec_insert_elts_ha(V,E,N,M,H,A) \
736 word _v(l) = vec_len (V); \
739 V = _vec_resize ((V), \
741 (_v(l) + _v(n))*sizeof((V)[0]), \
743 ASSERT (_v(m) <= _v(l)); \
744 memmove ((V) + _v(m) + _v(n), \
746 (_v(l) - _v(m)) * sizeof ((V)[0])); \
747 clib_memcpy ((V) + _v(m), (E), \
748 _v(n) * sizeof ((V)[0])); \
751 /** \brief Insert N vector elements starting at element M,
752 insert given elements (no header, unspecified alignment)
754 @param V (possibly NULL) pointer to a vector.
755 @param E element(s) to insert
756 @param N number of elements to insert
757 @param M insertion point
758 @return V (value-result macro parameter)
760 #define vec_insert_elts(V,E,N,M) vec_insert_elts_ha(V,E,N,M,0,0)
762 /** \brief Insert N vector elements starting at element M,
763 insert given elements (no header, specified alignment)
765 @param V (possibly NULL) pointer to a vector.
766 @param E element(s) to insert
767 @param N number of elements to insert
768 @param M insertion point
769 @param A alignment (may be zero)
770 @return V (value-result macro parameter)
772 #define vec_insert_elts_aligned(V,E,N,M,A) vec_insert_elts_ha(V,E,N,M,0,A)
774 /** \brief Delete N elements starting at element M
776 @param V pointer to a vector
777 @param N number of elements to delete
778 @param M first element to delete
779 @return V (value-result macro parameter)
781 #define vec_delete(V,N,M) \
783 word _v(l) = vec_len (V); \
786 /* Copy over deleted elements. */ \
787 if (_v(l) - _v(n) - _v(m) > 0) \
788 memmove ((V) + _v(m), (V) + _v(m) + _v(n), \
789 (_v(l) - _v(n) - _v(m)) * sizeof ((V)[0])); \
790 /* Zero empty space at end (for future re-allocation). */ \
792 memset ((V) + _v(l) - _v(n), 0, _v(n) * sizeof ((V)[0])); \
793 _vec_len (V) -= _v(n); \
796 /** \brief Delete the element at index I
798 @param V pointer to a vector
799 @param I index to delete
801 #define vec_del1(v,i) \
803 uword _vec_del_l = _vec_len (v) - 1; \
804 uword _vec_del_i = (i); \
805 if (_vec_del_i < _vec_del_l) \
806 (v)[_vec_del_i] = (v)[_vec_del_l]; \
807 _vec_len (v) = _vec_del_l; \
810 /** \brief Append v2 after v1. Result in v1.
811 @param V1 target vector
812 @param V2 vector to append
815 #define vec_append(v1,v2) \
817 uword _v(l1) = vec_len (v1); \
818 uword _v(l2) = vec_len (v2); \
820 v1 = _vec_resize ((v1), _v(l2), \
821 (_v(l1) + _v(l2)) * sizeof ((v1)[0]), 0, 0); \
822 clib_memcpy ((v1) + _v(l1), (v2), _v(l2) * sizeof ((v2)[0])); \
825 /** \brief Append v2 after v1. Result in v1. Specified alignment.
826 @param V1 target vector
827 @param V2 vector to append
828 @param align required alignment
831 #define vec_append_aligned(v1,v2,align) \
833 uword _v(l1) = vec_len (v1); \
834 uword _v(l2) = vec_len (v2); \
836 v1 = _vec_resize ((v1), _v(l2), \
837 (_v(l1) + _v(l2)) * sizeof ((v1)[0]), 0, align); \
838 clib_memcpy ((v1) + _v(l1), (v2), _v(l2) * sizeof ((v2)[0])); \
841 /** \brief Prepend v2 before v1. Result in v1.
842 @param V1 target vector
843 @param V2 vector to prepend
846 #define vec_prepend(v1,v2) \
848 uword _v(l1) = vec_len (v1); \
849 uword _v(l2) = vec_len (v2); \
851 v1 = _vec_resize ((v1), _v(l2), \
852 (_v(l1) + _v(l2)) * sizeof ((v1)[0]), 0, 0); \
853 memmove ((v1) + _v(l2), (v1), _v(l1) * sizeof ((v1)[0])); \
854 clib_memcpy ((v1), (v2), _v(l2) * sizeof ((v2)[0])); \
857 /** \brief Prepend v2 before v1. Result in v1. Specified alignment
858 @param V1 target vector
859 @param V2 vector to prepend
860 @param align required alignment
863 #define vec_prepend_aligned(v1,v2,align) \
865 uword _v(l1) = vec_len (v1); \
866 uword _v(l2) = vec_len (v2); \
868 v1 = _vec_resize ((v1), _v(l2), \
869 (_v(l1) + _v(l2)) * sizeof ((v1)[0]), 0, align); \
870 memmove ((v1) + _v(l2), (v1), _v(l1) * sizeof ((v1)[0])); \
871 clib_memcpy ((v1), (v2), _v(l2) * sizeof ((v2)[0])); \
875 /** \brief Zero all vector elements. Null-pointer tolerant.
876 @param var Vector to zero
878 #define vec_zero(var) \
881 memset ((var), 0, vec_len (var) * sizeof ((var)[0])); \
884 /** \brief Set all vector elements to given value. Null-pointer tolerant.
885 @param v vector to set
886 @param val value for each vector element
888 #define vec_set(v,val) \
891 __typeof__ ((v)[0]) _val = (val); \
892 for (_v(i) = 0; _v(i) < vec_len (v); _v(i)++) \
897 #include <stdlib.h> /* for qsort */
900 /** \brief Compare two vectors, not NULL-pointer tolerant
902 @param v1 Pointer to a vector
903 @param v2 Pointer to a vector
904 @return 1 if equal, 0 if unequal
906 #define vec_is_equal(v1,v2) \
907 (vec_len (v1) == vec_len (v2) && ! memcmp ((v1), (v2), vec_len (v1) * sizeof ((v1)[0])))
909 /** \brief Compare two vectors (only applicable to vectors of signed numbers).
910 Used in qsort compare functions.
912 @param v1 Pointer to a vector
913 @param v2 Pointer to a vector
916 #define vec_cmp(v1,v2) \
918 word _v(i), _v(cmp), _v(l); \
919 _v(l) = clib_min (vec_len (v1), vec_len (v2)); \
921 for (_v(i) = 0; _v(i) < _v(l); _v(i)++) { \
922 _v(cmp) = (v1)[_v(i)] - (v2)[_v(i)]; \
926 if (_v(cmp) == 0 && _v(l) > 0) \
927 _v(cmp) = vec_len(v1) - vec_len(v2); \
928 (_v(cmp) < 0 ? -1 : (_v(cmp) > 0 ? +1 : 0)); \
931 /** \brief Search a vector for the index of the entry that matches.
933 @param v1 Pointer to a vector
934 @param v2 Entry to match
935 @return index of match or ~0
937 #define vec_search(v,E) \
940 while (_v(i) < vec_len(v)) \
942 if ((v)[_v(i)] == E) \
946 if (_v(i) == vec_len(v)) \
951 /** \brief Sort a vector using the supplied element comparison function
953 @param vec vector to sort
954 @param f comparison function
956 #define vec_sort_with_function(vec,f) \
958 qsort (vec, vec_len (vec), sizeof (vec[0]), (void *) (f)); \
961 /** \brief Make a vector containing a NULL terminated c-string.
963 @param V (possibly NULL) pointer to a vector.
964 @param S pointer to string buffer.
965 @param L string length (NOT including the terminating NULL; a la strlen())
967 #define vec_validate_init_c_string(V, S, L) \
969 vec_reset_length (V); \
970 vec_validate ((V), (L)); \
972 clib_memcpy ((V), (S), (L)); \
977 /** \brief Test whether a vector is a NULL terminated c-string.
979 @param V (possibly NULL) pointer to a vector.
980 @return BOOLEAN indicating if the vector c-string is null terminated.
982 #define vec_c_string_is_terminated(V) \
983 (((V) != 0) && (vec_len (V) != 0) && ((V)[vec_len ((V)) - 1] == 0))
985 /** \brief (If necessary) NULL terminate a vector containing a c-string.
987 @param V (possibly NULL) pointer to a vector.
988 @return V (value-result macro parameter)
990 #define vec_terminate_c_string(V) \
992 u32 vl = vec_len ((V)); \
993 if (!vec_c_string_is_terminated(V)) \
995 vec_validate ((V), vl); \
1000 #endif /* included_vec_h */
1004 * fd.io coding-style-patch-verification: ON
1007 * eval: (c-set-style "gnu")