src/vnet/session/session.h

   1 /*
   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:
   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 <vnet/session/stream_session.h>
  19 #include <vnet/session/session_lookup.h>
  20 #include <vnet/session/transport_interface.h>
  21 #include <vnet/session/session_debug.h>
  22 #include <vnet/session/segment_manager.h>
  23 #include <svm/queue.h>
  24
  25 #define HALF_OPEN_LOOKUP_INVALID_VALUE ((u64)~0)
  26 #define INVALID_INDEX ((u32)~0)
  27 #define SESSION_PROXY_LISTENER_INDEX ((u8)~0 - 1)
  28 #define SESSION_LOCAL_HANDLE_PREFIX 0x7FFFFFFF
  29
  30 /* TODO decide how much since we have pre-data as well */
  31 #define MAX_HDRS_LEN    100     /* Max number of bytes for headers */
  32
  33 typedef enum
  34 {
  35   FIFO_EVENT_APP_RX,
  36   SESSION_IO_EVT_CT_RX,
  37   FIFO_EVENT_APP_TX,
  38   SESSION_IO_EVT_CT_TX,
  39   FIFO_EVENT_DISCONNECT,
  40   FIFO_EVENT_BUILTIN_RX,
  41   FIFO_EVENT_BUILTIN_TX,
  42   FIFO_EVENT_RPC,
  43   SESSION_CTRL_EVT_BOUND,
  44   SESSION_CTRL_EVT_ACCEPTED,
  45   SESSION_CTRL_EVT_ACCEPTED_REPLY,
  46   SESSION_CTRL_EVT_CONNECTED,
  47   SESSION_CTRL_EVT_CONNECTED_REPLY,
  48   SESSION_CTRL_EVT_DISCONNECTED,
  49   SESSION_CTRL_EVT_DISCONNECTED_REPLY,
  50   SESSION_CTRL_EVT_RESET,
  51   SESSION_CTRL_EVT_RESET_REPLY
  52 } session_evt_type_t;
  53
  54 static inline const char *
  55 fifo_event_type_str (session_evt_type_t et)
  56 {
  57   switch (et)
  58     {
  59     case FIFO_EVENT_APP_RX:
  60       return "FIFO_EVENT_APP_RX";
  61     case FIFO_EVENT_APP_TX:
  62       return "FIFO_EVENT_APP_TX";
  63     case FIFO_EVENT_DISCONNECT:
  64       return "FIFO_EVENT_DISCONNECT";
  65     case FIFO_EVENT_BUILTIN_RX:
  66       return "FIFO_EVENT_BUILTIN_RX";
  67     case FIFO_EVENT_RPC:
  68       return "FIFO_EVENT_RPC";
  69     default:
  70       return "UNKNOWN FIFO EVENT";
  71     }
  72 }
  73
  74 typedef enum
  75 {
  76   SESSION_MQ_IO_EVT_RING,
  77   SESSION_MQ_CTRL_EVT_RING,
  78   SESSION_MQ_N_RINGS
  79 } session_mq_rings_e;
  80
  81 #define foreach_session_input_error                                     \
  82 _(NO_SESSION, "No session drops")                                       \
  83 _(NO_LISTENER, "No listener for dst port drops")                        \
  84 _(ENQUEUED, "Packets pushed into rx fifo")                              \
  85 _(NOT_READY, "Session not ready packets")                               \
  86 _(FIFO_FULL, "Packets dropped for lack of rx fifo space")               \
  87 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space")      \
  88 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space")   \
  89 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair")   \
  90 _(NO_SPACE, "Couldn't allocate a fifo pair")                            \
  91 _(SEG_CREATE, "Couldn't create a new segment")
  92
  93 typedef enum
  94 {
  95 #define _(sym,str) SESSION_ERROR_##sym,
  96   foreach_session_input_error
  97 #undef _
  98     SESSION_N_ERROR,
  99 } session_error_t;
 100
 101 typedef struct
 102 {
 103   void *fp;
 104   void *arg;
 105 } session_rpc_args_t;
 106
 107 typedef u64 session_handle_t;
 108
 109 /* *INDENT-OFF* */
 110 typedef struct
 111 {
 112   u8 event_type;
 113   u8 postponed;
 114   union
 115   {
 116     svm_fifo_t *fifo;
 117     session_handle_t session_handle;
 118     session_rpc_args_t rpc_args;
 119     struct
 120     {
 121       u8 data[0];
 122     };
 123   };
 124 } __clib_packed session_event_t;
 125 /* *INDENT-ON* */
 126
 127 #define SESSION_MSG_NULL { }
 128
 129 typedef struct session_dgram_pre_hdr_
 130 {
 131   u32 data_length;
 132   u32 data_offset;
 133 } session_dgram_pre_hdr_t;
 134
 135 /* *INDENT-OFF* */
 136 typedef CLIB_PACKED (struct session_dgram_header_
 137 {
 138   u32 data_length;
 139   u32 data_offset;
 140   ip46_address_t rmt_ip;
 141   ip46_address_t lcl_ip;
 142   u16 rmt_port;
 143   u16 lcl_port;
 144   u8 is_ip4;
 145 }) session_dgram_hdr_t;
 146 /* *INDENT-ON* */
 147
 148 #define SESSION_CONN_ID_LEN 37
 149 #define SESSION_CONN_HDR_LEN 45
 150
 151 STATIC_ASSERT (sizeof (session_dgram_hdr_t) == (SESSION_CONN_ID_LEN + 8),
 152                "session conn id wrong length");
 153
 154 typedef struct session_tx_context_
 155 {
 156   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 157   stream_session_t *s;
 158   transport_proto_vft_t *transport_vft;
 159   transport_connection_t *tc;
 160   vlib_buffer_t *b;
 161   u32 max_dequeue;
 162   u32 snd_space;
 163   u32 left_to_snd;
 164   u32 tx_offset;
 165   u32 max_len_to_snd;
 166   u16 deq_per_first_buf;
 167   u16 deq_per_buf;
 168   u16 snd_mss;
 169   u16 n_segs_per_evt;
 170   u8 n_bufs_per_seg;
 171     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 172   session_dgram_hdr_t hdr;
 173 } session_tx_context_t;
 174
 175 /* Forward definition */
 176 typedef struct _session_manager_main session_manager_main_t;
 177
 178 typedef int
 179   (session_fifo_rx_fn) (vlib_main_t * vm, vlib_node_runtime_t * node,
 180                         session_event_t * e0, stream_session_t * s0,
 181                         int *n_tx_pkts);
 182
 183 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
 184 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
 185 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
 186
 187 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
 188
 189 typedef struct session_manager_worker_
 190 {
 191   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 192
 193   /** Worker session pool */
 194   stream_session_t *sessions;
 195
 196   /** vpp event message queue for worker */
 197   svm_msg_q_t *vpp_event_queue;
 198
 199   /** Our approximation of a "complete" dispatch loop period */
 200   f64 dispatch_period;
 201
 202   /** vlib_time_now last time around the track */
 203   f64 last_vlib_time;
 204
 205   /** Per-proto enqueue epoch counters */
 206   u64 current_enqueue_epoch[TRANSPORT_N_PROTO];
 207
 208   /** Per-proto vector of sessions to enqueue */
 209   u32 *session_to_enqueue[TRANSPORT_N_PROTO];
 210
 211   /** Context for session tx */
 212   session_tx_context_t ctx;
 213
 214   /** Vector of tx buffer free lists */
 215   u32 *tx_buffers;
 216
 217   /** Vector of partially read events */
 218   session_event_t *free_event_vector;
 219
 220   /** Vector of active event vectors */
 221   session_event_t *pending_event_vector;
 222
 223   /** Vector of postponed disconnects */
 224   session_event_t *pending_disconnects;
 225
 226   /** Peekers rw lock */
 227   clib_rwlock_t peekers_rw_locks;
 228
 229 } session_manager_worker_t;
 230
 231 struct _session_manager_main
 232 {
 233   /** Worker contexts */
 234   session_manager_worker_t *wrk;
 235
 236   /** Event queues memfd segment initialized only if so configured */
 237   ssvm_private_t evt_qs_segment;
 238
 239   /** Unique segment name counter */
 240   u32 unique_segment_name_counter;
 241
 242   /** Per transport rx function that can either dequeue or peek */
 243   session_fifo_rx_fn **session_tx_fns;
 244
 245   /** Per session type output nodes. Could optimize to group nodes by
 246    * fib but lookup would then require session type parsing in session node.
 247    * Trade memory for speed, for now */
 248   u32 *session_type_to_next;
 249
 250   /*
 251    * Config parameters
 252    */
 253
 254   /** Session manager is enabled */
 255   u8 is_enabled;
 256
 257   /** vpp fifo event queue configured length */
 258   u32 configured_event_queue_length;
 259
 260   /** Session ssvm segment configs*/
 261   uword session_baseva;
 262   uword session_va_space_size;
 263   u32 evt_qs_segment_size;
 264   u8 evt_qs_use_memfd_seg;
 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 #if SESSION_DEBUG
 284   /**
 285    * last event poll time by thread
 286    * Debug only. Will cause false cache-line sharing as-is
 287    */
 288   f64 *last_event_poll_by_thread;
 289 #endif
 290
 291 };
 292
 293 extern session_manager_main_t session_manager_main;
 294 extern vlib_node_registration_t session_queue_node;
 295 extern vlib_node_registration_t session_queue_process_node;
 296
 297 #define SESSION_Q_PROCESS_FLUSH_FRAMES  1
 298 #define SESSION_Q_PROCESS_STOP          2
 299
 300 /*
 301  * Session manager function
 302  */
 303 always_inline session_manager_main_t *
 304 vnet_get_session_manager_main ()
 305 {
 306   return &session_manager_main;
 307 }
 308
 309 always_inline session_manager_worker_t *
 310 session_manager_get_worker (u32 thread_index)
 311 {
 312   return &session_manager_main.wrk[thread_index];
 313 }
 314
 315 always_inline u8
 316 stream_session_is_valid (u32 si, u8 thread_index)
 317 {
 318   stream_session_t *s;
 319   s = pool_elt_at_index (session_manager_main.wrk[thread_index].sessions, si);
 320   if (s->thread_index != thread_index || s->session_index != si
 321       /* || s->server_rx_fifo->master_session_index != si
 322          || s->server_tx_fifo->master_session_index != si
 323          || s->server_rx_fifo->master_thread_index != thread_index
 324          || s->server_tx_fifo->master_thread_index != thread_index */ )
 325     return 0;
 326   return 1;
 327 }
 328
 329 stream_session_t *session_alloc (u32 thread_index);
 330 int session_alloc_fifos (segment_manager_t * sm, stream_session_t * s);
 331 void session_free (stream_session_t * s);
 332 void session_free_w_fifos (stream_session_t * s);
 333
 334 always_inline stream_session_t *
 335 session_get (u32 si, u32 thread_index)
 336 {
 337   ASSERT (stream_session_is_valid (si, thread_index));
 338   return pool_elt_at_index (session_manager_main.wrk[thread_index].sessions,
 339                             si);
 340 }
 341
 342 always_inline stream_session_t *
 343 session_get_if_valid (u64 si, u32 thread_index)
 344 {
 345   if (thread_index >= vec_len (session_manager_main.wrk))
 346     return 0;
 347
 348   if (pool_is_free_index (session_manager_main.wrk[thread_index].sessions,
 349                           si))
 350     return 0;
 351
 352   ASSERT (stream_session_is_valid (si, thread_index));
 353   return pool_elt_at_index (session_manager_main.wrk[thread_index].sessions,
 354                             si);
 355 }
 356
 357 always_inline session_handle_t
 358 session_handle (stream_session_t * s)
 359 {
 360   return ((u64) s->thread_index << 32) | (u64) s->session_index;
 361 }
 362
 363 always_inline u32
 364 session_index_from_handle (session_handle_t handle)
 365 {
 366   return handle & 0xFFFFFFFF;
 367 }
 368
 369 always_inline u32
 370 session_thread_from_handle (session_handle_t handle)
 371 {
 372   return handle >> 32;
 373 }
 374
 375 always_inline void
 376 session_parse_handle (session_handle_t handle, u32 * index,
 377                       u32 * thread_index)
 378 {
 379   *index = session_index_from_handle (handle);
 380   *thread_index = session_thread_from_handle (handle);
 381 }
 382
 383 always_inline stream_session_t *
 384 session_get_from_handle (session_handle_t handle)
 385 {
 386   session_manager_main_t *smm = &session_manager_main;
 387   u32 session_index, thread_index;
 388   session_parse_handle (handle, &session_index, &thread_index);
 389   return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
 390 }
 391
 392 always_inline stream_session_t *
 393 session_get_from_handle_if_valid (session_handle_t handle)
 394 {
 395   u32 session_index, thread_index;
 396   session_parse_handle (handle, &session_index, &thread_index);
 397   return session_get_if_valid (session_index, thread_index);
 398 }
 399
 400 always_inline u8
 401 session_handle_is_local (session_handle_t handle)
 402 {
 403   if ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX)
 404     return 1;
 405   return 0;
 406 }
 407
 408 always_inline transport_proto_t
 409 session_type_transport_proto (session_type_t st)
 410 {
 411   return (st >> 1);
 412 }
 413
 414 always_inline u8
 415 session_type_is_ip4 (session_type_t st)
 416 {
 417   return (st & 1);
 418 }
 419
 420 always_inline transport_proto_t
 421 session_get_transport_proto (stream_session_t * s)
 422 {
 423   return (s->session_type >> 1);
 424 }
 425
 426 always_inline fib_protocol_t
 427 session_get_fib_proto (stream_session_t * s)
 428 {
 429   u8 is_ip4 = s->session_type & 1;
 430   return (is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6);
 431 }
 432
 433 always_inline session_type_t
 434 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
 435 {
 436   return (proto << 1 | is_ip4);
 437 }
 438
 439 always_inline u8
 440 session_has_transport (stream_session_t * s)
 441 {
 442   return (session_get_transport_proto (s) != TRANSPORT_PROTO_NONE);
 443 }
 444
 445 transport_service_type_t session_transport_service_type (stream_session_t *);
 446 transport_tx_fn_type_t session_transport_tx_fn_type (stream_session_t *);
 447 u8 session_tx_is_dgram (stream_session_t * s);
 448
 449 /**
 450  * Acquires a lock that blocks a session pool from expanding.
 451  *
 452  * This is typically used for safely peeking into other threads'
 453  * pools in order to clone elements. Lock should be dropped as soon
 454  * as possible by calling @ref session_pool_remove_peeker.
 455  *
 456  * NOTE: Avoid using pool_elt_at_index while the lock is held because
 457  * it may lead to free elt bitmap expansion/contraction!
 458  */
 459 always_inline void
 460 session_pool_add_peeker (u32 thread_index)
 461 {
 462   session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
 463   if (thread_index == vlib_get_thread_index ())
 464     return;
 465   clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
 466 }
 467
 468 always_inline void
 469 session_pool_remove_peeker (u32 thread_index)
 470 {
 471   session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
 472   if (thread_index == vlib_get_thread_index ())
 473     return;
 474   clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
 475 }
 476
 477 /**
 478  * Get session from handle and 'lock' pool resize if not in same thread
 479  *
 480  * Caller should drop the peek 'lock' as soon as possible.
 481  */
 482 always_inline stream_session_t *
 483 session_get_from_handle_safe (u64 handle)
 484 {
 485   u32 thread_index = session_thread_from_handle (handle);
 486   session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
 487
 488   if (thread_index == vlib_get_thread_index ())
 489     {
 490       return pool_elt_at_index (wrk->sessions,
 491                                 session_index_from_handle (handle));
 492     }
 493   else
 494     {
 495       session_pool_add_peeker (thread_index);
 496       /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
 497       return wrk->sessions + session_index_from_handle (handle);
 498     }
 499 }
 500
 501 always_inline u32
 502 transport_max_rx_enqueue (transport_connection_t * tc)
 503 {
 504   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
 505   return svm_fifo_max_enqueue (s->server_rx_fifo);
 506 }
 507
 508 always_inline u32
 509 transport_rx_fifo_size (transport_connection_t * tc)
 510 {
 511   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
 512   return s->server_rx_fifo->nitems;
 513 }
 514
 515 always_inline u32
 516 transport_tx_fifo_size (transport_connection_t * tc)
 517 {
 518   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
 519   return s->server_tx_fifo->nitems;
 520 }
 521
 522 always_inline f64
 523 transport_dispatch_period (u32 thread_index)
 524 {
 525   return session_manager_main.wrk[thread_index].dispatch_period;
 526 }
 527
 528 always_inline f64
 529 transport_time_now (u32 thread_index)
 530 {
 531   return session_manager_main.wrk[thread_index].last_vlib_time;
 532 }
 533
 534 always_inline u32
 535 session_get_index (stream_session_t * s)
 536 {
 537   return (s - session_manager_main.wrk[s->thread_index].sessions);
 538 }
 539
 540 always_inline stream_session_t *
 541 session_clone_safe (u32 session_index, u32 thread_index)
 542 {
 543   stream_session_t *old_s, *new_s;
 544   u32 current_thread_index = vlib_get_thread_index ();
 545
 546   /* If during the memcpy pool is reallocated AND the memory allocator
 547    * decides to give the old chunk of memory to somebody in a hurry to
 548    * scribble something on it, we have a problem. So add this thread as
 549    * a session pool peeker.
 550    */
 551   session_pool_add_peeker (thread_index);
 552   new_s = session_alloc (current_thread_index);
 553   old_s = session_manager_main.wrk[thread_index].sessions + session_index;
 554   clib_memcpy (new_s, old_s, sizeof (*new_s));
 555   session_pool_remove_peeker (thread_index);
 556   new_s->thread_index = current_thread_index;
 557   new_s->session_index = session_get_index (new_s);
 558   return new_s;
 559 }
 560
 561 transport_connection_t *session_get_transport (stream_session_t * s);
 562
 563 u32 session_tx_fifo_max_dequeue (transport_connection_t * tc);
 564
 565 int
 566 session_enqueue_stream_connection (transport_connection_t * tc,
 567                                    vlib_buffer_t * b, u32 offset,
 568                                    u8 queue_event, u8 is_in_order);
 569 int session_enqueue_dgram_connection (stream_session_t * s,
 570                                       session_dgram_hdr_t * hdr,
 571                                       vlib_buffer_t * b, u8 proto,
 572                                       u8 queue_event);
 573 int stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
 574                                u32 offset, u32 max_bytes);
 575 u32 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
 576
 577 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
 578 int session_dgram_connect_notify (transport_connection_t * tc,
 579                                   u32 old_thread_index,
 580                                   stream_session_t ** new_session);
 581 int session_dequeue_notify (stream_session_t * s);
 582 void stream_session_init_fifos_pointers (transport_connection_t * tc,
 583                                          u32 rx_pointer, u32 tx_pointer);
 584
 585 void stream_session_accept_notify (transport_connection_t * tc);
 586 void stream_session_disconnect_notify (transport_connection_t * tc);
 587 void stream_session_delete_notify (transport_connection_t * tc);
 588 void stream_session_reset_notify (transport_connection_t * tc);
 589 int stream_session_accept (transport_connection_t * tc, u32 listener_index,
 590                            u8 notify);
 591 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
 592 int session_listen (stream_session_t * s, session_endpoint_cfg_t * sep);
 593 int session_stop_listen (stream_session_t * s);
 594 void stream_session_disconnect (stream_session_t * s);
 595 void stream_session_disconnect_transport (stream_session_t * s);
 596 void stream_session_cleanup (stream_session_t * s);
 597 int session_send_io_evt_to_thread (svm_fifo_t * f,
 598                                    session_evt_type_t evt_type);
 599 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
 600                                           session_evt_type_t evt_type);
 601 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
 602                                      void *rpc_args);
 603
 604 ssvm_private_t *session_manager_get_evt_q_segment (void);
 605
 606 u8 *format_stream_session (u8 * s, va_list * args);
 607 uword unformat_stream_session (unformat_input_t * input, va_list * args);
 608 uword unformat_transport_connection (unformat_input_t * input,
 609                                      va_list * args);
 610
 611 void session_register_transport (transport_proto_t transport_proto,
 612                                  const transport_proto_vft_t * vft, u8 is_ip4,
 613                                  u32 output_node);
 614
 615 always_inline void
 616 transport_add_tx_event (transport_connection_t * tc)
 617 {
 618   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
 619   if (svm_fifo_has_event (s->server_tx_fifo))
 620     return;
 621   session_send_io_evt_to_thread (s->server_tx_fifo, FIFO_EVENT_APP_TX);
 622 }
 623
 624 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
 625
 626 always_inline svm_msg_q_t *
 627 session_manager_get_vpp_event_queue (u32 thread_index)
 628 {
 629   return session_manager_main.wrk[thread_index].vpp_event_queue;
 630 }
 631
 632 int session_manager_flush_enqueue_events (u8 proto, u32 thread_index);
 633 int session_manager_flush_all_enqueue_events (u8 transport_proto);
 634
 635 always_inline u64
 636 listen_session_get_handle (stream_session_t * s)
 637 {
 638   ASSERT (s->session_state == SESSION_STATE_LISTENING);
 639   return session_handle (s);
 640 }
 641
 642 always_inline stream_session_t *
 643 listen_session_get_from_handle (session_handle_t handle)
 644 {
 645   return session_get_from_handle (handle);
 646 }
 647
 648 always_inline void
 649 listen_session_parse_handle (session_handle_t handle, u32 * index,
 650                              u32 * thread_index)
 651 {
 652   session_parse_handle (handle, index, thread_index);
 653 }
 654
 655 always_inline stream_session_t *
 656 listen_session_new (u8 thread_index, session_type_t type)
 657 {
 658   stream_session_t *s;
 659   s = session_alloc (thread_index);
 660   s->session_type = type;
 661   s->session_state = SESSION_STATE_LISTENING;
 662   return s;
 663 }
 664
 665 always_inline stream_session_t *
 666 listen_session_get (u32 index)
 667 {
 668   return session_get (index, 0);
 669 }
 670
 671 always_inline void
 672 listen_session_del (stream_session_t * s)
 673 {
 674   session_free (s);
 675 }
 676
 677 transport_connection_t *listen_session_get_transport (stream_session_t * s);
 678
 679 int
 680 listen_session_get_local_session_endpoint (stream_session_t * listener,
 681                                            session_endpoint_t * sep);
 682
 683 void session_flush_frames_main_thread (vlib_main_t * vm);
 684
 685 always_inline u8
 686 session_manager_is_enabled ()
 687 {
 688   return session_manager_main.is_enabled == 1;
 689 }
 690
 691 #define session_cli_return_if_not_enabled()                             \
 692 do {                                                                    \
 693     if (!session_manager_main.is_enabled)                               \
 694       return clib_error_return(0, "session layer is not enabled");      \
 695 } while (0)
 696
 697 void session_node_enable_disable (u8 is_en);
 698
 699 #endif /* __included_session_h__ */
 700
 701 /*
 702  * fd.io coding-style-patch-verification: ON
 703  *
 704  * Local Variables:
 705  * eval: (c-set-style "gnu")
 706  * End:
 707  */