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