src/vcl/vcl_private.h

   1 /*
   2  * Copyright (c) 2018-2019 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this
   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
  16 #ifndef SRC_VCL_VCL_PRIVATE_H_
  17 #define SRC_VCL_VCL_PRIVATE_H_
  18
  19 #include <vnet/session/application_interface.h>
  20 #include <vcl/vppcom.h>
  21 #include <vcl/vcl_debug.h>
  22
  23 #if (CLIB_DEBUG > 0)
  24 /* Set VPPCOM_DEBUG_INIT 2 for connection debug,
  25  *                       3 for read/write debug output
  26  * or
  27  *    export VCL_DEBUG=<#> to set dynamically.
  28  */
  29 #define VPPCOM_DEBUG_INIT 1
  30 #else
  31 #define VPPCOM_DEBUG_INIT 0
  32 #endif
  33
  34 #define VPPCOM_DEBUG vcm->debug
  35
  36 extern __thread uword __vcl_worker_index;
  37
  38 static inline void
  39 vcl_set_worker_index (uword wrk_index)
  40 {
  41   __vcl_worker_index = wrk_index;
  42 }
  43
  44 static inline uword
  45 vcl_get_worker_index (void)
  46 {
  47   return __vcl_worker_index;
  48 }
  49
  50 /*
  51  * VPPCOM Private definitions and functions.
  52  */
  53 typedef enum
  54 {
  55   STATE_APP_START,
  56   STATE_APP_CONN_VPP,
  57   STATE_APP_ENABLED,
  58   STATE_APP_ATTACHED,
  59   STATE_APP_ADDING_WORKER,
  60   STATE_APP_ADDING_TLS_DATA,
  61   STATE_APP_FAILED,
  62   STATE_APP_READY
  63 } vcl_bapi_app_state_t;
  64
  65 typedef enum vcl_session_state_
  66 {
  67   VCL_STATE_CLOSED,
  68   VCL_STATE_LISTEN,
  69   VCL_STATE_READY,
  70   VCL_STATE_VPP_CLOSING,
  71   VCL_STATE_DISCONNECT,
  72   VCL_STATE_DETACHED,
  73   VCL_STATE_UPDATED,
  74   VCL_STATE_LISTEN_NO_MQ,
  75 } vcl_session_state_t;
  76
  77 typedef struct epoll_event vppcom_epoll_event_t;
  78
  79 typedef struct
  80 {
  81   u32 next_sh;
  82   u32 prev_sh;
  83   u32 vep_sh;
  84   vppcom_epoll_event_t ev;
  85 #define VEP_DEFAULT_ET_MASK  (EPOLLIN|EPOLLOUT)
  86 #define VEP_UNSUPPORTED_EVENTS (EPOLLONESHOT|EPOLLEXCLUSIVE)
  87   u32 et_mask;
  88 } vppcom_epoll_t;
  89
  90 /* Select uses the vcl_si_set as if a clib_bitmap. Make sure they are the
  91  * same size */
  92 STATIC_ASSERT (sizeof (clib_bitmap_t) == sizeof (vcl_si_set),
  93                "vppcom bitmap size mismatch");
  94
  95 typedef struct
  96 {
  97   u8 is_ip4;
  98   ip46_address_t ip46;
  99 } vppcom_ip46_t;
 100
 101 #define VCL_ACCEPTED_F_CLOSED   (1 << 0)
 102 #define VCL_ACCEPTED_F_RESET    (1 << 1)
 103
 104 typedef struct vcl_session_msg
 105 {
 106   union
 107   {
 108     session_accepted_msg_t accepted_msg;
 109   };
 110   u32 flags;
 111 } vcl_session_msg_t;
 112
 113 typedef enum
 114 {
 115   VCL_SESS_ATTR_SERVER,
 116   VCL_SESS_ATTR_CUT_THRU,
 117   VCL_SESS_ATTR_VEP,
 118   VCL_SESS_ATTR_VEP_SESSION,
 119   VCL_SESS_ATTR_LISTEN,         // SOL_SOCKET,SO_ACCEPTCONN
 120   VCL_SESS_ATTR_NONBLOCK,       // fcntl,O_NONBLOCK
 121   VCL_SESS_ATTR_REUSEADDR,      // SOL_SOCKET,SO_REUSEADDR
 122   VCL_SESS_ATTR_REUSEPORT,      // SOL_SOCKET,SO_REUSEPORT
 123   VCL_SESS_ATTR_BROADCAST,      // SOL_SOCKET,SO_BROADCAST
 124   VCL_SESS_ATTR_V6ONLY,         // SOL_TCP,IPV6_V6ONLY
 125   VCL_SESS_ATTR_KEEPALIVE,      // SOL_SOCKET,SO_KEEPALIVE
 126   VCL_SESS_ATTR_TCP_NODELAY,    // SOL_TCP,TCP_NODELAY
 127   VCL_SESS_ATTR_TCP_KEEPIDLE,   // SOL_TCP,TCP_KEEPIDLE
 128   VCL_SESS_ATTR_TCP_KEEPINTVL,  // SOL_TCP,TCP_KEEPINTVL
 129   VCL_SESS_ATTR_SHUT_RD,
 130   VCL_SESS_ATTR_SHUT_WR,
 131   VCL_SESS_ATTR_MAX
 132 } vppcom_session_attr_t;
 133
 134 typedef enum vcl_session_flags_
 135 {
 136   VCL_SESSION_F_CONNECTED = 1 << 0,
 137   VCL_SESSION_F_IS_VEP = 1 << 1,
 138   VCL_SESSION_F_IS_VEP_SESSION = 1 << 2,
 139   VCL_SESSION_F_HAS_RX_EVT = 1 << 3,
 140 } __clib_packed vcl_session_flags_t;
 141
 142 typedef struct vcl_session_
 143 {
 144   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 145
 146 #define _(type, name) type name;
 147   foreach_app_session_field
 148 #undef _
 149   vcl_session_flags_t flags;    /**< see @ref vcl_session_flags_t */
 150   u32 rx_bytes_pending;         /**< bytes rx-ed as segs but not yet freed */
 151
 152   svm_fifo_t *ct_rx_fifo;
 153   svm_fifo_t *ct_tx_fifo;
 154   vcl_session_msg_t *accept_evts_fifo;
 155
 156   u64 vpp_handle;
 157   u32 vpp_thread_index;
 158   u32 listener_index;           /**< index of parent listener (if any) */
 159   int n_accepted_sessions;      /**< sessions accepted by this listener */
 160   u32 attributes;               /**< see @ref vppcom_session_attr_t */
 161   u64 parent_handle;
 162   int libc_epfd;
 163   vppcom_epoll_t vep;
 164
 165   u32 sndbuf_size;              // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
 166   u32 rcvbuf_size;              // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
 167   u32 user_mss;                 // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
 168
 169 #if VCL_ELOG
 170   elog_track_t elog_track;
 171 #endif
 172 } vcl_session_t;
 173
 174 typedef struct vppcom_cfg_t_
 175 {
 176   uword heapsize;
 177   u32 max_workers;
 178   uword segment_baseva;
 179   uword segment_size;
 180   uword add_segment_size;
 181   u32 preallocated_fifo_pairs;
 182   u32 rx_fifo_size;
 183   u32 tx_fifo_size;
 184   u32 event_queue_size;
 185   u32 listen_queue_size;
 186   u8 app_proxy_transport_tcp;
 187   u8 app_proxy_transport_udp;
 188   u8 app_scope_local;
 189   u8 app_scope_global;
 190   u8 *namespace_id;
 191   u64 namespace_secret;
 192   u8 use_mq_eventfd;
 193   f64 app_timeout;
 194   f64 session_timeout;
 195   f64 accept_timeout;
 196   u32 event_ring_size;
 197   char *event_log_path;
 198   u8 *vpp_app_socket_api;       /**< app socket api socket file name */
 199   u8 *vpp_bapi_socket_name;     /**< bapi socket transport socket name */
 200   u32 tls_engine;
 201   u8 mt_wrk_supported;
 202 } vppcom_cfg_t;
 203
 204 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
 205
 206 typedef struct vcl_cut_through_registration_
 207 {
 208   svm_msg_q_t *mq;
 209   svm_msg_q_t *peer_mq;
 210   u32 sid;
 211   u32 epoll_evt_conn_index;     /*< mq evt connection index part of
 212                                    the mqs evtfd epoll (if used) */
 213 } vcl_cut_through_registration_t;
 214
 215 typedef struct vcl_mq_evt_conn_
 216 {
 217   svm_msg_q_t *mq;
 218   int mq_fd;
 219 } vcl_mq_evt_conn_t;
 220
 221 typedef struct vcl_worker_
 222 {
 223   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 224
 225   /* Session pool */
 226   vcl_session_t *sessions;
 227
 228   /** Worker/thread index in current process */
 229   u32 wrk_index;
 230
 231   /** Worker index in vpp*/
 232   u32 vpp_wrk_index;
 233
 234   /**
 235    * Generic api client handle. When binary api is in used, it stores
 236    * the "client_index" and when socket api is use, it stores the sapi
 237    * client handle */
 238   u32 api_client_handle;
 239
 240   /** VPP binary api input queue */
 241   svm_queue_t *vl_input_queue;
 242
 243   /** VPP mq to be used for exchanging control messages */
 244   svm_msg_q_t *ctrl_mq;
 245
 246   /** Message queues epoll fd. Initialized only if using mqs with eventfds */
 247   int mqs_epfd;
 248
 249   /** Pool of event message queue event connections */
 250   vcl_mq_evt_conn_t *mq_evt_conns;
 251
 252   /** Per worker buffer for receiving mq epoll events */
 253   struct epoll_event *mq_events;
 254
 255   /** Hash table for disconnect processing */
 256   uword *session_index_by_vpp_handles;
 257
 258   /** Select bitmaps */
 259   clib_bitmap_t *rd_bitmap;
 260   clib_bitmap_t *wr_bitmap;
 261   clib_bitmap_t *ex_bitmap;
 262
 263   /** Our event message queue */
 264   svm_msg_q_t *app_event_queue;
 265
 266   /** VPP workers event message queues */
 267   svm_msg_q_t **vpp_event_queues;
 268
 269   /** For deadman timers */
 270   clib_time_t clib_time;
 271
 272   /** Vector acting as buffer for mq messages */
 273   svm_msg_q_msg_t *mq_msg_vector;
 274
 275   /** Vector of unhandled events */
 276   session_event_t *unhandled_evts_vector;
 277
 278   u32 *pending_session_wrk_updates;
 279
 280   /** Used also as a thread stop key buffer */
 281   pthread_t thread_id;
 282
 283   /** Current pid, may be different from main_pid if forked child */
 284   pid_t current_pid;
 285
 286   u32 forked_child;
 287
 288   clib_socket_t app_api_sock;
 289   socket_client_main_t bapi_sock_ctx;
 290   api_main_t bapi_api_ctx;
 291
 292   /** vcl needs next epoll_create to go to libc_epoll */
 293   u8 vcl_needs_real_epoll;
 294   volatile int rpc_done;
 295 } vcl_worker_t;
 296
 297 STATIC_ASSERT (sizeof (session_disconnected_msg_t) <= 16,
 298                "disconnected must fit in session_event_t");
 299 STATIC_ASSERT (sizeof (session_reset_msg_t) <= 16,
 300                "disconnected must fit in session_event_t");
 301
 302 typedef void (vcl_rpc_fn_t) (void *args);
 303
 304 typedef struct vppcom_main_t_
 305 {
 306   u8 is_init;
 307   u32 debug;
 308   pthread_t main_cpu;
 309
 310   /** Main process pid */
 311   pid_t main_pid;
 312
 313   /** App's index in vpp. It's used by vpp to identify the app */
 314   u32 app_index;
 315
 316   u8 *app_name;
 317
 318   /** VCL configuration */
 319   vppcom_cfg_t cfg;
 320
 321   volatile u32 forking;
 322
 323   /** Workers */
 324   vcl_worker_t *workers;
 325
 326   /** Lock to protect worker registrations */
 327   clib_spinlock_t workers_lock;
 328
 329   /** Lock to protect segment hash table */
 330   clib_rwlock_t segment_table_lock;
 331
 332   /** Mapped segments table */
 333   uword *segment_table;
 334
 335   /** Control mq obtained from attach */
 336   svm_msg_q_t *ctrl_mq;
 337
 338   fifo_segment_main_t segment_main;
 339
 340   vcl_rpc_fn_t *wrk_rpc_fn;
 341
 342   /*
 343    * Binary api context
 344    */
 345
 346   /* State of the connection, shared between msg RX thread and main thread */
 347   volatile vcl_bapi_app_state_t bapi_app_state;
 348
 349   /* VNET_API_ERROR_FOO -> "Foo" hash table */
 350   uword *error_string_by_error_number;
 351
 352 #ifdef VCL_ELOG
 353   /* VPP Event-logger */
 354   elog_main_t elog_main;
 355   elog_track_t elog_track;
 356 #endif
 357
 358 } vppcom_main_t;
 359
 360 extern vppcom_main_t *vcm;
 361 extern vppcom_main_t _vppcom_main;
 362
 363 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
 364 #define VCL_INVALID_SESSION_HANDLE ((u64)~0)
 365 #define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
 366 #define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
 367
 368 static inline vcl_session_t *
 369 vcl_session_alloc (vcl_worker_t * wrk)
 370 {
 371   vcl_session_t *s;
 372   pool_get (wrk->sessions, s);
 373   memset (s, 0, sizeof (*s));
 374   s->session_index = s - wrk->sessions;
 375   s->listener_index = VCL_INVALID_SESSION_INDEX;
 376   return s;
 377 }
 378
 379 static inline void
 380 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
 381 {
 382   /* Debug level set to 1 to avoid debug messages while ldp is cleaning up */
 383   VDBG (1, "session %u [0x%llx] removed", s->session_index, s->vpp_handle);
 384   pool_put (wrk->sessions, s);
 385 }
 386
 387 static inline vcl_session_t *
 388 vcl_session_get (vcl_worker_t * wrk, u32 session_index)
 389 {
 390   if (pool_is_free_index (wrk->sessions, session_index))
 391     return 0;
 392   return pool_elt_at_index (wrk->sessions, session_index);
 393 }
 394
 395 static inline vcl_session_handle_t
 396 vcl_session_handle_from_wrk_session_index (u32 session_index, u32 wrk_index)
 397 {
 398   ASSERT (session_index < 2 << 24);
 399   return (wrk_index << 24 | session_index);
 400 }
 401
 402 static inline vcl_session_handle_t
 403 vcl_session_handle_from_index (u32 session_index)
 404 {
 405   ASSERT (session_index < 2 << 24);
 406   return (vcl_get_worker_index () << 24 | session_index);
 407 }
 408
 409 static inline vcl_session_handle_t
 410 vcl_session_handle (vcl_session_t * s)
 411 {
 412   return vcl_session_handle_from_index (s->session_index);
 413 }
 414
 415 static inline void
 416 vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
 417 {
 418   *wrk_index = handle >> 24;
 419   *session_index = handle & 0xFFFFFF;
 420 }
 421
 422 static inline vcl_session_t *
 423 vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
 424 {
 425   u32 session_index, wrk_index;
 426   vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
 427   ASSERT (wrk_index == wrk->wrk_index);
 428   return vcl_session_get (wrk, session_index);
 429 }
 430
 431 static inline vcl_session_t *
 432 vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
 433 {
 434   uword *p;
 435   if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
 436     return vcl_session_get (wrk, (u32) p[0]);
 437   return 0;
 438 }
 439
 440 static inline u32
 441 vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
 442 {
 443   uword *p;
 444   if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
 445     return p[0];
 446   return VCL_INVALID_SESSION_INDEX;
 447 }
 448
 449 static inline void
 450 vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
 451 {
 452   hash_set (wrk->session_index_by_vpp_handles, handle, value);
 453 }
 454
 455 static inline void
 456 vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
 457 {
 458   hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
 459 }
 460
 461 static inline uword *
 462 vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
 463 {
 464   return hash_get (wrk->session_index_by_vpp_handles, handle);
 465 }
 466
 467 static inline void
 468 vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
 469                                 u32 value)
 470 {
 471   hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
 472 }
 473
 474 static inline void
 475 vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
 476 {
 477   hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
 478 }
 479
 480 static inline int
 481 vcl_session_is_connectable_listener (vcl_worker_t * wrk,
 482                                      vcl_session_t * session)
 483 {
 484   /* Tell if we session_handle is a QUIC session.
 485    * We can be in the following cases :
 486    * Listen session <- QUIC session <- Stream session
 487    * QUIC session <- Stream session
 488    */
 489   vcl_session_t *ls;
 490   if (session->session_type != VPPCOM_PROTO_QUIC)
 491     return 0;
 492   if (session->listener_index == VCL_INVALID_SESSION_INDEX)
 493     return !(session->session_state == VCL_STATE_LISTEN);
 494   ls = vcl_session_get_w_handle (wrk, session->listener_index);
 495   if (!ls)
 496     return VPPCOM_EBADFD;
 497   return ls->session_state == VCL_STATE_LISTEN;
 498 }
 499
 500 static inline vcl_session_t *
 501 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
 502 {
 503   uword *p;
 504   vcl_session_t *s;
 505
 506   p = hash_get (wrk->session_index_by_vpp_handles, handle);
 507   if (!p)
 508     {
 509       VDBG (0, "could not find listen session: unknown vpp listener handle"
 510             " %llx", handle);
 511       return 0;
 512     }
 513   s = vcl_session_get (wrk, p[0]);
 514   if (!s)
 515     {
 516       VDBG (1, "invalid listen session index (%u)", p[0]);
 517       return 0;
 518     }
 519
 520   ASSERT (s->session_state == VCL_STATE_LISTEN
 521           || s->session_state == VCL_STATE_LISTEN_NO_MQ
 522           || vcl_session_is_connectable_listener (wrk, s));
 523   return s;
 524 }
 525
 526 const char *vppcom_session_state_str (vcl_session_state_t state);
 527
 528 static inline u8
 529 vcl_session_is_ct (vcl_session_t * s)
 530 {
 531   return (s->ct_tx_fifo != 0);
 532 }
 533
 534 static inline u8
 535 vcl_session_is_cl (vcl_session_t * s)
 536 {
 537   if (s->session_type == VPPCOM_PROTO_UDP)
 538     return !(s->flags & VCL_SESSION_F_CONNECTED);
 539   return 0;
 540 }
 541
 542 static inline u8
 543 vcl_session_is_ready (vcl_session_t * s)
 544 {
 545   return (s->session_state == VCL_STATE_READY
 546           || s->session_state == VCL_STATE_VPP_CLOSING);
 547 }
 548
 549 static inline u8
 550 vcl_session_is_open (vcl_session_t * s)
 551 {
 552   return ((vcl_session_is_ready (s))
 553           || (s->session_state == VCL_STATE_LISTEN && vcl_session_is_cl (s)));
 554 }
 555
 556 static inline u8
 557 vcl_session_is_closing (vcl_session_t * s)
 558 {
 559   return (s->session_state == VCL_STATE_VPP_CLOSING
 560           || s->session_state == VCL_STATE_DISCONNECT);
 561 }
 562
 563 static inline u8
 564 vcl_session_is_closed (vcl_session_t * s)
 565 {
 566   return (!s || (s->session_state == VCL_STATE_CLOSED));
 567 }
 568
 569 static inline int
 570 vcl_session_closing_error (vcl_session_t * s)
 571 {
 572   /* Return 0 on closing sockets */
 573   return s->session_state == VCL_STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
 574 }
 575
 576 static inline int
 577 vcl_session_closed_error (vcl_session_t * s)
 578 {
 579   return s->session_state == VCL_STATE_DISCONNECT
 580     ? VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
 581 }
 582
 583 static inline void
 584 vcl_ip_copy_from_ep (ip46_address_t * ip, vppcom_endpt_t * ep)
 585 {
 586   if (ep->is_ip4)
 587     clib_memcpy_fast (&ip->ip4, ep->ip, sizeof (ip4_address_t));
 588   else
 589     clib_memcpy_fast (&ip->ip6, ep->ip, sizeof (ip6_address_t));
 590 }
 591
 592 static inline void
 593 vcl_ip_copy_to_ep (ip46_address_t * ip, vppcom_endpt_t * ep, u8 is_ip4)
 594 {
 595   ep->is_ip4 = is_ip4;
 596   if (is_ip4)
 597     clib_memcpy_fast (ep->ip, &ip->ip4, sizeof (ip4_address_t));
 598   else
 599     clib_memcpy_fast (ep->ip, &ip->ip6, sizeof (ip6_address_t));
 600 }
 601
 602 static inline int
 603 vcl_proto_is_dgram (uint8_t proto)
 604 {
 605   return proto == VPPCOM_PROTO_UDP;
 606 }
 607
 608 static inline u8
 609 vcl_session_has_attr (vcl_session_t * s, u8 attr)
 610 {
 611   return (s->attributes & (1 << attr)) ? 1 : 0;
 612 }
 613
 614 static inline void
 615 vcl_session_set_attr (vcl_session_t * s, u8 attr)
 616 {
 617   s->attributes |= 1 << attr;
 618 }
 619
 620 static inline void
 621 vcl_session_clear_attr (vcl_session_t * s, u8 attr)
 622 {
 623   s->attributes &= ~(1 << attr);
 624 }
 625
 626 /*
 627  * Helpers
 628  */
 629 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
 630 u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
 631 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
 632 int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
 633 int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
 634
 635 vcl_worker_t *vcl_worker_alloc_and_init (void);
 636 void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
 637 int vcl_worker_register_with_vpp (void);
 638 svm_msg_q_t *vcl_worker_ctrl_mq (vcl_worker_t * wrk);
 639
 640 void vcl_flush_mq_events (void);
 641 int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * session,
 642                          vcl_session_handle_t sh, u8 do_disconnect);
 643
 644 void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
 645 u32 vcl_segment_table_lookup (u64 segment_handle);
 646 void vcl_segment_table_del (u64 segment_handle);
 647
 648 int vcl_session_read_ready (vcl_session_t * session);
 649 int vcl_session_write_ready (vcl_session_t * session);
 650
 651 static inline vcl_worker_t *
 652 vcl_worker_get (u32 wrk_index)
 653 {
 654   return pool_elt_at_index (vcm->workers, wrk_index);
 655 }
 656
 657 static inline vcl_worker_t *
 658 vcl_worker_get_if_valid (u32 wrk_index)
 659 {
 660   if (pool_is_free_index (vcm->workers, wrk_index))
 661     return 0;
 662   return pool_elt_at_index (vcm->workers, wrk_index);
 663 }
 664
 665 static inline vcl_worker_t *
 666 vcl_worker_get_current (void)
 667 {
 668   return vcl_worker_get (vcl_get_worker_index ());
 669 }
 670
 671 static inline u8
 672 vcl_n_workers (void)
 673 {
 674   return pool_elts (vcm->workers);
 675 }
 676
 677 static inline svm_msg_q_t *
 678 vcl_session_vpp_evt_q (vcl_worker_t * wrk, vcl_session_t * s)
 679 {
 680   return wrk->vpp_event_queues[s->vpp_thread_index];
 681 }
 682
 683 static inline u64
 684 vcl_vpp_worker_segment_handle (u32 wrk_index)
 685 {
 686   return (VCL_INVALID_SEGMENT_HANDLE - wrk_index - 1);
 687 }
 688
 689 void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
 690                                      u32 wrk_index);
 691 int vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len);
 692
 693 int vcl_segment_attach (u64 segment_handle, char *name,
 694                         ssvm_segment_type_t type, int fd);
 695 void vcl_segment_detach (u64 segment_handle);
 696 void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s);
 697
 698 /*
 699  * VCL Binary API
 700  */
 701 int vcl_bapi_attach (void);
 702 int vcl_bapi_app_worker_add (void);
 703 void vcl_bapi_app_worker_del (vcl_worker_t * wrk);
 704 void vcl_bapi_disconnect_from_vpp (void);
 705 int vcl_bapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
 706 void vcl_bapi_send_application_tls_cert_add (vcl_session_t * session,
 707                                              char *cert, u32 cert_len);
 708 void vcl_bapi_send_application_tls_key_add (vcl_session_t * session,
 709                                             char *key, u32 key_len);
 710 u32 vcl_bapi_max_nsid_len (void);
 711 int vcl_bapi_worker_set (void);
 712
 713 /*
 714  * VCL Socket API
 715  */
 716 int vcl_sapi_attach (void);
 717 int vcl_sapi_app_worker_add (void);
 718 void vcl_sapi_app_worker_del (vcl_worker_t * wrk);
 719 void vcl_sapi_detach (vcl_worker_t * wrk);
 720 int vcl_sapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
 721
 722 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
 723
 724 /*
 725  * fd.io coding-style-patch-verification: ON
 726  *
 727  * Local Variables:
 728  * eval: (c-set-style "gnu")
 729  * End:
 730  */