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   ssvm_delete (&fs->ssvm);
 215
 216   if (CLIB_DEBUG)
 217     clib_memset (fs, 0xfb, sizeof (*fs));
 218   pool_put (sm->segments, fs);
 219 }
 220
 221 static fifo_segment_t *
 222 segment_manager_get_segment_if_valid (segment_manager_t * sm,
 223                                       u32 segment_index)
 224 {
 225   if (pool_is_free_index (sm->segments, segment_index))
 226     return 0;
 227   return pool_elt_at_index (sm->segments, segment_index);
 228 }
 229
 230 /**
 231  * Removes segment after acquiring writer lock
 232  */
 233 static inline void
 234 sm_lock_and_del_segment_inline (segment_manager_t * sm, u32 fs_index)
 235 {
 236   fifo_segment_t *fs;
 237   u8 is_prealloc;
 238
 239   clib_rwlock_writer_lock (&sm->segments_rwlock);
 240
 241   fs = segment_manager_get_segment_if_valid (sm, fs_index);
 242   if (!fs)
 243     goto done;
 244
 245   is_prealloc = fifo_segment_flags (fs) & FIFO_SEGMENT_F_IS_PREALLOCATED;
 246   if (is_prealloc && !segment_manager_app_detached (sm))
 247     goto done;
 248
 249   segment_manager_del_segment (sm, fs);
 250
 251 done:
 252   clib_rwlock_writer_unlock (&sm->segments_rwlock);
 253 }
 254
 255 void
 256 segment_manager_lock_and_del_segment (segment_manager_t * sm, u32 fs_index)
 257 {
 258   sm_lock_and_del_segment_inline (sm, fs_index);
 259 }
 260
 261 /**
 262  * Reads a segment from the segment manager's pool without lock
 263  */
 264 fifo_segment_t *
 265 segment_manager_get_segment (segment_manager_t * sm, u32 segment_index)
 266 {
 267   return pool_elt_at_index (sm->segments, segment_index);
 268 }
 269
 270 u64
 271 segment_manager_segment_handle (segment_manager_t * sm,
 272                                 fifo_segment_t * segment)
 273 {
 274   u32 segment_index = segment_manager_segment_index (sm, segment);
 275   return (((u64) segment_manager_index (sm) << 32) | segment_index);
 276 }
 277
 278 u64
 279 segment_manager_make_segment_handle (u32 segment_manager_index,
 280                                      u32 segment_index)
 281 {
 282   return (((u64) segment_manager_index << 32) | segment_index);
 283 }
 284
 285 fifo_segment_t *
 286 segment_manager_get_segment_w_handle (u64 segment_handle)
 287 {
 288   u32 sm_index, segment_index;
 289   segment_manager_t *sm;
 290
 291   segment_manager_parse_segment_handle (segment_handle, &sm_index,
 292                                         &segment_index);
 293   sm = segment_manager_get (sm_index);
 294   if (!sm || pool_is_free_index (sm->segments, segment_index))
 295     return 0;
 296   return pool_elt_at_index (sm->segments, segment_index);
 297 }
 298
 299 /**
 300  * Reads a segment from the segment manager's pool and acquires reader lock
 301  *
 302  * Caller must drop the reader's lock by calling
 303  * @ref segment_manager_segment_reader_unlock once it finishes working with
 304  * the segment.
 305  */
 306 fifo_segment_t *
 307 segment_manager_get_segment_w_lock (segment_manager_t * sm, u32 segment_index)
 308 {
 309   clib_rwlock_reader_lock (&sm->segments_rwlock);
 310   return pool_elt_at_index (sm->segments, segment_index);
 311 }
 312
 313 void
 314 segment_manager_segment_reader_lock (segment_manager_t * sm)
 315 {
 316   clib_rwlock_reader_lock (&sm->segments_rwlock);
 317 }
 318
 319 void
 320 segment_manager_segment_reader_unlock (segment_manager_t * sm)
 321 {
 322   clib_rwlock_reader_unlock (&sm->segments_rwlock);
 323 }
 324
 325 void
 326 segment_manager_segment_writer_unlock (segment_manager_t * sm)
 327 {
 328   clib_rwlock_writer_unlock (&sm->segments_rwlock);
 329 }
 330
 331 segment_manager_t *
 332 segment_manager_alloc (void)
 333 {
 334   segment_manager_main_t *smm = &sm_main;
 335   segment_manager_t *sm;
 336
 337   pool_get_zero (smm->segment_managers, sm);
 338   clib_rwlock_init (&sm->segments_rwlock);
 339   return sm;
 340 }
 341
 342 int
 343 segment_manager_init (segment_manager_t * sm)
 344 {
 345   segment_manager_props_t *props;
 346
 347   props = segment_manager_properties_get (sm);
 348
 349   sm->max_fifo_size = props->max_fifo_size ?
 350     props->max_fifo_size : sm_main.default_max_fifo_size;
 351   sm->max_fifo_size = clib_max (sm->max_fifo_size, 4096);
 352
 353   segment_manager_set_watermarks (sm,
 354                                   props->high_watermark,
 355                                   props->low_watermark);
 356   return 0;
 357 }
 358
 359 /**
 360  * Initializes segment manager based on options provided.
 361  * Returns error if ssvm segment(s) allocation fails.
 362  */
 363 int
 364 segment_manager_init_first (segment_manager_t * sm)
 365 {
 366   segment_manager_props_t *props;
 367   uword first_seg_size;
 368   fifo_segment_t *fs;
 369   int fs_index, i;
 370
 371   segment_manager_init (sm);
 372   props = segment_manager_properties_get (sm);
 373   first_seg_size = clib_max (props->segment_size,
 374                              sm_main.default_segment_size);
 375
 376   if (props->prealloc_fifos)
 377     {
 378       u64 approx_total_size, max_seg_size = ((u64) 1 << 32) - (128 << 10);
 379       u32 rx_rounded_data_size, tx_rounded_data_size;
 380       u32 prealloc_fifo_pairs = props->prealloc_fifos;
 381       u32 rx_fifo_size, tx_fifo_size, pair_size;
 382       u32 approx_segment_count;
 383
 384       /* Figure out how many segments should be preallocated */
 385       rx_rounded_data_size = (1 << (max_log2 (props->rx_fifo_size)));
 386       tx_rounded_data_size = (1 << (max_log2 (props->tx_fifo_size)));
 387
 388       rx_fifo_size = sizeof (svm_fifo_t) + rx_rounded_data_size;
 389       tx_fifo_size = sizeof (svm_fifo_t) + tx_rounded_data_size;
 390       pair_size = rx_fifo_size + tx_fifo_size;
 391
 392       approx_total_size = (u64) prealloc_fifo_pairs *pair_size;
 393       if (first_seg_size > approx_total_size)
 394         max_seg_size = first_seg_size;
 395       approx_segment_count = (approx_total_size + (max_seg_size - 1))
 396         / max_seg_size;
 397
 398       /* Allocate the segments */
 399       for (i = 0; i < approx_segment_count + 1; i++)
 400         {
 401           fs_index = segment_manager_add_segment (sm, max_seg_size);
 402           if (fs_index < 0)
 403             {
 404               clib_warning ("Failed to preallocate segment %d", i);
 405               return fs_index;
 406             }
 407
 408           fs = segment_manager_get_segment (sm, fs_index);
 409           if (i == 0)
 410             sm->event_queue = segment_manager_alloc_queue (fs, props);
 411
 412           fifo_segment_preallocate_fifo_pairs (fs,
 413                                                props->rx_fifo_size,
 414                                                props->tx_fifo_size,
 415                                                &prealloc_fifo_pairs);
 416           fifo_segment_flags (fs) = FIFO_SEGMENT_F_IS_PREALLOCATED;
 417           if (prealloc_fifo_pairs == 0)
 418             break;
 419         }
 420       return 0;
 421     }
 422
 423   fs_index = segment_manager_add_segment (sm, first_seg_size);
 424   if (fs_index < 0)
 425     {
 426       clib_warning ("Failed to allocate segment");
 427       return fs_index;
 428     }
 429
 430   fs = segment_manager_get_segment (sm, fs_index);
 431   sm->event_queue = segment_manager_alloc_queue (fs, props);
 432
 433   if (props->prealloc_fifo_hdrs)
 434     {
 435       u32 hdrs_per_slice;
 436
 437       /* Do not preallocate on slice associated to main thread */
 438       i = (vlib_num_workers ()? 1 : 0);
 439       hdrs_per_slice = props->prealloc_fifo_hdrs / (fs->n_slices - i);
 440
 441       for (; i < fs->n_slices; i++)
 442         {
 443           if (fifo_segment_prealloc_fifo_hdrs (fs, i, hdrs_per_slice))
 444             return VNET_API_ERROR_SVM_SEGMENT_CREATE_FAIL;
 445         }
 446     }
 447
 448   return 0;
 449 }
 450
 451 void
 452 segment_manager_cleanup_detached_listener (segment_manager_t * sm)
 453 {
 454   app_worker_t *app_wrk;
 455
 456   app_wrk = app_worker_get_if_valid (sm->app_wrk_index);
 457   if (!app_wrk)
 458     return;
 459
 460   app_worker_del_detached_sm (app_wrk, segment_manager_index (sm));
 461 }
 462
 463 /**
 464  * Cleanup segment manager.
 465  */
 466 void
 467 segment_manager_free (segment_manager_t * sm)
 468 {
 469   segment_manager_main_t *smm = &sm_main;
 470   fifo_segment_t *fifo_segment;
 471
 472   ASSERT (vlib_get_thread_index () == 0
 473           && !segment_manager_has_fifos (sm)
 474           && segment_manager_app_detached (sm));
 475
 476   if (sm->flags & SEG_MANAGER_F_DETACHED_LISTENER)
 477     segment_manager_cleanup_detached_listener (sm);
 478
 479   /* If we have empty preallocated segments that haven't been removed, remove
 480    * them now. Apart from that, the first segment in the first segment manager
 481    * is not removed when all fifos are removed. It can only be removed when
 482    * the manager is explicitly deleted/detached by the app. */
 483   clib_rwlock_writer_lock (&sm->segments_rwlock);
 484
 485   /* *INDENT-OFF* */
 486   pool_foreach (fifo_segment, sm->segments)  {
 487     segment_manager_del_segment (sm, fifo_segment);
 488   }
 489   /* *INDENT-ON* */
 490
 491   clib_rwlock_writer_unlock (&sm->segments_rwlock);
 492
 493   clib_rwlock_free (&sm->segments_rwlock);
 494   if (CLIB_DEBUG)
 495     clib_memset (sm, 0xfe, sizeof (*sm));
 496   pool_put (smm->segment_managers, sm);
 497 }
 498
 499 static void
 500 sm_free_w_index_helper (void *arg)
 501 {
 502   u32 sm_index = *(u32 *) arg;
 503   segment_manager_t *sm;
 504
 505   ASSERT (vlib_get_thread_index () == 0);
 506
 507   if ((sm = segment_manager_get_if_valid (sm_index)))
 508     segment_manager_free (sm);
 509 }
 510
 511 static void
 512 segment_manager_free_safe (segment_manager_t * sm)
 513 {
 514   if (!vlib_thread_is_main_w_barrier ())
 515     {
 516       u32 sm_index = segment_manager_index (sm);
 517       vlib_rpc_call_main_thread (sm_free_w_index_helper, (u8 *) & sm_index,
 518                                  sizeof (sm_index));
 519     }
 520   else
 521     {
 522       segment_manager_free (sm);
 523     }
 524 }
 525
 526 void
 527 segment_manager_init_free (segment_manager_t * sm)
 528 {
 529   ASSERT (vlib_get_thread_index () == 0);
 530
 531   segment_manager_app_detach (sm);
 532   if (segment_manager_has_fifos (sm))
 533     segment_manager_del_sessions (sm);
 534   else
 535     {
 536       ASSERT (!sm->first_is_protected || segment_manager_app_detached (sm));
 537       segment_manager_free (sm);
 538     }
 539 }
 540
 541 segment_manager_t *
 542 segment_manager_get (u32 index)
 543 {
 544   return pool_elt_at_index (sm_main.segment_managers, index);
 545 }
 546
 547 segment_manager_t *
 548 segment_manager_get_if_valid (u32 index)
 549 {
 550   if (pool_is_free_index (sm_main.segment_managers, index))
 551     return 0;
 552   return pool_elt_at_index (sm_main.segment_managers, index);
 553 }
 554
 555 u32
 556 segment_manager_index (segment_manager_t * sm)
 557 {
 558   return sm - sm_main.segment_managers;
 559 }
 560
 561 u8
 562 segment_manager_has_fifos (segment_manager_t * sm)
 563 {
 564   fifo_segment_t *seg;
 565   u8 first = 1;
 566
 567   /* *INDENT-OFF* */
 568   segment_manager_foreach_segment_w_lock (seg, sm, ({
 569     if (CLIB_DEBUG && !first && !fifo_segment_has_fifos (seg)
 570         && !(fifo_segment_flags (seg) & FIFO_SEGMENT_F_IS_PREALLOCATED))
 571       {
 572         clib_warning ("segment %d has no fifos!",
 573                       segment_manager_segment_index (sm, seg));
 574         first = 0;
 575       }
 576     if (fifo_segment_has_fifos (seg))
 577       {
 578         segment_manager_segment_reader_unlock (sm);
 579         return 1;
 580       }
 581   }));
 582   /* *INDENT-ON* */
 583
 584   return 0;
 585 }
 586
 587 /**
 588  * Initiate disconnects for all sessions 'owned' by a segment manager
 589  */
 590 void
 591 segment_manager_del_sessions (segment_manager_t * sm)
 592 {
 593   session_handle_t *handles = 0, *handle;
 594   fifo_segment_t *fs;
 595   session_t *session;
 596   int slice_index;
 597   svm_fifo_t *f;
 598
 599   ASSERT (pool_elts (sm->segments) != 0);
 600
 601   /* Across all fifo segments used by the server */
 602   /* *INDENT-OFF* */
 603   segment_manager_foreach_segment_w_lock (fs, sm, ({
 604     for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
 605       {
 606         f = fifo_segment_get_slice_fifo_list (fs, slice_index);
 607
 608         /*
 609          * Remove any residual sessions from the session lookup table
 610          * Don't bother deleting the individual fifos, we're going to
 611          * throw away the fifo segment in a minute.
 612          */
 613         while (f)
 614           {
 615             session = session_get_if_valid (f->master_session_index,
 616                                             f->master_thread_index);
 617             if (session)
 618               vec_add1 (handles, session_handle (session));
 619             f = f->next;
 620           }
 621       }
 622
 623     /* Instead of removing the segment, test when cleaning up disconnected
 624      * sessions if the segment can be removed.
 625      */
 626   }));
 627   /* *INDENT-ON* */
 628
 629   vec_foreach (handle, handles)
 630   {
 631     session = session_get_from_handle (*handle);
 632     session_close (session);
 633     /* Avoid propagating notifications back to the app */
 634     session->app_wrk_index = APP_INVALID_INDEX;
 635   }
 636 }
 637
 638 int
 639 segment_manager_try_alloc_fifos (fifo_segment_t * fifo_segment,
 640                                  u32 thread_index,
 641                                  u32 rx_fifo_size, u32 tx_fifo_size,
 642                                  svm_fifo_t ** rx_fifo, svm_fifo_t ** tx_fifo)
 643 {
 644   rx_fifo_size = clib_max (rx_fifo_size, sm_main.default_fifo_size);
 645   *rx_fifo = fifo_segment_alloc_fifo_w_slice (fifo_segment, thread_index,
 646                                               rx_fifo_size,
 647                                               FIFO_SEGMENT_RX_FIFO);
 648
 649   tx_fifo_size = clib_max (tx_fifo_size, sm_main.default_fifo_size);
 650   *tx_fifo = fifo_segment_alloc_fifo_w_slice (fifo_segment, thread_index,
 651                                               tx_fifo_size,
 652                                               FIFO_SEGMENT_TX_FIFO);
 653
 654   if (*rx_fifo == 0)
 655     {
 656       /* This would be very odd, but handle it... */
 657       if (*tx_fifo != 0)
 658         {
 659           fifo_segment_free_fifo (fifo_segment, *tx_fifo);
 660           *tx_fifo = 0;
 661         }
 662       return -1;
 663     }
 664   if (*tx_fifo == 0)
 665     {
 666       if (*rx_fifo != 0)
 667         {
 668           fifo_segment_free_fifo (fifo_segment, *rx_fifo);
 669           *rx_fifo = 0;
 670         }
 671       return -1;
 672     }
 673
 674   return 0;
 675 }
 676
 677 int
 678 segment_manager_alloc_session_fifos (segment_manager_t * sm,
 679                                      u32 thread_index,
 680                                      svm_fifo_t ** rx_fifo,
 681                                      svm_fifo_t ** tx_fifo)
 682 {
 683   int alloc_fail = 1, rv = 0, new_fs_index;
 684   uword free_bytes, max_free_bytes = 0;
 685   segment_manager_props_t *props;
 686   fifo_segment_t *fs = 0, *cur;
 687   u32 sm_index, fs_index;
 688   u8 added_a_segment = 0;
 689   u64 fs_handle;
 690
 691   props = segment_manager_properties_get (sm);
 692
 693   /*
 694    * Find the first free segment to allocate the fifos in
 695    */
 696
 697   segment_manager_segment_reader_lock (sm);
 698
 699   /* *INDENT-OFF* */
 700   pool_foreach (cur, sm->segments)  {
 701     free_bytes = fifo_segment_available_bytes (cur);
 702     if (free_bytes > max_free_bytes)
 703       {
 704         max_free_bytes = free_bytes;
 705         fs = cur;
 706       }
 707   }
 708   /* *INDENT-ON* */
 709
 710   if (fs)
 711     {
 712       alloc_fail = segment_manager_try_alloc_fifos (fs, thread_index,
 713                                                     props->rx_fifo_size,
 714                                                     props->tx_fifo_size,
 715                                                     rx_fifo, tx_fifo);
 716       /* On success, keep lock until fifos are initialized */
 717       if (!alloc_fail)
 718         goto alloc_success;
 719     }
 720
 721   segment_manager_segment_reader_unlock (sm);
 722
 723 alloc_check:
 724
 725   if (!alloc_fail)
 726     {
 727
 728     alloc_success:
 729
 730       ASSERT (rx_fifo && tx_fifo);
 731       sm_index = segment_manager_index (sm);
 732       fs_index = segment_manager_segment_index (sm, fs);
 733       (*tx_fifo)->segment_manager = sm_index;
 734       (*rx_fifo)->segment_manager = sm_index;
 735       (*tx_fifo)->segment_index = fs_index;
 736       (*rx_fifo)->segment_index = fs_index;
 737
 738       if (added_a_segment)
 739         {
 740           app_worker_t *app_wrk;
 741           fs_handle = segment_manager_segment_handle (sm, fs);
 742           app_wrk = app_worker_get (sm->app_wrk_index);
 743           rv = app_worker_add_segment_notify (app_wrk, fs_handle);
 744         }
 745       /* Drop the lock after app is notified */
 746       segment_manager_segment_reader_unlock (sm);
 747       return rv;
 748     }
 749
 750   /*
 751    * Allocation failed, see if we can add a new segment
 752    */
 753   if (props->add_segment)
 754     {
 755       if (added_a_segment)
 756         {
 757           clib_warning ("Added a segment, still can't allocate a fifo");
 758           segment_manager_segment_reader_unlock (sm);
 759           return SESSION_E_SEG_NO_SPACE2;
 760         }
 761       if ((new_fs_index = segment_manager_add_segment (sm, 0)) < 0)
 762         {
 763           clib_warning ("Failed to add new segment");
 764           return SESSION_E_SEG_CREATE;
 765         }
 766       fs = segment_manager_get_segment_w_lock (sm, new_fs_index);
 767       alloc_fail = segment_manager_try_alloc_fifos (fs, thread_index,
 768                                                     props->rx_fifo_size,
 769                                                     props->tx_fifo_size,
 770                                                     rx_fifo, tx_fifo);
 771       added_a_segment = 1;
 772       goto alloc_check;
 773     }
 774   else
 775     {
 776       SESSION_DBG ("Can't add new seg and no space to allocate fifos!");
 777       return SESSION_E_SEG_NO_SPACE;
 778     }
 779 }
 780
 781 void
 782 segment_manager_dealloc_fifos (svm_fifo_t * rx_fifo, svm_fifo_t * tx_fifo)
 783 {
 784   segment_manager_t *sm;
 785   fifo_segment_t *fs;
 786   u32 segment_index;
 787
 788   if (!rx_fifo || !tx_fifo)
 789     return;
 790
 791   /* It's possible to have no segment manager if the session was removed
 792    * as result of a detach. */
 793   if (!(sm = segment_manager_get_if_valid (rx_fifo->segment_manager)))
 794     return;
 795
 796   segment_index = rx_fifo->segment_index;
 797   fs = segment_manager_get_segment_w_lock (sm, segment_index);
 798   fifo_segment_free_fifo (fs, rx_fifo);
 799   fifo_segment_free_fifo (fs, tx_fifo);
 800
 801   /*
 802    * Try to remove svm segment if it has no fifos. This can be done only if
 803    * the segment is not the first in the segment manager or if it is first
 804    * and it is not protected. Moreover, if the segment is first and the app
 805    * has detached from the segment manager, remove the segment manager.
 806    */
 807   if (!fifo_segment_has_fifos (fs))
 808     {
 809       segment_manager_segment_reader_unlock (sm);
 810
 811       /* Remove segment if it holds no fifos or first but not protected */
 812       if (segment_index != 0 || !sm->first_is_protected)
 813         sm_lock_and_del_segment_inline (sm, segment_index);
 814
 815       /* Remove segment manager if no sessions and detached from app */
 816       if (segment_manager_app_detached (sm)
 817           && !segment_manager_has_fifos (sm))
 818         segment_manager_free_safe (sm);
 819     }
 820   else
 821     segment_manager_segment_reader_unlock (sm);
 822 }
 823
 824 void
 825 segment_manager_detach_fifo (segment_manager_t * sm, svm_fifo_t * f)
 826 {
 827   fifo_segment_t *fs;
 828
 829   fs = segment_manager_get_segment_w_lock (sm, f->segment_index);
 830   fifo_segment_detach_fifo (fs, f);
 831   segment_manager_segment_reader_unlock (sm);
 832 }
 833
 834 void
 835 segment_manager_attach_fifo (segment_manager_t * sm, svm_fifo_t * f,
 836                              session_t * s)
 837 {
 838   fifo_segment_t *fs;
 839
 840   fs = segment_manager_get_segment_w_lock (sm, f->segment_index);
 841   fifo_segment_attach_fifo (fs, f, s->thread_index);
 842   segment_manager_segment_reader_unlock (sm);
 843
 844   f->master_session_index = s->session_index;
 845   f->master_thread_index = s->thread_index;
 846 }
 847
 848 u32
 849 segment_manager_evt_q_expected_size (u32 q_len)
 850 {
 851   u32 fifo_evt_size, notif_q_size, q_hdrs;
 852   u32 msg_q_sz, fifo_evt_ring_sz, session_ntf_ring_sz;
 853
 854   fifo_evt_size = 1 << max_log2 (sizeof (session_event_t));
 855   notif_q_size = clib_max (16, q_len >> 4);
 856
 857   msg_q_sz = q_len * sizeof (svm_msg_q_msg_t);
 858   fifo_evt_ring_sz = q_len * fifo_evt_size;
 859   session_ntf_ring_sz = notif_q_size * 256;
 860   q_hdrs = sizeof (svm_queue_t) + sizeof (svm_msg_q_t);
 861
 862   return (msg_q_sz + fifo_evt_ring_sz + session_ntf_ring_sz + q_hdrs);
 863 }
 864
 865 /**
 866  * Allocates shm queue in the first segment
 867  *
 868  * Must be called with lock held
 869  */
 870 svm_msg_q_t *
 871 segment_manager_alloc_queue (fifo_segment_t * segment,
 872                              segment_manager_props_t * props)
 873 {
 874   u32 fifo_evt_size, session_evt_size = 256, notif_q_size;
 875   svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
 876   svm_msg_q_t *q;
 877   void *base;
 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   base = fifo_segment_alloc (segment, svm_msg_q_size_to_alloc (cfg));
 893   q = svm_msg_q_init (base, cfg);
 894
 895   if (props->use_mq_eventfd)
 896     {
 897       if (svm_msg_q_alloc_producer_eventfd (q))
 898         clib_warning ("failed to alloc eventfd");
 899     }
 900   return q;
 901 }
 902
 903 svm_msg_q_t *
 904 segment_manager_event_queue (segment_manager_t * sm)
 905 {
 906   return sm->event_queue;
 907 }
 908
 909 /**
 910  * Frees shm queue allocated in the first segment
 911  */
 912 void
 913 segment_manager_dealloc_queue (segment_manager_t * sm, svm_queue_t * q)
 914 {
 915   fifo_segment_t *segment;
 916   ssvm_shared_header_t *sh;
 917   void *oldheap;
 918
 919   ASSERT (!pool_is_free_index (sm->segments, 0));
 920
 921   segment = segment_manager_get_segment_w_lock (sm, 0);
 922   sh = segment->ssvm.sh;
 923
 924   oldheap = ssvm_push_heap (sh);
 925   svm_queue_free (q);
 926   ssvm_pop_heap (oldheap);
 927   segment_manager_segment_reader_unlock (sm);
 928 }
 929
 930 /*
 931  * Init segment vm address allocator
 932  */
 933 void
 934 segment_manager_main_init (segment_manager_main_init_args_t * a)
 935 {
 936   segment_manager_main_t *sm = &sm_main;
 937   clib_valloc_chunk_t _ip, *ip = &_ip;
 938
 939   ip->baseva = a->baseva;
 940   ip->size = a->size;
 941
 942   clib_valloc_init (&sm->va_allocator, ip, 1 /* lock */ );
 943
 944   sm->default_fifo_size = 1 << 12;
 945   sm->default_segment_size = 1 << 20;
 946   sm->default_app_mq_size = 128;
 947   sm->default_max_fifo_size = 4 << 20;
 948   sm->default_high_watermark = 80;
 949   sm->default_low_watermark = 50;
 950 }
 951
 952 static clib_error_t *
 953 segment_manager_show_fn (vlib_main_t * vm, unformat_input_t * input,
 954                          vlib_cli_command_t * cmd)
 955 {
 956   segment_manager_main_t *smm = &sm_main;
 957   u8 show_segments = 0, verbose = 0;
 958   uword max_fifo_size;
 959   segment_manager_t *sm;
 960   fifo_segment_t *seg;
 961   app_worker_t *app_wrk;
 962   application_t *app;
 963   u8 custom_logic;
 964
 965   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 966     {
 967       if (unformat (input, "segments"))
 968         show_segments = 1;
 969       else if (unformat (input, "verbose"))
 970         verbose = 1;
 971       else
 972         return clib_error_return (0, "unknown input `%U'",
 973                                   format_unformat_error, input);
 974     }
 975   vlib_cli_output (vm, "%d segment managers allocated",
 976                    pool_elts (smm->segment_managers));
 977   if (verbose && pool_elts (smm->segment_managers))
 978     {
 979       vlib_cli_output (vm, "%-6s%=10s%=10s%=13s%=11s%=11s%=12s",
 980                        "Index", "AppIndex", "Segments", "MaxFifoSize",
 981                        "HighWater", "LowWater", "FifoTuning");
 982
 983       /* *INDENT-OFF* */
 984       pool_foreach (sm, smm->segment_managers)  {
 985         app_wrk = app_worker_get_if_valid (sm->app_wrk_index);
 986         app = app_wrk ? application_get (app_wrk->app_index) : 0;
 987         custom_logic = (app && (app->cb_fns.fifo_tuning_callback)) ? 1 : 0;
 988         max_fifo_size = sm->max_fifo_size;
 989
 990         vlib_cli_output (vm, "%-6d%=10d%=10d%=13U%=11d%=11d%=12s",
 991                          segment_manager_index (sm),
 992                          sm->app_wrk_index, pool_elts (sm->segments),
 993                          format_memory_size, max_fifo_size,
 994                          sm->high_watermark, sm->low_watermark,
 995                          custom_logic ? "custom" : "none");
 996       }
 997       /* *INDENT-ON* */
 998
 999       vlib_cli_output (vm, "\n");
1000     }
1001   if (show_segments)
1002     {
1003       vlib_cli_output (vm, "%U", format_fifo_segment, 0, verbose);
1004
1005       /* *INDENT-OFF* */
1006       pool_foreach (sm, smm->segment_managers)  {
1007           segment_manager_foreach_segment_w_lock (seg, sm, ({
1008             vlib_cli_output (vm, "%U", format_fifo_segment, seg, verbose);
1009           }));
1010       }
1011       /* *INDENT-ON* */
1012
1013     }
1014   return 0;
1015 }
1016
1017 /* *INDENT-OFF* */
1018 VLIB_CLI_COMMAND (segment_manager_show_command, static) =
1019 {
1020   .path = "show segment-manager",
1021   .short_help = "show segment-manager [segments][verbose]",
1022   .function = segment_manager_show_fn,
1023 };
1024 /* *INDENT-ON* */
1025
1026 void
1027 segment_manager_format_sessions (segment_manager_t * sm, int verbose)
1028 {
1029   vlib_main_t *vm = vlib_get_main ();
1030   app_worker_t *app_wrk;
1031   fifo_segment_t *fs;
1032   const u8 *app_name;
1033   int slice_index;
1034   u8 *s = 0, *str;
1035   svm_fifo_t *f;
1036
1037   if (!sm)
1038     {
1039       if (verbose)
1040         vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
1041                          "API Client", "SegManager");
1042       else
1043         vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
1044       return;
1045     }
1046
1047   app_wrk = app_worker_get (sm->app_wrk_index);
1048   app_name = application_name_from_index (app_wrk->app_index);
1049
1050   clib_rwlock_reader_lock (&sm->segments_rwlock);
1051
1052   /* *INDENT-OFF* */
1053   pool_foreach (fs, sm->segments)  {
1054     for (slice_index = 0; slice_index < fs->n_slices; slice_index++)
1055       {
1056         f = fifo_segment_get_slice_fifo_list (fs, slice_index);
1057         while (f)
1058           {
1059             u32 session_index, thread_index;
1060             session_t *session;
1061
1062             session_index = f->master_session_index;
1063             thread_index = f->master_thread_index;
1064
1065             session = session_get (session_index, thread_index);
1066             str = format (0, "%U", format_session, session, verbose);
1067
1068             if (verbose)
1069               s = format (s, "%-40v%-20v%-15u%-10u", str, app_name,
1070                           app_wrk->api_client_index, 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  */