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