blob: 701ddde2227887bdd3f700c9a244f75065500eca [file] [log] [blame]
Ed Warnickecb9cada2015-12-08 15:45:58 -07001/*
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.c: allocate/free network 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
Chris Luked4024f52016-09-06 09:32:36 -040040/**
Chris Luked4024f52016-09-06 09:32:36 -040041 * @file
42 *
43 * Allocate/free network buffers.
44 */
45
Damjan Marion910d3692019-01-21 11:48:34 +010046#include <vppinfra/linux/sysfs.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070047#include <vlib/vlib.h>
Damjan Marion374e2c52017-03-09 20:38:15 +010048#include <vlib/unix/unix.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070049
Damjan Marion910d3692019-01-21 11:48:34 +010050#define VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA 16384
51#define VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA_UNPRIV 8192
Damjan Marion901d16c2018-10-23 19:50:20 +020052
Damjan Marion910d3692019-01-21 11:48:34 +010053#ifdef CLIB_HAVE_VEC128
54/* Assumptions by vlib_buffer_free_inline: */
55STATIC_ASSERT_FITS_IN (vlib_buffer_t, flags, 16);
56STATIC_ASSERT_FITS_IN (vlib_buffer_t, ref_count, 16);
57STATIC_ASSERT_FITS_IN (vlib_buffer_t, buffer_pool_index, 16);
58#endif
Damjan Marion04a7f052017-07-10 15:06:17 +020059
Damjan Marion910d3692019-01-21 11:48:34 +010060/* Make sure that buffer template size is not accidentally changed */
61STATIC_ASSERT_OFFSET_OF (vlib_buffer_t, template_end, 64);
62
63u16 __vlib_buffer_external_hdr_size = 0;
Damjan Marion567e61d2018-10-24 17:08:26 +020064
Dave Barach9b8ffd92016-07-08 08:13:45 -040065uword
66vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
67 vlib_buffer_t * b_first)
Ed Warnickecb9cada2015-12-08 15:45:58 -070068{
Dave Barach9b8ffd92016-07-08 08:13:45 -040069 vlib_buffer_t *b = b_first;
Ed Warnickecb9cada2015-12-08 15:45:58 -070070 uword l_first = b_first->current_length;
71 uword l = 0;
72 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
73 {
74 b = vlib_get_buffer (vm, b->next_buffer);
75 l += b->current_length;
76 }
77 b_first->total_length_not_including_first_buffer = l;
78 b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
79 return l + l_first;
80}
81
Dave Barach9b8ffd92016-07-08 08:13:45 -040082u8 *
83format_vlib_buffer (u8 * s, va_list * args)
Ed Warnickecb9cada2015-12-08 15:45:58 -070084{
Dave Barach9b8ffd92016-07-08 08:13:45 -040085 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
Christophe Fontained3c008d2017-10-02 18:10:54 +020086 u32 indent = format_get_indent (s);
Damjan Mariondac03522018-02-01 15:30:13 +010087 u8 *a = 0;
Damjan Marion1cd8f3c2016-11-24 02:07:32 +010088
Damjan Mariondac03522018-02-01 15:30:13 +010089#define _(bit, name, v) \
90 if (v && (b->flags & VLIB_BUFFER_##name)) \
91 a = format (a, "%s ", v);
92 foreach_vlib_buffer_flag
93#undef _
Damjan Marion36eb7c22019-01-18 20:45:30 +010094 s = format (s, "current data %d, length %d, buffer-pool %d, "
Damjan Marion910d3692019-01-21 11:48:34 +010095 "ref-count %u", b->current_data, b->current_length,
96 b->buffer_pool_index, b->ref_count);
Damjan Marion1cd8f3c2016-11-24 02:07:32 +010097
98 if (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID)
99 s = format (s, ", totlen-nifb %d",
100 b->total_length_not_including_first_buffer);
101
102 if (b->flags & VLIB_BUFFER_IS_TRACED)
103 s = format (s, ", trace 0x%x", b->trace_index);
104
Damjan Mariondac03522018-02-01 15:30:13 +0100105 if (a)
106 s = format (s, "\n%U%v", format_white_space, indent, a);
107 vec_free (a);
108
Damjan Marion1cd8f3c2016-11-24 02:07:32 +0100109 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
110 {
111 vlib_main_t *vm = vlib_get_main ();
112 u32 next_buffer = b->next_buffer;
113 b = vlib_get_buffer (vm, next_buffer);
114
Damjan Marionc47ed032017-01-25 14:18:03 +0100115 s =
Damjan Marion910d3692019-01-21 11:48:34 +0100116 format (s, "\n%Unext-buffer 0x%x, segment length %d, ref-count %u",
Damjan Marionc47ed032017-01-25 14:18:03 +0100117 format_white_space, indent, next_buffer, b->current_length,
Damjan Marion910d3692019-01-21 11:48:34 +0100118 b->ref_count);
Damjan Marion1cd8f3c2016-11-24 02:07:32 +0100119 }
120
Ed Warnickecb9cada2015-12-08 15:45:58 -0700121 return s;
122}
123
Dave Barach9b8ffd92016-07-08 08:13:45 -0400124u8 *
125format_vlib_buffer_and_data (u8 * s, va_list * args)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700126{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400127 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
128
Ed Warnickecb9cada2015-12-08 15:45:58 -0700129 s = format (s, "%U, %U",
130 format_vlib_buffer, b,
131 format_hex_bytes, vlib_buffer_get_current (b), 64);
132
133 return s;
134}
135
Dave Barach9b8ffd92016-07-08 08:13:45 -0400136static u8 *
137format_vlib_buffer_known_state (u8 * s, va_list * args)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700138{
139 vlib_buffer_known_state_t state = va_arg (*args, vlib_buffer_known_state_t);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400140 char *t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700141
142 switch (state)
143 {
144 case VLIB_BUFFER_UNKNOWN:
145 t = "unknown";
146 break;
147
148 case VLIB_BUFFER_KNOWN_ALLOCATED:
149 t = "known-allocated";
150 break;
151
152 case VLIB_BUFFER_KNOWN_FREE:
153 t = "known-free";
154 break;
155
156 default:
157 t = "invalid";
158 break;
159 }
160
161 return format (s, "%s", t);
162}
163
Dave Barach9b8ffd92016-07-08 08:13:45 -0400164u8 *
165format_vlib_buffer_contents (u8 * s, va_list * va)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700166{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400167 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
168 vlib_buffer_t *b = va_arg (*va, vlib_buffer_t *);
169
Ed Warnickecb9cada2015-12-08 15:45:58 -0700170 while (1)
171 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400172 vec_add (s, vlib_buffer_get_current (b), b->current_length);
173 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700174 break;
175 b = vlib_get_buffer (vm, b->next_buffer);
176 }
177
178 return s;
179}
180
181static u8 *
182vlib_validate_buffer_helper (vlib_main_t * vm,
183 u32 bi,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400184 uword follow_buffer_next, uword ** unique_hash)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700185{
Damjan Marion910d3692019-01-21 11:48:34 +0100186 vlib_buffer_main_t *bm = vm->buffer_main;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400187 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700188
Damjan Marion910d3692019-01-21 11:48:34 +0100189 if (vec_len (bm->buffer_pools) <= b->buffer_pool_index)
190 return format (0, "unknown buffer pool 0x%x", b->buffer_pool_index);
191
Dave Barach9b8ffd92016-07-08 08:13:45 -0400192 if ((signed) b->current_data < (signed) -VLIB_BUFFER_PRE_DATA_SIZE)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700193 return format (0, "current data %d before pre-data", b->current_data);
Damjan Marion878c6092017-01-04 13:19:27 +0100194
Damjan Marion32353822019-01-20 02:24:53 +0100195 if (b->current_data + b->current_length > VLIB_BUFFER_DATA_SIZE)
Damjan Marion910d3692019-01-21 11:48:34 +0100196 return format (0, "%d-%d beyond end of buffer %d", b->current_data,
197 b->current_length, VLIB_BUFFER_DATA_SIZE);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700198
Dave Barach9b8ffd92016-07-08 08:13:45 -0400199 if (follow_buffer_next && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700200 {
201 vlib_buffer_known_state_t k;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400202 u8 *msg, *result;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700203
Damjan Mariond50e3472019-01-20 00:03:56 +0100204 k = vlib_buffer_is_known (vm, b->next_buffer);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700205 if (k != VLIB_BUFFER_KNOWN_ALLOCATED)
206 return format (0, "next 0x%x: %U",
Dave Barach9b8ffd92016-07-08 08:13:45 -0400207 b->next_buffer, format_vlib_buffer_known_state, k);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700208
209 if (unique_hash)
210 {
211 if (hash_get (*unique_hash, b->next_buffer))
212 return format (0, "duplicate buffer 0x%x", b->next_buffer);
213
214 hash_set1 (*unique_hash, b->next_buffer);
215 }
216
217 msg = vlib_validate_buffer (vm, b->next_buffer, follow_buffer_next);
218 if (msg)
219 {
220 result = format (0, "next 0x%x: %v", b->next_buffer, msg);
221 vec_free (msg);
222 return result;
223 }
224 }
225
226 return 0;
227}
228
229u8 *
230vlib_validate_buffer (vlib_main_t * vm, u32 bi, uword follow_buffer_next)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400231{
232 return vlib_validate_buffer_helper (vm, bi, follow_buffer_next,
233 /* unique_hash */ 0);
234}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700235
236u8 *
237vlib_validate_buffers (vlib_main_t * vm,
238 u32 * buffers,
239 uword next_buffer_stride,
240 uword n_buffers,
241 vlib_buffer_known_state_t known_state,
242 uword follow_buffer_next)
243{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400244 uword i, *hash;
245 u32 bi, *b = buffers;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700246 vlib_buffer_known_state_t k;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400247 u8 *msg = 0, *result = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700248
249 hash = hash_create (0, 0);
250 for (i = 0; i < n_buffers; i++)
251 {
252 bi = b[0];
253 b += next_buffer_stride;
254
255 /* Buffer is not unique. */
256 if (hash_get (hash, bi))
257 {
258 msg = format (0, "not unique");
259 goto done;
260 }
261
Damjan Mariond50e3472019-01-20 00:03:56 +0100262 k = vlib_buffer_is_known (vm, bi);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700263 if (k != known_state)
264 {
265 msg = format (0, "is %U; expected %U",
266 format_vlib_buffer_known_state, k,
267 format_vlib_buffer_known_state, known_state);
268 goto done;
269 }
270
271 msg = vlib_validate_buffer_helper (vm, bi, follow_buffer_next, &hash);
272 if (msg)
273 goto done;
274
275 hash_set1 (hash, bi);
276 }
277
Dave Barach9b8ffd92016-07-08 08:13:45 -0400278done:
Ed Warnickecb9cada2015-12-08 15:45:58 -0700279 if (msg)
280 {
281 result = format (0, "0x%x: %v", bi, msg);
282 vec_free (msg);
283 }
284 hash_free (hash);
285 return result;
286}
287
Dave Barach80f54e22017-03-08 19:08:56 -0500288/*
289 * Hand-craft a static vector w/ length 1, so vec_len(vlib_mains) =1
290 * and vlib_mains[0] = &vlib_global_main from the beginning of time.
291 *
292 * The only place which should ever expand vlib_mains is start_workers()
293 * in threads.c. It knows about the bootstrap vector.
294 */
295/* *INDENT-OFF* */
296static struct
297{
298 vec_header_t h;
299 vlib_main_t *vm;
300} __attribute__ ((packed)) __bootstrap_vlib_main_vector
301 __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES))) =
302{
303 .h.len = 1,
304 .vm = &vlib_global_main,
305};
306/* *INDENT-ON* */
307
308vlib_main_t **vlib_mains = &__bootstrap_vlib_main_vector.vm;
309
Ed Warnickecb9cada2015-12-08 15:45:58 -0700310
311/* When dubugging validate that given buffers are either known allocated
312 or known free. */
Damjan Marionc8a26c62017-11-24 20:15:23 +0100313void
Ed Warnickecb9cada2015-12-08 15:45:58 -0700314vlib_buffer_validate_alloc_free (vlib_main_t * vm,
315 u32 * buffers,
316 uword n_buffers,
317 vlib_buffer_known_state_t expected_state)
318{
Damjan Marion910d3692019-01-21 11:48:34 +0100319 vlib_buffer_main_t *bm = vm->buffer_main;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400320 u32 *b;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700321 uword i, bi, is_free;
322
323 if (CLIB_DEBUG == 0)
324 return;
325
Ed Warnickecb9cada2015-12-08 15:45:58 -0700326 is_free = expected_state == VLIB_BUFFER_KNOWN_ALLOCATED;
327 b = buffers;
328 for (i = 0; i < n_buffers; i++)
329 {
330 vlib_buffer_known_state_t known;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400331
Ed Warnickecb9cada2015-12-08 15:45:58 -0700332 bi = b[0];
333 b += 1;
Damjan Mariond50e3472019-01-20 00:03:56 +0100334 known = vlib_buffer_is_known (vm, bi);
Damjan Marion910d3692019-01-21 11:48:34 +0100335
336 if (known == VLIB_BUFFER_UNKNOWN &&
337 expected_state == VLIB_BUFFER_KNOWN_FREE)
338 known = VLIB_BUFFER_KNOWN_FREE;
339
Ed Warnickecb9cada2015-12-08 15:45:58 -0700340 if (known != expected_state)
341 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700342 vlib_panic_with_msg
343 (vm, "%s %U buffer 0x%x",
344 is_free ? "freeing" : "allocating",
Dave Barach9b8ffd92016-07-08 08:13:45 -0400345 format_vlib_buffer_known_state, known, bi);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700346 }
347
Damjan Marion910d3692019-01-21 11:48:34 +0100348 clib_spinlock_lock (&bm->buffer_known_hash_lockp);
349 hash_set (bm->buffer_known_hash, bi, is_free ? VLIB_BUFFER_KNOWN_FREE :
350 VLIB_BUFFER_KNOWN_ALLOCATED);
351 clib_spinlock_unlock (&bm->buffer_known_hash_lockp);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700352 }
353}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700354
Dave Barach9b8ffd92016-07-08 08:13:45 -0400355void
356vlib_packet_template_init (vlib_main_t * vm,
357 vlib_packet_template_t * t,
358 void *packet_data,
359 uword n_packet_data_bytes,
Damjan Mariond1274cb2018-03-13 21:32:17 +0100360 uword min_n_buffers_each_alloc, char *fmt, ...)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700361{
Damjan Marion1cd8f3c2016-11-24 02:07:32 +0100362 va_list va;
Damjan Marion1cd8f3c2016-11-24 02:07:32 +0100363
364 va_start (va, fmt);
Damjan Marion671e60e2018-12-30 18:09:59 +0100365 t->name = va_format (0, fmt, &va);
Damjan Marion1cd8f3c2016-11-24 02:07:32 +0100366 va_end (va);
367
368 vlib_worker_thread_barrier_sync (vm);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700369
Dave Barachb7b92992018-10-17 10:38:51 -0400370 clib_memset (t, 0, sizeof (t[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700371
372 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
Damjan Mariond1274cb2018-03-13 21:32:17 +0100373 t->min_n_buffers_each_alloc = min_n_buffers_each_alloc;
Damjan Marion878c6092017-01-04 13:19:27 +0100374 vlib_worker_thread_barrier_release (vm);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700375}
376
377void *
Dave Barach9b8ffd92016-07-08 08:13:45 -0400378vlib_packet_template_get_packet (vlib_main_t * vm,
379 vlib_packet_template_t * t, u32 * bi_result)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700380{
381 u32 bi;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400382 vlib_buffer_t *b;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700383
384 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
385 return 0;
386
387 *bi_result = bi;
388
389 b = vlib_get_buffer (vm, bi);
Dave Barach178cf492018-11-13 16:34:13 -0500390 clib_memcpy_fast (vlib_buffer_get_current (b),
391 t->packet_data, vec_len (t->packet_data));
Dave Barach9b8ffd92016-07-08 08:13:45 -0400392 b->current_length = vec_len (t->packet_data);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700393
394 return b->data;
395}
396
Ed Warnickecb9cada2015-12-08 15:45:58 -0700397/* Append given data to end of buffer, possibly allocating new buffers. */
Dave Barach3a63fc52019-01-07 09:15:47 -0500398int
Damjan Marionab9b7ec2019-01-18 20:24:44 +0100399vlib_buffer_add_data (vlib_main_t * vm, u32 * buffer_index, void *data,
400 u32 n_data_bytes)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700401{
402 u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400403 vlib_buffer_t *b;
404 void *d;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700405
Dave Barach3a63fc52019-01-07 09:15:47 -0500406 bi = *buffer_index;
Damjan Marionab9b7ec2019-01-18 20:24:44 +0100407 if (bi == ~0 && 1 != vlib_buffer_alloc (vm, &bi, 1))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700408 goto out_of_buffers;
409
410 d = data;
411 n_left = n_data_bytes;
Damjan Marionab9b7ec2019-01-18 20:24:44 +0100412 n_buffer_bytes = VLIB_BUFFER_DATA_SIZE;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400413
Ed Warnickecb9cada2015-12-08 15:45:58 -0700414 b = vlib_get_buffer (vm, bi);
415 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
416
Dave Barach9b8ffd92016-07-08 08:13:45 -0400417 /* Get to the end of the chain before we try to append data... */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700418 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
419 b = vlib_get_buffer (vm, b->next_buffer);
420
421 while (1)
422 {
423 u32 n;
424
425 ASSERT (n_buffer_bytes >= b->current_length);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400426 n_left_this_buffer =
427 n_buffer_bytes - (b->current_data + b->current_length);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700428 n = clib_min (n_left_this_buffer, n_left);
Dave Barach178cf492018-11-13 16:34:13 -0500429 clib_memcpy_fast (vlib_buffer_get_current (b) + b->current_length, d,
430 n);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700431 b->current_length += n;
432 n_left -= n;
433 if (n_left == 0)
434 break;
435
436 d += n;
Damjan Marionab9b7ec2019-01-18 20:24:44 +0100437 if (1 != vlib_buffer_alloc (vm, &b->next_buffer, 1))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700438 goto out_of_buffers;
439
440 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
441
442 b = vlib_get_buffer (vm, b->next_buffer);
443 }
444
Dave Barach3a63fc52019-01-07 09:15:47 -0500445 *buffer_index = bi;
446 return 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700447
Dave Barach9b8ffd92016-07-08 08:13:45 -0400448out_of_buffers:
Dave Barach3a63fc52019-01-07 09:15:47 -0500449 clib_warning ("out of buffers");
450 return 1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700451}
452
Pierre Pfister328e99b2016-02-12 13:18:42 +0000453u16
Dave Barach9b8ffd92016-07-08 08:13:45 -0400454vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400455 vlib_buffer_t * first,
Damjan Mariondac03522018-02-01 15:30:13 +0100456 vlib_buffer_t ** last, void *data,
457 u16 data_len)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400458{
Pierre Pfister328e99b2016-02-12 13:18:42 +0000459 vlib_buffer_t *l = *last;
Damjan Marion32353822019-01-20 02:24:53 +0100460 u32 n_buffer_bytes = VLIB_BUFFER_DATA_SIZE;
Pierre Pfister328e99b2016-02-12 13:18:42 +0000461 u16 copied = 0;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400462 ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
463 while (data_len)
464 {
465 u16 max = n_buffer_bytes - l->current_length - l->current_data;
466 if (max == 0)
467 {
Damjan Marion910d3692019-01-21 11:48:34 +0100468 if (1 != vlib_buffer_alloc_from_pool (vm, &l->next_buffer, 1,
469 first->buffer_pool_index))
Dave Barach9b8ffd92016-07-08 08:13:45 -0400470 return copied;
Eyal Barib688fb12018-11-12 16:13:49 +0200471 *last = l = vlib_buffer_chain_buffer (vm, l, l->next_buffer);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400472 max = n_buffer_bytes - l->current_length - l->current_data;
473 }
Pierre Pfister328e99b2016-02-12 13:18:42 +0000474
Dave Barach9b8ffd92016-07-08 08:13:45 -0400475 u16 len = (data_len > max) ? max : data_len;
Dave Barach178cf492018-11-13 16:34:13 -0500476 clib_memcpy_fast (vlib_buffer_get_current (l) + l->current_length,
477 data + copied, len);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400478 vlib_buffer_chain_increase_length (first, l, len);
479 data_len -= len;
480 copied += len;
481 }
Pierre Pfister328e99b2016-02-12 13:18:42 +0000482 return copied;
483}
484
Damjan Marion910d3692019-01-21 11:48:34 +0100485clib_error_t *
486vlib_buffer_pool_create (vlib_main_t * vm, u8 index, char *name,
487 u32 data_size, u32 physmem_map_index)
Damjan Marion04a7f052017-07-10 15:06:17 +0200488{
Damjan Mariond50e3472019-01-20 00:03:56 +0100489 vlib_buffer_main_t *bm = vm->buffer_main;
Damjan Marion910d3692019-01-21 11:48:34 +0100490 vlib_buffer_pool_t *bp;
Damjan Marion68b4da62018-09-30 18:26:20 +0200491 vlib_physmem_map_t *m = vlib_physmem_get_map (vm, physmem_map_index);
492 uword start = pointer_to_uword (m->base);
Damjan Marion8e8d3c82018-10-23 22:54:40 +0200493 uword size = (uword) m->n_pages << m->log2_page_size;
Damjan Marion910d3692019-01-21 11:48:34 +0100494 u32 alloc_size, n_alloc_per_page;;
495
496 vec_validate_aligned (bm->buffer_pools, index, CLIB_CACHE_LINE_BYTES);
497 bp = vec_elt_at_index (bm->buffer_pools, index);
498
499 if (bp->start)
500 return clib_error_return (0, "buffer with index %u already exists",
501 index);
502
503 if (index >= 255)
504 return clib_error_return (0, "buffer index must be < 255", index);
Damjan Marion04a7f052017-07-10 15:06:17 +0200505
506 if (bm->buffer_mem_size == 0)
507 {
508 bm->buffer_mem_start = start;
509 bm->buffer_mem_size = size;
510 }
511 else if (start < bm->buffer_mem_start)
512 {
513 bm->buffer_mem_size += bm->buffer_mem_start - start;
514 bm->buffer_mem_start = start;
515 if (size > bm->buffer_mem_size)
516 bm->buffer_mem_size = size;
517 }
518 else if (start > bm->buffer_mem_start)
519 {
520 uword new_size = start - bm->buffer_mem_start + size;
521 if (new_size > bm->buffer_mem_size)
522 bm->buffer_mem_size = new_size;
523 }
524
525 if ((u64) bm->buffer_mem_size >
526 ((u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
527 {
528 clib_panic ("buffer memory size out of range!");
529 }
Damjan Marion149ba772017-10-12 13:09:26 +0200530
Damjan Marion910d3692019-01-21 11:48:34 +0100531 bp->start = start;
532 bp->size = size;
533 bp->index = bp - bm->buffer_pools;
534 bp->buffer_template.buffer_pool_index = bp->index;
535 bp->buffer_template.ref_count = 1;
536 bp->physmem_map_index = physmem_map_index;
537 bp->name = format (0, "%s%c", name, 0);
538 bp->data_size = data_size;
539 bp->numa_node = m->numa_node;
Damjan Mariond1274cb2018-03-13 21:32:17 +0100540
Damjan Marion910d3692019-01-21 11:48:34 +0100541 vec_validate_aligned (bp->threads, vec_len (vlib_mains) - 1,
542 CLIB_CACHE_LINE_BYTES);
543
544 alloc_size = data_size + sizeof (vlib_buffer_t) + bm->ext_hdr_size;
545 n_alloc_per_page = (1ULL << m->log2_page_size) / alloc_size;
546
547 /* preallocate buffer indices memory */
548 vec_validate_aligned (bp->buffers, m->n_pages * n_alloc_per_page,
549 CLIB_CACHE_LINE_BYTES);
550 vec_reset_length (bp->buffers);
551
552 clib_spinlock_init (&bp->lock);
553
554 while (1)
555 {
556 u8 *p;
557 u32 bi;
558
559 p = vlib_physmem_alloc_from_map (vm, bp->physmem_map_index, alloc_size,
560 CLIB_CACHE_LINE_BYTES);
561
562 if (p == 0)
563 break;
564
565 p += bm->ext_hdr_size;
566
567 vlib_buffer_copy_template ((vlib_buffer_t *) p, &bp->buffer_template);
568
569 bi = vlib_get_buffer_index (vm, (vlib_buffer_t *) p);
570
571 vec_add1_aligned (bp->buffers, bi, CLIB_CACHE_LINE_BYTES);
Damjan Marion24dcbe42019-01-31 12:29:39 +0100572 vlib_get_buffer (vm, bi);
Damjan Marion910d3692019-01-21 11:48:34 +0100573
574 bp->n_buffers += 1;
575 }
576
577 return 0;
Damjan Marion04a7f052017-07-10 15:06:17 +0200578}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700579
Dave Barach9b8ffd92016-07-08 08:13:45 -0400580static u8 *
Damjan Marion910d3692019-01-21 11:48:34 +0100581format_vlib_buffer_pool (u8 * s, va_list * va)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700582{
Damjan Marion910d3692019-01-21 11:48:34 +0100583 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
584 vlib_buffer_pool_t *bp = va_arg (*va, vlib_buffer_pool_t *);
585 vlib_buffer_pool_thread_t *bpt;
586 u32 cached = 0;
Damjan Marion1cd8f3c2016-11-24 02:07:32 +0100587
Damjan Marion910d3692019-01-21 11:48:34 +0100588 if (!bp)
589 return format (s, "%-20s%=6s%=6s%=6s%=11s%=6s%=8s%=8s%=8s",
590 "Pool Name", "Index", "NUMA", "Size", "Data Size",
591 "Total", "Avail", "Cached", "Used");
Damjan Marion1cd8f3c2016-11-24 02:07:32 +0100592
Damjan Marion910d3692019-01-21 11:48:34 +0100593 /* *INDENT-OFF* */
594 vec_foreach (bpt, bp->threads)
595 cached += vec_len (bpt->cached_buffers);
596 /* *INDENT-ON* */
Damjan Marion1cd8f3c2016-11-24 02:07:32 +0100597
Damjan Marion910d3692019-01-21 11:48:34 +0100598 s = format (s, "%-20s%=6d%=6d%=6u%=11u%=6u%=8u%=8u%=8u",
599 bp->name, bp->index, bp->numa_node, bp->data_size +
600 sizeof (vlib_buffer_t) + vm->buffer_main->ext_hdr_size,
601 bp->data_size, bp->n_buffers, vec_len (bp->buffers), cached,
602 bp->n_buffers - vec_len (bp->buffers) - cached);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700603
604 return s;
605}
606
607static clib_error_t *
608show_buffers (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400609 unformat_input_t * input, vlib_cli_command_t * cmd)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700610{
Damjan Marion910d3692019-01-21 11:48:34 +0100611 vlib_buffer_main_t *bm = vm->buffer_main;
612 vlib_buffer_pool_t *bp;
Damjan Marion1cd8f3c2016-11-24 02:07:32 +0100613
Damjan Marion910d3692019-01-21 11:48:34 +0100614 vlib_cli_output (vm, "%U", format_vlib_buffer_pool, vm, 0);
Damjan Marion1cd8f3c2016-11-24 02:07:32 +0100615
Damjan Marion910d3692019-01-21 11:48:34 +0100616 /* *INDENT-OFF* */
617 vec_foreach (bp, bm->buffer_pools)
618 vlib_cli_output (vm, "%U", format_vlib_buffer_pool, vm, bp);
619 /* *INDENT-ON* */
Damjan Marion1cd8f3c2016-11-24 02:07:32 +0100620
Ed Warnickecb9cada2015-12-08 15:45:58 -0700621 return 0;
622}
623
Dave Barach9b8ffd92016-07-08 08:13:45 -0400624/* *INDENT-OFF* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700625VLIB_CLI_COMMAND (show_buffers_command, static) = {
626 .path = "show buffers",
627 .short_help = "Show packet buffer allocation",
628 .function = show_buffers,
629};
Dave Barach9b8ffd92016-07-08 08:13:45 -0400630/* *INDENT-ON* */
631
Damjan Marion49d66f12017-07-20 18:10:35 +0200632clib_error_t *
Damjan Marion910d3692019-01-21 11:48:34 +0100633vlib_buffer_worker_init (vlib_main_t * vm)
Damjan Marion1cd8f3c2016-11-24 02:07:32 +0100634{
Damjan Marion910d3692019-01-21 11:48:34 +0100635 vlib_buffer_main_t *bm = vm->buffer_main;
636 vlib_buffer_pool_t *bp;
637
638 /* *INDENT-OFF* */
639 vec_foreach (bp, bm->buffer_pools)
640 {
641 clib_spinlock_lock (&bp->lock);
642 vec_validate_aligned (bp->threads, vec_len (vlib_mains) - 1,
643 CLIB_CACHE_LINE_BYTES);
644 clib_spinlock_unlock (&bp->lock);
645 }
646 /* *INDENT-ON* */
647
648 return 0;
649}
650
651VLIB_WORKER_INIT_FUNCTION (vlib_buffer_worker_init);
652
653static clib_error_t *
654vlib_buffer_main_init_numa_node (struct vlib_main_t *vm, u32 numa_node)
655{
656 vlib_buffer_main_t *bm = vm->buffer_main;
Damjan Marion49d66f12017-07-20 18:10:35 +0200657 clib_error_t *error;
Damjan Marion68b4da62018-09-30 18:26:20 +0200658 u32 physmem_map_index;
Damjan Marion910d3692019-01-21 11:48:34 +0100659 uword n_pages, pagesize;
660 u32 buffers_per_numa;
661 u32 buffer_size = CLIB_CACHE_LINE_ROUND (bm->ext_hdr_size +
662 sizeof (vlib_buffer_t) +
663 VLIB_BUFFER_DATA_SIZE);
664 u8 *name;
Damjan Marion567e61d2018-10-24 17:08:26 +0200665
Damjan Marion910d3692019-01-21 11:48:34 +0100666 pagesize = clib_mem_get_default_hugepage_size ();
667 name = format (0, "buffers-numa-%d%c", numa_node, 0);
Damjan Marion49d66f12017-07-20 18:10:35 +0200668
Damjan Marion910d3692019-01-21 11:48:34 +0100669 buffers_per_numa = bm->buffers_per_numa ? bm->buffers_per_numa :
670 VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA;
Damjan Marion49d66f12017-07-20 18:10:35 +0200671
Damjan Marion567e61d2018-10-24 17:08:26 +0200672retry:
Damjan Marion910d3692019-01-21 11:48:34 +0100673 n_pages = (buffers_per_numa - 1) / (pagesize / buffer_size) + 1;
674 error = vlib_physmem_shared_map_create (vm, (char *) name,
675 n_pages * pagesize,
676 min_log2 (pagesize), numa_node,
Damjan Marion567e61d2018-10-24 17:08:26 +0200677 &physmem_map_index);
678
Damjan Marion910d3692019-01-21 11:48:34 +0100679 if (error && pagesize != clib_mem_get_page_size ())
Damjan Marion567e61d2018-10-24 17:08:26 +0200680 {
Damjan Marion910d3692019-01-21 11:48:34 +0100681 vlib_log_warn (bm->log_default, "%U", format_clib_error, error);
Damjan Marion567e61d2018-10-24 17:08:26 +0200682 clib_error_free (error);
Damjan Marion910d3692019-01-21 11:48:34 +0100683 vlib_log_warn (bm->log_default, "falling back to non-hugepage "
Damjan Marion567e61d2018-10-24 17:08:26 +0200684 "backed buffer pool");
Damjan Marion910d3692019-01-21 11:48:34 +0100685 pagesize = clib_mem_get_page_size ();
686 buffers_per_numa = bm->buffers_per_numa ? bm->buffers_per_numa :
687 VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA_UNPRIV;
Damjan Marion567e61d2018-10-24 17:08:26 +0200688 goto retry;
689 }
690
691 if (error)
Damjan Marion68b4da62018-09-30 18:26:20 +0200692 return error;
Damjan Marion49d66f12017-07-20 18:10:35 +0200693
Damjan Marion910d3692019-01-21 11:48:34 +0100694 vec_reset_length (name);
695 name = format (name, "default-numa-%d%c", numa_node, 0);
Damjan Marion49d66f12017-07-20 18:10:35 +0200696
Damjan Marion910d3692019-01-21 11:48:34 +0100697 return vlib_buffer_pool_create (vm, numa_node, (char *) name,
698 VLIB_BUFFER_DATA_SIZE, physmem_map_index);
699}
700
701clib_error_t *
702vlib_buffer_main_init (struct vlib_main_t *vm)
703{
704 vlib_buffer_main_t *bm;
705 clib_error_t *err;
706 clib_bitmap_t *bmp = 0;
707 u32 numa_node;
708
709 if (vm->buffer_main == 0)
710 {
711 vm->buffer_main = clib_mem_alloc (sizeof (bm[0]));
712 clib_memset (vm->buffer_main, 0, sizeof (bm[0]));
713 }
714
715 bm = vm->buffer_main;
716 bm->log_default = vlib_log_register_class ("buffer", 0);
717 bm->ext_hdr_size = __vlib_buffer_external_hdr_size;
718
719 clib_spinlock_init (&bm->buffer_known_hash_lockp);
720
721 err = clib_sysfs_read ("/sys/devices/system/node/possible", "%U",
722 unformat_bitmap_list, &bmp);
723 if (err)
724 {
725 /* no info from sysfs, assuming that only numa 0 exists */
726 clib_error_free (err);
727 bmp = clib_bitmap_set (bmp, 0, 1);
728 }
729
730 /* *INDENT-OFF* */
731 clib_bitmap_foreach (numa_node, bmp, {
732 if ((err = vlib_buffer_main_init_numa_node(vm, numa_node)))
733 goto done;
734 });
735 /* *INDENT-ON* */
736
737 bm->n_numa_nodes = clib_bitmap_last_set (bmp) + 1;
738
739done:
740 vec_free (bmp);
741 return err;
Damjan Marion878c6092017-01-04 13:19:27 +0100742}
Damjan Marion1cd8f3c2016-11-24 02:07:32 +0100743
Damjan Marion49d66f12017-07-20 18:10:35 +0200744static clib_error_t *
745vlib_buffers_configure (vlib_main_t * vm, unformat_input_t * input)
746{
Damjan Marion910d3692019-01-21 11:48:34 +0100747 vlib_buffer_main_t *bm;
748
749 if (vm->buffer_main == 0)
750 {
751 vm->buffer_main = clib_mem_alloc (sizeof (bm[0]));
752 clib_memset (vm->buffer_main, 0, sizeof (bm[0]));
753 }
754
755 bm = vm->buffer_main;
Damjan Marion49d66f12017-07-20 18:10:35 +0200756
757 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
758 {
Damjan Marion910d3692019-01-21 11:48:34 +0100759 if (unformat (input, "buffers-per-numa %u", &bm->buffers_per_numa))
760 ;
Damjan Marion49d66f12017-07-20 18:10:35 +0200761 else
762 return unformat_parse_error (input);
763 }
764
765 unformat_free (input);
766 return 0;
767}
768
769VLIB_EARLY_CONFIG_FUNCTION (vlib_buffers_configure, "buffers");
770
771
Chris Luked4024f52016-09-06 09:32:36 -0400772/** @endcond */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400773/*
774 * fd.io coding-style-patch-verification: ON
775 *
776 * Local Variables:
777 * eval: (c-set-style "gnu")
778 * End:
779 */