FD.io VPP  v19.08-24-ge6a5712
Vector Packet Processing
session.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2019 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /**
16  * @file
17  * @brief Session and session manager
18  */
19 
20 #include <vnet/session/session.h>
23 #include <vnet/dpo/load_balance.h>
24 #include <vnet/fib/ip4_fib.h>
25 
27 
28 static inline int
29 session_send_evt_to_thread (void *data, void *args, u32 thread_index,
30  session_evt_type_t evt_type)
31 {
32  session_event_t *evt;
33  svm_msg_q_msg_t msg;
34  svm_msg_q_t *mq;
35 
36  mq = session_main_get_vpp_event_queue (thread_index);
37  if (PREDICT_FALSE (svm_msg_q_lock (mq)))
38  return -1;
40  {
41  svm_msg_q_unlock (mq);
42  return -2;
43  }
46  {
47  svm_msg_q_unlock (mq);
48  return -2;
49  }
50  evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
51  evt->event_type = evt_type;
52  switch (evt_type)
53  {
55  evt->rpc_args.fp = data;
56  evt->rpc_args.arg = args;
57  break;
58  case SESSION_IO_EVT_RX:
59  case SESSION_IO_EVT_TX:
62  evt->session_index = *(u32 *) data;
63  break;
66  evt->session_handle = session_handle ((session_t *) data);
67  break;
68  default:
69  clib_warning ("evt unhandled!");
70  svm_msg_q_unlock (mq);
71  return -1;
72  }
73 
74  svm_msg_q_add_and_unlock (mq, &msg);
75  return 0;
76 }
77 
78 int
80 {
81  return session_send_evt_to_thread (&f->master_session_index, 0,
82  f->master_thread_index, evt_type);
83 }
84 
85 int
87  session_evt_type_t evt_type)
88 {
89  return session_send_evt_to_thread (data, 0, thread_index, evt_type);
90 }
91 
92 int
94 {
95  /* only event supported for now is disconnect */
96  ASSERT (evt_type == SESSION_CTRL_EVT_CLOSE);
99 }
100 
101 void
103  void *rpc_args)
104 {
105  session_send_evt_to_thread (fp, rpc_args, thread_index,
107 }
108 
109 void
110 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
111 {
112  if (thread_index != vlib_get_thread_index ())
113  session_send_rpc_evt_to_thread_force (thread_index, fp, rpc_args);
114  else
115  {
116  void (*fnp) (void *) = fp;
117  fnp (rpc_args);
118  }
119 }
120 
121 void
123 {
124  session_t *s;
125 
126  s = session_get (tc->s_index, tc->thread_index);
128  if (!(s->flags & SESSION_F_CUSTOM_TX))
129  {
131  if (svm_fifo_set_event (s->tx_fifo))
132  {
133  session_worker_t *wrk;
134  session_evt_elt_t *elt;
135  wrk = session_main_get_worker (tc->thread_index);
136  if (has_prio)
137  elt = session_evt_alloc_new (wrk);
138  else
139  elt = session_evt_alloc_old (wrk);
140  elt->evt.session_index = tc->s_index;
141  elt->evt.event_type = SESSION_IO_EVT_TX;
142  }
143  }
144 }
145 
146 static void
148 {
149  u32 thread_index = vlib_get_thread_index ();
150  session_evt_elt_t *elt;
151  session_worker_t *wrk;
152 
153  /* If we are in the handler thread, or being called with the worker barrier
154  * held, just append a new event to pending disconnects vector. */
155  if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
156  {
158  elt = session_evt_alloc_ctrl (wrk);
159  clib_memset (&elt->evt, 0, sizeof (session_event_t));
160  elt->evt.session_handle = session_handle (s);
161  elt->evt.event_type = SESSION_CTRL_EVT_CLOSE;
162  }
163  else
165 }
166 
167 session_t *
168 session_alloc (u32 thread_index)
169 {
170  session_worker_t *wrk = &session_main.wrk[thread_index];
171  session_t *s;
172  u8 will_expand = 0;
173  pool_get_aligned_will_expand (wrk->sessions, will_expand,
175  /* If we have peekers, let them finish */
176  if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
177  {
181  }
182  else
183  {
185  }
186  clib_memset (s, 0, sizeof (*s));
187  s->session_index = s - wrk->sessions;
188  s->thread_index = thread_index;
190  return s;
191 }
192 
193 void
195 {
196  if (CLIB_DEBUG)
197  {
198  u8 thread_index = s->thread_index;
199  clib_memset (s, 0xFA, sizeof (*s));
200  pool_put (session_main.wrk[thread_index].sessions, s);
201  return;
202  }
203  SESSION_EVT (SESSION_EVT_FREE, s);
204  pool_put (session_main.wrk[s->thread_index].sessions, s);
205 }
206 
207 static void
209 {
210  app_worker_t *app_wrk;
211 
212  app_wrk = app_worker_get_if_valid (s->app_wrk_index);
213  if (!app_wrk)
214  return;
215  app_worker_cleanup_notify (app_wrk, s, ntf);
216 }
217 
218 void
220 {
223  session_free (s);
224 }
225 
226 /**
227  * Cleans up session and lookup table.
228  *
229  * Transport connection must still be valid.
230  */
231 static void
233 {
234  int rv;
235 
236  /* Delete from the main lookup table. */
237  if ((rv = session_lookup_del_session (s)))
238  clib_warning ("session %u hash delete rv %d", s->session_index, rv);
239 
241 }
242 
243 static session_t *
245 {
246  session_t *s;
247  u32 thread_index = tc->thread_index;
248 
249  ASSERT (thread_index == vlib_get_thread_index ()
250  || transport_protocol_is_cl (tc->proto));
251 
252  s = session_alloc (thread_index);
253  s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
255 
256  /* Attach transport to session and vice versa */
257  s->connection_index = tc->c_index;
258  tc->s_index = s->session_index;
259  return s;
260 }
261 
262 /**
263  * Discards bytes from buffer chain
264  *
265  * It discards n_bytes_to_drop starting at first buffer after chain_b
266  */
267 always_inline void
269  vlib_buffer_t ** chain_b,
270  u32 n_bytes_to_drop)
271 {
272  vlib_buffer_t *next = *chain_b;
273  u32 to_drop = n_bytes_to_drop;
274  ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
275  while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
276  {
277  next = vlib_get_buffer (vm, next->next_buffer);
278  if (next->current_length > to_drop)
279  {
280  vlib_buffer_advance (next, to_drop);
281  to_drop = 0;
282  }
283  else
284  {
285  to_drop -= next->current_length;
286  next->current_length = 0;
287  }
288  }
289  *chain_b = next;
290 
291  if (to_drop == 0)
292  b->total_length_not_including_first_buffer -= n_bytes_to_drop;
293 }
294 
295 /**
296  * Enqueue buffer chain tail
297  */
298 always_inline int
300  u32 offset, u8 is_in_order)
301 {
302  vlib_buffer_t *chain_b;
303  u32 chain_bi, len, diff;
305  u8 *data;
306  u32 written = 0;
307  int rv = 0;
308 
309  if (is_in_order && offset)
310  {
311  diff = offset - b->current_length;
313  return 0;
314  chain_b = b;
315  session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
316  chain_bi = vlib_get_buffer_index (vm, chain_b);
317  }
318  else
319  chain_bi = b->next_buffer;
320 
321  do
322  {
323  chain_b = vlib_get_buffer (vm, chain_bi);
324  data = vlib_buffer_get_current (chain_b);
325  len = chain_b->current_length;
326  if (!len)
327  continue;
328  if (is_in_order)
329  {
330  rv = svm_fifo_enqueue (s->rx_fifo, len, data);
331  if (rv == len)
332  {
333  written += rv;
334  }
335  else if (rv < len)
336  {
337  return (rv > 0) ? (written + rv) : written;
338  }
339  else if (rv > len)
340  {
341  written += rv;
342 
343  /* written more than what was left in chain */
345  return written;
346 
347  /* drop the bytes that have already been delivered */
348  session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
349  }
350  }
351  else
352  {
353  rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
354  if (rv)
355  {
356  clib_warning ("failed to enqueue multi-buffer seg");
357  return -1;
358  }
359  offset += len;
360  }
361  }
362  while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
363  ? chain_b->next_buffer : 0));
364 
365  if (is_in_order)
366  return written;
367 
368  return 0;
369 }
370 
371 /*
372  * Enqueue data for delivery to session peer. Does not notify peer of enqueue
373  * event but on request can queue notification events for later delivery by
374  * calling stream_server_flush_enqueue_events().
375  *
376  * @param tc Transport connection which is to be enqueued data
377  * @param b Buffer to be enqueued
378  * @param offset Offset at which to start enqueueing if out-of-order
379  * @param queue_event Flag to indicate if peer is to be notified or if event
380  * is to be queued. The former is useful when more data is
381  * enqueued and only one event is to be generated.
382  * @param is_in_order Flag to indicate if data is in order
383  * @return Number of bytes enqueued or a negative value if enqueueing failed.
384  */
385 int
387  vlib_buffer_t * b, u32 offset,
388  u8 queue_event, u8 is_in_order)
389 {
390  session_t *s;
391  int enqueued = 0, rv, in_order_off;
392 
393  s = session_get (tc->s_index, tc->thread_index);
394 
395  if (is_in_order)
396  {
397  enqueued = svm_fifo_enqueue (s->rx_fifo,
398  b->current_length,
400  if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
401  && enqueued >= 0))
402  {
403  in_order_off = enqueued > b->current_length ? enqueued : 0;
404  rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
405  if (rv > 0)
406  enqueued += rv;
407  }
408  }
409  else
410  {
411  rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
412  b->current_length,
414  if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
415  session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
416  /* if something was enqueued, report even this as success for ooo
417  * segment handling */
418  return rv;
419  }
420 
421  if (queue_event)
422  {
423  /* Queue RX event on this fifo. Eventually these will need to be flushed
424  * by calling stream_server_flush_enqueue_events () */
425  session_worker_t *wrk;
426 
428  if (!(s->flags & SESSION_F_RX_EVT))
429  {
430  s->flags |= SESSION_F_RX_EVT;
431  vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
432  }
433  }
434 
435  return enqueued;
436 }
437 
438 int
440  session_dgram_hdr_t * hdr,
441  vlib_buffer_t * b, u8 proto, u8 queue_event)
442 {
443  int enqueued = 0, rv, in_order_off;
444 
446  >= b->current_length + sizeof (*hdr));
447 
448  svm_fifo_enqueue (s->rx_fifo, sizeof (session_dgram_hdr_t), (u8 *) hdr);
449  enqueued = svm_fifo_enqueue (s->rx_fifo, b->current_length,
451  if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
452  {
453  in_order_off = enqueued > b->current_length ? enqueued : 0;
454  rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
455  if (rv > 0)
456  enqueued += rv;
457  }
458  if (queue_event)
459  {
460  /* Queue RX event on this fifo. Eventually these will need to be flushed
461  * by calling stream_server_flush_enqueue_events () */
462  session_worker_t *wrk;
463 
465  if (!(s->flags & SESSION_F_RX_EVT))
466  {
467  s->flags |= SESSION_F_RX_EVT;
468  vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
469  }
470  }
471  return enqueued;
472 }
473 
474 int
476  u32 offset, u32 max_bytes)
477 {
478  session_t *s = session_get (tc->s_index, tc->thread_index);
479  return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
480 }
481 
482 u32
484 {
485  session_t *s = session_get (tc->s_index, tc->thread_index);
486  u32 rv;
487 
488  rv = svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
489 
490  if (svm_fifo_needs_deq_ntf (s->tx_fifo, max_bytes))
492 
493  return rv;
494 }
495 
496 static inline int
498  svm_fifo_t * f, session_evt_type_t evt_type)
499 {
500  app_worker_t *app_wrk;
501  application_t *app;
502  int i;
503 
504  app = application_get (app_index);
505  if (!app)
506  return -1;
507 
508  for (i = 0; i < f->n_subscribers; i++)
509  {
510  app_wrk = application_get_worker (app, f->subscribers[i]);
511  if (!app_wrk)
512  continue;
513  if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
514  return -1;
515  }
516 
517  return 0;
518 }
519 
520 /**
521  * Notify session peer that new data has been enqueued.
522  *
523  * @param s Stream session for which the event is to be generated.
524  * @param lock Flag to indicate if call should lock message queue.
525  *
526  * @return 0 on success or negative number if failed to send notification.
527  */
528 static inline int
530 {
531  app_worker_t *app_wrk;
532  u32 session_index;
533  u8 n_subscribers;
534 
535  session_index = s->session_index;
536  n_subscribers = svm_fifo_n_subscribers (s->rx_fifo);
537 
538  app_wrk = app_worker_get_if_valid (s->app_wrk_index);
539  if (PREDICT_FALSE (!app_wrk))
540  {
541  SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
542  return 0;
543  }
544 
545  SESSION_EVT (SESSION_EVT_ENQ, s, svm_fifo_max_dequeue_prod (s->rx_fifo));
546 
547  s->flags &= ~SESSION_F_RX_EVT;
550  return -1;
551 
552  if (PREDICT_FALSE (n_subscribers))
553  {
554  s = session_get (session_index, vlib_get_thread_index ());
555  return session_notify_subscribers (app_wrk->app_index, s,
557  }
558 
559  return 0;
560 }
561 
562 int
564 {
566 }
567 
568 static void
570 {
571  u32 session_index = pointer_to_uword (arg);
572  session_t *s;
573 
574  s = session_get_if_valid (session_index, vlib_get_thread_index ());
575  if (!s)
576  return;
577 
579 }
580 
581 /**
582  * Like session_enqueue_notify, but can be called from a thread that does not
583  * own the session.
584  */
585 void
587 {
588  u32 thread_index = session_thread_from_handle (sh);
589  u32 session_index = session_index_from_handle (sh);
590 
591  /*
592  * Pass session index (u32) as opposed to handle (u64) in case pointers
593  * are not 64-bit.
594  */
595  session_send_rpc_evt_to_thread (thread_index,
597  uword_to_pointer (session_index, void *));
598 }
599 
600 int
602 {
603  app_worker_t *app_wrk;
604 
605  app_wrk = app_worker_get_if_valid (s->app_wrk_index);
606  if (PREDICT_FALSE (!app_wrk))
607  return -1;
608 
611  return -1;
612 
613  if (PREDICT_FALSE (s->tx_fifo->n_subscribers))
614  return session_notify_subscribers (app_wrk->app_index, s,
616 
618 
619  return 0;
620 }
621 
622 /**
623  * Flushes queue of sessions that are to be notified of new data
624  * enqueued events.
625  *
626  * @param thread_index Thread index for which the flush is to be performed.
627  * @return 0 on success or a positive number indicating the number of
628  * failures due to API queue being full.
629  */
630 int
631 session_main_flush_enqueue_events (u8 transport_proto, u32 thread_index)
632 {
633  session_worker_t *wrk = session_main_get_worker (thread_index);
634  session_t *s;
635  int i, errors = 0;
636  u32 *indices;
637 
638  indices = wrk->session_to_enqueue[transport_proto];
639 
640  for (i = 0; i < vec_len (indices); i++)
641  {
642  s = session_get_if_valid (indices[i], thread_index);
643  if (PREDICT_FALSE (!s))
644  {
645  errors++;
646  continue;
647  }
648 
650  errors++;
651  }
652 
653  vec_reset_length (indices);
654  wrk->session_to_enqueue[transport_proto] = indices;
655 
656  return errors;
657 }
658 
659 int
661 {
663  int i, errors = 0;
664  for (i = 0; i < 1 + vtm->n_threads; i++)
665  errors += session_main_flush_enqueue_events (transport_proto, i);
666  return errors;
667 }
668 
669 static inline int
671  session_state_t opened_state)
672 {
673  u32 opaque = 0, new_ti, new_si;
674  app_worker_t *app_wrk;
675  session_t *s = 0;
676  u64 ho_handle;
677 
678  /*
679  * Find connection handle and cleanup half-open table
680  */
681  ho_handle = session_lookup_half_open_handle (tc);
682  if (ho_handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
683  {
684  SESSION_DBG ("half-open was removed!");
685  return -1;
686  }
688 
689  /* Get the app's index from the handle we stored when opening connection
690  * and the opaque (api_context for external apps) from transport session
691  * index */
692  app_wrk = app_worker_get_if_valid (ho_handle >> 32);
693  if (!app_wrk)
694  return -1;
695 
696  opaque = tc->s_index;
697 
698  if (is_fail)
699  return app_worker_connect_notify (app_wrk, s, opaque);
700 
703  s->app_wrk_index = app_wrk->wrk_index;
704  new_si = s->session_index;
705  new_ti = s->thread_index;
706 
707  if (app_worker_init_connected (app_wrk, s))
708  {
709  session_free (s);
710  app_worker_connect_notify (app_wrk, 0, opaque);
711  return -1;
712  }
713 
714  s = session_get (new_si, new_ti);
715  s->session_state = opened_state;
717 
718  if (app_worker_connect_notify (app_wrk, s, opaque))
719  {
720  s = session_get (new_si, new_ti);
722  return -1;
723  }
724 
725  return 0;
726 }
727 
728 int
730 {
731  return session_stream_connect_notify_inline (tc, is_fail,
733 }
734 
735 int
737 {
738  return session_stream_connect_notify_inline (tc, is_fail,
740 }
741 
742 typedef struct _session_switch_pool_args
743 {
744  u32 session_index;
745  u32 thread_index;
746  u32 new_thread_index;
747  u32 new_session_index;
749 
750 /**
751  * Notify old thread of the session pool switch
752  */
753 static void
754 session_switch_pool (void *cb_args)
755 {
757  app_worker_t *app_wrk;
758  session_t *s;
759 
760  ASSERT (args->thread_index == vlib_get_thread_index ());
761  s = session_get (args->session_index, args->thread_index);
762  s->tx_fifo->master_session_index = args->new_session_index;
763  s->tx_fifo->master_thread_index = args->new_thread_index;
765  s->thread_index);
766 
767  app_wrk = app_worker_get_if_valid (s->app_wrk_index);
768  if (app_wrk)
769  {
770  session_handle_t new_sh;
771  new_sh = session_make_handle (args->new_session_index,
772  args->new_thread_index);
773  app_worker_migrate_notify (app_wrk, s, new_sh);
774 
775  /* Trigger app read on the new thread */
777  }
778 
779  session_free (s);
780  clib_mem_free (cb_args);
781 }
782 
783 /**
784  * Move dgram session to the right thread
785  */
786 int
788  u32 old_thread_index, session_t ** new_session)
789 {
790  session_t *new_s;
791  session_switch_pool_args_t *rpc_args;
792 
793  /*
794  * Clone half-open session to the right thread.
795  */
796  new_s = session_clone_safe (tc->s_index, old_thread_index);
797  new_s->connection_index = tc->c_index;
798  new_s->rx_fifo->master_session_index = new_s->session_index;
799  new_s->rx_fifo->master_thread_index = new_s->thread_index;
802 
803  /*
804  * Ask thread owning the old session to clean it up and make us the tx
805  * fifo owner
806  */
807  rpc_args = clib_mem_alloc (sizeof (*rpc_args));
808  rpc_args->new_session_index = new_s->session_index;
809  rpc_args->new_thread_index = new_s->thread_index;
810  rpc_args->session_index = tc->s_index;
811  rpc_args->thread_index = old_thread_index;
812  session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
813  rpc_args);
814 
815  tc->s_index = new_s->session_index;
816  new_s->connection_index = tc->c_index;
817  *new_session = new_s;
818  return 0;
819 }
820 
821 /**
822  * Notification from transport that connection is being closed.
823  *
824  * A disconnect is sent to application but state is not removed. Once
825  * disconnect is acknowledged by application, session disconnect is called.
826  * Ultimately this leads to close being called on transport (passive close).
827  */
828 void
830 {
831  app_worker_t *app_wrk;
832  session_t *s;
833 
834  s = session_get (tc->s_index, tc->thread_index);
836  return;
838  app_wrk = app_worker_get (s->app_wrk_index);
839  app_worker_close_notify (app_wrk, s);
840 }
841 
842 /**
843  * Notification from transport that connection is being deleted
844  *
845  * This removes the session if it is still valid. It should be called only on
846  * previously fully established sessions. For instance failed connects should
847  * call stream_session_connect_notify and indicate that the connect has
848  * failed.
849  */
850 void
852 {
853  session_t *s;
854 
855  /* App might've been removed already */
856  if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
857  return;
858 
859  switch (s->session_state)
860  {
862  /* Session was created but accept notification was not yet sent to the
863  * app. Cleanup everything. */
866  break;
871  /* If transport finishes or times out before we get a reply
872  * from the app, mark transport as closed and wait for reply
873  * before removing the session. Cleanup session table in advance
874  * because transport will soon be closed and closed sessions
875  * are assumed to have been removed from the lookup table */
880  break;
882  /* Cleanup lookup table as transport needs to still be valid.
883  * Program transport close to ensure that all session events
884  * have been cleaned up. Once transport close is called, the
885  * session is just removed because both transport and app have
886  * confirmed the close*/
892  break;
894  break;
897  session_delete (s);
898  break;
899  default:
900  clib_warning ("session state %u", s->session_state);
902  session_delete (s);
903  break;
904  }
905 }
906 
907 /**
908  * Notification from transport that it is closed
909  *
910  * Should be called by transport, prior to calling delete notify, once it
911  * knows that no more data will be exchanged. This could serve as an
912  * early acknowledgment of an active close especially if transport delete
913  * can be delayed a long time, e.g., tcp time-wait.
914  */
915 void
917 {
918  app_worker_t *app_wrk;
919  session_t *s;
920 
921  if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
922  return;
923 
924  /* Transport thinks that app requested close but it actually didn't.
925  * Can happen for tcp if fin and rst are received in close succession. */
927  {
931  }
932  /* If app close has not been received or has not yet resulted in
933  * a transport close, only mark the session transport as closed */
934  else if (s->session_state <= SESSION_STATE_CLOSING)
935  {
937  }
938  /* If app also closed, switch to closed */
941 
942  app_wrk = app_worker_get_if_valid (s->app_wrk_index);
943  if (app_wrk)
945 }
946 
947 /**
948  * Notify application that connection has been reset.
949  */
950 void
952 {
953  app_worker_t *app_wrk;
954  session_t *s;
955 
956  s = session_get (tc->s_index, tc->thread_index);
959  return;
961  app_wrk = app_worker_get (s->app_wrk_index);
962  app_worker_reset_notify (app_wrk, s);
963 }
964 
965 int
967 {
968  app_worker_t *app_wrk;
969  session_t *s;
970 
971  s = session_get (tc->s_index, tc->thread_index);
972  app_wrk = app_worker_get_if_valid (s->app_wrk_index);
973  if (!app_wrk)
974  return -1;
976  return app_worker_accept_notify (app_wrk, s);
977 }
978 
979 /**
980  * Accept a stream session. Optionally ping the server by callback.
981  */
982 int
984  u32 thread_index, u8 notify)
985 {
986  session_t *s;
987  int rv;
988 
990  s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
992 
993  if ((rv = app_worker_init_accepted (s)))
994  return rv;
995 
997 
998  /* Shoulder-tap the server */
999  if (notify)
1000  {
1001  app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
1002  return app_worker_accept_notify (app_wrk, s);
1003  }
1004 
1005  return 0;
1006 }
1007 
1008 int
1009 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1010 {
1013  app_worker_t *app_wrk;
1014  session_handle_t sh;
1015  session_t *s;
1016  int rv;
1017 
1019  rv = transport_connect (rmt->transport_proto, tep);
1020  if (rv < 0)
1021  {
1022  SESSION_DBG ("Transport failed to open connection.");
1023  return VNET_API_ERROR_SESSION_CONNECT;
1024  }
1025 
1026  tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1027 
1028  /* For dgram type of service, allocate session and fifos now */
1029  app_wrk = app_worker_get (app_wrk_index);
1031  s->app_wrk_index = app_wrk->wrk_index;
1033  if (app_worker_init_connected (app_wrk, s))
1034  {
1035  session_free (s);
1036  return -1;
1037  }
1038 
1039  sh = session_handle (s);
1041  return app_worker_connect_notify (app_wrk, s, opaque);
1042 }
1043 
1044 int
1045 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1046 {
1049  u64 handle;
1050  int rv;
1051 
1053  rv = transport_connect (rmt->transport_proto, tep);
1054  if (rv < 0)
1055  {
1056  SESSION_DBG ("Transport failed to open connection.");
1057  return VNET_API_ERROR_SESSION_CONNECT;
1058  }
1059 
1060  tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1061 
1062  /* If transport offers a stream service, only allocate session once the
1063  * connection has been established.
1064  * Add connection to half-open table and save app and tc index. The
1065  * latter is needed to help establish the connection while the former
1066  * is needed when the connect notify comes and we have to notify the
1067  * external app
1068  */
1069  handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
1070  session_lookup_add_half_open (tc, handle);
1071 
1072  /* Store api_context (opaque) for when the reply comes. Not the nicest
1073  * thing but better than allocating a separate half-open pool.
1074  */
1075  tc->s_index = opaque;
1076  if (transport_half_open_has_fifos (rmt->transport_proto))
1077  return session_ho_stream_connect_notify (tc, 0 /* is_fail */ );
1078  return 0;
1079 }
1080 
1081 int
1082 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1083 {
1086 
1087  sep->app_wrk_index = app_wrk_index;
1088  sep->opaque = opaque;
1089 
1090  return transport_connect (rmt->transport_proto, tep_cfg);
1091 }
1092 
1094 
1095 /* *INDENT-OFF* */
1100 };
1101 /* *INDENT-ON* */
1102 
1103 /**
1104  * Ask transport to open connection to remote transport endpoint.
1105  *
1106  * Stores handle for matching request with reply since the call can be
1107  * asynchronous. For instance, for TCP the 3-way handshake must complete
1108  * before reply comes. Session is only created once connection is established.
1109  *
1110  * @param app_index Index of the application requesting the connect
1111  * @param st Session type requested.
1112  * @param tep Remote transport endpoint
1113  * @param opaque Opaque data (typically, api_context) the application expects
1114  * on open completion.
1115  */
1116 int
1117 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1118 {
1120  tst = transport_protocol_service_type (rmt->transport_proto);
1121  return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1122 }
1123 
1124 /**
1125  * Ask transport to listen on session endpoint.
1126  *
1127  * @param s Session for which listen will be called. Note that unlike
1128  * established sessions, listen sessions are not associated to a
1129  * thread.
1130  * @param sep Local endpoint to be listened on.
1131  */
1132 int
1134 {
1135  transport_endpoint_t *tep;
1136  u32 tc_index, s_index;
1137 
1138  /* Transport bind/listen */
1139  tep = session_endpoint_to_transport (sep);
1140  s_index = ls->session_index;
1142  s_index, tep);
1143 
1144  if (tc_index == (u32) ~ 0)
1145  return -1;
1146 
1147  /* Attach transport to session. Lookup tables are populated by the app
1148  * worker because local tables (for ct sessions) are not backed by a fib */
1149  ls = listen_session_get (s_index);
1150  ls->connection_index = tc_index;
1151 
1152  return 0;
1153 }
1154 
1155 /**
1156  * Ask transport to stop listening on local transport endpoint.
1157  *
1158  * @param s Session to stop listening on. It must be in state LISTENING.
1159  */
1160 int
1162 {
1165 
1167  return -1;
1168 
1170  if (!tc)
1171  return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1172 
1173  if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1176  return 0;
1177 }
1178 
1179 /**
1180  * Initialize session closing procedure.
1181  *
1182  * Request is always sent to session node to ensure that all outstanding
1183  * requests are served before transport is notified.
1184  */
1185 void
1187 {
1188  if (!s)
1189  return;
1190 
1192  {
1193  /* Session will only be removed once both app and transport
1194  * acknowledge the close */
1198  return;
1199  }
1200 
1203 }
1204 
1205 /**
1206  * Notify transport the session can be disconnected. This should eventually
1207  * result in a delete notification that allows us to cleanup session state.
1208  * Called for both active/passive disconnects.
1209  *
1210  * Must be called from the session's thread.
1211  */
1212 void
1214 {
1216  {
1219  /* If transport is already deleted, just free the session */
1222  return;
1223  }
1224 
1225  /* If the tx queue wasn't drained, the transport can continue to try
1226  * sending the outstanding data (in closed state it cannot). It MUST however
1227  * at one point, either after sending everything or after a timeout, call
1228  * delete notify. This will finally lead to the complete cleanup of the
1229  * session.
1230  */
1232 
1234  s->thread_index);
1235 }
1236 
1237 /**
1238  * Cleanup transport and session state.
1239  *
1240  * Notify transport of the cleanup and free the session. This should
1241  * be called only if transport reported some error and is already
1242  * closed.
1243  */
1244 void
1246 {
1248 
1249  /* Delete from main lookup table before we axe the the transport */
1252  s->thread_index);
1253  /* Since we called cleanup, no delete notification will come. So, make
1254  * sure the session is properly freed. */
1256 }
1257 
1258 /**
1259  * Allocate event queues in the shared-memory segment
1260  *
1261  * That can either be a newly created memfd segment, that will need to be
1262  * mapped by all stack users, or the binary api's svm region. The latter is
1263  * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1264  * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1265  * vpp uses api svm region for event queues.
1266  */
1267 void
1269 {
1270  u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1271  ssvm_private_t *eqs = &smm->evt_qs_segment;
1272  api_main_t *am = &api_main;
1273  uword eqs_size = 64 << 20;
1274  pid_t vpp_pid = getpid ();
1275  void *oldheap;
1276  int i;
1277 
1279  evt_q_length = smm->configured_event_queue_length;
1280 
1281  if (smm->evt_qs_use_memfd_seg)
1282  {
1283  if (smm->evt_qs_segment_size)
1284  eqs_size = smm->evt_qs_segment_size;
1285 
1286  eqs->ssvm_size = eqs_size;
1287  eqs->i_am_master = 1;
1288  eqs->my_pid = vpp_pid;
1289  eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1290  eqs->requested_va = smm->session_baseva;
1291 
1293  {
1294  clib_warning ("failed to initialize queue segment");
1295  return;
1296  }
1297  }
1298 
1299  if (smm->evt_qs_use_memfd_seg)
1300  oldheap = ssvm_push_heap (eqs->sh);
1301  else
1302  oldheap = svm_push_data_heap (am->vlib_rp);
1303 
1304  for (i = 0; i < vec_len (smm->wrk); i++)
1305  {
1306  svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1308  {evt_q_length, evt_size, 0}
1309  ,
1310  {evt_q_length >> 1, 256, 0}
1311  };
1312  cfg->consumer_pid = 0;
1313  cfg->n_rings = 2;
1314  cfg->q_nitems = evt_q_length;
1315  cfg->ring_cfgs = rc;
1316  smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1317  if (smm->evt_qs_use_memfd_seg)
1318  {
1320  clib_warning ("eventfd returned");
1321  }
1322  }
1323 
1324  if (smm->evt_qs_use_memfd_seg)
1325  ssvm_pop_heap (oldheap);
1326  else
1327  svm_pop_heap (oldheap);
1328 }
1329 
1332 {
1333  session_main_t *smm = &session_main;
1334  if (smm->evt_qs_use_memfd_seg)
1335  return &smm->evt_qs_segment;
1336  return 0;
1337 }
1338 
1339 u64
1341 {
1342  svm_fifo_t *f;
1343 
1344  if (!s->rx_fifo)
1345  return SESSION_INVALID_HANDLE;
1346 
1347  f = s->rx_fifo;
1348  return segment_manager_make_segment_handle (f->segment_manager,
1349  f->segment_index);
1350 }
1351 
1352 /* *INDENT-OFF* */
1357  session_tx_fifo_dequeue_and_snd
1358 };
1359 /* *INDENT-ON* */
1360 
1361 /**
1362  * Initialize session layer for given transport proto and ip version
1363  *
1364  * Allocates per session type (transport proto + ip version) data structures
1365  * and adds arc from session queue node to session type output node.
1366  */
1367 void
1369  const transport_proto_vft_t * vft, u8 is_ip4,
1370  u32 output_node)
1371 {
1372  session_main_t *smm = &session_main;
1373  session_type_t session_type;
1374  u32 next_index = ~0;
1375 
1376  session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1377 
1378  vec_validate (smm->session_type_to_next, session_type);
1379  vec_validate (smm->session_tx_fns, session_type);
1380 
1381  /* *INDENT-OFF* */
1382  if (output_node != ~0)
1383  {
1384  foreach_vlib_main (({
1385  next_index = vlib_node_add_next (this_vlib_main,
1386  session_queue_node.index,
1387  output_node);
1388  }));
1389  }
1390  /* *INDENT-ON* */
1391 
1392  smm->session_type_to_next[session_type] = next_index;
1393  smm->session_tx_fns[session_type] =
1394  session_tx_fns[vft->transport_options.tx_type];
1395 }
1396 
1399 {
1403  else
1405  s->connection_index);
1406 }
1407 
1408 void
1410 {
1413  s->connection_index, s->thread_index, tep,
1414  is_lcl);
1415  else
1417  s->connection_index, tep, is_lcl);
1418 }
1419 
1422 {
1424  s->connection_index);
1425 }
1426 
1427 void
1429 {
1430  ASSERT (vlib_get_thread_index () == 0);
1433 }
1434 
1435 static clib_error_t *
1437 {
1438  segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1439  session_main_t *smm = &session_main;
1441  u32 num_threads, preallocated_sessions_per_worker;
1442  session_worker_t *wrk;
1443  int i;
1444 
1445  num_threads = 1 /* main thread */ + vtm->n_threads;
1446 
1447  if (num_threads < 1)
1448  return clib_error_return (0, "n_thread_stacks not set");
1449 
1450  /* Allocate cache line aligned worker contexts */
1451  vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1452 
1453  for (i = 0; i < num_threads; i++)
1454  {
1455  wrk = &smm->wrk[i];
1456  wrk->ctrl_head = clib_llist_make_head (wrk->event_elts, evt_list);
1457  wrk->new_head = clib_llist_make_head (wrk->event_elts, evt_list);
1458  wrk->old_head = clib_llist_make_head (wrk->event_elts, evt_list);
1459  wrk->vm = vlib_mains[i];
1461 
1462  if (num_threads > 1)
1464  }
1465 
1466  /* Allocate vpp event queues segment and queue */
1468 
1469  /* Initialize fifo segment main baseva and timeout */
1470  sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1471  sm_args->size = smm->session_va_space_size;
1472  segment_manager_main_init (sm_args);
1473 
1474  /* Preallocate sessions */
1475  if (smm->preallocated_sessions)
1476  {
1477  if (num_threads == 1)
1478  {
1480  }
1481  else
1482  {
1483  int j;
1484  preallocated_sessions_per_worker =
1485  (1.1 * (f64) smm->preallocated_sessions /
1486  (f64) (num_threads - 1));
1487 
1488  for (j = 1; j < num_threads; j++)
1489  {
1490  pool_init_fixed (smm->wrk[j].sessions,
1491  preallocated_sessions_per_worker);
1492  }
1493  }
1494  }
1495 
1498  transport_init ();
1499 
1500  smm->is_enabled = 1;
1501 
1502  /* Enable transports */
1503  transport_enable_disable (vm, 1);
1505  return 0;
1506 }
1507 
1508 void
1510 {
1511  u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1513  u8 have_workers = vtm->n_threads != 0;
1514 
1515  /* *INDENT-OFF* */
1516  foreach_vlib_main (({
1517  if (have_workers && ii == 0)
1518  {
1519  vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1520  state);
1521  if (is_en)
1522  {
1523  vlib_node_t *n = vlib_get_node (this_vlib_main,
1525  vlib_start_process (this_vlib_main, n->runtime_index);
1526  }
1527  else
1528  {
1529  vlib_process_signal_event_mt (this_vlib_main,
1532  }
1533 
1534  continue;
1535  }
1536  vlib_node_set_state (this_vlib_main, session_queue_node.index,
1537  state);
1538  }));
1539  /* *INDENT-ON* */
1540 }
1541 
1542 clib_error_t *
1544 {
1545  clib_error_t *error = 0;
1546  if (is_en)
1547  {
1548  if (session_main.is_enabled)
1549  return 0;
1550 
1551  error = session_manager_main_enable (vm);
1553  }
1554  else
1555  {
1556  session_main.is_enabled = 0;
1558  }
1559 
1560  return error;
1561 }
1562 
1563 clib_error_t *
1565 {
1566  session_main_t *smm = &session_main;
1568 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1569  smm->session_va_space_size = 128ULL << 30;
1570  smm->evt_qs_segment_size = 64 << 20;
1571 #else
1572  smm->session_va_space_size = 128 << 20;
1573  smm->evt_qs_segment_size = 1 << 20;
1574 #endif
1575  smm->is_enabled = 0;
1576  return 0;
1577 }
1578 
1580 
1581 static clib_error_t *
1583 {
1584  session_main_t *smm = &session_main;
1585  u32 nitems;
1586  uword tmp;
1587 
1588  while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1589  {
1590  if (unformat (input, "event-queue-length %d", &nitems))
1591  {
1592  if (nitems >= 2048)
1593  smm->configured_event_queue_length = nitems;
1594  else
1595  clib_warning ("event queue length %d too small, ignored", nitems);
1596  }
1597  else if (unformat (input, "preallocated-sessions %d",
1598  &smm->preallocated_sessions))
1599  ;
1600  else if (unformat (input, "v4-session-table-buckets %d",
1602  ;
1603  else if (unformat (input, "v4-halfopen-table-buckets %d",
1605  ;
1606  else if (unformat (input, "v6-session-table-buckets %d",
1608  ;
1609  else if (unformat (input, "v6-halfopen-table-buckets %d",
1611  ;
1612  else if (unformat (input, "v4-session-table-memory %U",
1613  unformat_memory_size, &tmp))
1614  {
1615  if (tmp >= 0x100000000)
1616  return clib_error_return (0, "memory size %llx (%lld) too large",
1617  tmp, tmp);
1619  }
1620  else if (unformat (input, "v4-halfopen-table-memory %U",
1621  unformat_memory_size, &tmp))
1622  {
1623  if (tmp >= 0x100000000)
1624  return clib_error_return (0, "memory size %llx (%lld) too large",
1625  tmp, tmp);
1627  }
1628  else if (unformat (input, "v6-session-table-memory %U",
1629  unformat_memory_size, &tmp))
1630  {
1631  if (tmp >= 0x100000000)
1632  return clib_error_return (0, "memory size %llx (%lld) too large",
1633  tmp, tmp);
1635  }
1636  else if (unformat (input, "v6-halfopen-table-memory %U",
1637  unformat_memory_size, &tmp))
1638  {
1639  if (tmp >= 0x100000000)
1640  return clib_error_return (0, "memory size %llx (%lld) too large",
1641  tmp, tmp);
1643  }
1644  else if (unformat (input, "local-endpoints-table-memory %U",
1645  unformat_memory_size, &tmp))
1646  {
1647  if (tmp >= 0x100000000)
1648  return clib_error_return (0, "memory size %llx (%lld) too large",
1649  tmp, tmp);
1650  smm->local_endpoints_table_memory = tmp;
1651  }
1652  else if (unformat (input, "local-endpoints-table-buckets %d",
1654  ;
1655  else if (unformat (input, "evt_qs_memfd_seg"))
1656  smm->evt_qs_use_memfd_seg = 1;
1657  else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
1658  &smm->evt_qs_segment_size))
1659  ;
1660  else
1661  return clib_error_return (0, "unknown input `%U'",
1662  format_unformat_error, input);
1663  }
1664  return 0;
1665 }
1666 
1668 
1669 /*
1670  * fd.io coding-style-patch-verification: ON
1671  *
1672  * Local Variables:
1673  * eval: (c-set-style "gnu")
1674  * End:
1675  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:439
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:124
#define session_endpoint_to_transport_cfg(_sep)
Definition: session_types.h:90
u32 preallocated_sessions
Preallocate session config parameter.
Definition: session.h:177
int app_worker_lock_and_send_event(app_worker_t *app, session_t *s, u8 evt_type)
Send event to application.
void transport_close(transport_proto_t tp, u32 conn_index, u8 thread_index)
Definition: transport.c:322
u64 ssvm_size
Definition: ssvm.h:85
static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES]
Definition: session.c:1096
u32 connection_index
Index of the transport connection associated to the session.
uword evt_qs_segment_size
Definition: session.h:159
void session_flush_frames_main_thread(vlib_main_t *vm)
Definition: session.c:1428
int app_worker_init_accepted(session_t *s)
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.
int app_worker_reset_notify(app_worker_t *app_wrk, session_t *s)
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)
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:1117
static void svm_pop_heap(void *oldheap)
Definition: svm.h:94
session_type_t session_type
Type built from transport and network protocol types.
uword requested_va
Definition: ssvm.h:88
#define SESSION_Q_PROCESS_FLUSH_FRAMES
Definition: session.h:186
svm_msg_q_t * vpp_event_queue
vpp event message queue for worker
Definition: session.h:79
void transport_get_listener_endpoint(transport_proto_t tp, u32 conn_index, transport_endpoint_t *tep, u8 is_lcl)
Definition: transport.c:381
static u32 svm_fifo_max_enqueue_prod(svm_fifo_t *f)
Maximum number of bytes that can be enqueued into fifo.
Definition: svm_fifo.h:609
static void clib_rwlock_writer_lock(clib_rwlock_t *p)
Definition: lock.h:171
svm_fifo_t * tx_fifo
session_main_t session_main
Definition: session.c:26
int session_tx_fifo_peek_bytes(transport_connection_t *tc, u8 *buffer, u32 offset, u32 max_bytes)
Definition: session.c:475
u32 session_index
Index in thread pool where session was allocated.
int session_stop_listen(session_t *s)
Ask transport to stop listening on local transport endpoint.
Definition: session.c:1161
unsigned long u64
Definition: types.h:89
transport_connection_t * listen_session_get_transport(session_t *s)
Definition: session.c:1421
static svm_msg_q_t * session_main_get_vpp_event_queue(u32 thread_index)
Definition: session.h:554
u32 configured_v4_halfopen_table_buckets
Definition: session.h:165
int session_ho_stream_connect_notify(transport_connection_t *tc, u8 is_fail)
Definition: session.c:736
void session_transport_delete_notify(transport_connection_t *tc)
Notification from transport that connection is being deleted.
Definition: session.c:851
transport_connection_t * session_get_transport(session_t *s)
Definition: session.c:1398
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:258
svm_fifo_t * rx_fifo
Pointers to rx/tx buffers.
session_worker_t * wrk
Worker contexts.
Definition: session.h:130
static session_t * session_get_if_valid(u64 si, u32 thread_index)
Definition: session.h:265
void session_add_self_custom_tx_evt(transport_connection_t *tc, u8 has_prio)
Definition: session.c:122
#define pool_get_aligned_will_expand(P, YESNO, A)
See if pool_get will expand the pool or not.
Definition: pool.h:242
int session_enqueue_dgram_connection(session_t *s, session_dgram_hdr_t *hdr, vlib_buffer_t *b, u8 proto, u8 queue_event)
Definition: session.c:439
u16 current_length
Nbytes between current data and the end of this buffer.
Definition: buffer.h:113
static int session_enqueue_notify_inline(session_t *s)
Notify session peer that new data has been enqueued.
Definition: session.c:529
int session_main_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:631
session_evt_type_t
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:522
static transport_proto_t session_get_transport_proto(session_t *s)
void session_send_rpc_evt_to_thread(u32 thread_index, void *fp, void *rpc_args)
Definition: session.c:110
int svm_fifo_peek(svm_fifo_t *f, u32 offset, u32 len, u8 *dst)
Peek data from fifo.
Definition: svm_fifo.c:926
void session_transport_reset_notify(transport_connection_t *tc)
Notify application that connection has been reset.
Definition: session.c:951
int i
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:1045
void svm_fifo_dequeue_drop_all(svm_fifo_t *f)
Dequeue and drop all bytes from fifo.
Definition: svm_fifo.c:980
ssvm_shared_header_t * sh
Definition: ssvm.h:84
u32 transport_start_listen(transport_proto_t tp, u32 session_index, transport_endpoint_t *tep)
Definition: transport.c:328
static session_t * session_get(u32 si, u32 thread_index)
Definition: session.h:258
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
session_evt_elt_t * event_elts
Pool of session event list elements.
Definition: session.h:97
u8 data[128]
Definition: ipsec.api:249
#define vec_validate_aligned(V, I, A)
Make sure vector is long enough for given index (no header, specified alignment)
Definition: vec.h:450
u32 flags
Session flags.
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:386
u64 session_lookup_half_open_handle(transport_connection_t *tc)
static session_t * session_clone_safe(u32 session_index, u32 thread_index)
Definition: session.h:355
u32 local_endpoints_table_memory
Transport table (preallocation) size parameters.
Definition: session.h:173
void session_node_enable_disable(u8 is_en)
Definition: session.c:1509
vlib_node_registration_t session_queue_node
(constructor) VLIB_REGISTER_NODE (session_queue_node)
vlib_main_t ** vlib_mains
Definition: buffer.c:321
static uword vlib_node_add_next(vlib_main_t *vm, uword node, uword next_node)
Definition: node_funcs.h:1092
unsigned char u8
Definition: types.h:56
app_worker_t * application_get_worker(application_t *app, u32 wrk_map_index)
Definition: application.c:644
session_fifo_rx_fn session_tx_fifo_peek_and_snd
session_t * sessions
Worker session pool.
Definition: session.h:76
#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:1353
static session_handle_t session_handle(session_t *s)
struct _svm_fifo svm_fifo_t
void session_get_endpoint(session_t *s, transport_endpoint_t *tep, u8 is_lcl)
Definition: session.c:1409
u8 session_type_t
void session_transport_closing_notify(transport_connection_t *tc)
Notification from transport that connection is being closed.
Definition: session.c:829
u64 segment_manager_make_segment_handle(u32 segment_manager_index, u32 segment_index)
int session_open_cl(u32 app_wrk_index, session_endpoint_t *rmt, u32 opaque)
Definition: session.c:1009
#define clib_llist_make_head(LP, name)
Initialize llist head.
Definition: llist.h:106
static session_worker_t * session_main_get_worker(u32 thread_index)
Definition: session.h:548
void session_free_w_fifos(session_t *s)
Definition: session.c:219
#define session_endpoint_to_transport(_sep)
Definition: session_types.h:89
void app_namespaces_init(void)
vlib_main_t * vm
Convenience pointer to this worker&#39;s vlib_main.
Definition: session.h:85
static clib_error_t * session_config_fn(vlib_main_t *vm, unformat_input_t *input)
Definition: session.c:1582
svm_msg_q_t * svm_msg_q_alloc(svm_msg_q_cfg_t *cfg)
Allocate message queue.
Definition: message_queue.c:40
u8 transport_half_open_has_fifos(transport_proto_t tp)
Definition: transport.c:292
int session_send_ctrl_evt_to_thread(session_t *s, session_evt_type_t evt_type)
Definition: session.c:93
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:173
static void * svm_push_data_heap(svm_region_t *rp)
Definition: svm.h:86
void segment_manager_dealloc_fifos(svm_fifo_t *rx_fifo, svm_fifo_t *tx_fifo)
#define always_inline
Definition: clib.h:98
clib_llist_index_t new_head
Head of list of elements.
Definition: session.h:103
u32 * session_type_to_next
Per session type output nodes.
Definition: session.h:144
static int session_stream_connect_notify_inline(transport_connection_t *tc, u8 is_fail, session_state_t opened_state)
Definition: session.c:670
static int session_enqueue_chain_tail(session_t *s, vlib_buffer_t *b, u32 offset, u8 is_in_order)
Enqueue buffer chain tail.
Definition: session.c:299
static void * ssvm_push_heap(ssvm_shared_header_t *sh)
Definition: ssvm.h:143
#define clib_error_return(e, args...)
Definition: error.h:99
svm_region_t * vlib_rp
Current binary api segment descriptor.
Definition: api_common.h:256
uword session_baseva
Session ssvm segment configs.
Definition: session.h:157
vhost_vring_state_t state
Definition: vhost_user.h:146
unsigned int u32
Definition: types.h:88
int session_send_io_evt_to_thread(svm_fifo_t *f, session_evt_type_t evt_type)
Definition: session.c:79
int ssvm_master_init(ssvm_private_t *ssvm, ssvm_segment_type_t type)
Definition: ssvm.c:420
static void ssvm_pop_heap(void *oldheap)
Definition: ssvm.h:151
#define HALF_OPEN_LOOKUP_INVALID_VALUE
#define SESSION_INVALID_HANDLE
Definition: session_types.h:23
int session_lookup_del_half_open(transport_connection_t *tc)
session_state_t
static u32 vlib_get_buffer_index(vlib_main_t *vm, void *p)
Translate buffer pointer into buffer index.
Definition: buffer_funcs.h:257
static clib_error_t * session_manager_main_enable(vlib_main_t *vm)
Definition: session.c:1436
struct _transport_proto_vft transport_proto_vft_t
int session_dequeue_notify(session_t *s)
Definition: session.c:601
struct _session_endpoint_cfg session_endpoint_cfg_t
u32 configured_v6_halfopen_table_memory
Definition: session.h:170
u32 configured_v6_session_table_buckets
Definition: session.h:167
static session_type_t session_type_from_proto_and_ip(transport_proto_t proto, u8 is_ip4)
static void clib_rwlock_init(clib_rwlock_t *p)
Definition: lock.h:131
int svm_msg_q_alloc_consumer_eventfd(svm_msg_q_t *mq)
Allocate event fd for queue consumer.
session_event_t evt
Definition: session.h:68
transport_service_type_t transport_protocol_service_type(transport_proto_t tp)
Definition: transport.c:298
uword session_va_space_size
Definition: session.h:158
void session_send_rpc_evt_to_thread_force(u32 thread_index, void *fp, void *rpc_args)
Definition: session.c:102
u32 configured_v4_session_table_buckets
Session table size parameters.
Definition: session.h:163
void transport_get_endpoint(transport_proto_t tp, u32 conn_index, u32 thread_index, transport_endpoint_t *tep, u8 is_lcl)
Definition: transport.c:365
int app_worker_accept_notify(app_worker_t *app_wrk, session_t *s)
u32 app_index
Index of application that owns the listener.
struct _unformat_input_t unformat_input_t
u32 configured_v6_halfopen_table_buckets
Definition: session.h:169
u32 configured_event_queue_length
vpp fifo event queue configured length
Definition: session.h:154
u8 is_enabled
Session manager is enabled.
Definition: session.h:151
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:229
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:286
#define APP_INVALID_INDEX
Definition: application.h:167
int svm_fifo_enqueue(svm_fifo_t *f, u32 len, const u8 *src)
Enqueue data to fifo.
Definition: svm_fifo.c:807
enum transport_service_type_ transport_service_type_t
#define PREDICT_FALSE(x)
Definition: clib.h:111
#define VLIB_CONFIG_FUNCTION(x, n,...)
Definition: init.h:182
int session_lookup_del_session(session_t *s)
int( session_fifo_rx_fn)(session_worker_t *wrk, vlib_node_runtime_t *node, session_evt_elt_t *e, int *n_tx_packets)
Definition: session.h:117
u32 wrk_index
Worker index in global worker pool.
Definition: application.h:37
clib_error_t * session_manager_main_init(vlib_main_t *vm)
Definition: session.c:1564
app_worker_t * app_worker_get_if_valid(u32 wrk_index)
static u32 svm_fifo_max_dequeue_prod(svm_fifo_t *f)
Fifo max bytes to dequeue optimized for producer.
Definition: svm_fifo.h:503
session_fifo_rx_fn ** session_tx_fns
Per transport rx function that can either dequeue or peek.
Definition: session.h:139
u64 session_segment_handle(session_t *s)
Definition: session.c:1340
#define foreach_vlib_main(body)
Definition: threads.h:236
static session_evt_elt_t * session_evt_alloc_old(session_worker_t *wrk)
Definition: session.h:231
void transport_cleanup(transport_proto_t tp, u32 conn_index, u8 thread_index)
Definition: transport.c:310
clib_error_t * vnet_session_enable_disable(vlib_main_t *vm, u8 is_en)
Definition: session.c:1543
u32 transport_stop_listen(transport_proto_t tp, u32 conn_index)
Definition: transport.c:335
struct _session_switch_pool_args session_switch_pool_args_t
u8 len
Definition: ip_types.api:90
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:203
clib_rwlock_t peekers_rw_locks
Peekers rw lock.
Definition: session.h:109
#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
static u8 svm_fifo_set_event(svm_fifo_t *f)
Set fifo event flag.
Definition: svm_fifo.h:739
u32 n_rings
number of msg rings
Definition: message_queue.h:54
u8 evt_qs_use_memfd_seg
Definition: session.h:160
void transport_init(void)
Definition: transport.c:754
int app_worker_transport_closed_notify(app_worker_t *app_wrk, session_t *s)
session_fifo_rx_fn session_tx_fifo_dequeue_and_snd
ssvm_private_t evt_qs_segment
Event queues memfd segment initialized only if so configured.
Definition: session.h:133
static u8 svm_fifo_needs_deq_ntf(svm_fifo_t *f, u32 n_last_deq)
Check if fifo needs dequeue notification.
Definition: svm_fifo.h:830
#define UNFORMAT_END_OF_INPUT
Definition: format.h:145
u32 runtime_index
Definition: node.h:282
session_handle_t listener_handle
Parent listener session index if the result of an accept.
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:213
int transport_connect(transport_proto_t tp, transport_endpoint_cfg_t *tep)
Definition: transport.c:316
vlib_main_t * vm
Definition: buffer.c:312
static void svm_msg_q_unlock(svm_msg_q_t *mq)
Unlock message queue.
static transport_connection_t * transport_get_connection(transport_proto_t tp, u32 conn_index, u8 thread_index)
Definition: transport.h:111
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:958
static void session_cleanup_notify(session_t *s, session_cleanup_ntf_t ntf)
Definition: session.c:208
void session_free(session_t *s)
Definition: session.c:194
int app_worker_cleanup_notify(app_worker_t *app_wrk, session_t *s, session_cleanup_ntf_t ntf)
#define clib_warning(format, args...)
Definition: error.h:59
void transport_init_tx_pacers_period(void)
Initialize period for tx pacers.
Definition: transport.c:725
static int session_send_evt_to_thread(void *data, void *args, u32 thread_index, session_evt_type_t evt_type)
Definition: session.c:29
int session_dgram_connect_notify(transport_connection_t *tc, u32 old_thread_index, session_t **new_session)
Move dgram session to the right thread.
Definition: session.c:787
Don&#39;t register connection in lookup Does not apply to local apps and transports using the network lay...
struct _transport_connection transport_connection_t
#define HIGH_SEGMENT_BASEVA
Definition: svm_common.h:84
int app_worker_init_connected(app_worker_t *app_wrk, session_t *s)
static session_evt_elt_t * session_evt_alloc_new(session_worker_t *wrk)
Definition: session.h:221
u32 my_pid
Definition: ssvm.h:86
void transport_enable_disable(vlib_main_t *vm, u8 is_en)
Definition: transport.c:743
static u8 vlib_thread_is_main_w_barrier(void)
Definition: threads.h:512
#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:418
static u32 session_thread_from_handle(session_handle_t handle)
#define SESSION_Q_PROCESS_STOP
Definition: session.h:187
int session_listen(session_t *ls, session_endpoint_cfg_t *sep)
Ask transport to listen on session endpoint.
Definition: session.c:1133
static u32 session_index_from_handle(session_handle_t handle)
#define uword_to_pointer(u, type)
Definition: types.h:136
void session_vpp_event_queues_allocate(session_main_t *smm)
Allocate event queues in the shared-memory segment.
Definition: session.c:1268
static session_handle_t session_make_handle(u32 session_index, u32 thread_index)
#define ASSERT(truth)
static int session_notify_subscribers(u32 app_index, session_t *s, svm_fifo_t *f, session_evt_type_t evt_type)
Definition: session.c:497
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.
int session_main_flush_all_enqueue_events(u8 transport_proto)
Definition: session.c:660
void segment_manager_main_init(segment_manager_main_init_args_t *a)
static void clib_mem_free(void *p)
Definition: mem.h:226
enum _transport_proto transport_proto_t
static void svm_fifo_clear_deq_ntf(svm_fifo_t *f)
Clear the want notification flag and set has notification.
Definition: svm_fifo.h:797
int svm_fifo_enqueue_with_offset(svm_fifo_t *f, u32 offset, u32 len, u8 *src)
Enqueue a future segment.
Definition: svm_fifo.c:850
static void vlib_buffer_advance(vlib_buffer_t *b, word l)
Advance current data pointer by the supplied (signed!) amount.
Definition: buffer.h:248
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
u32 configured_v4_halfopen_table_memory
Definition: session.h:166
static session_t * session_alloc_for_connection(transport_connection_t *tc)
Definition: session.c:244
int app_worker_migrate_notify(app_worker_t *app_wrk, session_t *s, session_handle_t new_sh)
u32 configured_v4_session_table_memory
Definition: session.h:164
int session_stream_accept_notify(transport_connection_t *tc)
Definition: session.c:966
static void * clib_mem_alloc(uword size)
Definition: mem.h:153
void session_enqueue_notify_thread(session_handle_t sh)
Like session_enqueue_notify, but can be called from a thread that does not own the session...
Definition: session.c:586
static uword pointer_to_uword(const void *p)
Definition: types.h:131
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:87
u8 thread_index
Index of the thread that allocated the session.
session_t * session_alloc(u32 thread_index)
Definition: session.c:168
void session_transport_cleanup(session_t *s)
Cleanup transport and session state.
Definition: session.c:1245
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:268
template key/value backing page structure
Definition: bihash_doc.h:44
static void session_switch_pool(void *cb_args)
Notify old thread of the session pool switch.
Definition: session.c:754
static transport_connection_t * transport_get_half_open(transport_proto_t tp, u32 conn_index)
Definition: transport.h:124
u32 local_endpoints_table_buckets
Definition: session.h:174
app_worker_t * app_worker_get(u32 wrk_index)
u32 q_nitems
msg queue size (not rings)
Definition: message_queue.h:53
u64 session_handle_t
static void session_program_transport_close(session_t *s)
Definition: session.c:147
void session_lookup_init(void)
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
session_fifo_rx_fn session_tx_fifo_dequeue_internal
clib_llist_index_t old_head
Head of list of pending events.
Definition: session.h:106
u32 next_buffer
Next buffer for this linked-list of buffers.
Definition: buffer.h:140
volatile u8 session_state
State in session layer state machine.
int session_enqueue_notify(session_t *s)
Definition: session.c:563
void session_transport_closed_notify(transport_connection_t *tc)
Notification from transport that it is closed.
Definition: session.c:916
u32 * session_to_enqueue[TRANSPORT_N_PROTO]
Per-proto vector of sessions to enqueue.
Definition: session.h:88
void session_close(session_t *s)
Initialize session closing procedure.
Definition: session.c:1186
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
ssvm_private_t * session_main_get_evt_q_segment(void)
Definition: session.c:1331
session_cleanup_ntf_t
int session_send_io_evt_to_thread_custom(void *data, u32 thread_index, session_evt_type_t evt_type)
Definition: session.c:86
f64 last_vlib_time
vlib_time_now last time around the track
Definition: session.h:82
unformat_function_t unformat_memory_size
Definition: format.h:296
static session_evt_elt_t * session_evt_alloc_ctrl(session_worker_t *wrk)
Definition: session.h:211
u32 app_index
Index of owning app.
Definition: application.h:43
static u8 svm_fifo_n_subscribers(svm_fifo_t *f)
Definition: svm_fifo.h:671
int session_lookup_add_connection(transport_connection_t *tc, u64 value)
Add transport connection to a session table.
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
u32 configured_v6_session_table_memory
Definition: session.h:168
int session_stream_connect_notify(transport_connection_t *tc, u8 is_fail)
Definition: session.c:729
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:367
static vlib_node_t * vlib_get_node(vlib_main_t *vm, u32 i)
Get vlib node by index.
Definition: node_funcs.h:59
int(* session_open_service_fn)(u32, session_endpoint_t *, u32)
Definition: session.c:1093
u32 app_wrk_index
Index of the app worker that owns the session.
u32 session_tx_fifo_dequeue_drop(transport_connection_t *tc, u32 max_bytes)
Definition: session.c:483
static void session_delete(session_t *s)
Cleans up session and lookup table.
Definition: session.c:232
void session_transport_close(session_t *s)
Notify transport the session can be disconnected.
Definition: session.c:1213
clib_llist_index_t ctrl_head
Head of control events list.
Definition: session.h:100
int app_worker_close_notify(app_worker_t *app_wrk, session_t *s)
struct _session_endpoint session_endpoint_t
int session_stream_accept(transport_connection_t *tc, u32 listener_index, u32 thread_index, u8 notify)
Accept a stream session.
Definition: session.c:983
int consumer_pid
pid of msg consumer
Definition: message_queue.h:52
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
static transport_connection_t * transport_get_listener(transport_proto_t tp, u32 conn_index)
Definition: transport.h:118
u32 total_length_not_including_first_buffer
Only valid for first buffer in chain.
Definition: buffer.h:167
int svm_fifo_dequeue_drop(svm_fifo_t *f, u32 len)
Dequeue and drop bytes from fifo.
Definition: svm_fifo.c:948
static int svm_msg_q_lock(svm_msg_q_t *mq)
Lock, or block trying, the message queue.
static void session_enqueue_notify_rpc(void *arg)
Definition: session.c:569
int session_open_app(u32 app_wrk_index, session_endpoint_t *rmt, u32 opaque)
Definition: session.c:1082
void vlib_start_process(vlib_main_t *vm, uword process_index)
Definition: main.c:1583
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:1368
int session_lookup_add_half_open(transport_connection_t *tc, u64 value)
api_main_t api_main
Definition: api_shared.c:35
u8 transport_protocol_is_cl(transport_proto_t tp)
Definition: transport.c:341
int app_worker_connect_notify(app_worker_t *app_wrk, session_t *s, u32 opaque)
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:85
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.
#define SESSION_EVT(_evt, _args...)
int i_am_master
Definition: ssvm.h:89
static session_t * listen_session_get(u32 ls_index)
Definition: session.h:524
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:978
vl_api_fib_path_nh_proto_t proto
Definition: fib_types.api:125
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:171