src/svm/svm_fifo_segment.c

   1 /*
   2  * Copyright (c) 2016 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/svm_fifo_segment.h>
  17
  18 svm_fifo_segment_main_t svm_fifo_segment_main;
  19
  20 static void
  21 allocate_new_fifo_chunk (svm_fifo_segment_header_t * fsh,
  22                          u32 data_size_in_bytes, int chunk_size)
  23 {
  24   int freelist_index;
  25   u32 size;
  26   u8 *fifo_space;
  27   u32 rounded_data_size;
  28   svm_fifo_t *f;
  29   int i;
  30
  31   rounded_data_size = (1 << (max_log2 (data_size_in_bytes)));
  32   freelist_index = max_log2 (rounded_data_size)
  33     - max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE);
  34
  35   /* Calculate space requirement $$$ round-up data_size_in_bytes */
  36   size = (sizeof (*f) + rounded_data_size) * chunk_size;
  37
  38   /* Allocate fifo space. May fail. */
  39   fifo_space = clib_mem_alloc_aligned_at_offset
  40     (size, CLIB_CACHE_LINE_BYTES, 0 /* align_offset */ ,
  41      0 /* os_out_of_memory */ );
  42
  43   /* Out of space.. */
  44   if (fifo_space == 0)
  45     return;
  46
  47   /* Carve fifo space */
  48   f = (svm_fifo_t *) fifo_space;
  49   for (i = 0; i < chunk_size; i++)
  50     {
  51       f->freelist_index = freelist_index;
  52       f->next = fsh->free_fifos[freelist_index];
  53       fsh->free_fifos[freelist_index] = f;
  54       fifo_space += sizeof (*f) + rounded_data_size;
  55       f = (svm_fifo_t *) fifo_space;
  56     }
  57 }
  58
  59 static void
  60 preallocate_fifo_pairs (svm_fifo_segment_header_t * fsh,
  61                         svm_fifo_segment_create_args_t * a)
  62 {
  63   u32 rx_fifo_size, tx_fifo_size;
  64   u32 rx_rounded_data_size, tx_rounded_data_size;
  65   svm_fifo_t *f;
  66   u8 *rx_fifo_space, *tx_fifo_space;
  67   int rx_freelist_index, tx_freelist_index;
  68   int i;
  69
  70   /* Parameter check */
  71   if (a->rx_fifo_size == 0 || a->tx_fifo_size == 0
  72       || a->preallocated_fifo_pairs == 0)
  73     return;
  74
  75   if (a->rx_fifo_size < FIFO_SEGMENT_MIN_FIFO_SIZE ||
  76       a->rx_fifo_size > FIFO_SEGMENT_MAX_FIFO_SIZE)
  77     {
  78       clib_warning ("rx fifo_size out of range %d", a->rx_fifo_size);
  79       return;
  80     }
  81
  82   if (a->tx_fifo_size < FIFO_SEGMENT_MIN_FIFO_SIZE ||
  83       a->tx_fifo_size > FIFO_SEGMENT_MAX_FIFO_SIZE)
  84     {
  85       clib_warning ("tx fifo_size out of range %d", a->rx_fifo_size);
  86       return;
  87     }
  88
  89   rx_rounded_data_size = (1 << (max_log2 (a->rx_fifo_size)));
  90
  91   rx_freelist_index = max_log2 (a->rx_fifo_size)
  92     - max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE);
  93
  94   tx_rounded_data_size = (1 << (max_log2 (a->rx_fifo_size)));
  95
  96   tx_freelist_index = max_log2 (a->tx_fifo_size)
  97     - max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE);
  98
  99   /* Calculate space requirements */
 100   rx_fifo_size = (sizeof (*f) + rx_rounded_data_size)
 101     * a->preallocated_fifo_pairs;
 102   tx_fifo_size = (sizeof (*f) + tx_rounded_data_size)
 103     * a->preallocated_fifo_pairs;
 104
 105   vec_validate_init_empty (fsh->free_fifos,
 106                            clib_max (rx_freelist_index, tx_freelist_index),
 107                            0);
 108   if (0)
 109     clib_warning ("rx_fifo_size %u (%d mb), tx_fifo_size %u (%d mb)",
 110                   rx_fifo_size, rx_fifo_size >> 20,
 111                   tx_fifo_size, tx_fifo_size >> 20);
 112
 113   /* Allocate rx fifo space. May fail. */
 114   rx_fifo_space = clib_mem_alloc_aligned_at_offset
 115     (rx_fifo_size, CLIB_CACHE_LINE_BYTES, 0 /* align_offset */ ,
 116      0 /* os_out_of_memory */ );
 117
 118   /* Same for TX */
 119   tx_fifo_space = clib_mem_alloc_aligned_at_offset
 120     (tx_fifo_size, CLIB_CACHE_LINE_BYTES, 0 /* align_offset */ ,
 121      0 /* os_out_of_memory */ );
 122
 123   /* Make sure it worked. Clean up if it didn't... */
 124   if (rx_fifo_space == 0 || tx_fifo_space == 0)
 125     {
 126       if (rx_fifo_space)
 127         clib_mem_free (rx_fifo_space);
 128       else
 129         clib_warning ("rx fifo preallocation failure: size %d npairs %d",
 130                       a->rx_fifo_size, a->preallocated_fifo_pairs);
 131
 132       if (tx_fifo_space)
 133         clib_mem_free (tx_fifo_space);
 134       else
 135         clib_warning ("tx fifo preallocation failure: size %d nfifos %d",
 136                       a->tx_fifo_size, a->preallocated_fifo_pairs);
 137       return;
 138     }
 139
 140   /* Carve rx fifo space */
 141   f = (svm_fifo_t *) rx_fifo_space;
 142   for (i = 0; i < a->preallocated_fifo_pairs; i++)
 143     {
 144       f->freelist_index = rx_freelist_index;
 145       f->next = fsh->free_fifos[rx_freelist_index];
 146       fsh->free_fifos[rx_freelist_index] = f;
 147       rx_fifo_space += sizeof (*f) + rx_rounded_data_size;
 148       f = (svm_fifo_t *) rx_fifo_space;
 149     }
 150   /* Carve tx fifo space */
 151   f = (svm_fifo_t *) tx_fifo_space;
 152   for (i = 0; i < a->preallocated_fifo_pairs; i++)
 153     {
 154       f->freelist_index = tx_freelist_index;
 155       f->next = fsh->free_fifos[tx_freelist_index];
 156       fsh->free_fifos[tx_freelist_index] = f;
 157       tx_fifo_space += sizeof (*f) + tx_rounded_data_size;
 158       f = (svm_fifo_t *) tx_fifo_space;
 159     }
 160 }
 161
 162 /** (master) create an svm fifo segment */
 163 int
 164 svm_fifo_segment_create (svm_fifo_segment_create_args_t * a)
 165 {
 166   int rv;
 167   svm_fifo_segment_private_t *s;
 168   svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
 169   ssvm_shared_header_t *sh;
 170   svm_fifo_segment_header_t *fsh;
 171   void *oldheap;
 172
 173   /* Allocate a fresh segment */
 174   pool_get (sm->segments, s);
 175   memset (s, 0, sizeof (*s));
 176
 177   s->ssvm.ssvm_size = a->segment_size;
 178   s->ssvm.i_am_master = 1;
 179   s->ssvm.my_pid = getpid ();
 180   s->ssvm.name = format (0, "%s%c", a->segment_name, 0);
 181   s->ssvm.requested_va = sm->next_baseva;
 182
 183   rv = ssvm_master_init (&s->ssvm, s - sm->segments);
 184
 185   if (rv)
 186     {
 187       _vec_len (s) = vec_len (s) - 1;
 188       return (rv);
 189     }
 190
 191   /* Note: requested_va updated due to seg base addr randomization */
 192   sm->next_baseva = s->ssvm.requested_va + a->segment_size;
 193
 194   sh = s->ssvm.sh;
 195   oldheap = ssvm_push_heap (sh);
 196
 197   /* Set up svm_fifo_segment shared header */
 198   fsh = clib_mem_alloc (sizeof (*fsh));
 199   memset (fsh, 0, sizeof (*fsh));
 200   sh->opaque[0] = fsh;
 201   s->h = fsh;
 202   fsh->segment_name = format (0, "%s%c", a->segment_name, 0);
 203   preallocate_fifo_pairs (fsh, a);
 204
 205   ssvm_pop_heap (oldheap);
 206
 207   sh->ready = 1;
 208   vec_add1 (a->new_segment_indices, s - sm->segments);
 209   return (0);
 210 }
 211
 212 /** Create an svm fifo segment in process-private memory */
 213 int
 214 svm_fifo_segment_create_process_private (svm_fifo_segment_create_args_t * a)
 215 {
 216   svm_fifo_segment_private_t *s;
 217   svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
 218   ssvm_shared_header_t *sh;
 219   svm_fifo_segment_header_t *fsh;
 220   void *oldheap;
 221   u8 **heaps = 0;
 222   mheap_t *heap_header;
 223   int segment_count = 1;
 224   int i;
 225
 226   if (a->private_segment_count && a->private_segment_size)
 227     {
 228       u8 *heap;
 229       u32 pagesize = clib_mem_get_page_size ();
 230       u32 rnd_size;
 231       rnd_size = (a->private_segment_size + (pagesize - 1)) & ~pagesize;
 232
 233       for (i = 0; i < a->private_segment_count; i++)
 234         {
 235           heap = mheap_alloc (0, rnd_size);
 236           if (heap == 0)
 237             {
 238               clib_unix_warning ("mheap alloc");
 239               return -1;
 240             }
 241           heap_header = mheap_header (heap);
 242           heap_header->flags |= MHEAP_FLAG_THREAD_SAFE;
 243           vec_add1 (heaps, heap);
 244         }
 245       segment_count = a->private_segment_count;
 246     }
 247
 248   /* Spread preallocated fifo pairs across segments */
 249   a->preallocated_fifo_pairs /= segment_count;
 250
 251   /* Allocate segments */
 252   for (i = 0; i < segment_count; i++)
 253     {
 254       pool_get (sm->segments, s);
 255       memset (s, 0, sizeof (*s));
 256
 257       s->ssvm.ssvm_size = ~0;
 258       s->ssvm.i_am_master = 1;
 259       s->ssvm.my_pid = getpid ();
 260       s->ssvm.name = format (0, "%s%c", a->segment_name, 0);
 261       s->ssvm.requested_va = ~0;
 262
 263       /* Allocate a [sic] shared memory header, in process memory... */
 264       sh = clib_mem_alloc_aligned (sizeof (*sh), CLIB_CACHE_LINE_BYTES);
 265       s->ssvm.sh = sh;
 266
 267       memset (sh, 0, sizeof (*sh));
 268       sh->heap = a->private_segment_count ? heaps[i] : clib_mem_get_heap ();
 269
 270       /* Set up svm_fifo_segment shared header */
 271       fsh = clib_mem_alloc (sizeof (*fsh));
 272       memset (fsh, 0, sizeof (*fsh));
 273       sh->opaque[0] = fsh;
 274       s->h = fsh;
 275       fsh->flags = FIFO_SEGMENT_F_IS_PRIVATE;
 276       if (!a->private_segment_count)
 277         fsh->flags |= FIFO_SEGMENT_F_IS_MAIN_HEAP;
 278       fsh->segment_name = format (0, "%s%c", a->segment_name, 0);
 279
 280       if (a->private_segment_count)
 281         {
 282           oldheap = clib_mem_get_heap ();
 283           clib_mem_set_heap (sh->heap);
 284           preallocate_fifo_pairs (fsh, a);
 285           clib_mem_set_heap (oldheap);
 286         }
 287       sh->ready = 1;
 288       vec_add1 (a->new_segment_indices, s - sm->segments);
 289     }
 290   vec_free (heaps);
 291   return (0);
 292 }
 293
 294 /** (slave) attach to an svm fifo segment */
 295 int
 296 svm_fifo_segment_attach (svm_fifo_segment_create_args_t * a)
 297 {
 298   int rv;
 299   svm_fifo_segment_private_t *s;
 300   svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
 301   ssvm_shared_header_t *sh;
 302   svm_fifo_segment_header_t *fsh;
 303
 304   /* Allocate a fresh segment */
 305   pool_get (sm->segments, s);
 306   memset (s, 0, sizeof (*s));
 307
 308   s->ssvm.ssvm_size = a->segment_size;
 309   s->ssvm.my_pid = getpid ();
 310   s->ssvm.name = format (0, "%s%c", a->segment_name, 0);
 311   s->ssvm.requested_va = sm->next_baseva;
 312
 313   rv = ssvm_slave_init (&s->ssvm, sm->timeout_in_seconds);
 314
 315   if (rv)
 316     {
 317       _vec_len (s) = vec_len (s) - 1;
 318       return (rv);
 319     }
 320
 321   /* Fish the segment header */
 322   sh = s->ssvm.sh;
 323   fsh = (svm_fifo_segment_header_t *) sh->opaque[0];
 324   s->h = fsh;
 325
 326   vec_add1 (a->new_segment_indices, s - sm->segments);
 327   return (0);
 328 }
 329
 330 void
 331 svm_fifo_segment_delete (svm_fifo_segment_private_t * s)
 332 {
 333   svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
 334   if (s->h->flags & FIFO_SEGMENT_F_IS_PRIVATE)
 335     {
 336       /* Don't try to free vpp's heap! */
 337       if (!(s->h->flags & FIFO_SEGMENT_F_IS_MAIN_HEAP))
 338         mheap_free (s->ssvm.sh->heap);
 339       clib_mem_free (s->ssvm.sh);
 340       clib_mem_free (s->h);
 341       pool_put (sm->segments, s);
 342     }
 343   else
 344     {
 345       ssvm_delete (&s->ssvm);
 346       pool_put (sm->segments, s);
 347     }
 348 }
 349
 350 svm_fifo_t *
 351 svm_fifo_segment_alloc_fifo (svm_fifo_segment_private_t * s,
 352                              u32 data_size_in_bytes,
 353                              svm_fifo_segment_freelist_t list_index)
 354 {
 355   ssvm_shared_header_t *sh;
 356   svm_fifo_segment_header_t *fsh;
 357   svm_fifo_t *f;
 358   void *oldheap;
 359   int freelist_index;
 360
 361   /*
 362    * 4K minimum. It's not likely that anything good will happen
 363    * with a smaller FIFO.
 364    */
 365   if (data_size_in_bytes < FIFO_SEGMENT_MIN_FIFO_SIZE ||
 366       data_size_in_bytes > FIFO_SEGMENT_MAX_FIFO_SIZE)
 367     {
 368       clib_warning ("fifo size out of range %d", data_size_in_bytes);
 369       return 0;
 370     }
 371
 372   freelist_index = max_log2 (data_size_in_bytes)
 373     - max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE);
 374
 375   sh = s->ssvm.sh;
 376   fsh = (svm_fifo_segment_header_t *) sh->opaque[0];
 377
 378   ssvm_lock_non_recursive (sh, 1);
 379   oldheap = ssvm_push_heap (sh);
 380
 381   switch (list_index)
 382     {
 383     case FIFO_SEGMENT_RX_FREELIST:
 384     case FIFO_SEGMENT_TX_FREELIST:
 385       vec_validate_init_empty (fsh->free_fifos, freelist_index, 0);
 386
 387       f = fsh->free_fifos[freelist_index];
 388       if (PREDICT_FALSE (f == 0))
 389         {
 390           allocate_new_fifo_chunk (fsh, data_size_in_bytes,
 391                                    FIFO_SEGMENT_ALLOC_CHUNK_SIZE);
 392           f = fsh->free_fifos[freelist_index];
 393         }
 394       if (PREDICT_TRUE (f != 0))
 395         {
 396           fsh->free_fifos[freelist_index] = f->next;
 397           /* (re)initialize the fifo, as in svm_fifo_create */
 398           memset (f, 0, sizeof (*f));
 399           f->nitems = data_size_in_bytes;
 400           f->ooos_list_head = OOO_SEGMENT_INVALID_INDEX;
 401           f->refcnt = 1;
 402           f->freelist_index = freelist_index;
 403           goto found;
 404         }
 405       /* FALLTHROUGH */
 406     case FIFO_SEGMENT_FREELIST_NONE:
 407       break;
 408
 409     default:
 410       clib_warning ("ignore bogus freelist %d", list_index);
 411       break;
 412     }
 413
 414   /* Note: this can fail, in which case: create another segment */
 415   f = svm_fifo_create (data_size_in_bytes);
 416   if (PREDICT_FALSE (f == 0))
 417     {
 418       ssvm_pop_heap (oldheap);
 419       ssvm_unlock_non_recursive (sh);
 420       return (0);
 421     }
 422   f->freelist_index = freelist_index;
 423
 424 found:
 425   /* If rx_freelist add to active fifos list. When cleaning up segment,
 426    * we need a list of active sessions that should be disconnected. Since
 427    * both rx and tx fifos keep pointers to the session, it's enough to track
 428    * only one. */
 429   if (list_index == FIFO_SEGMENT_RX_FREELIST)
 430     {
 431       if (fsh->fifos)
 432         {
 433           fsh->fifos->prev = f;
 434           f->next = fsh->fifos;
 435         }
 436       fsh->fifos = f;
 437     }
 438   fsh->n_active_fifos++;
 439
 440   ssvm_pop_heap (oldheap);
 441   ssvm_unlock_non_recursive (sh);
 442   return (f);
 443 }
 444
 445 void
 446 svm_fifo_segment_free_fifo (svm_fifo_segment_private_t * s, svm_fifo_t * f,
 447                             svm_fifo_segment_freelist_t list_index)
 448 {
 449   ssvm_shared_header_t *sh;
 450   svm_fifo_segment_header_t *fsh;
 451   void *oldheap;
 452   int freelist_index;
 453
 454   ASSERT (f->refcnt > 0);
 455
 456   if (--f->refcnt > 0)
 457     return;
 458
 459   sh = s->ssvm.sh;
 460   fsh = (svm_fifo_segment_header_t *) sh->opaque[0];
 461
 462   freelist_index = f->freelist_index;
 463
 464   ASSERT (freelist_index < vec_len (fsh->free_fifos));
 465
 466   ssvm_lock_non_recursive (sh, 2);
 467   oldheap = ssvm_push_heap (sh);
 468
 469   switch (list_index)
 470     {
 471     case FIFO_SEGMENT_RX_FREELIST:
 472       /* Remove from active list */
 473       if (f->prev)
 474         f->prev->next = f->next;
 475       else
 476         fsh->fifos = f->next;
 477       if (f->next)
 478         f->next->prev = f->prev;
 479       /* Fall through: we add only rx fifos to active pool */
 480     case FIFO_SEGMENT_TX_FREELIST:
 481       /* Add to free list */
 482       f->next = fsh->free_fifos[freelist_index];
 483       f->prev = 0;
 484       fsh->free_fifos[freelist_index] = f;
 485       break;
 486     case FIFO_SEGMENT_FREELIST_NONE:
 487       break;
 488
 489     default:
 490       clib_warning ("ignore bogus freelist %d", list_index);
 491       break;
 492     }
 493
 494   if (CLIB_DEBUG)
 495     {
 496       f->master_session_index = ~0;
 497       f->master_thread_index = ~0;
 498     }
 499
 500   fsh->n_active_fifos--;
 501   ssvm_pop_heap (oldheap);
 502   ssvm_unlock_non_recursive (sh);
 503 }
 504
 505 void
 506 svm_fifo_segment_init (u64 baseva, u32 timeout_in_seconds)
 507 {
 508   svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
 509
 510   sm->next_baseva = baseva;
 511   sm->timeout_in_seconds = timeout_in_seconds;
 512 }
 513
 514 u32
 515 svm_fifo_segment_index (svm_fifo_segment_private_t * s)
 516 {
 517   return s - svm_fifo_segment_main.segments;
 518 }
 519
 520 /**
 521  * Retrieve svm segments pool. Used only for debug purposes.
 522  */
 523 svm_fifo_segment_private_t *
 524 svm_fifo_segment_segments_pool (void)
 525 {
 526   svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
 527   return sm->segments;
 528 }
 529
 530 /**
 531  * Get number of active fifos
 532  */
 533 u32
 534 svm_fifo_segment_num_fifos (svm_fifo_segment_private_t * fifo_segment)
 535 {
 536   return fifo_segment->h->n_active_fifos;
 537 }
 538
 539 /*
 540  * fd.io coding-style-patch-verification: ON
 541  *
 542  * Local Variables:
 543  * eval: (c-set-style "gnu")
 544  * End:
 545  */