svm vcl: allow random offsets for fifo segments in apps
[vpp.git] / src / svm / fifo_segment.c
1 /*
2  * Copyright (c) 2016-2019 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 #include <svm/fifo_segment.h>
17 #include <vppinfra/mem.h>
18
19 static inline void *
20 fsh_alloc_aligned (fifo_segment_header_t *fsh, uword size, uword align)
21 {
22   uword cur_pos, cur_pos_align, new_pos;
23
24   cur_pos = clib_atomic_load_relax_n (&fsh->byte_index);
25   cur_pos_align = round_pow2_u64 (cur_pos, align);
26   size = round_pow2_u64 (size, align);
27   new_pos = cur_pos_align + size;
28
29   if (new_pos >= fsh->max_byte_index)
30     return 0;
31
32   while (!clib_atomic_cmp_and_swap_acq_relax (&fsh->byte_index, &cur_pos,
33                                               &new_pos, 1 /* weak */))
34     {
35       cur_pos_align = round_pow2_u64 (cur_pos, align);
36       new_pos = cur_pos_align + size;
37       if (new_pos >= fsh->max_byte_index)
38         return 0;
39     }
40   return uword_to_pointer ((u8 *) fsh + cur_pos_align, void *);
41 }
42
43 static inline void *
44 fsh_alloc (fifo_segment_header_t *fsh, uword size)
45 {
46   return fsh_alloc_aligned (fsh, size, 8);
47 }
48
49 static inline fifo_segment_slice_t *
50 fsh_slice_get (fifo_segment_header_t * fsh, u32 slice_index)
51 {
52   return &fsh->slices[slice_index];
53 }
54
55 static inline fifo_slice_private_t *
56 fs_slice_private_get (fifo_segment_t *fs, u32 slice_index)
57 {
58   ASSERT (slice_index < fs->n_slices);
59   return &fs->slices[slice_index];
60 }
61
62 static char *fifo_segment_mem_status_strings[] = {
63 #define _(sym,str) str,
64   foreach_segment_mem_status
65 #undef _
66 };
67
68 static inline uword
69 fsh_n_free_bytes (fifo_segment_header_t * fsh)
70 {
71   uword cur_pos = clib_atomic_load_relax_n (&fsh->byte_index);
72   ASSERT (fsh->max_byte_index > cur_pos);
73   return fsh->max_byte_index - cur_pos;
74 }
75
76 static inline void
77 fsh_cached_bytes_add (fifo_segment_header_t * fsh, uword size)
78 {
79   clib_atomic_fetch_add_rel (&fsh->n_cached_bytes, size);
80 }
81
82 static inline void
83 fsh_cached_bytes_sub (fifo_segment_header_t * fsh, uword size)
84 {
85   clib_atomic_fetch_sub_rel (&fsh->n_cached_bytes, size);
86 }
87
88 static inline uword
89 fsh_n_cached_bytes (fifo_segment_header_t * fsh)
90 {
91   uword n_cached = clib_atomic_load_relax_n (&fsh->n_cached_bytes);
92   return n_cached;
93 }
94
95 static inline void
96 fsh_active_fifos_update (fifo_segment_header_t * fsh, int inc)
97 {
98   clib_atomic_fetch_add_rel (&fsh->n_active_fifos, inc);
99 }
100
101 static inline u32
102 fsh_n_active_fifos (fifo_segment_header_t * fsh)
103 {
104   return clib_atomic_load_relax_n (&fsh->n_active_fifos);
105 }
106
107 static inline uword
108 fsh_virtual_mem (fifo_segment_header_t * fsh)
109 {
110   fifo_segment_slice_t *fss;
111   uword total_vm = 0;
112   int i;
113
114   for (i = 0; i < fsh->n_slices; i++)
115     {
116       fss = fsh_slice_get (fsh, i);
117       total_vm += clib_atomic_load_relax_n (&fss->virtual_mem);
118     }
119   return total_vm;
120 }
121
122 void
123 fsh_virtual_mem_update (fifo_segment_header_t * fsh, u32 slice_index,
124                         int n_bytes)
125 {
126   fifo_segment_slice_t *fss = fsh_slice_get (fsh, slice_index);
127   fss->virtual_mem += n_bytes;
128 }
129
130 static inline void
131 fss_chunk_freelist_lock (fifo_segment_slice_t *fss)
132 {
133   u32 free = 0;
134   while (!clib_atomic_cmp_and_swap_acq_relax_n (&fss->chunk_lock, &free, 1, 0))
135     {
136       /* atomic load limits number of compare_exchange executions */
137       while (clib_atomic_load_relax_n (&fss->chunk_lock))
138         CLIB_PAUSE ();
139       /* on failure, compare_exchange writes (*p)->lock into free */
140       free = 0;
141     }
142 }
143
144 static inline void
145 fss_chunk_freelist_unlock (fifo_segment_slice_t *fss)
146 {
147   /* Make sure all reads/writes are complete before releasing the lock */
148   clib_atomic_release (&fss->chunk_lock);
149 }
150
151 static inline int
152 fss_chunk_fl_index_is_valid (fifo_segment_slice_t * fss, u32 fl_index)
153 {
154   return (fl_index < FS_CHUNK_VEC_LEN);
155 }
156
157 static void
158 fss_chunk_free_list_push (fifo_segment_header_t *fsh,
159                           fifo_segment_slice_t *fss, u32 fl_index,
160                           svm_fifo_chunk_t *c)
161 {
162   fss_chunk_freelist_lock (fss);
163   c->next = fss->free_chunks[fl_index];
164   fss->free_chunks[fl_index] = fs_chunk_sptr (fsh, c);
165   fss_chunk_freelist_unlock (fss);
166 }
167
168 static void
169 fss_chunk_free_list_push_list (fifo_segment_header_t *fsh,
170                                fifo_segment_slice_t *fss, u32 fl_index,
171                                svm_fifo_chunk_t *head, svm_fifo_chunk_t *tail)
172 {
173   fss_chunk_freelist_lock (fss);
174   tail->next = fss->free_chunks[fl_index];
175   fss->free_chunks[fl_index] = fs_chunk_sptr (fsh, head);
176   fss_chunk_freelist_unlock (fss);
177 }
178
179 static svm_fifo_chunk_t *
180 fss_chunk_free_list_pop (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss,
181                          u32 fl_index)
182 {
183   svm_fifo_chunk_t *c;
184
185   ASSERT (fss_chunk_fl_index_is_valid (fss, fl_index));
186
187   fss_chunk_freelist_lock (fss);
188
189   if (!fss->free_chunks[fl_index])
190     {
191       fss_chunk_freelist_unlock (fss);
192       return 0;
193     }
194
195   c = fs_chunk_ptr (fsh, fss->free_chunks[fl_index]);
196   fss->free_chunks[fl_index] = c->next;
197
198   fss_chunk_freelist_unlock (fss);
199
200   return c;
201 }
202
203 static inline void
204 pfss_fifo_add_active_list (fifo_slice_private_t *pfss, svm_fifo_t *f)
205 {
206   if (pfss->active_fifos)
207     {
208       pfss->active_fifos->prev = f;
209       f->next = pfss->active_fifos;
210     }
211   pfss->active_fifos = f;
212 }
213
214 static inline void
215 pfss_fifo_del_active_list (fifo_slice_private_t *pfss, svm_fifo_t *f)
216 {
217   if (f->flags & SVM_FIFO_F_LL_TRACKED)
218     {
219       if (f->prev)
220         f->prev->next = f->next;
221       else
222         pfss->active_fifos = f->next;
223       if (f->next)
224         f->next->prev = f->prev;
225     }
226 }
227
228 static inline uword
229 fss_fl_chunk_bytes (fifo_segment_slice_t * fss)
230 {
231   return clib_atomic_load_relax_n (&fss->n_fl_chunk_bytes);
232 }
233
234 static inline void
235 fss_fl_chunk_bytes_add (fifo_segment_slice_t * fss, uword size)
236 {
237   clib_atomic_fetch_add_relax (&fss->n_fl_chunk_bytes, size);
238 }
239
240 static inline void
241 fss_fl_chunk_bytes_sub (fifo_segment_slice_t * fss, uword size)
242 {
243   clib_atomic_fetch_sub_relax (&fss->n_fl_chunk_bytes, size);
244 }
245
246 /**
247  * Initialize fifo segment shared header
248  */
249 int
250 fifo_segment_init (fifo_segment_t * fs)
251 {
252   u32 align = 8, offset = 2 * 4096, slices_sz, i;
253   uword max_fifo, seg_start, seg_sz;
254   fifo_segment_header_t *fsh;
255   ssvm_shared_header_t *sh;
256   void *seg_data;
257
258   /* TODO remove ssvm heap entirely */
259   sh = fs->ssvm.sh;
260
261   seg_data = (u8 *) sh + offset;
262   seg_sz = sh->ssvm_size - offset;
263
264   fs->n_slices = clib_max (fs->n_slices, 1);
265   slices_sz = sizeof (fifo_segment_slice_t) * fs->n_slices;
266
267   seg_start = round_pow2_u64 (pointer_to_uword (seg_data), align);
268   fsh = uword_to_pointer (seg_start, void *);
269   memset (fsh, 0, sizeof (*fsh) + slices_sz);
270
271   fsh->byte_index = sizeof (*fsh) + slices_sz;
272   fsh->max_byte_index = seg_sz;
273   fsh->n_slices = fs->n_slices;
274   max_fifo = clib_min ((seg_sz - slices_sz) / 2, FIFO_SEGMENT_MAX_FIFO_SIZE);
275   fsh->max_log2_fifo_size = min_log2 (max_fifo);
276   fsh->n_cached_bytes = 0;
277   fsh->n_reserved_bytes = fsh->byte_index;
278   ASSERT (fsh->max_byte_index <= sh->ssvm_size - offset);
279
280   fs->max_byte_index = fsh->max_byte_index;
281   fs->h = fsh;
282   sh->opaque[0] = (void *) ((u8 *) fsh - (u8 *) fs->ssvm.sh);
283
284   /* Allow random offsets */
285   fs->ssvm.sh->ssvm_va = 0;
286
287   vec_validate (fs->slices, fs->n_slices - 1);
288   for (i = 0; i < fs->n_slices; i++)
289     fs->slices[i].fifos =
290       clib_mem_bulk_init (sizeof (svm_fifo_t), CLIB_CACHE_LINE_BYTES, 32);
291
292   sh->ready = 1;
293   return (0);
294 }
295
296 /**
297  * Create a fifo segment and initialize as master
298  */
299 int
300 fifo_segment_create (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
301 {
302   fifo_segment_t *fs;
303   uword baseva;
304   int rv;
305
306   /* Allocate a fresh segment */
307   pool_get_zero (sm->segments, fs);
308
309   baseva = a->segment_type == SSVM_SEGMENT_PRIVATE ? ~0ULL : sm->next_baseva;
310   fs->ssvm.ssvm_size = a->segment_size;
311   fs->ssvm.is_server = 1;
312   fs->ssvm.my_pid = getpid ();
313   fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
314   fs->ssvm.requested_va = baseva;
315
316   if ((rv = ssvm_server_init (&fs->ssvm, a->segment_type)))
317     {
318       pool_put (sm->segments, fs);
319       return (rv);
320     }
321
322   /* Note: requested_va updated due to seg base addr randomization */
323   sm->next_baseva = fs->ssvm.sh->ssvm_va + fs->ssvm.ssvm_size;
324
325   fifo_segment_init (fs);
326   vec_add1 (a->new_segment_indices, fs - sm->segments);
327   return (0);
328 }
329
330 /**
331  * Attach as slave to a fifo segment
332  */
333 int
334 fifo_segment_attach (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
335 {
336   fifo_segment_header_t *fsh;
337   fifo_segment_t *fs;
338   int rv;
339
340   pool_get_zero (sm->segments, fs);
341
342   fs->ssvm.ssvm_size = a->segment_size;
343   fs->ssvm.my_pid = getpid ();
344   fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
345   fs->ssvm.requested_va = 0;
346   if (a->segment_type == SSVM_SEGMENT_MEMFD)
347     fs->ssvm.fd = a->memfd_fd;
348   else
349     fs->ssvm.attach_timeout = sm->timeout_in_seconds;
350
351   if ((rv = ssvm_client_init (&fs->ssvm, a->segment_type)))
352     {
353       pool_put (sm->segments, fs);
354       return (rv);
355     }
356
357   /* Probably a segment without fifos */
358   if (!fs->ssvm.sh->opaque[0])
359     goto done;
360
361   fsh = fs->h = (void *) fs->ssvm.sh + (uword) fs->ssvm.sh->opaque[0];
362   fs->max_byte_index = fsh->max_byte_index;
363   vec_validate (fs->slices, 0);
364   fs->slices[0].fifos =
365     clib_mem_bulk_init (sizeof (svm_fifo_t), CLIB_CACHE_LINE_BYTES, 32);
366
367 done:
368   vec_add1 (a->new_segment_indices, fs - sm->segments);
369   return (0);
370 }
371
372 void
373 fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * s)
374 {
375   fifo_segment_cleanup (s);
376   ssvm_delete (&s->ssvm);
377   clib_memset (s, 0xfe, sizeof (*s));
378   pool_put (sm->segments, s);
379 }
380
381 u32
382 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * s)
383 {
384   return s - sm->segments;
385 }
386
387 fifo_segment_t *
388 fifo_segment_get_segment (fifo_segment_main_t * sm, u32 segment_index)
389 {
390   return pool_elt_at_index (sm->segments, segment_index);
391 }
392
393 void
394 fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size)
395 {
396   *address = (char *) seg->ssvm.sh->ssvm_va;
397   *size = seg->ssvm.ssvm_size;
398 }
399
400 void
401 fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
402                         u32 timeout_in_seconds)
403 {
404   sm->next_baseva = baseva;
405   sm->timeout_in_seconds = timeout_in_seconds;
406 }
407
408 static inline u32
409 fs_freelist_for_size (u32 size)
410 {
411   if (PREDICT_FALSE (size < FIFO_SEGMENT_MIN_FIFO_SIZE))
412     return 0;
413   return clib_min (max_log2 (size) - FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE,
414                    FS_CHUNK_VEC_LEN - 1);
415 }
416
417 static inline u32
418 fs_freelist_index_to_size (u32 fl_index)
419 {
420   return 1 << (fl_index + FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE);
421 }
422
423 static inline int
424 fs_chunk_size_is_valid (fifo_segment_header_t * fsh, u32 size)
425 {
426   /*
427    * 4K minimum. It's not likely that anything good will happen
428    * with a smaller FIFO.
429    */
430   return size >= FIFO_SEGMENT_MIN_FIFO_SIZE &&
431          size <= (1ULL << fsh->max_log2_fifo_size);
432 }
433
434 svm_fifo_chunk_t *
435 fs_try_alloc_multi_chunk (fifo_segment_header_t * fsh,
436                           fifo_segment_slice_t * fss, u32 data_bytes)
437 {
438   u32 fl_index, fl_size, n_alloc = 0, req_bytes = data_bytes;
439   svm_fifo_chunk_t *c, *first = 0, *next;
440
441   fl_index = fs_freelist_for_size (req_bytes);
442   if (fl_index > 0)
443     fl_index -= 1;
444
445   fl_size = fs_freelist_index_to_size (fl_index);
446
447   while (req_bytes)
448     {
449       c = fss_chunk_free_list_pop (fsh, fss, fl_index);
450       if (c)
451         {
452           c->next = fs_chunk_sptr (fsh, first);
453           first = c;
454           n_alloc += fl_size;
455           req_bytes -= clib_min (fl_size, req_bytes);
456         }
457       else
458         {
459           /* Failed to allocate with smaller chunks */
460           if (fl_index == 0)
461             {
462               /* Free all chunks if any allocated */
463               c = first;
464               while (c)
465                 {
466                   fl_index = fs_freelist_for_size (c->length);
467                   next = fs_chunk_ptr (fsh, c->next);
468                   fss_chunk_free_list_push (fsh, fss, fl_index, c);
469                   c = next;
470                 }
471               n_alloc = 0;
472               first = 0;
473               /* As last attempt, try allocating a chunk larger than
474                * the requested size, if possible */
475               fl_index = fs_freelist_for_size (data_bytes) + 1;
476               if (!fss_chunk_fl_index_is_valid (fss, fl_index))
477                 return 0;
478               first = fss_chunk_free_list_pop (fsh, fss, fl_index);
479               if (first)
480                 {
481                   first->next = 0;
482                   n_alloc = fs_freelist_index_to_size (fl_index);
483                   goto done;
484                 }
485               return 0;
486             }
487           fl_index -= 1;
488           fl_size = fl_size >> 1;
489         }
490     }
491
492 done:
493   fss_fl_chunk_bytes_sub (fss, n_alloc);
494   fsh_cached_bytes_sub (fsh, n_alloc);
495   return first;
496 }
497
498 static int
499 fsh_try_alloc_fifo_hdr_batch (fifo_segment_header_t * fsh,
500                               fifo_segment_slice_t * fss, u32 batch_size)
501 {
502   svm_fifo_shared_t *f;
503   uword size;
504   u8 *fmem;
505   int i;
506
507   ASSERT (batch_size != 0);
508
509   size = (uword) sizeof (*f) * batch_size;
510
511   fmem = fsh_alloc_aligned (fsh, size, CLIB_CACHE_LINE_BYTES);
512   if (fmem == 0)
513     return -1;
514
515   /* Carve fifo hdr space */
516   for (i = 0; i < batch_size; i++)
517     {
518       f = (svm_fifo_shared_t *) fmem;
519       memset (f, 0, sizeof (*f));
520       f->next = fss->free_fifos;
521       fss->free_fifos = f;
522       fmem += sizeof (*f);
523     }
524
525   return 0;
526 }
527
528 static int
529 fsh_try_alloc_chunk_batch (fifo_segment_header_t * fsh,
530                            fifo_segment_slice_t * fss,
531                            u32 fl_index, u32 batch_size)
532 {
533   svm_fifo_chunk_t *c, *head = 0, *tail;
534   uword size, total_chunk_bytes;
535   u32 rounded_data_size;
536   u8 *cmem;
537   int i;
538
539   ASSERT (batch_size != 0);
540
541   rounded_data_size = fs_freelist_index_to_size (fl_index);
542   total_chunk_bytes = (uword) batch_size *rounded_data_size;
543   size = (uword) (sizeof (*c) + rounded_data_size) * batch_size;
544
545   cmem = fsh_alloc_aligned (fsh, size, 8 /* chunk hdr is 24B */);
546   if (cmem == 0)
547     return -1;
548
549   /* Carve fifo + chunk space */
550   tail = c = (svm_fifo_chunk_t *) cmem;
551   for (i = 0; i < batch_size; i++)
552     {
553       c->start_byte = 0;
554       c->length = rounded_data_size;
555       c->next = fs_chunk_sptr (fsh, head);
556       head = c;
557       cmem += sizeof (*c) + rounded_data_size;
558       c = (svm_fifo_chunk_t *) cmem;
559     }
560
561   fss_chunk_free_list_push_list (fsh, fss, fl_index, head, tail);
562   fss->num_chunks[fl_index] += batch_size;
563   fss_fl_chunk_bytes_add (fss, total_chunk_bytes);
564   fsh_cached_bytes_add (fsh, total_chunk_bytes);
565
566   return 0;
567 }
568
569 static int
570 fs_try_alloc_fifo_batch (fifo_segment_header_t * fsh,
571                          fifo_segment_slice_t * fss,
572                          u32 fl_index, u32 batch_size)
573 {
574   if (fsh_try_alloc_fifo_hdr_batch (fsh, fss, batch_size))
575     return 0;
576   return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
577 }
578
579 static svm_fifo_shared_t *
580 fsh_try_alloc_fifo_hdr (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss)
581 {
582   svm_fifo_shared_t *f;
583
584   if (!fss->free_fifos)
585     {
586       if (fsh_try_alloc_fifo_hdr_batch (fsh, fss,
587                                         FIFO_SEGMENT_ALLOC_BATCH_SIZE))
588         return 0;
589     }
590
591   f = fss->free_fifos;
592   fss->free_fifos = f->next;
593   memset (f, 0, sizeof (*f));
594   return f;
595 }
596
597 static svm_fifo_chunk_t *
598 fsh_try_alloc_chunk (fifo_segment_header_t * fsh,
599                      fifo_segment_slice_t * fss, u32 data_bytes)
600 {
601   svm_fifo_chunk_t *c;
602   u32 fl_index;
603
604   fl_index = fs_freelist_for_size (data_bytes);
605
606 free_list:
607   c = fss_chunk_free_list_pop (fsh, fss, fl_index);
608   if (c)
609     {
610       c->next = 0;
611       fss_fl_chunk_bytes_sub (fss, fs_freelist_index_to_size (fl_index));
612       fsh_cached_bytes_sub (fsh, fs_freelist_index_to_size (fl_index));
613     }
614   else
615     {
616       u32 chunk_size, batch = FIFO_SEGMENT_ALLOC_BATCH_SIZE;
617       uword n_free;
618
619       chunk_size = fs_freelist_index_to_size (fl_index);
620       n_free = fsh_n_free_bytes (fsh);
621
622       if (chunk_size <= n_free)
623         {
624           batch = chunk_size * batch <= n_free ? batch : 1;
625           if (!fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch))
626             goto free_list;
627         }
628       /* Failed to allocate larger chunk, try to allocate multi-chunk
629        * that is close to what was actually requested */
630       if (data_bytes <= fss_fl_chunk_bytes (fss))
631         {
632           c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
633           if (c)
634             goto done;
635           batch = n_free / FIFO_SEGMENT_MIN_FIFO_SIZE;
636           if (!batch || fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
637             goto done;
638         }
639       if (data_bytes <= fss_fl_chunk_bytes (fss) + n_free)
640         {
641           u32 min_size = FIFO_SEGMENT_MIN_FIFO_SIZE;
642
643           batch = (data_bytes - fss_fl_chunk_bytes (fss)) / min_size;
644           batch = clib_min (batch + 1, n_free / min_size);
645           if (fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
646             goto done;
647           c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
648         }
649     }
650
651 done:
652
653   return c;
654 }
655
656 /**
657  * Try to allocate new fifo
658  *
659  * Tries the following steps in order:
660  * - grab fifo and chunk from freelists
661  * - batch fifo and chunk allocation
662  * - single fifo allocation
663  * - grab multiple fifo chunks from freelists
664  */
665 static svm_fifo_shared_t *
666 fs_try_alloc_fifo (fifo_segment_header_t *fsh, u32 slice_index, u32 data_bytes)
667 {
668   fifo_segment_slice_t *fss;
669   u32 fl_index, min_size;
670   svm_fifo_chunk_t *c;
671   svm_fifo_shared_t *sf = 0;
672
673   fss = fsh_slice_get (fsh, slice_index);
674   min_size = clib_max ((fsh->pct_first_alloc * data_bytes) / 100, 4096);
675   fl_index = fs_freelist_for_size (min_size);
676
677   if (!fss_chunk_fl_index_is_valid (fss, fl_index))
678     return 0;
679
680   sf = fsh_try_alloc_fifo_hdr (fsh, fss);
681   if (!sf)
682     return 0;
683
684   c = fsh_try_alloc_chunk (fsh, fss, min_size);
685   if (!c)
686     {
687       sf->next = fss->free_fifos;
688       fss->free_fifos = sf;
689       return 0;
690     }
691
692   sf->start_chunk = fs_chunk_sptr (fsh, c);
693   while (c->next)
694     c = fs_chunk_ptr (fsh, c->next);
695   sf->end_chunk = fs_chunk_sptr (fsh, c);
696   sf->size = data_bytes;
697   sf->slice_index = slice_index;
698
699   return sf;
700 }
701
702 svm_fifo_chunk_t *
703 fsh_alloc_chunk (fifo_segment_header_t * fsh, u32 slice_index, u32 chunk_size)
704 {
705   fifo_segment_slice_t *fss;
706   svm_fifo_chunk_t *c;
707
708   fss = fsh_slice_get (fsh, slice_index);
709   c = fsh_try_alloc_chunk (fsh, fss, chunk_size);
710
711   return c;
712 }
713
714 static void
715 fsh_slice_collect_chunks (fifo_segment_header_t * fsh,
716                           fifo_segment_slice_t * fss, svm_fifo_chunk_t * c)
717 {
718   u32 n_collect = 0, fl_index;
719   svm_fifo_chunk_t *next;
720
721   while (c)
722     {
723       CLIB_MEM_UNPOISON (c, sizeof (*c));
724       next = fs_chunk_ptr (fsh, c->next);
725       fl_index = fs_freelist_for_size (c->length);
726       fss_chunk_free_list_push (fsh, fss, fl_index, c);
727       n_collect += fs_freelist_index_to_size (fl_index);
728       c = next;
729     }
730
731   fss_fl_chunk_bytes_add (fss, n_collect);
732   fsh_cached_bytes_add (fsh, n_collect);
733 }
734
735 void
736 fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
737                     svm_fifo_chunk_t * c)
738 {
739   fifo_segment_slice_t *fss;
740   fss = fsh_slice_get (fsh, slice_index);
741   fsh_slice_collect_chunks (fsh, fss, c);
742 }
743
744 svm_fifo_t *
745 fs_fifo_alloc (fifo_segment_t *fs, u32 slice_index)
746 {
747   fifo_slice_private_t *pfss = &fs->slices[slice_index];
748   svm_fifo_t *f;
749
750   f = clib_mem_bulk_alloc (pfss->fifos);
751   clib_memset (f, 0, sizeof (*f));
752   return f;
753 }
754
755 void
756 fs_fifo_free (fifo_segment_t *fs, svm_fifo_t *f)
757 {
758   u32 slice_index = f->shr->slice_index;
759   fifo_slice_private_t *pfss;
760
761   pfss = &fs->slices[slice_index];
762   clib_mem_bulk_free (pfss->fifos, f);
763 }
764
765 void
766 fifo_segment_cleanup (fifo_segment_t *fs)
767 {
768   int slice_index;
769   svm_msg_q_t *mq = 0;
770
771   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
772     clib_mem_bulk_destroy (fs->slices[slice_index].fifos);
773
774   vec_foreach (fs->mqs, mq)
775     vec_free (mq->rings);
776
777   vec_free (fs->mqs);
778 }
779
780 /**
781  * Allocate fifo in fifo segment
782  */
783 svm_fifo_t *
784 fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs, u32 slice_index,
785                                  u32 data_bytes, fifo_segment_ftype_t ftype)
786 {
787   fifo_segment_header_t *fsh = fs->h;
788   fifo_slice_private_t *pfss;
789   fifo_segment_slice_t *fss;
790   svm_fifo_shared_t *sf;
791   svm_fifo_t *f = 0;
792
793   ASSERT (slice_index < fs->n_slices);
794
795   if (PREDICT_FALSE (data_bytes > 1 << fsh->max_log2_fifo_size))
796     return 0;
797
798   sf = fs_try_alloc_fifo (fsh, slice_index, data_bytes);
799   if (!sf)
800     goto done;
801
802   f = fs_fifo_alloc (fs, slice_index);
803   f->fs_hdr = fsh;
804   f->shr = sf;
805
806   svm_fifo_init (f, data_bytes);
807
808   fss = fsh_slice_get (fsh, slice_index);
809   pfss = fs_slice_private_get (fs, slice_index);
810
811   /* If rx fifo type add to active fifos list. When cleaning up segment,
812    * we need a list of active sessions that should be disconnected. Since
813    * both rx and tx fifos keep pointers to the session, it's enough to track
814    * only one. */
815   if (ftype == FIFO_SEGMENT_RX_FIFO)
816     {
817       pfss_fifo_add_active_list (pfss, f);
818       f->flags |= SVM_FIFO_F_LL_TRACKED;
819     }
820
821   fsh_active_fifos_update (fsh, 1);
822   fss->virtual_mem += svm_fifo_size (f);
823
824 done:
825   return (f);
826 }
827
828 svm_fifo_t *
829 fifo_segment_alloc_fifo_w_offset (fifo_segment_t *fs, uword offset)
830 {
831   svm_fifo_t *f = fs_fifo_alloc (fs, 0);
832   svm_fifo_shared_t *sf;
833
834   sf = (svm_fifo_shared_t *) ((u8 *) fs->h + offset);
835   f->fs_hdr = fs->h;
836   f->shr = sf;
837
838   f->ooos_list_head = OOO_SEGMENT_INVALID_INDEX;
839   f->segment_index = SVM_FIFO_INVALID_INDEX;
840   f->refcnt = 1;
841   return f;
842 }
843
844 /**
845  * Free fifo allocated in fifo segment
846  */
847 void
848 fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f)
849 {
850   fifo_segment_header_t *fsh = fs->h;
851   fifo_slice_private_t *pfss;
852   fifo_segment_slice_t *fss;
853   svm_fifo_shared_t *sf;
854
855   ASSERT (f->refcnt > 0);
856
857   if (--f->refcnt > 0)
858     return;
859
860   /*
861    * Cleanup shared state
862    */
863
864   sf = f->shr;
865   fss = fsh_slice_get (fsh, sf->slice_index);
866   pfss = fs_slice_private_get (fs, sf->slice_index);
867
868   /* Free fifo chunks */
869   fsh_slice_collect_chunks (fsh, fss, fs_chunk_ptr (fsh, f->shr->start_chunk));
870
871   sf->start_chunk = sf->end_chunk = 0;
872   sf->head_chunk = sf->tail_chunk = 0;
873
874   /* Add to free list */
875   sf->next = fss->free_fifos;
876   fss->free_fifos = sf;
877
878   fss->virtual_mem -= svm_fifo_size (f);
879
880   /*
881    *  Cleanup private state
882    */
883
884   /* Remove from active list. Only rx fifos are tracked */
885   if (f->flags & SVM_FIFO_F_LL_TRACKED)
886     {
887       pfss_fifo_del_active_list (pfss, f);
888       f->flags &= ~SVM_FIFO_F_LL_TRACKED;
889     }
890
891   svm_fifo_free_chunk_lookup (f);
892   svm_fifo_free_ooo_data (f);
893
894   if (CLIB_DEBUG)
895     {
896       sf->master_session_index = ~0;
897       f->master_thread_index = ~0;
898     }
899
900   f->ooo_enq = f->ooo_deq = 0;
901   f->prev = 0;
902
903   fs_fifo_free (fs, f);
904
905   fsh_active_fifos_update (fsh, -1);
906 }
907
908 void
909 fifo_segment_detach_fifo (fifo_segment_t * fs, svm_fifo_t * f)
910 {
911   fifo_slice_private_t *pfss;
912   fifo_segment_slice_t *fss;
913   svm_fifo_chunk_t *c;
914   u32 fl_index;
915
916   ASSERT (f->refcnt == 1);
917
918   fss = fsh_slice_get (fs->h, f->shr->slice_index);
919   pfss = fs_slice_private_get (fs, f->shr->slice_index);
920   fss->virtual_mem -= svm_fifo_size (f);
921   if (f->flags & SVM_FIFO_F_LL_TRACKED)
922     pfss_fifo_del_active_list (pfss, f);
923
924   c = fs_chunk_ptr (fs->h, f->shr->start_chunk);
925   while (c)
926     {
927       fl_index = fs_freelist_for_size (c->length);
928       clib_atomic_fetch_sub_rel (&fss->num_chunks[fl_index], 1);
929       c = fs_chunk_ptr (fs->h, c->next);
930     }
931 }
932
933 void
934 fifo_segment_attach_fifo (fifo_segment_t * fs, svm_fifo_t * f,
935                           u32 slice_index)
936 {
937   fifo_slice_private_t *pfss;
938   fifo_segment_slice_t *fss;
939   svm_fifo_chunk_t *c;
940   u32 fl_index;
941
942   f->shr->slice_index = slice_index;
943   fss = fsh_slice_get (fs->h, f->shr->slice_index);
944   pfss = fs_slice_private_get (fs, f->shr->slice_index);
945   fss->virtual_mem += svm_fifo_size (f);
946   if (f->flags & SVM_FIFO_F_LL_TRACKED)
947     pfss_fifo_add_active_list (pfss, f);
948
949   c = fs_chunk_ptr (fs->h, f->shr->start_chunk);
950   while (c)
951     {
952       fl_index = fs_freelist_for_size (c->length);
953       clib_atomic_fetch_add_rel (&fss->num_chunks[fl_index], 1);
954       c = fs_chunk_ptr (fs->h, c->next);
955     }
956 }
957
958 uword
959 fifo_segment_fifo_offset (svm_fifo_t *f)
960 {
961   return (u8 *) f->shr - (u8 *) f->fs_hdr;
962 }
963
964 svm_msg_q_t *
965 fifo_segment_msg_q_alloc (fifo_segment_t *fs, u32 mq_index,
966                           svm_msg_q_cfg_t *cfg)
967 {
968   fifo_segment_header_t *fsh = fs->h;
969   svm_msg_q_shared_t *smq;
970   svm_msg_q_t *mq;
971   void *base;
972   u32 size;
973
974   if (!fs->mqs)
975     {
976       u32 n_mqs = clib_max (fs->h->n_mqs, 1);
977       vec_validate (fs->mqs, n_mqs - 1);
978     }
979
980   size = svm_msg_q_size_to_alloc (cfg);
981   base = fsh_alloc_aligned (fsh, size, 8);
982   fsh->n_reserved_bytes += size;
983
984   smq = svm_msg_q_init (base, cfg);
985   mq = vec_elt_at_index (fs->mqs, mq_index);
986   svm_msg_q_attach (mq, smq);
987
988   return mq;
989 }
990
991 svm_msg_q_t *
992 fifo_segment_msg_q_attach (fifo_segment_t *fs, uword offset, u32 mq_index)
993 {
994   svm_msg_q_t *mq;
995
996   if (!fs->mqs)
997     {
998       u32 n_mqs = clib_max (fs->h->n_mqs, 1);
999       vec_validate (fs->mqs, n_mqs - 1);
1000     }
1001
1002   mq = vec_elt_at_index (fs->mqs, mq_index);
1003
1004   if (!mq->q)
1005     {
1006       svm_msg_q_shared_t *smq;
1007       smq = (svm_msg_q_shared_t *) ((u8 *) fs->h + offset);
1008       svm_msg_q_attach (mq, smq);
1009     }
1010
1011   ASSERT (fifo_segment_msg_q_offset (fs, mq_index) == offset);
1012
1013   return mq;
1014 }
1015
1016 uword
1017 fifo_segment_msg_q_offset (fifo_segment_t *fs, u32 mq_index)
1018 {
1019   svm_msg_q_t *mq = vec_elt_at_index (fs->mqs, mq_index);
1020
1021   if (mq->q == 0)
1022     return ~0ULL;
1023
1024   return (uword) ((u8 *) mq->q - (u8 *) fs->h) - sizeof (svm_msg_q_shared_t);
1025 }
1026
1027 int
1028 fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
1029                                  u32 batch_size)
1030 {
1031   fifo_segment_header_t *fsh = fs->h;
1032   fifo_segment_slice_t *fss;
1033
1034   fss = fsh_slice_get (fsh, slice_index);
1035   return fsh_try_alloc_fifo_hdr_batch (fsh, fss, batch_size);
1036 }
1037
1038 int
1039 fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
1040                                    u32 chunk_size, u32 batch_size)
1041 {
1042   fifo_segment_header_t *fsh = fs->h;
1043   fifo_segment_slice_t *fss;
1044   u32 fl_index;
1045
1046   if (!fs_chunk_size_is_valid (fsh, chunk_size))
1047     {
1048       clib_warning ("chunk size out of range %d", chunk_size);
1049       return -1;
1050     }
1051
1052   fl_index = fs_freelist_for_size (chunk_size);
1053   fss = fsh_slice_get (fsh, slice_index);
1054
1055   return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
1056 }
1057
1058 /**
1059  * Pre-allocates fifo pairs in fifo segment
1060  */
1061 void
1062 fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
1063                                      u32 rx_fifo_size, u32 tx_fifo_size,
1064                                      u32 * n_fifo_pairs)
1065 {
1066   u32 rx_rounded_data_size, tx_rounded_data_size, pair_size, pairs_to_alloc;
1067   u32 hdrs, pairs_per_slice, alloc_now;
1068   fifo_segment_header_t *fsh = fs->h;
1069   int rx_fl_index, tx_fl_index, i;
1070   fifo_segment_slice_t *fss;
1071   uword space_available;
1072
1073   /* Parameter check */
1074   if (rx_fifo_size == 0 || tx_fifo_size == 0 || *n_fifo_pairs == 0)
1075     return;
1076
1077   if (!fs_chunk_size_is_valid (fsh, rx_fifo_size))
1078     {
1079       clib_warning ("rx fifo_size out of range %d", rx_fifo_size);
1080       return;
1081     }
1082
1083   if (!fs_chunk_size_is_valid (fsh, tx_fifo_size))
1084     {
1085       clib_warning ("tx fifo_size out of range %d", tx_fifo_size);
1086       return;
1087     }
1088
1089   rx_rounded_data_size = (1 << (max_log2 (rx_fifo_size)));
1090   rx_fl_index = fs_freelist_for_size (rx_fifo_size);
1091   tx_rounded_data_size = (1 << (max_log2 (tx_fifo_size)));
1092   tx_fl_index = fs_freelist_for_size (tx_fifo_size);
1093
1094   hdrs = sizeof (svm_fifo_t) + sizeof (svm_fifo_chunk_t);
1095
1096   /* Calculate space requirements */
1097   pair_size = 2 * hdrs + rx_rounded_data_size + tx_rounded_data_size;
1098   space_available = fsh_n_free_bytes (fsh);
1099   pairs_to_alloc = space_available / pair_size;
1100   pairs_to_alloc = clib_min (pairs_to_alloc, *n_fifo_pairs);
1101   pairs_per_slice = pairs_to_alloc / fs->n_slices;
1102   pairs_per_slice += pairs_to_alloc % fs->n_slices ? 1 : 0;
1103
1104   if (!pairs_per_slice)
1105     return;
1106
1107   for (i = 0; i < fs->n_slices; i++)
1108     {
1109       alloc_now = clib_min (pairs_per_slice, *n_fifo_pairs);
1110       if (0 == alloc_now)
1111         break;
1112
1113       fss = fsh_slice_get (fsh, i);
1114       if (fs_try_alloc_fifo_batch (fsh, fss, rx_fl_index, alloc_now))
1115         clib_warning ("rx prealloc failed: pairs %u", alloc_now);
1116       if (fs_try_alloc_fifo_batch (fsh, fss, tx_fl_index, alloc_now))
1117         clib_warning ("tx prealloc failed: pairs %u", alloc_now);
1118
1119       /* Account for the pairs allocated */
1120       *n_fifo_pairs -= alloc_now;
1121     }
1122 }
1123
1124 /**
1125  * Get number of active fifos
1126  */
1127 u32
1128 fifo_segment_num_fifos (fifo_segment_t * fs)
1129 {
1130   return fsh_n_active_fifos (fs->h);
1131 }
1132
1133 static u32
1134 fs_slice_num_free_fifos (fifo_segment_slice_t * fss)
1135 {
1136   svm_fifo_shared_t *f;
1137   u32 count = 0;
1138
1139   f = fss->free_fifos;
1140   if (f == 0)
1141     return 0;
1142
1143   while (f)
1144     {
1145       f = f->next;
1146       count++;
1147     }
1148   return count;
1149 }
1150
1151 u32
1152 fifo_segment_num_free_fifos (fifo_segment_t * fs)
1153 {
1154   fifo_segment_header_t *fsh = fs->h;
1155   fifo_segment_slice_t *fss;
1156   int slice_index;
1157   u32 count = 0;
1158
1159   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1160     {
1161       fss = fsh_slice_get (fsh, slice_index);
1162       count += fs_slice_num_free_fifos (fss);
1163     }
1164   return count;
1165 }
1166
1167 static u32
1168 fs_slice_num_free_chunks (fifo_segment_header_t *fsh,
1169                           fifo_segment_slice_t *fss, u32 size)
1170 {
1171   u32 count = 0, rounded_size, fl_index;
1172   svm_fifo_chunk_t *c;
1173   int i;
1174
1175   /* Count all free chunks? */
1176   if (size == ~0)
1177     {
1178       for (i = 0; i < FS_CHUNK_VEC_LEN; i++)
1179         {
1180           c = fs_chunk_ptr (fsh, fss->free_chunks[i]);
1181           if (c == 0)
1182             continue;
1183
1184           while (c)
1185             {
1186               c = fs_chunk_ptr (fsh, c->next);
1187               count++;
1188             }
1189         }
1190       return count;
1191     }
1192
1193   rounded_size = (1 << (max_log2 (size)));
1194   fl_index = fs_freelist_for_size (rounded_size);
1195
1196   if (fl_index >= FS_CHUNK_VEC_LEN)
1197     return 0;
1198
1199   c = fs_chunk_ptr (fsh, fss->free_chunks[fl_index]);
1200   if (c == 0)
1201     return 0;
1202
1203   while (c)
1204     {
1205       c = fs_chunk_ptr (fsh, c->next);
1206       count++;
1207     }
1208   return count;
1209 }
1210
1211 u32
1212 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size)
1213 {
1214   fifo_segment_header_t *fsh = fs->h;
1215   fifo_segment_slice_t *fss;
1216   int slice_index;
1217   u32 count = 0;
1218
1219   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1220     {
1221       fss = fsh_slice_get (fsh, slice_index);
1222       count += fs_slice_num_free_chunks (fsh, fss, size);
1223     }
1224   return count;
1225 }
1226
1227 uword
1228 fifo_segment_size (fifo_segment_t * fs)
1229 {
1230   return fs->h->max_byte_index - fs->h->n_reserved_bytes;
1231 }
1232
1233 u8
1234 fsh_has_reached_mem_limit (fifo_segment_header_t * fsh)
1235 {
1236   return (fsh->flags & FIFO_SEGMENT_F_MEM_LIMIT) ? 1 : 0;
1237 }
1238
1239 void
1240 fsh_reset_mem_limit (fifo_segment_header_t * fsh)
1241 {
1242   fsh->flags &= ~FIFO_SEGMENT_F_MEM_LIMIT;
1243 }
1244
1245 void *
1246 fifo_segment_alloc (fifo_segment_t *fs, uword size)
1247 {
1248   void *rv = fsh_alloc (fs->h, size);
1249   /* Mark externally allocated bytes as reserved. This helps
1250    * @ref fifo_segment_size report bytes used only for fifos */
1251   fs->h->n_reserved_bytes += size;
1252   return rv;
1253 }
1254
1255 uword
1256 fifo_segment_free_bytes (fifo_segment_t * fs)
1257 {
1258   return fsh_n_free_bytes (fs->h);
1259 }
1260
1261 uword
1262 fifo_segment_cached_bytes (fifo_segment_t * fs)
1263 {
1264   return fsh_n_cached_bytes (fs->h);
1265 }
1266
1267 uword
1268 fifo_segment_available_bytes (fifo_segment_t * fs)
1269 {
1270   return fsh_n_free_bytes (fs->h) + fsh_n_cached_bytes (fs->h);
1271 }
1272
1273 uword
1274 fifo_segment_fl_chunk_bytes (fifo_segment_t * fs)
1275 {
1276   fifo_segment_header_t *fsh = fs->h;
1277   fifo_segment_slice_t *fss;
1278   uword n_bytes = 0;
1279   int slice_index;
1280
1281   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1282     {
1283       fss = fsh_slice_get (fsh, slice_index);
1284       n_bytes += fss_fl_chunk_bytes (fss);
1285     }
1286
1287   return n_bytes;
1288 }
1289
1290 u8
1291 fifo_segment_has_fifos (fifo_segment_t * fs)
1292 {
1293   return (fsh_n_active_fifos (fs->h) != 0);
1294 }
1295
1296 svm_fifo_t *
1297 fifo_segment_get_slice_fifo_list (fifo_segment_t * fs, u32 slice_index)
1298 {
1299   fifo_slice_private_t *pfss;
1300
1301   pfss = fs_slice_private_get (fs, slice_index);
1302   return pfss->active_fifos;
1303 }
1304
1305 u8
1306 fifo_segment_get_mem_usage (fifo_segment_t * fs)
1307 {
1308   uword size, in_use;
1309
1310   size = fifo_segment_size (fs);
1311   in_use =
1312     size - fifo_segment_free_bytes (fs) - fifo_segment_cached_bytes (fs);
1313   return (in_use * 100) / size;
1314 }
1315
1316 fifo_segment_mem_status_t
1317 fifo_segment_determine_status (fifo_segment_header_t * fsh, u8 usage)
1318 {
1319   if (!fsh->high_watermark || !fsh->low_watermark)
1320     return MEMORY_PRESSURE_NO_PRESSURE;
1321
1322   /* once the no-memory is detected, the status continues
1323    * until memory usage gets below the high watermark
1324    */
1325   if (fsh_has_reached_mem_limit (fsh))
1326     {
1327       if (usage >= fsh->high_watermark)
1328         return MEMORY_PRESSURE_NO_MEMORY;
1329       else
1330         fsh_reset_mem_limit (fsh);
1331     }
1332
1333   if (usage >= fsh->high_watermark)
1334     return MEMORY_PRESSURE_HIGH_PRESSURE;
1335
1336   else if (usage >= fsh->low_watermark)
1337     return MEMORY_PRESSURE_LOW_PRESSURE;
1338
1339   return MEMORY_PRESSURE_NO_PRESSURE;
1340 }
1341
1342 fifo_segment_mem_status_t
1343 fifo_segment_get_mem_status (fifo_segment_t * fs)
1344 {
1345   fifo_segment_header_t *fsh = fs->h;
1346   u8 usage = fifo_segment_get_mem_usage (fs);
1347
1348   return fifo_segment_determine_status (fsh, usage);
1349 }
1350
1351 u8 *
1352 format_fifo_segment_type (u8 * s, va_list * args)
1353 {
1354   fifo_segment_t *sp;
1355   sp = va_arg (*args, fifo_segment_t *);
1356   ssvm_segment_type_t st = ssvm_type (&sp->ssvm);
1357
1358   if (st == SSVM_SEGMENT_PRIVATE)
1359     s = format (s, "%s", "private");
1360   else if (st == SSVM_SEGMENT_MEMFD)
1361     s = format (s, "%s", "memfd");
1362   else if (st == SSVM_SEGMENT_SHM)
1363     s = format (s, "%s", "shm");
1364   else
1365     s = format (s, "%s", "unknown");
1366   return s;
1367 }
1368
1369 /**
1370  * Segment format function
1371  */
1372 u8 *
1373 format_fifo_segment (u8 * s, va_list * args)
1374 {
1375   u32 count, indent, active_fifos, free_fifos;
1376   fifo_segment_t *fs = va_arg (*args, fifo_segment_t *);
1377   int verbose __attribute__ ((unused)) = va_arg (*args, int);
1378   uword est_chunk_bytes, est_free_seg_bytes, free_chunks;
1379   uword chunk_bytes = 0, free_seg_bytes, chunk_size;
1380   uword tracked_cached_bytes;
1381   uword fifo_hdr = 0, reserved;
1382   fifo_segment_header_t *fsh;
1383   fifo_segment_slice_t *fss;
1384   svm_fifo_chunk_t *c;
1385   u32 slice_index;
1386   char *address;
1387   size_t size;
1388   int i;
1389   uword allocated, in_use, virt;
1390   f64 usage;
1391   fifo_segment_mem_status_t mem_st;
1392
1393   indent = format_get_indent (s) + 2;
1394
1395   if (fs == 0)
1396     {
1397       s = format (s, "%-20s%10s%15s%15s%15s%15s", "Name", "Type",
1398                   "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
1399       return s;
1400     }
1401
1402   fifo_segment_info (fs, &address, &size);
1403   active_fifos = fifo_segment_num_fifos (fs);
1404   free_fifos = fifo_segment_num_free_fifos (fs);
1405
1406   s = format (s, "%-20v%10U%15llu%15u%15u%15llx", ssvm_name (&fs->ssvm),
1407               format_fifo_segment_type, fs, size >> 20ULL, active_fifos,
1408               free_fifos, address);
1409
1410   if (!verbose)
1411     return s;
1412
1413   fsh = fs->h;
1414
1415   free_chunks = fifo_segment_num_free_chunks (fs, ~0);
1416   if (free_chunks)
1417     s =
1418       format (s, "\n\n%UFree/Allocated chunks by size:\n", format_white_space,
1419               indent + 2);
1420   else
1421     s = format (s, "\n");
1422
1423   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1424     {
1425       fss = fsh_slice_get (fsh, slice_index);
1426       for (i = 0; i < FS_CHUNK_VEC_LEN; i++)
1427         {
1428           c = fs_chunk_ptr (fsh, fss->free_chunks[i]);
1429           if (c == 0 && fss->num_chunks[i] == 0)
1430             continue;
1431           count = 0;
1432           while (c)
1433             {
1434               c = fs_chunk_ptr (fsh, c->next);
1435               count++;
1436             }
1437
1438           chunk_size = fs_freelist_index_to_size (i);
1439           s = format (s, "%U%-5u kB: %u/%u\n", format_white_space, indent + 2,
1440                       chunk_size >> 10, count, fss->num_chunks[i]);
1441
1442           chunk_bytes += count * chunk_size;
1443         }
1444     }
1445
1446   fifo_hdr = free_fifos * sizeof (svm_fifo_t);
1447   est_chunk_bytes = fifo_segment_fl_chunk_bytes (fs);
1448   est_free_seg_bytes = fifo_segment_free_bytes (fs);
1449   free_seg_bytes = fifo_segment_free_bytes (fs);
1450   tracked_cached_bytes = fifo_segment_cached_bytes (fs);
1451   allocated = fifo_segment_size (fs);
1452   in_use = fifo_segment_size (fs) - est_free_seg_bytes - tracked_cached_bytes;
1453   usage = (100.0 * in_use) / allocated;
1454   mem_st = fifo_segment_get_mem_status (fs);
1455   virt = fsh_virtual_mem (fsh);
1456   reserved = fsh->n_reserved_bytes;
1457
1458   s = format (s, "\n%Useg free bytes: %U (%lu) estimated: %U (%lu) reserved:"
1459               " %U (%lu)\n", format_white_space, indent + 2,
1460               format_memory_size, free_seg_bytes, free_seg_bytes,
1461               format_memory_size, est_free_seg_bytes, est_free_seg_bytes,
1462               format_memory_size, reserved, reserved);
1463   s = format (s, "%Uchunk free bytes: %U (%lu) estimated: %U (%lu) tracked:"
1464               " %U (%lu)\n", format_white_space, indent + 2,
1465               format_memory_size, chunk_bytes, chunk_bytes,
1466               format_memory_size, est_chunk_bytes, est_chunk_bytes,
1467               format_memory_size, tracked_cached_bytes, tracked_cached_bytes);
1468   s = format (s, "%Ufifo active: %u hdr free bytes: %U (%u) \n",
1469               format_white_space, indent + 2, fsh->n_active_fifos,
1470               format_memory_size, fifo_hdr, fifo_hdr);
1471   s = format (s, "%Usegment usage: %.2f%% (%U / %U) virt: %U status: %s\n",
1472               format_white_space, indent + 2, usage, format_memory_size,
1473               in_use, format_memory_size, allocated, format_memory_size, virt,
1474               fifo_segment_mem_status_strings[mem_st]);
1475   s = format (s, "\n");
1476
1477   return s;
1478 }
1479
1480 /*
1481  * fd.io coding-style-patch-verification: ON
1482  *
1483  * Local Variables:
1484  * eval: (c-set-style "gnu")
1485  * End:
1486  */