00686593c6ba8472392839137d50dd8996dacec3
[vpp.git] / src / vlib / buffer.c
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.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
40 /**
41  * @file
42  *
43  * Allocate/free network buffers.
44  */
45
46 #include <vppinfra/linux/sysfs.h>
47 #include <vlib/vlib.h>
48 #include <vlib/unix/unix.h>
49 #include <vlib/stats/stats.h>
50
51 #define VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA 16384
52 #define VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA_UNPRIV 8192
53
54 #ifdef CLIB_HAVE_VEC128
55 /* Assumptions by vlib_buffer_free_inline: */
56 STATIC_ASSERT_FITS_IN (vlib_buffer_t, flags, 16);
57 STATIC_ASSERT_FITS_IN (vlib_buffer_t, ref_count, 16);
58 STATIC_ASSERT_FITS_IN (vlib_buffer_t, buffer_pool_index, 16);
59 #endif
60
61 /* Make sure that buffer template size is not accidentally changed */
62 STATIC_ASSERT_OFFSET_OF (vlib_buffer_t, template_end, 64);
63
64 u16 __vlib_buffer_external_hdr_size = 0;
65
66 uword
67 vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
68                                        vlib_buffer_t * b_first)
69 {
70   vlib_buffer_t *b = b_first;
71   uword l_first = b_first->current_length;
72   uword l = 0;
73   while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
74     {
75       b = vlib_get_buffer (vm, b->next_buffer);
76       l += b->current_length;
77     }
78   b_first->total_length_not_including_first_buffer = l;
79   b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
80   return l + l_first;
81 }
82
83 u8 *
84 format_vlib_buffer_no_chain (u8 * s, va_list * args)
85 {
86   vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
87   u32 indent = format_get_indent (s);
88   u8 *a = 0;
89
90 #define _(bit, name, v) \
91   if (v && (b->flags & VLIB_BUFFER_##name)) \
92     a = format (a, "%s ", v);
93   foreach_vlib_buffer_flag
94 #undef _
95     s = format (s, "current data %d, length %d, buffer-pool %d, "
96                 "ref-count %u", b->current_data, b->current_length,
97                 b->buffer_pool_index, b->ref_count);
98
99   if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
100     s = format (s, ", totlen-nifb %d",
101                 b->total_length_not_including_first_buffer);
102
103   if (b->flags & VLIB_BUFFER_IS_TRACED)
104     s = format (s, ", trace handle 0x%x", b->trace_handle);
105
106   if (a)
107     s = format (s, "\n%U%v", format_white_space, indent, a);
108   vec_free (a);
109
110   return s;
111 }
112
113 u8 *
114 format_vlib_buffer (u8 * s, va_list * args)
115 {
116   vlib_main_t *vm = vlib_get_main ();
117   vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
118   u32 indent = format_get_indent (s);
119
120   s = format (s, "%U", format_vlib_buffer_no_chain, b);
121
122   while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
123     {
124       u32 next_buffer = b->next_buffer;
125       b = vlib_get_buffer (vm, next_buffer);
126
127       s =
128         format (s, "\n%Unext-buffer 0x%x, segment length %d, ref-count %u",
129                 format_white_space, indent, next_buffer, b->current_length,
130                 b->ref_count);
131     }
132
133   return s;
134 }
135
136 u8 *
137 format_vlib_buffer_and_data (u8 * s, va_list * args)
138 {
139   vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
140
141   s = format (s, "%U, %U",
142               format_vlib_buffer, b,
143               format_hex_bytes, vlib_buffer_get_current (b), 64);
144
145   return s;
146 }
147
148 static u8 *
149 format_vlib_buffer_known_state (u8 * s, va_list * args)
150 {
151   vlib_buffer_known_state_t state = va_arg (*args, vlib_buffer_known_state_t);
152   char *t;
153
154   switch (state)
155     {
156     case VLIB_BUFFER_UNKNOWN:
157       t = "unknown";
158       break;
159
160     case VLIB_BUFFER_KNOWN_ALLOCATED:
161       t = "known-allocated";
162       break;
163
164     case VLIB_BUFFER_KNOWN_FREE:
165       t = "known-free";
166       break;
167
168     default:
169       t = "invalid";
170       break;
171     }
172
173   return format (s, "%s", t);
174 }
175
176 u8 *
177 format_vlib_buffer_contents (u8 * s, va_list * va)
178 {
179   vlib_main_t *vm = va_arg (*va, vlib_main_t *);
180   vlib_buffer_t *b = va_arg (*va, vlib_buffer_t *);
181
182   while (1)
183     {
184       vec_add (s, vlib_buffer_get_current (b), b->current_length);
185       if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
186         break;
187       b = vlib_get_buffer (vm, b->next_buffer);
188     }
189
190   return s;
191 }
192
193 static u8 *
194 vlib_validate_buffer_helper (vlib_main_t * vm,
195                              u32 bi,
196                              uword follow_buffer_next, uword ** unique_hash)
197 {
198   vlib_buffer_main_t *bm = vm->buffer_main;
199   vlib_buffer_t *b = vlib_get_buffer (vm, bi);
200
201   if (vec_len (bm->buffer_pools) <= b->buffer_pool_index)
202     return format (0, "unknown buffer pool 0x%x", b->buffer_pool_index);
203
204   if ((signed) b->current_data < (signed) -VLIB_BUFFER_PRE_DATA_SIZE)
205     return format (0, "current data %d before pre-data", b->current_data);
206
207   if (b->current_data + b->current_length >
208       vlib_buffer_get_default_data_size (vm))
209     return format (0, "%d-%d beyond end of buffer %d", b->current_data,
210                    b->current_length, vlib_buffer_get_default_data_size (vm));
211
212   if (follow_buffer_next && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
213     {
214       vlib_buffer_known_state_t k;
215       u8 *msg, *result;
216
217       k = vlib_buffer_is_known (vm, b->next_buffer);
218       if (k != VLIB_BUFFER_KNOWN_ALLOCATED)
219         return format (0, "next 0x%x: %U",
220                        b->next_buffer, format_vlib_buffer_known_state, k);
221
222       if (unique_hash)
223         {
224           if (hash_get (*unique_hash, b->next_buffer))
225             return format (0, "duplicate buffer 0x%x", b->next_buffer);
226
227           hash_set1 (*unique_hash, b->next_buffer);
228         }
229
230       msg = vlib_validate_buffer (vm, b->next_buffer, follow_buffer_next);
231       if (msg)
232         {
233           result = format (0, "next 0x%x: %v", b->next_buffer, msg);
234           vec_free (msg);
235           return result;
236         }
237     }
238
239   return 0;
240 }
241
242 u8 *
243 vlib_validate_buffer (vlib_main_t * vm, u32 bi, uword follow_buffer_next)
244 {
245   return vlib_validate_buffer_helper (vm, bi, follow_buffer_next,
246                                       /* unique_hash */ 0);
247 }
248
249 u8 *
250 vlib_validate_buffers (vlib_main_t * vm,
251                        u32 * buffers,
252                        uword next_buffer_stride,
253                        uword n_buffers,
254                        vlib_buffer_known_state_t known_state,
255                        uword follow_buffer_next)
256 {
257   uword i, *hash;
258   u32 bi, *b = buffers;
259   vlib_buffer_known_state_t k;
260   u8 *msg = 0, *result = 0;
261
262   hash = hash_create (0, 0);
263   for (i = 0; i < n_buffers; i++)
264     {
265       bi = b[0];
266       b += next_buffer_stride;
267
268       /* Buffer is not unique. */
269       if (hash_get (hash, bi))
270         {
271           msg = format (0, "not unique");
272           goto done;
273         }
274
275       k = vlib_buffer_is_known (vm, bi);
276       if (k != known_state)
277         {
278           msg = format (0, "is %U; expected %U",
279                         format_vlib_buffer_known_state, k,
280                         format_vlib_buffer_known_state, known_state);
281           goto done;
282         }
283
284       msg = vlib_validate_buffer_helper (vm, bi, follow_buffer_next, &hash);
285       if (msg)
286         goto done;
287
288       hash_set1 (hash, bi);
289     }
290
291 done:
292   if (msg)
293     {
294       result = format (0, "0x%x: %v", bi, msg);
295       vec_free (msg);
296     }
297   hash_free (hash);
298   return result;
299 }
300
301 /* When debugging validate that given buffers are either known allocated
302    or known free. */
303 void
304 vlib_buffer_validate_alloc_free (vlib_main_t * vm,
305                                  u32 * buffers,
306                                  uword n_buffers,
307                                  vlib_buffer_known_state_t expected_state)
308 {
309   vlib_buffer_main_t *bm = vm->buffer_main;
310   u32 *b;
311   uword i, bi, is_free;
312
313   if (CLIB_DEBUG == 0)
314     return;
315
316   is_free = expected_state == VLIB_BUFFER_KNOWN_ALLOCATED;
317   b = buffers;
318   for (i = 0; i < n_buffers; i++)
319     {
320       vlib_buffer_known_state_t known;
321
322       bi = b[0];
323       b += 1;
324       known = vlib_buffer_is_known (vm, bi);
325
326       if (known == VLIB_BUFFER_UNKNOWN &&
327           expected_state == VLIB_BUFFER_KNOWN_FREE)
328         known = VLIB_BUFFER_KNOWN_FREE;
329
330       if (known != expected_state)
331         {
332           clib_panic ("%s %U buffer 0x%x", is_free ? "freeing" : "allocating",
333                       format_vlib_buffer_known_state, known, bi);
334         }
335
336       clib_spinlock_lock (&bm->buffer_known_hash_lockp);
337       hash_set (bm->buffer_known_hash, bi, is_free ? VLIB_BUFFER_KNOWN_FREE :
338                 VLIB_BUFFER_KNOWN_ALLOCATED);
339       clib_spinlock_unlock (&bm->buffer_known_hash_lockp);
340     }
341 }
342
343 void
344 vlib_packet_template_init (vlib_main_t * vm,
345                            vlib_packet_template_t * t,
346                            void *packet_data,
347                            uword n_packet_data_bytes,
348                            uword min_n_buffers_each_alloc, char *fmt, ...)
349 {
350   va_list va;
351
352   va_start (va, fmt);
353   t->name = va_format (0, fmt, &va);
354   va_end (va);
355
356   vlib_worker_thread_barrier_sync (vm);
357
358   clib_memset (t, 0, sizeof (t[0]));
359
360   vec_add (t->packet_data, packet_data, n_packet_data_bytes);
361   t->min_n_buffers_each_alloc = min_n_buffers_each_alloc;
362   vlib_worker_thread_barrier_release (vm);
363 }
364
365 void *
366 vlib_packet_template_get_packet (vlib_main_t * vm,
367                                  vlib_packet_template_t * t, u32 * bi_result)
368 {
369   u32 bi;
370   vlib_buffer_t *b;
371
372   if (vlib_buffer_alloc (vm, &bi, 1) != 1)
373     return 0;
374
375   *bi_result = bi;
376
377   b = vlib_get_buffer (vm, bi);
378   clib_memcpy_fast (vlib_buffer_get_current (b),
379                     t->packet_data, vec_len (t->packet_data));
380   b->current_length = vec_len (t->packet_data);
381
382   return b->data;
383 }
384
385 /* Append given data to end of buffer, possibly allocating new buffers. */
386 int
387 vlib_buffer_add_data (vlib_main_t * vm, u32 * buffer_index, void *data,
388                       u32 n_data_bytes)
389 {
390   u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
391   vlib_buffer_t *b;
392   void *d;
393
394   bi = *buffer_index;
395   if (bi == ~0 && 1 != vlib_buffer_alloc (vm, &bi, 1))
396     goto out_of_buffers;
397
398   d = data;
399   n_left = n_data_bytes;
400   n_buffer_bytes = vlib_buffer_get_default_data_size (vm);
401
402   b = vlib_get_buffer (vm, bi);
403   b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
404
405   /* Get to the end of the chain before we try to append data... */
406   while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
407     b = vlib_get_buffer (vm, b->next_buffer);
408
409   while (1)
410     {
411       u32 n;
412
413       ASSERT (n_buffer_bytes >= b->current_length);
414       n_left_this_buffer =
415         n_buffer_bytes - (b->current_data + b->current_length);
416       n = clib_min (n_left_this_buffer, n_left);
417       clib_memcpy_fast (vlib_buffer_get_current (b) + b->current_length, d,
418                         n);
419       b->current_length += n;
420       n_left -= n;
421       if (n_left == 0)
422         break;
423
424       d += n;
425       if (1 != vlib_buffer_alloc (vm, &b->next_buffer, 1))
426         goto out_of_buffers;
427
428       b->flags |= VLIB_BUFFER_NEXT_PRESENT;
429
430       b = vlib_get_buffer (vm, b->next_buffer);
431     }
432
433   *buffer_index = bi;
434   return 0;
435
436 out_of_buffers:
437   clib_warning ("out of buffers");
438   return 1;
439 }
440
441 u16
442 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
443                                           vlib_buffer_t * first,
444                                           vlib_buffer_t ** last, void *data,
445                                           u16 data_len)
446 {
447   vlib_buffer_t *l = *last;
448   u32 n_buffer_bytes = vlib_buffer_get_default_data_size (vm);
449   u16 copied = 0;
450   ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
451   while (data_len)
452     {
453       u16 max = n_buffer_bytes - l->current_length - l->current_data;
454       if (max == 0)
455         {
456           if (1 != vlib_buffer_alloc_from_pool (vm, &l->next_buffer, 1,
457                                                 first->buffer_pool_index))
458             return copied;
459           *last = l = vlib_buffer_chain_buffer (vm, l, l->next_buffer);
460           max = n_buffer_bytes - l->current_length - l->current_data;
461         }
462
463       u16 len = (data_len > max) ? max : data_len;
464       clib_memcpy_fast (vlib_buffer_get_current (l) + l->current_length,
465                         data + copied, len);
466       vlib_buffer_chain_increase_length (first, l, len);
467       data_len -= len;
468       copied += len;
469     }
470   return copied;
471 }
472
473 static uword
474 vlib_buffer_alloc_size (uword ext_hdr_size, uword data_size)
475 {
476   uword alloc_size = ext_hdr_size + sizeof (vlib_buffer_t) + data_size;
477   alloc_size = CLIB_CACHE_LINE_ROUND (alloc_size);
478
479   /* in case when we have even number of cachelines, we add one more for
480    * better cache occupancy */
481   alloc_size |= CLIB_CACHE_LINE_BYTES;
482
483   return alloc_size;
484 }
485
486 u8
487 vlib_buffer_pool_create (vlib_main_t *vm, u32 data_size, u32 physmem_map_index,
488                          char *fmt, ...)
489 {
490   vlib_buffer_main_t *bm = vm->buffer_main;
491   vlib_buffer_pool_t *bp;
492   vlib_physmem_map_t *m = vlib_physmem_get_map (vm, physmem_map_index);
493   uword start = pointer_to_uword (m->base);
494   uword size = (uword) m->n_pages << m->log2_page_size;
495   uword page_mask = ~pow2_mask (m->log2_page_size);
496   u8 *p;
497   u32 alloc_size;
498   va_list va;
499
500   if (vec_len (bm->buffer_pools) >= 255)
501     return ~0;
502
503   vec_add2_aligned (bm->buffer_pools, bp, 1, CLIB_CACHE_LINE_BYTES);
504
505   if (bm->buffer_mem_size == 0)
506     {
507       bm->buffer_mem_start = start;
508       bm->buffer_mem_size = size;
509     }
510   else if (start < bm->buffer_mem_start)
511     {
512       bm->buffer_mem_size += bm->buffer_mem_start - start;
513       bm->buffer_mem_start = start;
514       if (size > bm->buffer_mem_size)
515         bm->buffer_mem_size = size;
516     }
517   else if (start > bm->buffer_mem_start)
518     {
519       uword new_size = start - bm->buffer_mem_start + size;
520       if (new_size > bm->buffer_mem_size)
521         bm->buffer_mem_size = new_size;
522     }
523
524   if ((u64) bm->buffer_mem_size >
525       ((u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
526     {
527       clib_panic ("buffer memory size out of range!");
528     }
529
530   bp->start = start;
531   bp->size = size;
532   bp->index = bp - bm->buffer_pools;
533   bp->buffer_template.buffer_pool_index = bp->index;
534   bp->buffer_template.ref_count = 1;
535   bp->physmem_map_index = physmem_map_index;
536   bp->data_size = data_size;
537   bp->numa_node = m->numa_node;
538   bp->log2_page_size = m->log2_page_size;
539
540   va_start (va, fmt);
541   bp->name = va_format (0, fmt, &va);
542   va_end (va);
543
544   vec_validate_aligned (bp->threads, vlib_get_n_threads () - 1,
545                         CLIB_CACHE_LINE_BYTES);
546
547   alloc_size = vlib_buffer_alloc_size (bm->ext_hdr_size, data_size);
548   bp->alloc_size = alloc_size;
549
550   /* preallocate buffer indices memory */
551   bp->buffers = clib_mem_alloc_aligned (
552     round_pow2 ((size / alloc_size) * sizeof (u32), CLIB_CACHE_LINE_BYTES),
553     CLIB_CACHE_LINE_BYTES);
554
555   clib_spinlock_init (&bp->lock);
556
557   p = m->base;
558
559   /* start with naturally aligned address */
560   p += alloc_size - (uword) p % alloc_size;
561
562   /*
563    * Waste 1 buffer (maximum) so that 0 is never a valid buffer index.
564    * Allows various places to ASSERT (bi != 0). Much easier
565    * than debugging downstream crashes in successor nodes.
566    */
567   if (p == m->base)
568     p += alloc_size;
569
570   for (; p < (u8 *) m->base + size - alloc_size; p += alloc_size)
571     {
572       vlib_buffer_t *b;
573       u32 bi;
574
575       /* skip if buffer spans across page boundary */
576       if (((uword) p & page_mask) != ((uword) (p + alloc_size) & page_mask))
577         continue;
578
579       b = (vlib_buffer_t *) (p + bm->ext_hdr_size);
580       vlib_buffer_copy_template (b, &bp->buffer_template);
581       bi = vlib_get_buffer_index (vm, b);
582       bp->buffers[bp->n_avail++] = bi;
583       vlib_get_buffer (vm, bi);
584     }
585
586   bp->n_buffers = bp->n_avail;
587
588   return bp->index;
589 }
590
591 static u8 *
592 format_vlib_buffer_pool (u8 * s, va_list * va)
593 {
594   vlib_main_t *vm = va_arg (*va, vlib_main_t *);
595   vlib_buffer_pool_t *bp = va_arg (*va, vlib_buffer_pool_t *);
596   vlib_buffer_pool_thread_t *bpt;
597   u32 cached = 0;
598
599   if (!bp)
600     return format (s, "%-20s%=6s%=6s%=6s%=11s%=6s%=8s%=8s%=8s",
601                    "Pool Name", "Index", "NUMA", "Size", "Data Size",
602                    "Total", "Avail", "Cached", "Used");
603
604   /* *INDENT-OFF* */
605   vec_foreach (bpt, bp->threads)
606     cached += bpt->n_cached;
607   /* *INDENT-ON* */
608
609   s = format (s, "%-20s%=6d%=6d%=6u%=11u%=6u%=8u%=8u%=8u",
610               bp->name, bp->index, bp->numa_node, bp->data_size +
611               sizeof (vlib_buffer_t) + vm->buffer_main->ext_hdr_size,
612               bp->data_size, bp->n_buffers, bp->n_avail, cached,
613               bp->n_buffers - bp->n_avail - cached);
614
615   return s;
616 }
617
618 u8 *
619 format_vlib_buffer_pool_all (u8 *s, va_list *va)
620 {
621   vlib_main_t *vm = va_arg (*va, vlib_main_t *);
622   vlib_buffer_main_t *bm = vm->buffer_main;
623   vlib_buffer_pool_t *bp;
624
625   s = format (s, "%U", format_vlib_buffer_pool, vm, 0);
626
627   vec_foreach (bp, bm->buffer_pools)
628     s = format (s, "\n%U", format_vlib_buffer_pool, vm, bp);
629
630   return s;
631 }
632
633 static clib_error_t *
634 show_buffers (vlib_main_t *vm, unformat_input_t *input,
635               vlib_cli_command_t *cmd)
636 {
637   vlib_cli_output (vm, "%U", format_vlib_buffer_pool_all, vm);
638   return 0;
639 }
640
641 /* *INDENT-OFF* */
642 VLIB_CLI_COMMAND (show_buffers_command, static) = {
643   .path = "show buffers",
644   .short_help = "Show packet buffer allocation",
645   .function = show_buffers,
646 };
647 /* *INDENT-ON* */
648
649 clib_error_t *
650 vlib_buffer_num_workers_change (vlib_main_t *vm)
651 {
652   vlib_buffer_main_t *bm = vm->buffer_main;
653   vlib_buffer_pool_t *bp;
654
655   vec_foreach (bp, bm->buffer_pools)
656     vec_validate_aligned (bp->threads, vlib_get_n_threads () - 1,
657                           CLIB_CACHE_LINE_BYTES);
658
659   return 0;
660 }
661
662 VLIB_NUM_WORKERS_CHANGE_FN (vlib_buffer_num_workers_change);
663
664 static clib_error_t *
665 vlib_buffer_main_init_numa_alloc (struct vlib_main_t *vm, u32 numa_node,
666                                   u32 * physmem_map_index,
667                                   clib_mem_page_sz_t log2_page_size,
668                                   u8 unpriv)
669 {
670   vlib_buffer_main_t *bm = vm->buffer_main;
671   u32 buffers_per_numa = bm->buffers_per_numa;
672   clib_error_t *error;
673   u32 buffer_size;
674   uword n_pages, pagesize;
675   u8 *name = 0;
676
677   ASSERT (log2_page_size != CLIB_MEM_PAGE_SZ_UNKNOWN);
678
679   pagesize = clib_mem_page_bytes (log2_page_size);
680   buffer_size = vlib_buffer_alloc_size (bm->ext_hdr_size,
681                                         vlib_buffer_get_default_data_size
682                                         (vm));
683   if (buffer_size > pagesize)
684     return clib_error_return (0, "buffer size (%llu) is greater than page "
685                               "size (%llu)", buffer_size, pagesize);
686
687   if (buffers_per_numa == 0)
688     buffers_per_numa = unpriv ? VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA_UNPRIV :
689       VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA;
690
691   name = format (0, "buffers-numa-%d%c", numa_node, 0);
692   n_pages = (buffers_per_numa - 1) / (pagesize / buffer_size) + 1;
693   error = vlib_physmem_shared_map_create (vm, (char *) name,
694                                           n_pages * pagesize,
695                                           min_log2 (pagesize), numa_node,
696                                           physmem_map_index);
697   vec_free (name);
698   return error;
699 }
700
701 static clib_error_t *
702 vlib_buffer_main_init_numa_node (struct vlib_main_t *vm, u32 numa_node,
703                                  u8 * index)
704 {
705   vlib_buffer_main_t *bm = vm->buffer_main;
706   u32 physmem_map_index;
707   clib_error_t *error;
708
709   if (bm->log2_page_size == CLIB_MEM_PAGE_SZ_UNKNOWN)
710     {
711       error = vlib_buffer_main_init_numa_alloc (vm, numa_node,
712                                                 &physmem_map_index,
713                                                 CLIB_MEM_PAGE_SZ_DEFAULT_HUGE,
714                                                 0 /* unpriv */ );
715       if (!error)
716         goto buffer_pool_create;
717
718       /* If alloc failed, retry without hugepages */
719       vlib_log_warn (bm->log_default,
720                      "numa[%u] falling back to non-hugepage backed "
721                      "buffer pool (%U)", numa_node, format_clib_error, error);
722       clib_error_free (error);
723
724       error = vlib_buffer_main_init_numa_alloc (vm, numa_node,
725                                                 &physmem_map_index,
726                                                 CLIB_MEM_PAGE_SZ_DEFAULT,
727                                                 1 /* unpriv */ );
728     }
729   else
730     error = vlib_buffer_main_init_numa_alloc (vm, numa_node,
731                                               &physmem_map_index,
732                                               bm->log2_page_size,
733                                               0 /* unpriv */ );
734   if (error)
735     return error;
736
737 buffer_pool_create:
738   *index =
739     vlib_buffer_pool_create (vm, vlib_buffer_get_default_data_size (vm),
740                              physmem_map_index, "default-numa-%d", numa_node);
741
742   if (*index == (u8) ~ 0)
743     error = clib_error_return (0, "maximum number of buffer pools reached");
744
745
746   return error;
747 }
748
749 void
750 vlib_buffer_main_alloc (vlib_main_t * vm)
751 {
752   vlib_buffer_main_t *bm;
753
754   if (vm->buffer_main)
755     return;
756
757   vm->buffer_main = bm = clib_mem_alloc (sizeof (bm[0]));
758   clib_memset (vm->buffer_main, 0, sizeof (bm[0]));
759   bm->default_data_size = VLIB_BUFFER_DEFAULT_DATA_SIZE;
760 }
761
762 static u32
763 buffer_get_cached (vlib_buffer_pool_t * bp)
764 {
765   u32 cached = 0;
766   vlib_buffer_pool_thread_t *bpt;
767
768   clib_spinlock_lock (&bp->lock);
769
770   /* *INDENT-OFF* */
771   vec_foreach (bpt, bp->threads)
772     cached += bpt->n_cached;
773   /* *INDENT-ON* */
774
775   clib_spinlock_unlock (&bp->lock);
776
777   return cached;
778 }
779
780 static vlib_buffer_pool_t *
781 buffer_get_by_index (vlib_buffer_main_t * bm, u32 index)
782 {
783   vlib_buffer_pool_t *bp;
784   if (!bm->buffer_pools || vec_len (bm->buffer_pools) < index)
785     return 0;
786   bp = vec_elt_at_index (bm->buffer_pools, index);
787
788   return bp;
789 }
790
791 static void
792 buffer_gauges_collect_used_fn (vlib_stats_collector_data_t *d)
793 {
794   vlib_main_t *vm = vlib_get_main ();
795   vlib_buffer_pool_t *bp =
796     buffer_get_by_index (vm->buffer_main, d->private_data);
797   if (!bp)
798     return;
799
800   d->entry->value = bp->n_buffers - bp->n_avail - buffer_get_cached (bp);
801 }
802
803 static void
804 buffer_gauges_collect_available_fn (vlib_stats_collector_data_t *d)
805 {
806   vlib_main_t *vm = vlib_get_main ();
807   vlib_buffer_pool_t *bp =
808     buffer_get_by_index (vm->buffer_main, d->private_data);
809   if (!bp)
810     return;
811
812   d->entry->value = bp->n_avail;
813 }
814
815 static void
816 buffer_gauges_collect_cached_fn (vlib_stats_collector_data_t *d)
817 {
818   vlib_main_t *vm = vlib_get_main ();
819   vlib_buffer_pool_t *bp =
820     buffer_get_by_index (vm->buffer_main, d->private_data);
821   if (!bp)
822     return;
823
824   d->entry->value = buffer_get_cached (bp);
825 }
826
827 clib_error_t *
828 vlib_buffer_main_init (struct vlib_main_t * vm)
829 {
830   vlib_buffer_main_t *bm;
831   clib_error_t *err;
832   clib_bitmap_t *bmp = 0, *bmp_has_memory = 0;
833   u32 numa_node;
834   vlib_buffer_pool_t *bp;
835   u8 *name = 0, first_valid_buffer_pool_index = ~0;
836
837   vlib_buffer_main_alloc (vm);
838
839   bm = vm->buffer_main;
840   bm->log_default = vlib_log_register_class ("buffer", 0);
841   bm->ext_hdr_size = __vlib_buffer_external_hdr_size;
842
843   clib_spinlock_init (&bm->buffer_known_hash_lockp);
844
845   if ((err = clib_sysfs_read ("/sys/devices/system/node/online", "%U",
846                               unformat_bitmap_list, &bmp)))
847     clib_error_free (err);
848
849   if ((err = clib_sysfs_read ("/sys/devices/system/node/has_memory", "%U",
850                               unformat_bitmap_list, &bmp_has_memory)))
851     clib_error_free (err);
852
853   if (bmp && bmp_has_memory)
854     bmp = clib_bitmap_and (bmp, bmp_has_memory);
855
856   /* no info from sysfs, assuming that only numa 0 exists */
857   if (bmp == 0)
858     bmp = clib_bitmap_set (bmp, 0, 1);
859
860   if (clib_bitmap_last_set (bmp) >= VLIB_BUFFER_MAX_NUMA_NODES)
861     clib_panic ("system have more than %u NUMA nodes",
862                 VLIB_BUFFER_MAX_NUMA_NODES);
863
864   /* *INDENT-OFF* */
865   clib_bitmap_foreach (numa_node, bmp)
866     {
867       u8 *index = bm->default_buffer_pool_index_for_numa + numa_node;
868       index[0] = ~0;
869       if ((err = vlib_buffer_main_init_numa_node (vm, numa_node, index)))
870         {
871           clib_error_report (err);
872           clib_error_free (err);
873           continue;
874         }
875
876       if (first_valid_buffer_pool_index == 0xff)
877         first_valid_buffer_pool_index = index[0];
878     }
879   /* *INDENT-ON* */
880
881   if (first_valid_buffer_pool_index == (u8) ~ 0)
882     {
883       err = clib_error_return (0, "failed to allocate buffer pool(s)");
884       goto done;
885     }
886
887   /* *INDENT-OFF* */
888   clib_bitmap_foreach (numa_node, bmp)
889     {
890       if (bm->default_buffer_pool_index_for_numa[numa_node]  == (u8) ~0)
891         bm->default_buffer_pool_index_for_numa[numa_node] =
892           first_valid_buffer_pool_index;
893     }
894   /* *INDENT-ON* */
895
896   vec_foreach (bp, bm->buffer_pools)
897   {
898     vlib_stats_collector_reg_t reg = { .private_data = bp - bm->buffer_pools };
899     if (bp->n_buffers == 0)
900       continue;
901
902     reg.entry_index =
903       vlib_stats_add_gauge ("/buffer-pools/%s/cached", bp->name);
904     reg.collect_fn = buffer_gauges_collect_cached_fn;
905     vlib_stats_register_collector_fn (&reg);
906
907     reg.entry_index = vlib_stats_add_gauge ("/buffer-pools/%s/used", bp->name);
908     reg.collect_fn = buffer_gauges_collect_used_fn;
909     vlib_stats_register_collector_fn (&reg);
910
911     reg.entry_index =
912       vlib_stats_add_gauge ("/buffer-pools/%s/available", bp->name);
913     reg.collect_fn = buffer_gauges_collect_available_fn;
914     vlib_stats_register_collector_fn (&reg);
915   }
916
917 done:
918   vec_free (bmp);
919   vec_free (bmp_has_memory);
920   vec_free (name);
921   return err;
922 }
923
924 static clib_error_t *
925 vlib_buffers_configure (vlib_main_t * vm, unformat_input_t * input)
926 {
927   vlib_buffer_main_t *bm;
928
929   vlib_buffer_main_alloc (vm);
930
931   bm = vm->buffer_main;
932   bm->log2_page_size = CLIB_MEM_PAGE_SZ_UNKNOWN;
933
934   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
935     {
936       if (unformat (input, "buffers-per-numa %u", &bm->buffers_per_numa))
937         ;
938       else if (unformat (input, "page-size %U", unformat_log2_page_size,
939                          &bm->log2_page_size))
940         ;
941       else if (unformat (input, "default data-size %u",
942                          &bm->default_data_size))
943         ;
944       else
945         return unformat_parse_error (input);
946     }
947
948   unformat_free (input);
949   return 0;
950 }
951
952 VLIB_EARLY_CONFIG_FUNCTION (vlib_buffers_configure, "buffers");
953
954 #if VLIB_BUFFER_ALLOC_FAULT_INJECTOR > 0
955 u32
956 vlib_buffer_alloc_may_fail (vlib_main_t * vm, u32 n_buffers)
957 {
958   f64 r;
959
960   r = random_f64 (&vm->buffer_alloc_success_seed);
961
962   /* Fail this request? */
963   if (r > vm->buffer_alloc_success_rate)
964     n_buffers--;
965   /* 5% chance of returning nothing at all */
966   if (r > vm->buffer_alloc_success_rate && r > 0.95)
967     n_buffers = 0;
968
969   return n_buffers;
970 }
971 #endif
972
973 __clib_export int
974 vlib_buffer_set_alloc_free_callback (
975   vlib_main_t *vm, vlib_buffer_alloc_free_callback_t *alloc_callback_fn,
976   vlib_buffer_alloc_free_callback_t *free_callback_fn)
977 {
978   vlib_buffer_main_t *bm = vm->buffer_main;
979   if ((alloc_callback_fn && bm->alloc_callback_fn) ||
980       (free_callback_fn && bm->free_callback_fn))
981     return 1;
982   bm->alloc_callback_fn = alloc_callback_fn;
983   bm->free_callback_fn = free_callback_fn;
984   return 0;
985 }
986
987 /** @endcond */
988 /*
989  * fd.io coding-style-patch-verification: ON
990  *
991  * Local Variables:
992  * eval: (c-set-style "gnu")
993  * End:
994  */