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