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
 698           batch = (data_bytes - fss_fl_chunk_bytes (fss)) / min_size;
 699           batch = clib_min (batch + 1, n_free / min_size);
 700           if (fsh_try_alloc_chunk_batch (fsh, fss, 0, batch))
 701             goto done;
 702           c = fs_try_alloc_multi_chunk (fsh, fss, data_bytes);
 703         }
 704     }
 705
 706 done:
 707
 708   return c;
 709 }
 710
 711 /**
 712  * Try to allocate new fifo
 713  *
 714  * Tries the following steps in order:
 715  * - grab fifo and chunk from freelists
 716  * - batch fifo and chunk allocation
 717  * - single fifo allocation
 718  * - grab multiple fifo chunks from freelists
 719  */
 720 static svm_fifo_shared_t *
 721 fs_try_alloc_fifo (fifo_segment_header_t *fsh, u32 slice_index, u32 data_bytes)
 722 {
 723   fifo_segment_slice_t *fss;
 724   u32 fl_index, min_size;
 725   svm_fifo_chunk_t *c;
 726   svm_fifo_shared_t *sf = 0;
 727
 728   fss = fsh_slice_get (fsh, slice_index);
 729   min_size = clib_max ((fsh->pct_first_alloc * data_bytes) / 100, 4096);
 730   fl_index = fs_freelist_for_size (min_size);
 731
 732   if (!fss_chunk_fl_index_is_valid (fss, fl_index))
 733     return 0;
 734
 735   sf = fsh_try_alloc_fifo_hdr (fsh, fss);
 736   if (!sf)
 737     return 0;
 738
 739   c = fsh_try_alloc_chunk (fsh, fss, min_size);
 740   if (!c)
 741     {
 742       fss_fifo_free_list_push (fsh, fss, sf);
 743       return 0;
 744     }
 745
 746   sf->start_chunk = fs_chunk_sptr (fsh, c);
 747   while (c->next)
 748     c = fs_chunk_ptr (fsh, c->next);
 749   sf->end_chunk = fs_chunk_sptr (fsh, c);
 750   sf->size = data_bytes;
 751   sf->slice_index = slice_index;
 752
 753   return sf;
 754 }
 755
 756 svm_fifo_chunk_t *
 757 fsh_alloc_chunk (fifo_segment_header_t * fsh, u32 slice_index, u32 chunk_size)
 758 {
 759   fifo_segment_slice_t *fss;
 760   svm_fifo_chunk_t *c;
 761
 762   fss = fsh_slice_get (fsh, slice_index);
 763   c = fsh_try_alloc_chunk (fsh, fss, chunk_size);
 764
 765   return c;
 766 }
 767
 768 static void
 769 fsh_slice_collect_chunks (fifo_segment_header_t * fsh,
 770                           fifo_segment_slice_t * fss, svm_fifo_chunk_t * c)
 771 {
 772   u32 n_collect = 0, fl_index;
 773   svm_fifo_chunk_t *next;
 774
 775   while (c)
 776     {
 777       CLIB_MEM_UNPOISON (c, sizeof (*c));
 778       next = fs_chunk_ptr (fsh, c->next);
 779       fl_index = fs_freelist_for_size (c->length);
 780       fss_chunk_free_list_push (fsh, fss, fl_index, c);
 781       n_collect += fs_freelist_index_to_size (fl_index);
 782       c = next;
 783     }
 784
 785   fss_fl_chunk_bytes_add (fss, n_collect);
 786   fsh_cached_bytes_add (fsh, n_collect);
 787 }
 788
 789 void
 790 fsh_collect_chunks (fifo_segment_header_t * fsh, u32 slice_index,
 791                     svm_fifo_chunk_t * c)
 792 {
 793   fifo_segment_slice_t *fss;
 794   fss = fsh_slice_get (fsh, slice_index);
 795   fsh_slice_collect_chunks (fsh, fss, c);
 796 }
 797
 798 svm_fifo_t *
 799 fs_fifo_alloc (fifo_segment_t *fs, u32 slice_index)
 800 {
 801   fifo_slice_private_t *pfss = &fs->slices[slice_index];
 802   svm_fifo_t *f;
 803
 804   f = clib_mem_bulk_alloc (pfss->fifos);
 805   clib_memset (f, 0, sizeof (*f));
 806   return f;
 807 }
 808
 809 void
 810 fs_fifo_free (fifo_segment_t *fs, svm_fifo_t *f, u32 slice_index)
 811 {
 812   fifo_slice_private_t *pfss;
 813
 814   if (CLIB_DEBUG)
 815     clib_memset (f, 0xfc, sizeof (*f));
 816
 817   pfss = &fs->slices[slice_index];
 818   clib_mem_bulk_free (pfss->fifos, f);
 819 }
 820
 821 void
 822 fifo_segment_cleanup (fifo_segment_t *fs)
 823 {
 824   int slice_index;
 825   svm_msg_q_t *mq = 0;
 826
 827   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
 828     clib_mem_bulk_destroy (fs->slices[slice_index].fifos);
 829
 830   vec_free (fs->slices);
 831
 832   vec_foreach (fs->mqs, mq)
 833     svm_msg_q_cleanup (mq);
 834
 835   vec_free (fs->mqs);
 836 }
 837
 838 /**
 839  * Allocate fifo in fifo segment
 840  */
 841 svm_fifo_t *
 842 fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs, u32 slice_index,
 843                                  u32 data_bytes, fifo_segment_ftype_t ftype)
 844 {
 845   fifo_segment_header_t *fsh = fs->h;
 846   fifo_slice_private_t *pfss;
 847   fifo_segment_slice_t *fss;
 848   svm_fifo_shared_t *sf;
 849   svm_fifo_t *f = 0;
 850
 851   ASSERT (slice_index < fs->n_slices);
 852
 853   if (PREDICT_FALSE (data_bytes > 1 << fsh->max_log2_fifo_size))
 854     return 0;
 855
 856   sf = fs_try_alloc_fifo (fsh, slice_index, data_bytes);
 857   if (!sf)
 858     goto done;
 859
 860   f = fs_fifo_alloc (fs, slice_index);
 861   f->fs_hdr = fsh;
 862   f->shr = sf;
 863
 864   svm_fifo_init (f, data_bytes);
 865
 866   fss = fsh_slice_get (fsh, slice_index);
 867   pfss = fs_slice_private_get (fs, slice_index);
 868
 869   /* If rx fifo type add to active fifos list. When cleaning up segment,
 870    * we need a list of active sessions that should be disconnected. Since
 871    * both rx and tx fifos keep pointers to the session, it's enough to track
 872    * only one. */
 873   if (ftype == FIFO_SEGMENT_RX_FIFO)
 874     {
 875       pfss_fifo_add_active_list (pfss, f);
 876       f->flags |= SVM_FIFO_F_LL_TRACKED;
 877     }
 878
 879   fsh_active_fifos_update (fsh, 1);
 880   fss->virtual_mem += svm_fifo_size (f);
 881
 882 done:
 883   return (f);
 884 }
 885
 886 svm_fifo_t *
 887 fifo_segment_alloc_fifo_w_offset (fifo_segment_t *fs, uword offset)
 888 {
 889   svm_fifo_t *f = fs_fifo_alloc (fs, 0);
 890   svm_fifo_shared_t *sf;
 891
 892   sf = (svm_fifo_shared_t *) ((u8 *) fs->h + offset);
 893   f->fs_hdr = fs->h;
 894   f->shr = sf;
 895
 896   f->ooos_list_head = OOO_SEGMENT_INVALID_INDEX;
 897   f->segment_index = SVM_FIFO_INVALID_INDEX;
 898   f->refcnt = 1;
 899   return f;
 900 }
 901
 902 /**
 903  * Free fifo allocated in fifo segment
 904  */
 905 void
 906 fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f)
 907 {
 908   fifo_segment_header_t *fsh = fs->h;
 909   fifo_slice_private_t *pfss;
 910   fifo_segment_slice_t *fss;
 911   svm_fifo_shared_t *sf;
 912
 913   ASSERT (f->refcnt > 0);
 914
 915   if (--f->refcnt > 0)
 916     return;
 917
 918   /*
 919    * Cleanup shared state
 920    */
 921
 922   sf = f->shr;
 923   fss = fsh_slice_get (fsh, sf->slice_index);
 924   pfss = fs_slice_private_get (fs, sf->slice_index);
 925
 926   /* Free fifo chunks */
 927   fsh_slice_collect_chunks (fsh, fss, fs_chunk_ptr (fsh, f->shr->start_chunk));
 928
 929   sf->start_chunk = sf->end_chunk = 0;
 930   sf->head_chunk = sf->tail_chunk = 0;
 931
 932   /* Add to free list */
 933   fss_fifo_free_list_push (fsh, fss, sf);
 934
 935   fss->virtual_mem -= svm_fifo_size (f);
 936
 937   /*
 938    *  Cleanup private state
 939    */
 940
 941   /* Remove from active list. Only rx fifos are tracked */
 942   if (f->flags & SVM_FIFO_F_LL_TRACKED)
 943     {
 944       pfss_fifo_del_active_list (pfss, f);
 945       f->flags &= ~SVM_FIFO_F_LL_TRACKED;
 946     }
 947
 948   svm_fifo_free_chunk_lookup (f);
 949   svm_fifo_free_ooo_data (f);
 950
 951   if (CLIB_DEBUG)
 952     {
 953       sf->master_session_index = ~0;
 954       f->master_thread_index = ~0;
 955     }
 956
 957   f->ooo_enq = f->ooo_deq = 0;
 958   f->prev = 0;
 959
 960   fs_fifo_free (fs, f, f->shr->slice_index);
 961
 962   fsh_active_fifos_update (fsh, -1);
 963 }
 964
 965 void
 966 fifo_segment_free_client_fifo (fifo_segment_t *fs, svm_fifo_t *f)
 967 {
 968   fs_fifo_free (fs, f, 0 /* clients attach fifos in slice 0 */);
 969 }
 970
 971 void
 972 fifo_segment_detach_fifo (fifo_segment_t *fs, svm_fifo_t **f)
 973 {
 974   fifo_slice_private_t *pfss;
 975   fifo_segment_slice_t *fss;
 976   svm_fifo_t *of = *f;
 977   u32 slice_index;
 978
 979   slice_index = of->master_thread_index;
 980   fss = fsh_slice_get (fs->h, slice_index);
 981   pfss = fs_slice_private_get (fs, slice_index);
 982   fss->virtual_mem -= svm_fifo_size (of);
 983   if (of->flags & SVM_FIFO_F_LL_TRACKED)
 984     pfss_fifo_del_active_list (pfss, of);
 985
 986   /* Collect chunks that were provided in return for those detached */
 987   fsh_slice_collect_chunks (fs->h, fss, of->chunks_at_attach);
 988   of->chunks_at_attach = 0;
 989
 990   /* Collect hdr that was provided in return for the detached */
 991   fss_fifo_free_list_push (fs->h, fss, of->hdr_at_attach);
 992   of->hdr_at_attach = 0;
 993
 994   clib_mem_bulk_free (pfss->fifos, *f);
 995   *f = 0;
 996 }
 997
 998 void
 999 fifo_segment_attach_fifo (fifo_segment_t *fs, svm_fifo_t **f, u32 slice_index)
1000 {
1001   svm_fifo_chunk_t *c, *nc, *pc = 0;
1002   fifo_slice_private_t *pfss;
1003   fifo_segment_slice_t *fss;
1004   svm_fifo_t *nf, *of;
1005
1006   nf = fs_fifo_alloc (fs, slice_index);
1007   clib_memcpy_fast (nf, *f, sizeof (*nf));
1008
1009   fss = fsh_slice_get (fs->h, slice_index);
1010   pfss = fs_slice_private_get (fs, slice_index);
1011   fss->virtual_mem += svm_fifo_size (nf);
1012   nf->next = nf->prev = 0;
1013   if (nf->flags & SVM_FIFO_F_LL_TRACKED)
1014     pfss_fifo_add_active_list (pfss, nf);
1015
1016   /* Allocate shared hdr and chunks to be collected at detach in return
1017    * for those that are being attached now */
1018   of = *f;
1019   of->hdr_at_attach = fsh_try_alloc_fifo_hdr (fs->h, fss);
1020
1021   c = fs_chunk_ptr (fs->h, nf->shr->start_chunk);
1022   of->chunks_at_attach = pc = fsh_try_alloc_chunk (fs->h, fss, c->length);
1023
1024   while ((c = fs_chunk_ptr (fs->h, c->next)))
1025     {
1026       nc = fsh_try_alloc_chunk (fs->h, fss, c->length);
1027       pc->next = fs_chunk_sptr (fs->h, nc);
1028       pc = nc;
1029     }
1030
1031   nf->shr->slice_index = slice_index;
1032   *f = nf;
1033 }
1034
1035 uword
1036 fifo_segment_fifo_offset (svm_fifo_t *f)
1037 {
1038   return (u8 *) f->shr - (u8 *) f->fs_hdr;
1039 }
1040
1041 svm_msg_q_t *
1042 fifo_segment_msg_q_alloc (fifo_segment_t *fs, u32 mq_index,
1043                           svm_msg_q_cfg_t *cfg)
1044 {
1045   fifo_segment_header_t *fsh = fs->h;
1046   svm_msg_q_shared_t *smq;
1047   svm_msg_q_t *mq;
1048   void *base;
1049   u32 size;
1050
1051   if (!fs->mqs)
1052     {
1053       u32 n_mqs = clib_max (fs->h->n_mqs, 1);
1054       vec_validate (fs->mqs, n_mqs - 1);
1055     }
1056
1057   size = svm_msg_q_size_to_alloc (cfg);
1058   base = fsh_alloc_aligned (fsh, size, 8);
1059   fsh->n_reserved_bytes += size;
1060
1061   smq = svm_msg_q_init (base, cfg);
1062   mq = vec_elt_at_index (fs->mqs, mq_index);
1063   svm_msg_q_attach (mq, smq);
1064
1065   return mq;
1066 }
1067
1068 svm_msg_q_t *
1069 fifo_segment_msg_q_attach (fifo_segment_t *fs, uword offset, u32 mq_index)
1070 {
1071   svm_msg_q_t *mq;
1072
1073   if (!fs->mqs)
1074     {
1075       u32 n_mqs = clib_max (fs->h->n_mqs, 1);
1076       vec_validate (fs->mqs, n_mqs - 1);
1077     }
1078
1079   mq = vec_elt_at_index (fs->mqs, mq_index);
1080
1081   if (!mq->q.shr)
1082     {
1083       svm_msg_q_shared_t *smq;
1084       smq = (svm_msg_q_shared_t *) ((u8 *) fs->h + offset);
1085       svm_msg_q_attach (mq, smq);
1086     }
1087
1088   ASSERT (fifo_segment_msg_q_offset (fs, mq_index) == offset);
1089
1090   return mq;
1091 }
1092
1093 void
1094 fifo_segment_msg_qs_discover (fifo_segment_t *fs, int *fds, u32 n_fds)
1095 {
1096   svm_msg_q_shared_t *smq;
1097   u32 n_mqs, size, i;
1098   uword offset = 0, n_alloced;
1099   svm_msg_q_t *mq;
1100
1101   n_mqs = fs->h->n_mqs;
1102   if (n_fds && n_mqs != n_fds)
1103     {
1104       clib_warning ("expected %u fds got %u", n_mqs, n_fds);
1105       return;
1106     }
1107
1108   vec_validate (fs->mqs, n_mqs - 1);
1109   n_alloced = fs->h->n_reserved_bytes - fs->h->start_byte_index;
1110   ASSERT (n_alloced % n_mqs == 0);
1111   size = n_alloced / n_mqs;
1112
1113   offset = fs->h->start_byte_index;
1114   for (i = 0; i < n_mqs; i++)
1115     {
1116       mq = vec_elt_at_index (fs->mqs, i);
1117       smq = (svm_msg_q_shared_t *) ((u8 *) fs->h + offset);
1118       svm_msg_q_attach (mq, smq);
1119       if (n_fds)
1120         svm_msg_q_set_eventfd (mq, fds[i]);
1121       offset += size;
1122     }
1123 }
1124
1125 uword
1126 fifo_segment_msg_q_offset (fifo_segment_t *fs, u32 mq_index)
1127 {
1128   svm_msg_q_t *mq = vec_elt_at_index (fs->mqs, mq_index);
1129
1130   if (mq->q.shr == 0)
1131     return ~0ULL;
1132
1133   return (uword) ((u8 *) mq->q.shr - (u8 *) fs->h) -
1134          sizeof (svm_msg_q_shared_t);
1135 }
1136
1137 int
1138 fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
1139                                  u32 batch_size)
1140 {
1141   fifo_segment_header_t *fsh = fs->h;
1142   fifo_segment_slice_t *fss;
1143
1144   fss = fsh_slice_get (fsh, slice_index);
1145   return fsh_try_alloc_fifo_hdr_batch (fsh, fss, batch_size);
1146 }
1147
1148 int
1149 fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
1150                                    u32 chunk_size, u32 batch_size)
1151 {
1152   fifo_segment_header_t *fsh = fs->h;
1153   fifo_segment_slice_t *fss;
1154   u32 fl_index;
1155
1156   if (!fs_chunk_size_is_valid (fsh, chunk_size))
1157     {
1158       clib_warning ("chunk size out of range %d", chunk_size);
1159       return -1;
1160     }
1161
1162   fl_index = fs_freelist_for_size (chunk_size);
1163   fss = fsh_slice_get (fsh, slice_index);
1164
1165   return fsh_try_alloc_chunk_batch (fsh, fss, fl_index, batch_size);
1166 }
1167
1168 /**
1169  * Pre-allocates fifo pairs in fifo segment
1170  */
1171 void
1172 fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
1173                                      u32 rx_fifo_size, u32 tx_fifo_size,
1174                                      u32 * n_fifo_pairs)
1175 {
1176   u32 rx_rounded_data_size, tx_rounded_data_size, pair_size, pairs_to_alloc;
1177   u32 hdrs, pairs_per_slice, alloc_now;
1178   fifo_segment_header_t *fsh = fs->h;
1179   int rx_fl_index, tx_fl_index, i;
1180   fifo_segment_slice_t *fss;
1181   uword space_available;
1182
1183   /* Parameter check */
1184   if (rx_fifo_size == 0 || tx_fifo_size == 0 || *n_fifo_pairs == 0)
1185     return;
1186
1187   if (!fs_chunk_size_is_valid (fsh, rx_fifo_size))
1188     {
1189       clib_warning ("rx fifo_size out of range %d", rx_fifo_size);
1190       return;
1191     }
1192
1193   if (!fs_chunk_size_is_valid (fsh, tx_fifo_size))
1194     {
1195       clib_warning ("tx fifo_size out of range %d", tx_fifo_size);
1196       return;
1197     }
1198
1199   rx_rounded_data_size = (1 << (max_log2 (rx_fifo_size)));
1200   rx_fl_index = fs_freelist_for_size (rx_fifo_size);
1201   tx_rounded_data_size = (1 << (max_log2 (tx_fifo_size)));
1202   tx_fl_index = fs_freelist_for_size (tx_fifo_size);
1203
1204   hdrs = sizeof (svm_fifo_t) + sizeof (svm_fifo_chunk_t);
1205
1206   /* Calculate space requirements */
1207   pair_size = 2 * hdrs + rx_rounded_data_size + tx_rounded_data_size;
1208   space_available = fsh_n_free_bytes (fsh);
1209   pairs_to_alloc = space_available / pair_size;
1210   pairs_to_alloc = clib_min (pairs_to_alloc, *n_fifo_pairs);
1211   pairs_per_slice = pairs_to_alloc / fs->n_slices;
1212   pairs_per_slice += pairs_to_alloc % fs->n_slices ? 1 : 0;
1213
1214   if (!pairs_per_slice)
1215     return;
1216
1217   for (i = 0; i < fs->n_slices; i++)
1218     {
1219       alloc_now = clib_min (pairs_per_slice, *n_fifo_pairs);
1220       if (0 == alloc_now)
1221         break;
1222
1223       fss = fsh_slice_get (fsh, i);
1224       if (fs_try_alloc_fifo_batch (fsh, fss, rx_fl_index, alloc_now))
1225         clib_warning ("rx prealloc failed: pairs %u", alloc_now);
1226       if (fs_try_alloc_fifo_batch (fsh, fss, tx_fl_index, alloc_now))
1227         clib_warning ("tx prealloc failed: pairs %u", alloc_now);
1228
1229       /* Account for the pairs allocated */
1230       *n_fifo_pairs -= alloc_now;
1231     }
1232 }
1233
1234 /**
1235  * Get number of active fifos
1236  */
1237 u32
1238 fifo_segment_num_fifos (fifo_segment_t * fs)
1239 {
1240   return fsh_n_active_fifos (fs->h);
1241 }
1242
1243 static u32
1244 fs_slice_num_free_fifos (fifo_segment_header_t *fsh, fifo_segment_slice_t *fss)
1245 {
1246   svm_fifo_shared_t *f;
1247   u32 count = 0;
1248
1249   f = fs_ptr (fsh, fss->free_fifos);
1250   if (f == 0)
1251     return 0;
1252
1253   while (f)
1254     {
1255       f = fs_ptr (fsh, f->next);
1256       count++;
1257     }
1258   return count;
1259 }
1260
1261 u32
1262 fifo_segment_num_free_fifos (fifo_segment_t * fs)
1263 {
1264   fifo_segment_header_t *fsh = fs->h;
1265   fifo_segment_slice_t *fss;
1266   int slice_index;
1267   u32 count = 0;
1268
1269   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1270     {
1271       fss = fsh_slice_get (fsh, slice_index);
1272       count += fs_slice_num_free_fifos (fsh, fss);
1273     }
1274   return count;
1275 }
1276
1277 static u32
1278 fs_slice_num_free_chunks (fifo_segment_header_t *fsh,
1279                           fifo_segment_slice_t *fss, u32 size)
1280 {
1281   u32 count = 0, rounded_size, fl_index;
1282   svm_fifo_chunk_t *c;
1283   int i;
1284
1285   /* Count all free chunks? */
1286   if (size == ~0)
1287     {
1288       for (i = 0; i < FS_CHUNK_VEC_LEN; i++)
1289         {
1290           c = fss_chunk_free_list_head (fsh, fss, i);
1291           if (c == 0)
1292             continue;
1293
1294           while (c)
1295             {
1296               c = fs_chunk_ptr (fsh, c->next);
1297               count++;
1298             }
1299         }
1300       return count;
1301     }
1302
1303   rounded_size = (1 << (max_log2 (size)));
1304   fl_index = fs_freelist_for_size (rounded_size);
1305
1306   if (fl_index >= FS_CHUNK_VEC_LEN)
1307     return 0;
1308
1309   c = fss_chunk_free_list_head (fsh, fss, fl_index);
1310   if (c == 0)
1311     return 0;
1312
1313   while (c)
1314     {
1315       c = fs_chunk_ptr (fsh, c->next);
1316       count++;
1317     }
1318   return count;
1319 }
1320
1321 u32
1322 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size)
1323 {
1324   fifo_segment_header_t *fsh = fs->h;
1325   fifo_segment_slice_t *fss;
1326   int slice_index;
1327   u32 count = 0;
1328
1329   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1330     {
1331       fss = fsh_slice_get (fsh, slice_index);
1332       count += fs_slice_num_free_chunks (fsh, fss, size);
1333     }
1334   return count;
1335 }
1336
1337 uword
1338 fifo_segment_size (fifo_segment_t * fs)
1339 {
1340   return fs->h->max_byte_index - fs->h->n_reserved_bytes;
1341 }
1342
1343 u8
1344 fsh_has_reached_mem_limit (fifo_segment_header_t * fsh)
1345 {
1346   return (fsh->flags & FIFO_SEGMENT_F_MEM_LIMIT) ? 1 : 0;
1347 }
1348
1349 void
1350 fsh_reset_mem_limit (fifo_segment_header_t * fsh)
1351 {
1352   fsh->flags &= ~FIFO_SEGMENT_F_MEM_LIMIT;
1353 }
1354
1355 void *
1356 fifo_segment_alloc (fifo_segment_t *fs, uword size)
1357 {
1358   void *rv = fsh_alloc (fs->h, size);
1359   /* Mark externally allocated bytes as reserved. This helps
1360    * @ref fifo_segment_size report bytes used only for fifos */
1361   fs->h->n_reserved_bytes += size;
1362   return rv;
1363 }
1364
1365 uword
1366 fifo_segment_free_bytes (fifo_segment_t * fs)
1367 {
1368   return fsh_n_free_bytes (fs->h);
1369 }
1370
1371 uword
1372 fifo_segment_cached_bytes (fifo_segment_t * fs)
1373 {
1374   return fsh_n_cached_bytes (fs->h);
1375 }
1376
1377 uword
1378 fifo_segment_available_bytes (fifo_segment_t * fs)
1379 {
1380   return fsh_n_free_bytes (fs->h) + fsh_n_cached_bytes (fs->h);
1381 }
1382
1383 uword
1384 fifo_segment_fl_chunk_bytes (fifo_segment_t * fs)
1385 {
1386   fifo_segment_header_t *fsh = fs->h;
1387   fifo_segment_slice_t *fss;
1388   uword n_bytes = 0;
1389   int slice_index;
1390
1391   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1392     {
1393       fss = fsh_slice_get (fsh, slice_index);
1394       n_bytes += fss_fl_chunk_bytes (fss);
1395     }
1396
1397   return n_bytes;
1398 }
1399
1400 u8
1401 fifo_segment_has_fifos (fifo_segment_t * fs)
1402 {
1403   return (fsh_n_active_fifos (fs->h) != 0);
1404 }
1405
1406 svm_fifo_t *
1407 fifo_segment_get_slice_fifo_list (fifo_segment_t * fs, u32 slice_index)
1408 {
1409   fifo_slice_private_t *pfss;
1410
1411   pfss = fs_slice_private_get (fs, slice_index);
1412   return pfss->active_fifos;
1413 }
1414
1415 u8
1416 fifo_segment_get_mem_usage (fifo_segment_t * fs)
1417 {
1418   uword size, in_use;
1419
1420   size = fifo_segment_size (fs);
1421   in_use =
1422     size - fifo_segment_free_bytes (fs) - fifo_segment_cached_bytes (fs);
1423   return (in_use * 100) / size;
1424 }
1425
1426 fifo_segment_mem_status_t
1427 fifo_segment_determine_status (fifo_segment_header_t * fsh, u8 usage)
1428 {
1429   if (!fsh->high_watermark || !fsh->low_watermark)
1430     return MEMORY_PRESSURE_NO_PRESSURE;
1431
1432   /* once the no-memory is detected, the status continues
1433    * until memory usage gets below the high watermark
1434    */
1435   if (fsh_has_reached_mem_limit (fsh))
1436     {
1437       if (usage >= fsh->high_watermark)
1438         return MEMORY_PRESSURE_NO_MEMORY;
1439       else
1440         fsh_reset_mem_limit (fsh);
1441     }
1442
1443   if (usage >= fsh->high_watermark)
1444     return MEMORY_PRESSURE_HIGH_PRESSURE;
1445
1446   else if (usage >= fsh->low_watermark)
1447     return MEMORY_PRESSURE_LOW_PRESSURE;
1448
1449   return MEMORY_PRESSURE_NO_PRESSURE;
1450 }
1451
1452 fifo_segment_mem_status_t
1453 fifo_segment_get_mem_status (fifo_segment_t * fs)
1454 {
1455   fifo_segment_header_t *fsh = fs->h;
1456   u8 usage = fifo_segment_get_mem_usage (fs);
1457
1458   return fifo_segment_determine_status (fsh, usage);
1459 }
1460
1461 u8 *
1462 format_fifo_segment_type (u8 * s, va_list * args)
1463 {
1464   fifo_segment_t *sp;
1465   sp = va_arg (*args, fifo_segment_t *);
1466   ssvm_segment_type_t st = ssvm_type (&sp->ssvm);
1467
1468   if (st == SSVM_SEGMENT_PRIVATE)
1469     s = format (s, "%s", "private");
1470   else if (st == SSVM_SEGMENT_MEMFD)
1471     s = format (s, "%s", "memfd");
1472   else if (st == SSVM_SEGMENT_SHM)
1473     s = format (s, "%s", "shm");
1474   else
1475     s = format (s, "%s", "unknown");
1476   return s;
1477 }
1478
1479 /**
1480  * Segment format function
1481  */
1482 u8 *
1483 format_fifo_segment (u8 * s, va_list * args)
1484 {
1485   u32 count, indent, active_fifos, free_fifos;
1486   fifo_segment_t *fs = va_arg (*args, fifo_segment_t *);
1487   int verbose __attribute__ ((unused)) = va_arg (*args, int);
1488   uword est_chunk_bytes, est_free_seg_bytes, free_chunks;
1489   uword chunk_bytes = 0, free_seg_bytes, chunk_size;
1490   uword tracked_cached_bytes;
1491   uword fifo_hdr = 0, reserved;
1492   fifo_segment_header_t *fsh;
1493   fifo_segment_slice_t *fss;
1494   svm_fifo_chunk_t *c;
1495   u32 slice_index;
1496   char *address;
1497   size_t size;
1498   int i;
1499   uword allocated, in_use, virt;
1500   f64 usage;
1501   fifo_segment_mem_status_t mem_st;
1502
1503   indent = format_get_indent (s) + 2;
1504
1505   if (fs == 0)
1506     {
1507       s = format (s, "%-20s%10s%15s%15s%15s%15s", "Name", "Type",
1508                   "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
1509       return s;
1510     }
1511
1512   fifo_segment_info (fs, &address, &size);
1513   active_fifos = fifo_segment_num_fifos (fs);
1514   free_fifos = fifo_segment_num_free_fifos (fs);
1515
1516   s = format (s, "%-20v%10U%15llu%15u%15u%15llx", ssvm_name (&fs->ssvm),
1517               format_fifo_segment_type, fs, size >> 20ULL, active_fifos,
1518               free_fifos, address);
1519
1520   if (!verbose)
1521     return s;
1522
1523   fsh = fs->h;
1524
1525   free_chunks = fifo_segment_num_free_chunks (fs, ~0);
1526   if (free_chunks)
1527     s =
1528       format (s, "\n\n%UFree/Allocated chunks by size:\n", format_white_space,
1529               indent + 2);
1530   else
1531     s = format (s, "\n");
1532
1533   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1534     {
1535       fss = fsh_slice_get (fsh, slice_index);
1536       for (i = 0; i < FS_CHUNK_VEC_LEN; i++)
1537         {
1538           c = fss_chunk_free_list_head (fsh, fss, i);
1539           if (c == 0 && fss->num_chunks[i] == 0)
1540             continue;
1541           count = 0;
1542           while (c)
1543             {
1544               c = fs_chunk_ptr (fsh, c->next);
1545               count++;
1546             }
1547
1548           chunk_size = fs_freelist_index_to_size (i);
1549           s = format (s, "%U%-5u kB: %u/%u\n", format_white_space, indent + 2,
1550                       chunk_size >> 10, count, fss->num_chunks[i]);
1551
1552           chunk_bytes += count * chunk_size;
1553         }
1554     }
1555
1556   fifo_hdr = free_fifos * sizeof (svm_fifo_t);
1557   est_chunk_bytes = fifo_segment_fl_chunk_bytes (fs);
1558   est_free_seg_bytes = fifo_segment_free_bytes (fs);
1559   free_seg_bytes = fifo_segment_free_bytes (fs);
1560   tracked_cached_bytes = fifo_segment_cached_bytes (fs);
1561   allocated = fifo_segment_size (fs);
1562   in_use = fifo_segment_size (fs) - est_free_seg_bytes - tracked_cached_bytes;
1563   usage = (100.0 * in_use) / allocated;
1564   mem_st = fifo_segment_get_mem_status (fs);
1565   virt = fsh_virtual_mem (fsh);
1566   reserved = fsh->n_reserved_bytes;
1567
1568   s = format (s, "\n%Useg free bytes: %U (%lu) estimated: %U (%lu) reserved:"
1569               " %U (%lu)\n", format_white_space, indent + 2,
1570               format_memory_size, free_seg_bytes, free_seg_bytes,
1571               format_memory_size, est_free_seg_bytes, est_free_seg_bytes,
1572               format_memory_size, reserved, reserved);
1573   s = format (s, "%Uchunk free bytes: %U (%lu) estimated: %U (%lu) tracked:"
1574               " %U (%lu)\n", format_white_space, indent + 2,
1575               format_memory_size, chunk_bytes, chunk_bytes,
1576               format_memory_size, est_chunk_bytes, est_chunk_bytes,
1577               format_memory_size, tracked_cached_bytes, tracked_cached_bytes);
1578   s = format (s, "%Ufifo active: %u hdr free: %u bytes: %U (%u) \n",
1579               format_white_space, indent + 2, fsh->n_active_fifos, free_fifos,
1580               format_memory_size, fifo_hdr, fifo_hdr);
1581   s = format (s, "%Usegment usage: %.2f%% (%U / %U) virt: %U status: %s\n",
1582               format_white_space, indent + 2, usage, format_memory_size,
1583               in_use, format_memory_size, allocated, format_memory_size, virt,
1584               fifo_segment_mem_status_strings[mem_st]);
1585   s = format (s, "\n");
1586
1587   return s;
1588 }
1589
1590 /*
1591  * fd.io coding-style-patch-verification: ON
1592  *
1593  * Local Variables:
1594  * eval: (c-set-style "gnu")
1595  * End:
1596  */