FD.io VPP  v21.01.1
Vector Packet Processing
application_worker.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 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 
18 #include <vnet/session/session.h>
19 
20 /**
21  * Pool of workers associated to apps
22  */
24 
27 {
28  app_worker_t *app_wrk;
29  pool_get (app_workers, app_wrk);
30  clib_memset (app_wrk, 0, sizeof (*app_wrk));
31  app_wrk->wrk_index = app_wrk - app_workers;
32  app_wrk->app_index = app->app_index;
33  app_wrk->wrk_map_index = ~0;
37  APP_DBG ("New app %v worker %u", app->name, app_wrk->wrk_index);
38  return app_wrk;
39 }
40 
42 app_worker_get (u32 wrk_index)
43 {
44  return pool_elt_at_index (app_workers, wrk_index);
45 }
46 
49 {
50  if (pool_is_free_index (app_workers, wrk_index))
51  return 0;
52  return pool_elt_at_index (app_workers, wrk_index);
53 }
54 
55 void
57 {
58  application_t *app = application_get (app_wrk->app_index);
59  vnet_unlisten_args_t _a, *a = &_a;
60  u64 handle, *handles = 0, *sm_indices = 0;
62  session_t *ls;
63  u32 sm_index;
64  int i, j;
65 
66  /*
67  * Listener cleanup
68  */
69 
70  /* *INDENT-OFF* */
71  hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
72  ls = listen_session_get_from_handle (handle);
73  vec_add1 (handles, app_listen_session_handle (ls));
74  vec_add1 (sm_indices, sm_index);
75  sm = segment_manager_get (sm_index);
76  }));
77  /* *INDENT-ON* */
78 
79  for (i = 0; i < vec_len (handles); i++)
80  {
81  /* Cleanup listener */
82  a->app_index = app->app_index;
83  a->wrk_map_index = app_wrk->wrk_map_index;
84  a->handle = handles[i];
85  (void) vnet_unlisten (a);
86 
87  sm = segment_manager_get_if_valid (sm_indices[i]);
88  if (sm && !segment_manager_app_detached (sm))
89  {
90  sm->first_is_protected = 0;
92  }
93  }
94  vec_reset_length (handles);
95  vec_free (sm_indices);
96  hash_free (app_wrk->listeners_table);
97 
98  /*
99  * Connects segment manager cleanup
100  */
101 
103  {
105  sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
106  sm->first_is_protected = 0;
108  }
109 
110  /*
111  * Half-open cleanup
112  */
113 
114  for (i = 0; i < vec_len (app_wrk->half_open_table); i++)
115  {
116  if (!app_wrk->half_open_table[i])
117  continue;
118 
119  /* *INDENT-OFF* */
120  hash_foreach (handle, sm_index, app_wrk->half_open_table[i], ({
121  vec_add1 (handles, handle);
122  }));
123  /* *INDENT-ON* */
124 
125  for (j = 0; j < vec_len (handles); j++)
126  session_cleanup_half_open (i, handles[j]);
127 
128  hash_free (app_wrk->half_open_table[i]);
129  vec_reset_length (handles);
130  }
131 
132  vec_free (app_wrk->half_open_table);
133  vec_free (handles);
134 
135  /*
136  * Detached listener segment managers cleanup
137  */
138  for (i = 0; i < vec_len (app_wrk->detached_seg_managers); i++)
139  {
140  sm = segment_manager_get (app_wrk->detached_seg_managers[i]);
142  }
143  vec_free (app_wrk->detached_seg_managers);
145 
146  /* If first segment manager is used by a listener that recently
147  * stopped listening, mark it as detached */
148  if (app_wrk->first_segment_manager != app_wrk->connects_seg_manager
151  {
152  sm->first_is_protected = 0;
153  sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
155  }
156 
157  if (CLIB_DEBUG)
158  clib_memset (app_wrk, 0xfe, sizeof (*app_wrk));
159  pool_put (app_workers, app_wrk);
160 }
161 
164 {
165  app_worker_t *app_wrk;
166  app_wrk = app_worker_get_if_valid (wrk_index);
167  if (!app_wrk)
168  return 0;
169  return application_get_if_valid (app_wrk->app_index);
170 }
171 
172 static segment_manager_t *
174 {
175  segment_manager_t *sm = 0;
176 
177  /* If the first segment manager is not in use, don't allocate a new one */
179  && app_wrk->first_segment_manager_in_use == 0)
180  {
182  app_wrk->first_segment_manager_in_use = 1;
183  }
184  else
185  {
186  sm = segment_manager_alloc ();
187  }
188  sm->app_wrk_index = app_wrk->wrk_index;
190  return sm;
191 }
192 
193 static int
195 {
196  svm_fifo_t *rx_fifo = 0, *tx_fifo = 0;
197  int rv;
198 
200  &rx_fifo, &tx_fifo)))
201  return rv;
202 
203  rx_fifo->master_session_index = s->session_index;
204  rx_fifo->master_thread_index = s->thread_index;
205 
206  tx_fifo->master_session_index = s->session_index;
207  tx_fifo->master_thread_index = s->thread_index;
208 
209  s->rx_fifo = rx_fifo;
210  s->tx_fifo = tx_fifo;
211  return 0;
212 }
213 
214 int
216 {
217  segment_manager_t *sm;
218 
219  /* Allocate segment manager. All sessions derived out of a listen session
220  * have fifos allocated by the same segment manager. */
221  if (!(sm = app_worker_alloc_segment_manager (app_wrk)))
222  return SESSION_E_ALLOC;
223 
224  /* Keep track of the segment manager for the listener or this worker */
226  segment_manager_index (sm));
227 
229  {
230  if (ls->rx_fifo)
231  return SESSION_E_NOSUPPORT;
232  return app_worker_alloc_session_fifos (sm, ls);
233  }
234  return 0;
235 }
236 
237 int
239  app_listener_t * app_listener)
240 {
241  session_t *ls;
242  int rv;
243 
244  if (clib_bitmap_get (app_listener->workers, app_wrk->wrk_map_index))
245  return SESSION_E_ALREADY_LISTENING;
246 
247  app_listener->workers = clib_bitmap_set (app_listener->workers,
248  app_wrk->wrk_map_index, 1);
249 
250  if (app_listener->session_index != SESSION_INVALID_INDEX)
251  {
252  ls = session_get (app_listener->session_index, 0);
253  if ((rv = app_worker_init_listener (app_wrk, ls)))
254  return rv;
255  }
256 
257  if (app_listener->local_index != SESSION_INVALID_INDEX)
258  {
259  ls = session_get (app_listener->local_index, 0);
260  if ((rv = app_worker_init_listener (app_wrk, ls)))
261  return rv;
262  }
263 
264  return 0;
265 }
266 
267 static void
269 {
270  vec_add1 (app_wrk->detached_seg_managers, sm_index);
271 }
272 
273 void
275 {
276  u32 i;
277 
279  for (i = 0; i < vec_len (app_wrk->detached_seg_managers); i++)
280  {
281  if (app_wrk->detached_seg_managers[i] == sm_index)
282  {
283  vec_del1 (app_wrk->detached_seg_managers, i);
284  break;
285  }
286  }
288 }
289 
290 static void
292 {
293  session_handle_t handle;
294  segment_manager_t *sm;
295  uword *sm_indexp;
296 
297  handle = listen_session_get_handle (ls);
298  sm_indexp = hash_get (app_wrk->listeners_table, handle);
299  if (PREDICT_FALSE (!sm_indexp))
300  return;
301 
302  /* Dealloc fifos, if any (dgram listeners) */
303  if (ls->rx_fifo)
304  {
306  ls->tx_fifo = ls->rx_fifo = 0;
307  }
308 
309  /* Try to cleanup segment manager */
310  sm = segment_manager_get (*sm_indexp);
311  if (sm && app_wrk->first_segment_manager != *sm_indexp)
312  {
314  if (!segment_manager_has_fifos (sm))
316  else
317  {
318  /* Track segment manager in case app detaches and all the
319  * outstanding sessions need to be closed */
320  app_worker_add_detached_sm (app_wrk, *sm_indexp);
321  sm->flags |= SEG_MANAGER_F_DETACHED_LISTENER;
322  }
323  }
324 
325  hash_unset (app_wrk->listeners_table, handle);
326 }
327 
328 int
330 {
331  session_t *ls;
332 
333  if (!clib_bitmap_get (al->workers, app_wrk->wrk_map_index))
334  return 0;
335 
337  {
339  app_worker_stop_listen_session (app_wrk, ls);
340  }
341 
343  {
344  ls = listen_session_get (al->local_index);
345  app_worker_stop_listen_session (app_wrk, ls);
346  }
347 
349  if (clib_bitmap_is_zero (al->workers))
351 
352  return 0;
353 }
354 
355 int
357 {
358  app_worker_t *app_wrk;
359  segment_manager_t *sm;
361  application_t *app;
362 
364  app_wrk = application_listener_select_worker (listener);
365  s->app_wrk_index = app_wrk->wrk_index;
366 
367  app = application_get (app_wrk->app_index);
368  if (app->cb_fns.fifo_tuning_callback)
369  s->flags |= SESSION_F_CUSTOM_FIFO_TUNING;
370 
371  sm = app_worker_get_listen_segment_manager (app_wrk, listener);
372  if (app_worker_alloc_session_fifos (sm, s))
373  return -1;
374 
375  return 0;
376 }
377 
378 int
380 {
381  application_t *app = application_get (app_wrk->app_index);
382  return app->cb_fns.session_accept_callback (s);
383 }
384 
385 int
387 {
388  application_t *app = application_get (app_wrk->app_index);
389  segment_manager_t *sm;
390 
391  if (app->cb_fns.fifo_tuning_callback)
392  s->flags |= SESSION_F_CUSTOM_FIFO_TUNING;
393 
394  /* Allocate fifos for session, unless the app is a builtin proxy */
396  return 0;
397 
399  return app_worker_alloc_session_fifos (sm, s);
400 }
401 
402 int
404  session_error_t err, u32 opaque)
405 {
406  application_t *app = application_get (app_wrk->app_index);
407  return app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque,
408  s, err);
409 }
410 
411 int
413  session_handle_t ho_handle,
414  session_handle_t wrk_handle)
415 {
416  ASSERT (vlib_get_thread_index () == 0);
417  vec_validate (app_wrk->half_open_table, tp);
418  hash_set (app_wrk->half_open_table[tp], ho_handle, wrk_handle);
419  return 0;
420 }
421 
422 int
424  session_handle_t ho_handle)
425 {
426  ASSERT (vlib_get_thread_index () == 0);
427  hash_unset (app_wrk->half_open_table[tp], ho_handle);
428  return 0;
429 }
430 
431 u64
433  session_handle_t ho_handle)
434 {
435  u64 *ho_wrk_handlep;
436 
437  /* No locking because all updates are done from main thread */
438  ho_wrk_handlep = hash_get (app_wrk->half_open_table[tp], ho_handle);
439  if (!ho_wrk_handlep)
440  return SESSION_INVALID_HANDLE;
441 
442  return *ho_wrk_handlep;
443 }
444 
445 int
447 {
448  application_t *app = application_get (app_wrk->app_index);
450  return 0;
451 }
452 
453 int
455 {
456  application_t *app = application_get (app_wrk->app_index);
459  return 0;
460 }
461 
462 int
464 {
465  application_t *app = application_get (app_wrk->app_index);
467  return 0;
468 }
469 
470 int
473 {
474  application_t *app = application_get (app_wrk->app_index);
476  app->cb_fns.session_cleanup_callback (s, ntf);
477  return 0;
478 }
479 
480 int
482 {
483  application_t *app = application_get (app_wrk->app_index);
485  return 0;
486 }
487 
488 int
490 {
491  application_t *app = application_get (app_wrk->app_index);
492 
494  return 0;
495 
497  return 0;
498 }
499 
500 int
502  session_handle_t new_sh)
503 {
504  application_t *app = application_get (app_wrk->app_index);
505  app->cb_fns.session_migrate_callback (s, new_sh);
506  return 0;
507 }
508 
509 int
511 {
512  segment_manager_t *sm;
513  svm_fifo_t *rxf, *txf;
514 
515  if (s->session_state == SESSION_STATE_LISTENING)
516  return application_change_listener_owner (s, app_wrk);
517 
518  s->app_wrk_index = app_wrk->wrk_index;
519 
520  rxf = s->rx_fifo;
521  txf = s->tx_fifo;
522 
523  if (!rxf || !txf)
524  return 0;
525 
526  s->rx_fifo = 0;
527  s->tx_fifo = 0;
528 
530  if (app_worker_alloc_session_fifos (sm, s))
531  return -1;
532 
533  if (!svm_fifo_is_empty_cons (rxf))
534  svm_fifo_clone (s->rx_fifo, rxf);
535 
536  if (!svm_fifo_is_empty_cons (txf))
537  svm_fifo_clone (s->tx_fifo, txf);
538 
540 
541  return 0;
542 }
543 
544 int
546  u32 api_context)
547 {
548  int rv;
549 
550  /* Make sure we have a segment manager for connects */
552  return SESSION_E_ALLOC;
553 
554  if ((rv = session_open (app_wrk->wrk_index, sep, api_context)))
555  return rv;
556 
557  return 0;
558 }
559 
560 int
562  svm_fifo_t * f,
564 {
565  application_t *app = application_get (app_wrk->app_index);
566  return app->cb_fns.fifo_tuning_callback (s, f, act, len);
567 }
568 
569 int
571 {
572  segment_manager_t *sm;
573 
575  {
576  sm = app_worker_alloc_segment_manager (app_wrk);
577  if (sm == 0)
578  return -1;
580  }
581  return 0;
582 }
583 
586 {
587  ASSERT (app->connects_seg_manager != (u32) ~ 0);
589 }
590 
593 {
594  if (app_wrk->connects_seg_manager == (u32) ~ 0)
596  return segment_manager_get (app_wrk->connects_seg_manager);
597 }
598 
602 {
603  uword *smp;
604  smp = hash_get (app->listeners_table, listen_session_get_handle (listener));
605  ALWAYS_ASSERT (smp != 0);
606  return segment_manager_get (*smp);
607 }
608 
609 session_t *
612 {
614  u64 handle;
615  u32 sm_index;
616  u8 sst;
617 
618  sst = session_type_from_proto_and_ip (transport_proto,
619  fib_proto == FIB_PROTOCOL_IP4);
620 
621  /* *INDENT-OFF* */
622  hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
623  listener = listen_session_get_from_handle (handle);
624  if (listener->session_type == sst
625  && !(listener->flags & SESSION_F_PROXY))
626  return listener;
627  }));
628  /* *INDENT-ON* */
629 
630  return 0;
631 }
632 
633 session_t *
636 {
638  u64 handle;
639  u32 sm_index;
640  u8 sst;
641 
642  sst = session_type_from_proto_and_ip (transport_proto,
643  fib_proto == FIB_PROTOCOL_IP4);
644 
645  /* *INDENT-OFF* */
646  hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
647  listener = listen_session_get_from_handle (handle);
648  if (listener->session_type == sst && (listener->flags & SESSION_F_PROXY))
649  return listener;
650  }));
651  /* *INDENT-ON* */
652 
653  return 0;
654 }
655 
656 /**
657  * Send an API message to the external app, to map new segment
658  */
659 int
660 app_worker_add_segment_notify (app_worker_t * app_wrk, u64 segment_handle)
661 {
662  application_t *app = application_get (app_wrk->app_index);
663 
664  return app->cb_fns.add_segment_callback (app_wrk->wrk_index,
665  segment_handle);
666 }
667 
668 int
669 app_worker_del_segment_notify (app_worker_t * app_wrk, u64 segment_handle)
670 {
671  application_t *app = application_get (app_wrk->app_index);
672  return app->cb_fns.del_segment_callback (app_wrk->wrk_index,
673  segment_handle);
674 }
675 
676 static inline u8
678 {
679  return app_wrk->app_is_builtin;
680 }
681 
682 static inline int
684 {
685  session_event_t *evt;
686  svm_msg_q_msg_t msg;
687  svm_msg_q_t *mq;
688 
689  if (app_worker_application_is_builtin (app_wrk))
690  return app_worker_builtin_rx (app_wrk, s);
691 
692  if (svm_fifo_has_event (s->rx_fifo))
693  return 0;
694 
695  mq = app_wrk->event_queue;
696  svm_msg_q_lock (mq);
697 
698  if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
699  {
700  clib_warning ("evt q full");
701  svm_msg_q_unlock (mq);
702  return -1;
703  }
704 
706  {
707  clib_warning ("evt q rings full");
708  svm_msg_q_unlock (mq);
709  return -1;
710  }
711 
713  evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
714  evt->session_index = s->rx_fifo->client_session_index;
715  evt->event_type = SESSION_IO_EVT_RX;
716 
717  (void) svm_fifo_set_event (s->rx_fifo);
718  svm_msg_q_add_and_unlock (mq, &msg);
719 
720  return 0;
721 }
722 
723 static inline int
725 {
726  svm_msg_q_t *mq;
727  session_event_t *evt;
728  svm_msg_q_msg_t msg;
729 
730  if (app_worker_application_is_builtin (app_wrk))
731  return app_worker_builtin_tx (app_wrk, s);
732 
733  mq = app_wrk->event_queue;
734  svm_msg_q_lock (mq);
735 
736  if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
737  {
738  clib_warning ("evt q full");
739  svm_msg_q_unlock (mq);
740  return -1;
741  }
742 
744  {
745  clib_warning ("evt q rings full");
746  svm_msg_q_unlock (mq);
747  return -1;
748  }
749 
751  evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
752  evt->event_type = SESSION_IO_EVT_TX;
753  evt->session_index = s->tx_fifo->client_session_index;
754 
755  svm_msg_q_add_and_unlock (mq, &msg);
756  return 0;
757 }
758 
759 /* *INDENT-OFF* */
761  session_t *s);
765 };
766 /* *INDENT-ON* */
767 
768 /**
769  * Send event to application
770  *
771  * Logic from queue perspective is blocking. However, if queue is full,
772  * we return.
773  */
774 int
776  u8 evt_type)
777 {
778  return app_send_evt_handler_fns[evt_type] (app, s);
779 }
780 
781 u8 *
782 format_app_worker_listener (u8 * s, va_list * args)
783 {
784  app_worker_t *app_wrk = va_arg (*args, app_worker_t *);
785  u64 handle = va_arg (*args, u64);
786  u32 sm_index = va_arg (*args, u32);
787  int verbose = va_arg (*args, int);
789  const u8 *app_name;
790  u8 *str;
791 
792  if (!app_wrk)
793  {
794  if (verbose)
795  s = format (s, "%-40s%-25s%-10s%-15s%-15s%-10s", "Connection", "App",
796  "Wrk", "API Client", "ListenerID", "SegManager");
797  else
798  s = format (s, "%-40s%-25s%-10s", "Connection", "App", "Wrk");
799 
800  return s;
801  }
802 
803  app_name = application_name_from_index (app_wrk->app_index);
804  listener = listen_session_get_from_handle (handle);
805  str = format (0, "%U", format_session, listener, verbose);
806 
807  if (verbose)
808  {
809  u8 *buf;
810  buf = format (0, "%u(%u)", app_wrk->wrk_map_index, app_wrk->wrk_index);
811  s = format (s, "%-40v%-25v%-10v%-15u%-15u%-10u", str, app_name,
812  buf, app_wrk->api_client_index, handle, sm_index);
813  vec_free (buf);
814  }
815  else
816  s = format (s, "%-40v%-25v%=10u", str, app_name, app_wrk->wrk_map_index);
817 
818  vec_free (str);
819 
820  return s;
821 }
822 
823 u8 *
824 format_app_worker (u8 * s, va_list * args)
825 {
826  app_worker_t *app_wrk = va_arg (*args, app_worker_t *);
827  u32 indent = 1;
828 
829  s = format (s, "%U wrk-index %u app-index %u map-index %u "
830  "api-client-index %d\n", format_white_space, indent,
831  app_wrk->wrk_index, app_wrk->app_index, app_wrk->wrk_map_index,
832  app_wrk->api_client_index);
833  return s;
834 }
835 
836 void
837 app_worker_format_connects (app_worker_t * app_wrk, int verbose)
838 {
839  segment_manager_t *sm;
840 
841  /* Header */
842  if (!app_wrk)
843  {
844  segment_manager_format_sessions (0, verbose);
845  return;
846  }
847 
848  if (app_wrk->connects_seg_manager == (u32) ~ 0)
849  return;
850 
852  segment_manager_format_sessions (sm, verbose);
853 }
854 
855 /*
856  * fd.io coding-style-patch-verification: ON
857  *
858  * Local Variables:
859  * eval: (c-set-style "gnu")
860  * End:
861  */
u32 segment_manager_index(segment_manager_t *sm)
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:509
int app_worker_init_accepted(session_t *s)
#define hash_set(h, key, value)
Definition: hash.h:255
void * svm_msg_q_msg_data(svm_msg_q_t *mq, svm_msg_q_msg_t *msg)
Get data for message in queue.
static u8 svm_msg_q_ring_is_full(svm_msg_q_t *mq, u32 ring_index)
static_always_inline void clib_spinlock_unlock(clib_spinlock_t *p)
Definition: lock.h:121
int session_open(u32 app_wrk_index, session_endpoint_t *rmt, u32 opaque)
Ask transport to open connection to remote transport endpoint.
Definition: session.c:1319
static_always_inline void clib_spinlock_lock(clib_spinlock_t *p)
Definition: lock.h:82
int app_worker_init_connected(app_worker_t *app_wrk, session_t *s)
#define hash_unset(h, key)
Definition: hash.h:261
u8 * format_session(u8 *s, va_list *args)
Format stream session as per the following format.
Definition: session_cli.c:101
a
Definition: bitmap.h:544
transport_proto
Definition: session.api:22
svm_fifo_t * tx_fifo
u32 * detached_seg_managers
Vector of detached listener segment managers.
Definition: application.h:74
struct _vnet_unlisten_args_t vnet_unlisten_args_t
int application_change_listener_owner(session_t *s, app_worker_t *app_wrk)
Definition: application.c:1107
u32 session_index
Index in thread pool where session was allocated.
static segment_manager_t * app_worker_alloc_segment_manager(app_worker_t *app_wrk)
unsigned long u64
Definition: types.h:89
session_t * app_worker_first_listener(app_worker_t *app_wrk, u8 fib_proto, u8 transport_proto)
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
transport_connection_t * session_get_transport(session_t *s)
Definition: session.c:1631
svm_fifo_t * rx_fifo
Pointers to rx/tx buffers.
static session_t * listen_session_get_from_handle(session_handle_t handle)
Definition: session.h:583
static void app_worker_add_detached_sm(app_worker_t *app_wrk, u32 sm_index)
void segment_manager_format_sessions(segment_manager_t *sm, int verbose)
int app_worker_builtin_tx(app_worker_t *app_wrk, session_t *s)
u64 app_worker_lookup_half_open(app_worker_t *app_wrk, transport_proto_t tp, session_handle_t ho_handle)
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:592
void app_worker_del_detached_sm(app_worker_t *app_wrk, u32 sm_index)
static int svm_fifo_is_empty_cons(svm_fifo_t *f)
Check if fifo is empty optimized for consumer.
Definition: svm_fifo.h:497
int app_worker_builtin_rx(app_worker_t *app_wrk, session_t *s)
u32 wrk_map_index
Worker index in app&#39;s map pool.
Definition: application.h:40
void segment_manager_free(segment_manager_t *sm)
Cleanup segment manager.
static uword * clib_bitmap_set(uword *ai, uword i, uword value)
Sets the ith bit of a bitmap to new_value Removes trailing zeros from the bitmap. ...
Definition: bitmap.h:167
static session_t * session_get(u32 si, u32 thread_index)
Definition: session.h:307
int vnet_unlisten(vnet_unlisten_args_t *a)
Definition: application.c:1055
int app_worker_reset_notify(app_worker_t *app_wrk, session_t *s)
void(* session_reset_callback)(session_t *s)
Notify app that session was reset.
uword * listeners_table
Lookup tables for listeners.
Definition: application.h:52
u32 flags
Session flags.
u8 app_is_builtin
Definition: application.h:65
static u8 app_worker_application_is_builtin(app_worker_t *app_wrk)
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:251
u32 connects_seg_manager
Segment manager used for outgoing connects issued by the app.
Definition: application.h:49
static int app_send_io_evt_tx(app_worker_t *app_wrk, session_t *s)
unsigned char u8
Definition: types.h:56
application_t * application_get_if_valid(u32 app_index)
Definition: application.c:434
#define vec_reset_length(v)
Reset vector length to zero NULL-pointer tolerant.
static void clib_spinlock_free(clib_spinlock_t *p)
Definition: lock.h:72
static uword clib_bitmap_set_no_check(uword *a, uword i, uword new_value)
Sets the ith bit of a bitmap to new_value.
Definition: bitmap.h:141
static int app_send_io_evt_rx(app_worker_t *app_wrk, session_t *s)
int app_worker_connect_session(app_worker_t *app_wrk, session_endpoint_t *sep, u32 api_context)
void(* session_migrate_callback)(session_t *s, session_handle_t new_sh)
Notify app that session pool migration happened.
enum session_ft_action_ session_ft_action_t
application_t * app_worker_get_app(u32 wrk_index)
int(* builtin_app_rx_callback)(session_t *session)
Direct RX callback for built-in application.
void svm_fifo_clone(svm_fifo_t *df, svm_fifo_t *sf)
Clones fifo.
Definition: svm_fifo.c:1280
u32 first_segment_manager
First segment manager has in the the first segment the application&#39;s event fifo.
Definition: application.h:59
static int app_worker_alloc_session_fifos(segment_manager_t *sm, session_t *s)
void segment_manager_dealloc_fifos(svm_fifo_t *rx_fifo, svm_fifo_t *tx_fifo)
u32 local_index
local listening session index
Definition: application.h:88
static uword clib_bitmap_is_zero(uword *ai)
predicate function; is an entire bitmap empty?
Definition: bitmap.h:57
u8 * format_white_space(u8 *s, va_list *va)
Definition: std-formats.c:129
int app_worker_cleanup_notify(app_worker_t *app_wrk, session_t *s, session_cleanup_ntf_t ntf)
u32 session_index
global listening session index
Definition: application.h:89
description fragment has unexpected format
Definition: map.api:433
void session_cleanup_half_open(transport_proto_t tp, session_handle_t ho_handle)
Definition: session.c:286
#define hash_foreach(key_var, value_var, h, body)
Definition: hash.h:442
#define ALWAYS_ASSERT(truth)
unsigned int u32
Definition: types.h:88
app_worker_t * app_worker_alloc(application_t *app)
#define SESSION_INVALID_HANDLE
Definition: session_types.h:23
int app_worker_transport_closed_notify(app_worker_t *app_wrk, session_t *s)
int app_worker_connect_notify(app_worker_t *app_wrk, session_t *s, session_error_t err, u32 opaque)
static void clib_spinlock_init(clib_spinlock_t *p)
Definition: lock.h:65
int app_worker_del_segment_notify(app_worker_t *app_wrk, u64 segment_handle)
#define hash_get(h, key)
Definition: hash.h:249
static session_type_t session_type_from_proto_and_ip(transport_proto_t proto, u8 is_ip4)
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:546
void app_worker_free(app_worker_t *app_wrk)
u8 * format_app_worker_listener(u8 *s, va_list *args)
void segment_manager_app_detach(segment_manager_t *sm)
int app_worker_stop_listen(app_worker_t *app_wrk, app_listener_t *al)
const u8 * application_name_from_index(u32 app_index)
Returns app name for app-index.
Definition: application.c:360
#define hash_free(h)
Definition: hash.h:310
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:301
void segment_manager_init_free(segment_manager_t *sm)
Initiate segment manager cleanup.
u8 segment_manager_has_fifos(segment_manager_t *sm)
#define PREDICT_FALSE(x)
Definition: clib.h:121
#define vec_del1(v, i)
Delete the element at index I.
Definition: vec.h:875
int(* add_segment_callback)(u32 app_wrk_index, u64 segment_handle)
Notify server of new segment.
u32 wrk_index
Worker index in global worker pool.
Definition: application.h:37
segment_manager_t * app_worker_get_or_alloc_connect_segment_manager(app_worker_t *app_wrk)
#define SESSION_INVALID_INDEX
Definition: session_types.h:22
int() app_send_evt_handler_fn(app_worker_t *app, session_t *s)
static void app_worker_stop_listen_session(app_worker_t *app_wrk, session_t *ls)
static u64 listen_session_get_handle(session_t *s)
Definition: session.h:575
int(* del_segment_callback)(u32 app_wrk_index, u64 segment_handle)
Notify server of new segment.
u8 len
Definition: ip_types.api:103
int app_worker_accept_notify(app_worker_t *app_wrk, session_t *s)
#define SEGMENT_MANAGER_INVALID_APP_INDEX
static u8 svm_fifo_set_event(svm_fifo_t *f)
Set fifo event flag.
Definition: svm_fifo.h:727
session_t * app_worker_proxy_listener(app_worker_t *app_wrk, u8 fib_proto, u8 transport_proto)
int(* session_connected_callback)(u32 app_wrk_index, u32 opaque, session_t *s, session_error_t code)
Connection request callback.
session_handle_t listener_handle
Parent listener session index if the result of an accept.
int app_worker_migrate_notify(app_worker_t *app_wrk, session_t *s, session_handle_t new_sh)
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:219
static void svm_msg_q_unlock(svm_msg_q_t *mq)
Unlock message queue.
segment_manager_t * segment_manager_alloc(void)
void(* session_cleanup_callback)(session_t *s, session_cleanup_ntf_t ntf)
Notify app that session or transport are about to be removed.
int app_worker_del_half_open(app_worker_t *app_wrk, transport_proto_t tp, session_handle_t ho_handle)
sll srl srl sll sra u16x4 i
Definition: vector_sse42.h:317
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:380
#define clib_warning(format, args...)
Definition: error.h:59
u8 segment_manager_app_detached(segment_manager_t *sm)
clib_bitmap_t * workers
workers accepting connections
Definition: application.h:84
clib_spinlock_t detached_seg_managers_lock
Protects detached seg managers.
Definition: application.h:71
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:298
static uword clib_bitmap_get(uword *ai, uword i)
Gets the ith bit value from a bitmap.
Definition: bitmap.h:197
int app_worker_close_notify(app_worker_t *app_wrk, session_t *s)
static u8 transport_connection_is_cless(transport_connection_t *tc)
Definition: transport.h:215
int(* builtin_app_tx_callback)(session_t *session)
Direct TX callback for built-in application.
int app_worker_own_session(app_worker_t *app_wrk, session_t *s)
int segment_manager_alloc_session_fifos(segment_manager_t *sm, u32 thread_index, svm_fifo_t **rx_fifo, svm_fifo_t **tx_fifo)
application_t * application_get(u32 app_index)
Definition: application.c:426
int segment_manager_init(segment_manager_t *sm)
int app_worker_add_half_open(app_worker_t *app_wrk, transport_proto_t tp, session_handle_t ho_handle, session_handle_t wrk_handle)
app_worker_t * app_worker_get_if_valid(u32 wrk_index)
#define ASSERT(truth)
void svm_msg_q_add_and_unlock(svm_msg_q_t *mq, svm_msg_q_msg_t *msg)
Producer enqueue one message to queue with mutex held.
app_worker_t * application_listener_select_worker(session_t *ls)
Definition: application.c:674
uword ** half_open_table
Per transport proto hash tables of half-open connection handles.
Definition: application.h:68
session_cb_vft_t cb_fns
Callbacks: shoulder-taps for the server/client.
Definition: application.h:104
enum _transport_proto transport_proto_t
static app_send_evt_handler_fn *const app_send_evt_handler_fns[2]
u8 thread_index
Index of the thread that allocated the session.
app_worker_t * app_worker_get(u32 wrk_index)
u32 app_index
App index in app pool.
Definition: application.h:98
u64 session_handle_t
void app_worker_format_connects(app_worker_t *app_wrk, int verbose)
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
void(* session_disconnect_callback)(session_t *s)
Notify app that session is closing.
volatile u8 session_state
State in session layer state machine.
segment_manager_t * app_worker_get_listen_segment_manager(app_worker_t *app, session_t *listener)
int app_worker_add_segment_notify(app_worker_t *app_wrk, u64 segment_handle)
Send an API message to the external app, to map new segment.
u8 * name
Name registered by builtin apps.
Definition: application.h:113
u64 uword
Definition: types.h:112
struct _segment_manager segment_manager_t
int app_worker_start_listen(app_worker_t *app_wrk, app_listener_t *app_listener)
segment_manager_t * segment_manager_get(u32 index)
void app_listener_cleanup(app_listener_t *al)
Definition: application.c:238
session_cleanup_ntf_t
void(* session_transport_closed_callback)(session_t *s)
Notify app that transport is closed.
u32 app_index
Index of owning app.
Definition: application.h:43
u8 * format_app_worker(u8 *s, va_list *args)
int app_worker_session_fifo_tuning(app_worker_t *app_wrk, session_t *s, svm_fifo_t *f, session_ft_action_t act, u32 len)
int app_worker_lock_and_send_event(app_worker_t *app, session_t *s, u8 evt_type)
Send event to application.
int(* fifo_tuning_callback)(session_t *s, svm_fifo_t *f, session_ft_action_t act, u32 bytes)
Delegate fifo-tuning-logic to application.
enum session_error_ session_error_t
u32 app_wrk_index
Index of the app worker that owns the session.
static int svm_fifo_has_event(svm_fifo_t *f)
Check if fifo has io event.
Definition: svm_fifo.h:713
int(* session_accept_callback)(session_t *new_session)
Notify server of newly accepted session.
int app_worker_init_listener(app_worker_t *app_wrk, session_t *ls)
static app_worker_t * app_workers
Pool of workers associated to apps.
int application_is_builtin_proxy(application_t *app)
Definition: application.c:1153
u32 api_client_index
API index for the worker.
Definition: application.h:63
struct _session_endpoint session_endpoint_t
static int svm_msg_q_lock(svm_msg_q_t *mq)
Lock, or block trying, the message queue.
svm_msg_q_t * event_queue
Application listens for events on this svm queue.
Definition: application.h:46
struct _svm_fifo svm_fifo_t
#define APP_INVALID_SEGMENT_MANAGER_INDEX
Definition: application.h:180
static u8 svm_msg_q_is_full(svm_msg_q_t *mq)
Check if message queue is full.
#define APP_DBG(_fmt, _args...)
Definition: application.h:29
segment_manager_t * app_worker_get_connect_segment_manager(app_worker_t *app)
svm_msg_q_msg_t svm_msg_q_alloc_msg_w_ring(svm_msg_q_t *mq, u32 ring_index)
Allocate message buffer on ring.
int app_worker_alloc_connects_segment_manager(app_worker_t *app_wrk)
static session_t * listen_session_get(u32 ls_index)
Definition: session.h:606
u8 first_segment_manager_in_use
Definition: application.h:60
segment_manager_t * segment_manager_get_if_valid(u32 index)