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 (u8 sst, transport_connection_t * tc,
43 session_manager_main_t *smm = &session_manager_main;
49 case SESSION_TYPE_IP4_UDP:
50 case SESSION_TYPE_IP4_TCP:
51 make_v4_ss_kv_from_tc (&kv4, tc);
53 clib_bihash_add_del_16_8 (&smm->v4_session_hash, &kv4, 1 /* is_add */ );
55 case SESSION_TYPE_IP6_UDP:
56 case SESSION_TYPE_IP6_TCP:
57 make_v6_ss_kv_from_tc (&kv6, tc);
59 clib_bihash_add_del_48_8 (&smm->v6_session_hash, &kv6, 1 /* is_add */ );
62 clib_warning ("Session type not supported");
68 stream_session_table_add (session_manager_main_t * smm, stream_session_t * s,
71 transport_connection_t *tc;
73 tc = tp_vfts[s->session_type].get_connection (s->connection_index,
75 stream_session_table_add_for_tc (s->session_type, tc, value);
79 stream_session_half_open_table_add (u8 sst, transport_connection_t * tc,
82 session_manager_main_t *smm = &session_manager_main;
88 case SESSION_TYPE_IP4_UDP:
89 case SESSION_TYPE_IP4_TCP:
90 make_v4_ss_kv_from_tc (&kv4, tc);
92 clib_bihash_add_del_16_8 (&smm->v4_half_open_hash, &kv4,
95 case SESSION_TYPE_IP6_UDP:
96 case SESSION_TYPE_IP6_TCP:
97 make_v6_ss_kv_from_tc (&kv6, tc);
99 clib_bihash_add_del_48_8 (&smm->v6_half_open_hash, &kv6,
103 clib_warning ("Session type not supported");
109 stream_session_table_del_for_tc (session_manager_main_t * smm, u8 sst,
110 transport_connection_t * tc)
117 case SESSION_TYPE_IP4_UDP:
118 case SESSION_TYPE_IP4_TCP:
119 make_v4_ss_kv_from_tc (&kv4, tc);
120 return clib_bihash_add_del_16_8 (&smm->v4_session_hash, &kv4,
123 case SESSION_TYPE_IP6_UDP:
124 case SESSION_TYPE_IP6_TCP:
125 make_v6_ss_kv_from_tc (&kv6, tc);
126 return clib_bihash_add_del_48_8 (&smm->v6_session_hash, &kv6,
130 clib_warning ("Session type not supported");
138 stream_session_table_del (session_manager_main_t * smm, stream_session_t * s)
140 transport_connection_t *ts;
142 ts = tp_vfts[s->session_type].get_connection (s->connection_index,
144 return stream_session_table_del_for_tc (smm, s->session_type, ts);
148 stream_session_half_open_table_del (session_manager_main_t * smm, u8 sst,
149 transport_connection_t * tc)
156 case SESSION_TYPE_IP4_UDP:
157 case SESSION_TYPE_IP4_TCP:
158 make_v4_ss_kv_from_tc (&kv4, tc);
159 clib_bihash_add_del_16_8 (&smm->v4_half_open_hash, &kv4,
162 case SESSION_TYPE_IP6_UDP:
163 case SESSION_TYPE_IP6_TCP:
164 make_v6_ss_kv_from_tc (&kv6, tc);
165 clib_bihash_add_del_48_8 (&smm->v6_half_open_hash, &kv6,
169 clib_warning ("Session type not supported");
175 stream_session_lookup_listener4 (ip4_address_t * lcl, u16 lcl_port, u8 proto)
177 session_manager_main_t *smm = &session_manager_main;
181 make_v4_listener_kv (&kv4, lcl, lcl_port, proto);
182 rv = clib_bihash_search_inline_16_8 (&smm->v4_session_hash, &kv4);
184 return pool_elt_at_index (smm->listen_sessions[proto], (u32) kv4.value);
186 /* Zero out the lcl ip */
188 rv = clib_bihash_search_inline_16_8 (&smm->v4_session_hash, &kv4);
190 return pool_elt_at_index (smm->listen_sessions[proto], kv4.value);
195 /** Looks up a session based on the 5-tuple passed as argument.
197 * First it tries to find an established session, if this fails, it tries
198 * finding a listener session if this fails, it tries a lookup with a
199 * wildcarded local source (listener bound to all interfaces)
202 stream_session_lookup4 (ip4_address_t * lcl, ip4_address_t * rmt,
203 u16 lcl_port, u16 rmt_port, u8 proto,
206 session_manager_main_t *smm = &session_manager_main;
210 /* Lookup session amongst established ones */
211 make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
212 rv = clib_bihash_search_inline_16_8 (&smm->v4_session_hash, &kv4);
214 return stream_session_get_tsi (kv4.value, my_thread_index);
216 /* If nothing is found, check if any listener is available */
217 return stream_session_lookup_listener4 (lcl, lcl_port, proto);
221 stream_session_lookup_listener6 (ip6_address_t * lcl, u16 lcl_port, u8 proto)
223 session_manager_main_t *smm = &session_manager_main;
227 make_v6_listener_kv (&kv6, lcl, lcl_port, proto);
228 rv = clib_bihash_search_inline_48_8 (&smm->v6_session_hash, &kv6);
230 return pool_elt_at_index (smm->listen_sessions[proto], kv6.value);
232 /* Zero out the lcl ip */
233 kv6.key[0] = kv6.key[1] = 0;
234 rv = clib_bihash_search_inline_48_8 (&smm->v6_session_hash, &kv6);
236 return pool_elt_at_index (smm->listen_sessions[proto], kv6.value);
241 /* Looks up a session based on the 5-tuple passed as argument.
242 * First it tries to find an established session, if this fails, it tries
243 * finding a listener session if this fails, it tries a lookup with a
244 * wildcarded local source (listener bound to all interfaces) */
246 stream_session_lookup6 (ip6_address_t * lcl, ip6_address_t * rmt,
247 u16 lcl_port, u16 rmt_port, u8 proto,
250 session_manager_main_t *smm = vnet_get_session_manager_main ();
254 make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
255 rv = clib_bihash_search_inline_48_8 (&smm->v6_session_hash, &kv6);
257 return stream_session_get_tsi (kv6.value, my_thread_index);
259 /* If nothing is found, check if any listener is available */
260 return stream_session_lookup_listener6 (lcl, lcl_port, proto);
264 stream_session_lookup_listener (ip46_address_t * lcl, u16 lcl_port, u8 proto)
268 case SESSION_TYPE_IP4_UDP:
269 case SESSION_TYPE_IP4_TCP:
270 return stream_session_lookup_listener4 (&lcl->ip4, lcl_port, proto);
272 case SESSION_TYPE_IP6_UDP:
273 case SESSION_TYPE_IP6_TCP:
274 return stream_session_lookup_listener6 (&lcl->ip6, lcl_port, proto);
281 stream_session_half_open_lookup (session_manager_main_t * smm,
282 ip46_address_t * lcl, ip46_address_t * rmt,
283 u16 lcl_port, u16 rmt_port, u8 proto)
291 case SESSION_TYPE_IP4_UDP:
292 case SESSION_TYPE_IP4_TCP:
293 make_v4_ss_kv (&kv4, &lcl->ip4, &rmt->ip4, lcl_port, rmt_port, proto);
294 rv = clib_bihash_search_inline_16_8 (&smm->v4_half_open_hash, &kv4);
301 case SESSION_TYPE_IP6_UDP:
302 case SESSION_TYPE_IP6_TCP:
303 make_v6_ss_kv (&kv6, &lcl->ip6, &rmt->ip6, lcl_port, rmt_port, proto);
304 rv = clib_bihash_search_inline_48_8 (&smm->v6_half_open_hash, &kv6);
315 transport_connection_t *
316 stream_session_lookup_transport4 (ip4_address_t * lcl, ip4_address_t * rmt,
317 u16 lcl_port, u16 rmt_port, u8 proto,
320 session_manager_main_t *smm = &session_manager_main;
325 /* Lookup session amongst established ones */
326 make_v4_ss_kv (&kv4, lcl, rmt, lcl_port, rmt_port, proto);
327 rv = clib_bihash_search_inline_16_8 (&smm->v4_session_hash, &kv4);
330 s = stream_session_get_tsi (kv4.value, my_thread_index);
332 return tp_vfts[s->session_type].get_connection (s->connection_index,
336 /* If nothing is found, check if any listener is available */
337 s = stream_session_lookup_listener4 (lcl, lcl_port, proto);
339 return tp_vfts[s->session_type].get_listener (s->connection_index);
341 /* Finally, try half-open connections */
342 rv = clib_bihash_search_inline_16_8 (&smm->v4_half_open_hash, &kv4);
344 return tp_vfts[proto].get_half_open (kv4.value & 0xFFFFFFFF);
349 transport_connection_t *
350 stream_session_lookup_transport6 (ip6_address_t * lcl, ip6_address_t * rmt,
351 u16 lcl_port, u16 rmt_port, u8 proto,
354 session_manager_main_t *smm = &session_manager_main;
359 make_v6_ss_kv (&kv6, lcl, rmt, lcl_port, rmt_port, proto);
360 rv = clib_bihash_search_inline_48_8 (&smm->v6_session_hash, &kv6);
363 s = stream_session_get_tsi (kv6.value, my_thread_index);
365 return tp_vfts[s->session_type].get_connection (s->connection_index,
369 /* If nothing is found, check if any listener is available */
370 s = stream_session_lookup_listener6 (lcl, lcl_port, proto);
372 return tp_vfts[s->session_type].get_listener (s->connection_index);
374 /* Finally, try half-open connections */
375 rv = clib_bihash_search_inline_48_8 (&smm->v6_half_open_hash, &kv6);
377 return tp_vfts[proto].get_half_open (kv6.value & 0xFFFFFFFF);
383 * Allocate vpp event queue (once) per worker thread
386 vpp_session_event_queue_allocate (session_manager_main_t * smm,
389 api_main_t *am = &api_main;
392 if (smm->vpp_event_queues[thread_index] == 0)
394 /* Allocate event fifo in the /vpe-api shared-memory segment */
395 oldheap = svm_push_data_heap (am->vlib_rp);
397 smm->vpp_event_queues[thread_index] =
398 unix_shared_memory_queue_init (2048 /* nels $$$$ config */ ,
399 sizeof (session_fifo_event_t),
400 0 /* consumer pid */ ,
402 /* (do not) send signal when queue non-empty */
405 svm_pop_heap (oldheap);
410 session_manager_get_segment_info (u32 index, u8 ** name, u32 * size)
412 svm_fifo_segment_private_t *s;
413 s = svm_fifo_get_segment (index);
414 *name = s->h->segment_name;
415 *size = s->ssvm.ssvm_size;
419 session_manager_add_segment_i (session_manager_main_t * smm,
420 session_manager_t * sm,
421 u32 segment_size, u8 * segment_name)
423 svm_fifo_segment_create_args_t _ca, *ca = &_ca;
426 memset (ca, 0, sizeof (*ca));
428 ca->segment_name = (char *) segment_name;
429 ca->segment_size = segment_size;
431 rv = svm_fifo_segment_create (ca);
434 clib_warning ("svm_fifo_segment_create ('%s', %d) failed",
435 ca->segment_name, ca->segment_size);
436 vec_free (segment_name);
440 vec_add1 (sm->segment_indices, ca->new_segment_index);
446 session_manager_add_segment (session_manager_main_t * smm,
447 session_manager_t * sm)
450 svm_fifo_segment_create_args_t _ca, *ca = &_ca;
451 u32 add_segment_size;
452 u32 default_segment_size = 128 << 10;
454 memset (ca, 0, sizeof (*ca));
455 segment_name = format (0, "%d-%d%c", getpid (),
456 smm->unique_segment_name_counter++, 0);
458 sm->add_segment_size ? sm->add_segment_size : default_segment_size;
460 return session_manager_add_segment_i (smm, sm, add_segment_size,
465 session_manager_add_first_segment (session_manager_main_t * smm,
466 session_manager_t * sm, u32 segment_size,
469 svm_fifo_segment_create_args_t _ca, *ca = &_ca;
470 memset (ca, 0, sizeof (*ca));
471 *segment_name = format (0, "%d-%d%c", getpid (),
472 smm->unique_segment_name_counter++, 0);
473 return session_manager_add_segment_i (smm, sm, segment_size, *segment_name);
477 session_manager_del (session_manager_main_t * smm, session_manager_t * sm)
479 u32 *deleted_sessions = 0;
480 u32 *deleted_thread_indices = 0;
483 /* Across all fifo segments used by the server */
484 for (j = 0; j < vec_len (sm->segment_indices); j++)
486 svm_fifo_segment_private_t *fifo_segment;
488 /* Vector of fifos allocated in the segment */
489 fifo_segment = svm_fifo_get_segment (sm->segment_indices[j]);
490 fifos = (svm_fifo_t **) fifo_segment->h->fifos;
493 * Remove any residual sessions from the session lookup table
494 * Don't bother deleting the individual fifos, we're going to
495 * throw away the fifo segment in a minute.
497 for (i = 0; i < vec_len (fifos); i++)
500 u32 session_index, thread_index;
501 stream_session_t *session;
504 session_index = fifo->server_session_index;
505 thread_index = fifo->server_thread_index;
507 session = pool_elt_at_index (smm->sessions[thread_index],
510 /* Add to the deleted_sessions vector (once!) */
511 if (!session->is_deleted)
513 session->is_deleted = 1;
514 vec_add1 (deleted_sessions,
515 session - smm->sessions[thread_index]);
516 vec_add1 (deleted_thread_indices, thread_index);
520 for (i = 0; i < vec_len (deleted_sessions); i++)
522 stream_session_t *session;
525 pool_elt_at_index (smm->sessions[deleted_thread_indices[i]],
526 deleted_sessions[i]);
528 /* Instead of directly removing the session call disconnect */
529 stream_session_disconnect (session);
532 stream_session_table_del (smm, session);
533 pool_put(smm->sessions[deleted_thread_indices[i]], session);
537 vec_reset_length (deleted_sessions);
538 vec_reset_length (deleted_thread_indices);
540 /* Instead of removing the segment, test when removing the session if
541 * the segment can be removed
543 /* svm_fifo_segment_delete (fifo_segment); */
546 vec_free (deleted_sessions);
547 vec_free (deleted_thread_indices);
551 session_manager_allocate_session_fifos (session_manager_main_t * smm,
552 session_manager_t * sm,
553 svm_fifo_t ** server_rx_fifo,
554 svm_fifo_t ** server_tx_fifo,
555 u32 * fifo_segment_index,
556 u8 * added_a_segment)
558 svm_fifo_segment_private_t *fifo_segment;
559 u32 fifo_size, default_fifo_size = 128 << 10; /* TODO config */
562 *added_a_segment = 0;
564 /* Allocate svm fifos */
565 ASSERT (vec_len (sm->segment_indices));
568 for (i = 0; i < vec_len (sm->segment_indices); i++)
570 *fifo_segment_index = sm->segment_indices[i];
571 fifo_segment = svm_fifo_get_segment (*fifo_segment_index);
573 fifo_size = sm->rx_fifo_size;
574 fifo_size = (fifo_size == 0) ? default_fifo_size : fifo_size;
575 *server_rx_fifo = svm_fifo_segment_alloc_fifo (fifo_segment, fifo_size);
577 fifo_size = sm->tx_fifo_size;
578 fifo_size = (fifo_size == 0) ? default_fifo_size : fifo_size;
579 *server_tx_fifo = svm_fifo_segment_alloc_fifo (fifo_segment, fifo_size);
581 if (*server_rx_fifo == 0)
583 /* This would be very odd, but handle it... */
584 if (*server_tx_fifo != 0)
586 svm_fifo_segment_free_fifo (fifo_segment, *server_tx_fifo);
591 if (*server_tx_fifo == 0)
593 if (*server_rx_fifo != 0)
595 svm_fifo_segment_free_fifo (fifo_segment, *server_rx_fifo);
603 /* See if we're supposed to create another segment */
604 if (*server_rx_fifo == 0)
608 if (*added_a_segment)
610 clib_warning ("added a segment, still cant allocate a fifo");
611 return SESSION_ERROR_NEW_SEG_NO_SPACE;
614 if (session_manager_add_segment (smm, sm))
615 return VNET_API_ERROR_URI_FIFO_CREATE_FAILED;
617 *added_a_segment = 1;
622 clib_warning ("No space to allocate fifos!");
623 return SESSION_ERROR_NO_SPACE;
630 stream_session_create_i (session_manager_main_t * smm, application_t * app,
631 transport_connection_t * tc,
632 stream_session_t ** ret_s)
635 svm_fifo_t *server_rx_fifo = 0, *server_tx_fifo = 0;
636 u32 fifo_segment_index;
637 u32 pool_index, seg_size;
640 u32 thread_index = tc->thread_index;
641 session_manager_t *sm;
645 sm = session_manager_get (app->session_manager_index);
647 /* Check the API queue */
648 if (app->mode == APP_SERVER && application_api_queue_is_full (app))
649 return SESSION_ERROR_API_QUEUE_FULL;
651 if ((rv = session_manager_allocate_session_fifos (smm, sm, &server_rx_fifo,
657 if (segment_added && app->mode == APP_SERVER)
659 /* Send an API message to the external server, to map new segment */
660 ASSERT (app->cb_fns.add_segment_callback);
662 session_manager_get_segment_info (fifo_segment_index, &seg_name,
664 if (app->cb_fns.add_segment_callback (app->api_client_index, seg_name,
666 return VNET_API_ERROR_URI_FIFO_CREATE_FAILED;
669 /* Create the session */
670 pool_get (smm->sessions[thread_index], s);
671 memset (s, 0, sizeof (*s));
673 /* Initialize backpointers */
674 pool_index = s - smm->sessions[thread_index];
675 server_rx_fifo->server_session_index = pool_index;
676 server_rx_fifo->server_thread_index = thread_index;
678 server_tx_fifo->server_session_index = pool_index;
679 server_tx_fifo->server_thread_index = thread_index;
681 s->server_rx_fifo = server_rx_fifo;
682 s->server_tx_fifo = server_tx_fifo;
684 /* Initialize state machine, such as it is... */
685 s->session_type = app->session_type;
686 s->session_state = SESSION_STATE_CONNECTING;
687 s->app_index = application_get_index (app);
688 s->server_segment_index = fifo_segment_index;
689 s->thread_index = thread_index;
690 s->session_index = pool_index;
692 /* Attach transport to session */
693 s->connection_index = tc->c_index;
695 /* Attach session to transport */
696 tc->s_index = s->session_index;
698 /* Add to the main lookup table */
699 value = (((u64) thread_index) << 32) | (u64) s->session_index;
700 stream_session_table_add_for_tc (app->session_type, tc, value);
708 * Enqueue data for delivery to session peer. Does not notify peer of enqueue
709 * event but on request can queue notification events for later delivery by
710 * calling stream_server_flush_enqueue_events().
712 * @param tc Transport connection which is to be enqueued data
713 * @param data Data to be enqueued
714 * @param len Length of data to be enqueued
715 * @param queue_event Flag to indicate if peer is to be notified or if event
716 * is to be queued. The former is useful when more data is
717 * enqueued and only one event is to be generated.
718 * @return Number of bytes enqueued or a negative value if enqueueing failed.
721 stream_session_enqueue_data (transport_connection_t * tc, u8 * data, u16 len,
727 s = stream_session_get (tc->s_index, tc->thread_index);
729 /* Make sure there's enough space left. We might've filled the pipes */
730 if (PREDICT_FALSE (len > svm_fifo_max_enqueue (s->server_rx_fifo)))
733 enqueued = svm_fifo_enqueue_nowait (s->server_rx_fifo, s->pid, len, data);
737 /* Queue RX event on this fifo. Eventually these will need to be flushed
738 * by calling stream_server_flush_enqueue_events () */
739 session_manager_main_t *smm = vnet_get_session_manager_main ();
740 u32 thread_index = s->thread_index;
741 u32 my_enqueue_epoch = smm->current_enqueue_epoch[thread_index];
743 if (s->enqueue_epoch != my_enqueue_epoch)
745 s->enqueue_epoch = my_enqueue_epoch;
746 vec_add1 (smm->session_indices_to_enqueue_by_thread[thread_index],
747 s - smm->sessions[thread_index]);
754 /** Check if we have space in rx fifo to push more bytes */
756 stream_session_no_space (transport_connection_t * tc, u32 thread_index,
759 stream_session_t *s = stream_session_get (tc->c_index, thread_index);
761 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY))
764 if (data_len > svm_fifo_max_enqueue (s->server_rx_fifo))
771 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
772 u32 offset, u32 max_bytes)
774 stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
775 return svm_fifo_peek (s->server_tx_fifo, s->pid, offset, max_bytes, buffer);
779 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
781 stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
782 return svm_fifo_dequeue_drop (s->server_tx_fifo, s->pid, max_bytes);
786 * Notify session peer that new data has been enqueued.
788 * @param s Stream session for which the event is to be generated.
789 * @param block Flag to indicate if call should block if event queue is full.
791 * @return 0 on succes or negative number if failed to send notification.
794 stream_session_enqueue_notify (stream_session_t * s, u8 block)
797 session_fifo_event_t evt;
798 unix_shared_memory_queue_t *q;
799 static u32 serial_number;
801 if (PREDICT_FALSE (s->session_state == SESSION_STATE_CLOSED))
804 /* Get session's server */
805 app = application_get (s->app_index);
807 /* Fabricate event */
808 evt.fifo = s->server_rx_fifo;
809 evt.event_type = FIFO_EVENT_SERVER_RX;
810 evt.event_id = serial_number++;
811 evt.enqueue_length = svm_fifo_max_dequeue (s->server_rx_fifo);
813 /* Built-in server? Hand event to the callback... */
814 if (app->cb_fns.builtin_server_rx_callback)
815 return app->cb_fns.builtin_server_rx_callback (s, &evt);
817 /* Add event to server's event queue */
818 q = app->event_queue;
820 /* Based on request block (or not) for lack of space */
821 if (block || PREDICT_TRUE (q->cursize < q->maxsize))
822 unix_shared_memory_queue_add (app->event_queue, (u8 *) & evt,
823 0 /* do wait for mutex */ );
828 SESSION_EVT_DBG(s, SESSION_EVT_ENQ, ({
829 ed->data[0] = evt.event_id;
830 ed->data[1] = evt.enqueue_length;
838 * Flushes queue of sessions that are to be notified of new data
841 * @param thread_index Thread index for which the flush is to be performed.
842 * @return 0 on success or a positive number indicating the number of
843 * failures due to API queue being full.
846 session_manager_flush_enqueue_events (u32 thread_index)
848 session_manager_main_t *smm = &session_manager_main;
849 u32 *session_indices_to_enqueue;
852 session_indices_to_enqueue =
853 smm->session_indices_to_enqueue_by_thread[thread_index];
855 for (i = 0; i < vec_len (session_indices_to_enqueue); i++)
857 stream_session_t *s0;
860 s0 = stream_session_get (session_indices_to_enqueue[i], thread_index);
861 if (stream_session_enqueue_notify (s0, 0 /* don't block */ ))
867 vec_reset_length (session_indices_to_enqueue);
869 smm->session_indices_to_enqueue_by_thread[thread_index] =
870 session_indices_to_enqueue;
872 /* Increment enqueue epoch for next round */
873 smm->current_enqueue_epoch[thread_index]++;
879 * Start listening on server's ip/port pair for requested transport.
881 * Creates a 'dummy' stream session with state LISTENING to be used in session
882 * lookups, prior to establishing connection. Requests transport to build
883 * it's own specific listening connection.
886 stream_session_start_listen (u32 server_index, ip46_address_t * ip, u16 port)
888 session_manager_main_t *smm = &session_manager_main;
890 transport_connection_t *tc;
894 srv = application_get (server_index);
896 pool_get (smm->listen_sessions[srv->session_type], s);
897 memset (s, 0, sizeof (*s));
899 s->session_type = srv->session_type;
900 s->session_state = SESSION_STATE_LISTENING;
901 s->session_index = s - smm->listen_sessions[srv->session_type];
902 s->app_index = srv->index;
904 /* Transport bind/listen */
905 tci = tp_vfts[srv->session_type].bind (s->session_index, ip, port);
907 /* Attach transport to session */
908 s->connection_index = tci;
909 tc = tp_vfts[srv->session_type].get_listener (tci);
911 srv->session_index = s->session_index;
913 /* Add to the main lookup table */
914 stream_session_table_add_for_tc (s->session_type, tc, s->session_index);
920 stream_session_stop_listen (u32 server_index)
922 session_manager_main_t *smm = &session_manager_main;
923 stream_session_t *listener;
924 transport_connection_t *tc;
927 srv = application_get (server_index);
928 listener = pool_elt_at_index (smm->listen_sessions[srv->session_type],
931 tc = tp_vfts[srv->session_type].get_listener (listener->connection_index);
932 stream_session_table_del_for_tc (smm, listener->session_type, tc);
934 tp_vfts[srv->session_type].unbind (listener->connection_index);
935 pool_put (smm->listen_sessions[srv->session_type], listener);
939 connect_server_add_segment_cb (application_t * ss, char *segment_name,
942 /* Does exactly nothing, but die */
948 connects_session_manager_init (session_manager_main_t * smm, u8 session_type)
950 session_manager_t *sm;
951 u32 connect_fifo_size = 256 << 10; /* Config? */
952 u32 default_segment_size = 1 << 20;
954 pool_get (smm->session_managers, sm);
955 memset (sm, 0, sizeof (*sm));
957 sm->add_segment_size = default_segment_size;
958 sm->rx_fifo_size = connect_fifo_size;
959 sm->tx_fifo_size = connect_fifo_size;
962 session_manager_add_segment (smm, sm);
963 smm->connect_manager_index[session_type] = sm - smm->session_managers;
967 stream_session_connect_notify (transport_connection_t * tc, u8 sst,
970 session_manager_main_t *smm = &session_manager_main;
972 stream_session_t *new_s = 0;
975 value = stream_session_half_open_lookup (smm, &tc->lcl_ip, &tc->rmt_ip,
976 tc->lcl_port, tc->rmt_port,
978 if (value == HALF_OPEN_LOOKUP_INVALID_VALUE)
980 clib_warning ("This can't be good!");
984 app = application_get (value >> 32);
988 /* Create new session (server segments are allocated if needed) */
989 if (stream_session_create_i (smm, app, tc, &new_s))
992 app->session_index = stream_session_get_index (new_s);
993 app->thread_index = new_s->thread_index;
995 /* Allocate vpp event queue for this thread if needed */
996 vpp_session_event_queue_allocate (smm, tc->thread_index);
1000 app->cb_fns.session_connected_callback (app->api_client_index, new_s,
1003 /* Cleanup session lookup */
1004 stream_session_half_open_table_del (smm, sst, tc);
1008 stream_session_accept_notify (transport_connection_t * tc)
1010 application_t *server;
1011 stream_session_t *s;
1013 s = stream_session_get (tc->s_index, tc->thread_index);
1014 server = application_get (s->app_index);
1015 server->cb_fns.session_accept_callback (s);
1019 * Notification from transport that connection is being closed.
1021 * A disconnect is sent to application but state is not removed. Once
1022 * disconnect is acknowledged by application, session disconnect is called.
1023 * Ultimately this leads to close being called on transport (passive close).
1026 stream_session_disconnect_notify (transport_connection_t * tc)
1028 application_t *server;
1029 stream_session_t *s;
1031 s = stream_session_get (tc->s_index, tc->thread_index);
1032 server = application_get (s->app_index);
1033 server->cb_fns.session_disconnect_callback (s);
1037 * Cleans up session and associated app if needed.
1040 stream_session_delete (stream_session_t * s)
1042 session_manager_main_t *smm = vnet_get_session_manager_main ();
1043 svm_fifo_segment_private_t *fifo_segment;
1046 /* Delete from the main lookup table. */
1047 stream_session_table_del (smm, s);
1049 /* Cleanup fifo segments */
1050 fifo_segment = svm_fifo_get_segment (s->server_segment_index);
1051 svm_fifo_segment_free_fifo (fifo_segment, s->server_rx_fifo);
1052 svm_fifo_segment_free_fifo (fifo_segment, s->server_tx_fifo);
1054 app = application_get_if_valid (s->app_index);
1056 /* No app. A possibility: after disconnect application called unbind */
1060 if (app->mode == APP_CLIENT)
1062 /* Cleanup app if client */
1063 application_del (app);
1065 else if (app->mode == APP_SERVER)
1067 session_manager_t *sm;
1068 svm_fifo_segment_private_t *fifo_segment;
1072 /* For server, see if any segments can be removed */
1073 sm = session_manager_get (app->session_manager_index);
1076 fifo_segment = svm_fifo_get_segment (s->server_segment_index);
1077 fifos = (svm_fifo_t **) fifo_segment->h->fifos;
1079 fifo_index = svm_fifo_segment_index (fifo_segment);
1081 /* Remove segment only if it holds no fifos and not the first */
1082 if (sm->segment_indices[0] != fifo_index && vec_len (fifos) == 0)
1083 svm_fifo_segment_delete (fifo_segment);
1086 pool_put (smm->sessions[s->thread_index], s);
1090 * Notification from transport that connection is being deleted
1092 * This should be called only on previously fully established sessions. For
1093 * instance failed connects should call stream_session_connect_notify and
1094 * indicate that the connect has failed.
1097 stream_session_delete_notify (transport_connection_t * tc)
1099 stream_session_t *s;
1101 /* App might've been removed already */
1102 s = stream_session_get_if_valid (tc->s_index, tc->thread_index);
1107 stream_session_delete (s);
1111 * Notify application that connection has been reset.
1114 stream_session_reset_notify (transport_connection_t * tc)
1116 stream_session_t *s;
1118 s = stream_session_get (tc->s_index, tc->thread_index);
1120 app = application_get (s->app_index);
1121 app->cb_fns.session_reset_callback (s);
1125 * Accept a stream session. Optionally ping the server by callback.
1128 stream_session_accept (transport_connection_t * tc, u32 listener_index,
1131 session_manager_main_t *smm = &session_manager_main;
1132 application_t *server;
1133 stream_session_t *s, *listener;
1137 /* Find the server */
1138 listener = pool_elt_at_index (smm->listen_sessions[sst], listener_index);
1139 server = application_get (listener->app_index);
1141 if ((rv = stream_session_create_i (smm, server, tc, &s)))
1144 /* Allocate vpp event queue for this thread if needed */
1145 vpp_session_event_queue_allocate (smm, tc->thread_index);
1147 /* Shoulder-tap the server */
1150 server->cb_fns.session_accept_callback (s);
1157 stream_session_open (u8 sst, ip46_address_t * addr, u16 port_host_byte_order,
1160 transport_connection_t *tc;
1165 /* Ask transport to open connection */
1166 rv = tp_vfts[sst].open (addr, port_host_byte_order);
1169 clib_warning ("Transport failed to open connection.");
1170 return VNET_API_ERROR_SESSION_CONNECT_FAIL;
1175 /* Get transport connection */
1176 tc = tp_vfts[sst].get_half_open (tci);
1178 /* Store api_client_index and transport connection index */
1179 value = (((u64) app_index) << 32) | (u64) tc->c_index;
1181 /* Add to the half-open lookup table */
1182 stream_session_half_open_table_add (sst, tc, value);
1188 * Disconnect session and propagate to transport. This should eventually
1189 * result in a delete notification that allows us to cleanup session state.
1190 * Called for both active/passive disconnects.
1193 stream_session_disconnect (stream_session_t * s)
1195 s->session_state = SESSION_STATE_CLOSED;
1196 tp_vfts[s->session_type].close (s->connection_index, s->thread_index);
1200 * Cleanup transport and session state.
1202 * Notify transport of the cleanup, wait for a delete notify to actually
1203 * remove the session state.
1206 stream_session_cleanup (stream_session_t * s)
1208 session_manager_main_t *smm = &session_manager_main;
1211 s->session_state = SESSION_STATE_CLOSED;
1213 /* Delete from the main lookup table to avoid more enqueues */
1214 rv = stream_session_table_del (smm, s);
1216 clib_warning ("hash delete error, rv %d", rv);
1218 tp_vfts[s->session_type].cleanup (s->connection_index, s->thread_index);
1222 session_register_transport (u8 type, const transport_proto_vft_t * vft)
1224 session_manager_main_t *smm = vnet_get_session_manager_main ();
1226 vec_validate (tp_vfts, type);
1227 tp_vfts[type] = *vft;
1229 /* If an offset function is provided, then peek instead of dequeue */
1230 smm->session_tx_fns[type] =
1231 (vft->tx_fifo_offset) ? session_tx_fifo_peek_and_snd :
1232 session_tx_fifo_dequeue_and_snd;
1235 transport_proto_vft_t *
1236 session_get_transport_vft (u8 type)
1238 if (type >= vec_len (tp_vfts))
1240 return &tp_vfts[type];
1243 static clib_error_t *
1244 session_manager_main_enable (vlib_main_t * vm)
1246 session_manager_main_t *smm = &session_manager_main;
1247 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1251 num_threads = 1 /* main thread */ + vtm->n_threads;
1253 if (num_threads < 1)
1254 return clib_error_return (0, "n_thread_stacks not set");
1256 /* $$$ config parameters */
1257 svm_fifo_segment_init (0x200000000ULL /* first segment base VA */ ,
1258 20 /* timeout in seconds */ );
1260 /* configure per-thread ** vectors */
1261 vec_validate (smm->sessions, num_threads - 1);
1262 vec_validate (smm->session_indices_to_enqueue_by_thread, num_threads - 1);
1263 vec_validate (smm->tx_buffers, num_threads - 1);
1264 vec_validate (smm->fifo_events, num_threads - 1);
1265 vec_validate (smm->evts_partially_read, num_threads - 1);
1266 vec_validate (smm->current_enqueue_epoch, num_threads - 1);
1267 vec_validate (smm->vpp_event_queues, num_threads - 1);
1269 /* $$$$ preallocate hack config parameter */
1270 for (i = 0; i < 200000; i++)
1272 stream_session_t *ss;
1273 pool_get (smm->sessions[0], ss);
1274 memset (ss, 0, sizeof (*ss));
1277 for (i = 0; i < 200000; i++)
1278 pool_put_index (smm->sessions[0], i);
1280 clib_bihash_init_16_8 (&smm->v4_session_hash, "v4 session table",
1281 200000 /* $$$$ config parameter nbuckets */ ,
1282 (64 << 20) /*$$$ config parameter table size */ );
1283 clib_bihash_init_48_8 (&smm->v6_session_hash, "v6 session table",
1284 200000 /* $$$$ config parameter nbuckets */ ,
1285 (64 << 20) /*$$$ config parameter table size */ );
1287 clib_bihash_init_16_8 (&smm->v4_half_open_hash, "v4 half-open table",
1288 200000 /* $$$$ config parameter nbuckets */ ,
1289 (64 << 20) /*$$$ config parameter table size */ );
1290 clib_bihash_init_48_8 (&smm->v6_half_open_hash, "v6 half-open table",
1291 200000 /* $$$$ config parameter nbuckets */ ,
1292 (64 << 20) /*$$$ config parameter table size */ );
1294 for (i = 0; i < SESSION_N_TYPES; i++)
1295 smm->connect_manager_index[i] = INVALID_INDEX;
1297 smm->is_enabled = 1;
1299 /* Enable TCP transport */
1300 vnet_tcp_enable_disable (vm, 1);
1306 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1310 if (session_manager_main.is_enabled)
1313 vlib_node_set_state (vm, session_queue_node.index,
1314 VLIB_NODE_STATE_POLLING);
1316 return session_manager_main_enable (vm);
1320 session_manager_main.is_enabled = 0;
1321 vlib_node_set_state (vm, session_queue_node.index,
1322 VLIB_NODE_STATE_DISABLED);
1329 session_manager_main_init (vlib_main_t * vm)
1331 session_manager_main_t *smm = &session_manager_main;
1333 smm->vlib_main = vm;
1334 smm->vnet_main = vnet_get_main ();
1335 smm->is_enabled = 0;
1340 VLIB_INIT_FUNCTION (session_manager_main_init)
1342 * fd.io coding-style-patch-verification: ON
1345 * eval: (c-set-style "gnu")