LCOV - code coverage report
Current view: top level - vnet/session - session.h (source / functions) Hit Total Coverage
Test: coverage-filtered.info Lines: 140 175 80.0 %
Date: 2023-07-05 22:20:52 Functions: 37 44 84.1 %

          Line data    Source code
       1             : /*
       2             :  * Copyright (c) 2017-2019 Cisco and/or its affiliates.
       3             :  * Licensed under the Apache License, Version 2.0 (the "License");
       4             :  * you may not use this file except in compliance with the License.
       5             :  * You may obtain a copy of the License at:
       6             :  *
       7             :  *     http://www.apache.org/licenses/LICENSE-2.0
       8             :  *
       9             :  * Unless required by applicable law or agreed to in writing, software
      10             :  * distributed under the License is distributed on an "AS IS" BASIS,
      11             :  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      12             :  * See the License for the specific language governing permissions and
      13             :  * limitations under the License.
      14             :  */
      15             : #ifndef __included_session_h__
      16             : #define __included_session_h__
      17             : 
      18             : #include <vppinfra/llist.h>
      19             : #include <vnet/session/session_types.h>
      20             : #include <vnet/session/session_lookup.h>
      21             : #include <vnet/session/session_debug.h>
      22             : #include <svm/message_queue.h>
      23             : #include <svm/fifo_segment.h>
      24             : #include <vlib/dma/dma.h>
      25             : 
      26             : #define foreach_session_input_error                                     \
      27             : _(NO_SESSION, "No session drops")                                       \
      28             : _(NO_LISTENER, "No listener for dst port drops")                        \
      29             : _(ENQUEUED, "Packets pushed into rx fifo")                              \
      30             : _(NOT_READY, "Session not ready packets")                               \
      31             : _(FIFO_FULL, "Packets dropped for lack of rx fifo space")               \
      32             : _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space")      \
      33             : _(API_QUEUE_FULL, "Sessions not created for lack of API queue space")   \
      34             : 
      35             : typedef enum
      36             : {
      37             : #define _(sym,str) SESSION_ERROR_##sym,
      38             :   foreach_session_input_error
      39             : #undef _
      40             :     SESSION_N_ERROR,
      41             : } session_input_error_t;
      42             : 
      43             : typedef struct session_wrk_stats_
      44             : {
      45             :   u32 errors[SESSION_N_ERRORS];
      46             : } session_wrk_stats_t;
      47             : 
      48             : typedef struct session_tx_context_
      49             : {
      50             :   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
      51             :   session_t *s;
      52             :   transport_proto_vft_t *transport_vft;
      53             :   transport_connection_t *tc;
      54             :   transport_send_params_t sp;
      55             :   u32 max_dequeue;
      56             :   u32 left_to_snd;
      57             :   u32 max_len_to_snd;
      58             :   u16 deq_per_first_buf;
      59             :   u16 deq_per_buf;
      60             :   u16 n_segs_per_evt;
      61             :   u16 n_bufs_needed;
      62             :   u8 n_bufs_per_seg;
      63             :     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
      64             :   session_dgram_hdr_t hdr;
      65             : 
      66             :   /** Vector of tx buffer free lists */
      67             :   u32 *tx_buffers;
      68             :   vlib_buffer_t **transport_pending_bufs;
      69             : } session_tx_context_t;
      70             : 
      71             : typedef struct session_evt_elt
      72             : {
      73             :   clib_llist_anchor_t evt_list;
      74             :   session_event_t evt;
      75             : } session_evt_elt_t;
      76             : 
      77             : typedef struct session_ctrl_evt_data_
      78             : {
      79             :   u8 data[SESSION_CTRL_MSG_MAX_SIZE];
      80             : } session_evt_ctrl_data_t;
      81             : 
      82             : typedef enum session_wrk_state_
      83             : {
      84             :   SESSION_WRK_POLLING,
      85             :   SESSION_WRK_INTERRUPT,
      86             :   SESSION_WRK_IDLE,
      87             : } __clib_packed session_wrk_state_t;
      88             : 
      89             : typedef enum session_wrk_flags_
      90             : {
      91             :   SESSION_WRK_F_ADAPTIVE = 1 << 0,
      92             : } __clib_packed session_wrk_flag_t;
      93             : 
      94             : #define DMA_TRANS_SIZE 1024
      95             : typedef struct
      96             : {
      97             :   u32 *pending_tx_buffers;
      98             :   u16 *pending_tx_nexts;
      99             : } session_dma_transfer;
     100             : 
     101             : typedef struct session_worker_
     102             : {
     103             :   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
     104             : 
     105             :   /** Worker session pool */
     106             :   session_t *sessions;
     107             : 
     108             :   /** vpp event message queue for worker */
     109             :   svm_msg_q_t *vpp_event_queue;
     110             : 
     111             :   /** vlib_time_now last time around the track */
     112             :   clib_time_type_t last_vlib_time;
     113             : 
     114             :   /** vlib_time_now rounded to us precision and as u64 */
     115             :   clib_us_time_t last_vlib_us_time;
     116             : 
     117             :   /** Convenience pointer to this worker's vlib_main */
     118             :   vlib_main_t *vm;
     119             : 
     120             :   /** Per-proto vector of sessions to enqueue */
     121             :   u32 **session_to_enqueue;
     122             : 
     123             :   /** Timerfd used to periodically signal wrk session queue node */
     124             :   int timerfd;
     125             : 
     126             :   /** Worker flags */
     127             :   session_wrk_flag_t flags;
     128             : 
     129             :   /** Worker state */
     130             :   session_wrk_state_t state;
     131             : 
     132             :   /** Context for session tx */
     133             :   session_tx_context_t ctx;
     134             : 
     135             :   /** Pool of session event list elements */
     136             :   session_evt_elt_t *event_elts;
     137             : 
     138             :   /** Pool of ctrl events data buffers */
     139             :   session_evt_ctrl_data_t *ctrl_evts_data;
     140             : 
     141             :   /** Head of control events list */
     142             :   clib_llist_index_t ctrl_head;
     143             : 
     144             :   /** Head of list of elements */
     145             :   clib_llist_index_t new_head;
     146             : 
     147             :   /** Head of list of pending events */
     148             :   clib_llist_index_t old_head;
     149             : 
     150             :   /** Vector of buffers to be sent */
     151             :   u32 *pending_tx_buffers;
     152             : 
     153             :   /** Vector of nexts for the pending tx buffers */
     154             :   u16 *pending_tx_nexts;
     155             : 
     156             :   /** Clib file for timerfd. Used only if adaptive mode is on */
     157             :   uword timerfd_file;
     158             : 
     159             :   /** List of pending connects for first worker */
     160             :   clib_llist_index_t pending_connects;
     161             : 
     162             :   /** Flag that is set if main thread signaled to handle connects */
     163             :   u32 n_pending_connects;
     164             : 
     165             :   /** List head for first worker evts pending handling on main */
     166             :   clib_llist_index_t evts_pending_main;
     167             : 
     168             :   int config_index;
     169             :   u8 dma_enabled;
     170             :   session_dma_transfer *dma_trans;
     171             :   u16 trans_head;
     172             :   u16 trans_tail;
     173             :   u16 trans_size;
     174             :   u16 batch_num;
     175             :   vlib_dma_batch_t *batch;
     176             : 
     177             :   session_wrk_stats_t stats;
     178             : 
     179             : #if SESSION_DEBUG
     180             :   /** last event poll time by thread */
     181             :   clib_time_type_t last_event_poll;
     182             : #endif
     183             : } session_worker_t;
     184             : 
     185             : typedef int (session_fifo_rx_fn) (session_worker_t * wrk,
     186             :                                   vlib_node_runtime_t * node,
     187             :                                   session_evt_elt_t * e, int *n_tx_packets);
     188             : 
     189             : extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
     190             : extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
     191             : extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
     192             : 
     193             : u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
     194             : 
     195             : typedef void (*session_update_time_fn) (f64 time_now, u8 thread_index);
     196             : 
     197             : typedef struct session_main_
     198             : {
     199             :   /** Worker contexts */
     200             :   session_worker_t *wrk;
     201             : 
     202             :   /** Vector of transport update time functions */
     203             :   session_update_time_fn *update_time_fns;
     204             : 
     205             :   /** Event queues memfd segment */
     206             :   fifo_segment_t wrk_mqs_segment;
     207             : 
     208             :   /** Unique segment name counter */
     209             :   u32 unique_segment_name_counter;
     210             : 
     211             :   /** Per transport rx function that can either dequeue or peek */
     212             :   session_fifo_rx_fn **session_tx_fns;
     213             : 
     214             :   /** Per session type output nodes. Could optimize to group nodes by
     215             :    * fib but lookup would then require session type parsing in session node.
     216             :    * Trade memory for speed, for now */
     217             :   u32 *session_type_to_next;
     218             : 
     219             :   /** Thread used for allocating active open connections, i.e., half-opens
     220             :    * for transports like tcp, and sessions that will be migrated for cl
     221             :    * transports like udp. If vpp has workers, this will be first worker. */
     222             :   u32 transport_cl_thread;
     223             : 
     224             :   transport_proto_t last_transport_proto_type;
     225             : 
     226             :   /** Number of workers at pool realloc barrier */
     227             :   volatile u32 pool_realloc_at_barrier;
     228             : 
     229             :   /** Number of workers doing reallocs */
     230             :   volatile u32 pool_realloc_doing_work;
     231             : 
     232             :   /** Lock to synchronize parallel forced reallocs */
     233             :   clib_spinlock_t pool_realloc_lock;
     234             : 
     235             :   /*
     236             :    * Config parameters
     237             :    */
     238             : 
     239             :   /** Session manager is enabled */
     240             :   u8 is_enabled;
     241             : 
     242             :   /** Session manager initialized (not necessarily enabled) */
     243             :   u8 is_initialized;
     244             : 
     245             :   /** Enable session manager at startup */
     246             :   u8 session_enable_asap;
     247             : 
     248             :   /** Poll session node in main thread */
     249             :   u8 poll_main;
     250             : 
     251             :   /** Allocate private rx mqs for external apps */
     252             :   u8 use_private_rx_mqs;
     253             : 
     254             :   /** Do not enable session queue node adaptive mode */
     255             :   u8 no_adaptive;
     256             : 
     257             :   /** vpp fifo event queue configured length */
     258             :   u32 configured_wrk_mq_length;
     259             : 
     260             :   /** Session ssvm segment configs*/
     261             :   uword wrk_mqs_segment_size;
     262             : 
     263             :   /** Session enable dma*/
     264             :   u8 dma_enabled;
     265             : 
     266             :   /** Session table size parameters */
     267             :   u32 configured_v4_session_table_buckets;
     268             :   u32 configured_v4_session_table_memory;
     269             :   u32 configured_v4_halfopen_table_buckets;
     270             :   u32 configured_v4_halfopen_table_memory;
     271             :   u32 configured_v6_session_table_buckets;
     272             :   u32 configured_v6_session_table_memory;
     273             :   u32 configured_v6_halfopen_table_buckets;
     274             :   u32 configured_v6_halfopen_table_memory;
     275             : 
     276             :   /** Transport table (preallocation) size parameters */
     277             :   u32 local_endpoints_table_memory;
     278             :   u32 local_endpoints_table_buckets;
     279             : 
     280             :   /** Preallocate session config parameter */
     281             :   u32 preallocated_sessions;
     282             : 
     283             :   u16 msg_id_base;
     284             : } session_main_t;
     285             : 
     286             : extern session_main_t session_main;
     287             : extern vlib_node_registration_t session_queue_node;
     288             : extern vlib_node_registration_t session_queue_process_node;
     289             : extern vlib_node_registration_t session_queue_pre_input_node;
     290             : 
     291             : typedef enum session_q_process_evt_
     292             : {
     293             :   SESSION_Q_PROCESS_RUN_ON_MAIN = 1,
     294             :   SESSION_Q_PROCESS_STOP
     295             : } session_q_process_evt_t;
     296             : 
     297             : #define TRANSPORT_PROTO_INVALID (session_main.last_transport_proto_type + 1)
     298             : #define TRANSPORT_N_PROTOS (session_main.last_transport_proto_type + 1)
     299             : 
     300             : static inline void
     301     1322180 : session_evt_add_old (session_worker_t * wrk, session_evt_elt_t * elt)
     302             : {
     303     1322180 :   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
     304             :                        clib_llist_elt (wrk->event_elts, wrk->old_head));
     305     1322180 : }
     306             : 
     307             : static inline void
     308       72772 : session_evt_add_head_old (session_worker_t * wrk, session_evt_elt_t * elt)
     309             : {
     310       72772 :   clib_llist_add (wrk->event_elts, evt_list, elt,
     311             :                   clib_llist_elt (wrk->event_elts, wrk->old_head));
     312       72772 : }
     313             : 
     314             : 
     315             : static inline u32
     316         273 : session_evt_ctrl_data_alloc (session_worker_t * wrk)
     317             : {
     318             :   session_evt_ctrl_data_t *data;
     319         273 :   pool_get (wrk->ctrl_evts_data, data);
     320         273 :   return (data - wrk->ctrl_evts_data);
     321             : }
     322             : 
     323             : static inline session_evt_elt_t *
     324         892 : session_evt_alloc_ctrl (session_worker_t * wrk)
     325             : {
     326             :   session_evt_elt_t *elt;
     327         892 :   clib_llist_get (wrk->event_elts, elt);
     328         892 :   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
     329             :                        clib_llist_elt (wrk->event_elts, wrk->ctrl_head));
     330         892 :   return elt;
     331             : }
     332             : 
     333             : static inline void *
     334         546 : session_evt_ctrl_data (session_worker_t * wrk, session_evt_elt_t * elt)
     335             : {
     336         546 :   return (void *) (pool_elt_at_index (wrk->ctrl_evts_data,
     337             :                                       elt->evt.ctrl_data_index));
     338             : }
     339             : 
     340             : static inline void
     341         273 : session_evt_ctrl_data_free (session_worker_t * wrk, session_evt_elt_t * elt)
     342             : {
     343         273 :   ASSERT (elt->evt.event_type >= SESSION_CTRL_EVT_RPC);
     344         273 :   pool_put_index (wrk->ctrl_evts_data, elt->evt.ctrl_data_index);
     345         273 : }
     346             : 
     347             : static inline session_evt_elt_t *
     348      180353 : session_evt_alloc_new (session_worker_t * wrk)
     349             : {
     350             :   session_evt_elt_t *elt;
     351      180353 :   clib_llist_get (wrk->event_elts, elt);
     352      180353 :   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
     353             :                        clib_llist_elt (wrk->event_elts, wrk->new_head));
     354      180353 :   return elt;
     355             : }
     356             : 
     357             : static inline session_evt_elt_t *
     358           0 : session_evt_alloc_old (session_worker_t * wrk)
     359             : {
     360             :   session_evt_elt_t *elt;
     361           0 :   clib_llist_get (wrk->event_elts, elt);
     362           0 :   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
     363             :                        clib_llist_elt (wrk->event_elts, wrk->old_head));
     364           0 :   return elt;
     365             : }
     366             : 
     367             : int session_wrk_handle_mq (session_worker_t *wrk, svm_msg_q_t *mq);
     368             : 
     369             : session_t *session_alloc (u32 thread_index);
     370             : void session_free (session_t * s);
     371             : void session_free_w_fifos (session_t * s);
     372             : void session_cleanup_half_open (session_handle_t ho_handle);
     373             : u8 session_is_valid (u32 si, u8 thread_index);
     374             : 
     375             : always_inline session_t *
     376     4592072 : session_get (u32 si, u32 thread_index)
     377             : {
     378     4592072 :   ASSERT (session_is_valid (si, thread_index));
     379     4592072 :   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
     380             : }
     381             : 
     382             : always_inline session_t *
     383       71551 : session_get_if_valid (u64 si, u32 thread_index)
     384             : {
     385       71551 :   if (thread_index >= vec_len (session_main.wrk))
     386          18 :     return 0;
     387             : 
     388       71533 :   if (pool_is_free_index (session_main.wrk[thread_index].sessions, si))
     389          16 :     return 0;
     390             : 
     391       71517 :   ASSERT (session_is_valid (si, thread_index));
     392       71517 :   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
     393             : }
     394             : 
     395             : always_inline session_t *
     396     1350387 : session_get_from_handle (session_handle_t handle)
     397             : {
     398     1350387 :   session_main_t *smm = &session_main;
     399             :   u32 session_index, thread_index;
     400     1350387 :   session_parse_handle (handle, &session_index, &thread_index);
     401     1350387 :   return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
     402             : }
     403             : 
     404             : always_inline session_t *
     405       14246 : session_get_from_handle_if_valid (session_handle_t handle)
     406             : {
     407             :   u32 session_index, thread_index;
     408       14246 :   session_parse_handle (handle, &session_index, &thread_index);
     409       14246 :   return session_get_if_valid (session_index, thread_index);
     410             : }
     411             : 
     412             : u64 session_segment_handle (session_t * s);
     413             : 
     414             : /**
     415             :  * Get session from handle and avoid pool validation if no same thread
     416             :  *
     417             :  * Peekers are fine because pool grows with barrier (see @ref session_alloc)
     418             :  */
     419             : always_inline session_t *
     420       58149 : session_get_from_handle_safe (u64 handle)
     421             : {
     422       58149 :   u32 thread_index = session_thread_from_handle (handle);
     423       58149 :   session_worker_t *wrk = &session_main.wrk[thread_index];
     424             : 
     425       58149 :   if (thread_index == vlib_get_thread_index ())
     426             :     {
     427       58149 :       return pool_elt_at_index (wrk->sessions,
     428             :                                 session_index_from_handle (handle));
     429             :     }
     430             :   else
     431             :     {
     432             :       /* Don't use pool_elt_at index to avoid pool bitmap reallocs */
     433           0 :       return wrk->sessions + session_index_from_handle (handle);
     434             :     }
     435             : }
     436             : 
     437             : always_inline session_t *
     438           0 : session_clone_safe (u32 session_index, u32 thread_index)
     439             : {
     440           0 :   u32 current_thread_index = vlib_get_thread_index (), new_index;
     441             :   session_t *old_s, *new_s;
     442             : 
     443           0 :   new_s = session_alloc (current_thread_index);
     444           0 :   new_index = new_s->session_index;
     445             :   /* Session pools are reallocated with barrier (see @ref session_alloc) */
     446           0 :   old_s = session_main.wrk[thread_index].sessions + session_index;
     447           0 :   clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
     448           0 :   new_s->thread_index = current_thread_index;
     449           0 :   new_s->session_index = new_index;
     450           0 :   return new_s;
     451             : }
     452             : 
     453             : int session_open (session_endpoint_cfg_t *sep, session_handle_t *rsh);
     454             : int session_listen (session_t * s, session_endpoint_cfg_t * sep);
     455             : int session_stop_listen (session_t * s);
     456             : void session_half_close (session_t *s);
     457             : void session_close (session_t * s);
     458             : void session_reset (session_t * s);
     459             : void session_transport_half_close (session_t *s);
     460             : void session_transport_close (session_t * s);
     461             : void session_transport_reset (session_t * s);
     462             : void session_transport_cleanup (session_t * s);
     463             : int session_send_io_evt_to_thread (svm_fifo_t * f,
     464             :                                    session_evt_type_t evt_type);
     465             : int session_enqueue_notify (session_t * s);
     466             : int session_dequeue_notify (session_t * s);
     467             : int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
     468             :                                           session_evt_type_t evt_type);
     469             : void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
     470             :                                      void *rpc_args);
     471             : void session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
     472             :                                            void *rpc_args);
     473             : void session_add_self_custom_tx_evt (transport_connection_t * tc,
     474             :                                      u8 has_prio);
     475             : void sesssion_reschedule_tx (transport_connection_t * tc);
     476             : transport_connection_t *session_get_transport (session_t * s);
     477             : void session_get_endpoint (session_t * s, transport_endpoint_t * tep,
     478             :                            u8 is_lcl);
     479             : int session_transport_attribute (session_t *s, u8 is_get,
     480             :                                  transport_endpt_attr_t *attr);
     481             : 
     482             : u8 *format_session (u8 * s, va_list * args);
     483             : uword unformat_session (unformat_input_t * input, va_list * args);
     484             : uword unformat_transport_connection (unformat_input_t * input,
     485             :                                      va_list * args);
     486             : 
     487             : /*
     488             :  * Interface to transport protos
     489             :  */
     490             : 
     491             : int session_enqueue_stream_connection (transport_connection_t * tc,
     492             :                                        vlib_buffer_t * b, u32 offset,
     493             :                                        u8 queue_event, u8 is_in_order);
     494             : int session_enqueue_dgram_connection (session_t * s,
     495             :                                       session_dgram_hdr_t * hdr,
     496             :                                       vlib_buffer_t * b, u8 proto,
     497             :                                       u8 queue_event);
     498             : int session_stream_connect_notify (transport_connection_t * tc,
     499             :                                    session_error_t err);
     500             : int session_dgram_connect_notify (transport_connection_t * tc,
     501             :                                   u32 old_thread_index,
     502             :                                   session_t ** new_session);
     503             : int session_stream_accept_notify (transport_connection_t * tc);
     504             : void session_transport_closing_notify (transport_connection_t * tc);
     505             : void session_transport_delete_notify (transport_connection_t * tc);
     506             : void session_half_open_delete_notify (transport_connection_t *tc);
     507             : void session_half_open_migrate_notify (transport_connection_t *tc);
     508             : int session_half_open_migrated_notify (transport_connection_t *tc);
     509             : void session_transport_closed_notify (transport_connection_t * tc);
     510             : void session_transport_reset_notify (transport_connection_t * tc);
     511             : int session_stream_accept (transport_connection_t * tc, u32 listener_index,
     512             :                            u32 thread_index, u8 notify);
     513             : int session_dgram_accept (transport_connection_t * tc, u32 listener_index,
     514             :                           u32 thread_index);
     515             : /**
     516             :  * Initialize session layer for given transport proto and ip version
     517             :  *
     518             :  * Allocates per session type (transport proto + ip version) data structures
     519             :  * and adds arc from session queue node to session type output node.
     520             :  *
     521             :  * @param transport_proto       transport proto to be registered
     522             :  * @param vft                   virtual function table for transport
     523             :  * @param is_ip4                flag that indicates if transports uses ipv4
     524             :  *                              as underlying network layer
     525             :  * @param output_node           output node for transport
     526             :  */
     527             : void session_register_transport (transport_proto_t transport_proto,
     528             :                                  const transport_proto_vft_t * vft, u8 is_ip4,
     529             :                                  u32 output_node);
     530             : transport_proto_t session_add_transport_proto (void);
     531             : void session_register_update_time_fn (session_update_time_fn fn, u8 is_add);
     532             : int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
     533             :                                 u32 offset, u32 max_bytes);
     534             : u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
     535             : 
     536             : always_inline void
     537        2438 : session_set_state (session_t *s, session_state_t session_state)
     538             : {
     539        2438 :   s->session_state = session_state;
     540             :   SESSION_EVT (SESSION_EVT_STATE_CHANGE, s);
     541        2438 : }
     542             : 
     543             : always_inline u32
     544       95327 : transport_max_rx_enqueue (transport_connection_t * tc)
     545             : {
     546       95327 :   session_t *s = session_get (tc->s_index, tc->thread_index);
     547       95327 :   return svm_fifo_max_enqueue_prod (s->rx_fifo);
     548             : }
     549             : 
     550             : always_inline u32
     551     2149220 : transport_max_tx_dequeue (transport_connection_t * tc)
     552             : {
     553     2149220 :   session_t *s = session_get (tc->s_index, tc->thread_index);
     554     2149220 :   return svm_fifo_max_dequeue_cons (s->tx_fifo);
     555             : }
     556             : 
     557             : always_inline u32
     558         133 : transport_max_rx_dequeue (transport_connection_t * tc)
     559             : {
     560         133 :   session_t *s = session_get (tc->s_index, tc->thread_index);
     561         133 :   return svm_fifo_max_dequeue (s->rx_fifo);
     562             : }
     563             : 
     564             : always_inline u32
     565           0 : transport_rx_fifo_size (transport_connection_t * tc)
     566             : {
     567           0 :   session_t *s = session_get (tc->s_index, tc->thread_index);
     568           0 :   return svm_fifo_size (s->rx_fifo);
     569             : }
     570             : 
     571             : always_inline u32
     572         267 : transport_tx_fifo_size (transport_connection_t * tc)
     573             : {
     574         267 :   session_t *s = session_get (tc->s_index, tc->thread_index);
     575         267 :   return svm_fifo_size (s->tx_fifo);
     576             : }
     577             : 
     578             : always_inline u8
     579             : transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
     580             : {
     581             :   session_t *s = session_get (tc->c_index, tc->thread_index);
     582             :   return svm_fifo_has_ooo_data (s->rx_fifo);
     583             : }
     584             : 
     585             : always_inline u32
     586          45 : transport_tx_fifo_has_dgram (transport_connection_t *tc)
     587             : {
     588          45 :   session_t *s = session_get (tc->s_index, tc->thread_index);
     589          45 :   u32 max_deq = svm_fifo_max_dequeue_cons (s->tx_fifo);
     590             :   session_dgram_pre_hdr_t phdr;
     591             : 
     592          45 :   if (max_deq <= sizeof (session_dgram_hdr_t))
     593          43 :     return 0;
     594           2 :   svm_fifo_peek (s->tx_fifo, 0, sizeof (phdr), (u8 *) &phdr);
     595           2 :   return max_deq >= phdr.data_length + sizeof (session_dgram_hdr_t);
     596             : }
     597             : 
     598             : always_inline void
     599           0 : transport_rx_fifo_req_deq_ntf (transport_connection_t *tc)
     600             : {
     601           0 :   session_t *s = session_get (tc->s_index, tc->thread_index);
     602           0 :   svm_fifo_add_want_deq_ntf (s->rx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
     603           0 : }
     604             : 
     605             : always_inline clib_time_type_t
     606             : transport_time_now (u32 thread_index)
     607             : {
     608             :   return session_main.wrk[thread_index].last_vlib_time;
     609             : }
     610             : 
     611             : always_inline clib_us_time_t
     612      129655 : transport_us_time_now (u32 thread_index)
     613             : {
     614      129655 :   return session_main.wrk[thread_index].last_vlib_us_time;
     615             : }
     616             : 
     617             : always_inline clib_time_type_t
     618       41205 : transport_seconds_per_loop (u32 thread_index)
     619             : {
     620       41205 :   return session_main.wrk[thread_index].vm->seconds_per_loop;
     621             : }
     622             : 
     623             : always_inline void
     624             : transport_add_tx_event (transport_connection_t * tc)
     625             : {
     626             :   session_t *s = session_get (tc->s_index, tc->thread_index);
     627             :   if (svm_fifo_has_event (s->tx_fifo))
     628             :     return;
     629             :   session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
     630             : }
     631             : 
     632             : always_inline u32
     633        2691 : transport_cl_thread (void)
     634             : {
     635        2691 :   return session_main.transport_cl_thread;
     636             : }
     637             : 
     638             : always_inline u32
     639         708 : session_vlib_thread_is_cl_thread (void)
     640             : {
     641         708 :   return (vlib_get_thread_index () == transport_cl_thread () ||
     642           0 :           vlib_thread_is_main_w_barrier ());
     643             : }
     644             : 
     645             : /*
     646             :  * Listen sessions
     647             :  */
     648             : 
     649             : always_inline u64
     650         431 : listen_session_get_handle (session_t * s)
     651             : {
     652         431 :   ASSERT (s->session_state == SESSION_STATE_LISTENING ||
     653             :           session_get_transport_proto (s) == TRANSPORT_PROTO_QUIC);
     654         431 :   return session_handle (s);
     655             : }
     656             : 
     657             : always_inline session_t *
     658         363 : listen_session_get_from_handle (session_handle_t handle)
     659             : {
     660         363 :   return session_get_from_handle (handle);
     661             : }
     662             : 
     663             : always_inline void
     664             : listen_session_parse_handle (session_handle_t handle, u32 * index,
     665             :                              u32 * thread_index)
     666             : {
     667             :   session_parse_handle (handle, index, thread_index);
     668             : }
     669             : 
     670             : always_inline session_t *
     671          78 : listen_session_alloc (u8 thread_index, session_type_t type)
     672             : {
     673             :   session_t *s;
     674          78 :   s = session_alloc (thread_index);
     675          78 :   s->session_type = type;
     676          78 :   s->session_state = SESSION_STATE_LISTENING;
     677          78 :   return s;
     678             : }
     679             : 
     680             : always_inline session_t *
     681         549 : listen_session_get (u32 ls_index)
     682             : {
     683         549 :   return session_get (ls_index, 0);
     684             : }
     685             : 
     686             : always_inline void
     687          62 : listen_session_free (session_t * s)
     688             : {
     689          62 :   ASSERT (!s->rx_fifo);
     690          62 :   session_free (s);
     691          62 : }
     692             : 
     693             : always_inline session_t *
     694         148 : ho_session_alloc (void)
     695             : {
     696             :   session_t *s;
     697         148 :   ASSERT (session_vlib_thread_is_cl_thread ());
     698         148 :   s = session_alloc (transport_cl_thread ());
     699         148 :   s->session_state = SESSION_STATE_CONNECTING;
     700         148 :   s->flags |= SESSION_F_HALF_OPEN;
     701         148 :   return s;
     702             : }
     703             : 
     704             : always_inline session_t *
     705         305 : ho_session_get (u32 ho_index)
     706             : {
     707         305 :   return session_get (ho_index, transport_cl_thread ());
     708             : }
     709             : 
     710             : always_inline void
     711             : ho_session_free (session_t *s)
     712             : {
     713             :   ASSERT (!s->rx_fifo && s->thread_index == 0);
     714             :   session_free (s);
     715             : }
     716             : 
     717             : transport_connection_t *listen_session_get_transport (session_t * s);
     718             : 
     719             : /*
     720             :  * Session layer functions
     721             :  */
     722             : 
     723             : always_inline session_main_t *
     724    75002249 : vnet_get_session_main ()
     725             : {
     726    75002249 :   return &session_main;
     727             : }
     728             : 
     729             : always_inline session_worker_t *
     730     1232971 : session_main_get_worker (u32 thread_index)
     731             : {
     732     1232971 :   return vec_elt_at_index (session_main.wrk, thread_index);
     733             : }
     734             : 
     735             : static inline session_worker_t *
     736           0 : session_main_get_worker_if_valid (u32 thread_index)
     737             : {
     738           0 :   if (thread_index > vec_len (session_main.wrk))
     739           0 :     return 0;
     740           0 :   return session_main_get_worker (thread_index);
     741             : }
     742             : 
     743             : always_inline svm_msg_q_t *
     744        2227 : session_main_get_vpp_event_queue (u32 thread_index)
     745             : {
     746        2227 :   return session_main_get_worker (thread_index)->vpp_event_queue;
     747             : }
     748             : 
     749             : always_inline u8
     750          97 : session_main_is_enabled ()
     751             : {
     752          97 :   return session_main.is_enabled == 1;
     753             : }
     754             : 
     755             : always_inline void
     756           0 : session_worker_stat_error_inc (session_worker_t *wrk, int error, int value)
     757             : {
     758           0 :   if ((-(error) >= 0 && -(error) < SESSION_N_ERRORS))
     759           0 :     wrk->stats.errors[-error] += value;
     760             :   else
     761             :     SESSION_DBG ("unknown session counter");
     762           0 : }
     763             : 
     764             : always_inline void
     765           0 : session_stat_error_inc (int error, int value)
     766             : {
     767             :   session_worker_t *wrk;
     768           0 :   wrk = session_main_get_worker (vlib_get_thread_index ());
     769           0 :   session_worker_stat_error_inc (wrk, error, value);
     770           0 : }
     771             : 
     772             : #define session_cli_return_if_not_enabled()                             \
     773             : do {                                                                    \
     774             :     if (!session_main.is_enabled)                                       \
     775             :       return clib_error_return (0, "session layer is not enabled");   \
     776             : } while (0)
     777             : 
     778             : int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
     779             : int session_main_flush_all_enqueue_events (u8 transport_proto);
     780             : void session_queue_run_on_main_thread (vlib_main_t * vm);
     781             : 
     782             : /**
     783             :  * Add session node pending buffer with custom node
     784             :  *
     785             :  * @param thread_index  worker thread expected to send the buffer
     786             :  * @param bi            buffer index
     787             :  * @param next_node     next node edge index for buffer. Edge to next node
     788             :  *                      must exist
     789             :  */
     790             : always_inline void
     791       24780 : session_add_pending_tx_buffer (u32 thread_index, u32 bi, u32 next_node)
     792             : {
     793       24780 :   session_worker_t *wrk = session_main_get_worker (thread_index);
     794       24780 :   vec_add1 (wrk->pending_tx_buffers, bi);
     795       24780 :   vec_add1 (wrk->pending_tx_nexts, next_node);
     796       24780 :   if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
     797          22 :     vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
     798       24780 : }
     799             : 
     800             : always_inline void
     801    75072743 : session_wrk_update_time (session_worker_t *wrk, f64 now)
     802             : {
     803    75072743 :   wrk->last_vlib_time = now;
     804    75072743 :   wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
     805    75072743 : }
     806             : 
     807             : void session_wrk_enable_adaptive_mode (session_worker_t *wrk);
     808             : fifo_segment_t *session_main_get_wrk_mqs_segment (void);
     809             : void session_node_enable_disable (u8 is_en);
     810             : clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
     811             : void session_wrk_handle_evts_main_rpc (void *);
     812             : 
     813             : session_t *session_alloc_for_connection (transport_connection_t * tc);
     814             : session_t *session_alloc_for_half_open (transport_connection_t *tc);
     815             : 
     816             : typedef void (pool_safe_realloc_rpc_fn) (void *rpc_args);
     817             : 
     818             : typedef struct
     819             : {
     820             :   u8 ph[STRUCT_OFFSET_OF (pool_header_t, max_elts) + 4];
     821             :   u32 flag;
     822             : } pool_safe_realloc_header_t;
     823             : 
     824             : STATIC_ASSERT_SIZEOF (pool_safe_realloc_header_t, sizeof (pool_header_t));
     825             : 
     826             : #define POOL_REALLOC_SAFE_ELT_THRESH 32
     827             : 
     828             : #define pool_realloc_flag(PH)                                                 \
     829             :   ((pool_safe_realloc_header_t *) pool_header (PH))->flag
     830             : 
     831             : typedef struct pool_realloc_rpc_args_
     832             : {
     833             :   void **pool;
     834             :   uword elt_size;
     835             :   uword align;
     836             : } pool_realloc_rpc_args_t;
     837             : 
     838             : always_inline void
     839          79 : pool_program_safe_realloc_rpc (void *args)
     840             : {
     841          79 :   vlib_main_t *vm = vlib_get_main ();
     842             :   u32 free_elts, max_elts, n_alloc;
     843             :   pool_realloc_rpc_args_t *pra;
     844             : 
     845          79 :   ASSERT (vlib_get_thread_index () == 0);
     846          79 :   pra = (pool_realloc_rpc_args_t *) args;
     847             : 
     848          79 :   vlib_worker_thread_barrier_sync (vm);
     849             : 
     850          79 :   free_elts = _pool_free_elts (*pra->pool, pra->elt_size);
     851          79 :   if (free_elts < POOL_REALLOC_SAFE_ELT_THRESH)
     852             :     {
     853          79 :       max_elts = _vec_max_len (*pra->pool, pra->elt_size);
     854          79 :       n_alloc = clib_max (2 * max_elts, POOL_REALLOC_SAFE_ELT_THRESH);
     855          79 :       _pool_alloc (pra->pool, n_alloc, pra->align, 0, pra->elt_size);
     856             :     }
     857          79 :   pool_realloc_flag (*pra->pool) = 0;
     858          79 :   clib_mem_free (args);
     859             : 
     860          79 :   vlib_worker_thread_barrier_release (vm);
     861          79 : }
     862             : 
     863             : always_inline void
     864          79 : pool_program_safe_realloc (void **p, u32 elt_size, u32 align)
     865             : {
     866             :   pool_realloc_rpc_args_t *pra;
     867             : 
     868             :   /* Reuse pad as a realloc flag */
     869          79 :   if (pool_realloc_flag (*p))
     870           0 :     return;
     871             : 
     872          79 :   pra = clib_mem_alloc (sizeof (*pra));
     873          79 :   pra->pool = p;
     874          79 :   pra->elt_size = elt_size;
     875          79 :   pra->align = align;
     876          79 :   pool_realloc_flag (*p) = 1;
     877             : 
     878          79 :   session_send_rpc_evt_to_thread (0 /* thread index */,
     879             :                                   pool_program_safe_realloc_rpc, pra);
     880             : }
     881             : 
     882             : #define pool_needs_realloc(P)                                                 \
     883             :   ((!P) ||                                                                    \
     884             :    (vec_len (pool_header (P)->free_indices) < POOL_REALLOC_SAFE_ELT_THRESH && \
     885             :     pool_free_elts (P) < POOL_REALLOC_SAFE_ELT_THRESH))
     886             : 
     887             : #define pool_get_aligned_safe(P, E, align)                                    \
     888             :   do                                                                          \
     889             :     {                                                                         \
     890             :       if (PREDICT_FALSE (pool_needs_realloc (P)))                             \
     891             :         {                                                                     \
     892             :           if (PREDICT_FALSE (!(P)))                                           \
     893             :             {                                                                 \
     894             :               pool_alloc_aligned (P, POOL_REALLOC_SAFE_ELT_THRESH, align);    \
     895             :             }                                                                 \
     896             :           else if (PREDICT_FALSE (!pool_free_elts (P)))                       \
     897             :             {                                                                 \
     898             :               vlib_workers_sync ();                                           \
     899             :               pool_alloc_aligned (P, pool_max_len (P), align);                \
     900             :               vlib_workers_continue ();                                       \
     901             :               ALWAYS_ASSERT (pool_free_elts (P) > 0);                         \
     902             :             }                                                                 \
     903             :           else                                                                \
     904             :             {                                                                 \
     905             :               pool_program_safe_realloc ((void **) &(P), sizeof ((P)[0]),     \
     906             :                                          _vec_align (P, align));              \
     907             :             }                                                                 \
     908             :         }                                                                     \
     909             :       pool_get_aligned (P, E, align);                                         \
     910             :     }                                                                         \
     911             :   while (0)
     912             : 
     913             : #endif /* __included_session_h__ */
     914             : 
     915             : /*
     916             :  * fd.io coding-style-patch-verification: ON
     917             :  *
     918             :  * Local Variables:
     919             :  * eval: (c-set-style "gnu")
     920             :  * End:
     921             :  */

Generated by: LCOV version 1.14