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 * buffer.h: VLIB buffers
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #ifndef included_vlib_buffer_h
41 #define included_vlib_buffer_h
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 */
50 #include <vlib/config.h> /* for __PRE_DATA_SIZE */
51 #define VLIB_BUFFER_PRE_DATA_SIZE __PRE_DATA_SIZE
53 #define VLIB_BUFFER_DEFAULT_DATA_SIZE (2048)
55 /* Minimum buffer chain segment size. Does not apply to last buffer in chain.
56 Dataplane code can safely asume that specified amount of data is not split
57 into 2 chained buffers */
58 #define VLIB_BUFFER_MIN_CHAIN_SEG_SIZE (128)
60 /* Amount of head buffer data copied to each replica head buffer */
61 #define VLIB_BUFFER_CLONE_HEAD_SIZE (256)
64 vlib buffer structure definition and a few select
65 access methods. This structure and the buffer allocation
66 mechanism should perhaps live in vnet, but it would take a lot
67 of typing to make it so.
73 #define foreach_vlib_buffer_flag \
75 _( 1, NEXT_PRESENT, 0) \
76 _( 2, TOTAL_LENGTH_VALID, 0) \
77 _( 3, EXT_HDR_VALID, "ext-hdr-valid")
79 /* NOTE: only buffer generic flags should be defined here, please consider
80 using user flags. i.e. src/vnet/buffer.h */
84 #define _(bit, name, v) VLIB_BUFFER_##name = (1 << (bit)),
85 foreach_vlib_buffer_flag
91 #define _(bit, name, v) VLIB_BUFFER_LOG2_##name = (bit),
92 foreach_vlib_buffer_flag
96 /* User defined buffer flags. */
97 #define LOG2_VLIB_BUFFER_FLAG_USER(n) (32 - (n))
98 #define VLIB_BUFFER_FLAG_USER(n) (1 << LOG2_VLIB_BUFFER_FLAG_USER(n))
99 #define VLIB_BUFFER_FLAGS_ALL (0x0f)
101 /** VLIB buffer representation. */
106 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
108 /** signed offset in data[], pre_data[] that we are currently
109 * processing. If negative current header points into predata area. */
112 /** Nbytes between current data and the end of this buffer. */
116 <br> VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index,
117 <br> VLIB_BUFFER_IS_TRACED: trace this buffer.
118 <br> VLIB_BUFFER_NEXT_PRESENT: this is a multi-chunk buffer.
119 <br> VLIB_BUFFER_TOTAL_LENGTH_VALID: as it says
120 <br> VLIB_BUFFER_EXT_HDR_VALID: buffer contains valid external buffer manager header,
121 set to avoid adding it to a flow report
122 <br> VLIB_BUFFER_FLAG_USER(n): user-defined bit N
126 /** Generic flow identifier */
129 /** Reference count for this buffer. */
130 volatile u8 ref_count;
132 /** index of buffer pool this buffer belongs. */
133 u8 buffer_pool_index;
135 /** Error code for buffers to be enqueued to error handler. */
138 /** Next buffer for this linked-list of buffers. Only valid if
139 * VLIB_BUFFER_NEXT_PRESENT flag is set. */
142 /** The following fields can be in a union because once a packet enters
143 * the punt path, it is no longer on a feature arc */
146 /** Used by feature subgraph arcs to visit enabled feature nodes */
147 u32 current_config_index;
148 /* the reason the packet once punted */
152 /** Opaque data used by sub-graphs for their own purposes. */
155 /** part of buffer metadata which is initialized on alloc ends here. */
156 STRUCT_MARK (template_end);
158 /** start of 2nd cache line */
159 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
161 /** Specifies trace buffer handle if VLIB_PACKET_IS_TRACED flag is
165 /** Only valid for first buffer in chain. Current length plus total length
166 * given here give total number of bytes in buffer chain. */
167 u32 total_length_not_including_first_buffer;
169 /**< More opaque data, see ../vnet/vnet/buffer.h */
172 /** start of third cache line */
173 CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
175 /** Space for inserting data before buffer start. Packet rewrite string
176 * will be rewritten backwards and may extend back before
177 * buffer->data[0]. Must come directly before packet data. */
178 u8 pre_data[VLIB_BUFFER_PRE_DATA_SIZE];
183 #ifdef CLIB_HAVE_VEC128
186 #ifdef CLIB_HAVE_VEC256
189 #ifdef CLIB_HAVE_VEC512
194 #define VLIB_BUFFER_HDR_SIZE (sizeof(vlib_buffer_t) - VLIB_BUFFER_PRE_DATA_SIZE)
196 /** \brief Prefetch buffer metadata.
197 The first 64 bytes of buffer contains most header information
199 @param b - (vlib_buffer_t *) pointer to the buffer
200 @param type - LOAD, STORE. In most cases, STORE is the right answer
203 #define vlib_prefetch_buffer_header(b,type) CLIB_PREFETCH (b, 64, type)
204 #define vlib_prefetch_buffer_data(b,type) \
205 CLIB_PREFETCH (vlib_buffer_get_current(b), CLIB_CACHE_LINE_BYTES, type)
208 vlib_buffer_struct_is_sane (vlib_buffer_t * b)
210 ASSERT (sizeof (b[0]) % 64 == 0);
212 /* Rewrite data must be before and contiguous with packet data. */
213 ASSERT (b->pre_data + VLIB_BUFFER_PRE_DATA_SIZE == b->data);
217 vlib_buffer_get_va (vlib_buffer_t * b)
219 return pointer_to_uword (b->data);
222 /** \brief Get pointer to current data to process
224 @param b - (vlib_buffer_t *) pointer to the buffer
225 @return - (void *) (b->data + b->current_data)
229 vlib_buffer_get_current (vlib_buffer_t * b)
232 ASSERT ((signed) b->current_data >= (signed) -VLIB_BUFFER_PRE_DATA_SIZE);
233 return b->data + b->current_data;
237 vlib_buffer_get_current_va (vlib_buffer_t * b)
239 return vlib_buffer_get_va (b) + b->current_data;
242 /** \brief Advance current data pointer by the supplied (signed!) amount
244 @param b - (vlib_buffer_t *) pointer to the buffer
245 @param l - (word) signed increment
248 vlib_buffer_advance (vlib_buffer_t * b, word l)
250 ASSERT (b->current_length >= l);
251 b->current_data += l;
252 b->current_length -= l;
254 ASSERT ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0 ||
255 b->current_length >= VLIB_BUFFER_MIN_CHAIN_SEG_SIZE);
258 /** \brief Check if there is enough space in buffer to advance
260 @param b - (vlib_buffer_t *) pointer to the buffer
261 @param l - (word) size to check
262 @return - 0 if there is less space than 'l' in buffer
265 vlib_buffer_has_space (vlib_buffer_t * b, word l)
267 return b->current_length >= l;
270 /** \brief Reset current header & length to state they were in when
273 @param b - (vlib_buffer_t *) pointer to the buffer
277 vlib_buffer_reset (vlib_buffer_t * b)
279 b->current_length += clib_max (b->current_data, 0);
283 /** \brief Get pointer to buffer's opaque data array
285 @param b - (vlib_buffer_t *) pointer to the buffer
286 @return - (void *) b->opaque
289 vlib_get_buffer_opaque (vlib_buffer_t * b)
291 return (void *) b->opaque;
294 /** \brief Get pointer to buffer's opaque2 data array
296 @param b - (vlib_buffer_t *) pointer to the buffer
297 @return - (void *) b->opaque2
300 vlib_get_buffer_opaque2 (vlib_buffer_t * b)
302 return (void *) b->opaque2;
305 /** \brief Get pointer to the end of buffer's data
306 * @param b pointer to the buffer
307 * @return pointer to tail of packet's data
310 vlib_buffer_get_tail (vlib_buffer_t * b)
312 return b->data + b->current_data + b->current_length;
315 /** \brief Append uninitialized data to buffer
316 * @param b pointer to the buffer
317 * @param size number of uninitialized bytes
318 * @return pointer to beginning of uninitialized data
321 vlib_buffer_put_uninit (vlib_buffer_t * b, u16 size)
323 void *p = vlib_buffer_get_tail (b);
324 /* XXX make sure there's enough space */
325 b->current_length += size;
329 /** \brief Prepend uninitialized data to buffer
330 * @param b pointer to the buffer
331 * @param size number of uninitialized bytes
332 * @return pointer to beginning of uninitialized data
335 vlib_buffer_push_uninit (vlib_buffer_t * b, u8 size)
337 ASSERT (b->current_data + VLIB_BUFFER_PRE_DATA_SIZE >= size);
338 b->current_data -= size;
339 b->current_length += size;
341 return vlib_buffer_get_current (b);
344 /** \brief Make head room, typically for packet headers
345 * @param b pointer to the buffer
346 * @param size number of head room bytes
347 * @return pointer to start of buffer (current data)
350 vlib_buffer_make_headroom (vlib_buffer_t * b, u8 size)
352 ASSERT (b->current_data + VLIB_BUFFER_PRE_DATA_SIZE >= size);
353 b->current_data += size;
354 return vlib_buffer_get_current (b);
357 /** \brief Construct a trace handle from thread and pool index
358 * @param thread Thread id
359 * @param pool_index Pool index
360 * @return trace handle
363 vlib_buffer_make_trace_handle (u32 thread, u32 pool_index)
366 ASSERT (thread < 0xff);
367 ASSERT (pool_index < 0x00FFFFFF);
368 rv = (thread << 24) | (pool_index & 0x00FFFFFF);
372 /** \brief Extract the thread id from a trace handle
373 * @param trace_handle the trace handle
374 * @return the thread id
377 vlib_buffer_get_trace_thread (vlib_buffer_t * b)
379 u32 trace_handle = b->trace_handle;
381 return trace_handle >> 24;
384 /** \brief Extract the trace (pool) index from a trace handle
385 * @param trace_handle the trace handle
386 * @return the trace index
389 vlib_buffer_get_trace_index (vlib_buffer_t * b)
391 u32 trace_handle = b->trace_handle;
392 return trace_handle & 0x00FFFFFF;
395 /** \brief Retrieve bytes from buffer head
396 * @param b pointer to the buffer
397 * @param size number of bytes to pull
398 * @return pointer to start of buffer (current data)
401 vlib_buffer_pull (vlib_buffer_t * b, u8 size)
403 if (b->current_length + VLIB_BUFFER_PRE_DATA_SIZE < size)
406 void *data = vlib_buffer_get_current (b);
407 vlib_buffer_advance (b, size);
411 /* Forward declaration. */
416 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
419 } vlib_buffer_pool_thread_t;
422 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
425 uword log2_page_size;
428 u32 physmem_map_index;
433 clib_spinlock_t lock;
435 /* per-thread data */
436 vlib_buffer_pool_thread_t *threads;
438 /* buffer metadata template */
439 vlib_buffer_t buffer_template;
440 } vlib_buffer_pool_t;
442 #define VLIB_BUFFER_MAX_NUMA_NODES 32
446 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
447 /* Virtual memory address and size of buffer memory, used for calculating
449 uword buffer_mem_start;
450 uword buffer_mem_size;
451 vlib_buffer_pool_t *buffer_pools;
453 /* Hash table mapping buffer index into number
454 0 => allocated but free, 1 => allocated and not-free.
455 If buffer index is not in hash table then this buffer
456 has never been allocated. */
457 uword *buffer_known_hash;
458 clib_spinlock_t buffer_known_hash_lockp;
459 u8 default_buffer_pool_index_for_numa[VLIB_BUFFER_MAX_NUMA_NODES];
462 u32 buffers_per_numa;
464 u32 default_data_size;
467 vlib_log_class_t log_default;
468 } vlib_buffer_main_t;
470 clib_error_t *vlib_buffer_main_init (struct vlib_main_t *vm);
475 /** \brief Compile time buffer trajectory tracing option
476 Turn this on if you run into "bad monkey" contexts,
477 and you want to know exactly which nodes they've visited...
480 #define VLIB_BUFFER_TRACE_TRAJECTORY 0
482 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
483 extern void (*vlib_buffer_trace_trajectory_cb) (vlib_buffer_t * b, u32 index);
484 extern void (*vlib_buffer_trace_trajectory_init_cb) (vlib_buffer_t * b);
485 extern void vlib_buffer_trace_trajectory_init (vlib_buffer_t * b);
486 #define VLIB_BUFFER_TRACE_TRAJECTORY_INIT(b) \
487 vlib_buffer_trace_trajectory_init (b);
489 #define VLIB_BUFFER_TRACE_TRAJECTORY_INIT(b)
490 #endif /* VLIB_BUFFER_TRACE_TRAJECTORY */
492 extern u16 __vlib_buffer_external_hdr_size;
493 #define VLIB_BUFFER_SET_EXT_HDR_SIZE(x) \
494 static void __clib_constructor \
495 vnet_buffer_set_ext_hdr_size() \
497 if (__vlib_buffer_external_hdr_size) \
498 clib_error ("buffer external header space already set"); \
499 __vlib_buffer_external_hdr_size = CLIB_CACHE_LINE_ROUND (x); \
502 #endif /* included_vlib_buffer_h */
505 * fd.io coding-style-patch-verification: ON
508 * eval: (c-set-style "gnu")