src/svm/fifo_segment.c

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