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 <vlib/error.h> /* for vlib_error_t */
49 #include <vlib/config.h> /* for __PRE_DATA_SIZE */
50 #define VLIB_BUFFER_DATA_SIZE (2048)
51 #define VLIB_BUFFER_PRE_DATA_SIZE __PRE_DATA_SIZE
53 #if defined (CLIB_HAVE_VEC128) || defined (__aarch64__)
54 typedef u8x16 vlib_copy_unit_t;
56 typedef u64 vlib_copy_unit_t;
60 vlib buffer structure definition and a few select
61 access methods. This structure and the buffer allocation
62 mechanism should perhaps live in vnet, but it would take a lot
63 of typing to make it so.
66 /* VLIB buffer representation. */
69 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
70 /* Offset within data[] that we are currently processing.
71 If negative current header points into predata area. */
72 i16 current_data; /**< signed offset in data[], pre_data[]
73 that we are currently processing.
74 If negative current header points into predata area.
76 u16 current_length; /**< Nbytes between current data and
77 the end of this buffer.
79 u32 flags; /**< buffer flags:
80 <br> VLIB_BUFFER_IS_TRACED: trace this buffer.
81 <br> VLIB_BUFFER_NEXT_PRESENT: this is a multi-chunk buffer.
82 <br> VLIB_BUFFER_TOTAL_LENGTH_VALID: as it says
83 <br> VLIB_BUFFER_REPL_FAIL: packet replication failure
84 <br> VLIB_BUFFER_RECYCLE: as it says
85 <br> VLIB_BUFFER_FLOW_REPORT: buffer is a flow report,
86 set to avoid adding it to a flow report
87 <br> VLIB_BUFFER_FLAG_USER(n): user-defined bit N
89 #define VLIB_BUFFER_IS_TRACED (1 << 0)
90 #define VLIB_BUFFER_LOG2_NEXT_PRESENT (1)
91 #define VLIB_BUFFER_NEXT_PRESENT (1 << VLIB_BUFFER_LOG2_NEXT_PRESENT)
92 #define VLIB_BUFFER_IS_RECYCLED (1 << 2)
93 #define VLIB_BUFFER_TOTAL_LENGTH_VALID (1 << 3)
94 #define VLIB_BUFFER_REPL_FAIL (1 << 4)
95 #define VLIB_BUFFER_RECYCLE (1 << 5)
96 #define VLIB_BUFFER_FLOW_REPORT (1 << 6)
98 /* User defined buffer flags. */
99 #define LOG2_VLIB_BUFFER_FLAG_USER(n) (32 - (n))
100 #define VLIB_BUFFER_FLAG_USER(n) (1 << LOG2_VLIB_BUFFER_FLAG_USER(n))
102 u32 free_list_index; /**< Buffer free list that this buffer was
103 allocated from and will be freed to.
106 u32 total_length_not_including_first_buffer;
107 /**< Only valid for first buffer in chain. Current length plus
108 total length given here give total number of bytes in buffer chain.
111 u32 next_buffer; /**< Next buffer for this linked-list of buffers.
112 Only valid if VLIB_BUFFER_NEXT_PRESENT flag is set.
115 vlib_error_t error; /**< Error code for buffers to be enqueued
118 u32 current_config_index; /**< Used by feature subgraph arcs to
119 visit enabled feature nodes
122 u8 feature_arc_index; /**< Used to identify feature arcs by intermediate
126 u8 dont_waste_me[3]; /**< Available space in the (precious)
127 first 32 octets of buffer metadata
128 Before allocating any of it, discussion required!
131 u32 opaque[8]; /**< Opaque data used by sub-graphs for their own purposes.
132 See .../vnet/vnet/buffer.h
134 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
136 u32 trace_index; /**< Specifies index into trace buffer
137 if VLIB_PACKET_IS_TRACED flag is set.
139 u32 recycle_count; /**< Used by L2 path recycle code */
140 u32 opaque2[14]; /**< More opaque data, currently unused */
142 /***** end of second cache line */
143 CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
144 u8 pre_data[VLIB_BUFFER_PRE_DATA_SIZE]; /**< Space for inserting data
146 Packet rewrite string will be
147 rewritten backwards and may extend
148 back before buffer->data[0].
149 Must come directly before packet data.
152 u8 data[0]; /**< Packet data. Hardware DMA here */
153 } vlib_buffer_t; /* Must be a multiple of 64B. */
155 #define VLIB_BUFFER_HDR_SIZE (sizeof(vlib_buffer_t) - VLIB_BUFFER_PRE_DATA_SIZE)
157 /** \brief Prefetch buffer metadata.
158 The first 64 bytes of buffer contains most header information
160 @param b - (vlib_buffer_t *) pointer to the buffer
161 @param type - LOAD, STORE. In most cases, STORE is the right answer
164 #define vlib_prefetch_buffer_header(b,type) CLIB_PREFETCH (b, 64, type)
166 always_inline vlib_buffer_t *
167 vlib_buffer_next_contiguous (vlib_buffer_t * b, u32 buffer_bytes)
169 return (void *) (b + 1) + buffer_bytes;
173 vlib_buffer_struct_is_sane (vlib_buffer_t * b)
175 ASSERT (sizeof (b[0]) % 64 == 0);
177 /* Rewrite data must be before and contiguous with packet data. */
178 ASSERT (b->pre_data + VLIB_BUFFER_PRE_DATA_SIZE == b->data);
181 /** \brief Get pointer to current data to process
183 @param b - (vlib_buffer_t *) pointer to the buffer
184 @return - (void *) (b->data + b->current_data)
188 vlib_buffer_get_current (vlib_buffer_t * b)
191 ASSERT ((signed) b->current_data >= (signed) -VLIB_BUFFER_PRE_DATA_SIZE);
192 return b->data + b->current_data;
195 /** \brief Advance current data pointer by the supplied (signed!) amount
197 @param b - (vlib_buffer_t *) pointer to the buffer
198 @param l - (word) signed increment
201 vlib_buffer_advance (vlib_buffer_t * b, word l)
203 ASSERT (b->current_length >= l);
204 b->current_data += l;
205 b->current_length -= l;
208 /** \brief Reset current header & length to state they were in when
211 @param b - (vlib_buffer_t *) pointer to the buffer
215 vlib_buffer_reset (vlib_buffer_t * b)
217 b->current_length += clib_max (b->current_data, 0);
221 /** \brief Get pointer to buffer's opaque data array
223 @param b - (vlib_buffer_t *) pointer to the buffer
224 @return - (void *) b->opaque
227 vlib_get_buffer_opaque (vlib_buffer_t * b)
229 return (void *) b->opaque;
232 /** \brief Get pointer to buffer's opaque2 data array
234 @param b - (vlib_buffer_t *) pointer to the buffer
235 @return - (void *) b->opaque2
238 vlib_get_buffer_opaque2 (vlib_buffer_t * b)
240 return (void *) b->opaque2;
243 /* Forward declaration. */
246 typedef struct vlib_buffer_free_list_t
248 /* Template buffer used to initialize first 16 bytes of buffers
249 allocated on this free list. */
250 vlib_buffer_t buffer_init_template;
252 /* Our index into vlib_main_t's buffer_free_list_pool. */
255 /* Number of data bytes for buffers in this free list. */
258 /* Number of buffers to allocate when we need to allocate new buffers
259 from physmem heap. */
260 u32 min_n_buffers_each_physmem_alloc;
262 /* Total number of buffers allocated from this free list. */
265 /* Vector of free buffers. Each element is a byte offset into I/O heap.
266 Aligned vectors always has naturally aligned vlib_copy_unit_t sized chunks
267 of buffer indices. Unaligned vector has any left over. This is meant to
268 speed up copy routines. */
269 u32 *aligned_buffers, *unaligned_buffers;
271 /* Memory chunks allocated for this free list
272 recorded here so they can be freed when free list
274 void **buffer_memory_allocated;
276 /* Free list name. */
279 /* Callback functions to initialize newly allocated buffers.
280 If null buffers are zeroed. */
281 void (*buffer_init_function) (struct vlib_main_t * vm,
282 struct vlib_buffer_free_list_t * fl,
283 u32 * buffers, u32 n_buffers);
285 /* Callback function to announce that buffers have been
286 added to the freelist */
287 void (*buffers_added_to_freelist_function)
288 (struct vlib_main_t * vm, struct vlib_buffer_free_list_t * fl);
290 uword buffer_init_function_opaque;
291 } __attribute__ ((aligned (16))) vlib_buffer_free_list_t;
295 u32 (*vlib_buffer_alloc_cb) (struct vlib_main_t * vm, u32 * buffers,
297 u32 (*vlib_buffer_alloc_from_free_list_cb) (struct vlib_main_t * vm,
298 u32 * buffers, u32 n_buffers,
299 u32 free_list_index);
300 void (*vlib_buffer_free_cb) (struct vlib_main_t * vm, u32 * buffers,
302 void (*vlib_buffer_free_no_next_cb) (struct vlib_main_t * vm, u32 * buffers,
304 void (*vlib_packet_template_init_cb) (struct vlib_main_t * vm, void *t,
306 uword n_packet_data_bytes,
308 min_n_buffers_each_physmem_alloc,
310 void (*vlib_buffer_delete_free_list_cb) (struct vlib_main_t * vm,
311 u32 free_list_index);
312 } vlib_buffer_callbacks_t;
316 /* Buffer free callback, for subversive activities */
317 u32 (*buffer_free_callback) (struct vlib_main_t * vm,
319 u32 n_buffers, u32 follow_buffer_next);
320 /* Pool of buffer free lists.
321 Multiple free lists exist for packet generator which uses
322 separate free lists for each packet stream --- so as to avoid
323 initializing static data for each packet generated. */
324 vlib_buffer_free_list_t *buffer_free_list_pool;
325 #define VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX (0)
326 #define VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES VLIB_BUFFER_DATA_SIZE
328 /* Hash table mapping buffer size (rounded to next unit of
329 sizeof (vlib_buffer_t)) to free list index. */
330 uword *free_list_by_size;
332 /* Hash table mapping buffer index into number
333 0 => allocated but free, 1 => allocated and not-free.
334 If buffer index is not in hash table then this buffer
335 has never been allocated. */
336 uword *buffer_known_hash;
338 /* List of free-lists needing Blue Light Special announcements */
339 vlib_buffer_free_list_t **announce_list;
342 vlib_buffer_callbacks_t cb;
343 int extern_buffer_mgmt;
344 } vlib_buffer_main_t;
346 void vlib_buffer_cb_init (struct vlib_main_t *vm);
347 int vlib_buffer_cb_register (struct vlib_main_t *vm,
348 vlib_buffer_callbacks_t * cb);
352 struct vlib_main_t *vlib_main;
354 u32 first_buffer, last_buffer;
360 /* Total accumulated bytes in chain starting with first_buffer. */
361 u32 n_total_data_bytes;
363 /* Max number of bytes to accumulate in chain starting with first_buffer.
364 As this limit is reached buffers are enqueued to next node. */
365 u32 max_n_data_bytes_per_chain;
367 /* Next node to enqueue buffers to relative to current process node. */
370 /* Free list to use to allocate new buffers. */
376 /* CLIB fifo of buffer indices waiting to be unserialized. */
379 /* Event type used to signal that RX buffers have been added to fifo. */
380 uword ready_one_time_event;
383 } vlib_serialize_buffer_main_t;
385 void serialize_open_vlib_buffer (serialize_main_t * m, struct vlib_main_t *vm,
386 vlib_serialize_buffer_main_t * sm);
387 void unserialize_open_vlib_buffer (serialize_main_t * m,
388 struct vlib_main_t *vm,
389 vlib_serialize_buffer_main_t * sm);
391 u32 serialize_close_vlib_buffer (serialize_main_t * m);
392 void unserialize_close_vlib_buffer (serialize_main_t * m);
393 void *vlib_set_buffer_free_callback (struct vlib_main_t *vm, void *fp);
396 serialize_vlib_buffer_n_bytes (serialize_main_t * m)
398 serialize_stream_t *s = &m->stream;
399 vlib_serialize_buffer_main_t *sm
400 = uword_to_pointer (m->stream.data_function_opaque,
401 vlib_serialize_buffer_main_t *);
402 return sm->tx.n_total_data_bytes + s->current_buffer_index +
403 vec_len (s->overflow_buffer);
409 /** \brief Compile time buffer trajectory tracing option
410 Turn this on if you run into "bad monkey" contexts,
411 and you want to know exactly which nodes they've visited...
414 #define VLIB_BUFFER_TRACE_TRAJECTORY 0
416 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
417 #define VLIB_BUFFER_TRACE_TRAJECTORY_INIT(b) (b)->pre_data[0]=0
419 #define VLIB_BUFFER_TRACE_TRAJECTORY_INIT(b)
420 #endif /* VLIB_BUFFER_TRACE_TRAJECTORY */
422 #endif /* included_vlib_buffer_h */
425 * fd.io coding-style-patch-verification: ON
428 * eval: (c-set-style "gnu")