FD.io VPP  v18.10-34-gcce845e
Vector Packet Processing
segment_manager.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 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 
17 #include <vnet/session/session.h>
19 
21 
22 /**
23  * Counter used to build segment names
24  */
26 
27 /**
28  * Default fifo and segment size. TODO config.
29  */
30 static u32 default_fifo_size = 1 << 12;
31 static u32 default_segment_size = 1 << 20;
33 
36 {
37  app_worker_t *app_wrk = app_worker_get (sm->app_wrk_index);
39 }
40 
43 {
44  props->add_segment_size = default_segment_size;
45  props->rx_fifo_size = default_fifo_size;
46  props->tx_fifo_size = default_fifo_size;
47  props->evt_q_size = default_app_evt_queue_size;
48  return props;
49 }
50 
51 static u8
53 {
54  return (sm->app_wrk_index == SEGMENT_MANAGER_INVALID_APP_INDEX);
55 }
56 
57 void
59 {
60  sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
61 }
62 
66 {
67  return (seg - sm->segments);
68 }
69 
70 /**
71  * Remove segment without lock
72  */
73 void
76 {
78 
79  if (ssvm_type (&fs->ssvm) != SSVM_SEGMENT_PRIVATE)
81 
82  ssvm_delete (&fs->ssvm);
83 
84  if (CLIB_DEBUG)
85  memset (fs, 0xfb, sizeof (*fs));
86  pool_put (sm->segments, fs);
87 }
88 
89 /**
90  * Removes segment after acquiring writer lock
91  */
92 static inline void
94 {
96  u8 is_prealloc;
97 
98  clib_rwlock_writer_lock (&sm->segments_rwlock);
99  fs = segment_manager_get_segment (sm, fs_index);
101  if (is_prealloc && !segment_manager_app_detached (sm))
102  {
103  clib_rwlock_writer_unlock (&sm->segments_rwlock);
104  return;
105  }
106 
108  clib_rwlock_writer_unlock (&sm->segments_rwlock);
109 }
110 
111 /**
112  * Reads a segment from the segment manager's pool without lock
113  */
116 {
117  return pool_elt_at_index (sm->segments, segment_index);
118 }
119 
120 /**
121  * Reads a segment from the segment manager's pool and acquires reader lock
122  *
123  * Caller must drop the reader's lock by calling
124  * @ref segment_manager_segment_reader_unlock once it finishes working with
125  * the segment.
126  */
129 {
130  clib_rwlock_reader_lock (&sm->segments_rwlock);
131  return pool_elt_at_index (sm->segments, segment_index);
132 }
133 
134 void
136 {
137  ASSERT (sm->segments_rwlock->n_readers > 0);
138  clib_rwlock_reader_unlock (&sm->segments_rwlock);
139 }
140 
141 void
143 {
144  clib_rwlock_writer_unlock (&sm->segments_rwlock);
145 }
146 
147 /**
148  * Adds segment to segment manager's pool
149  *
150  * If needed a writer's lock is acquired before allocating a new segment
151  * to avoid affecting any of the segments pool readers.
152  */
153 int
155 {
157  u32 rnd_margin = 128 << 10, seg_index, page_size;
159  uword baseva = (u64) ~ 0, alloc_size;
161  u8 *seg_name;
162  int rv;
163 
164  props = segment_manager_properties_get (sm);
165 
166  /* Not configured for addition of new segments and not first */
167  if (!props->add_segment && !segment_size)
168  {
169  clib_warning ("cannot allocate new segment");
170  return VNET_API_ERROR_INVALID_VALUE;
171  }
172 
173  /*
174  * Allocate fifo segment and lock if needed
175  */
176  if (vlib_num_workers ())
177  {
178  clib_rwlock_writer_lock (&sm->segments_rwlock);
179  pool_get (sm->segments, seg);
180  }
181  else
182  {
183  pool_get (sm->segments, seg);
184  }
185  memset (seg, 0, sizeof (*seg));
186 
187  /*
188  * Initialize ssvm segment and svm fifo private header
189  */
190  segment_size = segment_size ? segment_size : props->add_segment_size;
191  page_size = clib_mem_get_page_size ();
192  segment_size = (segment_size + page_size - 1) & ~(page_size - 1);
193  if (props->segment_type != SSVM_SEGMENT_PRIVATE)
194  {
195  seg_name = format (0, "%d-%d%c", getpid (), segment_name_counter++, 0);
196  alloc_size = (uword) segment_size + rnd_margin;
197  baseva = clib_valloc_alloc (&smm->va_allocator, alloc_size, 0);
198  if (!baseva)
199  {
200  clib_warning ("out of space for segments");
201  return -1;
202  }
203  }
204  else
205  seg_name = format (0, "%s%c", "process-private-segment", 0);
206 
207  seg->ssvm.ssvm_size = segment_size;
208  seg->ssvm.name = seg_name;
209  seg->ssvm.requested_va = baseva;
210 
211  if ((rv = ssvm_master_init (&seg->ssvm, props->segment_type)))
212  {
213  clib_warning ("svm_master_init ('%v', %u) failed", seg_name,
214  segment_size);
215 
216  if (props->segment_type != SSVM_SEGMENT_PRIVATE)
217  clib_valloc_free (&smm->va_allocator, baseva);
218  pool_put (sm->segments, seg);
219  return (rv);
220  }
221 
222  svm_fifo_segment_init (seg);
223 
224  /*
225  * Save segment index before dropping lock, if any held
226  */
227  seg_index = seg - sm->segments;
228 
229  if (vlib_num_workers ())
230  clib_rwlock_writer_unlock (&sm->segments_rwlock);
231 
232  return seg_index;
233 }
234 
237 {
239  segment_manager_t *sm;
240  pool_get (smm->segment_managers, sm);
241  memset (sm, 0, sizeof (*sm));
242  clib_rwlock_init (&sm->segments_rwlock);
243  return sm;
244 }
245 
246 /**
247  * Initializes segment manager based on options provided.
248  * Returns error if ssvm segment(s) allocation fails.
249  */
250 int
252  u32 prealloc_fifo_pairs)
253 {
254  u32 rx_fifo_size, tx_fifo_size, pair_size;
255  u32 rx_rounded_data_size, tx_rounded_data_size;
256  u64 approx_total_size, max_seg_size = ((u64) 1 << 32) - (128 << 10);
259  u32 approx_segment_count;
260  int seg_index, i;
261 
262  props = segment_manager_properties_get (sm);
263  first_seg_size = clib_max (first_seg_size, default_segment_size);
264 
265  if (prealloc_fifo_pairs)
266  {
267  /* Figure out how many segments should be preallocated */
268  rx_rounded_data_size = (1 << (max_log2 (props->rx_fifo_size)));
269  tx_rounded_data_size = (1 << (max_log2 (props->tx_fifo_size)));
270 
271  rx_fifo_size = sizeof (svm_fifo_t) + rx_rounded_data_size;
272  tx_fifo_size = sizeof (svm_fifo_t) + tx_rounded_data_size;
273  pair_size = rx_fifo_size + tx_fifo_size;
274 
275  approx_total_size = (u64) prealloc_fifo_pairs *pair_size;
276  if (first_seg_size > approx_total_size)
277  max_seg_size = first_seg_size;
278  approx_segment_count = (approx_total_size + (max_seg_size - 1))
279  / max_seg_size;
280 
281  /* Allocate the segments */
282  for (i = 0; i < approx_segment_count + 1; i++)
283  {
284  seg_index = segment_manager_add_segment (sm, max_seg_size);
285  if (seg_index < 0)
286  {
287  clib_warning ("Failed to preallocate segment %d", i);
288  return seg_index;
289  }
290 
291  segment = segment_manager_get_segment (sm, seg_index);
292  if (i == 0)
293  sm->event_queue = segment_manager_alloc_queue (segment, props);
294 
296  props->rx_fifo_size,
297  props->tx_fifo_size,
298  &prealloc_fifo_pairs);
300  if (prealloc_fifo_pairs == 0)
301  break;
302  }
303  }
304  else
305  {
306  seg_index = segment_manager_add_segment (sm, first_seg_size);
307  if (seg_index)
308  {
309  clib_warning ("Failed to allocate segment");
310  return seg_index;
311  }
312  segment = segment_manager_get_segment (sm, seg_index);
313  sm->event_queue = segment_manager_alloc_queue (segment, props);
314  }
315 
316  return 0;
317 }
318 
319 u8
321 {
323  u8 first = 1;
324 
325  /* *INDENT-OFF* */
327  if (CLIB_DEBUG && !first && !svm_fifo_segment_has_fifos (seg)
329  {
330  clib_warning ("segment %d has no fifos!",
332  first = 0;
333  }
334  if (svm_fifo_segment_has_fifos (seg))
335  {
337  return 1;
338  }
339  }));
340  /* *INDENT-ON* */
341 
342  return 0;
343 }
344 
345 /**
346  * Initiate disconnects for all sessions 'owned' by a segment manager
347  */
348 void
350 {
351  svm_fifo_segment_private_t *fifo_segment;
352  stream_session_t *session;
353  svm_fifo_t *fifo;
354 
355  ASSERT (pool_elts (sm->segments) != 0);
356 
357  /* Across all fifo segments used by the server */
358  /* *INDENT-OFF* */
359  segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
360  fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
361 
362  /*
363  * Remove any residual sessions from the session lookup table
364  * Don't bother deleting the individual fifos, we're going to
365  * throw away the fifo segment in a minute.
366  */
367  while (fifo)
368  {
369  if (fifo->ct_session_index != SVM_FIFO_INVALID_SESSION_INDEX)
370  {
371  svm_fifo_t *next = fifo->next;
373  fifo->ct_session_index);
374  fifo = next;
375  continue;
376  }
377  session = session_get (fifo->master_session_index,
378  fifo->master_thread_index);
379  stream_session_disconnect (session);
380  fifo = fifo->next;
381  }
382 
383  /* Instead of removing the segment, test when cleaning up disconnected
384  * sessions if the segment can be removed.
385  */
386  }));
387  /* *INDENT-ON* */
388 }
389 
390 /**
391  * Removes segment manager.
392  *
393  * Since the fifos allocated in the segment keep backpointers to the sessions
394  * prior to removing the segment, we call session disconnect. This
395  * subsequently propagates into transport.
396  */
397 void
399 {
401  svm_fifo_segment_private_t *fifo_segment;
402 
405 
406  /* If we have empty preallocated segments that haven't been removed, remove
407  * them now. Apart from that, the first segment in the first segment manager
408  * is not removed when all fifos are removed. It can only be removed when
409  * the manager is explicitly deleted/detached by the app. */
410  clib_rwlock_writer_lock (&sm->segments_rwlock);
411 
412  /* *INDENT-OFF* */
413  pool_foreach (fifo_segment, sm->segments, ({
414  segment_manager_del_segment (sm, fifo_segment);
415  }));
416  /* *INDENT-ON* */
417 
418  clib_rwlock_writer_unlock (&sm->segments_rwlock);
419 
420  clib_rwlock_free (&sm->segments_rwlock);
421  if (CLIB_DEBUG)
422  memset (sm, 0xfe, sizeof (*sm));
423  pool_put (smm->segment_managers, sm);
424 }
425 
426 void
428 {
430  if (segment_manager_has_fifos (sm))
432  else
433  {
434  ASSERT (!sm->first_is_protected || segment_manager_app_detached (sm));
435  segment_manager_del (sm);
436  }
437 }
438 
439 int
441  u32 rx_fifo_size, u32 tx_fifo_size,
442  svm_fifo_t ** rx_fifo, svm_fifo_t ** tx_fifo)
443 {
444  rx_fifo_size = clib_max (rx_fifo_size, default_fifo_size);
445  *rx_fifo = svm_fifo_segment_alloc_fifo (fifo_segment, rx_fifo_size,
447 
448  tx_fifo_size = clib_max (tx_fifo_size, default_fifo_size);
449  *tx_fifo = svm_fifo_segment_alloc_fifo (fifo_segment, tx_fifo_size,
451 
452  if (*rx_fifo == 0)
453  {
454  /* This would be very odd, but handle it... */
455  if (*tx_fifo != 0)
456  {
457  svm_fifo_segment_free_fifo (fifo_segment, *tx_fifo,
459  *tx_fifo = 0;
460  }
461  return -1;
462  }
463  if (*tx_fifo == 0)
464  {
465  if (*rx_fifo != 0)
466  {
467  svm_fifo_segment_free_fifo (fifo_segment, *rx_fifo,
469  *rx_fifo = 0;
470  }
471  return -1;
472  }
473 
474  return 0;
475 }
476 
477 int
479  svm_fifo_t ** rx_fifo,
480  svm_fifo_t ** tx_fifo,
481  u32 * fifo_segment_index)
482 {
483  svm_fifo_segment_private_t *fifo_segment = 0;
484  int alloc_fail = 1, rv = 0, new_fs_index;
486  u8 added_a_segment = 0;
487  u32 sm_index;
488 
489  props = segment_manager_properties_get (sm);
490 
491  /*
492  * Find the first free segment to allocate the fifos in
493  */
494 
495  /* *INDENT-OFF* */
496  segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
497  alloc_fail = segment_manager_try_alloc_fifos (fifo_segment,
498  props->rx_fifo_size,
499  props->tx_fifo_size,
500  rx_fifo, tx_fifo);
501  /* Exit with lock held, drop it after notifying app */
502  if (!alloc_fail)
503  goto alloc_success;
504  }));
505  /* *INDENT-ON* */
506 
507 alloc_check:
508 
509  if (!alloc_fail)
510  {
511 
512  alloc_success:
513 
514  ASSERT (rx_fifo && tx_fifo);
515  sm_index = segment_manager_index (sm);
516  (*tx_fifo)->segment_manager = sm_index;
517  (*rx_fifo)->segment_manager = sm_index;
518  *fifo_segment_index = segment_manager_segment_index (sm, fifo_segment);
519 
520  if (added_a_segment)
521  rv = app_worker_add_segment_notify (sm->app_wrk_index,
522  &fifo_segment->ssvm);
523  /* Drop the lock after app is notified */
525  return rv;
526  }
527 
528  /*
529  * Allocation failed, see if we can add a new segment
530  */
531  if (props->add_segment)
532  {
533  if (added_a_segment)
534  {
535  clib_warning ("Added a segment, still can't allocate a fifo");
537  return SESSION_ERROR_NEW_SEG_NO_SPACE;
538  }
539  if ((new_fs_index = segment_manager_add_segment (sm, 0)) < 0)
540  {
541  clib_warning ("Failed to add new segment");
542  return SESSION_ERROR_SEG_CREATE;
543  }
544  fifo_segment = segment_manager_get_segment_w_lock (sm, new_fs_index);
545  alloc_fail = segment_manager_try_alloc_fifos (fifo_segment,
546  props->rx_fifo_size,
547  props->tx_fifo_size,
548  rx_fifo, tx_fifo);
549  added_a_segment = 1;
550  goto alloc_check;
551  }
552  else
553  {
554  clib_warning ("Can't add new seg and no space to allocate fifos!");
555  return SESSION_ERROR_NO_SPACE;
556  }
557 }
558 
559 void
560 segment_manager_dealloc_fifos (u32 segment_index, svm_fifo_t * rx_fifo,
561  svm_fifo_t * tx_fifo)
562 {
563  svm_fifo_segment_private_t *fifo_segment;
564  segment_manager_t *sm;
565 
566  /* It's possible to have no segment manager if the session was removed
567  * as result of a detach. */
568  if (!(sm = segment_manager_get_if_valid (rx_fifo->segment_manager)))
569  return;
570 
571  fifo_segment = segment_manager_get_segment_w_lock (sm, segment_index);
572  svm_fifo_segment_free_fifo (fifo_segment, rx_fifo,
574  svm_fifo_segment_free_fifo (fifo_segment, tx_fifo,
576 
577  /*
578  * Try to remove svm segment if it has no fifos. This can be done only if
579  * the segment is not the first in the segment manager or if it is first
580  * and it is not protected. Moreover, if the segment is first and the app
581  * has detached from the segment manager, remove the segment manager.
582  */
583  if (!svm_fifo_segment_has_fifos (fifo_segment))
584  {
586 
587  /* Remove segment if it holds no fifos or first but not protected */
588  if (segment_index != 0 || !sm->first_is_protected)
589  segment_manager_lock_and_del_segment (sm, segment_index);
590 
591  /* Remove segment manager if no sessions and detached from app */
593  && !segment_manager_has_fifos (sm))
594  {
595  segment_manager_del (sm);
596  }
597  }
598  else
600 }
601 
602 u32
604 {
605  u32 fifo_evt_size, notif_q_size, q_hdrs;
606  u32 msg_q_sz, fifo_evt_ring_sz, session_ntf_ring_sz;
607 
608  fifo_evt_size = 1 << max_log2 (sizeof (session_event_t));
609  notif_q_size = clib_max (16, q_len >> 4);
610 
611  msg_q_sz = q_len * sizeof (svm_msg_q_msg_t);
612  fifo_evt_ring_sz = q_len * fifo_evt_size;
613  session_ntf_ring_sz = notif_q_size * 256;
614  q_hdrs = sizeof (svm_queue_t) + sizeof (svm_msg_q_t);
615 
616  return (msg_q_sz + fifo_evt_ring_sz + session_ntf_ring_sz + q_hdrs);
617 }
618 
619 /**
620  * Allocates shm queue in the first segment
621  *
622  * Must be called with lock held
623  */
624 svm_msg_q_t *
627 {
628  u32 fifo_evt_size, session_evt_size = 256, notif_q_size;
629  svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
630  svm_msg_q_t *q;
631  void *oldheap;
632 
633  fifo_evt_size = sizeof (session_event_t);
634  notif_q_size = clib_max (16, props->evt_q_size >> 4);
635  /* *INDENT-OFF* */
637  {props->evt_q_size, fifo_evt_size, 0},
638  {notif_q_size, session_evt_size, 0}
639  };
640  /* *INDENT-ON* */
641  cfg->consumer_pid = 0;
642  cfg->n_rings = 2;
643  cfg->q_nitems = props->evt_q_size;
644  cfg->ring_cfgs = rc;
645 
646  oldheap = ssvm_push_heap (segment->ssvm.sh);
647  q = svm_msg_q_alloc (cfg);
648  ssvm_pop_heap (oldheap);
649 
650  if (props->use_mq_eventfd)
651  {
653  clib_warning ("failed to alloc eventfd");
654  }
655  return q;
656 }
657 
658 /**
659  * Frees shm queue allocated in the first segment
660  */
661 void
663 {
666  void *oldheap;
667 
668  ASSERT (!pool_is_free_index (sm->segments, 0));
669 
670  segment = segment_manager_get_segment_w_lock (sm, 0);
671  sh = segment->ssvm.sh;
672 
673  oldheap = ssvm_push_heap (sh);
674  svm_queue_free (q);
675  ssvm_pop_heap (oldheap);
677 }
678 
679 /*
680  * Init segment vm address allocator
681  */
682 void
684 {
686  clib_valloc_chunk_t _ip, *ip = &_ip;
687 
688  ip->baseva = a->baseva;
689  ip->size = a->size;
690 
691  clib_valloc_init (&sm->va_allocator, ip, 1 /* lock */ );
692 }
693 
694 static clib_error_t *
696  vlib_cli_command_t * cmd)
697 {
700  segment_manager_t *sm;
701  u8 show_segments = 0, verbose = 0;
702  uword address;
703  u64 size;
704  u32 active_fifos;
705  u32 free_fifos;
706 
708  {
709  if (unformat (input, "segments"))
710  show_segments = 1;
711  else if (unformat (input, "verbose"))
712  verbose = 1;
713  else
714  return clib_error_return (0, "unknown input `%U'",
715  format_unformat_error, input);
716  }
717  vlib_cli_output (vm, "%d segment managers allocated",
718  pool_elts (smm->segment_managers));
719  if (verbose && pool_elts (smm->segment_managers))
720  {
721  vlib_cli_output (vm, "%-10s%=15s%=12s", "Index", "App Index",
722  "Segments");
723 
724  /* *INDENT-OFF* */
725  pool_foreach (sm, smm->segment_managers, ({
726  vlib_cli_output (vm, "%-10d%=15d%=12d", segment_manager_index (sm),
727  sm->app_wrk_index, pool_elts (sm->segments));
728  }));
729  /* *INDENT-ON* */
730 
731  }
732  if (show_segments)
733  {
734  vlib_cli_output (vm, "%-15s%15s%15s%15s%15s%15s", "Name", "Type",
735  "HeapSize (M)", "ActiveFifos", "FreeFifos", "Address");
736 
737  /* *INDENT-OFF* */
738  pool_foreach (sm, smm->segment_managers, ({
739  segment_manager_foreach_segment_w_lock (seg, sm, ({
740  svm_fifo_segment_info (seg, &address, &size);
741  active_fifos = svm_fifo_segment_num_fifos (seg);
742  free_fifos = svm_fifo_segment_num_free_fifos (seg, ~0 /* size */);
743  vlib_cli_output (vm, "%-15v%15U%15llu%15u%15u%15llx",
744  ssvm_name (&seg->ssvm), format_svm_fifo_segment_type,
745  seg, size >> 20ULL, active_fifos, free_fifos,
746  address);
747  if (verbose)
748  vlib_cli_output (vm, "%U", format_svm_fifo_segment, seg, verbose);
749  }));
750  }));
751  /* *INDENT-ON* */
752 
753  }
754  return 0;
755 }
756 
757 /* *INDENT-OFF* */
758 VLIB_CLI_COMMAND (segment_manager_show_command, static) =
759 {
760  .path = "show segment-manager",
761  .short_help = "show segment-manager [segments][verbose]",
762  .function = segment_manager_show_fn,
763 };
764 /* *INDENT-ON* */
765 
766 /*
767  * fd.io coding-style-patch-verification: ON
768  *
769  * Local Variables:
770  * eval: (c-set-style "gnu")
771  * End:
772  */
segment_manager_main_t segment_manager_main
static void clib_rwlock_reader_lock(clib_rwlock_t *p)
Definition: lock.h:139
u64 ssvm_size
Definition: ssvm.h:84
app_worker_t * app_worker_get(u32 wrk_index)
Definition: application.c:499
typedef address
Definition: ip_types.api:35
int application_local_session_disconnect_w_index(u32 app_wrk_index, u32 ls_index)
Definition: application.c:1827
void segment_manager_segment_reader_unlock(segment_manager_t *sm)
uword requested_va
Definition: ssvm.h:87
static segment_manager_t * segment_manager_get_if_valid(u32 index)
a
Definition: bitmap.h:538
static void clib_rwlock_writer_lock(clib_rwlock_t *p)
Definition: lock.h:177
struct _segment_manager_properties segment_manager_properties_t
segment_manager_properties_t * application_get_segment_manager_properties(u32 app_index)
Definition: application.c:1191
unsigned long u64
Definition: types.h:89
static u32 default_segment_size
svm_msg_q_t * segment_manager_alloc_queue(svm_fifo_segment_private_t *segment, segment_manager_properties_t *props)
Allocates shm queue in the first segment.
static void clib_rwlock_free(clib_rwlock_t *p)
Definition: lock.h:129
static u32 default_app_evt_queue_size
clib_valloc_main_t va_allocator
Virtual address allocator.
#define FIFO_SEGMENT_F_IS_PREALLOCATED
int i
ssvm_shared_header_t * sh
Definition: ssvm.h:83
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
void segment_manager_dealloc_fifos(u32 segment_index, svm_fifo_t *rx_fifo, svm_fifo_t *tx_fifo)
segment_manager_properties_t * segment_manager_properties_init(segment_manager_properties_t *props)
#define segment_manager_foreach_segment_w_lock(VAR, SM, BODY)
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:228
void svm_fifo_segment_preallocate_fifo_pairs(svm_fifo_segment_private_t *s, u32 rx_fifo_size, u32 tx_fifo_size, u32 *n_fifo_pairs)
Pre-allocates fifo pairs in fifo segment.
segment_manager_t * segment_managers
Pool of segment managers.
u32 segment_manager_evt_q_expected_size(u32 q_len)
unsigned char u8
Definition: types.h:56
int segment_manager_init(segment_manager_t *sm, u32 first_seg_size, u32 prealloc_fifo_pairs)
Initializes segment manager based on options provided.
void ssvm_delete(ssvm_private_t *ssvm)
Definition: ssvm.c:423
struct _svm_fifo svm_fifo_t
memset(h->entries, 0, sizeof(h->entries[0])*entries)
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:443
svm_msg_q_t * svm_msg_q_alloc(svm_msg_q_cfg_t *cfg)
Allocate message queue.
Definition: message_queue.c:40
static u8 segment_manager_app_detached(segment_manager_t *sm)
#define always_inline
Definition: clib.h:94
svm_fifo_segment_private_t * segment_manager_get_segment_w_lock(segment_manager_t *sm, u32 segment_index)
Reads a segment from the segment manager&#39;s pool and acquires reader lock.
static void * ssvm_push_heap(ssvm_shared_header_t *sh)
Definition: ssvm.h:144
#define clib_error_return(e, args...)
Definition: error.h:99
unsigned int u32
Definition: types.h:88
struct _stream_session_t stream_session_t
static void segment_manager_lock_and_del_segment(segment_manager_t *sm, u32 fs_index)
Removes segment after acquiring writer lock.
int ssvm_master_init(ssvm_private_t *ssvm, ssvm_segment_type_t type)
Definition: ssvm.c:411
static void ssvm_pop_heap(void *oldheap)
Definition: ssvm.h:152
segment_manager_t * segment_manager_new()
static heap_elt_t * first(heap_header_t *h)
Definition: heap.c:59
#define svm_fifo_segment_flags(_seg)
int segment_manager_alloc_session_fifos(segment_manager_t *sm, svm_fifo_t **rx_fifo, svm_fifo_t **tx_fifo, u32 *fifo_segment_index)
static svm_fifo_t * svm_fifo_segment_get_fifo_list(svm_fifo_segment_private_t *fifo_segment)
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:464
uword size
static void clib_rwlock_init(clib_rwlock_t *p)
Definition: lock.h:122
static void clib_rwlock_reader_unlock(clib_rwlock_t *p)
Definition: lock.h:157
void segment_manager_app_detach(segment_manager_t *sm)
void segment_manager_dealloc_queue(segment_manager_t *sm, svm_queue_t *q)
Frees shm queue allocated in the first segment.
struct _unformat_input_t unformat_input_t
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:274
svm_fifo_segment_private_t * segment_manager_get_segment(segment_manager_t *sm, u32 segment_index)
Reads a segment from the segment manager&#39;s pool without lock.
u8 segment_manager_has_fifos(segment_manager_t *sm)
segment_manager_properties_t * segment_manager_properties_get(segment_manager_t *sm)
uword size
size in bytes of this chunk
Definition: valloc.h:33
void segment_manager_del_segment(segment_manager_t *sm, svm_fifo_segment_private_t *fs)
Remove segment without lock.
int segment_manager_add_segment(segment_manager_t *sm, u32 segment_size)
Adds segment to segment manager&#39;s pool.
static stream_session_t * session_get(u32 si, u32 thread_index)
Definition: session.h:314
uword baseva
base VA for this chunk
Definition: valloc.h:32
#define SEGMENT_MANAGER_INVALID_APP_INDEX
static u8 svm_fifo_segment_has_fifos(svm_fifo_segment_private_t *fifo_segment)
static void clib_rwlock_writer_unlock(clib_rwlock_t *p)
Definition: lock.h:185
u32 n_rings
number of msg rings
Definition: message_queue.h:54
#define UNFORMAT_END_OF_INPUT
Definition: format.h:144
vlib_main_t * vm
Definition: buffer.c:294
#define clib_warning(format, args...)
Definition: error.h:59
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:271
int segment_manager_try_alloc_fifos(svm_fifo_segment_private_t *fifo_segment, u32 rx_fifo_size, u32 tx_fifo_size, svm_fifo_t **rx_fifo, svm_fifo_t **tx_fifo)
static u32 segment_manager_index(segment_manager_t *sm)
void svm_queue_free(svm_queue_t *q)
Definition: queue.c:89
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:155
uword clib_valloc_alloc(clib_valloc_main_t *vam, uword size, int os_out_of_memory_on_failure)
Allocate virtual space.
Definition: valloc.c:151
void segment_manager_init_del(segment_manager_t *sm)
#define ASSERT(truth)
void segment_manager_main_init(segment_manager_main_init_args_t *a)
static u32 segment_manager_segment_index(segment_manager_t *sm, svm_fifo_segment_private_t *seg)
void stream_session_disconnect(stream_session_t *s)
Initialize session disconnect.
Definition: session.c:1066
svm_msg_q_ring_cfg_t * ring_cfgs
array of ring cfgs
Definition: message_queue.h:55
void svm_fifo_segment_free_fifo(svm_fifo_segment_private_t *s, svm_fifo_t *f, svm_fifo_segment_freelist_t list_index)
#define clib_max(x, y)
Definition: clib.h:284
u8 * name
Definition: ssvm.h:86
void segment_manager_segment_writer_unlock(segment_manager_t *sm)
void segment_manager_del(segment_manager_t *sm)
Removes segment manager.
u32 q_nitems
msg queue size (not rings)
Definition: message_queue.h:53
static uword max_log2(uword x)
Definition: clib.h:187
static u32 segment_name_counter
Counter used to build segment names.
u64 uword
Definition: types.h:112
void segment_manager_del_sessions(segment_manager_t *sm)
Initiate disconnects for all sessions &#39;owned&#39; by a segment manager.
uword clib_valloc_free(clib_valloc_main_t *vam, uword baseva)
Free virtual space.
Definition: valloc.c:228
struct _segment_manager segment_manager_t
struct _svm_queue svm_queue_t
int svm_fifo_segment_init(svm_fifo_segment_private_t *s)
Initialize svm fifo segment shared header.
u32 app_index
Index of owning app.
Definition: application.h:72
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
void clib_valloc_init(clib_valloc_main_t *vam, clib_valloc_chunk_t *template, int need_lock)
Initialize a virtual memory allocation arena.
Definition: valloc.c:129
int app_worker_add_segment_notify(u32 app_wrk_index, ssvm_private_t *fs)
Send an API message to the external app, to map new segment.
Definition: application.c:985
static u32 vlib_num_workers()
Definition: threads.h:365
static clib_error_t * segment_manager_show_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
#define SVM_FIFO_INVALID_SESSION_INDEX
Definition: svm_fifo.h:41
int consumer_pid
pid of msg consumer
Definition: message_queue.h:52
static u32 default_fifo_size
Default fifo and segment size.
int svm_msg_q_alloc_producer_eventfd(svm_msg_q_t *mq)
Allocate event fd for queue consumer.
uword clib_mem_get_page_size(void)
Definition: mem_dlmalloc.c:244
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:725
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:972
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:170
svm_fifo_t * svm_fifo_segment_alloc_fifo(svm_fifo_segment_private_t *s, u32 data_size_in_bytes, svm_fifo_segment_freelist_t list_index)
Allocate fifo in svm segment.
ssvm_segment_type_t ssvm_type(const ssvm_private_t *ssvm)
Definition: ssvm.c:429
static uword pool_elts(void *v)
Number of active elements in a pool.
Definition: pool.h:128