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