src/svm/fifo_segment.c

   1 /*
   2  * Copyright (c) 2016-2019 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #include <svm/fifo_segment.h>
  17
  18 /**
  19  * Fifo segment free space
  20  *
  21  * Queries the underlying memory manager, dlmalloc, for free space. Since this
  22  * ends up walking the internal data structures, it should not be called
  23  * indiscriminately.
  24  *
  25  * @param fs            fifo segment
  26  * @return              number of free bytes
  27  */
  28 static uword
  29 fsh_free_space (fifo_segment_header_t * fsh)
  30 {
  31   struct dlmallinfo dlminfo;
  32
  33   dlminfo = mspace_mallinfo (fsh->ssvm_sh->heap);
  34   return dlminfo.fordblks;
  35 }
  36
  37 static inline void
  38 fsh_free_bytes_sub (fifo_segment_header_t * fsh, int size)
  39 {
  40   clib_atomic_fetch_sub_rel (&fsh->n_free_bytes, size);
  41 }
  42
  43 static inline uword
  44 fsh_n_free_bytes (fifo_segment_header_t * fsh)
  45 {
  46   uword n_free = clib_atomic_load_relax_n (&fsh->n_free_bytes);
  47   return n_free > fsh->n_reserved_bytes ? n_free - fsh->n_reserved_bytes : 0;
  48 }
  49
  50 static inline void
  51 fsh_update_free_bytes (fifo_segment_header_t * fsh)
  52 {
  53   clib_atomic_store_rel_n (&fsh->n_free_bytes, fsh_free_space (fsh));
  54 }
  55
  56 static void
  57 fsh_check_mem (fifo_segment_header_t * fsh)
  58 {
  59   uword thresh;
  60
  61   if (fsh->flags & FIFO_SEGMENT_F_MEM_LIMIT)
  62     return;
  63
  64   thresh = clib_max (0.01 * fsh->ssvm_sh->ssvm_size,
  65                      2 * fsh->n_reserved_bytes);
  66   if (fsh->n_free_bytes > thresh)
  67     return;
  68
  69   fsh->flags |= FIFO_SEGMENT_F_MEM_LIMIT;
  70   fsh_update_free_bytes (fsh);
  71 }
  72
  73 static inline fifo_segment_slice_t *
  74 fsh_slice_get (fifo_segment_header_t * fsh, u32 slice_index)
  75 {
  76   return &fsh->slices[slice_index];
  77 }
  78
  79 static inline void
  80 fsh_active_fifos_update (fifo_segment_header_t * fsh, int inc)
  81 {
  82   clib_atomic_fetch_add_rel (&fsh->n_active_fifos, inc);
  83 }
  84
  85 /**
  86  * Initialize fifo segment shared header
  87  */
  88 int
  89 fifo_segment_init (fifo_segment_t * fs)
  90 {
  91   fifo_segment_header_t *fsh;
  92   fifo_segment_slice_t *fss;
  93   ssvm_shared_header_t *sh;
  94   u32 max_chunk_sz, max_chunks;
  95   uword max_fifo;
  96   void *oldheap;
  97   int i;
  98
  99   sh = fs->ssvm.sh;
 100   oldheap = ssvm_push_heap (sh);
 101
 102   /*
 103    * Manually align the fifo segment header to sizeof(uword) = 8 bytes.
 104    * Long story made short: the "process-private" fifo segment
 105    * is allocated from the main heap, not mmapped. dlmalloc
 106    * only guarantees 4-byte alignment, and on aarch64
 107    * the fsh can end up 4-byte but not 8-byte aligned.
 108    * That eventually causes the atomic op in fifo_segment_update_free_bytes
 109    * to backfire.
 110    */
 111   fsh = clib_mem_alloc_aligned (sizeof (*fsh), sizeof (uword));
 112   clib_memset (fsh, 0, sizeof (*fsh));
 113   fs->h = sh->opaque[0] = fsh;
 114   fs->n_slices = clib_max (fs->n_slices, 1);
 115
 116   fsh->ssvm_sh = fs->ssvm.sh;
 117   fsh->n_slices = fs->n_slices;
 118   max_fifo = clib_min ((fsh_free_space (fsh) - 4096) / 2,
 119                        FIFO_SEGMENT_MAX_FIFO_SIZE);
 120   fsh->max_log2_chunk_size = max_log2 (max_fifo);
 121
 122   fsh->slices = clib_mem_alloc (sizeof (*fss) * fs->n_slices);
 123   clib_memset (fsh->slices, 0, sizeof (*fss) * fs->n_slices);
 124   max_chunk_sz = fsh->max_log2_chunk_size - FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE;
 125
 126   for (i = 0; i < fs->n_slices; i++)
 127     {
 128       fss = fsh_slice_get (fsh, i);
 129       vec_validate_init_empty (fss->free_chunks, max_chunk_sz, 0);
 130     }
 131
 132   ssvm_pop_heap (oldheap);
 133
 134   fsh->n_free_bytes = fsh_free_space (fsh);
 135   max_chunks = fsh->n_free_bytes / FIFO_SEGMENT_MIN_FIFO_SIZE;
 136   fsh->n_reserved_bytes = (max_chunks / 4) * sizeof (rb_node_t);
 137   sh->ready = 1;
 138   return (0);
 139 }
 140
 141 /**
 142  * Create a fifo segment and initialize as master
 143  */
 144 int
 145 fifo_segment_create (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
 146 {
 147   fifo_segment_t *fs;
 148   uword baseva;
 149   int rv;
 150
 151   /* Allocate a fresh segment */
 152   pool_get_zero (sm->segments, fs);
 153
 154   baseva = a->segment_type == SSVM_SEGMENT_PRIVATE ? ~0ULL : sm->next_baseva;
 155   fs->ssvm.ssvm_size = a->segment_size;
 156   fs->ssvm.i_am_master = 1;
 157   fs->ssvm.my_pid = getpid ();
 158   fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
 159   fs->ssvm.requested_va = baseva;
 160
 161   if ((rv = ssvm_master_init (&fs->ssvm, a->segment_type)))
 162     {
 163       pool_put (sm->segments, fs);
 164       return (rv);
 165     }
 166
 167   /* Note: requested_va updated due to seg base addr randomization */
 168   sm->next_baseva = fs->ssvm.sh->ssvm_va + fs->ssvm.ssvm_size;
 169
 170   fifo_segment_init (fs);
 171   vec_add1 (a->new_segment_indices, fs - sm->segments);
 172   return (0);
 173 }
 174
 175 /**
 176  * Attach as slave to a fifo segment
 177  */
 178 int
 179 fifo_segment_attach (fifo_segment_main_t * sm, fifo_segment_create_args_t * a)
 180 {
 181   fifo_segment_t *fs;
 182   int rv;
 183
 184   pool_get_zero (sm->segments, fs);
 185
 186   fs->ssvm.ssvm_size = a->segment_size;
 187   fs->ssvm.my_pid = getpid ();
 188   fs->ssvm.name = format (0, "%s%c", a->segment_name, 0);
 189   fs->ssvm.requested_va = sm->next_baseva;
 190   if (a->segment_type == SSVM_SEGMENT_MEMFD)
 191     fs->ssvm.fd = a->memfd_fd;
 192   else
 193     fs->ssvm.attach_timeout = sm->timeout_in_seconds;
 194
 195   if ((rv = ssvm_slave_init (&fs->ssvm, a->segment_type)))
 196     {
 197       _vec_len (fs) = vec_len (fs) - 1;
 198       return (rv);
 199     }
 200
 201   /* Fish the segment header */
 202   fs->h = fs->ssvm.sh->opaque[0];
 203
 204   vec_add1 (a->new_segment_indices, fs - sm->segments);
 205   return (0);
 206 }
 207
 208 void
 209 fifo_segment_delete (fifo_segment_main_t * sm, fifo_segment_t * s)
 210 {
 211   ssvm_delete (&s->ssvm);
 212   clib_memset (s, 0xfe, sizeof (*s));
 213   pool_put (sm->segments, s);
 214 }
 215
 216 u32
 217 fifo_segment_index (fifo_segment_main_t * sm, fifo_segment_t * s)
 218 {
 219   return s - sm->segments;
 220 }
 221
 222 fifo_segment_t *
 223 fifo_segment_get_segment (fifo_segment_main_t * sm, u32 segment_index)
 224 {
 225   return pool_elt_at_index (sm->segments, segment_index);
 226 }
 227
 228 void
 229 fifo_segment_info (fifo_segment_t * seg, char **address, size_t * size)
 230 {
 231   *address = (char *) seg->ssvm.sh->ssvm_va;
 232   *size = seg->ssvm.ssvm_size;
 233 }
 234
 235 void
 236 fifo_segment_main_init (fifo_segment_main_t * sm, u64 baseva,
 237                         u32 timeout_in_seconds)
 238 {
 239   sm->next_baseva = baseva;
 240   sm->timeout_in_seconds = timeout_in_seconds;
 241 }
 242
 243 static inline u32
 244 fs_freelist_for_size (u32 size)
 245 {
 246   return max_log2 (size) - FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE;
 247 }
 248
 249 static inline u32
 250 fs_freelist_index_to_size (u32 fl_index)
 251 {
 252   return 1 << (fl_index + FIFO_SEGMENT_MIN_LOG2_FIFO_SIZE);
 253 }
 254
 255 static inline int
 256 fs_chunk_size_is_valid (fifo_segment_header_t * fsh, u32 size)
 257 {
 258   /*
 259    * 4K minimum. It's not likely that anything good will happen
 260    * with a smaller FIFO.
 261    */
 262   return size >= FIFO_SEGMENT_MIN_FIFO_SIZE
 263     && size <= (1 << fsh->max_log2_chunk_size);
 264 }
 265
 266 static svm_fifo_t *
 267 fs_try_alloc_fifo_freelist (fifo_segment_slice_t * fss,
 268                             u32 fl_index, u32 data_bytes)
 269 {
 270   svm_fifo_chunk_t *c;
 271   svm_fifo_t *f;
 272
 273   f = fss->free_fifos;
 274   c = fss->free_chunks[fl_index];
 275
 276   if (!f || !c)
 277     return 0;
 278
 279   fss->free_fifos = f->next;
 280   fss->free_chunks[fl_index] = c->next;
 281   c->next = c;
 282   c->start_byte = 0;
 283   c->length = data_bytes;
 284   memset (f, 0, sizeof (*f));
 285   f->start_chunk = c;
 286   f->end_chunk = c;
 287
 288   fss->n_fl_chunk_bytes -= fs_freelist_index_to_size (fl_index);
 289   return f;
 290 }
 291
 292 static svm_fifo_t *
 293 fs_try_alloc_fifo_freelist_multi_chunk (fifo_segment_header_t * fsh,
 294                                         fifo_segment_slice_t * fss,
 295                                         u32 data_bytes)
 296 {
 297   svm_fifo_chunk_t *c, *first = 0, *last = 0;
 298   u32 fl_index, fl_size, n_alloc = 0;
 299   svm_fifo_t *f;
 300
 301   f = fss->free_fifos;
 302   if (!f)
 303     {
 304       void *oldheap = ssvm_push_heap (fsh->ssvm_sh);
 305       f = clib_mem_alloc_aligned (sizeof (*f), CLIB_CACHE_LINE_BYTES);
 306       ssvm_pop_heap (oldheap);
 307       if (!f)
 308         return 0;
 309       memset (f, 0, sizeof (*f));
 310       fsh_free_bytes_sub (fsh, sizeof (*f));
 311     }
 312   else
 313     {
 314       fss->free_fifos = f->next;
 315     }
 316
 317   fl_index = fs_freelist_for_size (data_bytes);
 318   if (fl_index > 0)
 319     fl_index -= 1;
 320
 321   fl_size = fs_freelist_index_to_size (fl_index);
 322
 323   while (data_bytes)
 324     {
 325       c = fss->free_chunks[fl_index];
 326       if (c)
 327         {
 328           fss->free_chunks[fl_index] = c->next;
 329           if (!last)
 330             last = c;
 331           c->next = first;
 332           first = c;
 333           n_alloc += fl_size;
 334           c->length = clib_min (fl_size, data_bytes);
 335           data_bytes -= c->length;
 336         }
 337       else
 338         {
 339           /* Failed to allocate with smaller chunks */
 340           if (fl_index == 0)
 341             {
 342               /* free all chunks if any allocated */
 343               c = first;
 344               while (c)
 345                 {
 346                   fl_index = fs_freelist_for_size (c->length);
 347                   fl_size = fs_freelist_index_to_size (fl_index);
 348                   c->next = fss->free_chunks[fl_index];
 349                   fss->free_chunks[fl_index] = c;
 350                   fss->n_fl_chunk_bytes += fl_size;
 351                   data_bytes += fl_size;
 352                 }
 353               first = last = 0;
 354               fl_index = fs_freelist_for_size (data_bytes);
 355               if (fss->free_chunks[fl_index + 1])
 356                 {
 357                   fl_index += 1;
 358                   fl_size = fs_freelist_index_to_size (fl_index);
 359                   continue;
 360                 }
 361
 362               f->next = fss->free_fifos;
 363               fss->free_fifos = f;
 364               return 0;
 365             }
 366           fl_index -= 1;
 367           fl_size = fl_size >> 1;
 368         }
 369     }
 370
 371   f->start_chunk = first;
 372   f->end_chunk = last;
 373   last->next = first;
 374   fss->n_fl_chunk_bytes -= n_alloc;
 375   return f;
 376 }
 377
 378 static int
 379 fs_try_alloc_fifo_batch (fifo_segment_header_t * fsh,
 380                          fifo_segment_slice_t * fss,
 381                          u32 fl_index, u32 batch_size)
 382 {
 383   u32 hdrs, rounded_data_size;
 384   svm_fifo_chunk_t *c;
 385   svm_fifo_t *f;
 386   void *oldheap;
 387   uword size;
 388   u8 *fmem;
 389   int i;
 390
 391   rounded_data_size = fs_freelist_index_to_size (fl_index);
 392   hdrs = sizeof (*f) + sizeof (*c);
 393   size = (uword) (hdrs + rounded_data_size) * batch_size;
 394
 395   oldheap = ssvm_push_heap (fsh->ssvm_sh);
 396   fmem = clib_mem_alloc_aligned_at_offset (size, CLIB_CACHE_LINE_BYTES,
 397                                            0 /* align_offset */ ,
 398                                            0 /* os_out_of_memory */ );
 399   ssvm_pop_heap (oldheap);
 400
 401   /* Out of space.. */
 402   if (fmem == 0)
 403     return -1;
 404
 405   /* Carve fifo + chunk space */
 406   for (i = 0; i < batch_size; i++)
 407     {
 408       f = (svm_fifo_t *) fmem;
 409       memset (f, 0, sizeof (*f));
 410       f->next = fss->free_fifos;
 411       fss->free_fifos = f;
 412       c = (svm_fifo_chunk_t *) (fmem + sizeof (*f));
 413       c->start_byte = 0;
 414       c->length = rounded_data_size;
 415       c->rb_index = RBTREE_TNIL_INDEX;
 416       c->next = fss->free_chunks[fl_index];
 417       fss->free_chunks[fl_index] = c;
 418       fmem += hdrs + rounded_data_size;
 419     }
 420
 421   fss->n_fl_chunk_bytes += batch_size * rounded_data_size;
 422   fsh_free_bytes_sub (fsh, size);
 423
 424   return 0;
 425 }
 426
 427 /**
 428  * Try to allocate new fifo
 429  *
 430  * Tries the following steps in order:
 431  * - grab fifo and chunk from freelists
 432  * - batch fifo and chunk allocation
 433  * - single fifo allocation
 434  * - grab multiple fifo chunks from freelists
 435  */
 436 static svm_fifo_t *
 437 fs_try_alloc_fifo (fifo_segment_header_t * fsh, fifo_segment_slice_t * fss,
 438                    u32 data_bytes)
 439 {
 440   u32 fifo_sz, fl_index;
 441   svm_fifo_t *f = 0;
 442   uword n_free_bytes;
 443
 444   fl_index = fs_freelist_for_size (data_bytes);
 445   fifo_sz = sizeof (svm_fifo_t) + sizeof (svm_fifo_chunk_t);
 446   fifo_sz += 1 << max_log2 (data_bytes);
 447
 448   if (fss->free_fifos && fss->free_chunks[fl_index])
 449     {
 450       f = fs_try_alloc_fifo_freelist (fss, fl_index, data_bytes);
 451       if (f)
 452         goto done;
 453     }
 454
 455   fsh_check_mem (fsh);
 456   n_free_bytes = fsh_n_free_bytes (fsh);
 457   if (fifo_sz * FIFO_SEGMENT_ALLOC_BATCH_SIZE < n_free_bytes)
 458     {
 459       if (fs_try_alloc_fifo_batch (fsh, fss, fl_index,
 460                                    FIFO_SEGMENT_ALLOC_BATCH_SIZE))
 461         goto done;
 462
 463       f = fs_try_alloc_fifo_freelist (fss, fl_index, data_bytes);
 464       goto done;
 465     }
 466   if (fifo_sz <= n_free_bytes)
 467     {
 468       void *oldheap = ssvm_push_heap (fsh->ssvm_sh);
 469       f = svm_fifo_create (data_bytes);
 470       ssvm_pop_heap (oldheap);
 471       if (f)
 472         {
 473           fsh_free_bytes_sub (fsh, fifo_sz);
 474           goto done;
 475         }
 476     }
 477   if (data_bytes <= fss->n_fl_chunk_bytes)
 478     f = fs_try_alloc_fifo_freelist_multi_chunk (fsh, fss, data_bytes);
 479
 480 done:
 481
 482   return f;
 483 }
 484
 485 /**
 486  * Allocate fifo in fifo segment
 487  */
 488 svm_fifo_t *
 489 fifo_segment_alloc_fifo_w_slice (fifo_segment_t * fs, u32 slice_index,
 490                                  u32 data_bytes, fifo_segment_ftype_t ftype)
 491 {
 492   fifo_segment_header_t *fsh = fs->h;
 493   fifo_segment_slice_t *fss;
 494   svm_fifo_t *f = 0;
 495
 496   ASSERT (slice_index < fs->n_slices);
 497
 498   fss = fsh_slice_get (fsh, slice_index);
 499   f = fs_try_alloc_fifo (fsh, fss, data_bytes);
 500   if (!f)
 501     goto done;
 502
 503   f->slice_index = slice_index;
 504
 505   /* (re)initialize the fifo, as in svm_fifo_create */
 506   svm_fifo_init (f, data_bytes);
 507
 508   /* Initialize chunks and rbtree for multi-chunk fifos */
 509   if (f->start_chunk->next != f->start_chunk)
 510     svm_fifo_init_chunks (f);
 511
 512   /* If rx fifo type add to active fifos list. When cleaning up segment,
 513    * we need a list of active sessions that should be disconnected. Since
 514    * both rx and tx fifos keep pointers to the session, it's enough to track
 515    * only one. */
 516   if (ftype == FIFO_SEGMENT_RX_FIFO)
 517     {
 518       if (fss->fifos)
 519         {
 520           fss->fifos->prev = f;
 521           f->next = fss->fifos;
 522         }
 523       fss->fifos = f;
 524       f->flags |= SVM_FIFO_F_LL_TRACKED;
 525     }
 526   fsh_active_fifos_update (fsh, 1);
 527
 528 done:
 529   return (f);
 530 }
 531
 532 /**
 533  * Free fifo allocated in fifo segment
 534  */
 535 void
 536 fifo_segment_free_fifo (fifo_segment_t * fs, svm_fifo_t * f)
 537 {
 538   fifo_segment_header_t *fsh = fs->h;
 539   svm_fifo_chunk_t *cur, *next;
 540   fifo_segment_slice_t *fss;
 541   int fl_index;
 542
 543   ASSERT (f->refcnt > 0);
 544
 545   if (--f->refcnt > 0)
 546     return;
 547
 548   fss = fsh_slice_get (fsh, f->slice_index);
 549
 550   /* Remove from active list. Only rx fifos are tracked */
 551   if (f->flags & SVM_FIFO_F_LL_TRACKED)
 552     {
 553       if (f->prev)
 554         f->prev->next = f->next;
 555       else
 556         fss->fifos = f->next;
 557       if (f->next)
 558         f->next->prev = f->prev;
 559       f->flags &= ~SVM_FIFO_F_LL_TRACKED;
 560     }
 561
 562   /* Add to free list */
 563   f->next = fss->free_fifos;
 564   f->prev = 0;
 565   fss->free_fifos = f;
 566
 567   /* Free fifo chunks */
 568   cur = f->start_chunk;
 569   do
 570     {
 571       next = cur->next;
 572       fl_index = fs_freelist_for_size (cur->length);
 573       ASSERT (fl_index < vec_len (fss->free_chunks));
 574       cur->next = fss->free_chunks[fl_index];
 575       cur->rb_index = RBTREE_TNIL_INDEX;
 576       fss->free_chunks[fl_index] = cur;
 577       fss->n_fl_chunk_bytes += fs_freelist_index_to_size (fl_index);
 578       cur = next;
 579     }
 580   while (cur != f->start_chunk);
 581
 582   f->start_chunk = f->end_chunk = f->new_chunks = 0;
 583   f->head_chunk = f->tail_chunk = f->ooo_enq = f->ooo_deq = 0;
 584
 585   svm_fifo_free_chunk_lookup (f);
 586
 587   /* not allocated on segment heap */
 588   svm_fifo_free_ooo_data (f);
 589
 590   if (CLIB_DEBUG)
 591     {
 592       f->master_session_index = ~0;
 593       f->master_thread_index = ~0;
 594     }
 595
 596   fsh_active_fifos_update (fsh, -1);
 597 }
 598
 599 int
 600 fifo_segment_prealloc_fifo_hdrs (fifo_segment_t * fs, u32 slice_index,
 601                                  u32 batch_size)
 602 {
 603   fifo_segment_header_t *fsh = fs->h;
 604   fifo_segment_slice_t *fss;
 605   svm_fifo_t *f;
 606   void *oldheap;
 607   uword size;
 608   u8 *fmem;
 609   int i;
 610
 611   fss = fsh_slice_get (fsh, slice_index);
 612   size = (uword) (sizeof (*f)) * batch_size;
 613
 614   oldheap = ssvm_push_heap (fsh->ssvm_sh);
 615   fmem = clib_mem_alloc_aligned_at_offset (size, CLIB_CACHE_LINE_BYTES,
 616                                            0 /* align_offset */ ,
 617                                            0 /* os_out_of_memory */ );
 618   ssvm_pop_heap (oldheap);
 619
 620   /* Out of space.. */
 621   if (fmem == 0)
 622     return -1;
 623
 624   /* Carve fifo + chunk space */
 625   for (i = 0; i < batch_size; i++)
 626     {
 627       f = (svm_fifo_t *) fmem;
 628       memset (f, 0, sizeof (*f));
 629       f->next = fss->free_fifos;
 630       fss->free_fifos = f;
 631       fmem += sizeof (*f);
 632     }
 633
 634   fsh_free_bytes_sub (fsh, size);
 635
 636   return 0;
 637 }
 638
 639 int
 640 fifo_segment_prealloc_fifo_chunks (fifo_segment_t * fs, u32 slice_index,
 641                                    u32 chunk_size, u32 batch_size)
 642 {
 643   fifo_segment_header_t *fsh = fs->h;
 644   u32 rounded_data_size, fl_index;
 645   fifo_segment_slice_t *fss;
 646   svm_fifo_chunk_t *c;
 647   void *oldheap;
 648   uword size;
 649   u8 *cmem;
 650   int i;
 651
 652   if (!fs_chunk_size_is_valid (fsh, chunk_size))
 653     {
 654       clib_warning ("chunk size out of range %d", chunk_size);
 655       return -1;
 656     }
 657
 658   fl_index = fs_freelist_for_size (chunk_size);
 659   rounded_data_size = fs_freelist_index_to_size (fl_index);
 660   size = (uword) (sizeof (*c) + rounded_data_size) * batch_size;
 661
 662   oldheap = ssvm_push_heap (fsh->ssvm_sh);
 663   cmem = clib_mem_alloc_aligned_at_offset (size, CLIB_CACHE_LINE_BYTES,
 664                                            0 /* align_offset */ ,
 665                                            0 /* os_out_of_memory */ );
 666   ssvm_pop_heap (oldheap);
 667
 668   /* Out of space.. */
 669   if (cmem == 0)
 670     return -1;
 671
 672   fss = fsh_slice_get (fsh, slice_index);
 673
 674   /* Carve fifo + chunk space */
 675   for (i = 0; i < batch_size; i++)
 676     {
 677       c = (svm_fifo_chunk_t *) cmem;
 678       c->start_byte = 0;
 679       c->length = rounded_data_size;
 680       c->next = fss->free_chunks[fl_index];
 681       fss->free_chunks[fl_index] = c;
 682       cmem += sizeof (*c) + rounded_data_size;
 683     }
 684
 685   fss->n_fl_chunk_bytes += batch_size * rounded_data_size;
 686   fsh_free_bytes_sub (fsh, size);
 687
 688   return 0;
 689 }
 690
 691 /**
 692  * Pre-allocates fifo pairs in fifo segment
 693  */
 694 void
 695 fifo_segment_preallocate_fifo_pairs (fifo_segment_t * fs,
 696                                      u32 rx_fifo_size, u32 tx_fifo_size,
 697                                      u32 * n_fifo_pairs)
 698 {
 699   u32 rx_rounded_data_size, tx_rounded_data_size, pair_size, pairs_to_alloc;
 700   u32 hdrs, pairs_per_slice, alloc_now;
 701   fifo_segment_header_t *fsh = fs->h;
 702   int rx_fl_index, tx_fl_index, i;
 703   fifo_segment_slice_t *fss;
 704   uword space_available;
 705
 706   /* Parameter check */
 707   if (rx_fifo_size == 0 || tx_fifo_size == 0 || *n_fifo_pairs == 0)
 708     return;
 709
 710   if (!fs_chunk_size_is_valid (fsh, rx_fifo_size))
 711     {
 712       clib_warning ("rx fifo_size out of range %d", rx_fifo_size);
 713       return;
 714     }
 715
 716   if (!fs_chunk_size_is_valid (fsh, tx_fifo_size))
 717     {
 718       clib_warning ("tx fifo_size out of range %d", tx_fifo_size);
 719       return;
 720     }
 721
 722   rx_rounded_data_size = (1 << (max_log2 (rx_fifo_size)));
 723   rx_fl_index = fs_freelist_for_size (rx_fifo_size);
 724   tx_rounded_data_size = (1 << (max_log2 (tx_fifo_size)));
 725   tx_fl_index = fs_freelist_for_size (tx_fifo_size);
 726
 727   hdrs = sizeof (svm_fifo_t) + sizeof (svm_fifo_chunk_t);
 728
 729   /* Calculate space requirements */
 730   pair_size = 2 * hdrs + rx_rounded_data_size + tx_rounded_data_size;
 731   space_available = fsh_free_space (fsh);
 732   pairs_to_alloc = space_available / pair_size;
 733   pairs_to_alloc = clib_min (pairs_to_alloc, *n_fifo_pairs);
 734   pairs_per_slice = pairs_to_alloc / fs->n_slices;
 735   pairs_per_slice += pairs_to_alloc % fs->n_slices ? 1 : 0;
 736
 737   if (!pairs_per_slice)
 738     return;
 739
 740   for (i = 0; i < fs->n_slices; i++)
 741     {
 742       fss = fsh_slice_get (fsh, i);
 743       alloc_now = clib_min (pairs_per_slice, *n_fifo_pairs);
 744       if (fs_try_alloc_fifo_batch (fsh, fss, rx_fl_index, alloc_now))
 745         clib_warning ("rx prealloc failed: pairs %u", alloc_now);
 746       if (fs_try_alloc_fifo_batch (fsh, fss, tx_fl_index, alloc_now))
 747         clib_warning ("tx prealloc failed: pairs %u", alloc_now);
 748
 749       /* Account for the pairs allocated */
 750       *n_fifo_pairs -= alloc_now;
 751     }
 752 }
 753
 754 int
 755 fifo_segment_grow_fifo (fifo_segment_t * fs, svm_fifo_t * f, u32 chunk_size)
 756 {
 757   fifo_segment_header_t *fsh = fs->h;
 758   fifo_segment_slice_t *fss;
 759   svm_fifo_chunk_t *c;
 760   void *oldheap;
 761   int fl_index;
 762
 763   fl_index = fs_freelist_for_size (chunk_size);
 764   fss = fsh_slice_get (fsh, f->slice_index);
 765
 766   c = fss->free_chunks[fl_index];
 767
 768   if (!c)
 769     {
 770       fsh_check_mem (fsh);
 771       if (fsh_n_free_bytes (fsh) < chunk_size)
 772         return -1;
 773
 774       oldheap = ssvm_push_heap (fsh->ssvm_sh);
 775       c = svm_fifo_chunk_alloc (chunk_size);
 776       ssvm_pop_heap (oldheap);
 777
 778       if (!c)
 779         return -1;
 780
 781       fsh_free_bytes_sub (fsh, chunk_size + sizeof (*c));
 782     }
 783   else
 784     {
 785       fss->free_chunks[fl_index] = c->next;
 786       c->next = 0;
 787       fss->n_fl_chunk_bytes -= fs_freelist_index_to_size (fl_index);
 788     }
 789
 790   svm_fifo_add_chunk (f, c);
 791
 792   return 0;
 793 }
 794
 795 int
 796 fifo_segment_collect_fifo_chunks (fifo_segment_t * fs, svm_fifo_t * f)
 797 {
 798   fifo_segment_header_t *fsh = fs->h;
 799   svm_fifo_chunk_t *cur, *next;
 800   fifo_segment_slice_t *fss;
 801   int fl_index;
 802
 803   cur = svm_fifo_collect_chunks (f);
 804
 805   fss = fsh_slice_get (fsh, f->slice_index);
 806
 807   while (cur)
 808     {
 809       next = cur->next;
 810       fl_index = fs_freelist_for_size (cur->length);
 811       cur->next = fss->free_chunks[fl_index];
 812       fss->free_chunks[fl_index] = cur;
 813       cur = next;
 814     }
 815
 816   return 0;
 817 }
 818
 819 /**
 820  * Get number of active fifos
 821  */
 822 u32
 823 fifo_segment_num_fifos (fifo_segment_t * fs)
 824 {
 825   return clib_atomic_load_relax_n (&fs->h->n_active_fifos);
 826 }
 827
 828 static u32
 829 fs_slice_num_free_fifos (fifo_segment_slice_t * fss)
 830 {
 831   svm_fifo_t *f;
 832   u32 count = 0;
 833
 834   f = fss->free_fifos;
 835   if (f == 0)
 836     return 0;
 837
 838   while (f)
 839     {
 840       f = f->next;
 841       count++;
 842     }
 843   return count;
 844 }
 845
 846 u32
 847 fifo_segment_num_free_fifos (fifo_segment_t * fs)
 848 {
 849   fifo_segment_header_t *fsh = fs->h;
 850   fifo_segment_slice_t *fss;
 851   int slice_index;
 852   u32 count = 0;
 853
 854   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
 855     {
 856       fss = fsh_slice_get (fsh, slice_index);
 857       count += fs_slice_num_free_fifos (fss);
 858     }
 859   return count;
 860 }
 861
 862 static u32
 863 fs_slice_num_free_chunks (fifo_segment_slice_t * fss, u32 size)
 864 {
 865   u32 count = 0, rounded_size, fl_index;
 866   svm_fifo_chunk_t *c;
 867   int i;
 868
 869   /* Count all free chunks? */
 870   if (size == ~0)
 871     {
 872       for (i = 0; i < vec_len (fss->free_chunks); i++)
 873         {
 874           c = fss->free_chunks[i];
 875           if (c == 0)
 876             continue;
 877
 878           while (c)
 879             {
 880               c = c->next;
 881               count++;
 882             }
 883         }
 884       return count;
 885     }
 886
 887   rounded_size = (1 << (max_log2 (size)));
 888   fl_index = fs_freelist_for_size (rounded_size);
 889
 890   if (fl_index >= vec_len (fss->free_chunks))
 891     return 0;
 892
 893   c = fss->free_chunks[fl_index];
 894   if (c == 0)
 895     return 0;
 896
 897   while (c)
 898     {
 899       c = c->next;
 900       count++;
 901     }
 902   return count;
 903 }
 904
 905 u32
 906 fifo_segment_num_free_chunks (fifo_segment_t * fs, u32 size)
 907 {
 908   fifo_segment_header_t *fsh = fs->h;
 909   fifo_segment_slice_t *fss;
 910   int slice_index;
 911   u32 count = 0;
 912
 913   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
 914     {
 915       fss = fsh_slice_get (fsh, slice_index);
 916       count += fs_slice_num_free_chunks (fss, size);
 917     }
 918   return count;
 919 }
 920
 921 void
 922 fifo_segment_update_free_bytes (fifo_segment_t * fs)
 923 {
 924   fsh_update_free_bytes (fs->h);
 925 }
 926
 927 uword
 928 fifo_segment_free_bytes (fifo_segment_t * fs)
 929 {
 930   return fsh_n_free_bytes (fs->h);
 931 }
 932
 933 uword
 934 fifo_segment_fl_chunk_bytes (fifo_segment_t * fs)
 935 {
 936   fifo_segment_header_t *fsh = fs->h;
 937   fifo_segment_slice_t *fss;
 938   uword n_bytes = 0;
 939   int slice_index;
 940
 941   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
 942     {
 943       fss = fsh_slice_get (fsh, slice_index);
 944       n_bytes += fss->n_fl_chunk_bytes;
 945     }
 946
 947   return n_bytes;
 948 }
 949
 950 u8
 951 fifo_segment_has_fifos (fifo_segment_t * fs)
 952 {
 953   fifo_segment_header_t *fsh = fs->h;
 954   fifo_segment_slice_t *fss;
 955   int slice_index;
 956
 957   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
 958     {
 959       fss = fsh_slice_get (fsh, slice_index);
 960       if (fss->fifos)
 961         return 1;
 962     }
 963   return 0;
 964 }
 965
 966 svm_fifo_t *
 967 fifo_segment_get_slice_fifo_list (fifo_segment_t * fs, u32 slice_index)
 968 {
 969   fifo_segment_header_t *fsh = fs->h;
 970   fifo_segment_slice_t *fss;
 971
 972   fss = fsh_slice_get (fsh, slice_index);
 973   return fss->fifos;
 974 }
 975
 976 u8 *
 977 format_fifo_segment_type (u8 * s, va_list * args)
 978 {
 979   fifo_segment_t *sp;
 980   sp = va_arg (*args, fifo_segment_t *);
 981   ssvm_segment_type_t st = ssvm_type (&sp->ssvm);
 982
 983   if (st == SSVM_SEGMENT_PRIVATE)
 984     s = format (s, "%s", "private-heap");
 985   else if (st == SSVM_SEGMENT_MEMFD)
 986     s = format (s, "%s", "memfd");
 987   else if (st == SSVM_SEGMENT_SHM)
 988     s = format (s, "%s", "shm");
 989   else
 990     s = format (s, "%s", "unknown");
 991   return s;
 992 }
 993
 994 /**
 995  * Segment format function
 996  */
 997 u8 *
 998 format_fifo_segment (u8 * s, va_list * args)
 999 {
1000   u32 count, indent, active_fifos, free_fifos, fifo_hdr = 0;
1001   fifo_segment_t *fs = va_arg (*args, fifo_segment_t *);
1002   int verbose __attribute__ ((unused)) = va_arg (*args, int);
1003   uword est_chunk_bytes, est_free_seg_bytes, free_chunks;
1004   uword chunk_bytes = 0, free_seg_bytes, chunk_size;
1005   fifo_segment_header_t *fsh;
1006   fifo_segment_slice_t *fss;
1007   svm_fifo_chunk_t *c;
1008   u32 slice_index;
1009   char *address;
1010   size_t size;
1011   int i;
1012
1013   indent = format_get_indent (s) + 2;
1014
1015   if (fs == 0)
1016     {
1017       s = format (s, "%-15s%15s%15s%15s%15s%15s", "Name", "Type",
1018                   "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
1019       return s;
1020     }
1021
1022   fifo_segment_info (fs, &address, &size);
1023   active_fifos = fifo_segment_num_fifos (fs);
1024   free_fifos = fifo_segment_num_free_fifos (fs);
1025
1026   s = format (s, "%-15v%15U%15llu%15u%15u%15llx", ssvm_name (&fs->ssvm),
1027               format_fifo_segment_type, fs, size >> 20ULL, active_fifos,
1028               free_fifos, address);
1029
1030   if (!verbose)
1031     return s;
1032
1033   fsh = fs->h;
1034
1035   free_chunks = fifo_segment_num_free_chunks (fs, ~0);
1036   if (free_chunks)
1037     s = format (s, "\n\n%UFree chunks by size:\n", format_white_space,
1038                 indent + 2);
1039   else
1040     s = format (s, "\n");
1041
1042   for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1043     {
1044       fss = fsh_slice_get (fsh, slice_index);
1045       for (i = 0; i < vec_len (fss->free_chunks); i++)
1046         {
1047           c = fss->free_chunks[i];
1048           if (c == 0)
1049             continue;
1050           count = 0;
1051           while (c)
1052             {
1053               c = c->next;
1054               count++;
1055             }
1056
1057           chunk_size = fs_freelist_index_to_size (i);
1058           s = format (s, "%U%-5u kB: %u\n", format_white_space, indent + 2,
1059                       chunk_size >> 10, count);
1060
1061           chunk_bytes += count * chunk_size;
1062         }
1063     }
1064
1065   fifo_hdr = free_fifos * sizeof (svm_fifo_t);
1066   est_chunk_bytes = fifo_segment_fl_chunk_bytes (fs);
1067   est_free_seg_bytes = fifo_segment_free_bytes (fs);
1068   fifo_segment_update_free_bytes (fs);
1069   free_seg_bytes = fifo_segment_free_bytes (fs);
1070
1071   s = format (s, "\n%Useg free bytes: %U (%lu) estimated: %U (%lu)\n",
1072               format_white_space, indent + 2, format_memory_size,
1073               free_seg_bytes, free_seg_bytes, format_memory_size,
1074               est_free_seg_bytes, est_free_seg_bytes);
1075   s = format (s, "%Uchunk free bytes: %U (%lu) estimated: %U (%lu)\n",
1076               format_white_space, indent + 2, format_memory_size, chunk_bytes,
1077               chunk_bytes, format_memory_size, est_chunk_bytes,
1078               est_chunk_bytes);
1079   s = format (s, "%Ufifo hdr free bytes: %U (%u) reserved %U (%lu)\n",
1080               format_white_space, indent + 2, format_memory_size, fifo_hdr,
1081               fifo_hdr, format_memory_size, fsh->n_reserved_bytes,
1082               fsh->n_reserved_bytes);
1083   s = format (s, "\n");
1084
1085   return s;
1086 }
1087
1088 /*
1089  * fd.io coding-style-patch-verification: ON
1090  *
1091  * Local Variables:
1092  * eval: (c-set-style "gnu")
1093  * End:
1094  */