src/svm/fifo_segment.c

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