src/svm/fifo_segment.c

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