FD.io VPP  v19.01.2-3-gf61a1a8
Vector Packet Processing
session.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 /**
16  * @file
17  * @brief Session and session manager
18  */
19 
20 #include <vnet/session/session.h>
23 #include <vlibmemory/api.h>
24 #include <vnet/dpo/load_balance.h>
25 #include <vnet/fib/ip4_fib.h>
26 
29 
30 static inline int
31 session_send_evt_to_thread (void *data, void *args, u32 thread_index,
32  session_evt_type_t evt_type)
33 {
34  session_event_t *evt;
35  svm_msg_q_msg_t msg;
36  svm_msg_q_t *mq;
37  u32 tries = 0, max_tries;
38 
39  mq = session_manager_get_vpp_event_queue (thread_index);
40  while (svm_msg_q_try_lock (mq))
41  {
42  max_tries = vlib_get_current_process (vlib_get_main ())? 1e6 : 3;
43  if (tries++ == max_tries)
44  {
45  SESSION_DBG ("failed to enqueue evt");
46  return -1;
47  }
48  }
50  {
51  svm_msg_q_unlock (mq);
52  return -2;
53  }
56  {
57  svm_msg_q_unlock (mq);
58  return -2;
59  }
60  evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
61  evt->event_type = evt_type;
62  switch (evt_type)
63  {
64  case FIFO_EVENT_RPC:
65  evt->rpc_args.fp = data;
66  evt->rpc_args.arg = args;
67  break;
68  case FIFO_EVENT_APP_TX:
71  evt->fifo = data;
72  break;
75  evt->session_handle = session_handle ((stream_session_t *) data);
76  break;
77  default:
78  clib_warning ("evt unhandled!");
79  svm_msg_q_unlock (mq);
80  return -1;
81  }
82 
83  svm_msg_q_add_and_unlock (mq, &msg);
84  return 0;
85 }
86 
87 int
89 {
90  return session_send_evt_to_thread (f, 0, f->master_thread_index, evt_type);
91 }
92 
93 int
94 session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
95  session_evt_type_t evt_type)
96 {
97  return session_send_evt_to_thread (data, 0, thread_index, evt_type);
98 }
99 
100 int
102  session_evt_type_t evt_type)
103 {
104  /* only event supported for now is disconnect */
105  ASSERT (evt_type == FIFO_EVENT_DISCONNECT);
106  return session_send_evt_to_thread (s, 0, s->thread_index,
108 }
109 
110 void
111 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
112 {
113  if (thread_index != vlib_get_thread_index ())
114  session_send_evt_to_thread (fp, rpc_args, thread_index, FIFO_EVENT_RPC);
115  else
116  {
117  void (*fnp) (void *) = fp;
118  fnp (rpc_args);
119  }
120 }
121 
122 static void
124 {
125  u32 thread_index = vlib_get_thread_index ();
127  session_event_t *evt;
128 
129  /* If we are in the handler thread, or being called with the worker barrier
130  * held, just append a new event to pending disconnects vector. */
131  if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
132  {
133  wrk = session_manager_get_worker (s->thread_index);
134  vec_add2 (wrk->pending_disconnects, evt, 1);
135  clib_memset (evt, 0, sizeof (*evt));
136  evt->session_handle = session_handle (s);
137  evt->event_type = FIFO_EVENT_DISCONNECT;
138  }
139  else
141 }
142 
144 session_alloc (u32 thread_index)
145 {
146  session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
147  stream_session_t *s;
148  u8 will_expand = 0;
149  pool_get_aligned_will_expand (wrk->sessions, will_expand,
151  /* If we have peekers, let them finish */
152  if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
153  {
157  }
158  else
159  {
161  }
162  clib_memset (s, 0, sizeof (*s));
163  s->session_index = s - wrk->sessions;
164  s->thread_index = thread_index;
165  return s;
166 }
167 
168 void
170 {
171  pool_put (session_manager_main.wrk[s->thread_index].sessions, s);
172  if (CLIB_DEBUG)
173  clib_memset (s, 0xFA, sizeof (*s));
174 }
175 
176 void
178 {
179  segment_manager_dealloc_fifos (s->svm_segment_index, s->server_rx_fifo,
180  s->server_tx_fifo);
181  session_free (s);
182 }
183 
184 /**
185  * Cleans up session and lookup table.
186  *
187  * Transport connection must still be valid.
188  */
189 static void
191 {
192  int rv;
193 
194  /* Delete from the main lookup table. */
195  if ((rv = session_lookup_del_session (s)))
196  clib_warning ("hash delete error, rv %d", rv);
197 
199 }
200 
201 int
203 {
204  svm_fifo_t *server_rx_fifo = 0, *server_tx_fifo = 0;
205  u32 fifo_segment_index;
206  int rv;
207 
208  if ((rv = segment_manager_alloc_session_fifos (sm, &server_rx_fifo,
209  &server_tx_fifo,
210  &fifo_segment_index)))
211  return rv;
212  /* Initialize backpointers */
213  server_rx_fifo->master_session_index = s->session_index;
214  server_rx_fifo->master_thread_index = s->thread_index;
215 
216  server_tx_fifo->master_session_index = s->session_index;
217  server_tx_fifo->master_thread_index = s->thread_index;
218 
219  s->server_rx_fifo = server_rx_fifo;
220  s->server_tx_fifo = server_tx_fifo;
221  s->svm_segment_index = fifo_segment_index;
222  return 0;
223 }
224 
225 static stream_session_t *
227 {
228  stream_session_t *s;
229  u32 thread_index = tc->thread_index;
230 
231  ASSERT (thread_index == vlib_get_thread_index ()
232  || transport_protocol_is_cl (tc->proto));
233 
234  s = session_alloc (thread_index);
235  s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
236  s->enqueue_epoch = (u64) ~ 0;
237  s->session_state = SESSION_STATE_CLOSED;
238 
239  /* Attach transport to session and vice versa */
240  s->connection_index = tc->c_index;
241  tc->s_index = s->session_index;
242  return s;
243 }
244 
245 static int
247  u8 alloc_fifos, stream_session_t ** ret_s)
248 {
249  stream_session_t *s;
250  int rv;
251 
253  if (alloc_fifos && (rv = session_alloc_fifos (sm, s)))
254  {
255  session_free (s);
256  *ret_s = 0;
257  return rv;
258  }
259 
260  /* Add to the main lookup table */
262 
263  *ret_s = s;
264  return 0;
265 }
266 
267 /**
268  * Discards bytes from buffer chain
269  *
270  * It discards n_bytes_to_drop starting at first buffer after chain_b
271  */
272 always_inline void
274  vlib_buffer_t ** chain_b,
275  u32 n_bytes_to_drop)
276 {
277  vlib_buffer_t *next = *chain_b;
278  u32 to_drop = n_bytes_to_drop;
279  ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
280  while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
281  {
282  next = vlib_get_buffer (vm, next->next_buffer);
283  if (next->current_length > to_drop)
284  {
285  vlib_buffer_advance (next, to_drop);
286  to_drop = 0;
287  }
288  else
289  {
290  to_drop -= next->current_length;
291  next->current_length = 0;
292  }
293  }
294  *chain_b = next;
295 
296  if (to_drop == 0)
297  b->total_length_not_including_first_buffer -= n_bytes_to_drop;
298 }
299 
300 /**
301  * Enqueue buffer chain tail
302  */
303 always_inline int
305  u32 offset, u8 is_in_order)
306 {
307  vlib_buffer_t *chain_b;
308  u32 chain_bi, len, diff;
310  u8 *data;
311  u32 written = 0;
312  int rv = 0;
313 
314  if (is_in_order && offset)
315  {
316  diff = offset - b->current_length;
318  return 0;
319  chain_b = b;
320  session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
321  chain_bi = vlib_get_buffer_index (vm, chain_b);
322  }
323  else
324  chain_bi = b->next_buffer;
325 
326  do
327  {
328  chain_b = vlib_get_buffer (vm, chain_bi);
329  data = vlib_buffer_get_current (chain_b);
330  len = chain_b->current_length;
331  if (!len)
332  continue;
333  if (is_in_order)
334  {
335  rv = svm_fifo_enqueue_nowait (s->server_rx_fifo, len, data);
336  if (rv == len)
337  {
338  written += rv;
339  }
340  else if (rv < len)
341  {
342  return (rv > 0) ? (written + rv) : written;
343  }
344  else if (rv > len)
345  {
346  written += rv;
347 
348  /* written more than what was left in chain */
350  return written;
351 
352  /* drop the bytes that have already been delivered */
353  session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
354  }
355  }
356  else
357  {
358  rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset, len,
359  data);
360  if (rv)
361  {
362  clib_warning ("failed to enqueue multi-buffer seg");
363  return -1;
364  }
365  offset += len;
366  }
367  }
368  while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
369  ? chain_b->next_buffer : 0));
370 
371  if (is_in_order)
372  return written;
373 
374  return 0;
375 }
376 
377 /*
378  * Enqueue data for delivery to session peer. Does not notify peer of enqueue
379  * event but on request can queue notification events for later delivery by
380  * calling stream_server_flush_enqueue_events().
381  *
382  * @param tc Transport connection which is to be enqueued data
383  * @param b Buffer to be enqueued
384  * @param offset Offset at which to start enqueueing if out-of-order
385  * @param queue_event Flag to indicate if peer is to be notified or if event
386  * is to be queued. The former is useful when more data is
387  * enqueued and only one event is to be generated.
388  * @param is_in_order Flag to indicate if data is in order
389  * @return Number of bytes enqueued or a negative value if enqueueing failed.
390  */
391 int
393  vlib_buffer_t * b, u32 offset,
394  u8 queue_event, u8 is_in_order)
395 {
396  stream_session_t *s;
397  int enqueued = 0, rv, in_order_off;
398 
399  s = session_get (tc->s_index, tc->thread_index);
400 
401  if (is_in_order)
402  {
403  enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo,
404  b->current_length,
406  if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
407  && enqueued >= 0))
408  {
409  in_order_off = enqueued > b->current_length ? enqueued : 0;
410  rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
411  if (rv > 0)
412  enqueued += rv;
413  }
414  }
415  else
416  {
417  rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset,
418  b->current_length,
420  if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
421  session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
422  /* if something was enqueued, report even this as success for ooo
423  * segment handling */
424  return rv;
425  }
426 
427  if (queue_event)
428  {
429  /* Queue RX event on this fifo. Eventually these will need to be flushed
430  * by calling stream_server_flush_enqueue_events () */
432 
433  wrk = session_manager_get_worker (s->thread_index);
434  if (s->enqueue_epoch != wrk->current_enqueue_epoch[tc->proto])
435  {
436  s->enqueue_epoch = wrk->current_enqueue_epoch[tc->proto];
437  vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
438  }
439  }
440 
441  return enqueued;
442 }
443 
444 int
446  session_dgram_hdr_t * hdr,
447  vlib_buffer_t * b, u8 proto, u8 queue_event)
448 {
449  int enqueued = 0, rv, in_order_off;
450 
451  ASSERT (svm_fifo_max_enqueue (s->server_rx_fifo)
452  >= b->current_length + sizeof (*hdr));
453 
454  svm_fifo_enqueue_nowait (s->server_rx_fifo, sizeof (session_dgram_hdr_t),
455  (u8 *) hdr);
456  enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo, b->current_length,
458  if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
459  {
460  in_order_off = enqueued > b->current_length ? enqueued : 0;
461  rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
462  if (rv > 0)
463  enqueued += rv;
464  }
465  if (queue_event)
466  {
467  /* Queue RX event on this fifo. Eventually these will need to be flushed
468  * by calling stream_server_flush_enqueue_events () */
470 
471  wrk = session_manager_get_worker (s->thread_index);
472  if (s->enqueue_epoch != wrk->current_enqueue_epoch[proto])
473  {
474  s->enqueue_epoch = wrk->current_enqueue_epoch[proto];
475  vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
476  }
477  }
478  return enqueued;
479 }
480 
481 /** Check if we have space in rx fifo to push more bytes */
482 u8
484  u16 data_len)
485 {
486  stream_session_t *s = session_get (tc->s_index, thread_index);
487 
488  if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
489  return 1;
490 
491  if (data_len > svm_fifo_max_enqueue (s->server_rx_fifo))
492  return 1;
493 
494  return 0;
495 }
496 
497 u32
499 {
500  stream_session_t *s = session_get (tc->s_index, tc->thread_index);
501  if (!s->server_tx_fifo)
502  return 0;
503  return svm_fifo_max_dequeue (s->server_tx_fifo);
504 }
505 
506 int
508  u32 offset, u32 max_bytes)
509 {
510  stream_session_t *s = session_get (tc->s_index, tc->thread_index);
511  return svm_fifo_peek (s->server_tx_fifo, offset, max_bytes, buffer);
512 }
513 
514 u32
516 {
517  stream_session_t *s = session_get (tc->s_index, tc->thread_index);
518  return svm_fifo_dequeue_drop (s->server_tx_fifo, max_bytes);
519 }
520 
521 /**
522  * Notify session peer that new data has been enqueued.
523  *
524  * @param s Stream session for which the event is to be generated.
525  * @param lock Flag to indicate if call should lock message queue.
526  *
527  * @return 0 on success or negative number if failed to send notification.
528  */
529 static inline int
531 {
532  app_worker_t *app;
533 
534  app = app_worker_get_if_valid (s->app_wrk_index);
535  if (PREDICT_FALSE (!app))
536  {
537  SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
538  return 0;
539  }
540 
541  /* *INDENT-OFF* */
542  SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
543  ed->data[0] = FIFO_EVENT_APP_RX;
544  ed->data[1] = svm_fifo_max_dequeue (s->server_rx_fifo);
545  }));
546  /* *INDENT-ON* */
547 
549 }
550 
551 int
553 {
554  app_worker_t *app;
555 
556  app = app_worker_get_if_valid (s->app_wrk_index);
557  if (PREDICT_FALSE (!app))
558  return -1;
559 
561  return -1;
562 
563  svm_fifo_clear_tx_ntf (s->server_tx_fifo);
564  return 0;
565 }
566 
567 /**
568  * Flushes queue of sessions that are to be notified of new data
569  * enqueued events.
570  *
571  * @param thread_index Thread index for which the flush is to be performed.
572  * @return 0 on success or a positive number indicating the number of
573  * failures due to API queue being full.
574  */
575 int
576 session_manager_flush_enqueue_events (u8 transport_proto, u32 thread_index)
577 {
579  stream_session_t *s;
580  int i, errors = 0;
581  u32 *indices;
582 
583  indices = wrk->session_to_enqueue[transport_proto];
584 
585  for (i = 0; i < vec_len (indices); i++)
586  {
587  s = session_get_if_valid (indices[i], thread_index);
588  if (PREDICT_FALSE (!s))
589  {
590  errors++;
591  continue;
592  }
594  errors++;
595  }
596 
597  vec_reset_length (indices);
598  wrk->session_to_enqueue[transport_proto] = indices;
599  wrk->current_enqueue_epoch[transport_proto]++;
600 
601  return errors;
602 }
603 
604 int
606 {
608  int i, errors = 0;
609  for (i = 0; i < 1 + vtm->n_threads; i++)
610  errors += session_manager_flush_enqueue_events (transport_proto, i);
611  return errors;
612 }
613 
614 /**
615  * Init fifo tail and head pointers
616  *
617  * Useful if transport uses absolute offsets for tracking ooo segments.
618  */
619 void
621  u32 rx_pointer, u32 tx_pointer)
622 {
623  stream_session_t *s;
624  s = session_get (tc->s_index, tc->thread_index);
625  svm_fifo_init_pointers (s->server_rx_fifo, rx_pointer);
626  svm_fifo_init_pointers (s->server_tx_fifo, tx_pointer);
627 }
628 
629 int
631 {
632  u32 opaque = 0, new_ti, new_si;
633  stream_session_t *new_s = 0;
634  segment_manager_t *sm;
635  app_worker_t *app_wrk;
636  application_t *app;
637  u8 alloc_fifos;
638  int error = 0;
639  u64 handle;
640 
641  /*
642  * Find connection handle and cleanup half-open table
643  */
644  handle = session_lookup_half_open_handle (tc);
645  if (handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
646  {
647  SESSION_DBG ("half-open was removed!");
648  return -1;
649  }
651 
652  /* Get the app's index from the handle we stored when opening connection
653  * and the opaque (api_context for external apps) from transport session
654  * index */
655  app_wrk = app_worker_get_if_valid (handle >> 32);
656  if (!app_wrk)
657  return -1;
658  opaque = tc->s_index;
659  app = application_get (app_wrk->app_index);
660 
661  /*
662  * Allocate new session with fifos (svm segments are allocated if needed)
663  */
664  if (!is_fail)
665  {
667  alloc_fifos = !application_is_builtin_proxy (app);
668  if (session_alloc_and_init (sm, tc, alloc_fifos, &new_s))
669  {
670  is_fail = 1;
671  error = -1;
672  }
673  else
674  {
675  new_s->session_state = SESSION_STATE_CONNECTING;
676  new_s->app_wrk_index = app_wrk->wrk_index;
677  new_si = new_s->session_index;
678  new_ti = new_s->thread_index;
679  }
680  }
681 
682  /*
683  * Notify client application
684  */
685  if (app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque,
686  new_s, is_fail))
687  {
688  SESSION_DBG ("failed to notify app");
689  if (!is_fail)
690  {
691  new_s = session_get (new_si, new_ti);
692  session_transport_close (new_s);
693  }
694  }
695  else
696  {
697  if (!is_fail)
698  {
699  new_s = session_get (new_si, new_ti);
700  new_s->session_state = SESSION_STATE_READY;
701  }
702  }
703 
704  return error;
705 }
706 
707 typedef struct _session_switch_pool_args
708 {
709  u32 session_index;
710  u32 thread_index;
711  u32 new_thread_index;
712  u32 new_session_index;
714 
715 static void
716 session_switch_pool (void *cb_args)
717 {
720  stream_session_t *s;
721  ASSERT (args->thread_index == vlib_get_thread_index ());
722  s = session_get (args->session_index, args->thread_index);
723  s->server_tx_fifo->master_session_index = args->new_session_index;
724  s->server_tx_fifo->master_thread_index = args->new_thread_index;
726  tp_vfts[tp].cleanup (s->connection_index, s->thread_index);
727  session_free (s);
728  clib_mem_free (cb_args);
729 }
730 
731 /**
732  * Move dgram session to the right thread
733  */
734 int
736  u32 old_thread_index,
737  stream_session_t ** new_session)
738 {
739  stream_session_t *new_s;
740  session_switch_pool_args_t *rpc_args;
741 
742  /*
743  * Clone half-open session to the right thread.
744  */
745  new_s = session_clone_safe (tc->s_index, old_thread_index);
746  new_s->connection_index = tc->c_index;
747  new_s->server_rx_fifo->master_session_index = new_s->session_index;
748  new_s->server_rx_fifo->master_thread_index = new_s->thread_index;
749  new_s->session_state = SESSION_STATE_READY;
751 
752  /*
753  * Ask thread owning the old session to clean it up and make us the tx
754  * fifo owner
755  */
756  rpc_args = clib_mem_alloc (sizeof (*rpc_args));
757  rpc_args->new_session_index = new_s->session_index;
758  rpc_args->new_thread_index = new_s->thread_index;
759  rpc_args->session_index = tc->s_index;
760  rpc_args->thread_index = old_thread_index;
761  session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
762  rpc_args);
763 
764  tc->s_index = new_s->session_index;
765  new_s->connection_index = tc->c_index;
766  *new_session = new_s;
767  return 0;
768 }
769 
770 int
772 {
773  app_worker_t *app_wrk;
774  application_t *app;
775  stream_session_t *s;
776 
777  s = session_get (tc->s_index, tc->thread_index);
778  app_wrk = app_worker_get_if_valid (s->app_wrk_index);
779  if (!app_wrk)
780  return -1;
781  s->session_state = SESSION_STATE_ACCEPTING;
782  app = application_get (app_wrk->app_index);
783  return app->cb_fns.session_accept_callback (s);
784 }
785 
786 /**
787  * Notification from transport that connection is being closed.
788  *
789  * A disconnect is sent to application but state is not removed. Once
790  * disconnect is acknowledged by application, session disconnect is called.
791  * Ultimately this leads to close being called on transport (passive close).
792  */
793 void
795 {
796  app_worker_t *app_wrk;
797  application_t *app;
798  stream_session_t *s;
799 
800  s = session_get (tc->s_index, tc->thread_index);
801  if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
802  return;
803  s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
804  app_wrk = app_worker_get_if_valid (s->app_wrk_index);
805  if (!app_wrk)
806  return;
807  app = application_get (app_wrk->app_index);
808  app->cb_fns.session_disconnect_callback (s);
809 }
810 
811 /**
812  * Notification from transport that connection is being deleted
813  *
814  * This removes the session if it is still valid. It should be called only on
815  * previously fully established sessions. For instance failed connects should
816  * call stream_session_connect_notify and indicate that the connect has
817  * failed.
818  */
819 void
821 {
822  stream_session_t *s;
823 
824  /* App might've been removed already */
825  if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
826  return;
827 
828  /* Make sure we don't try to send anything more */
829  svm_fifo_dequeue_drop_all (s->server_tx_fifo);
830 
831  switch (s->session_state)
832  {
835  /* If transport finishes or times out before we get a reply
836  * from the app, mark transport as closed and wait for reply
837  * before removing the session. Cleanup session table in advance
838  * because transport will soon be closed and closed sessions
839  * are assumed to have been removed from the lookup table */
841  s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
842  break;
845  /* Cleanup lookup table as transport needs to still be valid.
846  * Program transport close to ensure that all session events
847  * have been cleaned up. Once transport close is called, the
848  * session is just removed because both transport and app have
849  * confirmed the close*/
851  s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
853  break;
855  break;
857  session_delete (s);
858  break;
859  default:
860  clib_warning ("session state %u", s->session_state);
861  session_delete (s);
862  break;
863  }
864 }
865 
866 /**
867  * Notification from transport that session can be closed
868  *
869  * Should be called by transport only if it was closed with non-empty
870  * tx fifo and once it decides to begin the closing procedure prior to
871  * issuing a delete notify. This gives the chance to the session layer
872  * to cleanup any outstanding events.
873  */
874 void
876 {
877  stream_session_t *s;
878 
879  if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
880  return;
881 
882  /* Transport thinks that app requested close but it actually didn't.
883  * Can happen for tcp if fin and rst are received in close succession. */
884  if (s->session_state == SESSION_STATE_READY)
885  {
887  svm_fifo_dequeue_drop_all (s->server_tx_fifo);
888  }
889  /* If app close has not been received or has not yet resulted in
890  * a transport close, only mark the session transport as closed */
891  else if (s->session_state <= SESSION_STATE_CLOSING)
892  {
894  s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
895  }
896  else
897  s->session_state = SESSION_STATE_CLOSED;
898 }
899 
900 /**
901  * Notify application that connection has been reset.
902  */
903 void
905 {
906  stream_session_t *s;
907  app_worker_t *app_wrk;
908  application_t *app;
909  s = session_get (tc->s_index, tc->thread_index);
910  svm_fifo_dequeue_drop_all (s->server_tx_fifo);
911  if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
912  return;
913  s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
914  app_wrk = app_worker_get (s->app_wrk_index);
915  app = application_get (app_wrk->app_index);
916  app->cb_fns.session_reset_callback (s);
917 }
918 
919 /**
920  * Accept a stream session. Optionally ping the server by callback.
921  */
922 int
924  u8 notify)
925 {
927  app_worker_t *app_wrk;
928  segment_manager_t *sm;
929  int rv;
930 
931  /* Find the server */
932  listener = listen_session_get (listener_index);
933  app_wrk = application_listener_select_worker (listener, 0);
934 
935  sm = app_worker_get_listen_segment_manager (app_wrk, listener);
936  if ((rv = session_alloc_and_init (sm, tc, 1, &s)))
937  return rv;
938 
939  s->app_wrk_index = app_wrk->wrk_index;
940  s->listener_index = listener_index;
941 
942  /* Shoulder-tap the server */
943  if (notify)
944  {
945  application_t *app = application_get (app_wrk->app_index);
946  return app->cb_fns.session_accept_callback (s);
947  }
948 
949  return 0;
950 }
951 
952 int
953 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
954 {
957  segment_manager_t *sm;
958  app_worker_t *app_wrk;
959  stream_session_t *s;
960  application_t *app;
961  int rv;
962 
964  rv = tp_vfts[rmt->transport_proto].open (tep);
965  if (rv < 0)
966  {
967  SESSION_DBG ("Transport failed to open connection.");
968  return VNET_API_ERROR_SESSION_CONNECT;
969  }
970 
971  tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
972 
973  /* For dgram type of service, allocate session and fifos now.
974  */
975  app_wrk = app_worker_get (app_wrk_index);
977 
978  if (session_alloc_and_init (sm, tc, 1, &s))
979  return -1;
980  s->app_wrk_index = app_wrk->wrk_index;
981  s->session_state = SESSION_STATE_OPENED;
982 
983  /* Tell the app about the new event fifo for this session */
984  app = application_get (app_wrk->app_index);
985  app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque, s, 0);
986 
987  return 0;
988 }
989 
990 int
991 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
992 {
995  u64 handle;
996  int rv;
997 
999  rv = tp_vfts[rmt->transport_proto].open (tep);
1000  if (rv < 0)
1001  {
1002  SESSION_DBG ("Transport failed to open connection.");
1003  return VNET_API_ERROR_SESSION_CONNECT;
1004  }
1005 
1006  tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
1007 
1008  /* If transport offers a stream service, only allocate session once the
1009  * connection has been established.
1010  * Add connection to half-open table and save app and tc index. The
1011  * latter is needed to help establish the connection while the former
1012  * is needed when the connect notify comes and we have to notify the
1013  * external app
1014  */
1015  handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
1016  session_lookup_add_half_open (tc, handle);
1017 
1018  /* Store api_context (opaque) for when the reply comes. Not the nicest
1019  * thing but better than allocating a separate half-open pool.
1020  */
1021  tc->s_index = opaque;
1022  return 0;
1023 }
1024 
1025 int
1026 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1027 {
1030 
1031  sep->app_wrk_index = app_wrk_index;
1032  sep->opaque = opaque;
1033 
1034  return tp_vfts[rmt->transport_proto].open (tep_cfg);
1035 }
1036 
1038 
1039 /* *INDENT-OFF* */
1044 };
1045 /* *INDENT-ON* */
1046 
1047 /**
1048  * Ask transport to open connection to remote transport endpoint.
1049  *
1050  * Stores handle for matching request with reply since the call can be
1051  * asynchronous. For instance, for TCP the 3-way handshake must complete
1052  * before reply comes. Session is only created once connection is established.
1053  *
1054  * @param app_index Index of the application requesting the connect
1055  * @param st Session type requested.
1056  * @param tep Remote transport endpoint
1057  * @param opaque Opaque data (typically, api_context) the application expects
1058  * on open completion.
1059  */
1060 int
1061 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1062 {
1063  transport_service_type_t tst = tp_vfts[rmt->transport_proto].service_type;
1064  return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1065 }
1066 
1067 /**
1068  * Ask transport to listen on session endpoint.
1069  *
1070  * @param s Session for which listen will be called. Note that unlike
1071  * established sessions, listen sessions are not associated to a
1072  * thread.
1073  * @param sep Local endpoint to be listened on.
1074  */
1075 int
1077 {
1079  transport_endpoint_t *tep;
1080  u32 tc_index, s_index;
1081 
1082  /* Transport bind/listen */
1083  tep = session_endpoint_to_transport (sep);
1084  s_index = ls->session_index;
1085  tc_index = tp_vfts[sep->transport_proto].bind (s_index, tep);
1086 
1087  if (tc_index == (u32) ~ 0)
1088  return -1;
1089 
1090  /* Attach transport to session */
1091  ls = listen_session_get (s_index);
1092  ls->connection_index = tc_index;
1093 
1094  /* Add to the main lookup table after transport was initialized */
1095  tc = tp_vfts[sep->transport_proto].get_listener (tc_index);
1096  session_lookup_add_connection (tc, s_index);
1097  return 0;
1098 }
1099 
1100 /**
1101  * Ask transport to stop listening on local transport endpoint.
1102  *
1103  * @param s Session to stop listening on. It must be in state LISTENING.
1104  */
1105 int
1107 {
1110  if (s->session_state != SESSION_STATE_LISTENING)
1111  {
1112  clib_warning ("not a listening session");
1113  return -1;
1114  }
1115 
1116  tc = tp_vfts[tp].get_listener (s->connection_index);
1117  if (!tc)
1118  {
1119  clib_warning ("no transport");
1120  return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1121  }
1122 
1124  tp_vfts[tp].unbind (s->connection_index);
1125  return 0;
1126 }
1127 
1128 /**
1129  * Initialize session closing procedure.
1130  *
1131  * Request is always sent to session node to ensure that all outstanding
1132  * requests are served before transport is notified.
1133  */
1134 void
1136 {
1137  if (!s)
1138  return;
1139 
1140  if (s->session_state >= SESSION_STATE_CLOSING)
1141  {
1142  /* Session will only be removed once both app and transport
1143  * acknowledge the close */
1144  if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1146 
1147  /* Session already closed. Clear the tx fifo */
1148  if (s->session_state == SESSION_STATE_CLOSED)
1149  svm_fifo_dequeue_drop_all (s->server_tx_fifo);
1150  return;
1151  }
1152 
1153  s->session_state = SESSION_STATE_CLOSING;
1155 }
1156 
1157 /**
1158  * Notify transport the session can be disconnected. This should eventually
1159  * result in a delete notification that allows us to cleanup session state.
1160  * Called for both active/passive disconnects.
1161  *
1162  * Must be called from the session's thread.
1163  */
1164 void
1166 {
1167  /* If transport is already closed, just free the session */
1168  if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1169  {
1171  return;
1172  }
1173 
1174  /* If tx queue wasn't drained, change state to closed waiting for transport.
1175  * This way, the transport, if it so wishes, can continue to try sending the
1176  * outstanding data (in closed state it cannot). It MUST however at one
1177  * point, either after sending everything or after a timeout, call delete
1178  * notify. This will finally lead to the complete cleanup of the session.
1179  */
1180  if (svm_fifo_max_dequeue (s->server_tx_fifo))
1181  s->session_state = SESSION_STATE_CLOSED_WAITING;
1182  else
1183  s->session_state = SESSION_STATE_CLOSED;
1184 
1185  tp_vfts[session_get_transport_proto (s)].close (s->connection_index,
1186  s->thread_index);
1187 }
1188 
1189 /**
1190  * Cleanup transport and session state.
1191  *
1192  * Notify transport of the cleanup and free the session. This should
1193  * be called only if transport reported some error and is already
1194  * closed.
1195  */
1196 void
1198 {
1199  s->session_state = SESSION_STATE_CLOSED;
1200 
1201  /* Delete from main lookup table before we axe the the transport */
1203  tp_vfts[session_get_transport_proto (s)].cleanup (s->connection_index,
1204  s->thread_index);
1205  /* Since we called cleanup, no delete notification will come. So, make
1206  * sure the session is properly freed. */
1208 }
1209 
1212 {
1213  transport_proto_t tp;
1214  tp = session_get_transport_proto (s);
1215  return transport_protocol_service_type (tp);
1216 }
1217 
1220 {
1221  transport_proto_t tp;
1222  tp = session_get_transport_proto (s);
1223  return transport_protocol_tx_fn_type (tp);
1224 }
1225 
1226 u8
1228 {
1230 }
1231 
1232 /**
1233  * Allocate event queues in the shared-memory segment
1234  *
1235  * That can either be a newly created memfd segment, that will need to be
1236  * mapped by all stack users, or the binary api's svm region. The latter is
1237  * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1238  * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1239  * vpp uses api svm region for event queues.
1240  */
1241 void
1243 {
1244  u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1245  ssvm_private_t *eqs = &smm->evt_qs_segment;
1246  api_main_t *am = &api_main;
1247  u64 eqs_size = 64 << 20;
1248  pid_t vpp_pid = getpid ();
1249  void *oldheap;
1250  int i;
1251 
1253  evt_q_length = smm->configured_event_queue_length;
1254 
1255  if (smm->evt_qs_use_memfd_seg)
1256  {
1257  if (smm->evt_qs_segment_size)
1258  eqs_size = smm->evt_qs_segment_size;
1259 
1260  eqs->ssvm_size = eqs_size;
1261  eqs->i_am_master = 1;
1262  eqs->my_pid = vpp_pid;
1263  eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1264  eqs->requested_va = smm->session_baseva;
1265 
1267  {
1268  clib_warning ("failed to initialize queue segment");
1269  return;
1270  }
1271  }
1272 
1273  if (smm->evt_qs_use_memfd_seg)
1274  oldheap = ssvm_push_heap (eqs->sh);
1275  else
1276  oldheap = svm_push_data_heap (am->vlib_rp);
1277 
1278  for (i = 0; i < vec_len (smm->wrk); i++)
1279  {
1280  svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1282  {evt_q_length, evt_size, 0}
1283  ,
1284  {evt_q_length << 1, 256, 0}
1285  };
1286  cfg->consumer_pid = 0;
1287  cfg->n_rings = 2;
1288  cfg->q_nitems = evt_q_length;
1289  cfg->ring_cfgs = rc;
1290  smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1291  if (smm->evt_qs_use_memfd_seg)
1292  {
1294  clib_warning ("eventfd returned");
1295  }
1296  }
1297 
1298  if (smm->evt_qs_use_memfd_seg)
1299  ssvm_pop_heap (oldheap);
1300  else
1301  svm_pop_heap (oldheap);
1302 }
1303 
1306 {
1308  if (smm->evt_qs_use_memfd_seg)
1309  return &smm->evt_qs_segment;
1310  return 0;
1311 }
1312 
1313 /* *INDENT-OFF* */
1318  session_tx_fifo_dequeue_and_snd
1319 };
1320 /* *INDENT-ON* */
1321 
1322 /**
1323  * Initialize session layer for given transport proto and ip version
1324  *
1325  * Allocates per session type (transport proto + ip version) data structures
1326  * and adds arc from session queue node to session type output node.
1327  */
1328 void
1330  const transport_proto_vft_t * vft, u8 is_ip4,
1331  u32 output_node)
1332 {
1334  session_type_t session_type;
1335  u32 next_index = ~0;
1336 
1337  session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1338 
1339  vec_validate (smm->session_type_to_next, session_type);
1340  vec_validate (smm->session_tx_fns, session_type);
1341 
1342  /* *INDENT-OFF* */
1343  if (output_node != ~0)
1344  {
1345  foreach_vlib_main (({
1346  next_index = vlib_node_add_next (this_vlib_main,
1347  session_queue_node.index,
1348  output_node);
1349  }));
1350  }
1351  /* *INDENT-ON* */
1352 
1353  smm->session_type_to_next[session_type] = next_index;
1354  smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1355 }
1356 
1359 {
1360  transport_proto_t tp;
1361  if (s->session_state != SESSION_STATE_LISTENING)
1362  {
1363  tp = session_get_transport_proto (s);
1364  return tp_vfts[tp].get_connection (s->connection_index,
1365  s->thread_index);
1366  }
1367  return 0;
1368 }
1369 
1372 {
1374  return tp_vfts[tp].get_listener (s->connection_index);
1375 }
1376 
1377 int
1379  session_endpoint_t * sep)
1380 {
1383  tc = tp_vfts[tp].get_listener (listener->connection_index);
1384  if (!tc)
1385  {
1386  clib_warning ("no transport");
1387  return -1;
1388  }
1389 
1390  /* N.B. The ip should not be copied because this is the local endpoint */
1391  sep->port = tc->lcl_port;
1392  sep->transport_proto = tc->proto;
1393  sep->is_ip4 = tc->is_ip4;
1394  return 0;
1395 }
1396 
1397 void
1399 {
1400  ASSERT (vlib_get_thread_index () == 0);
1403 }
1404 
1405 static clib_error_t *
1407 {
1408  segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1411  u32 num_threads, preallocated_sessions_per_worker;
1413  int i, j;
1414 
1415  num_threads = 1 /* main thread */ + vtm->n_threads;
1416 
1417  if (num_threads < 1)
1418  return clib_error_return (0, "n_thread_stacks not set");
1419 
1420  /* Allocate cache line aligned worker contexts */
1421  vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1422 
1423  for (i = 0; i < TRANSPORT_N_PROTO; i++)
1424  {
1425  for (j = 0; j < num_threads; j++)
1426  smm->wrk[j].current_enqueue_epoch[i] = 1;
1427  }
1428 
1429  for (i = 0; i < num_threads; i++)
1430  {
1431  wrk = &smm->wrk[i];
1432  vec_validate (wrk->free_event_vector, 128);
1433  _vec_len (wrk->free_event_vector) = 0;
1434  vec_validate (wrk->pending_event_vector, 128);
1435  _vec_len (wrk->pending_event_vector) = 0;
1436  vec_validate (wrk->pending_disconnects, 128);
1437  _vec_len (wrk->pending_disconnects) = 0;
1439  _vec_len (wrk->postponed_event_vector) = 0;
1440 
1442  wrk->dispatch_period = 500e-6;
1443 
1444  if (num_threads > 1)
1446  }
1447 
1448 #if SESSION_DEBUG
1449  vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1450 #endif
1451 
1452  /* Allocate vpp event queues segment and queue */
1454 
1455  /* Initialize fifo segment main baseva and timeout */
1456  sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1457  sm_args->size = smm->session_va_space_size;
1458  segment_manager_main_init (sm_args);
1459 
1460  /* Preallocate sessions */
1461  if (smm->preallocated_sessions)
1462  {
1463  if (num_threads == 1)
1464  {
1466  }
1467  else
1468  {
1469  int j;
1470  preallocated_sessions_per_worker =
1471  (1.1 * (f64) smm->preallocated_sessions /
1472  (f64) (num_threads - 1));
1473 
1474  for (j = 1; j < num_threads; j++)
1475  {
1476  pool_init_fixed (smm->wrk[j].sessions,
1477  preallocated_sessions_per_worker);
1478  }
1479  }
1480  }
1481 
1484  transport_init ();
1485 
1486  smm->is_enabled = 1;
1487 
1488  /* Enable transports */
1489  transport_enable_disable (vm, 1);
1491  return 0;
1492 }
1493 
1494 void
1496 {
1497  u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1499  u8 have_workers = vtm->n_threads != 0;
1500 
1501  /* *INDENT-OFF* */
1502  foreach_vlib_main (({
1503  if (have_workers && ii == 0)
1504  {
1505  vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1506  state);
1507  if (is_en)
1508  {
1509  vlib_node_t *n = vlib_get_node (this_vlib_main,
1511  vlib_start_process (this_vlib_main, n->runtime_index);
1512  }
1513  else
1514  {
1515  vlib_process_signal_event_mt (this_vlib_main,
1518  }
1519 
1520  continue;
1521  }
1522  vlib_node_set_state (this_vlib_main, session_queue_node.index,
1523  state);
1524  }));
1525  /* *INDENT-ON* */
1526 }
1527 
1528 clib_error_t *
1530 {
1531  clib_error_t *error = 0;
1532  if (is_en)
1533  {
1534  if (session_manager_main.is_enabled)
1535  return 0;
1536 
1538  error = session_manager_main_enable (vm);
1539  }
1540  else
1541  {
1542  session_manager_main.is_enabled = 0;
1544  }
1545 
1546  return error;
1547 }
1548 
1549 clib_error_t *
1551 {
1554 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1555  smm->session_va_space_size = 128ULL << 30;
1556  smm->evt_qs_segment_size = 64 << 20;
1557 #else
1558  smm->session_va_space_size = 128 << 20;
1559  smm->evt_qs_segment_size = 1 << 20;
1560 #endif
1561  smm->is_enabled = 0;
1562  return 0;
1563 }
1564 
1566 
1567 static clib_error_t *
1569 {
1571  u32 nitems;
1572  uword tmp;
1573 
1574  while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1575  {
1576  if (unformat (input, "event-queue-length %d", &nitems))
1577  {
1578  if (nitems >= 2048)
1579  smm->configured_event_queue_length = nitems;
1580  else
1581  clib_warning ("event queue length %d too small, ignored", nitems);
1582  }
1583  else if (unformat (input, "preallocated-sessions %d",
1584  &smm->preallocated_sessions))
1585  ;
1586  else if (unformat (input, "v4-session-table-buckets %d",
1588  ;
1589  else if (unformat (input, "v4-halfopen-table-buckets %d",
1591  ;
1592  else if (unformat (input, "v6-session-table-buckets %d",
1594  ;
1595  else if (unformat (input, "v6-halfopen-table-buckets %d",
1597  ;
1598  else if (unformat (input, "v4-session-table-memory %U",
1599  unformat_memory_size, &tmp))
1600  {
1601  if (tmp >= 0x100000000)
1602  return clib_error_return (0, "memory size %llx (%lld) too large",
1603  tmp, tmp);
1605  }
1606  else if (unformat (input, "v4-halfopen-table-memory %U",
1607  unformat_memory_size, &tmp))
1608  {
1609  if (tmp >= 0x100000000)
1610  return clib_error_return (0, "memory size %llx (%lld) too large",
1611  tmp, tmp);
1613  }
1614  else if (unformat (input, "v6-session-table-memory %U",
1615  unformat_memory_size, &tmp))
1616  {
1617  if (tmp >= 0x100000000)
1618  return clib_error_return (0, "memory size %llx (%lld) too large",
1619  tmp, tmp);
1621  }
1622  else if (unformat (input, "v6-halfopen-table-memory %U",
1623  unformat_memory_size, &tmp))
1624  {
1625  if (tmp >= 0x100000000)
1626  return clib_error_return (0, "memory size %llx (%lld) too large",
1627  tmp, tmp);
1629  }
1630  else if (unformat (input, "local-endpoints-table-memory %U",
1631  unformat_memory_size, &tmp))
1632  {
1633  if (tmp >= 0x100000000)
1634  return clib_error_return (0, "memory size %llx (%lld) too large",
1635  tmp, tmp);
1636  smm->local_endpoints_table_memory = tmp;
1637  }
1638  else if (unformat (input, "local-endpoints-table-buckets %d",
1640  ;
1641  else if (unformat (input, "evt_qs_memfd_seg"))
1642  smm->evt_qs_use_memfd_seg = 1;
1643  else
1644  return clib_error_return (0, "unknown input `%U'",
1645  format_unformat_error, input);
1646  }
1647  return 0;
1648 }
1649 
1651 
1652 /*
1653  * fd.io coding-style-patch-verification: ON
1654  *
1655  * Local Variables:
1656  * eval: (c-set-style "gnu")
1657  * End:
1658  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:439
u32 configured_v4_session_table_memory
Definition: session.h:274
f64 dispatch_period
Our approximation of a "complete" dispatch loop period.
Definition: session.h:190
u64 ssvm_size
Definition: ssvm.h:84
static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES]
Definition: session.c:1040
app_worker_t * app_worker_get(u32 wrk_index)
Definition: application.c:517
int stream_session_accept_notify(transport_connection_t *tc)
Definition: session.c:771
static void session_delete(stream_session_t *s)
Cleans up session and lookup table.
Definition: session.c:190
void session_flush_frames_main_thread(vlib_main_t *vm)
Definition: session.c:1398
static u8 svm_msg_q_msg_is_invalid(svm_msg_q_msg_t *msg)
Check if message is invalid.
int session_lookup_del_connection(transport_connection_t *tc)
Delete transport connection from session table.
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)
clib_rwlock_t peekers_rw_locks
Peekers rw lock.
Definition: session.h:220
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:1061
session_evt_type_t
Definition: session.h:33
static void svm_pop_heap(void *oldheap)
Definition: svm.h:94
uword requested_va
Definition: ssvm.h:87
void svm_fifo_init_pointers(svm_fifo_t *f, u32 pointer)
Set fifo pointers to requested offset.
Definition: svm_fifo.c:843
#define SESSION_Q_PROCESS_FLUSH_FRAMES
Definition: session.h:303
static void clib_rwlock_writer_lock(clib_rwlock_t *p)
Definition: lock.h:177
transport_proto_vft_t * tp_vfts
Per-type vector of transport protocol virtual function tables.
Definition: transport.c:23
struct _transport_connection transport_connection_t
ssvm_private_t evt_qs_segment
Event queues memfd segment initialized only if so configured.
Definition: session.h:243
u32 configured_v4_halfopen_table_memory
Definition: session.h:276
u32 configured_v6_session_table_buckets
Definition: session.h:277
unsigned long u64
Definition: types.h:89
session_manager_main_t session_manager_main
Definition: session.c:27
void session_transport_delete_notify(transport_connection_t *tc)
Notification from transport that connection is being deleted.
Definition: session.c:820
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:232
app_worker_t * application_listener_select_worker(stream_session_t *ls, u8 is_local)
Definition: application.c:478
#define pool_get_aligned_will_expand(P, YESNO, A)
See if pool_get will expand the pool or not.
Definition: pool.h:242
struct _transport_proto_vft transport_proto_vft_t
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:525
session_event_t * pending_event_vector
Vector of active event vectors.
Definition: session.h:211
void session_send_rpc_evt_to_thread(u32 thread_index, void *fp, void *rpc_args)
Definition: session.c:111
void session_transport_reset_notify(transport_connection_t *tc)
Notify application that connection has been reset.
Definition: session.c:904
#define vec_add2(V, P, N)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:564
int i
session_event_t * postponed_event_vector
Vector of postponed events.
Definition: session.h:217
#define session_endpoint_to_transport_cfg(_sep)
transport_tx_fn_type_t transport_protocol_tx_fn_type(transport_proto_t tp)
Definition: transport.c:270
clib_memset(h->entries, 0, sizeof(h->entries[0])*entries)
int session_open_vc(u32 app_wrk_index, session_endpoint_t *rmt, u32 opaque)
Definition: session.c:991
void svm_fifo_dequeue_drop_all(svm_fifo_t *f)
Definition: svm_fifo.c:774
transport_connection_t * session_get_transport(stream_session_t *s)
Definition: session.c:1358
static u32 svm_fifo_max_enqueue(svm_fifo_t *f)
Definition: svm_fifo.h:142
ssvm_shared_header_t * sh
Definition: ssvm.h:83
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
int session_lookup_del_session(stream_session_t *s)
void segment_manager_dealloc_fifos(u32 segment_index, svm_fifo_t *rx_fifo, svm_fifo_t *tx_fifo)
u8 is_enabled
Session manager is enabled.
Definition: session.h:261
int session_listen(stream_session_t *ls, session_endpoint_cfg_t *sep)
Ask transport to listen on session endpoint.
Definition: session.c:1076
#define vec_validate_aligned(V, I, A)
Make sure vector is long enough for given index (no header, specified alignment)
Definition: vec.h:450
int session_enqueue_stream_connection(transport_connection_t *tc, vlib_buffer_t *b, u32 offset, u8 queue_event, u8 is_in_order)
Definition: session.c:392
u64 session_lookup_half_open_handle(transport_connection_t *tc)
u32 configured_v6_halfopen_table_memory
Definition: session.h:280
void session_node_enable_disable(u8 is_en)
Definition: session.c:1495
vlib_node_registration_t session_queue_node
(constructor) VLIB_REGISTER_NODE (session_queue_node)
vlib_main_t ** vlib_mains
Definition: buffer.c:310
enum transport_service_type_ transport_service_type_t
static uword vlib_node_add_next(vlib_main_t *vm, uword node, uword next_node)
Definition: node_funcs.h:1122
unsigned char u8
Definition: types.h:56
session_fifo_rx_fn session_tx_fifo_peek_and_snd
#define vec_reset_length(v)
Reset vector length to zero NULL-pointer tolerant.
double f64
Definition: types.h:142
static session_fifo_rx_fn * session_tx_fns[TRANSPORT_TX_N_FNS]
Definition: session.c:1314
session_event_t * pending_disconnects
Vector of postponed disconnects.
Definition: session.h:214
struct _svm_fifo svm_fifo_t
void session_free(stream_session_t *s)
Definition: session.c:169
segment_manager_t * app_worker_get_listen_segment_manager(app_worker_t *app, stream_session_t *listener)
Definition: application.c:943
int session_stop_listen(stream_session_t *s)
Ask transport to stop listening on local transport endpoint.
Definition: session.c:1106
void session_transport_closing_notify(transport_connection_t *tc)
Notification from transport that connection is being closed.
Definition: session.c:794
int session_open_cl(u32 app_wrk_index, session_endpoint_t *rmt, u32 opaque)
Definition: session.c:953
static svm_msg_q_t * session_manager_get_vpp_event_queue(u32 thread_index)
Definition: session.h:656
void app_namespaces_init(void)
static clib_error_t * session_config_fn(vlib_main_t *vm, unformat_input_t *input)
Definition: session.c:1568
svm_msg_q_t * svm_msg_q_alloc(svm_msg_q_cfg_t *cfg)
Allocate message queue.
Definition: message_queue.c:40
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:163
u32 * session_to_enqueue[TRANSPORT_N_PROTO]
Per-proto vector of sessions to enqueue.
Definition: session.h:199
static void * svm_push_data_heap(svm_region_t *rp)
Definition: svm.h:86
#define always_inline
Definition: clib.h:98
static u32 svm_fifo_max_dequeue(svm_fifo_t *f)
Definition: svm_fifo.h:124
int session_send_ctrl_evt_to_thread(stream_session_t *s, session_evt_type_t evt_type)
Definition: session.c:101
static stream_session_t * session_alloc_for_connection(transport_connection_t *tc)
Definition: session.c:226
int session_dequeue_notify(stream_session_t *s)
Definition: session.c:552
static stream_session_t * listen_session_get(u32 index)
Definition: session.h:695
static void * ssvm_push_heap(ssvm_shared_header_t *sh)
Definition: ssvm.h:144
#define clib_error_return(e, args...)
Definition: error.h:99
svm_region_t * vlib_rp
Current binary api segment descriptor.
Definition: api_common.h:255
int svm_fifo_enqueue_nowait(svm_fifo_t *f, u32 max_bytes, const u8 *copy_from_here)
Definition: svm_fifo.c:530
vhost_vring_state_t state
Definition: vhost_user.h:120
int session_enqueue_dgram_connection(stream_session_t *s, session_dgram_hdr_t *hdr, vlib_buffer_t *b, u8 proto, u8 queue_event)
Definition: session.c:445
unsigned int u32
Definition: types.h:88
u32 configured_v6_session_table_memory
Definition: session.h:278
struct _stream_session_t stream_session_t
int session_send_io_evt_to_thread(svm_fifo_t *f, session_evt_type_t evt_type)
Definition: session.c:88
void session_vpp_event_queues_allocate(session_manager_main_t *smm)
Allocate event queues in the shared-memory segment.
Definition: session.c:1242
int ssvm_master_init(ssvm_private_t *ssvm, ssvm_segment_type_t type)
Definition: ssvm.c:411
int( session_fifo_rx_fn)(vlib_main_t *vm, vlib_node_runtime_t *node, session_manager_worker_t *wrk, session_event_t *e, int *n_tx_pkts)
Definition: session.h:226
enum transport_dequeue_type_ transport_tx_fn_type_t
static void ssvm_pop_heap(void *oldheap)
Definition: ssvm.h:152
void session_close(stream_session_t *s)
Initialize session closing procedure.
Definition: session.c:1135
stream_session_t * sessions
Worker session pool.
Definition: session.h:184
int session_lookup_del_half_open(transport_connection_t *tc)
static u32 vlib_get_buffer_index(vlib_main_t *vm, void *p)
Translate buffer pointer into buffer index.
Definition: buffer_funcs.h:158
static clib_error_t * session_manager_main_enable(vlib_main_t *vm)
Definition: session.c:1406
struct _session_endpoint_cfg session_endpoint_cfg_t
session_event_t * free_event_vector
Vector of partially read events.
Definition: session.h:208
#define session_endpoint_to_transport(_sep)
static transport_proto_t session_get_transport_proto(stream_session_t *s)
Definition: session.h:427
u32 stream_session_dequeue_drop(transport_connection_t *tc, u32 max_bytes)
Definition: session.c:515
int segment_manager_alloc_session_fifos(segment_manager_t *sm, svm_fifo_t **rx_fifo, svm_fifo_t **tx_fifo, u32 *fifo_segment_index)
f64 last_vlib_time
vlib_time_now last time around the track
Definition: session.h:193
int session_dgram_connect_notify(transport_connection_t *tc, u32 old_thread_index, stream_session_t **new_session)
Move dgram session to the right thread.
Definition: session.c:735
static void clib_rwlock_init(clib_rwlock_t *p)
Definition: lock.h:122
int svm_msg_q_alloc_consumer_eventfd(svm_msg_q_t *mq)
Allocate event fd for queue consumer.
transport_service_type_t transport_protocol_service_type(transport_proto_t tp)
Definition: transport.c:264
u16 current_length
Nbytes between current data and the end of this buffer.
Definition: buffer.h:114
struct _session_endpoint session_endpoint_t
static void svm_fifo_clear_tx_ntf(svm_fifo_t *f)
Definition: svm_fifo.h:265
app_worker_t * app_worker_get_if_valid(u32 wrk_index)
Definition: application.c:523
struct _unformat_input_t unformat_input_t
unsigned short u16
Definition: types.h:57
u32 configured_v6_halfopen_table_buckets
Definition: session.h:279
static session_handle_t session_handle(stream_session_t *s)
Definition: session.h:364
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:214
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:286
#define PREDICT_FALSE(x)
Definition: clib.h:111
#define VLIB_CONFIG_FUNCTION(x, n,...)
Definition: init.h:172
u32 wrk_index
Worker index in global worker pool.
Definition: application.h:65
clib_error_t * session_manager_main_init(vlib_main_t *vm)
Definition: session.c:1550
static stream_session_t * session_get_if_valid(u64 si, u32 thread_index)
Definition: session.h:349
#define foreach_vlib_main(body)
Definition: threads.h:235
int stream_session_accept(transport_connection_t *tc, u32 listener_index, u8 notify)
Accept a stream session.
Definition: session.c:923
clib_error_t * vnet_session_enable_disable(vlib_main_t *vm, u8 is_en)
Definition: session.c:1529
void session_free_w_fifos(stream_session_t *s)
Definition: session.c:177
static stream_session_t * session_get(u32 si, u32 thread_index)
Definition: session.h:341
struct _session_switch_pool_args session_switch_pool_args_t
u8 len
Definition: ip_types.api:49
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:202
int session_alloc_fifos(segment_manager_t *sm, stream_session_t *s)
Definition: session.c:202
#define pool_get_aligned(P, E, A)
Allocate an object E from a pool P with alignment A.
Definition: pool.h:230
#define SESSION_DBG(_fmt, _args...)
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 SESSION_EVT_DBG(_evt, _args...)
void transport_init(void)
Definition: transport.c:647
session_fifo_rx_fn session_tx_fifo_dequeue_and_snd
#define UNFORMAT_END_OF_INPUT
Definition: format.h:144
static session_manager_worker_t * session_manager_get_worker(u32 thread_index)
Definition: session.h:316
u32 runtime_index
Definition: node.h:307
static int session_enqueue_notify(stream_session_t *s)
Notify session peer that new data has been enqueued.
Definition: session.c:530
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:212
static vlib_process_t * vlib_get_current_process(vlib_main_t *vm)
Definition: node_funcs.h:421
static session_type_t session_type_from_proto_and_ip(transport_proto_t proto, u8 is_ip4)
Definition: session.h:440
vlib_main_t * vm
Definition: buffer.c:301
static void svm_msg_q_unlock(svm_msg_q_t *mq)
Unlock message queue.
static void vlib_process_signal_event_mt(vlib_main_t *vm, uword node_index, uword type_opaque, uword data)
Signal event to process from any thread.
Definition: node_funcs.h:988
void session_transport_cleanup(stream_session_t *s)
Cleanup transport and session state.
Definition: session.c:1197
transport_service_type_t session_transport_service_type(stream_session_t *s)
Definition: session.c:1211
#define clib_warning(format, args...)
Definition: error.h:59
void transport_init_tx_pacers_period(void)
Initialize period for tx pacers.
Definition: transport.c:618
static int session_send_evt_to_thread(void *data, void *args, u32 thread_index, session_evt_type_t evt_type)
Definition: session.c:31
void stream_session_init_fifos_pointers(transport_connection_t *tc, u32 rx_pointer, u32 tx_pointer)
Init fifo tail and head pointers.
Definition: session.c:620
#define HIGH_SEGMENT_BASEVA
Definition: svm_common.h:84
u32 my_pid
Definition: ssvm.h:85
void session_transport_close(stream_session_t *s)
Notify transport the session can be disconnected.
Definition: session.c:1165
void transport_enable_disable(vlib_main_t *vm, u8 is_en)
Definition: transport.c:636
static u8 vlib_thread_is_main_w_barrier(void)
Definition: threads.h:511
static int svm_msg_q_try_lock(svm_msg_q_t *mq)
Try locking message queue.
u32 configured_v4_halfopen_table_buckets
Definition: session.h:275
u32 local_endpoints_table_buckets
Definition: session.h:284
#define pool_init_fixed(pool, max_elts)
initialize a fixed-size, preallocated pool
Definition: pool.h:86
application_t * application_get(u32 app_index)
Definition: application.c:213
int app_worker_lock_and_send_event(app_worker_t *app, stream_session_t *s, u8 evt_type)
Send event to application.
Definition: application.c:1418
#define SESSION_Q_PROCESS_STOP
Definition: session.h:304
session_fifo_rx_fn ** session_tx_fns
Per transport rx function that can either dequeue or peek.
Definition: session.h:249
ssvm_private_t * session_manager_get_evt_q_segment(void)
Definition: session.c:1305
#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.
u32 session_tx_fifo_max_dequeue(transport_connection_t *tc)
Definition: session.c:498
u8 session_type_t
u32 preallocated_sessions
Preallocate session config parameter.
Definition: session.h:287
u32 next_buffer
Next buffer for this linked-list of buffers.
Definition: buffer.h:130
void segment_manager_main_init(segment_manager_main_init_args_t *a)
static void clib_mem_free(void *p)
Definition: mem.h:205
session_cb_vft_t cb_fns
Callbacks: shoulder-taps for the server/client.
Definition: application.h:130
int listen_session_get_local_session_endpoint(stream_session_t *listener, session_endpoint_t *sep)
Definition: session.c:1378
u32 * session_type_to_next
Per session type output nodes.
Definition: session.h:254
static void vlib_buffer_advance(vlib_buffer_t *b, word l)
Advance current data pointer by the supplied (signed!) amount.
Definition: buffer.h:233
static void vlib_node_set_state(vlib_main_t *vm, u32 node_index, vlib_node_state_t new_state)
Set node dispatch state.
Definition: node_funcs.h:148
int svm_fifo_enqueue_with_offset(svm_fifo_t *f, u32 offset, u32 required_bytes, u8 *copy_from_here)
Definition: svm_fifo.c:598
static void * clib_mem_alloc(uword size)
Definition: mem.h:132
svm_msg_q_ring_cfg_t * ring_cfgs
array of ring cfgs
Definition: message_queue.h:55
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
u8 * name
Definition: ssvm.h:86
stream_session_t * session_alloc(u32 thread_index)
Definition: session.c:144
#define HALF_OPEN_LOOKUP_INVALID_VALUE
Definition: session.h:25
static void session_enqueue_discard_chain_bytes(vlib_main_t *vm, vlib_buffer_t *b, vlib_buffer_t **chain_b, u32 n_bytes_to_drop)
Discards bytes from buffer chain.
Definition: session.c:273
u32 total_length_not_including_first_buffer
Only valid for first buffer in chain.
Definition: buffer.h:156
template key/value backing page structure
Definition: bihash_doc.h:44
u32 configured_v4_session_table_buckets
Session table size parameters.
Definition: session.h:273
static void session_switch_pool(void *cb_args)
Definition: session.c:716
int svm_fifo_dequeue_drop(svm_fifo_t *f, u32 max_bytes)
Definition: svm_fifo.c:734
u64 current_enqueue_epoch[TRANSPORT_N_PROTO]
Per-proto enqueue epoch counters.
Definition: session.h:196
session_manager_worker_t * wrk
Worker contexts.
Definition: session.h:240
u32 q_nitems
msg queue size (not rings)
Definition: message_queue.h:53
enum _transport_proto transport_proto_t
transport_connection_t * listen_session_get_transport(stream_session_t *s)
Definition: session.c:1371
void session_lookup_init(void)
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
svm_msg_q_t * vpp_event_queue
vpp event message queue for worker
Definition: session.h:187
session_fifo_rx_fn session_tx_fifo_dequeue_internal
uword session_baseva
Session ssvm segment configs.
Definition: session.h:267
static stream_session_t * session_clone_safe(u32 session_index, u32 thread_index)
Definition: session.h:569
void session_transport_closed_notify(transport_connection_t *tc)
Notification from transport that session can be closed.
Definition: session.c:875
u64 uword
Definition: types.h:112
struct _segment_manager segment_manager_t
int session_send_io_evt_to_thread_custom(void *data, u32 thread_index, session_evt_type_t evt_type)
Definition: session.c:94
unformat_function_t unformat_memory_size
Definition: format.h:295
int session_manager_flush_all_enqueue_events(u8 transport_proto)
Definition: session.c:605
u32 app_index
Index of owning app.
Definition: application.h:71
int session_lookup_add_connection(transport_connection_t *tc, u64 value)
Add transport connection to a session table.
transport_tx_fn_type_t session_transport_tx_fn_type(stream_session_t *s)
Definition: session.c:1219
int session_manager_flush_enqueue_events(u8 transport_proto, u32 thread_index)
Flushes queue of sessions that are to be notified of new data enqueued events.
Definition: session.c:576
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
int session_stream_connect_notify(transport_connection_t *tc, u8 is_fail)
Definition: session.c:630
static vlib_thread_main_t * vlib_get_thread_main()
Definition: global_funcs.h:32
vlib_node_registration_t session_queue_process_node
(constructor) VLIB_REGISTER_NODE (session_queue_process_node)
static u32 vlib_num_workers()
Definition: threads.h:366
static vlib_node_t * vlib_get_node(vlib_main_t *vm, u32 i)
Get vlib node by index.
Definition: node_funcs.h:59
static int session_enqueue_chain_tail(stream_session_t *s, vlib_buffer_t *b, u32 offset, u8 is_in_order)
Enqueue buffer chain tail.
Definition: session.c:304
u8 session_tx_is_dgram(stream_session_t *s)
Definition: session.c:1227
u32 configured_event_queue_length
vpp fifo event queue configured length
Definition: session.h:264
int(* session_open_service_fn)(u32, session_endpoint_t *, u32)
Definition: session.c:1037
static void session_program_transport_close(stream_session_t *s)
Definition: session.c:123
int application_is_builtin_proxy(application_t *app)
Definition: application.c:1036
u32 local_endpoints_table_memory
Transport table (preallocation) size parameters.
Definition: session.h:283
segment_manager_t * app_worker_get_connect_segment_manager(app_worker_t *app)
Definition: application.c:928
int consumer_pid
pid of msg consumer
Definition: message_queue.h:52
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
u32 flags
buffer flags: VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index, VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:117
int session_open_app(u32 app_wrk_index, session_endpoint_t *rmt, u32 opaque)
Definition: session.c:1026
static int session_alloc_and_init(segment_manager_t *sm, transport_connection_t *tc, u8 alloc_fifos, stream_session_t **ret_s)
Definition: session.c:246
void vlib_start_process(vlib_main_t *vm, uword process_index)
Definition: main.c:1556
int svm_fifo_peek(svm_fifo_t *f, u32 relative_offset, u32 max_bytes, u8 *copy_here)
Definition: svm_fifo.c:726
void session_register_transport(transport_proto_t transport_proto, const transport_proto_vft_t *vft, u8 is_ip4, u32 output_node)
Initialize session layer for given transport proto and ip version.
Definition: session.c:1329
int session_lookup_add_half_open(transport_connection_t *tc, u64 value)
api_main_t api_main
Definition: api_shared.c:35
int stream_session_peek_bytes(transport_connection_t *tc, u8 *buffer, u32 offset, u32 max_bytes)
Definition: session.c:507
u8 transport_protocol_is_cl(transport_proto_t tp)
Definition: transport.c:276
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:62
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 i_am_master
Definition: ssvm.h:88
u8 stream_session_no_space(transport_connection_t *tc, u32 thread_index, u16 data_len)
Check if we have space in rx fifo to push more bytes.
Definition: session.c:483
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
uword session_va_space_size
Definition: session.h:268