src/vlib/buffer.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  * buffer.h: VLIB buffers
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining
  21  * a copy of this software and associated documentation files (the
  22  * "Software"), to deal in the Software without restriction, including
  23  * without limitation the rights to use, copy, modify, merge, publish,
  24  * distribute, sublicense, and/or sell copies of the Software, and to
  25  * permit persons to whom the Software is furnished to do so, subject to
  26  * the following conditions:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39
  40 #ifndef included_vlib_buffer_h
  41 #define included_vlib_buffer_h
  42
  43 #include <vppinfra/types.h>
  44 #include <vppinfra/cache.h>
  45 #include <vppinfra/serialize.h>
  46 #include <vppinfra/vector.h>
  47 #include <vppinfra/lock.h>
  48 #include <vlib/error.h>         /* for vlib_error_t */
  49
  50 #include <vlib/config.h>        /* for __PRE_DATA_SIZE */
  51 #define VLIB_BUFFER_DATA_SIZE           (2048)
  52 #define VLIB_BUFFER_PRE_DATA_SIZE       __PRE_DATA_SIZE
  53
  54 typedef u8 vlib_buffer_free_list_index_t;
  55
  56 /** \file
  57     vlib buffer structure definition and a few select
  58     access methods. This structure and the buffer allocation
  59     mechanism should perhaps live in vnet, but it would take a lot
  60     of typing to make it so.
  61 */
  62
  63 /**
  64  * Buffer Flags
  65  */
  66 #define foreach_vlib_buffer_flag \
  67   _( 0, NON_DEFAULT_FREELIST, "non-default-fl")         \
  68   _( 1, IS_TRACED, 0)                                   \
  69   _( 2, NEXT_PRESENT, 0)                                \
  70   _( 3, TOTAL_LENGTH_VALID, 0)                          \
  71   _( 4, EXT_HDR_VALID, "ext-hdr-valid")
  72
  73 /* NOTE: only buffer generic flags should be defined here, please consider
  74    using user flags. i.e. src/vnet/buffer.h */
  75
  76 enum
  77 {
  78 #define _(bit, name, v) VLIB_BUFFER_##name  = (1 << (bit)),
  79   foreach_vlib_buffer_flag
  80 #undef _
  81 };
  82
  83 enum
  84 {
  85 #define _(bit, name, v) VLIB_BUFFER_LOG2_##name  = (bit),
  86   foreach_vlib_buffer_flag
  87 #undef _
  88 };
  89
  90   /* User defined buffer flags. */
  91 #define LOG2_VLIB_BUFFER_FLAG_USER(n) (32 - (n))
  92 #define VLIB_BUFFER_FLAG_USER(n) (1 << LOG2_VLIB_BUFFER_FLAG_USER(n))
  93
  94 /* VLIB buffer representation. */
  95 typedef struct
  96 {
  97   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  98   STRUCT_MARK (template_start);
  99   /* Offset within data[] that we are currently processing.
 100      If negative current header points into predata area. */
 101   i16 current_data;  /**< signed offset in data[], pre_data[]
 102                         that we are currently processing.
 103                         If negative current header points into predata area.
 104                      */
 105   u16 current_length;  /**< Nbytes between current data and
 106                           the end of this buffer.
 107                        */
 108   u32 flags; /**< buffer flags:
 109                 <br> VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index,
 110                 <br> VLIB_BUFFER_IS_TRACED: trace this buffer.
 111                 <br> VLIB_BUFFER_NEXT_PRESENT: this is a multi-chunk buffer.
 112                 <br> VLIB_BUFFER_TOTAL_LENGTH_VALID: as it says
 113                 <br> VLIB_BUFFER_EXT_HDR_VALID: buffer contains valid external buffer manager header,
 114                 set to avoid adding it to a flow report
 115                 <br> VLIB_BUFFER_FLAG_USER(n): user-defined bit N
 116              */
 117
 118   u32 flow_id;  /**< Generic flow identifier */
 119
 120
 121   u32 next_buffer;   /**< Next buffer for this linked-list of buffers.
 122                         Only valid if VLIB_BUFFER_NEXT_PRESENT flag is set.
 123                      */
 124
 125     STRUCT_MARK (template_end);
 126
 127   u32 current_config_index; /**< Used by feature subgraph arcs to
 128                                visit enabled feature nodes
 129                             */
 130   vlib_error_t error;   /**< Error code for buffers to be enqueued
 131                            to error handler.
 132                         */
 133   u8 n_add_refs; /**< Number of additional references to this buffer. */
 134
 135   u8 buffer_pool_index; /**< index of buffer pool this buffer belongs. */
 136
 137   u32 opaque[10]; /**< Opaque data used by sub-graphs for their own purposes.
 138                     See .../vnet/vnet/buffer.h
 139                  */
 140     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 141
 142   u32 trace_index; /**< Specifies index into trace buffer
 143                       if VLIB_PACKET_IS_TRACED flag is set.
 144                    */
 145   u32 recycle_count; /**< Used by L2 path recycle code */
 146
 147   u32 total_length_not_including_first_buffer;
 148   /**< Only valid for first buffer in chain. Current length plus
 149      total length given here give total number of bytes in buffer chain.
 150   */
 151   vlib_buffer_free_list_index_t free_list_index; /** < only used if
 152                                                    VLIB_BUFFER_NON_DEFAULT_FREELIST
 153                                                    flag is set */
 154   u8 align_pad[3]; /**< available */
 155   u32 opaque2[12];  /**< More opaque data, see ../vnet/vnet/buffer.h */
 156
 157   /***** end of second cache line */
 158     CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
 159   u8 pre_data[VLIB_BUFFER_PRE_DATA_SIZE];  /**< Space for inserting data
 160                                                before buffer start.
 161                                                Packet rewrite string will be
 162                                                rewritten backwards and may extend
 163                                                back before buffer->data[0].
 164                                                Must come directly before packet data.
 165                                             */
 166
 167   u8 data[0]; /**< Packet data. Hardware DMA here */
 168 } vlib_buffer_t;                /* Must be a multiple of 64B. */
 169
 170 #define VLIB_BUFFER_HDR_SIZE  (sizeof(vlib_buffer_t) - VLIB_BUFFER_PRE_DATA_SIZE)
 171
 172 /** \brief Prefetch buffer metadata.
 173     The first 64 bytes of buffer contains most header information
 174
 175     @param b - (vlib_buffer_t *) pointer to the buffer
 176     @param type - LOAD, STORE. In most cases, STORE is the right answer
 177 */
 178
 179 #define vlib_prefetch_buffer_header(b,type) CLIB_PREFETCH (b, 64, type)
 180
 181 always_inline void
 182 vlib_buffer_struct_is_sane (vlib_buffer_t * b)
 183 {
 184   ASSERT (sizeof (b[0]) % 64 == 0);
 185
 186   /* Rewrite data must be before and contiguous with packet data. */
 187   ASSERT (b->pre_data + VLIB_BUFFER_PRE_DATA_SIZE == b->data);
 188 }
 189
 190 always_inline uword
 191 vlib_buffer_get_va (vlib_buffer_t * b)
 192 {
 193   return pointer_to_uword (b->data);
 194 }
 195
 196 /** \brief Get pointer to current data to process
 197
 198     @param b - (vlib_buffer_t *) pointer to the buffer
 199     @return - (void *) (b->data + b->current_data)
 200 */
 201
 202 always_inline void *
 203 vlib_buffer_get_current (vlib_buffer_t * b)
 204 {
 205   /* Check bounds. */
 206   ASSERT ((signed) b->current_data >= (signed) -VLIB_BUFFER_PRE_DATA_SIZE);
 207   return b->data + b->current_data;
 208 }
 209
 210 always_inline uword
 211 vlib_buffer_get_current_va (vlib_buffer_t * b)
 212 {
 213   return vlib_buffer_get_va (b) + b->current_data;
 214 }
 215
 216 /** \brief Advance current data pointer by the supplied (signed!) amount
 217
 218     @param b - (vlib_buffer_t *) pointer to the buffer
 219     @param l - (word) signed increment
 220 */
 221 always_inline void
 222 vlib_buffer_advance (vlib_buffer_t * b, word l)
 223 {
 224   ASSERT (b->current_length >= l);
 225   b->current_data += l;
 226   b->current_length -= l;
 227 }
 228
 229 /** \brief Check if there is enough space in buffer to advance
 230
 231     @param b - (vlib_buffer_t *) pointer to the buffer
 232     @param l - (word) size to check
 233     @return - 0 if there is less space than 'l' in buffer
 234 */
 235 always_inline u8
 236 vlib_buffer_has_space (vlib_buffer_t * b, word l)
 237 {
 238   return b->current_length >= l;
 239 }
 240
 241 /** \brief Reset current header & length to state they were in when
 242     packet was received.
 243
 244     @param b - (vlib_buffer_t *) pointer to the buffer
 245 */
 246
 247 always_inline void
 248 vlib_buffer_reset (vlib_buffer_t * b)
 249 {
 250   b->current_length += clib_max (b->current_data, 0);
 251   b->current_data = 0;
 252 }
 253
 254 /** \brief Get pointer to buffer's opaque data array
 255
 256     @param b - (vlib_buffer_t *) pointer to the buffer
 257     @return - (void *) b->opaque
 258 */
 259 always_inline void *
 260 vlib_get_buffer_opaque (vlib_buffer_t * b)
 261 {
 262   return (void *) b->opaque;
 263 }
 264
 265 /** \brief Get pointer to buffer's opaque2 data array
 266
 267     @param b - (vlib_buffer_t *) pointer to the buffer
 268     @return - (void *) b->opaque2
 269 */
 270 always_inline void *
 271 vlib_get_buffer_opaque2 (vlib_buffer_t * b)
 272 {
 273   return (void *) b->opaque2;
 274 }
 275
 276 /** \brief Get pointer to the end of buffer's data
 277  * @param b     pointer to the buffer
 278  * @return      pointer to tail of packet's data
 279  */
 280 always_inline u8 *
 281 vlib_buffer_get_tail (vlib_buffer_t * b)
 282 {
 283   return b->data + b->current_data + b->current_length;
 284 }
 285
 286 /** \brief Append uninitialized data to buffer
 287  * @param b     pointer to the buffer
 288  * @param size  number of uninitialized bytes
 289  * @return      pointer to beginning of uninitialized data
 290  */
 291 always_inline void *
 292 vlib_buffer_put_uninit (vlib_buffer_t * b, u8 size)
 293 {
 294   void *p = vlib_buffer_get_tail (b);
 295   /* XXX make sure there's enough space */
 296   b->current_length += size;
 297   return p;
 298 }
 299
 300 /** \brief Prepend uninitialized data to buffer
 301  * @param b     pointer to the buffer
 302  * @param size  number of uninitialized bytes
 303  * @return      pointer to beginning of uninitialized data
 304  */
 305 always_inline void *
 306 vlib_buffer_push_uninit (vlib_buffer_t * b, u8 size)
 307 {
 308   ASSERT (b->current_data + VLIB_BUFFER_PRE_DATA_SIZE >= size);
 309   b->current_data -= size;
 310   b->current_length += size;
 311
 312   return vlib_buffer_get_current (b);
 313 }
 314
 315 /** \brief Make head room, typically for packet headers
 316  * @param b     pointer to the buffer
 317  * @param size  number of head room bytes
 318  * @return      pointer to start of buffer (current data)
 319  */
 320 always_inline void *
 321 vlib_buffer_make_headroom (vlib_buffer_t * b, u8 size)
 322 {
 323   ASSERT (b->current_data + VLIB_BUFFER_PRE_DATA_SIZE >= size);
 324   b->current_data += size;
 325   return vlib_buffer_get_current (b);
 326 }
 327
 328 /** \brief Retrieve bytes from buffer head
 329  * @param b     pointer to the buffer
 330  * @param size  number of bytes to pull
 331  * @return      pointer to start of buffer (current data)
 332  */
 333 always_inline void *
 334 vlib_buffer_pull (vlib_buffer_t * b, u8 size)
 335 {
 336   if (b->current_length + VLIB_BUFFER_PRE_DATA_SIZE < size)
 337     return 0;
 338
 339   void *data = vlib_buffer_get_current (b);
 340   vlib_buffer_advance (b, size);
 341   return data;
 342 }
 343
 344 /* Forward declaration. */
 345 struct vlib_main_t;
 346
 347 typedef struct vlib_buffer_free_list_t
 348 {
 349   /* Template buffer used to initialize first 16 bytes of buffers
 350      allocated on this free list. */
 351   vlib_buffer_t buffer_init_template;
 352
 353   /* Our index into vlib_main_t's buffer_free_list_pool. */
 354   vlib_buffer_free_list_index_t index;
 355
 356   /* Number of data bytes for buffers in this free list. */
 357   u32 n_data_bytes;
 358
 359   /* Number of buffers to allocate when we need to allocate new buffers */
 360   u32 min_n_buffers_each_alloc;
 361
 362   /* Total number of buffers allocated from this free list. */
 363   u32 n_alloc;
 364
 365   /* Vector of free buffers.  Each element is a byte offset into I/O heap. */
 366   u32 *buffers;
 367
 368   /* index of buffer pool used to get / put buffers */
 369   u8 buffer_pool_index;
 370
 371   /* Free list name. */
 372   u8 *name;
 373
 374   /* Callback functions to initialize newly allocated buffers.
 375      If null buffers are zeroed. */
 376   void (*buffer_init_function) (struct vlib_main_t * vm,
 377                                 struct vlib_buffer_free_list_t * fl,
 378                                 u32 * buffers, u32 n_buffers);
 379
 380   uword buffer_init_function_opaque;
 381 } __attribute__ ((aligned (16))) vlib_buffer_free_list_t;
 382
 383 typedef uword (vlib_buffer_fill_free_list_cb_t) (struct vlib_main_t * vm,
 384                                                  vlib_buffer_free_list_t * fl,
 385                                                  uword min_free_buffers);
 386 typedef void (vlib_buffer_free_cb_t) (struct vlib_main_t * vm, u32 * buffers,
 387                                       u32 n_buffers);
 388 typedef void (vlib_buffer_free_no_next_cb_t) (struct vlib_main_t * vm,
 389                                               u32 * buffers, u32 n_buffers);
 390
 391 typedef struct
 392 {
 393   vlib_buffer_fill_free_list_cb_t *vlib_buffer_fill_free_list_cb;
 394   vlib_buffer_free_cb_t *vlib_buffer_free_cb;
 395   vlib_buffer_free_no_next_cb_t *vlib_buffer_free_no_next_cb;
 396   void (*vlib_packet_template_init_cb) (struct vlib_main_t * vm, void *t,
 397                                         void *packet_data,
 398                                         uword n_packet_data_bytes,
 399                                         uword
 400                                         min_n_buffers_each_physmem_alloc,
 401                                         u8 * name);
 402   void (*vlib_buffer_delete_free_list_cb) (struct vlib_main_t * vm,
 403                                            vlib_buffer_free_list_index_t
 404                                            free_list_index);
 405 } vlib_buffer_callbacks_t;
 406
 407 extern vlib_buffer_callbacks_t *vlib_buffer_callbacks;
 408
 409 typedef struct
 410 {
 411   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 412   uword start;
 413   uword size;
 414   uword log2_page_size;
 415   u32 physmem_map_index;
 416   u32 buffer_size;
 417   u32 *buffers;
 418   clib_spinlock_t lock;
 419 } vlib_buffer_pool_t;
 420
 421 typedef struct
 422 {
 423   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 424   /* Virtual memory address and size of buffer memory, used for calculating
 425      buffer index */
 426   uword buffer_mem_start;
 427   uword buffer_mem_size;
 428   vlib_buffer_pool_t *buffer_pools;
 429
 430   /* Buffer free callback, for subversive activities */
 431     u32 (*buffer_free_callback) (struct vlib_main_t * vm,
 432                                  u32 * buffers,
 433                                  u32 n_buffers, u32 follow_buffer_next);
 434 #define VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX (0)
 435 #define VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES VLIB_BUFFER_DATA_SIZE
 436
 437   /* Hash table mapping buffer size (rounded to next unit of
 438      sizeof (vlib_buffer_t)) to free list index. */
 439   uword *free_list_by_size;
 440
 441   /* Hash table mapping buffer index into number
 442      0 => allocated but free, 1 => allocated and not-free.
 443      If buffer index is not in hash table then this buffer
 444      has never been allocated. */
 445   uword *buffer_known_hash;
 446   clib_spinlock_t buffer_known_hash_lockp;
 447
 448   /* Callbacks */
 449   vlib_buffer_callbacks_t cb;
 450   int callbacks_registered;
 451 } vlib_buffer_main_t;
 452
 453 extern vlib_buffer_main_t buffer_main;
 454
 455 static_always_inline vlib_buffer_pool_t *
 456 vlib_buffer_pool_get (u8 buffer_pool_index)
 457 {
 458   vlib_buffer_main_t *bm = &buffer_main;
 459   return vec_elt_at_index (bm->buffer_pools, buffer_pool_index);
 460 }
 461
 462 u8 vlib_buffer_register_physmem_map (struct vlib_main_t * vm,
 463                                      u32 physmem_map_index);
 464
 465 clib_error_t *vlib_buffer_main_init (struct vlib_main_t *vm);
 466
 467 typedef struct
 468 {
 469   struct vlib_main_t *vlib_main;
 470
 471   u32 first_buffer, last_buffer;
 472
 473   union
 474   {
 475     struct
 476     {
 477       /* Total accumulated bytes in chain starting with first_buffer. */
 478       u32 n_total_data_bytes;
 479
 480       /* Max number of bytes to accumulate in chain starting with first_buffer.
 481          As this limit is reached buffers are enqueued to next node. */
 482       u32 max_n_data_bytes_per_chain;
 483
 484       /* Next node to enqueue buffers to relative to current process node. */
 485       u32 next_index;
 486
 487       /* Free list to use to allocate new buffers. */
 488       vlib_buffer_free_list_index_t free_list_index;
 489     } tx;
 490
 491     struct
 492     {
 493       /* CLIB fifo of buffer indices waiting to be unserialized. */
 494       u32 *buffer_fifo;
 495
 496       /* Event type used to signal that RX buffers have been added to fifo. */
 497       uword ready_one_time_event;
 498     } rx;
 499   };
 500 } vlib_serialize_buffer_main_t;
 501
 502 void serialize_open_vlib_buffer (serialize_main_t * m, struct vlib_main_t *vm,
 503                                  vlib_serialize_buffer_main_t * sm);
 504 void unserialize_open_vlib_buffer (serialize_main_t * m,
 505                                    struct vlib_main_t *vm,
 506                                    vlib_serialize_buffer_main_t * sm);
 507
 508 u32 serialize_close_vlib_buffer (serialize_main_t * m);
 509 void unserialize_close_vlib_buffer (serialize_main_t * m);
 510 void *vlib_set_buffer_free_callback (struct vlib_main_t *vm, void *fp);
 511
 512 always_inline u32
 513 serialize_vlib_buffer_n_bytes (serialize_main_t * m)
 514 {
 515   serialize_stream_t *s = &m->stream;
 516   vlib_serialize_buffer_main_t *sm
 517     = uword_to_pointer (m->stream.data_function_opaque,
 518                         vlib_serialize_buffer_main_t *);
 519   return sm->tx.n_total_data_bytes + s->current_buffer_index +
 520     vec_len (s->overflow_buffer);
 521 }
 522
 523 /*
 524  */
 525
 526 /** \brief Compile time buffer trajectory tracing option
 527     Turn this on if you run into "bad monkey" contexts,
 528     and you want to know exactly which nodes they've visited...
 529     See vlib/main.c...
 530 */
 531 #define VLIB_BUFFER_TRACE_TRAJECTORY 0
 532
 533 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
 534 extern void (*vlib_buffer_trace_trajectory_cb) (vlib_buffer_t * b, u32 index);
 535 extern void (*vlib_buffer_trace_trajectory_init_cb) (vlib_buffer_t * b);
 536 extern void vlib_buffer_trace_trajectory_init (vlib_buffer_t * b);
 537 #define VLIB_BUFFER_TRACE_TRAJECTORY_INIT(b) \
 538   vlib_buffer_trace_trajectory_init (b);
 539 #else
 540 #define VLIB_BUFFER_TRACE_TRAJECTORY_INIT(b)
 541 #endif /* VLIB_BUFFER_TRACE_TRAJECTORY */
 542
 543 #endif /* included_vlib_buffer_h */
 544
 545 #define VLIB_BUFFER_REGISTER_CALLBACKS(x,...)                           \
 546     __VA_ARGS__ vlib_buffer_callbacks_t __##x##_buffer_callbacks;       \
 547 static void __vlib_add_buffer_callbacks_t_##x (void)                    \
 548     __attribute__((__constructor__)) ;                                  \
 549 static void __vlib_add_buffer_callbacks_t_##x (void)                    \
 550 {                                                                       \
 551     if (vlib_buffer_callbacks)                                          \
 552       clib_panic ("vlib buffer callbacks already registered");          \
 553     vlib_buffer_callbacks = &__##x##_buffer_callbacks;                  \
 554 }                                                                       \
 555 static void __vlib_rm_buffer_callbacks_t_##x (void)                     \
 556     __attribute__((__destructor__)) ;                                   \
 557 static void __vlib_rm_buffer_callbacks_t_##x (void)                     \
 558 { vlib_buffer_callbacks = 0; }                                          \
 559 __VA_ARGS__ vlib_buffer_callbacks_t __##x##_buffer_callbacks
 560
 561 /*
 562  * fd.io coding-style-patch-verification: ON
 563  *
 564  * Local Variables:
 565  * eval: (c-set-style "gnu")
 566  * End:
 567  */