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