src/vppinfra/vec_bootstrap.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 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
  38 #ifndef included_clib_vec_bootstrap_h
  39 #define included_clib_vec_bootstrap_h
  40
  41 /** \file
  42     Vector bootstrap header file
  43 */
  44
  45 /* Bootstrap include so that #include <vppinfra/mem.h> can include e.g.
  46    <vppinfra/mheap.h> which depends on <vppinfra/vec.h>. */
  47
  48 /** \brief vector header structure
  49
  50    Bookkeeping header preceding vector elements in memory.
  51    User header information may preceed standard vec header.
  52    If you change u32 len -> u64 len, single vectors can
  53    exceed 2**32 elements. Clib heaps are vectors. */
  54
  55 typedef struct
  56 {
  57   u32 len; /**< Number of elements in vector (NOT its allocated length). */
  58   u8 hdr_size;        /**< header size divided by VEC_MIN_ALIGN */
  59   u8 log2_align : 7;  /**< data alignment */
  60   u8 default_heap : 1; /**< vector uses default heap */
  61   u8 vpad[2];         /**< pad to 8 bytes */
  62   u8 vector_data[0];  /**< Vector data . */
  63 } vec_header_t;
  64
  65 #define VEC_MIN_ALIGN 8
  66
  67 /** \brief Find the vector header
  68
  69     Given the user's pointer to a vector, find the corresponding
  70     vector header
  71
  72     @param v pointer to a vector
  73     @return pointer to the vector's vector_header_t
  74 */
  75 #define _vec_find(v)    ((vec_header_t *) (v) - 1)
  76 #define _vec_heap(v)    (((void **) (_vec_find (v)))[-1])
  77
  78 always_inline uword __vec_align (uword data_align, uword configuered_align);
  79 always_inline uword __vec_elt_sz (uword elt_sz, int is_void);
  80
  81 #define _vec_round_size(s) \
  82   (((s) + sizeof (uword) - 1) &~ (sizeof (uword) - 1))
  83 #define _vec_is_void(P)                                                       \
  84   __builtin_types_compatible_p (__typeof__ ((P)[0]), void)
  85 #define _vec_elt_sz(V)   __vec_elt_sz (sizeof ((V)[0]), _vec_is_void (V))
  86 #define _vec_align(V, A) __vec_align (__alignof__((V)[0]), A)
  87
  88 always_inline CLIB_NOSANITIZE_ADDR uword
  89 vec_get_header_size (void *v)
  90 {
  91   uword header_size = _vec_find (v)->hdr_size * VEC_MIN_ALIGN;
  92   return header_size;
  93 }
  94
  95 /** \brief Find a user vector header
  96
  97     Finds the user header of a vector with unspecified alignment given
  98     the user pointer to the vector.
  99 */
 100
 101 always_inline void *
 102 vec_header (void *v)
 103 {
 104   return v ? v - vec_get_header_size (v) : 0;
 105 }
 106
 107 /** \brief Find the end of user vector header
 108
 109     Finds the end of the user header of a vector with unspecified
 110     alignment given the user pointer to the vector.
 111 */
 112
 113 always_inline void *
 114 vec_header_end (void *v)
 115 {
 116   return v + vec_get_header_size (v);
 117 }
 118
 119 /** \brief Number of elements in vector (rvalue-only, NULL tolerant)
 120
 121     vec_len (v) checks for NULL, but cannot be used as an lvalue.
 122     If in doubt, use vec_len...
 123 */
 124
 125 static_always_inline u32
 126 __vec_len (void *v)
 127 {
 128   return _vec_find (v)->len;
 129 }
 130
 131 #define _vec_len(v)     __vec_len ((void *) (v))
 132 #define vec_len(v)      ((v) ? _vec_len(v) : 0)
 133
 134 u32 vec_len_not_inline (void *v);
 135
 136 /** \brief Number of data bytes in vector. */
 137
 138 #define vec_bytes(v) (vec_len (v) * sizeof (v[0]))
 139
 140 /**
 141  * Return size of memory allocated for the vector
 142  *
 143  * @param v vector
 144  * @return memory size allocated for the vector
 145  */
 146
 147 uword vec_mem_size (void *v);
 148
 149 /**
 150  * Number of elements that can fit into generic vector
 151  *
 152  * @param v vector
 153  * @param b extra header bytes
 154  * @return number of elements that can fit into vector
 155  */
 156
 157 always_inline uword
 158 vec_max_bytes (void *v)
 159 {
 160   return v ? vec_mem_size (v) - vec_get_header_size (v) : 0;
 161 }
 162
 163 always_inline uword
 164 _vec_max_len (void *v, uword elt_sz)
 165 {
 166   return vec_max_bytes (v) / elt_sz;
 167 }
 168
 169 #define vec_max_len(v) _vec_max_len (v, _vec_elt_sz (v))
 170
 171 always_inline void
 172 _vec_set_len (void *v, uword len, uword elt_sz)
 173 {
 174   ASSERT (v);
 175   ASSERT (len <= _vec_max_len (v, elt_sz));
 176   uword old_len = _vec_len (v);
 177
 178   if (len > old_len)
 179     CLIB_MEM_UNPOISON (v + old_len * elt_sz, (len - old_len) * elt_sz);
 180   else if (len > old_len)
 181     CLIB_MEM_POISON (v + len * elt_sz, (old_len - len) * elt_sz);
 182
 183   _vec_find (v)->len = len;
 184 }
 185
 186 #define vec_set_len(v, l) _vec_set_len ((void *) v, l, _vec_elt_sz (v))
 187 #define vec_inc_len(v, l) vec_set_len (v, _vec_len (v) + (l))
 188 #define vec_dec_len(v, l) vec_set_len (v, _vec_len (v) - (l))
 189
 190 /** \brief Reset vector length to zero
 191     NULL-pointer tolerant
 192 */
 193 #define vec_reset_length(v) do { if (v) vec_set_len (v, 0); } while (0)
 194
 195 /** \brief End (last data address) of vector. */
 196 #define vec_end(v)      ((v) + vec_len (v))
 197
 198 /** \brief True if given pointer is within given vector. */
 199 #define vec_is_member(v,e) ((e) >= (v) && (e) < vec_end (v))
 200
 201 /** \brief Get vector value at index i checking that i is in bounds. */
 202 #define vec_elt_at_index(v,i)                   \
 203 ({                                              \
 204   ASSERT ((i) < vec_len (v));                   \
 205   (v) + (i);                                    \
 206 })
 207
 208 /** \brief Get vector value at index i */
 209 #define vec_elt(v,i) (vec_elt_at_index(v,i))[0]
 210
 211 /** \brief Vector iterator */
 212 #define vec_foreach(var,vec) for (var = (vec); var < vec_end (vec); var++)
 213
 214 /** \brief Vector iterator (reverse) */
 215 #define vec_foreach_backwards(var, vec)                                       \
 216   if (vec)                                                                    \
 217     for (var = vec_end (vec) - 1; var >= (vec); var--)
 218
 219 /** \brief Iterate over vector indices. */
 220 #define vec_foreach_index(var,v) for ((var) = 0; (var) < vec_len (v); (var)++)
 221
 222 /** \brief Iterate over vector indices (reverse). */
 223 #define vec_foreach_index_backwards(var, v)                                   \
 224   if (v)                                                                      \
 225     for ((var) = vec_len ((v)) - 1; (var) >= 0; (var)--)
 226
 227 #endif /* included_clib_vec_bootstrap_h */
 228
 229 /*
 230  * fd.io coding-style-patch-verification: ON
 231  *
 232  * Local Variables:
 233  * eval: (c-set-style "gnu")
 234  * End:
 235  */