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 <vlibmemory/api.h>
22 #include <vnet/dpo/load_balance.h>
23 #include <vnet/fib/ip4_fib.h>
24 #include <vnet/session/application.h>
25 #include <vnet/tcp/tcp.h>
26 #include <vnet/session/session_debug.h>
29 * Per-type vector of transport protocol virtual function tables
31 static transport_proto_vft_t *tp_vfts;
33 session_manager_main_t session_manager_main;
36 * Session lookup key; (src-ip, dst-ip, src-port, dst-port, session-type)
37 * Value: (owner thread index << 32 | session_index);
40 stream_session_table_add_for_tc (transport_connection_t * tc, u64 value)
42 session_manager_main_t *smm = &session_manager_main;
48 case SESSION_TYPE_IP4_UDP:
49 case SESSION_TYPE_IP4_TCP:
50 make_v4_ss_kv_from_tc (&kv4, tc);
52 clib_bihash_add_del_16_8 (&smm->v4_session_hash, &kv4, 1 /* is_add */ );
54 case SESSION_TYPE_IP6_UDP:
55 case SESSION_TYPE_IP6_TCP:
56 make_v6_ss_kv_from_tc (&kv6, tc);
58 clib_bihash_add_del_48_8 (&smm->v6_session_hash, &kv6, 1 /* is_add */ );
61 clib_warning ("Session type not supported");
67 stream_session_table_add (session_manager_main_t * smm, stream_session_t * s,
70 transport_connection_t *tc;
72 tc = tp_vfts[s->session_type].get_connection (s->connection_index,
74 stream_session_table_add_for_tc (tc, value);
78 stream_session_half_open_table_add (session_type_t sst,
79 transport_connection_t * tc, u64 value)
81 session_manager_main_t *smm = &session_manager_main;
87 case SESSION_TYPE_IP4_UDP:
88 case SESSION_TYPE_IP4_TCP:
89 make_v4_ss_kv_from_tc (&kv4, tc);
91 clib_bihash_add_del_16_8 (&smm->v4_half_open_hash, &kv4,
94 case SESSION_TYPE_IP6_UDP:
95 case SESSION_TYPE_IP6_TCP:
96 make_v6_ss_kv_from_tc (&kv6, tc);
98 clib_bihash_add_del_48_8 (&smm->v6_half_open_hash, &kv6,
102 clib_warning ("Session type not supported");
108 stream_session_table_del_for_tc (transport_connection_t * tc)
110 session_manager_main_t *smm = &session_manager_main;
115 case SESSION_TYPE_IP4_UDP:
116 case SESSION_TYPE_IP4_TCP:
117 make_v4_ss_kv_from_tc (&kv4, tc);
118 return clib_bihash_add_del_16_8 (&smm->v4_session_hash, &kv4,
121 case SESSION_TYPE_IP6_UDP:
122 case SESSION_TYPE_IP6_TCP:
123 make_v6_ss_kv_from_tc (&kv6, tc);
124 return clib_bihash_add_del_48_8 (&smm->v6_session_hash, &kv6,
128 clib_warning ("Session type not supported");
136 stream_session_table_del (session_manager_main_t * smm, stream_session_t * s)
138 transport_connection_t *ts;
140 ts = tp_vfts[s->session_type].get_connection (s->connection_index,
142 return stream_session_table_del_for_tc (ts);
146 stream_session_half_open_table_del (session_manager_main_t * smm, u8 sst,
147 transport_connection_t * tc)
154 case SESSION_TYPE_IP4_UDP:
155 case SESSION_TYPE_IP4_TCP:
156 make_v4_ss_kv_from_tc (&kv4, tc);
157 clib_bihash_add_del_16_8 (&smm->v4_half_open_hash, &kv4,
160 case SESSION_TYPE_IP6_UDP:
161 case SESSION_TYPE_IP6_TCP:
162 make_v6_ss_kv_from_tc (&kv6, tc);
163 clib_bihash_add_del_48_8 (&smm->v6_half_open_hash, &kv6,
167 clib_warning ("Session type not supported");
173 stream_session_lookup_listener4 (ip4_address_t * lcl, u16 lcl_port, u8 proto)
175 session_manager_main_t *smm = &session_manager_main;
179 make_v4_listener_kv (&kv4, lcl, lcl_port, proto);
180 rv = clib_bihash_search_inline_16_8 (&smm->v4_session_hash, &kv4);
182 return pool_elt_at_index (smm->listen_sessions[proto], (u32) kv4.value);
184 /* Zero out the lcl ip */
186 rv = clib_bihash_search_inline_16_8 (&smm->v4_session_hash, &kv4);
188 return pool_elt_at_index (smm->listen_sessions[proto], kv4.value);
193 /** Looks up a session based on the 5-tuple passed as argument.
195 * First it tries to find an established session, if this fails, it tries
196 * finding a listener session if this fails, it tries a lookup with a
197 * wildcarded local source (listener bound to all interfaces)
200 stream_session_lookup4 (ip4_address_t * lcl, ip4_address_t * rmt,
201 u16 lcl_port, u16 rmt_port, u8 proto)
203 session_manager_main_t *smm = &session_manager_main;
208 /* Lookup session amongst established ones */
209 make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
210 rv = clib_bihash_search_inline_16_8 (&smm->v4_session_hash, &kv4);
212 return stream_session_get_from_handle (kv4.value);
214 /* If nothing is found, check if any listener is available */
215 if ((s = stream_session_lookup_listener4 (lcl, lcl_port, proto)))
218 /* Finally, try half-open connections */
219 rv = clib_bihash_search_inline_16_8 (&smm->v4_half_open_hash, &kv4);
221 return stream_session_get_from_handle (kv4.value);
226 stream_session_lookup_listener6 (ip6_address_t * lcl, u16 lcl_port, u8 proto)
228 session_manager_main_t *smm = &session_manager_main;
232 make_v6_listener_kv (&kv6, lcl, lcl_port, proto);
233 rv = clib_bihash_search_inline_48_8 (&smm->v6_session_hash, &kv6);
235 return pool_elt_at_index (smm->listen_sessions[proto], kv6.value);
237 /* Zero out the lcl ip */
238 kv6.key[0] = kv6.key[1] = 0;
239 rv = clib_bihash_search_inline_48_8 (&smm->v6_session_hash, &kv6);
241 return pool_elt_at_index (smm->listen_sessions[proto], kv6.value);
246 /* Looks up a session based on the 5-tuple passed as argument.
247 * First it tries to find an established session, if this fails, it tries
248 * finding a listener session if this fails, it tries a lookup with a
249 * wildcarded local source (listener bound to all interfaces) */
251 stream_session_lookup6 (ip6_address_t * lcl, ip6_address_t * rmt,
252 u16 lcl_port, u16 rmt_port, u8 proto)
254 session_manager_main_t *smm = vnet_get_session_manager_main ();
259 make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
260 rv = clib_bihash_search_inline_48_8 (&smm->v6_session_hash, &kv6);
262 return stream_session_get_from_handle (kv6.value);
264 /* If nothing is found, check if any listener is available */
265 if ((s = stream_session_lookup_listener6 (lcl, lcl_port, proto)))
268 /* Finally, try half-open connections */
269 rv = clib_bihash_search_inline_48_8 (&smm->v6_half_open_hash, &kv6);
271 return stream_session_get_from_handle (kv6.value);
276 stream_session_lookup_listener (ip46_address_t * lcl, u16 lcl_port, u8 proto)
280 case SESSION_TYPE_IP4_UDP:
281 case SESSION_TYPE_IP4_TCP:
282 return stream_session_lookup_listener4 (&lcl->ip4, lcl_port, proto);
284 case SESSION_TYPE_IP6_UDP:
285 case SESSION_TYPE_IP6_TCP:
286 return stream_session_lookup_listener6 (&lcl->ip6, lcl_port, proto);
293 stream_session_half_open_lookup (session_manager_main_t * smm,
294 ip46_address_t * lcl, ip46_address_t * rmt,
295 u16 lcl_port, u16 rmt_port, u8 proto)
303 case SESSION_TYPE_IP4_UDP:
304 case SESSION_TYPE_IP4_TCP:
305 make_v4_ss_kv (&kv4, &lcl->ip4, &rmt->ip4, lcl_port, rmt_port, proto);
306 rv = clib_bihash_search_inline_16_8 (&smm->v4_half_open_hash, &kv4);
313 case SESSION_TYPE_IP6_UDP:
314 case SESSION_TYPE_IP6_TCP:
315 make_v6_ss_kv (&kv6, &lcl->ip6, &rmt->ip6, lcl_port, rmt_port, proto);
316 rv = clib_bihash_search_inline_48_8 (&smm->v6_half_open_hash, &kv6);
327 transport_connection_t *
328 stream_session_lookup_transport_wt4 (ip4_address_t * lcl, ip4_address_t * rmt,
329 u16 lcl_port, u16 rmt_port, u8 proto,
332 session_manager_main_t *smm = &session_manager_main;
337 /* Lookup session amongst established ones */
338 make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
339 rv = clib_bihash_search_inline_16_8 (&smm->v4_session_hash, &kv4);
342 s = stream_session_get_tsi (kv4.value, my_thread_index);
344 return tp_vfts[s->session_type].get_connection (s->connection_index,
348 /* If nothing is found, check if any listener is available */
349 s = stream_session_lookup_listener4 (lcl, lcl_port, proto);
351 return tp_vfts[s->session_type].get_listener (s->connection_index);
353 /* Finally, try half-open connections */
354 rv = clib_bihash_search_inline_16_8 (&smm->v4_half_open_hash, &kv4);
356 return tp_vfts[proto].get_half_open (kv4.value & 0xFFFFFFFF);
360 transport_connection_t *
361 stream_session_lookup_transport4 (ip4_address_t * lcl, ip4_address_t * rmt,
362 u16 lcl_port, u16 rmt_port, u8 proto)
364 session_manager_main_t *smm = &session_manager_main;
369 /* Lookup session amongst established ones */
370 make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
371 rv = clib_bihash_search_inline_16_8 (&smm->v4_session_hash, &kv4);
374 s = stream_session_get_from_handle (kv4.value);
375 return tp_vfts[s->session_type].get_connection (s->connection_index,
379 /* If nothing is found, check if any listener is available */
380 s = stream_session_lookup_listener4 (lcl, lcl_port, proto);
382 return tp_vfts[s->session_type].get_listener (s->connection_index);
384 /* Finally, try half-open connections */
385 rv = clib_bihash_search_inline_16_8 (&smm->v4_half_open_hash, &kv4);
387 return tp_vfts[proto].get_half_open (kv4.value & 0xFFFFFFFF);
391 transport_connection_t *
392 stream_session_lookup_transport_wt6 (ip6_address_t * lcl, ip6_address_t * rmt,
393 u16 lcl_port, u16 rmt_port, u8 proto,
396 session_manager_main_t *smm = &session_manager_main;
401 make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
402 rv = clib_bihash_search_inline_48_8 (&smm->v6_session_hash, &kv6);
405 s = stream_session_get_tsi (kv6.value, my_thread_index);
407 return tp_vfts[s->session_type].get_connection (s->connection_index,
411 /* If nothing is found, check if any listener is available */
412 s = stream_session_lookup_listener6 (lcl, lcl_port, proto);
414 return tp_vfts[s->session_type].get_listener (s->connection_index);
416 /* Finally, try half-open connections */
417 rv = clib_bihash_search_inline_48_8 (&smm->v6_half_open_hash, &kv6);
419 return tp_vfts[proto].get_half_open (kv6.value & 0xFFFFFFFF);
424 transport_connection_t *
425 stream_session_lookup_transport6 (ip6_address_t * lcl, ip6_address_t * rmt,
426 u16 lcl_port, u16 rmt_port, u8 proto)
428 session_manager_main_t *smm = &session_manager_main;
433 make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
434 rv = clib_bihash_search_inline_48_8 (&smm->v6_session_hash, &kv6);
437 s = stream_session_get_from_handle (kv6.value);
438 return tp_vfts[s->session_type].get_connection (s->connection_index,
442 /* If nothing is found, check if any listener is available */
443 s = stream_session_lookup_listener6 (lcl, lcl_port, proto);
445 return tp_vfts[s->session_type].get_listener (s->connection_index);
447 /* Finally, try half-open connections */
448 rv = clib_bihash_search_inline_48_8 (&smm->v6_half_open_hash, &kv6);
450 return tp_vfts[proto].get_half_open (kv6.value & 0xFFFFFFFF);
456 stream_session_create_i (segment_manager_t * sm, transport_connection_t * tc,
457 stream_session_t ** ret_s)
459 session_manager_main_t *smm = &session_manager_main;
460 svm_fifo_t *server_rx_fifo = 0, *server_tx_fifo = 0;
461 u32 fifo_segment_index;
465 u32 thread_index = tc->thread_index;
468 ASSERT (thread_index == vlib_get_thread_index ());
470 if ((rv = segment_manager_alloc_session_fifos (sm, &server_rx_fifo,
472 &fifo_segment_index)))
475 /* Create the session */
476 pool_get_aligned (smm->sessions[thread_index], s, CLIB_CACHE_LINE_BYTES);
477 memset (s, 0, sizeof (*s));
479 /* Initialize backpointers */
480 pool_index = s - smm->sessions[thread_index];
481 server_rx_fifo->master_session_index = pool_index;
482 server_rx_fifo->master_thread_index = thread_index;
484 server_tx_fifo->master_session_index = pool_index;
485 server_tx_fifo->master_thread_index = thread_index;
487 s->server_rx_fifo = server_rx_fifo;
488 s->server_tx_fifo = server_tx_fifo;
490 /* Initialize state machine, such as it is... */
491 s->session_type = tc->proto;
492 s->session_state = SESSION_STATE_CONNECTING;
493 s->svm_segment_index = fifo_segment_index;
494 s->thread_index = thread_index;
495 s->session_index = pool_index;
497 /* Attach transport to session */
498 s->connection_index = tc->c_index;
500 /* Attach session to transport */
501 tc->s_index = s->session_index;
503 /* Add to the main lookup table */
504 value = (((u64) thread_index) << 32) | (u64) s->session_index;
505 stream_session_table_add_for_tc (tc, value);
512 /** Enqueue buffer chain tail */
514 session_enqueue_chain_tail (stream_session_t * s, vlib_buffer_t * b,
515 u32 offset, u8 is_in_order)
517 vlib_buffer_t *chain_b;
518 u32 chain_bi = b->next_buffer;
519 vlib_main_t *vm = vlib_get_main ();
526 chain_b = vlib_get_buffer (vm, chain_bi);
527 data = vlib_buffer_get_current (chain_b);
528 len = chain_b->current_length;
531 rv = svm_fifo_enqueue_nowait (s->server_rx_fifo, len, data);
534 return (rv > 0) ? (written + rv) : written;
540 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset, len,
547 while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
548 ? chain_b->next_buffer : 0));
557 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
558 * event but on request can queue notification events for later delivery by
559 * calling stream_server_flush_enqueue_events().
561 * @param tc Transport connection which is to be enqueued data
562 * @param b Buffer to be enqueued
563 * @param offset Offset at which to start enqueueing if out-of-order
564 * @param queue_event Flag to indicate if peer is to be notified or if event
565 * is to be queued. The former is useful when more data is
566 * enqueued and only one event is to be generated.
567 * @param is_in_order Flag to indicate if data is in order
568 * @return Number of bytes enqueued or a negative value if enqueueing failed.
571 stream_session_enqueue_data (transport_connection_t * tc, vlib_buffer_t * b,
572 u32 offset, u8 queue_event, u8 is_in_order)
575 int enqueued = 0, rv;
577 s = stream_session_get (tc->s_index, tc->thread_index);
582 svm_fifo_enqueue_nowait (s->server_rx_fifo, b->current_length,
583 vlib_buffer_get_current (b));
585 ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued > 0))
587 rv = session_enqueue_chain_tail (s, b, 0, 1);
595 rv = svm_fifo_enqueue_with_offset (s->server_rx_fifo, offset,
597 vlib_buffer_get_current (b));
598 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
599 rv = session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
606 /* Queue RX event on this fifo. Eventually these will need to be flushed
607 * by calling stream_server_flush_enqueue_events () */
608 session_manager_main_t *smm = vnet_get_session_manager_main ();
609 u32 thread_index = s->thread_index;
610 u32 my_enqueue_epoch = smm->current_enqueue_epoch[thread_index];
612 if (s->enqueue_epoch != my_enqueue_epoch)
614 s->enqueue_epoch = my_enqueue_epoch;
615 vec_add1 (smm->session_indices_to_enqueue_by_thread[thread_index],
616 s - smm->sessions[thread_index]);
626 /** Check if we have space in rx fifo to push more bytes */
628 stream_session_no_space (transport_connection_t * tc, u32 thread_index,
631 stream_session_t *s = stream_session_get (tc->s_index, thread_index);
633 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
636 if (data_len > svm_fifo_max_enqueue (s->server_rx_fifo))
643 stream_session_tx_fifo_max_dequeue (transport_connection_t * tc)
645 stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
646 if (s->session_state != SESSION_STATE_READY)
648 return svm_fifo_max_dequeue (s->server_tx_fifo);
652 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
653 u32 offset, u32 max_bytes)
655 stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
656 return svm_fifo_peek (s->server_tx_fifo, offset, max_bytes, buffer);
660 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
662 stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
663 return svm_fifo_dequeue_drop (s->server_tx_fifo, max_bytes);
667 * Notify session peer that new data has been enqueued.
669 * @param s Stream session for which the event is to be generated.
670 * @param block Flag to indicate if call should block if event queue is full.
672 * @return 0 on succes or negative number if failed to send notification.
675 stream_session_enqueue_notify (stream_session_t * s, u8 block)
678 session_fifo_event_t evt;
679 unix_shared_memory_queue_t *q;
680 static u32 serial_number;
682 if (PREDICT_FALSE (s->session_state == SESSION_STATE_CLOSED))
685 /* Get session's server */
686 app = application_get (s->app_index);
688 /* Built-in server? Hand event to the callback... */
689 if (app->cb_fns.builtin_server_rx_callback)
690 return app->cb_fns.builtin_server_rx_callback (s);
692 /* If no event, send one */
693 if (svm_fifo_set_event (s->server_rx_fifo))
695 /* Fabricate event */
696 evt.fifo = s->server_rx_fifo;
697 evt.event_type = FIFO_EVENT_APP_RX;
698 evt.event_id = serial_number++;
700 /* Add event to server's event queue */
701 q = app->event_queue;
703 /* Based on request block (or not) for lack of space */
704 if (block || PREDICT_TRUE (q->cursize < q->maxsize))
705 unix_shared_memory_queue_add (app->event_queue, (u8 *) & evt,
706 0 /* do wait for mutex */ );
709 clib_warning ("fifo full");
715 SESSION_EVT_DBG(SESSION_EVT_ENQ, s, ({
716 ed->data[0] = evt.event_id;
717 ed->data[1] = svm_fifo_max_dequeue (s->server_rx_fifo);
725 * Flushes queue of sessions that are to be notified of new data
728 * @param thread_index Thread index for which the flush is to be performed.
729 * @return 0 on success or a positive number indicating the number of
730 * failures due to API queue being full.
733 session_manager_flush_enqueue_events (u32 thread_index)
735 session_manager_main_t *smm = &session_manager_main;
736 u32 *session_indices_to_enqueue;
739 session_indices_to_enqueue =
740 smm->session_indices_to_enqueue_by_thread[thread_index];
742 for (i = 0; i < vec_len (session_indices_to_enqueue); i++)
744 stream_session_t *s0;
747 s0 = stream_session_get (session_indices_to_enqueue[i], thread_index);
748 if (stream_session_enqueue_notify (s0, 0 /* don't block */ ))
754 vec_reset_length (session_indices_to_enqueue);
756 smm->session_indices_to_enqueue_by_thread[thread_index] =
757 session_indices_to_enqueue;
759 /* Increment enqueue epoch for next round */
760 smm->current_enqueue_epoch[thread_index]++;
766 * Init fifo tail and head pointers
768 * Useful if transport uses absolute offsets for tracking ooo segments.
771 stream_session_init_fifos_pointers (transport_connection_t * tc,
772 u32 rx_pointer, u32 tx_pointer)
775 s = stream_session_get (tc->s_index, tc->thread_index);
776 svm_fifo_init_pointers (s->server_rx_fifo, rx_pointer);
777 svm_fifo_init_pointers (s->server_tx_fifo, tx_pointer);
781 stream_session_connect_notify (transport_connection_t * tc, u8 sst,
784 session_manager_main_t *smm = &session_manager_main;
786 stream_session_t *new_s = 0;
791 handle = stream_session_half_open_lookup (smm, &tc->lcl_ip, &tc->rmt_ip,
792 tc->lcl_port, tc->rmt_port,
794 if (handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
796 clib_warning ("This can't be good!");
800 /* Get the app's index from the handle we stored when opening connection */
801 app = application_get (handle >> 32);
802 api_context = tc->s_index;
806 segment_manager_t *sm;
807 sm = application_get_connect_segment_manager (app);
809 /* Create new session (svm segments are allocated if needed) */
810 if (stream_session_create_i (sm, tc, &new_s))
816 new_s->app_index = app->index;
820 app->cb_fns.session_connected_callback (app->index, api_context, new_s,
823 /* Cleanup session lookup */
824 stream_session_half_open_table_del (smm, sst, tc);
830 stream_session_accept_notify (transport_connection_t * tc)
832 application_t *server;
835 s = stream_session_get (tc->s_index, tc->thread_index);
836 server = application_get (s->app_index);
837 server->cb_fns.session_accept_callback (s);
841 * Notification from transport that connection is being closed.
843 * A disconnect is sent to application but state is not removed. Once
844 * disconnect is acknowledged by application, session disconnect is called.
845 * Ultimately this leads to close being called on transport (passive close).
848 stream_session_disconnect_notify (transport_connection_t * tc)
850 application_t *server;
853 s = stream_session_get (tc->s_index, tc->thread_index);
854 server = application_get (s->app_index);
855 server->cb_fns.session_disconnect_callback (s);
859 * Cleans up session and associated app if needed.
862 stream_session_delete (stream_session_t * s)
864 session_manager_main_t *smm = vnet_get_session_manager_main ();
866 /* Delete from the main lookup table. */
867 stream_session_table_del (smm, s);
869 /* Cleanup fifo segments */
870 segment_manager_dealloc_fifos (s->svm_segment_index, s->server_rx_fifo,
873 pool_put (smm->sessions[s->thread_index], s);
877 * Notification from transport that connection is being deleted
879 * This should be called only on previously fully established sessions. For
880 * instance failed connects should call stream_session_connect_notify and
881 * indicate that the connect has failed.
884 stream_session_delete_notify (transport_connection_t * tc)
888 /* App might've been removed already */
889 s = stream_session_get_if_valid (tc->s_index, tc->thread_index);
894 stream_session_delete (s);
898 * Notify application that connection has been reset.
901 stream_session_reset_notify (transport_connection_t * tc)
905 s = stream_session_get (tc->s_index, tc->thread_index);
907 app = application_get (s->app_index);
908 app->cb_fns.session_reset_callback (s);
912 * Accept a stream session. Optionally ping the server by callback.
915 stream_session_accept (transport_connection_t * tc, u32 listener_index,
918 application_t *server;
919 stream_session_t *s, *listener;
920 segment_manager_t *sm;
924 /* Find the server */
925 listener = listen_session_get (sst, listener_index);
926 server = application_get (listener->app_index);
928 sm = application_get_listen_segment_manager (server, listener);
929 if ((rv = stream_session_create_i (sm, tc, &s)))
932 s->app_index = server->index;
933 s->listener_index = listener_index;
934 s->session_state = SESSION_STATE_ACCEPTING;
936 /* Shoulder-tap the server */
939 server->cb_fns.session_accept_callback (s);
946 * Ask transport to open connection to remote transport endpoint.
948 * Stores handle for matching request with reply since the call can be
949 * asynchronous. For instance, for TCP the 3-way handshake must complete
950 * before reply comes. Session is only created once connection is established.
952 * @param app_index Index of the application requesting the connect
953 * @param st Session type requested.
954 * @param tep Remote transport endpoint
955 * @param res Resulting transport connection .
958 stream_session_open (u32 app_index, session_type_t st,
959 transport_endpoint_t * tep,
960 transport_connection_t ** res)
962 transport_connection_t *tc;
966 rv = tp_vfts[st].open (&tep->ip, tep->port);
969 clib_warning ("Transport failed to open connection.");
970 return VNET_API_ERROR_SESSION_CONNECT_FAIL;
973 tc = tp_vfts[st].get_half_open ((u32) rv);
975 /* Save app and tc index. The latter is needed to help establish the
976 * connection while the former is needed when the connect notify comes
977 * and we have to notify the external app */
978 handle = (((u64) app_index) << 32) | (u64) tc->c_index;
980 /* Add to the half-open lookup table */
981 stream_session_half_open_table_add (st, tc, handle);
989 * Ask transport to listen on local transport endpoint.
991 * @param s Session for which listen will be called. Note that unlike
992 * established sessions, listen sessions are not associated to a
994 * @param tep Local endpoint to be listened on.
997 stream_session_listen (stream_session_t * s, transport_endpoint_t * tep)
999 transport_connection_t *tc;
1002 /* Transport bind/listen */
1003 tci = tp_vfts[s->session_type].bind (s->session_index, &tep->ip, tep->port);
1005 if (tci == (u32) ~ 0)
1008 /* Attach transport to session */
1009 s->connection_index = tci;
1010 tc = tp_vfts[s->session_type].get_listener (tci);
1012 /* Weird but handle it ... */
1016 /* Add to the main lookup table */
1017 stream_session_table_add_for_tc (tc, s->session_index);
1023 * Ask transport to stop listening on local transport endpoint.
1025 * @param s Session to stop listening on. It must be in state LISTENING.
1028 stream_session_stop_listen (stream_session_t * s)
1030 transport_connection_t *tc;
1032 if (s->session_state != SESSION_STATE_LISTENING)
1034 clib_warning ("not a listening session");
1038 tc = tp_vfts[s->session_type].get_listener (s->connection_index);
1041 clib_warning ("no transport");
1042 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1045 stream_session_table_del_for_tc (tc);
1046 tp_vfts[s->session_type].unbind (s->connection_index);
1051 session_send_session_evt_to_thread (u64 session_handle,
1052 fifo_event_type_t evt_type,
1055 static u16 serial_number = 0;
1056 session_fifo_event_t evt;
1057 unix_shared_memory_queue_t *q;
1059 /* Fabricate event */
1060 evt.session_handle = session_handle;
1061 evt.event_type = evt_type;
1062 evt.event_id = serial_number++;
1064 q = session_manager_get_vpp_event_queue (thread_index);
1066 /* Based on request block (or not) for lack of space */
1067 if (PREDICT_TRUE (q->cursize < q->maxsize))
1069 if (unix_shared_memory_queue_add (q, (u8 *) & evt,
1070 1 /* do wait for mutex */ ))
1072 clib_warning ("failed to enqueue evt");
1077 clib_warning ("queue full");
1083 * Disconnect session and propagate to transport. This should eventually
1084 * result in a delete notification that allows us to cleanup session state.
1085 * Called for both active/passive disconnects.
1087 * Should be called from the session's thread.
1090 stream_session_disconnect (stream_session_t * s)
1092 s->session_state = SESSION_STATE_CLOSED;
1093 tp_vfts[s->session_type].close (s->connection_index, s->thread_index);
1097 * Cleanup transport and session state.
1099 * Notify transport of the cleanup, wait for a delete notify to actually
1100 * remove the session state.
1103 stream_session_cleanup (stream_session_t * s)
1105 session_manager_main_t *smm = &session_manager_main;
1108 s->session_state = SESSION_STATE_CLOSED;
1110 /* Delete from the main lookup table to avoid more enqueues */
1111 rv = stream_session_table_del (smm, s);
1113 clib_warning ("hash delete error, rv %d", rv);
1115 tp_vfts[s->session_type].cleanup (s->connection_index, s->thread_index);
1119 session_register_transport (u8 type, const transport_proto_vft_t * vft)
1121 session_manager_main_t *smm = vnet_get_session_manager_main ();
1123 vec_validate (tp_vfts, type);
1124 tp_vfts[type] = *vft;
1126 /* If an offset function is provided, then peek instead of dequeue */
1127 smm->session_tx_fns[type] =
1128 (vft->tx_fifo_offset) ? session_tx_fifo_peek_and_snd :
1129 session_tx_fifo_dequeue_and_snd;
1132 transport_proto_vft_t *
1133 session_get_transport_vft (u8 type)
1135 if (type >= vec_len (tp_vfts))
1137 return &tp_vfts[type];
1141 * Allocate vpp event queue (once) per worker thread
1144 session_vpp_event_queue_allocate (session_manager_main_t * smm,
1147 api_main_t *am = &api_main;
1149 u32 event_queue_length = 2048;
1151 if (smm->vpp_event_queues[thread_index] == 0)
1153 /* Allocate event fifo in the /vpe-api shared-memory segment */
1154 oldheap = svm_push_data_heap (am->vlib_rp);
1156 if (smm->configured_event_queue_length)
1157 event_queue_length = smm->configured_event_queue_length;
1159 smm->vpp_event_queues[thread_index] =
1160 unix_shared_memory_queue_init
1161 (event_queue_length,
1162 sizeof (session_fifo_event_t), 0 /* consumer pid */ ,
1163 0 /* (do not) send signal when queue non-empty */ );
1165 svm_pop_heap (oldheap);
1170 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
1172 if (proto == TRANSPORT_PROTO_TCP)
1175 return SESSION_TYPE_IP4_TCP;
1177 return SESSION_TYPE_IP6_TCP;
1182 return SESSION_TYPE_IP4_UDP;
1184 return SESSION_TYPE_IP6_UDP;
1187 return SESSION_N_TYPES;
1190 static clib_error_t *
1191 session_manager_main_enable (vlib_main_t * vm)
1193 session_manager_main_t *smm = &session_manager_main;
1194 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1198 num_threads = 1 /* main thread */ + vtm->n_threads;
1200 if (num_threads < 1)
1201 return clib_error_return (0, "n_thread_stacks not set");
1203 /* $$$ config parameters */
1204 svm_fifo_segment_init (0x200000000ULL /* first segment base VA */ ,
1205 20 /* timeout in seconds */ );
1207 /* configure per-thread ** vectors */
1208 vec_validate (smm->sessions, num_threads - 1);
1209 vec_validate (smm->session_indices_to_enqueue_by_thread, num_threads - 1);
1210 vec_validate (smm->tx_buffers, num_threads - 1);
1211 vec_validate (smm->pending_event_vector, num_threads - 1);
1212 vec_validate (smm->free_event_vector, num_threads - 1);
1213 vec_validate (smm->current_enqueue_epoch, num_threads - 1);
1214 vec_validate (smm->vpp_event_queues, num_threads - 1);
1216 for (i = 0; i < num_threads; i++)
1218 vec_validate (smm->free_event_vector[i], 0);
1219 _vec_len (smm->free_event_vector[i]) = 0;
1220 vec_validate (smm->pending_event_vector[i], 0);
1221 _vec_len (smm->pending_event_vector[i]) = 0;
1225 vec_validate (smm->last_event_poll_by_thread, num_threads - 1);
1228 /* Allocate vpp event queues */
1229 for (i = 0; i < vec_len (smm->vpp_event_queues); i++)
1230 session_vpp_event_queue_allocate (smm, i);
1232 /* $$$$ preallocate hack config parameter */
1233 for (i = 0; i < smm->preallocated_sessions; i++)
1235 stream_session_t *ss __attribute__ ((unused));
1236 pool_get_aligned (smm->sessions[0], ss, CLIB_CACHE_LINE_BYTES);
1239 for (i = 0; i < smm->preallocated_sessions; i++)
1240 pool_put_index (smm->sessions[0], i);
1242 clib_bihash_init_16_8 (&smm->v4_session_hash, "v4 session table",
1243 200000 /* $$$$ config parameter nbuckets */ ,
1244 (64 << 20) /*$$$ config parameter table size */ );
1245 clib_bihash_init_48_8 (&smm->v6_session_hash, "v6 session table",
1246 200000 /* $$$$ config parameter nbuckets */ ,
1247 (64 << 20) /*$$$ config parameter table size */ );
1249 clib_bihash_init_16_8 (&smm->v4_half_open_hash, "v4 half-open table",
1250 200000 /* $$$$ config parameter nbuckets */ ,
1251 (64 << 20) /*$$$ config parameter table size */ );
1252 clib_bihash_init_48_8 (&smm->v6_half_open_hash, "v6 half-open table",
1253 200000 /* $$$$ config parameter nbuckets */ ,
1254 (64 << 20) /*$$$ config parameter table size */ );
1256 smm->is_enabled = 1;
1258 /* Enable TCP transport */
1259 vnet_tcp_enable_disable (vm, 1);
1265 session_node_enable_disable (u8 is_en)
1267 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1269 foreach_vlib_main (({
1270 vlib_node_set_state (this_vlib_main, session_queue_node.index,
1277 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1281 if (session_manager_main.is_enabled)
1284 session_node_enable_disable (is_en);
1286 return session_manager_main_enable (vm);
1290 session_manager_main.is_enabled = 0;
1291 session_node_enable_disable (is_en);
1298 session_manager_main_init (vlib_main_t * vm)
1300 session_manager_main_t *smm = &session_manager_main;
1302 smm->vlib_main = vm;
1303 smm->vnet_main = vnet_get_main ();
1304 smm->is_enabled = 0;
1309 VLIB_INIT_FUNCTION (session_manager_main_init);
1311 static clib_error_t *
1312 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1314 session_manager_main_t *smm = &session_manager_main;
1317 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1319 if (unformat (input, "event-queue-length %d", &nitems))
1322 smm->configured_event_queue_length = nitems;
1324 clib_warning ("event queue length %d too small, ignored", nitems);
1326 if (unformat (input, "preallocated-sessions %d",
1327 &smm->preallocated_sessions))
1330 return clib_error_return (0, "unknown input `%U'",
1331 format_unformat_error, input);
1336 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1339 * fd.io coding-style-patch-verification: ON
1342 * eval: (c-set-style "gnu")