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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * @brief Session and session manager
20 #include <vnet/session/session.h>
21 #include <vnet/session/session_debug.h>
22 #include <vnet/session/application.h>
23 #include <vlibmemory/api.h>
24 #include <vnet/dpo/load_balance.h>
25 #include <vnet/fib/ip4_fib.h>
27 session_manager_main_t session_manager_main;
28 extern transport_proto_vft_t *tp_vfts;
31 session_send_evt_to_thread (u64 session_handle, fifo_event_type_t evt_type,
32 u32 thread_index, void *fp, void *rpc_args)
34 session_fifo_event_t evt = { {0}, };
36 u32 tries = 0, max_tries;
38 evt.event_type = evt_type;
39 if (evt_type == FIFO_EVENT_RPC)
42 evt.rpc_args.arg = rpc_args;
45 evt.session_handle = session_handle;
47 q = session_manager_get_vpp_event_queue (thread_index);
48 while (svm_queue_add (q, (u8 *) & evt, 1))
50 max_tries = vlib_get_current_process (vlib_get_main ())? 1e6 : 3;
51 if (tries++ == max_tries)
53 SESSION_DBG ("failed to enqueue evt");
60 session_send_session_evt_to_thread (u64 session_handle,
61 fifo_event_type_t evt_type,
64 session_send_evt_to_thread (session_handle, evt_type, thread_index, 0, 0);
68 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
70 if (thread_index != vlib_get_thread_index ())
71 session_send_evt_to_thread (0, FIFO_EVENT_RPC, thread_index, fp,
75 void (*fnp) (void *) = fp;
81 session_alloc (u32 thread_index)
83 session_manager_main_t *smm = &session_manager_main;
86 pool_get_aligned_will_expand (smm->sessions[thread_index], will_expand,
87 CLIB_CACHE_LINE_BYTES);
88 /* If we have peekers, let them finish */
89 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
91 clib_rwlock_writer_lock (&smm->peekers_rw_locks[thread_index]);
92 pool_get_aligned (session_manager_main.sessions[thread_index], s,
93 CLIB_CACHE_LINE_BYTES);
94 clib_rwlock_writer_unlock (&smm->peekers_rw_locks[thread_index]);
98 pool_get_aligned (session_manager_main.sessions[thread_index], s,
99 CLIB_CACHE_LINE_BYTES);
101 memset (s, 0, sizeof (*s));
102 s->session_index = s - session_manager_main.sessions[thread_index];
103 s->thread_index = thread_index;
108 session_free (stream_session_t * s)
110 pool_put (session_manager_main.sessions[s->thread_index], s);
112 memset (s, 0xFA, sizeof (*s));
116 session_alloc_fifos (segment_manager_t * sm, stream_session_t * s)
118 svm_fifo_t *server_rx_fifo = 0, *server_tx_fifo = 0;
119 u32 fifo_segment_index;
122 if ((rv = segment_manager_alloc_session_fifos (sm, &server_rx_fifo,
124 &fifo_segment_index)))
126 /* Initialize backpointers */
127 server_rx_fifo->master_session_index = s->session_index;
128 server_rx_fifo->master_thread_index = s->thread_index;
130 server_tx_fifo->master_session_index = s->session_index;
131 server_tx_fifo->master_thread_index = s->thread_index;
133 s->server_rx_fifo = server_rx_fifo;
134 s->server_tx_fifo = server_tx_fifo;
135 s->svm_segment_index = fifo_segment_index;
139 static stream_session_t *
140 session_alloc_for_connection (transport_connection_t * tc)
143 u32 thread_index = tc->thread_index;
145 ASSERT (thread_index == vlib_get_thread_index ());
147 s = session_alloc (thread_index);
148 s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
149 s->session_state = SESSION_STATE_CONNECTING;
150 s->enqueue_epoch = ~0;
152 /* Attach transport to session and vice versa */
153 s->connection_index = tc->c_index;
154 tc->s_index = s->session_index;
159 session_alloc_and_init (segment_manager_t * sm, transport_connection_t * tc,
160 u8 alloc_fifos, stream_session_t ** ret_s)
165 s = session_alloc_for_connection (tc);
166 if (alloc_fifos && (rv = session_alloc_fifos (sm, s)))
173 /* Add to the main lookup table */
174 session_lookup_add_connection (tc, session_handle (s));
181 * Discards bytes from buffer chain
183 * It discards n_bytes_to_drop starting at first buffer after chain_b
186 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
187 vlib_buffer_t ** chain_b,
190 vlib_buffer_t *next = *chain_b;
191 u32 to_drop = n_bytes_to_drop;
192 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
193 while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
195 next = vlib_get_buffer (vm, next->next_buffer);
196 if (next->current_length > to_drop)
198 vlib_buffer_advance (next, to_drop);
203 to_drop -= next->current_length;
204 next->current_length = 0;
210 b->total_length_not_including_first_buffer -= n_bytes_to_drop;
214 * Enqueue buffer chain tail
217 session_enqueue_chain_tail (stream_session_t * s, vlib_buffer_t * b,
218 u32 offset, u8 is_in_order)
220 vlib_buffer_t *chain_b;
221 u32 chain_bi, len, diff;
222 vlib_main_t *vm = vlib_get_main ();
227 if (is_in_order && offset)
229 diff = offset - b->current_length;
230 if (diff > b->total_length_not_including_first_buffer)
233 session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
234 chain_bi = vlib_get_buffer_index (vm, chain_b);
237 chain_bi = b->next_buffer;
241 chain_b = vlib_get_buffer (vm, chain_bi);
242 data = vlib_buffer_get_current (chain_b);
243 len = chain_b->current_length;
248 rv = svm_fifo_enqueue_nowait (s->server_rx_fifo, len, data);
255 return (rv > 0) ? (written + rv) : written;
261 /* written more than what was left in chain */
262 if (written > b->total_length_not_including_first_buffer)
265 /* drop the bytes that have already been delivered */
266 session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
271 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset, len,
275 clib_warning ("failed to enqueue multi-buffer seg");
281 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
282 ? chain_b->next_buffer : 0));
291 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
292 * event but on request can queue notification events for later delivery by
293 * calling stream_server_flush_enqueue_events().
295 * @param tc Transport connection which is to be enqueued data
296 * @param b Buffer to be enqueued
297 * @param offset Offset at which to start enqueueing if out-of-order
298 * @param queue_event Flag to indicate if peer is to be notified or if event
299 * is to be queued. The former is useful when more data is
300 * enqueued and only one event is to be generated.
301 * @param is_in_order Flag to indicate if data is in order
302 * @return Number of bytes enqueued or a negative value if enqueueing failed.
305 session_enqueue_stream_connection (transport_connection_t * tc,
306 vlib_buffer_t * b, u32 offset,
307 u8 queue_event, u8 is_in_order)
310 int enqueued = 0, rv, in_order_off;
312 s = session_get (tc->s_index, tc->thread_index);
316 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo,
318 vlib_buffer_get_current (b));
319 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
322 in_order_off = enqueued > b->current_length ? enqueued : 0;
323 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
330 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset,
332 vlib_buffer_get_current (b));
333 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
334 session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
335 /* if something was enqueued, report even this as success for ooo
336 * segment handling */
342 /* Queue RX event on this fifo. Eventually these will need to be flushed
343 * by calling stream_server_flush_enqueue_events () */
344 session_manager_main_t *smm = vnet_get_session_manager_main ();
345 u32 thread_index = s->thread_index;
346 u32 enqueue_epoch = smm->current_enqueue_epoch[tc->proto][thread_index];
348 if (s->enqueue_epoch != enqueue_epoch)
350 s->enqueue_epoch = enqueue_epoch;
351 vec_add1 (smm->session_to_enqueue[tc->proto][thread_index],
352 s - smm->sessions[thread_index]);
361 session_enqueue_dgram_connection (stream_session_t * s,
362 session_dgram_hdr_t * hdr,
363 vlib_buffer_t * b, u8 proto, u8 queue_event)
365 int enqueued = 0, rv, in_order_off;
367 ASSERT (svm_fifo_max_enqueue (s->server_rx_fifo)
368 >= b->current_length + sizeof (*hdr));
370 svm_fifo_enqueue_nowait (s->server_rx_fifo, sizeof (session_dgram_hdr_t),
372 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo, b->current_length,
373 vlib_buffer_get_current (b));
374 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
376 in_order_off = enqueued > b->current_length ? enqueued : 0;
377 rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
383 /* Queue RX event on this fifo. Eventually these will need to be flushed
384 * by calling stream_server_flush_enqueue_events () */
385 session_manager_main_t *smm = vnet_get_session_manager_main ();
386 u32 thread_index = s->thread_index;
387 u32 enqueue_epoch = smm->current_enqueue_epoch[proto][thread_index];
389 if (s->enqueue_epoch != enqueue_epoch)
391 s->enqueue_epoch = enqueue_epoch;
392 vec_add1 (smm->session_to_enqueue[proto][thread_index],
393 s - smm->sessions[thread_index]);
399 /** Check if we have space in rx fifo to push more bytes */
401 stream_session_no_space (transport_connection_t * tc, u32 thread_index,
404 stream_session_t *s = session_get (tc->s_index, thread_index);
406 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
409 if (data_len > svm_fifo_max_enqueue (s->server_rx_fifo))
416 stream_session_tx_fifo_max_dequeue (transport_connection_t * tc)
418 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
419 if (!s->server_tx_fifo)
421 return svm_fifo_max_dequeue (s->server_tx_fifo);
425 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
426 u32 offset, u32 max_bytes)
428 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
429 return svm_fifo_peek (s->server_tx_fifo, offset, max_bytes, buffer);
433 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
435 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
436 return svm_fifo_dequeue_drop (s->server_tx_fifo, max_bytes);
440 * Notify session peer that new data has been enqueued.
442 * @param s Stream session for which the event is to be generated.
443 * @param block Flag to indicate if call should block if event queue is full.
445 * @return 0 on succes or negative number if failed to send notification.
448 session_enqueue_notify (stream_session_t * s, u8 block)
451 session_fifo_event_t evt;
454 if (PREDICT_FALSE (s->session_state >= SESSION_STATE_CLOSING))
456 /* Session is closed so app will never clean up. Flush rx fifo */
457 u32 to_dequeue = svm_fifo_max_dequeue (s->server_rx_fifo);
459 svm_fifo_dequeue_drop (s->server_rx_fifo, to_dequeue);
463 /* Get session's server */
464 app = application_get_if_valid (s->app_index);
466 if (PREDICT_FALSE (app == 0))
468 clib_warning ("invalid s->app_index = %d", s->app_index);
472 /* Built-in app? Hand event to the callback... */
473 if (app->cb_fns.builtin_app_rx_callback)
474 return app->cb_fns.builtin_app_rx_callback (s);
476 /* If no event, send one */
477 if (svm_fifo_set_event (s->server_rx_fifo))
479 /* Fabricate event */
480 evt.fifo = s->server_rx_fifo;
481 evt.event_type = FIFO_EVENT_APP_RX;
483 /* Add event to server's event queue */
484 q = app->event_queue;
486 /* Based on request block (or not) for lack of space */
487 if (block || PREDICT_TRUE (q->cursize < q->maxsize))
488 svm_queue_add (app->event_queue, (u8 *) & evt,
489 0 /* do wait for mutex */ );
492 clib_warning ("fifo full");
498 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
499 ed->data[0] = evt.event_type;
500 ed->data[1] = svm_fifo_max_dequeue (s->server_rx_fifo);
508 * Flushes queue of sessions that are to be notified of new data
511 * @param thread_index Thread index for which the flush is to be performed.
512 * @return 0 on success or a positive number indicating the number of
513 * failures due to API queue being full.
516 session_manager_flush_enqueue_events (u8 transport_proto, u32 thread_index)
518 session_manager_main_t *smm = &session_manager_main;
523 indices = smm->session_to_enqueue[transport_proto][thread_index];
525 for (i = 0; i < vec_len (indices); i++)
527 s = session_get_if_valid (indices[i], thread_index);
528 if (s == 0 || session_enqueue_notify (s, 0 /* don't block */ ))
532 vec_reset_length (indices);
533 smm->session_to_enqueue[transport_proto][thread_index] = indices;
534 smm->current_enqueue_epoch[transport_proto][thread_index]++;
540 session_manager_flush_all_enqueue_events (u8 transport_proto)
542 vlib_thread_main_t *vtm = vlib_get_thread_main ();
544 for (i = 0; i < 1 + vtm->n_threads; i++)
545 errors += session_manager_flush_enqueue_events (transport_proto, i);
550 * Init fifo tail and head pointers
552 * Useful if transport uses absolute offsets for tracking ooo segments.
555 stream_session_init_fifos_pointers (transport_connection_t * tc,
556 u32 rx_pointer, u32 tx_pointer)
559 s = session_get (tc->s_index, tc->thread_index);
560 svm_fifo_init_pointers (s->server_rx_fifo, rx_pointer);
561 svm_fifo_init_pointers (s->server_tx_fifo, tx_pointer);
565 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
567 u32 opaque = 0, new_ti, new_si;
568 stream_session_t *new_s = 0;
569 segment_manager_t *sm;
576 * Find connection handle and cleanup half-open table
578 handle = session_lookup_half_open_handle (tc);
579 if (handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
581 SESSION_DBG ("half-open was removed!");
584 session_lookup_del_half_open (tc);
586 /* Get the app's index from the handle we stored when opening connection
587 * and the opaque (api_context for external apps) from transport session
589 app = application_get_if_valid (handle >> 32);
592 opaque = tc->s_index;
595 * Allocate new session with fifos (svm segments are allocated if needed)
599 sm = application_get_connect_segment_manager (app);
600 alloc_fifos = !application_is_builtin_proxy (app);
601 if (session_alloc_and_init (sm, tc, alloc_fifos, &new_s))
608 new_s->app_index = app->index;
609 new_si = new_s->session_index;
610 new_ti = new_s->thread_index;
615 * Notify client application
617 if (app->cb_fns.session_connected_callback (app->index, opaque, new_s,
620 SESSION_DBG ("failed to notify app");
623 new_s = session_get (new_si, new_ti);
624 stream_session_disconnect_transport (new_s);
631 new_s = session_get (new_si, new_ti);
632 new_s->session_state = SESSION_STATE_READY;
639 typedef struct _session_switch_pool_args
643 u32 new_thread_index;
644 u32 new_session_index;
645 } session_switch_pool_args_t;
648 session_switch_pool (void *cb_args)
650 session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
651 transport_proto_t tp;
653 ASSERT (args->thread_index == vlib_get_thread_index ());
654 s = session_get (args->session_index, args->thread_index);
655 s->server_tx_fifo->master_session_index = args->new_session_index;
656 s->server_tx_fifo->master_thread_index = args->new_thread_index;
657 tp = session_get_transport_proto (s);
658 tp_vfts[tp].cleanup (s->connection_index, s->thread_index);
660 clib_mem_free (cb_args);
664 * Move dgram session to the right thread
667 session_dgram_connect_notify (transport_connection_t * tc,
668 u32 old_thread_index,
669 stream_session_t ** new_session)
671 stream_session_t *new_s;
672 session_switch_pool_args_t *rpc_args;
675 * Clone half-open session to the right thread.
677 new_s = session_clone_safe (tc->s_index, old_thread_index);
678 new_s->connection_index = tc->c_index;
679 new_s->server_rx_fifo->master_session_index = new_s->session_index;
680 new_s->server_rx_fifo->master_thread_index = new_s->thread_index;
681 new_s->session_state = SESSION_STATE_READY;
682 session_lookup_add_connection (tc, session_handle (new_s));
685 * Ask thread owning the old session to clean it up and make us the tx
688 rpc_args = clib_mem_alloc (sizeof (*rpc_args));
689 rpc_args->new_session_index = new_s->session_index;
690 rpc_args->new_thread_index = new_s->thread_index;
691 rpc_args->session_index = tc->s_index;
692 rpc_args->thread_index = old_thread_index;
693 session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
696 tc->s_index = new_s->session_index;
697 new_s->connection_index = tc->c_index;
698 *new_session = new_s;
703 stream_session_accept_notify (transport_connection_t * tc)
705 application_t *server;
708 s = session_get (tc->s_index, tc->thread_index);
709 server = application_get (s->app_index);
710 server->cb_fns.session_accept_callback (s);
714 * Notification from transport that connection is being closed.
716 * A disconnect is sent to application but state is not removed. Once
717 * disconnect is acknowledged by application, session disconnect is called.
718 * Ultimately this leads to close being called on transport (passive close).
721 stream_session_disconnect_notify (transport_connection_t * tc)
723 application_t *server;
726 s = session_get (tc->s_index, tc->thread_index);
727 server = application_get (s->app_index);
728 server->cb_fns.session_disconnect_callback (s);
732 * Cleans up session and lookup table.
735 stream_session_delete (stream_session_t * s)
739 /* Delete from the main lookup table. */
740 if ((rv = session_lookup_del_session (s)))
741 clib_warning ("hash delete error, rv %d", rv);
743 /* Cleanup fifo segments */
744 segment_manager_dealloc_fifos (s->svm_segment_index, s->server_rx_fifo,
750 * Notification from transport that connection is being deleted
752 * This removes the session if it is still valid. It should be called only on
753 * previously fully established sessions. For instance failed connects should
754 * call stream_session_connect_notify and indicate that the connect has
758 stream_session_delete_notify (transport_connection_t * tc)
762 /* App might've been removed already */
763 s = session_get_if_valid (tc->s_index, tc->thread_index);
766 stream_session_delete (s);
770 * Notify application that connection has been reset.
773 stream_session_reset_notify (transport_connection_t * tc)
777 s = session_get (tc->s_index, tc->thread_index);
778 s->session_state = SESSION_STATE_CLOSED;
779 app = application_get (s->app_index);
780 app->cb_fns.session_reset_callback (s);
784 * Accept a stream session. Optionally ping the server by callback.
787 stream_session_accept (transport_connection_t * tc, u32 listener_index,
790 application_t *server;
791 stream_session_t *s, *listener;
792 segment_manager_t *sm;
795 /* Find the server */
796 listener = listen_session_get (listener_index);
797 server = application_get (listener->app_index);
799 sm = application_get_listen_segment_manager (server, listener);
800 if ((rv = session_alloc_and_init (sm, tc, 1, &s)))
803 s->app_index = server->index;
804 s->listener_index = listener_index;
805 s->session_state = SESSION_STATE_ACCEPTING;
807 /* Shoulder-tap the server */
810 server->cb_fns.session_accept_callback (s);
817 session_open_cl (u32 app_index, session_endpoint_t * rmt, u32 opaque)
819 transport_connection_t *tc;
820 transport_endpoint_t *tep;
821 segment_manager_t *sm;
826 tep = session_endpoint_to_transport (rmt);
827 rv = tp_vfts[rmt->transport_proto].open (tep);
830 SESSION_DBG ("Transport failed to open connection.");
831 return VNET_API_ERROR_SESSION_CONNECT;
834 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
836 /* For dgram type of service, allocate session and fifos now.
838 app = application_get (app_index);
839 sm = application_get_connect_segment_manager (app);
841 if (session_alloc_and_init (sm, tc, 1, &s))
843 s->app_index = app->index;
844 s->session_state = SESSION_STATE_OPENED;
846 /* Tell the app about the new event fifo for this session */
847 app->cb_fns.session_connected_callback (app->index, opaque, s, 0);
853 session_open_vc (u32 app_index, session_endpoint_t * rmt, u32 opaque)
855 transport_connection_t *tc;
856 transport_endpoint_t *tep;
860 tep = session_endpoint_to_transport (rmt);
861 rv = tp_vfts[rmt->transport_proto].open (tep);
864 SESSION_DBG ("Transport failed to open connection.");
865 return VNET_API_ERROR_SESSION_CONNECT;
868 tc = tp_vfts[rmt->transport_proto].get_half_open ((u32) rv);
870 /* If transport offers a stream service, only allocate session once the
871 * connection has been established.
872 * Add connection to half-open table and save app and tc index. The
873 * latter is needed to help establish the connection while the former
874 * is needed when the connect notify comes and we have to notify the
877 handle = (((u64) app_index) << 32) | (u64) tc->c_index;
878 session_lookup_add_half_open (tc, handle);
880 /* Store api_context (opaque) for when the reply comes. Not the nicest
881 * thing but better than allocating a separate half-open pool.
883 tc->s_index = opaque;
888 session_open_app (u32 app_index, session_endpoint_t * rmt, u32 opaque)
890 session_endpoint_extended_t *sep = (session_endpoint_extended_t *) rmt;
891 sep->app_index = app_index;
892 sep->opaque = opaque;
894 return tp_vfts[rmt->transport_proto].open ((transport_endpoint_t *) sep);
897 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
900 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
908 * Ask transport to open connection to remote transport endpoint.
910 * Stores handle for matching request with reply since the call can be
911 * asynchronous. For instance, for TCP the 3-way handshake must complete
912 * before reply comes. Session is only created once connection is established.
914 * @param app_index Index of the application requesting the connect
915 * @param st Session type requested.
916 * @param tep Remote transport endpoint
917 * @param opaque Opaque data (typically, api_context) the application expects
918 * on open completion.
921 session_open (u32 app_index, session_endpoint_t * rmt, u32 opaque)
923 transport_service_type_t tst = tp_vfts[rmt->transport_proto].service_type;
924 return session_open_srv_fns[tst] (app_index, rmt, opaque);
928 session_listen_vc (stream_session_t * s, session_endpoint_t * sep)
930 transport_connection_t *tc;
933 /* Transport bind/listen */
934 tci = tp_vfts[sep->transport_proto].bind (s->session_index,
935 session_endpoint_to_transport
938 if (tci == (u32) ~ 0)
941 /* Attach transport to session */
942 s->connection_index = tci;
943 tc = tp_vfts[sep->transport_proto].get_listener (tci);
945 /* Weird but handle it ... */
949 /* Add to the main lookup table */
950 session_lookup_add_connection (tc, s->session_index);
955 session_listen_cl (stream_session_t * s, session_endpoint_t * sep)
957 transport_connection_t *tc;
958 application_t *server;
959 segment_manager_t *sm;
962 /* Transport bind/listen */
963 tci = tp_vfts[sep->transport_proto].bind (s->session_index,
964 session_endpoint_to_transport
967 if (tci == (u32) ~ 0)
970 /* Attach transport to session */
971 s->connection_index = tci;
972 tc = tp_vfts[sep->transport_proto].get_listener (tci);
974 /* Weird but handle it ... */
978 server = application_get (s->app_index);
979 sm = application_get_listen_segment_manager (server, s);
980 if (session_alloc_fifos (sm, s))
983 /* Add to the main lookup table */
984 session_lookup_add_connection (tc, s->session_index);
989 session_listen_app (stream_session_t * s, session_endpoint_t * sep)
991 session_endpoint_extended_t esep;
992 clib_memcpy (&esep, sep, sizeof (*sep));
993 esep.app_index = s->app_index;
995 return tp_vfts[sep->transport_proto].bind (s->session_index,
996 (transport_endpoint_t *) & esep);
999 typedef int (*session_listen_service_fn) (stream_session_t *,
1000 session_endpoint_t *);
1003 static session_listen_service_fn
1004 session_listen_srv_fns[TRANSPORT_N_SERVICES] = {
1012 * Ask transport to listen on local transport endpoint.
1014 * @param s Session for which listen will be called. Note that unlike
1015 * established sessions, listen sessions are not associated to a
1017 * @param tep Local endpoint to be listened on.
1020 stream_session_listen (stream_session_t * s, session_endpoint_t * sep)
1022 transport_service_type_t tst = tp_vfts[sep->transport_proto].service_type;
1023 return session_listen_srv_fns[tst] (s, sep);
1027 * Ask transport to stop listening on local transport endpoint.
1029 * @param s Session to stop listening on. It must be in state LISTENING.
1032 stream_session_stop_listen (stream_session_t * s)
1034 transport_proto_t tp = session_get_transport_proto (s);
1035 transport_connection_t *tc;
1036 if (s->session_state != SESSION_STATE_LISTENING)
1038 clib_warning ("not a listening session");
1042 tc = tp_vfts[tp].get_listener (s->connection_index);
1045 clib_warning ("no transport");
1046 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1049 session_lookup_del_connection (tc);
1050 tp_vfts[tp].unbind (s->connection_index);
1055 * Initialize session disconnect.
1057 * Request is always sent to session node to ensure that all outstanding
1058 * requests are served before transport is notified.
1061 stream_session_disconnect (stream_session_t * s)
1063 u32 thread_index = vlib_get_thread_index ();
1064 session_manager_main_t *smm = &session_manager_main;
1065 session_fifo_event_t *evt;
1067 if (!s || s->session_state >= SESSION_STATE_CLOSING)
1069 s->session_state = SESSION_STATE_CLOSING;
1071 /* If we are in the handler thread, or being called with the worker barrier
1072 * held (api/cli), just append a new event pending disconnects vector. */
1073 if (thread_index > 0 || !vlib_get_current_process (vlib_get_main ()))
1075 ASSERT (s->thread_index == thread_index || thread_index == 0);
1076 vec_add2 (smm->pending_disconnects[s->thread_index], evt, 1);
1077 memset (evt, 0, sizeof (*evt));
1078 evt->session_handle = session_handle (s);
1079 evt->event_type = FIFO_EVENT_DISCONNECT;
1082 session_send_session_evt_to_thread (session_handle (s),
1083 FIFO_EVENT_DISCONNECT,
1088 * Notify transport the session can be disconnected. This should eventually
1089 * result in a delete notification that allows us to cleanup session state.
1090 * Called for both active/passive disconnects.
1092 * Must be called from the session's thread.
1095 stream_session_disconnect_transport (stream_session_t * s)
1097 s->session_state = SESSION_STATE_CLOSED;
1098 tp_vfts[session_get_transport_proto (s)].close (s->connection_index,
1103 * Cleanup transport and session state.
1105 * Notify transport of the cleanup, wait for a delete notify to actually
1106 * remove the session state.
1109 stream_session_cleanup (stream_session_t * s)
1113 s->session_state = SESSION_STATE_CLOSED;
1115 /* Delete from the main lookup table to avoid more enqueues */
1116 rv = session_lookup_del_session (s);
1118 clib_warning ("hash delete error, rv %d", rv);
1120 tp_vfts[session_get_transport_proto (s)].cleanup (s->connection_index,
1124 transport_service_type_t
1125 session_transport_service_type (stream_session_t * s)
1127 transport_proto_t tp;
1128 tp = session_get_transport_proto (s);
1129 return transport_protocol_service_type (tp);
1132 transport_tx_fn_type_t
1133 session_transport_tx_fn_type (stream_session_t * s)
1135 transport_proto_t tp;
1136 tp = session_get_transport_proto (s);
1137 return transport_protocol_tx_fn_type (tp);
1141 session_tx_is_dgram (stream_session_t * s)
1143 return (session_transport_tx_fn_type (s) == TRANSPORT_TX_DGRAM);
1147 * Allocate event queues in the shared-memory segment
1149 * That can either be a newly created memfd segment, that will need to be
1150 * mapped by all stack users, or the binary api's svm region. The latter is
1151 * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1152 * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1153 * vpp uses api svm region for event queues.
1156 session_vpp_event_queues_allocate (session_manager_main_t * smm)
1158 u32 evt_q_length = 2048, evt_size = sizeof (session_fifo_event_t);
1159 ssvm_private_t *eqs = &smm->evt_qs_segment;
1160 api_main_t *am = &api_main;
1161 u64 eqs_size = 64 << 20;
1162 pid_t vpp_pid = getpid ();
1166 if (smm->configured_event_queue_length)
1167 evt_q_length = smm->configured_event_queue_length;
1169 if (smm->evt_qs_use_memfd_seg)
1171 if (smm->evt_qs_segment_size)
1172 eqs_size = smm->evt_qs_segment_size;
1174 eqs->ssvm_size = eqs_size;
1175 eqs->i_am_master = 1;
1176 eqs->my_pid = vpp_pid;
1177 eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1178 eqs->requested_va = smm->session_baseva;
1180 ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD);
1183 if (smm->evt_qs_use_memfd_seg)
1184 oldheap = ssvm_push_heap (eqs->sh);
1186 oldheap = svm_push_data_heap (am->vlib_rp);
1188 for (i = 0; i < vec_len (smm->vpp_event_queues); i++)
1190 smm->vpp_event_queues[i] = svm_queue_init (evt_q_length, evt_size,
1194 if (smm->evt_qs_use_memfd_seg)
1195 ssvm_pop_heap (oldheap);
1197 svm_pop_heap (oldheap);
1201 session_manager_get_evt_q_segment (void)
1203 session_manager_main_t *smm = &session_manager_main;
1204 if (smm->evt_qs_use_memfd_seg)
1205 return &smm->evt_qs_segment;
1210 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1211 session_tx_fifo_peek_and_snd,
1212 session_tx_fifo_dequeue_and_snd,
1213 session_tx_fifo_dequeue_internal,
1214 session_tx_fifo_dequeue_and_snd
1219 * Initialize session layer for given transport proto and ip version
1221 * Allocates per session type (transport proto + ip version) data structures
1222 * and adds arc from session queue node to session type output node.
1225 session_register_transport (transport_proto_t transport_proto,
1226 const transport_proto_vft_t * vft, u8 is_ip4,
1229 session_manager_main_t *smm = &session_manager_main;
1230 session_type_t session_type;
1231 u32 next_index = ~0;
1233 session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1235 vec_validate (smm->session_type_to_next, session_type);
1236 vec_validate (smm->session_tx_fns, session_type);
1239 if (output_node != ~0)
1241 foreach_vlib_main (({
1242 next_index = vlib_node_add_next (this_vlib_main,
1243 session_queue_node.index,
1249 smm->session_type_to_next[session_type] = next_index;
1250 smm->session_tx_fns[session_type] = session_tx_fns[vft->tx_type];
1253 transport_connection_t *
1254 session_get_transport (stream_session_t * s)
1256 transport_proto_t tp;
1257 if (s->session_state != SESSION_STATE_LISTENING)
1259 tp = session_get_transport_proto (s);
1260 return tp_vfts[tp].get_connection (s->connection_index,
1266 transport_connection_t *
1267 listen_session_get_transport (stream_session_t * s)
1269 transport_proto_t tp = session_get_transport_proto (s);
1270 return tp_vfts[tp].get_listener (s->connection_index);
1274 listen_session_get_local_session_endpoint (stream_session_t * listener,
1275 session_endpoint_t * sep)
1277 transport_proto_t tp = session_get_transport_proto (listener);
1278 transport_connection_t *tc;
1279 tc = tp_vfts[tp].get_listener (listener->connection_index);
1282 clib_warning ("no transport");
1286 /* N.B. The ip should not be copied because this is the local endpoint */
1287 sep->port = tc->lcl_port;
1288 sep->transport_proto = tc->proto;
1289 sep->is_ip4 = tc->is_ip4;
1294 session_flush_frames_main_thread (vlib_main_t * vm)
1296 ASSERT (vlib_get_thread_index () == 0);
1297 vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1298 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1301 static clib_error_t *
1302 session_manager_main_enable (vlib_main_t * vm)
1304 segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1305 session_manager_main_t *smm = &session_manager_main;
1306 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1307 u32 num_threads, preallocated_sessions_per_worker;
1310 num_threads = 1 /* main thread */ + vtm->n_threads;
1312 if (num_threads < 1)
1313 return clib_error_return (0, "n_thread_stacks not set");
1315 /* configure per-thread ** vectors */
1316 vec_validate (smm->sessions, num_threads - 1);
1317 vec_validate (smm->tx_buffers, num_threads - 1);
1318 vec_validate (smm->pending_event_vector, num_threads - 1);
1319 vec_validate (smm->pending_disconnects, num_threads - 1);
1320 vec_validate (smm->free_event_vector, num_threads - 1);
1321 vec_validate (smm->vpp_event_queues, num_threads - 1);
1322 vec_validate (smm->peekers_rw_locks, num_threads - 1);
1323 vec_validate_aligned (smm->ctx, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1325 for (i = 0; i < TRANSPORT_N_PROTO; i++)
1327 vec_validate (smm->current_enqueue_epoch[i], num_threads - 1);
1328 vec_validate (smm->session_to_enqueue[i], num_threads - 1);
1329 for (j = 0; j < num_threads; j++)
1330 smm->current_enqueue_epoch[i][j] = 1;
1333 for (i = 0; i < num_threads; i++)
1335 vec_validate (smm->free_event_vector[i], 0);
1336 _vec_len (smm->free_event_vector[i]) = 0;
1337 vec_validate (smm->pending_event_vector[i], 0);
1338 _vec_len (smm->pending_event_vector[i]) = 0;
1339 vec_validate (smm->pending_disconnects[i], 0);
1340 _vec_len (smm->pending_disconnects[i]) = 0;
1341 if (num_threads > 1)
1342 clib_rwlock_init (&smm->peekers_rw_locks[i]);
1346 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1349 /* Allocate vpp event queues segment and queue */
1350 session_vpp_event_queues_allocate (smm);
1352 /* Initialize fifo segment main baseva and timeout */
1353 sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1354 sm_args->size = smm->session_va_space_size;
1355 segment_manager_main_init (sm_args);
1357 /* Preallocate sessions */
1358 if (smm->preallocated_sessions)
1360 if (num_threads == 1)
1362 pool_init_fixed (smm->sessions[0], smm->preallocated_sessions);
1367 preallocated_sessions_per_worker =
1368 (1.1 * (f64) smm->preallocated_sessions /
1369 (f64) (num_threads - 1));
1371 for (j = 1; j < num_threads; j++)
1373 pool_init_fixed (smm->sessions[j],
1374 preallocated_sessions_per_worker);
1379 session_lookup_init ();
1380 app_namespaces_init ();
1383 smm->is_enabled = 1;
1385 /* Enable transports */
1386 transport_enable_disable (vm, 1);
1392 session_node_enable_disable (u8 is_en)
1394 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1395 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1396 u8 have_workers = vtm->n_threads != 0;
1399 foreach_vlib_main (({
1400 if (have_workers && ii == 0)
1402 vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1406 vlib_node_t *n = vlib_get_node (this_vlib_main,
1407 session_queue_process_node.index);
1408 vlib_start_process (this_vlib_main, n->runtime_index);
1412 vlib_process_signal_event_mt (this_vlib_main,
1413 session_queue_process_node.index,
1414 SESSION_Q_PROCESS_STOP, 0);
1419 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1426 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1428 clib_error_t *error = 0;
1431 if (session_manager_main.is_enabled)
1434 session_node_enable_disable (is_en);
1435 error = session_manager_main_enable (vm);
1439 session_manager_main.is_enabled = 0;
1440 session_node_enable_disable (is_en);
1447 session_manager_main_init (vlib_main_t * vm)
1449 session_manager_main_t *smm = &session_manager_main;
1450 smm->session_baseva = 0x200000000ULL;
1451 smm->session_va_space_size = (u64) 128 << 30;
1452 smm->evt_qs_segment_size = 64 << 20;
1453 smm->is_enabled = 0;
1457 VLIB_INIT_FUNCTION (session_manager_main_init);
1459 static clib_error_t *
1460 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1462 session_manager_main_t *smm = &session_manager_main;
1466 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1468 if (unformat (input, "event-queue-length %d", &nitems))
1471 smm->configured_event_queue_length = nitems;
1473 clib_warning ("event queue length %d too small, ignored", nitems);
1475 else if (unformat (input, "preallocated-sessions %d",
1476 &smm->preallocated_sessions))
1478 else if (unformat (input, "v4-session-table-buckets %d",
1479 &smm->configured_v4_session_table_buckets))
1481 else if (unformat (input, "v4-halfopen-table-buckets %d",
1482 &smm->configured_v4_halfopen_table_buckets))
1484 else if (unformat (input, "v6-session-table-buckets %d",
1485 &smm->configured_v6_session_table_buckets))
1487 else if (unformat (input, "v6-halfopen-table-buckets %d",
1488 &smm->configured_v6_halfopen_table_buckets))
1490 else if (unformat (input, "v4-session-table-memory %U",
1491 unformat_memory_size, &tmp))
1493 if (tmp >= 0x100000000)
1494 return clib_error_return (0, "memory size %llx (%lld) too large",
1496 smm->configured_v4_session_table_memory = tmp;
1498 else if (unformat (input, "v4-halfopen-table-memory %U",
1499 unformat_memory_size, &tmp))
1501 if (tmp >= 0x100000000)
1502 return clib_error_return (0, "memory size %llx (%lld) too large",
1504 smm->configured_v4_halfopen_table_memory = tmp;
1506 else if (unformat (input, "v6-session-table-memory %U",
1507 unformat_memory_size, &tmp))
1509 if (tmp >= 0x100000000)
1510 return clib_error_return (0, "memory size %llx (%lld) too large",
1512 smm->configured_v6_session_table_memory = tmp;
1514 else if (unformat (input, "v6-halfopen-table-memory %U",
1515 unformat_memory_size, &tmp))
1517 if (tmp >= 0x100000000)
1518 return clib_error_return (0, "memory size %llx (%lld) too large",
1520 smm->configured_v6_halfopen_table_memory = tmp;
1522 else if (unformat (input, "local-endpoints-table-memory %U",
1523 unformat_memory_size, &tmp))
1525 if (tmp >= 0x100000000)
1526 return clib_error_return (0, "memory size %llx (%lld) too large",
1528 smm->local_endpoints_table_memory = tmp;
1530 else if (unformat (input, "local-endpoints-table-buckets %d",
1531 &smm->local_endpoints_table_buckets))
1533 else if (unformat (input, "evt_qs_memfd_seg"))
1534 smm->evt_qs_use_memfd_seg = 1;
1536 return clib_error_return (0, "unknown input `%U'",
1537 format_unformat_error, input);
1542 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1545 * fd.io coding-style-patch-verification: ON
1548 * eval: (c-set-style "gnu")