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_HEADER_ROUND */
  59   u8 log2_align;      /**< data alignment */
  60   u8 vpad[2];         /**< pad to 8 bytes */
  61   u8 vector_data[0];  /**< Vector data . */
  62 } vec_header_t;
  63
  64 #define VEC_HEADER_ROUND 8
  65
  66 /** \brief Find the vector header
  67
  68     Given the user's pointer to a vector, find the corresponding
  69     vector header
  70
  71     @param v pointer to a vector
  72     @return pointer to the vector's vector_header_t
  73 */
  74 #define _vec_find(v)    ((vec_header_t *) (v) - 1)
  75
  76 #define _vec_round_size(s) \
  77   (((s) + sizeof (uword) - 1) &~ (sizeof (uword) - 1))
  78
  79 always_inline uword
  80 vec_header_bytes (uword header_bytes)
  81 {
  82   return round_pow2 (header_bytes + sizeof (vec_header_t), VEC_HEADER_ROUND);
  83 }
  84
  85 always_inline uword
  86 vec_get_header_size (void *v)
  87 {
  88   uword header_size = _vec_find (v)->hdr_size * VEC_HEADER_ROUND;
  89   return header_size;
  90 }
  91
  92 /** \brief Find a user vector header
  93
  94     Finds the user header of a vector with unspecified alignment given
  95     the user pointer to the vector.
  96 */
  97
  98 always_inline void *
  99 vec_header (void *v)
 100 {
 101   return v ? v - vec_get_header_size (v) : 0;
 102 }
 103
 104 /** \brief Find the end of user vector header
 105
 106     Finds the end of the user header of a vector with unspecified
 107     alignment given the user pointer to the vector.
 108 */
 109
 110 always_inline void *
 111 vec_header_end (void *v)
 112 {
 113   return v + vec_get_header_size (v);
 114 }
 115
 116 /** \brief Number of elements in vector (lvalue-capable)
 117
 118    _vec_len (v) does not check for null, but can be used as an lvalue
 119    (e.g. _vec_len (v) = 99).
 120 */
 121
 122 #define _vec_len(v)     (_vec_find(v)->len)
 123
 124 /** \brief Number of elements in vector (rvalue-only, NULL tolerant)
 125
 126     vec_len (v) checks for NULL, but cannot be used as an lvalue.
 127     If in doubt, use vec_len...
 128 */
 129
 130 #define vec_len(v)      ((v) ? _vec_len(v) : 0)
 131 u32 vec_len_not_inline (void *v);
 132
 133 /** \brief Number of data bytes in vector. */
 134
 135 #define vec_bytes(v) (vec_len (v) * sizeof (v[0]))
 136
 137 /**
 138  * Return size of memory allocated for the vector
 139  *
 140  * @param v vector
 141  * @return memory size allocated for the vector
 142  */
 143
 144 always_inline uword
 145 vec_mem_size (void *v)
 146 {
 147   return v ? clib_mem_size (v - vec_get_header_size (v)) : 0;
 148 }
 149
 150 /**
 151  * Number of elements that can fit into generic vector
 152  *
 153  * @param v vector
 154  * @param b extra header bytes
 155  * @return number of elements that can fit into vector
 156  */
 157
 158 always_inline uword
 159 _vec_max_len (void *v, uword elt_size)
 160 {
 161   return v ? vec_mem_size (v) / elt_size : 0;
 162 }
 163
 164 #define vec_max_len(v) _vec_max_len (v, sizeof ((v)[0]))
 165
 166 always_inline void
 167 _vec_set_len (void *v, uword len, uword elt_size)
 168 {
 169   ASSERT (v);
 170   ASSERT (len <= vec_max_len (v));
 171
 172   CLIB_MEM_POISON_LEN (v, _vec_len (v) * elt_size, len * elt_size);
 173   _vec_len (v) = len;
 174 }
 175
 176 #define vec_set_len(v, l) _vec_set_len ((void *) v, l, sizeof ((v)[0]))
 177
 178 /** \brief Reset vector length to zero
 179     NULL-pointer tolerant
 180 */
 181 #define vec_reset_length(v) do { if (v) vec_set_len (v, 0); } while (0)
 182
 183 /** \brief End (last data address) of vector. */
 184 #define vec_end(v)      ((v) + vec_len (v))
 185
 186 /** \brief True if given pointer is within given vector. */
 187 #define vec_is_member(v,e) ((e) >= (v) && (e) < vec_end (v))
 188
 189 /** \brief Get vector value at index i checking that i is in bounds. */
 190 #define vec_elt_at_index(v,i)                   \
 191 ({                                              \
 192   ASSERT ((i) < vec_len (v));                   \
 193   (v) + (i);                                    \
 194 })
 195
 196 /** \brief Get vector value at index i */
 197 #define vec_elt(v,i) (vec_elt_at_index(v,i))[0]
 198
 199 /** \brief Vector iterator */
 200 #define vec_foreach(var,vec) for (var = (vec); var < vec_end (vec); var++)
 201
 202 /** \brief Vector iterator (reverse) */
 203 #define vec_foreach_backwards(var, vec)                                       \
 204   if (vec)                                                                    \
 205     for (var = vec_end (vec) - 1; var >= (vec); var--)
 206
 207 /** \brief Iterate over vector indices. */
 208 #define vec_foreach_index(var,v) for ((var) = 0; (var) < vec_len (v); (var)++)
 209
 210 /** \brief Iterate over vector indices (reverse). */
 211 #define vec_foreach_index_backwards(var, v)                                   \
 212   if (v)                                                                      \
 213     for ((var) = vec_len ((v)) - 1; (var) >= 0; (var)--)
 214
 215 #endif /* included_clib_vec_bootstrap_h */
 216
 217 /*
 218  * fd.io coding-style-patch-verification: ON
 219  *
 220  * Local Variables:
 221  * eval: (c-set-style "gnu")
 222  * End:
 223  */