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