src/vnet/session/segment_manager.c

   1 /*
   2  * Copyright (c) 2017-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 <vnet/session/segment_manager.h>
  17 #include <vnet/session/session.h>
  18 #include <vnet/session/application.h>
  19
  20 typedef struct segment_manager_main_
  21 {
  22   segment_manager_t *segment_managers;  /**< Pool of segment managers */
  23   clib_valloc_main_t va_allocator;      /**< Virtual address allocator */
  24   u32 seg_name_counter;                 /**< Counter for segment names */
  25
  26   /*
  27    * Configuration
  28    */
  29   u32 default_fifo_size;        /**< default rx/tx fifo size */
  30   u32 default_segment_size;     /**< default fifo segment size */
  31   u32 default_app_mq_size;      /**< default app msg q size */
  32   u32 default_max_fifo_size;    /**< default max fifo size */
  33   u8 default_high_watermark;    /**< default high watermark % */
  34   u8 default_low_watermark;     /**< default low watermark % */
  35 } segment_manager_main_t;
  36
  37 static segment_manager_main_t sm_main;
  38
  39 #define segment_manager_foreach_segment_w_lock(VAR, SM, BODY)           \
  40 do {                                                                    \
  41     clib_rwlock_reader_lock (&(SM)->segments_rwlock);                   \
  42     pool_foreach((VAR), ((SM)->segments)) (BODY);                       \
  43     clib_rwlock_reader_unlock (&(SM)->segments_rwlock);                 \
  44 } while (0)
  45
  46 static segment_manager_props_t *
  47 segment_manager_properties_get (segment_manager_t * sm)
  48 {
  49   app_worker_t *app_wrk = app_worker_get (sm->app_wrk_index);
  50   return application_get_segment_manager_properties (app_wrk->app_index);
  51 }
  52
  53 segment_manager_props_t *
  54 segment_manager_props_init (segment_manager_props_t * props)
  55 {
  56   props->add_segment_size = sm_main.default_segment_size;
  57   props->rx_fifo_size = sm_main.default_fifo_size;
  58   props->tx_fifo_size = sm_main.default_fifo_size;
  59   props->evt_q_size = sm_main.default_app_mq_size;
  60   props->max_fifo_size = sm_main.default_max_fifo_size;
  61   props->high_watermark = sm_main.default_high_watermark;
  62   props->low_watermark = sm_main.default_low_watermark;
  63   props->n_slices = vlib_num_workers () + 1;
  64   return props;
  65 }
  66
  67 u8
  68 segment_manager_app_detached (segment_manager_t * sm)
  69 {
  70   return (sm->flags & SEG_MANAGER_F_DETACHED);
  71 }
  72
  73 void
  74 segment_manager_app_detach (segment_manager_t * sm)
  75 {
  76   sm->flags |= SEG_MANAGER_F_DETACHED;
  77 }
  78
  79 always_inline u32
  80 segment_manager_segment_index (segment_manager_t * sm, fifo_segment_t * seg)
  81 {
  82   return (seg - sm->segments);
  83 }
  84
  85 /**
  86  * Adds segment to segment manager's pool
  87  *
  88  * If needed a writer's lock is acquired before allocating a new segment
  89  * to avoid affecting any of the segments pool readers.
  90  */
  91 int
  92 segment_manager_add_segment (segment_manager_t * sm, uword segment_size)
  93 {
  94   uword baseva = (uword) ~ 0ULL, alloc_size, page_size;
  95   u32 rnd_margin = 128 << 10, fs_index = ~0;
  96   segment_manager_main_t *smm = &sm_main;
  97   segment_manager_props_t *props;
  98   fifo_segment_t *fs;
  99   u8 *seg_name;
 100   int rv;
 101
 102   props = segment_manager_properties_get (sm);
 103
 104   /* Not configured for addition of new segments and not first */
 105   if (!props->add_segment && !segment_size)
 106     {
 107       clib_warning ("cannot allocate new segment");
 108       return VNET_API_ERROR_INVALID_VALUE;
 109     }
 110
 111   /*
 112    * Allocate fifo segment and grab lock if needed
 113    */
 114   if (vlib_num_workers ())
 115     clib_rwlock_writer_lock (&sm->segments_rwlock);
 116
 117   pool_get_zero (sm->segments, fs);
 118
 119   /*
 120    * Allocate ssvm segment
 121    */
 122   segment_size = segment_size ? segment_size : props->add_segment_size;
 123   page_size = clib_mem_get_page_size ();
 124   /* Protect against segment size u32 wrap */
 125   segment_size = clib_max (segment_size + page_size - 1, segment_size);
 126   segment_size = segment_size & ~(page_size - 1);
 127
 128   if (props->segment_type != SSVM_SEGMENT_PRIVATE)
 129     {
 130       seg_name = format (0, "%d-%d%c", getpid (), smm->seg_name_counter++, 0);
 131       alloc_size = (uword) segment_size + rnd_margin;
 132       baseva = clib_valloc_alloc (&smm->va_allocator, alloc_size, 0);
 133       if (!baseva)
 134         {
 135           clib_warning ("out of space for segments");
 136           pool_put (sm->segments, fs);
 137           goto done;
 138         }
 139     }
 140   else
 141     {
 142       app_worker_t *app_wrk = app_worker_get (sm->app_wrk_index);
 143       application_t *app = application_get (app_wrk->app_index);
 144       seg_name = format (0, "%v segment%c", app->name, 0);
 145     }
 146
 147   fs->ssvm.ssvm_size = segment_size;
 148   fs->ssvm.name = seg_name;
 149   /* clib_mem_vm_map_shared consumes first page before requested_va */
 150   fs->ssvm.requested_va = baseva + page_size;
 151
 152   if ((rv = ssvm_server_init (&fs->ssvm, props->segment_type)))
 153     {
 154       clib_warning ("svm_master_init ('%v', %u) failed", seg_name,
 155                     segment_size);
 156
 157       if (props->segment_type != SSVM_SEGMENT_PRIVATE)
 158         clib_valloc_free (&smm->va_allocator, baseva);
 159       pool_put (sm->segments, fs);
 160       goto done;
 161     }
 162
 163   /*
 164    * Initialize fifo segment
 165    */
 166   fs->n_slices = props->n_slices;
 167   fifo_segment_init (fs);
 168
 169   /*
 170    * Save segment index before dropping lock, if any held
 171    */
 172   fs_index = fs - sm->segments;
 173
 174   /*
 175    * Set watermarks in segment
 176    */
 177   fs->h->high_watermark = sm->high_watermark;
 178   fs->h->low_watermark = sm->low_watermark;
 179   fs->h->pct_first_alloc = props->pct_first_alloc;
 180   fs->h->flags &= ~FIFO_SEGMENT_F_MEM_LIMIT;
 181
 182 done:
 183
 184   if (vlib_num_workers ())
 185     clib_rwlock_writer_unlock (&sm->segments_rwlock);
 186
 187   return fs_index;
 188 }
 189
 190 /**
 191  * Remove segment without lock
 192  */
 193 void
 194 segment_manager_del_segment (segment_manager_t * sm, fifo_segment_t * fs)
 195 {
 196   segment_manager_main_t *smm = &sm_main;
 197
 198   if (ssvm_type (&fs->ssvm) != SSVM_SEGMENT_PRIVATE)
 199     {
 200       /* clib_mem_vm_map_shared consumes first page before requested_va */
 201       clib_valloc_free (&smm->va_allocator,
 202                         fs->ssvm.requested_va - clib_mem_get_page_size ());
 203
 204       if (!segment_manager_app_detached (sm))
 205         {
 206           app_worker_t *app_wrk;
 207           u64 segment_handle;
 208           app_wrk = app_worker_get (sm->app_wrk_index);
 209           segment_handle = segment_manager_segment_handle (sm, fs);
 210           app_worker_del_segment_notify (app_wrk, segment_handle);
 211         }
 212     }
 213
 214   fifo_segment_cleanup (fs);
 215   ssvm_delete (&fs->ssvm);
 216
 217   if (CLIB_DEBUG)
 218     clib_memset (fs, 0xfb, sizeof (*fs));
 219   pool_put (sm->segments, fs);
 220 }
 221
 222 static fifo_segment_t *
 223 segment_manager_get_segment_if_valid (segment_manager_t * sm,
 224                                       u32 segment_index)
 225 {
 226   if (pool_is_free_index (sm->segments, segment_index))
 227     return 0;
 228   return pool_elt_at_index (sm->segments, segment_index);
 229 }
 230
 231 /**
 232  * Removes segment after acquiring writer lock
 233  */
 234 static inline void
 235 sm_lock_and_del_segment_inline (segment_manager_t * sm, u32 fs_index)
 236 {
 237   fifo_segment_t *fs;
 238   u8 is_prealloc;
 239
 240   clib_rwlock_writer_lock (&sm->segments_rwlock);
 241
 242   fs = segment_manager_get_segment_if_valid (sm, fs_index);
 243   if (!fs)
 244     goto done;
 245
 246   is_prealloc = fifo_segment_flags (fs) & FIFO_SEGMENT_F_IS_PREALLOCATED;
 247   if (is_prealloc && !segment_manager_app_detached (sm))
 248     goto done;
 249
 250   segment_manager_del_segment (sm, fs);
 251
 252 done:
 253   clib_rwlock_writer_unlock (&sm->segments_rwlock);
 254 }
 255
 256 void
 257 segment_manager_lock_and_del_segment (segment_manager_t * sm, u32 fs_index)
 258 {
 259   sm_lock_and_del_segment_inline (sm, fs_index);
 260 }
 261
 262 /**
 263  * Reads a segment from the segment manager's pool without lock
 264  */
 265 fifo_segment_t *
 266 segment_manager_get_segment (segment_manager_t * sm, u32 segment_index)
 267 {
 268   return pool_elt_at_index (sm->segments, segment_index);
 269 }
 270
 271 u64
 272 segment_manager_segment_handle (segment_manager_t * sm,
 273                                 fifo_segment_t * segment)
 274 {
 275   u32 segment_index = segment_manager_segment_index (sm, segment);
 276   return (((u64) segment_manager_index (sm) << 32) | segment_index);
 277 }
 278
 279 u64
 280 segment_manager_make_segment_handle (u32 segment_manager_index,
 281                                      u32 segment_index)
 282 {
 283   return (((u64) segment_manager_index << 32) | segment_index);
 284 }
 285
 286 fifo_segment_t *
 287 segment_manager_get_segment_w_handle (u64 segment_handle)
 288 {
 289   u32 sm_index, segment_index;
 290   segment_manager_t *sm;
 291
 292   segment_manager_parse_segment_handle (segment_handle, &sm_index,
 293                                         &segment_index);
 294   sm = segment_manager_get (sm_index);
 295   if (!sm || pool_is_free_index (sm->segments, segment_index))
 296     return 0;
 297   return pool_elt_at_index (sm->segments, segment_index);
 298 }
 299
 300 /**
 301  * Reads a segment from the segment manager's pool and acquires reader lock
 302  *
 303  * Caller must drop the reader's lock by calling
 304  * @ref segment_manager_segment_reader_unlock once it finishes working with
 305  * the segment.
 306  */
 307 fifo_segment_t *
 308 segment_manager_get_segment_w_lock (segment_manager_t * sm, u32 segment_index)
 309 {
 310   clib_rwlock_reader_lock (&sm->segments_rwlock);
 311   return pool_elt_at_index (sm->segments, segment_index);
 312 }
 313
 314 void
 315 segment_manager_segment_reader_lock (segment_manager_t * sm)
 316 {
 317   clib_rwlock_reader_lock (&sm->segments_rwlock);
 318 }
 319
 320 void
 321 segment_manager_segment_reader_unlock (segment_manager_t * sm)
 322 {
 323   clib_rwlock_reader_unlock (&sm->segments_rwlock);
 324 }
 325
 326 void
 327 segment_manager_segment_writer_unlock (segment_manager_t * sm)
 328 {
 329   clib_rwlock_writer_unlock (&sm->segments_rwlock);
 330 }
 331
 332 segment_manager_t *
 333 segment_manager_alloc (void)
 334 {
 335   segment_manager_main_t *smm = &sm_main;
 336   segment_manager_t *sm;
 337
 338   pool_get_zero (smm->segment_managers, sm);
 339   clib_rwlock_init (&sm->segments_rwlock);
 340   return sm;
 341 }
 342
 343 int
 344 segment_manager_init (segment_manager_t * sm)
 345 {
 346   segment_manager_props_t *props;
 347
 348   props = segment_manager_properties_get (sm);
 349
 350   sm->max_fifo_size = props->max_fifo_size ?
 351     props->max_fifo_size : sm_main.default_max_fifo_size;
 352   sm->max_fifo_size = clib_max (sm->max_fifo_size, 4096);
 353
 354   segment_manager_set_watermarks (sm,
 355                                   props->high_watermark,
 356                                   props->low_watermark);
 357   return 0;
 358 }
 359
 360 /**
 361  * Initializes segment manager based on options provided.
 362  * Returns error if ssvm segment(s) allocation fails.
 363  */
 364 int
 365 segment_manager_init_first (segment_manager_t * sm)
 366 {
 367   segment_manager_props_t *props;
 368   uword first_seg_size;
 369   fifo_segment_t *fs;
 370   int fs_index, i;
 371
 372   segment_manager_init (sm);
 373   props = segment_manager_properties_get (sm);
 374   first_seg_size = clib_max (props->segment_size,
 375                              sm_main.default_segment_size);
 376
 377   if (props->prealloc_fifos)
 378     {
 379       u64 approx_total_size, max_seg_size = ((u64) 1 << 32) - (128 << 10);
 380       u32 rx_rounded_data_size, tx_rounded_data_size;
 381       u32 prealloc_fifo_pairs = props->prealloc_fifos;
 382       u32 rx_fifo_size, tx_fifo_size, pair_size;
 383       u32 approx_segment_count;
 384
 385       /* Figure out how many segments should be preallocated */
 386       rx_rounded_data_size = (1 << (max_log2 (props->rx_fifo_size)));
 387       tx_rounded_data_size = (1 << (max_log2 (props->tx_fifo_size)));
 388
 389       rx_fifo_size = sizeof (svm_fifo_t) + rx_rounded_data_size;
 390       tx_fifo_size = sizeof (svm_fifo_t) + tx_rounded_data_size;
 391       pair_size = rx_fifo_size + tx_fifo_size;
 392
 393       approx_total_size = (u64) prealloc_fifo_pairs *pair_size;
 394       if (first_seg_size > approx_total_size)
 395         max_seg_size = first_seg_size;
 396       approx_segment_count = (approx_total_size + (max_seg_size - 1))
 397         / max_seg_size;
 398
 399       /* Allocate the segments */
 400       for (i = 0; i < approx_segment_count + 1; i++)
 401         {
 402           fs_index = segment_manager_add_segment (sm, max_seg_size);
 403           if (fs_index < 0)
 404             {
 405               clib_warning ("Failed to preallocate segment %d", i);
 406               return fs_index;
 407             }
 408
 409           fs = segment_manager_get_segment (sm, fs_index);
 410           if (i == 0)
 411             sm->event_queue = segment_manager_alloc_queue (fs, props);
 412
 413           fifo_segment_preallocate_fifo_pairs (fs,
 414                                                props->rx_fifo_size,
 415                                                props->tx_fifo_size,
 416                                                &prealloc_fifo_pairs);
 417           fifo_segment_flags (fs) = FIFO_SEGMENT_F_IS_PREALLOCATED;
 418           if (prealloc_fifo_pairs == 0)
 419             break;
 420         }
 421       return 0;
 422     }
 423
 424   fs_index = segment_manager_add_segment (sm, first_seg_size);
 425   if (fs_index < 0)
 426     {
 427       clib_warning ("Failed to allocate segment");
 428       return fs_index;
 429     }
 430
 431   fs = segment_manager_get_segment (sm, fs_index);
 432   sm->event_queue = segment_manager_alloc_queue (fs, props);
 433
 434   if (props->prealloc_fifo_hdrs)
 435     {
 436       u32 hdrs_per_slice;
 437
 438       /* Do not preallocate on slice associated to main thread */
 439       i = (vlib_num_workers ()? 1 : 0);
 440       hdrs_per_slice = props->prealloc_fifo_hdrs / (fs->n_slices - i);
 441
 442       for (; i < fs->n_slices; i++)
 443         {
 444           if (fifo_segment_prealloc_fifo_hdrs (fs, i, hdrs_per_slice))
 445             return VNET_API_ERROR_SVM_SEGMENT_CREATE_FAIL;
 446         }
 447     }
 448
 449   return 0;
 450 }
 451
 452 void
 453 segment_manager_cleanup_detached_listener (segment_manager_t * sm)
 454 {
 455   app_worker_t *app_wrk;
 456
 457   app_wrk = app_worker_get_if_valid (sm->app_wrk_index);
 458   if (!app_wrk)
 459     return;
 460
 461   app_worker_del_detached_sm (app_wrk, segment_manager_index (sm));
 462 }
 463
 464 /**
 465  * Cleanup segment manager.
 466  */
 467 void
 468 segment_manager_free (segment_manager_t * sm)
 469 {
 470   segment_manager_main_t *smm = &sm_main;
 471   fifo_segment_t *fifo_segment;
 472
 473   ASSERT (vlib_get_thread_index () == 0
 474           && !segment_manager_has_fifos (sm)
 475           && segment_manager_app_detached (sm));
 476
 477   if (sm->flags & SEG_MANAGER_F_DETACHED_LISTENER)
 478     segment_manager_cleanup_detached_listener (sm);
 479
 480   /* If we have empty preallocated segments that haven't been removed, remove
 481    * them now. Apart from that, the first segment in the first segment manager
 482    * is not removed when all fifos are removed. It can only be removed when
 483    * the manager is explicitly deleted/detached by the app. */
 484   clib_rwlock_writer_lock (&sm->segments_rwlock);
 485
 486   /* *INDENT-OFF* */
 487   pool_foreach (fifo_segment, sm->segments)  {
 488     segment_manager_del_segment (sm, fifo_segment);
 489   }
 490   /* *INDENT-ON* */
 491
 492   clib_rwlock_writer_unlock (&sm->segments_rwlock);
 493
 494   clib_rwlock_free (&sm->segments_rwlock);
 495   if (CLIB_DEBUG)
 496     clib_memset (sm, 0xfe, sizeof (*sm));
 497   pool_put (smm->segment_managers, sm);
 498 }
 499
 500 static void
 501 sm_free_w_index_helper (void *arg)
 502 {
 503   u32 sm_index = *(u32 *) arg;
 504   segment_manager_t *sm;
 505
 506   ASSERT (vlib_get_thread_index () == 0);
 507
 508   if ((sm = segment_manager_get_if_valid (sm_index)))
 509     segment_manager_free (sm);
 510 }
 511
 512 static void
 513 segment_manager_free_safe (segment_manager_t * sm)
 514 {
 515   if (!vlib_thread_is_main_w_barrier ())
 516     {
 517       u32 sm_index = segment_manager_index (sm);
 518       vlib_rpc_call_main_thread (sm_free_w_index_helper, (u8 *) & sm_index,
 519                                  sizeof (sm_index));
 520     }
 521   else
 522     {
 523       segment_manager_free (sm);
 524     }
 525 }
 526
 527 void
 528 segment_manager_init_free (segment_manager_t * sm)
 529 {
 530   ASSERT (vlib_get_thread_index () == 0);
 531
 532   segment_manager_app_detach (sm);
 533   if (segment_manager_has_fifos (sm))
 534     segment_manager_del_sessions (sm);
 535   else
 536     {
 537       ASSERT (!sm->first_is_protected || segment_manager_app_detached (sm));
 538       segment_manager_free (sm);
 539     }
 540 }
 541
 542 segment_manager_t *
 543 segment_manager_get (u32 index)
 544 {
 545   return pool_elt_at_index (sm_main.segment_managers, index);
 546 }
 547
 548 segment_manager_t *
 549 segment_manager_get_if_valid (u32 index)
 550 {
 551   if (pool_is_free_index (sm_main.segment_managers, index))
 552     return 0;
 553   return pool_elt_at_index (sm_main.segment_managers, index);
 554 }
 555
 556 u32
 557 segment_manager_index (segment_manager_t * sm)
 558 {
 559   return sm - sm_main.segment_managers;
 560 }
 561
 562 u8
 563 segment_manager_has_fifos (segment_manager_t * sm)
 564 {
 565   fifo_segment_t *seg;
 566   u8 first = 1;
 567
 568   /* *INDENT-OFF* */
 569   segment_manager_foreach_segment_w_lock (seg, sm, ({
 570     if (CLIB_DEBUG && !first && !fifo_segment_has_fifos (seg)
 571         && !(fifo_segment_flags (seg) & FIFO_SEGMENT_F_IS_PREALLOCATED))
 572       {
 573         clib_warning ("segment %d has no fifos!",
 574                       segment_manager_segment_index (sm, seg));
 575         first = 0;
 576       }
 577     if (fifo_segment_has_fifos (seg))
 578       {
 579         segment_manager_segment_reader_unlock (sm);
 580         return 1;
 581       }
 582   }));
 583   /* *INDENT-ON* */
 584
 585   return 0;
 586 }
 587
 588 /**
 589  * Initiate disconnects for all sessions 'owned' by a segment manager
 590  */
 591 void
 592 segment_manager_del_sessions (segment_manager_t * sm)
 593 {
 594   session_handle_t *handles = 0, *handle;
 595   fifo_segment_t *fs;
 596   session_t *session;
 597   int slice_index;
 598   svm_fifo_t *f;
 599
 600   ASSERT (pool_elts (sm->segments) != 0);
 601
 602   /* Across all fifo segments used by the server */
 603   /* *INDENT-OFF* */
 604   segment_manager_foreach_segment_w_lock (fs, sm, ({
 605     for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
 606       {
 607         f = fifo_segment_get_slice_fifo_list (fs, slice_index);
 608
 609         /*
 610          * Remove any residual sessions from the session lookup table
 611          * Don't bother deleting the individual fifos, we're going to
 612          * throw away the fifo segment in a minute.
 613          */
 614         while (f)
 615           {
 616             session = session_get_if_valid (f->shr->master_session_index,
 617                                             f->master_thread_index);
 618             if (session)
 619               vec_add1 (handles, session_handle (session));
 620             f = f->next;
 621           }
 622       }
 623
 624     /* Instead of removing the segment, test when cleaning up disconnected
 625      * sessions if the segment can be removed.
 626      */
 627   }));
 628   /* *INDENT-ON* */
 629
 630   vec_foreach (handle, handles)
 631   {
 632     session = session_get_from_handle (*handle);
 633     session_close (session);
 634     /* Avoid propagating notifications back to the app */
 635     session->app_wrk_index = APP_INVALID_INDEX;
 636   }
 637 }
 638
 639 int
 640 segment_manager_try_alloc_fifos (fifo_segment_t * fifo_segment,
 641                                  u32 thread_index,
 642                                  u32 rx_fifo_size, u32 tx_fifo_size,
 643                                  svm_fifo_t ** rx_fifo, svm_fifo_t ** tx_fifo)
 644 {
 645   rx_fifo_size = clib_max (rx_fifo_size, sm_main.default_fifo_size);
 646   *rx_fifo = fifo_segment_alloc_fifo_w_slice (fifo_segment, thread_index,
 647                                               rx_fifo_size,
 648                                               FIFO_SEGMENT_RX_FIFO);
 649
 650   tx_fifo_size = clib_max (tx_fifo_size, sm_main.default_fifo_size);
 651   *tx_fifo = fifo_segment_alloc_fifo_w_slice (fifo_segment, thread_index,
 652                                               tx_fifo_size,
 653                                               FIFO_SEGMENT_TX_FIFO);
 654
 655   if (*rx_fifo == 0)
 656     {
 657       /* This would be very odd, but handle it... */
 658       if (*tx_fifo != 0)
 659         {
 660           fifo_segment_free_fifo (fifo_segment, *tx_fifo);
 661           *tx_fifo = 0;
 662         }
 663       return -1;
 664     }
 665   if (*tx_fifo == 0)
 666     {
 667       if (*rx_fifo != 0)
 668         {
 669           fifo_segment_free_fifo (fifo_segment, *rx_fifo);
 670           *rx_fifo = 0;
 671         }
 672       return -1;
 673     }
 674
 675   return 0;
 676 }
 677
 678 int
 679 segment_manager_alloc_session_fifos (segment_manager_t * sm,
 680                                      u32 thread_index,
 681                                      svm_fifo_t ** rx_fifo,
 682                                      svm_fifo_t ** tx_fifo)
 683 {
 684   int alloc_fail = 1, rv = 0, new_fs_index;
 685   uword free_bytes, max_free_bytes = 0;
 686   segment_manager_props_t *props;
 687   fifo_segment_t *fs = 0, *cur;
 688   u32 sm_index, fs_index;
 689   u8 added_a_segment = 0;
 690   u64 fs_handle;
 691
 692   props = segment_manager_properties_get (sm);
 693
 694   /*
 695    * Find the first free segment to allocate the fifos in
 696    */
 697
 698   segment_manager_segment_reader_lock (sm);
 699
 700   /* *INDENT-OFF* */
 701   pool_foreach (cur, sm->segments)  {
 702     free_bytes = fifo_segment_available_bytes (cur);
 703     if (free_bytes > max_free_bytes)
 704       {
 705         max_free_bytes = free_bytes;
 706         fs = cur;
 707       }
 708   }
 709   /* *INDENT-ON* */
 710
 711   if (fs)
 712     {
 713       alloc_fail = segment_manager_try_alloc_fifos (fs, thread_index,
 714                                                     props->rx_fifo_size,
 715                                                     props->tx_fifo_size,
 716                                                     rx_fifo, tx_fifo);
 717       /* On success, keep lock until fifos are initialized */
 718       if (!alloc_fail)
 719         goto alloc_success;
 720     }
 721
 722   segment_manager_segment_reader_unlock (sm);
 723
 724 alloc_check:
 725
 726   if (!alloc_fail)
 727     {
 728
 729     alloc_success:
 730
 731       ASSERT (rx_fifo && tx_fifo);
 732       sm_index = segment_manager_index (sm);
 733       fs_index = segment_manager_segment_index (sm, fs);
 734       (*tx_fifo)->segment_manager = sm_index;
 735       (*rx_fifo)->segment_manager = sm_index;
 736       (*tx_fifo)->segment_index = fs_index;
 737       (*rx_fifo)->segment_index = fs_index;
 738
 739       if (added_a_segment)
 740         {
 741           app_worker_t *app_wrk;
 742           fs_handle = segment_manager_segment_handle (sm, fs);
 743           app_wrk = app_worker_get (sm->app_wrk_index);
 744           rv = app_worker_add_segment_notify (app_wrk, fs_handle);
 745         }
 746       /* Drop the lock after app is notified */
 747       segment_manager_segment_reader_unlock (sm);
 748       return rv;
 749     }
 750
 751   /*
 752    * Allocation failed, see if we can add a new segment
 753    */
 754   if (props->add_segment)
 755     {
 756       if (added_a_segment)
 757         {
 758           clib_warning ("Added a segment, still can't allocate a fifo");
 759           segment_manager_segment_reader_unlock (sm);
 760           return SESSION_E_SEG_NO_SPACE2;
 761         }
 762       if ((new_fs_index = segment_manager_add_segment (sm, 0)) < 0)
 763         {
 764           clib_warning ("Failed to add new segment");
 765           return SESSION_E_SEG_CREATE;
 766         }
 767       fs = segment_manager_get_segment_w_lock (sm, new_fs_index);
 768       alloc_fail = segment_manager_try_alloc_fifos (fs, thread_index,
 769                                                     props->rx_fifo_size,
 770                                                     props->tx_fifo_size,
 771                                                     rx_fifo, tx_fifo);
 772       added_a_segment = 1;
 773       goto alloc_check;
 774     }
 775   else
 776     {
 777       SESSION_DBG ("Can't add new seg and no space to allocate fifos!");
 778       return SESSION_E_SEG_NO_SPACE;
 779     }
 780 }
 781
 782 void
 783 segment_manager_dealloc_fifos (svm_fifo_t * rx_fifo, svm_fifo_t * tx_fifo)
 784 {
 785   segment_manager_t *sm;
 786   fifo_segment_t *fs;
 787   u32 segment_index;
 788
 789   if (!rx_fifo || !tx_fifo)
 790     return;
 791
 792   /* It's possible to have no segment manager if the session was removed
 793    * as result of a detach. */
 794   if (!(sm = segment_manager_get_if_valid (rx_fifo->segment_manager)))
 795     return;
 796
 797   segment_index = rx_fifo->segment_index;
 798   fs = segment_manager_get_segment_w_lock (sm, segment_index);
 799   fifo_segment_free_fifo (fs, rx_fifo);
 800   fifo_segment_free_fifo (fs, tx_fifo);
 801
 802   /*
 803    * Try to remove svm segment if it has no fifos. This can be done only if
 804    * the segment is not the first in the segment manager or if it is first
 805    * and it is not protected. Moreover, if the segment is first and the app
 806    * has detached from the segment manager, remove the segment manager.
 807    */
 808   if (!fifo_segment_has_fifos (fs))
 809     {
 810       segment_manager_segment_reader_unlock (sm);
 811
 812       /* Remove segment if it holds no fifos or first but not protected */
 813       if (segment_index != 0 || !sm->first_is_protected)
 814         sm_lock_and_del_segment_inline (sm, segment_index);
 815
 816       /* Remove segment manager if no sessions and detached from app */
 817       if (segment_manager_app_detached (sm)
 818           && !segment_manager_has_fifos (sm))
 819         segment_manager_free_safe (sm);
 820     }
 821   else
 822     segment_manager_segment_reader_unlock (sm);
 823 }
 824
 825 void
 826 segment_manager_detach_fifo (segment_manager_t * sm, svm_fifo_t * f)
 827 {
 828   fifo_segment_t *fs;
 829
 830   fs = segment_manager_get_segment_w_lock (sm, f->segment_index);
 831   fifo_segment_detach_fifo (fs, f);
 832   segment_manager_segment_reader_unlock (sm);
 833 }
 834
 835 void
 836 segment_manager_attach_fifo (segment_manager_t * sm, svm_fifo_t * f,
 837                              session_t * s)
 838 {
 839   fifo_segment_t *fs;
 840
 841   fs = segment_manager_get_segment_w_lock (sm, f->segment_index);
 842   fifo_segment_attach_fifo (fs, f, s->thread_index);
 843   segment_manager_segment_reader_unlock (sm);
 844
 845   f->shr->master_session_index = s->session_index;
 846   f->master_thread_index = s->thread_index;
 847 }
 848
 849 u32
 850 segment_manager_evt_q_expected_size (u32 q_len)
 851 {
 852   u32 fifo_evt_size, notif_q_size, q_hdrs;
 853   u32 msg_q_sz, fifo_evt_ring_sz, session_ntf_ring_sz;
 854
 855   fifo_evt_size = 1 << max_log2 (sizeof (session_event_t));
 856   notif_q_size = clib_max (16, q_len >> 4);
 857
 858   msg_q_sz = q_len * sizeof (svm_msg_q_msg_t);
 859   fifo_evt_ring_sz = q_len * fifo_evt_size;
 860   session_ntf_ring_sz = notif_q_size * 256;
 861   q_hdrs = sizeof (svm_queue_t) + sizeof (svm_msg_q_t);
 862
 863   return (msg_q_sz + fifo_evt_ring_sz + session_ntf_ring_sz + q_hdrs);
 864 }
 865
 866 /**
 867  * Allocates shm queue in the first segment
 868  *
 869  * Must be called with lock held
 870  */
 871 svm_msg_q_t *
 872 segment_manager_alloc_queue (fifo_segment_t * segment,
 873                              segment_manager_props_t * props)
 874 {
 875   u32 fifo_evt_size, session_evt_size = 256, notif_q_size;
 876   svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
 877   svm_msg_q_t *q;
 878
 879   fifo_evt_size = sizeof (session_event_t);
 880   notif_q_size = clib_max (16, props->evt_q_size >> 4);
 881   /* *INDENT-OFF* */
 882   svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
 883     {props->evt_q_size, fifo_evt_size, 0},
 884     {notif_q_size, session_evt_size, 0}
 885   };
 886   /* *INDENT-ON* */
 887   cfg->consumer_pid = 0;
 888   cfg->n_rings = 2;
 889   cfg->q_nitems = props->evt_q_size;
 890   cfg->ring_cfgs = rc;
 891
 892   q = fifo_segment_msg_q_alloc (segment, 0, cfg);
 893
 894   if (props->use_mq_eventfd)
 895     {
 896       if (svm_msg_q_alloc_producer_eventfd (q))
 897         clib_warning ("failed to alloc eventfd");
 898     }
 899   return q;
 900 }
 901
 902 svm_msg_q_t *
 903 segment_manager_event_queue (segment_manager_t * sm)
 904 {
 905   return sm->event_queue;
 906 }
 907
 908 /**
 909  * Frees shm queue allocated in the first segment
 910  */
 911 void
 912 segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q)
 913 {
 914   fifo_segment_t *segment;
 915   ssvm_shared_header_t *sh;
 916   void *oldheap;
 917
 918   ASSERT (!pool_is_free_index (sm->segments, 0));
 919
 920   segment = segment_manager_get_segment_w_lock (sm, 0);
 921   sh = segment->ssvm.sh;
 922
 923   oldheap = ssvm_push_heap (sh);
 924   svm_queue_free (q);
 925   ssvm_pop_heap (oldheap);
 926   segment_manager_segment_reader_unlock (sm);
 927 }
 928
 929 /*
 930  * Init segment vm address allocator
 931  */
 932 void
 933 segment_manager_main_init (segment_manager_main_init_args_t * a)
 934 {
 935   segment_manager_main_t *sm = &sm_main;
 936   clib_valloc_chunk_t _ip, *ip = &_ip;
 937
 938   ip->baseva = a->baseva;
 939   ip->size = a->size;
 940
 941   clib_valloc_init (&sm->va_allocator, ip, 1 /* lock */ );
 942
 943   sm->default_fifo_size = 1 << 12;
 944   sm->default_segment_size = 1 << 20;
 945   sm->default_app_mq_size = 128;
 946   sm->default_max_fifo_size = 4 << 20;
 947   sm->default_high_watermark = 80;
 948   sm->default_low_watermark = 50;
 949 }
 950
 951 static clib_error_t *
 952 segment_manager_show_fn (vlib_main_t * vm, unformat_input_t * input,
 953                          vlib_cli_command_t * cmd)
 954 {
 955   segment_manager_main_t *smm = &sm_main;
 956   u8 show_segments = 0, verbose = 0;
 957   uword max_fifo_size;
 958   segment_manager_t *sm;
 959   fifo_segment_t *seg;
 960   app_worker_t *app_wrk;
 961   application_t *app;
 962   u8 custom_logic;
 963
 964   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 965     {
 966       if (unformat (input, "segments"))
 967         show_segments = 1;
 968       else if (unformat (input, "verbose"))
 969         verbose = 1;
 970       else
 971         return clib_error_return (0, "unknown input `%U'",
 972                                   format_unformat_error, input);
 973     }
 974   vlib_cli_output (vm, "%d segment managers allocated",
 975                    pool_elts (smm->segment_managers));
 976   if (verbose && pool_elts (smm->segment_managers))
 977     {
 978       vlib_cli_output (vm, "%-6s%=10s%=10s%=13s%=11s%=11s%=12s",
 979                        "Index", "AppIndex", "Segments", "MaxFifoSize",
 980                        "HighWater", "LowWater", "FifoTuning");
 981
 982       /* *INDENT-OFF* */
 983       pool_foreach (sm, smm->segment_managers)  {
 984         app_wrk = app_worker_get_if_valid (sm->app_wrk_index);
 985         app = app_wrk ? application_get (app_wrk->app_index) : 0;
 986         custom_logic = (app && (app->cb_fns.fifo_tuning_callback)) ? 1 : 0;
 987         max_fifo_size = sm->max_fifo_size;
 988
 989         vlib_cli_output (vm, "%-6d%=10d%=10d%=13U%=11d%=11d%=12s",
 990                          segment_manager_index (sm),
 991                          sm->app_wrk_index, pool_elts (sm->segments),
 992                          format_memory_size, max_fifo_size,
 993                          sm->high_watermark, sm->low_watermark,
 994                          custom_logic ? "custom" : "none");
 995       }
 996       /* *INDENT-ON* */
 997
 998       vlib_cli_output (vm, "\n");
 999     }
1000   if (show_segments)
1001     {
1002       vlib_cli_output (vm, "%U", format_fifo_segment, 0, verbose);
1003
1004       /* *INDENT-OFF* */
1005       pool_foreach (sm, smm->segment_managers)  {
1006           segment_manager_foreach_segment_w_lock (seg, sm, ({
1007             vlib_cli_output (vm, "%U", format_fifo_segment, seg, verbose);
1008           }));
1009       }
1010       /* *INDENT-ON* */
1011
1012     }
1013   return 0;
1014 }
1015
1016 /* *INDENT-OFF* */
1017 VLIB_CLI_COMMAND (segment_manager_show_command, static) =
1018 {
1019   .path = "show segment-manager",
1020   .short_help = "show segment-manager [segments][verbose]",
1021   .function = segment_manager_show_fn,
1022 };
1023 /* *INDENT-ON* */
1024
1025 void
1026 segment_manager_format_sessions (segment_manager_t * sm, int verbose)
1027 {
1028   vlib_main_t *vm = vlib_get_main ();
1029   app_worker_t *app_wrk;
1030   fifo_segment_t *fs;
1031   const u8 *app_name;
1032   int slice_index;
1033   u8 *s = 0, *str;
1034   svm_fifo_t *f;
1035
1036   if (!sm)
1037     {
1038       if (verbose)
1039         vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
1040                          "API Client", "SegManager");
1041       else
1042         vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
1043       return;
1044     }
1045
1046   app_wrk = app_worker_get (sm->app_wrk_index);
1047   app_name = application_name_from_index (app_wrk->app_index);
1048
1049   clib_rwlock_reader_lock (&sm->segments_rwlock);
1050
1051   /* *INDENT-OFF* */
1052   pool_foreach (fs, sm->segments)  {
1053     for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1054       {
1055         f = fifo_segment_get_slice_fifo_list (fs, slice_index);
1056         while (f)
1057           {
1058             u32 session_index, thread_index;
1059             session_t *session;
1060
1061             session_index = f->shr->master_session_index;
1062             thread_index = f->master_thread_index;
1063
1064             session = session_get (session_index, thread_index);
1065             str = format (0, "%U", format_session, session, verbose);
1066
1067             if (verbose)
1068               s = format (s, "%-40v%-20v%-15u%-10u", str, app_name,
1069                           app_wrk->api_client_index,
1070                           app_wrk->connects_seg_manager);
1071             else
1072               s = format (s, "%-40v%-20v", str, app_name);
1073
1074             vlib_cli_output (vm, "%v", s);
1075             vec_reset_length (s);
1076             vec_free (str);
1077
1078             f = f->next;
1079           }
1080         vec_free (s);
1081       }
1082   }
1083   /* *INDENT-ON* */
1084
1085   clib_rwlock_reader_unlock (&sm->segments_rwlock);
1086 }
1087
1088 void
1089 segment_manager_set_watermarks (segment_manager_t * sm,
1090                                 u8 high_watermark, u8 low_watermark)
1091 {
1092   ASSERT (high_watermark <= 100 && low_watermark <= 100 &&
1093           low_watermark <= high_watermark);
1094
1095   sm->high_watermark = high_watermark;
1096   sm->low_watermark = low_watermark;
1097 }
1098
1099 /*
1100  * fd.io coding-style-patch-verification: ON
1101  *
1102  * Local Variables:
1103  * eval: (c-set-style "gnu")
1104  * End:
1105  */