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