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