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