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->fs_index = fs - sm->segments;
 391   fs->sm_index = ~0;
 392   fs->ssvm.ssvm_size = a->segment_size;
 393   fs->ssvm.my_pid = getpid ();
 394   fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
 395   fs->ssvm.requested_va = 0;
 396   if (a->segment_type == SSVM_SEGMENT_MEMFD)
 397     fs->ssvm.fd = a->memfd_fd;
 398   else
 399     fs->ssvm.attach_timeout = sm->timeout_in_seconds;
 400
 401   if ((rv = ssvm_client_init (&fs->ssvm, a->segment_type)))
 402     {
 403       pool_put (sm->segments, fs);
 404       return (rv);
 405     }
 406
 407   /* Probably a segment without fifos */
 408   if (!fs->ssvm.sh->opaque[0])
 409     goto done;
 410
 411   fsh = fs->h = (void *) fs->ssvm.sh + (uword) fs->ssvm.sh->opaque[0];
 412   fs->max_byte_index = fsh->max_byte_index;
 413   vec_validate (fs->slices, 0);
 414   fs->slices[0].fifos =
 415     clib_mem_bulk_init (sizeof (svm_fifo_t), CLIB_CACHE_LINE_BYTES, 32);
 416
 417 done:
 418   vec_add1 (a->new_segment_indices, fs - sm->segments);
 419   return (0);
 420 }
 421
 422 void
 423 fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * s)
 424 {
 425   fifo_segment_cleanup (s);
 426   ssvm_delete (&s->ssvm);
 427   clib_memset (s, 0xfe, sizeof (*s));
 428   pool_put (sm->segments, s);
 429 }
 430
 431 u32
 432 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * s)
 433 {
 434   return s - sm->segments;
 435 }
 436
 437 fifo_segment_t *
 438 fifo_segment_get_segment (fifo_segment_main_t * sm, u32 segment_index)
 439 {
 440   return pool_elt_at_index (sm->segments, segment_index);
 441 }
 442
 443 fifo_segment_t *
 444 fifo_segment_get_segment_if_valid (fifo_segment_main_t *sm, u32 segment_index)
 445 {
 446   if (pool_is_free_index (sm->segments, segment_index))
 447     return 0;
 448   return pool_elt_at_index (sm->segments, segment_index);
 449 }
 450
 451 void
 452 fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size)
 453 {
 454   *address = (char *) seg->ssvm.sh->ssvm_va;
 455   *size = seg->ssvm.ssvm_size;
 456 }
 457
 458 void
 459 fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
 460                         u32 timeout_in_seconds)
 461 {
 462   sm->next_baseva = baseva;
 463   sm->timeout_in_seconds = timeout_in_seconds;
 464 }
 465
 466 static inline u32
 467 fs_freelist_for_size (u32 size)
 468 {
 469   if (PREDICT_FALSE (size < FIFO_SEGMENT_MIN_FIFO_SIZE))
 470     return 0;
 471   return clib_min (max_log2 (size) - FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE,
 472                    FS_CHUNK_VEC_LEN - 1);
 473 }
 474
 475 static inline u32
 476 fs_freelist_index_to_size (u32 fl_index)
 477 {
 478   return 1 << (fl_index + FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE);
 479 }
 480
 481 static inline int
 482 fs_chunk_size_is_valid (fifo_segment_header_t * fsh, u32 size)
 483 {
 484   /*
 485    * 4K minimum. It's not likely that anything good will happen
 486    * with a smaller FIFO.
 487    */
 488   return size >= FIFO_SEGMENT_MIN_FIFO_SIZE &&
 489          size <= (1ULL << fsh->max_log2_fifo_size);
 490 }
 491
 492 svm_fifo_chunk_t *
 493 fs_try_alloc_multi_chunk (fifo_segment_header_t * fsh,
 494                           fifo_segment_slice_t * fss, u32 data_bytes)
 495 {
 496   u32 fl_index, fl_size, n_alloc = 0, req_bytes = data_bytes;
 497   svm_fifo_chunk_t *c, *first = 0, *next;
 498
 499   fl_index = fs_freelist_for_size (req_bytes);
 500   if (fl_index > 0)
 501     fl_index -= 1;
 502
 503   fl_size = fs_freelist_index_to_size (fl_index);
 504
 505   while (req_bytes)
 506     {
 507       c = fss_chunk_free_list_pop (fsh, fss, fl_index);
 508       if (c)
 509         {
 510           c->next = fs_chunk_sptr (fsh, first);
 511           first = c;
 512           n_alloc += fl_size;
 513           req_bytes -= clib_min (fl_size, req_bytes);
 514         }
 515       else
 516         {
 517           /* Failed to allocate with smaller chunks */
 518           if (fl_index == 0)
 519             {
 520               /* Free all chunks if any allocated */
 521               c = first;
 522               while (c)
 523                 {
 524                   fl_index = fs_freelist_for_size (c->length);
 525                   next = fs_chunk_ptr (fsh, c->next);
 526                   fss_chunk_free_list_push (fsh, fss, fl_index, c);
 527                   c = next;
 528                 }
 529               n_alloc = 0;
 530               first = 0;
 531               /* As last attempt, try allocating a chunk larger than
 532                * the requested size, if possible */
 533               fl_index = fs_freelist_for_size (data_bytes) + 1;
 534               if (!fss_chunk_fl_index_is_valid (fss, fl_index))
 535                 return 0;
 536               first = fss_chunk_free_list_pop (fsh, fss, fl_index);
 537               if (first)
 538                 {
 539                   first->next = 0;
 540                   n_alloc = fs_freelist_index_to_size (fl_index);
 541                   goto done;
 542                 }
 543               return 0;
 544             }
 545           fl_index -= 1;
 546           fl_size = fl_size >> 1;
 547         }
 548     }
 549
 550 done:
 551   fss_fl_chunk_bytes_sub (fss, n_alloc);
 552   fsh_cached_bytes_sub (fsh, n_alloc);
 553   return first;
 554 }
 555
 556 static int
 557 fsh_try_alloc_fifo_hdr_batch (fifo_segment_header_t * fsh,
 558                               fifo_segment_slice_t * fss, u32 batch_size)
 559 {
 560   svm_fifo_shared_t *f, *head = 0, *tail;
 561   uword size;
 562   u8 *fmem;
 563   int i;
 564
 565   ASSERT (batch_size != 0);
 566
 567   size = (uword) sizeof (*f) * batch_size;
 568
 569   fmem = fsh_alloc_aligned (fsh, size, CLIB_CACHE_LINE_BYTES);
 570   if (fmem == 0)
 571     return -1;
 572
 573   /* Carve fifo hdr space */
 574   tail = f = (svm_fifo_shared_t *) fmem;
 575   for (i = 0; i < batch_size; i++)
 576     {
 577       clib_memset (f, 0, sizeof (*f));
 578       f->next = fs_sptr (fsh, head);
 579       head = f;
 580       fmem += sizeof (*f);
 581       f = (svm_fifo_shared_t *) fmem;
 582     }
 583
 584   fss_fifo_free_list_push_list (fsh, fss, head, tail);
 585
 586   return 0;
 587 }
 588
 589 static int
 590 fsh_try_alloc_chunk_batch (fifo_segment_header_t * fsh,
 591                            fifo_segment_slice_t * fss,
 592                            u32 fl_index, u32 batch_size)
 593 {
 594   svm_fifo_chunk_t *c, *head = 0, *tail;
 595   uword size, total_chunk_bytes;
 596   u32 rounded_data_size;
 597   u8 *cmem;
 598   int i;
 599
 600   ASSERT (batch_size != 0);
 601
 602   rounded_data_size = fs_freelist_index_to_size (fl_index);
 603   total_chunk_bytes = (uword) batch_size *rounded_data_size;
 604   size = (uword) (sizeof (*c) + rounded_data_size) * batch_size;
 605
 606   cmem = fsh_alloc_aligned (fsh, size, 8 /* chunk hdr is 24B */);
 607   if (cmem == 0)
 608     return -1;
 609
 610   /* Carve fifo + chunk space */
 611   tail = c = (svm_fifo_chunk_t *) cmem;
 612   for (i = 0; i < batch_size; i++)
 613     {
 614       c->start_byte = 0;
 615       c->length = rounded_data_size;
 616       c->next = fs_chunk_sptr (fsh, head);
 617       head = c;
 618       cmem += sizeof (*c) + rounded_data_size;
 619       c = (svm_fifo_chunk_t *) cmem;
 620     }
 621
 622   fss_chunk_free_list_push_list (fsh, fss, fl_index, head, tail);
 623   fss->num_chunks[fl_index] += batch_size;
 624   fss_fl_chunk_bytes_add (fss, total_chunk_bytes);
 625   fsh_cached_bytes_add (fsh, total_chunk_bytes);
 626
 627   return 0;
 628 }
 629
 630 static int
 631 fs_try_alloc_fifo_batch (fifo_segment_header_t * fsh,
 632                          fifo_segment_slice_t * fss,
 633                          u32 fl_index, u32 batch_size)
 634 {
 635   if (fsh_try_alloc_fifo_hdr_batch (fsh, fss, batch_size))
 636     return 0;
 637   return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
 638 }
 639
 640 static svm_fifo_shared_t *
 641 fsh_try_alloc_fifo_hdr (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss)
 642 {
 643   svm_fifo_shared_t *sf;
 644
 645   if (!fss->free_fifos)
 646     {
 647       if (fsh_try_alloc_fifo_hdr_batch (fsh, fss,
 648                                         FIFO_SEGMENT_ALLOC_BATCH_SIZE))
 649         return 0;
 650     }
 651
 652   sf = fss_fifo_free_list_pop (fsh, fss);
 653   clib_memset (sf, 0, sizeof (*sf));
 654
 655   return sf;
 656 }
 657
 658 static svm_fifo_chunk_t *
 659 fsh_try_alloc_chunk (fifo_segment_header_t * fsh,
 660                      fifo_segment_slice_t * fss, u32 data_bytes)
 661 {
 662   svm_fifo_chunk_t *c;
 663   u32 fl_index;
 664
 665   fl_index = fs_freelist_for_size (data_bytes);
 666
 667 free_list:
 668   c = fss_chunk_free_list_pop (fsh, fss, fl_index);
 669   if (c)
 670     {
 671       c->next = 0;
 672       fss_fl_chunk_bytes_sub (fss, fs_freelist_index_to_size (fl_index));
 673       fsh_cached_bytes_sub (fsh, fs_freelist_index_to_size (fl_index));
 674     }
 675   else
 676     {
 677       u32 chunk_size, batch = FIFO_SEGMENT_ALLOC_BATCH_SIZE;
 678       uword n_free;
 679
 680       chunk_size = fs_freelist_index_to_size (fl_index);
 681       n_free = fsh_n_free_bytes (fsh);
 682
 683       if (chunk_size <= n_free)
 684         {
 685           batch = chunk_size * batch <= n_free ? batch : 1;
 686           if (!fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch))
 687             goto free_list;
 688         }
 689       /* Failed to allocate larger chunk, try to allocate multi-chunk
 690        * that is close to what was actually requested */
 691       if (data_bytes <= fss_fl_chunk_bytes (fss))
 692         {
 693           c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
 694           if (c)
 695             goto done;
 696           batch = n_free / FIFO_SEGMENT_MIN_FIFO_SIZE;
 697           if (!batch || fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
 698             goto done;
 699         }
 700       if (data_bytes <= fss_fl_chunk_bytes (fss) + n_free)
 701         {
 702           u32 min_size = FIFO_SEGMENT_MIN_FIFO_SIZE;
 703           if (n_free < min_size)
 704             goto done;
 705           batch = (data_bytes - fss_fl_chunk_bytes (fss)) / min_size;
 706           batch = clib_min (batch + 1, n_free / min_size);
 707           if (fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
 708             goto done;
 709           c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
 710         }
 711     }
 712
 713 done:
 714
 715   return c;
 716 }
 717
 718 /**
 719  * Try to allocate new fifo
 720  *
 721  * Tries the following steps in order:
 722  * - grab fifo and chunk from freelists
 723  * - batch fifo and chunk allocation
 724  * - single fifo allocation
 725  * - grab multiple fifo chunks from freelists
 726  */
 727 static svm_fifo_shared_t *
 728 fs_try_alloc_fifo (fifo_segment_header_t *fsh, u32 slice_index, u32 data_bytes)
 729 {
 730   fifo_segment_slice_t *fss;
 731   u32 fl_index, min_size;
 732   svm_fifo_chunk_t *c;
 733   svm_fifo_shared_t *sf = 0;
 734
 735   fss = fsh_slice_get (fsh, slice_index);
 736   min_size = clib_max ((fsh->pct_first_alloc * data_bytes) / 100, 4096);
 737   fl_index = fs_freelist_for_size (min_size);
 738
 739   if (!fss_chunk_fl_index_is_valid (fss, fl_index))
 740     return 0;
 741
 742   sf = fsh_try_alloc_fifo_hdr (fsh, fss);
 743   if (!sf)
 744     return 0;
 745
 746   c = fsh_try_alloc_chunk (fsh, fss, min_size);
 747   if (!c)
 748     {
 749       fss_fifo_free_list_push (fsh, fss, sf);
 750       return 0;
 751     }
 752
 753   sf->start_chunk = fs_chunk_sptr (fsh, c);
 754   while (c->next)
 755     c = fs_chunk_ptr (fsh, c->next);
 756   sf->end_chunk = fs_chunk_sptr (fsh, c);
 757   sf->size = data_bytes;
 758   sf->slice_index = slice_index;
 759
 760   return sf;
 761 }
 762
 763 svm_fifo_chunk_t *
 764 fsh_alloc_chunk (fifo_segment_header_t * fsh, u32 slice_index, u32 chunk_size)
 765 {
 766   fifo_segment_slice_t *fss;
 767   svm_fifo_chunk_t *c;
 768
 769   fss = fsh_slice_get (fsh, slice_index);
 770   c = fsh_try_alloc_chunk (fsh, fss, chunk_size);
 771
 772   return c;
 773 }
 774
 775 static void
 776 fsh_slice_collect_chunks (fifo_segment_header_t * fsh,
 777                           fifo_segment_slice_t * fss, svm_fifo_chunk_t * c)
 778 {
 779   u32 n_collect = 0, fl_index;
 780   svm_fifo_chunk_t *next;
 781
 782   while (c)
 783     {
 784       clib_mem_unpoison (c, sizeof (*c));
 785       next = fs_chunk_ptr (fsh, c->next);
 786       fl_index = fs_freelist_for_size (c->length);
 787       fss_chunk_free_list_push (fsh, fss, fl_index, c);
 788       n_collect += fs_freelist_index_to_size (fl_index);
 789       c = next;
 790     }
 791
 792   fss_fl_chunk_bytes_add (fss, n_collect);
 793   fsh_cached_bytes_add (fsh, n_collect);
 794 }
 795
 796 void
 797 fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
 798                     svm_fifo_chunk_t * c)
 799 {
 800   fifo_segment_slice_t *fss;
 801   fss = fsh_slice_get (fsh, slice_index);
 802   fsh_slice_collect_chunks (fsh, fss, c);
 803 }
 804
 805 svm_fifo_t *
 806 fs_fifo_alloc (fifo_segment_t *fs, u32 slice_index)
 807 {
 808   fifo_slice_private_t *pfss = &fs->slices[slice_index];
 809   svm_fifo_t *f;
 810
 811   f = clib_mem_bulk_alloc (pfss->fifos);
 812   clib_memset (f, 0, sizeof (*f));
 813   return f;
 814 }
 815
 816 void
 817 fs_fifo_free (fifo_segment_t *fs, svm_fifo_t *f, u32 slice_index)
 818 {
 819   fifo_slice_private_t *pfss;
 820
 821   if (CLIB_DEBUG)
 822     clib_memset (f, 0xfc, sizeof (*f));
 823
 824   pfss = &fs->slices[slice_index];
 825   clib_mem_bulk_free (pfss->fifos, f);
 826 }
 827
 828 void
 829 fifo_segment_cleanup (fifo_segment_t *fs)
 830 {
 831   int slice_index;
 832   svm_msg_q_t *mq = 0;
 833
 834   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
 835     clib_mem_bulk_destroy (fs->slices[slice_index].fifos);
 836
 837   vec_free (fs->slices);
 838
 839   vec_foreach (mq, fs->mqs)
 840     svm_msg_q_cleanup (mq);
 841
 842   vec_free (fs->mqs);
 843 }
 844
 845 /**
 846  * Allocate fifo in fifo segment
 847  */
 848 svm_fifo_t *
 849 fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs, u32 slice_index,
 850                                  u32 data_bytes, fifo_segment_ftype_t ftype)
 851 {
 852   fifo_segment_header_t *fsh = fs->h;
 853   fifo_slice_private_t *pfss;
 854   fifo_segment_slice_t *fss;
 855   svm_fifo_shared_t *sf;
 856   svm_fifo_t *f = 0;
 857
 858   ASSERT (slice_index < fs->n_slices);
 859
 860   if (PREDICT_FALSE (data_bytes > 1 << fsh->max_log2_fifo_size))
 861     return 0;
 862
 863   sf = fs_try_alloc_fifo (fsh, slice_index, data_bytes);
 864   if (!sf)
 865     goto done;
 866
 867   f = fs_fifo_alloc (fs, slice_index);
 868   f->fs_hdr = fsh;
 869   f->shr = sf;
 870
 871   svm_fifo_init (f, data_bytes);
 872
 873   f->segment_manager = fs->sm_index;
 874   f->segment_index = fs->fs_index;
 875
 876   fss = fsh_slice_get (fsh, slice_index);
 877   pfss = fs_slice_private_get (fs, slice_index);
 878
 879   /* If rx fifo type add to active fifos list. When cleaning up segment,
 880    * we need a list of active sessions that should be disconnected. Since
 881    * both rx and tx fifos keep pointers to the session, it's enough to track
 882    * only one. */
 883   if (ftype == FIFO_SEGMENT_RX_FIFO)
 884     {
 885       pfss_fifo_add_active_list (pfss, f);
 886       f->flags |= SVM_FIFO_F_LL_TRACKED;
 887     }
 888
 889   fsh_active_fifos_update (fsh, 1);
 890   fss->virtual_mem += svm_fifo_size (f);
 891
 892 done:
 893   return (f);
 894 }
 895
 896 svm_fifo_t *
 897 fifo_segment_alloc_fifo_w_offset (fifo_segment_t *fs, uword offset)
 898 {
 899   svm_fifo_t *f = fs_fifo_alloc (fs, 0);
 900   svm_fifo_shared_t *sf;
 901
 902   sf = (svm_fifo_shared_t *) ((u8 *) fs->h + offset);
 903   f->fs_hdr = fs->h;
 904   f->shr = sf;
 905
 906   f->ooos_list_head = OOO_SEGMENT_INVALID_INDEX;
 907   f->segment_index = SVM_FIFO_INVALID_INDEX;
 908   f->refcnt = 1;
 909   return f;
 910 }
 911
 912 svm_fifo_t *
 913 fifo_segment_duplicate_fifo (fifo_segment_t *fs, svm_fifo_t *f)
 914 {
 915   svm_fifo_t *nf = fs_fifo_alloc (fs, 0);
 916   clib_memcpy (nf, f, sizeof (*f));
 917   return nf;
 918 }
 919
 920 /**
 921  * Free fifo allocated in fifo segment
 922  */
 923 void
 924 fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f)
 925 {
 926   fifo_segment_header_t *fsh = fs->h;
 927   fifo_slice_private_t *pfss;
 928   fifo_segment_slice_t *fss;
 929   svm_fifo_shared_t *sf;
 930
 931   ASSERT (f->refcnt > 0);
 932
 933   if (--f->refcnt > 0)
 934     return;
 935
 936   /*
 937    * Cleanup shared state
 938    */
 939
 940   sf = f->shr;
 941   fss = fsh_slice_get (fsh, sf->slice_index);
 942   pfss = fs_slice_private_get (fs, sf->slice_index);
 943
 944   /* Free fifo chunks */
 945   fsh_slice_collect_chunks (fsh, fss, fs_chunk_ptr (fsh, f->shr->start_chunk));
 946
 947   sf->start_chunk = sf->end_chunk = 0;
 948   sf->head_chunk = sf->tail_chunk = 0;
 949
 950   /* Add to free list */
 951   fss_fifo_free_list_push (fsh, fss, sf);
 952
 953   fss->virtual_mem -= svm_fifo_size (f);
 954
 955   /*
 956    *  Cleanup private state
 957    */
 958
 959   /* Remove from active list. Only rx fifos are tracked */
 960   if (f->flags & SVM_FIFO_F_LL_TRACKED)
 961     {
 962       pfss_fifo_del_active_list (pfss, f);
 963       f->flags &= ~SVM_FIFO_F_LL_TRACKED;
 964     }
 965
 966   svm_fifo_free_chunk_lookup (f);
 967   svm_fifo_free_ooo_data (f);
 968
 969   if (CLIB_DEBUG)
 970     {
 971       sf->master_session_index = ~0;
 972       f->master_thread_index = ~0;
 973     }
 974
 975   f->ooo_enq = f->ooo_deq = 0;
 976   f->prev = 0;
 977
 978   fs_fifo_free (fs, f, f->shr->slice_index);
 979
 980   fsh_active_fifos_update (fsh, -1);
 981 }
 982
 983 void
 984 fifo_segment_free_client_fifo (fifo_segment_t *fs, svm_fifo_t *f)
 985 {
 986   fs_fifo_free (fs, f, 0 /* clients attach fifos in slice 0 */);
 987 }
 988
 989 void
 990 fifo_segment_detach_fifo (fifo_segment_t *fs, svm_fifo_t **f)
 991 {
 992   fifo_slice_private_t *pfss;
 993   fifo_segment_slice_t *fss;
 994   svm_fifo_t *of = *f;
 995   u32 slice_index;
 996
 997   slice_index = of->master_thread_index;
 998   fss = fsh_slice_get (fs->h, slice_index);
 999   pfss = fs_slice_private_get (fs, slice_index);
1000   fss->virtual_mem -= svm_fifo_size (of);
1001   if (of->flags & SVM_FIFO_F_LL_TRACKED)
1002     pfss_fifo_del_active_list (pfss, of);
1003
1004   /* Collect chunks that were provided in return for those detached */
1005   fsh_slice_collect_chunks (fs->h, fss, of->chunks_at_attach);
1006   of->chunks_at_attach = 0;
1007
1008   /* Collect hdr that was provided in return for the detached */
1009   fss_fifo_free_list_push (fs->h, fss, of->hdr_at_attach);
1010   of->hdr_at_attach = 0;
1011
1012   clib_mem_bulk_free (pfss->fifos, *f);
1013   *f = 0;
1014 }
1015
1016 void
1017 fifo_segment_attach_fifo (fifo_segment_t *fs, svm_fifo_t **f, u32 slice_index)
1018 {
1019   svm_fifo_chunk_t *c, *nc, *pc = 0;
1020   fifo_slice_private_t *pfss;
1021   fifo_segment_slice_t *fss;
1022   svm_fifo_t *nf, *of;
1023
1024   nf = fs_fifo_alloc (fs, slice_index);
1025   clib_memcpy_fast (nf, *f, sizeof (*nf));
1026
1027   fss = fsh_slice_get (fs->h, slice_index);
1028   pfss = fs_slice_private_get (fs, slice_index);
1029   fss->virtual_mem += svm_fifo_size (nf);
1030   nf->next = nf->prev = 0;
1031   if (nf->flags & SVM_FIFO_F_LL_TRACKED)
1032     pfss_fifo_add_active_list (pfss, nf);
1033
1034   /* Allocate shared hdr and chunks to be collected at detach in return
1035    * for those that are being attached now */
1036   of = *f;
1037   of->hdr_at_attach = fsh_try_alloc_fifo_hdr (fs->h, fss);
1038
1039   c = fs_chunk_ptr (fs->h, nf->shr->start_chunk);
1040   of->chunks_at_attach = pc = fsh_try_alloc_chunk (fs->h, fss, c->length);
1041
1042   while ((c = fs_chunk_ptr (fs->h, c->next)))
1043     {
1044       nc = fsh_try_alloc_chunk (fs->h, fss, c->length);
1045       pc->next = fs_chunk_sptr (fs->h, nc);
1046       pc = nc;
1047     }
1048
1049   nf->shr->slice_index = slice_index;
1050   *f = nf;
1051 }
1052
1053 uword
1054 fifo_segment_fifo_offset (svm_fifo_t *f)
1055 {
1056   return (u8 *) f->shr - (u8 *) f->fs_hdr;
1057 }
1058
1059 svm_fifo_chunk_t *
1060 fifo_segment_alloc_chunk_w_slice (fifo_segment_t *fs, u32 slice_index,
1061                                   u32 chunk_size)
1062 {
1063   fifo_segment_header_t *fsh = fs->h;
1064   fifo_segment_slice_t *fss;
1065
1066   fss = fsh_slice_get (fsh, slice_index);
1067   return fsh_try_alloc_chunk (fsh, fss, chunk_size);
1068 }
1069
1070 void
1071 fifo_segment_collect_chunk (fifo_segment_t *fs, u32 slice_index,
1072                             svm_fifo_chunk_t *c)
1073 {
1074   fsh_collect_chunks (fs->h, slice_index, c);
1075 }
1076
1077 uword
1078 fifo_segment_chunk_offset (fifo_segment_t *fs, svm_fifo_chunk_t *c)
1079 {
1080   return (u8 *) c - (u8 *) fs->h;
1081 }
1082
1083 svm_msg_q_t *
1084 fifo_segment_msg_q_alloc (fifo_segment_t *fs, u32 mq_index,
1085                           svm_msg_q_cfg_t *cfg)
1086 {
1087   fifo_segment_header_t *fsh = fs->h;
1088   svm_msg_q_shared_t *smq;
1089   svm_msg_q_t *mq;
1090   void *base;
1091   u32 size;
1092
1093   if (!fs->mqs)
1094     {
1095       u32 n_mqs = clib_max (fs->h->n_mqs, 1);
1096       vec_validate (fs->mqs, n_mqs - 1);
1097     }
1098
1099   size = svm_msg_q_size_to_alloc (cfg);
1100   base = fsh_alloc_aligned (fsh, size, 8);
1101   if (!base)
1102     return 0;
1103
1104   fsh->n_reserved_bytes += size;
1105
1106   smq = svm_msg_q_init (base, cfg);
1107   mq = vec_elt_at_index (fs->mqs, mq_index);
1108   svm_msg_q_attach (mq, smq);
1109
1110   return mq;
1111 }
1112
1113 svm_msg_q_t *
1114 fifo_segment_msg_q_attach (fifo_segment_t *fs, uword offset, u32 mq_index)
1115 {
1116   svm_msg_q_t *mq;
1117
1118   if (!fs->mqs)
1119     {
1120       u32 n_mqs = clib_max (fs->h->n_mqs, 1);
1121       vec_validate (fs->mqs, n_mqs - 1);
1122     }
1123
1124   mq = vec_elt_at_index (fs->mqs, mq_index);
1125
1126   if (!mq->q.shr)
1127     {
1128       svm_msg_q_shared_t *smq;
1129       smq = (svm_msg_q_shared_t *) ((u8 *) fs->h + offset);
1130       svm_msg_q_attach (mq, smq);
1131     }
1132
1133   ASSERT (fifo_segment_msg_q_offset (fs, mq_index) == offset);
1134
1135   return mq;
1136 }
1137
1138 void
1139 fifo_segment_msg_qs_discover (fifo_segment_t *fs, int *fds, u32 n_fds)
1140 {
1141   svm_msg_q_shared_t *smq;
1142   u32 n_mqs, size, i;
1143   uword offset = 0, n_alloced;
1144   svm_msg_q_t *mq;
1145
1146   n_mqs = fs->h->n_mqs;
1147   if (n_fds && n_mqs != n_fds)
1148     {
1149       clib_warning ("expected %u fds got %u", n_mqs, n_fds);
1150       return;
1151     }
1152
1153   vec_validate (fs->mqs, n_mqs - 1);
1154   n_alloced = fs->h->n_reserved_bytes - fs->h->start_byte_index;
1155   ASSERT (n_alloced % n_mqs == 0);
1156   size = n_alloced / n_mqs;
1157
1158   offset = fs->h->start_byte_index;
1159   for (i = 0; i < n_mqs; i++)
1160     {
1161       mq = vec_elt_at_index (fs->mqs, i);
1162       smq = (svm_msg_q_shared_t *) ((u8 *) fs->h + offset);
1163       svm_msg_q_attach (mq, smq);
1164       if (n_fds)
1165         svm_msg_q_set_eventfd (mq, fds[i]);
1166       offset += size;
1167     }
1168 }
1169
1170 uword
1171 fifo_segment_msg_q_offset (fifo_segment_t *fs, u32 mq_index)
1172 {
1173   svm_msg_q_t *mq = vec_elt_at_index (fs->mqs, mq_index);
1174
1175   if (mq->q.shr == 0)
1176     return ~0ULL;
1177
1178   return (uword) ((u8 *) mq->q.shr - (u8 *) fs->h) -
1179          sizeof (svm_msg_q_shared_t);
1180 }
1181
1182 int
1183 fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
1184                                  u32 batch_size)
1185 {
1186   fifo_segment_header_t *fsh = fs->h;
1187   fifo_segment_slice_t *fss;
1188
1189   fss = fsh_slice_get (fsh, slice_index);
1190   return fsh_try_alloc_fifo_hdr_batch (fsh, fss, batch_size);
1191 }
1192
1193 int
1194 fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
1195                                    u32 chunk_size, u32 batch_size)
1196 {
1197   fifo_segment_header_t *fsh = fs->h;
1198   fifo_segment_slice_t *fss;
1199   u32 fl_index;
1200
1201   if (!fs_chunk_size_is_valid (fsh, chunk_size))
1202     {
1203       clib_warning ("chunk size out of range %d", chunk_size);
1204       return -1;
1205     }
1206
1207   fl_index = fs_freelist_for_size (chunk_size);
1208   fss = fsh_slice_get (fsh, slice_index);
1209
1210   return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
1211 }
1212
1213 /**
1214  * Pre-allocates fifo pairs in fifo segment
1215  */
1216 void
1217 fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
1218                                      u32 rx_fifo_size, u32 tx_fifo_size,
1219                                      u32 * n_fifo_pairs)
1220 {
1221   u32 rx_rounded_data_size, tx_rounded_data_size, pair_size, pairs_to_alloc;
1222   u32 hdrs, pairs_per_slice, alloc_now;
1223   fifo_segment_header_t *fsh = fs->h;
1224   int rx_fl_index, tx_fl_index, i;
1225   fifo_segment_slice_t *fss;
1226   uword space_available;
1227
1228   /* Parameter check */
1229   if (rx_fifo_size == 0 || tx_fifo_size == 0 || *n_fifo_pairs == 0)
1230     return;
1231
1232   if (!fs_chunk_size_is_valid (fsh, rx_fifo_size))
1233     {
1234       clib_warning ("rx fifo_size out of range %d", rx_fifo_size);
1235       return;
1236     }
1237
1238   if (!fs_chunk_size_is_valid (fsh, tx_fifo_size))
1239     {
1240       clib_warning ("tx fifo_size out of range %d", tx_fifo_size);
1241       return;
1242     }
1243
1244   rx_rounded_data_size = (1 << (max_log2 (rx_fifo_size)));
1245   rx_fl_index = fs_freelist_for_size (rx_fifo_size);
1246   tx_rounded_data_size = (1 << (max_log2 (tx_fifo_size)));
1247   tx_fl_index = fs_freelist_for_size (tx_fifo_size);
1248
1249   hdrs = sizeof (svm_fifo_t) + sizeof (svm_fifo_chunk_t);
1250
1251   /* Calculate space requirements */
1252   pair_size = 2 * hdrs + rx_rounded_data_size + tx_rounded_data_size;
1253   space_available = fsh_n_free_bytes (fsh);
1254   pairs_to_alloc = space_available / pair_size;
1255   pairs_to_alloc = clib_min (pairs_to_alloc, *n_fifo_pairs);
1256   pairs_per_slice = pairs_to_alloc / fs->n_slices;
1257   pairs_per_slice += pairs_to_alloc % fs->n_slices ? 1 : 0;
1258
1259   if (!pairs_per_slice)
1260     return;
1261
1262   for (i = 0; i < fs->n_slices; i++)
1263     {
1264       alloc_now = clib_min (pairs_per_slice, *n_fifo_pairs);
1265       if (0 == alloc_now)
1266         break;
1267
1268       fss = fsh_slice_get (fsh, i);
1269       if (fs_try_alloc_fifo_batch (fsh, fss, rx_fl_index, alloc_now))
1270         clib_warning ("rx prealloc failed: pairs %u", alloc_now);
1271       if (fs_try_alloc_fifo_batch (fsh, fss, tx_fl_index, alloc_now))
1272         clib_warning ("tx prealloc failed: pairs %u", alloc_now);
1273
1274       /* Account for the pairs allocated */
1275       *n_fifo_pairs -= alloc_now;
1276     }
1277 }
1278
1279 /**
1280  * Get number of active fifos
1281  */
1282 u32
1283 fifo_segment_num_fifos (fifo_segment_t * fs)
1284 {
1285   return fsh_n_active_fifos (fs->h);
1286 }
1287
1288 static u32
1289 fs_slice_num_free_fifos (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss)
1290 {
1291   svm_fifo_shared_t *f;
1292   u32 count = 0;
1293
1294   f = fs_ptr (fsh, fss->free_fifos);
1295   if (f == 0)
1296     return 0;
1297
1298   while (f)
1299     {
1300       f = fs_ptr (fsh, f->next);
1301       count++;
1302     }
1303   return count;
1304 }
1305
1306 u32
1307 fifo_segment_num_free_fifos (fifo_segment_t * fs)
1308 {
1309   fifo_segment_header_t *fsh = fs->h;
1310   fifo_segment_slice_t *fss;
1311   int slice_index;
1312   u32 count = 0;
1313
1314   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1315     {
1316       fss = fsh_slice_get (fsh, slice_index);
1317       count += fs_slice_num_free_fifos (fsh, fss);
1318     }
1319   return count;
1320 }
1321
1322 static u32
1323 fs_slice_num_free_chunks (fifo_segment_header_t *fsh,
1324                           fifo_segment_slice_t *fss, u32 size)
1325 {
1326   u32 count = 0, rounded_size, fl_index;
1327   svm_fifo_chunk_t *c;
1328   int i;
1329
1330   /* Count all free chunks? */
1331   if (size == ~0)
1332     {
1333       for (i = 0; i < FS_CHUNK_VEC_LEN; i++)
1334         {
1335           c = fss_chunk_free_list_head (fsh, fss, i);
1336           if (c == 0)
1337             continue;
1338
1339           while (c)
1340             {
1341               c = fs_chunk_ptr (fsh, c->next);
1342               count++;
1343             }
1344         }
1345       return count;
1346     }
1347
1348   rounded_size = (1 << (max_log2 (size)));
1349   fl_index = fs_freelist_for_size (rounded_size);
1350
1351   if (fl_index >= FS_CHUNK_VEC_LEN)
1352     return 0;
1353
1354   c = fss_chunk_free_list_head (fsh, fss, fl_index);
1355   if (c == 0)
1356     return 0;
1357
1358   while (c)
1359     {
1360       c = fs_chunk_ptr (fsh, c->next);
1361       count++;
1362     }
1363   return count;
1364 }
1365
1366 u32
1367 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size)
1368 {
1369   fifo_segment_header_t *fsh = fs->h;
1370   fifo_segment_slice_t *fss;
1371   int slice_index;
1372   u32 count = 0;
1373
1374   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1375     {
1376       fss = fsh_slice_get (fsh, slice_index);
1377       count += fs_slice_num_free_chunks (fsh, fss, size);
1378     }
1379   return count;
1380 }
1381
1382 uword
1383 fifo_segment_size (fifo_segment_t * fs)
1384 {
1385   return fs->h->max_byte_index - fs->h->n_reserved_bytes;
1386 }
1387
1388 static u8
1389 fs_has_reached_mem_limit (fifo_segment_t *fs)
1390 {
1391   return (fs->flags & FIFO_SEGMENT_F_MEM_LIMIT) ? 1 : 0;
1392 }
1393
1394 static void
1395 fs_reset_mem_limit (fifo_segment_t *fs)
1396 {
1397   fs->flags &= ~FIFO_SEGMENT_F_MEM_LIMIT;
1398 }
1399
1400 void *
1401 fifo_segment_alloc (fifo_segment_t *fs, uword size)
1402 {
1403   void *rv = fsh_alloc (fs->h, size);
1404   /* Mark externally allocated bytes as reserved. This helps
1405    * @ref fifo_segment_size report bytes used only for fifos */
1406   fs->h->n_reserved_bytes += size;
1407   return rv;
1408 }
1409
1410 uword
1411 fifo_segment_free_bytes (fifo_segment_t * fs)
1412 {
1413   return fsh_n_free_bytes (fs->h);
1414 }
1415
1416 uword
1417 fifo_segment_cached_bytes (fifo_segment_t * fs)
1418 {
1419   return fsh_n_cached_bytes (fs->h);
1420 }
1421
1422 uword
1423 fifo_segment_available_bytes (fifo_segment_t * fs)
1424 {
1425   return fsh_n_free_bytes (fs->h) + fsh_n_cached_bytes (fs->h);
1426 }
1427
1428 uword
1429 fifo_segment_fl_chunk_bytes (fifo_segment_t * fs)
1430 {
1431   fifo_segment_header_t *fsh = fs->h;
1432   fifo_segment_slice_t *fss;
1433   uword n_bytes = 0;
1434   int slice_index;
1435
1436   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1437     {
1438       fss = fsh_slice_get (fsh, slice_index);
1439       n_bytes += fss_fl_chunk_bytes (fss);
1440     }
1441
1442   return n_bytes;
1443 }
1444
1445 u8
1446 fifo_segment_has_fifos (fifo_segment_t * fs)
1447 {
1448   return (fsh_n_active_fifos (fs->h) != 0);
1449 }
1450
1451 svm_fifo_t *
1452 fifo_segment_get_slice_fifo_list (fifo_segment_t * fs, u32 slice_index)
1453 {
1454   fifo_slice_private_t *pfss;
1455
1456   pfss = fs_slice_private_get (fs, slice_index);
1457   return pfss->active_fifos;
1458 }
1459
1460 u8
1461 fifo_segment_get_mem_usage (fifo_segment_t * fs)
1462 {
1463   uword size, in_use;
1464
1465   size = fifo_segment_size (fs);
1466   in_use =
1467     size - fifo_segment_free_bytes (fs) - fifo_segment_cached_bytes (fs);
1468   return (in_use * 100) / size;
1469 }
1470
1471 fifo_segment_mem_status_t
1472 fifo_segment_determine_status (fifo_segment_t *fs, u8 usage)
1473 {
1474   if (!fs->high_watermark || !fs->low_watermark)
1475     return MEMORY_PRESSURE_NO_PRESSURE;
1476
1477   /* once the no-memory is detected, the status continues
1478    * until memory usage gets below the high watermark
1479    */
1480   if (fs_has_reached_mem_limit (fs))
1481     {
1482       if (usage >= fs->high_watermark)
1483         return MEMORY_PRESSURE_NO_MEMORY;
1484       else
1485         fs_reset_mem_limit (fs);
1486     }
1487
1488   if (usage >= fs->high_watermark)
1489     return MEMORY_PRESSURE_HIGH_PRESSURE;
1490
1491   else if (usage >= fs->low_watermark)
1492     return MEMORY_PRESSURE_LOW_PRESSURE;
1493
1494   return MEMORY_PRESSURE_NO_PRESSURE;
1495 }
1496
1497 fifo_segment_mem_status_t
1498 fifo_segment_get_mem_status (fifo_segment_t * fs)
1499 {
1500   u8 usage = fifo_segment_get_mem_usage (fs);
1501
1502   return fifo_segment_determine_status (fs, usage);
1503 }
1504
1505 u8 *
1506 format_fifo_segment_type (u8 * s, va_list * args)
1507 {
1508   fifo_segment_t *sp;
1509   sp = va_arg (*args, fifo_segment_t *);
1510   ssvm_segment_type_t st = ssvm_type (&sp->ssvm);
1511
1512   if (st == SSVM_SEGMENT_PRIVATE)
1513     s = format (s, "%s", "private");
1514   else if (st == SSVM_SEGMENT_MEMFD)
1515     s = format (s, "%s", "memfd");
1516   else if (st == SSVM_SEGMENT_SHM)
1517     s = format (s, "%s", "shm");
1518   else
1519     s = format (s, "%s", "unknown");
1520   return s;
1521 }
1522
1523 /**
1524  * Segment format function
1525  */
1526 u8 *
1527 format_fifo_segment (u8 * s, va_list * args)
1528 {
1529   u32 count, indent, active_fifos, free_fifos;
1530   fifo_segment_t *fs = va_arg (*args, fifo_segment_t *);
1531   int verbose __attribute__ ((unused)) = va_arg (*args, int);
1532   uword est_chunk_bytes, est_free_seg_bytes, free_chunks;
1533   uword chunk_bytes = 0, free_seg_bytes, chunk_size;
1534   uword tracked_cached_bytes;
1535   uword fifo_hdr = 0, reserved;
1536   fifo_segment_header_t *fsh;
1537   fifo_segment_slice_t *fss;
1538   svm_fifo_chunk_t *c;
1539   u32 slice_index;
1540   char *address;
1541   size_t size;
1542   int i;
1543   uword allocated, in_use, virt;
1544   f64 usage;
1545   fifo_segment_mem_status_t mem_st;
1546
1547   indent = format_get_indent (s);
1548
1549   fifo_segment_info (fs, &address, &size);
1550   active_fifos = fifo_segment_num_fifos (fs);
1551   free_fifos = fifo_segment_num_free_fifos (fs);
1552
1553   s = format (s, "%U%v type: %U size: %U active fifos: %u", format_white_space,
1554               2, ssvm_name (&fs->ssvm), format_fifo_segment_type, fs,
1555               format_memory_size, size, active_fifos);
1556
1557   if (!verbose)
1558     return s;
1559
1560   fsh = fs->h;
1561
1562   free_chunks = fifo_segment_num_free_chunks (fs, ~0);
1563   if (free_chunks)
1564     s = format (s, "\n\n%UFree/Allocated chunks by size:\n",
1565                 format_white_space, 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  */