src/svm/fifo_segment.c

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