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 listener_index;           /**< index of parent listener (if any) */
 158   int n_accepted_sessions;      /**< sessions accepted by this listener */
 159   u32 attributes;               /**< see @ref vppcom_session_attr_t */
 160   u64 parent_handle;
 161   int libc_epfd;
 162   vppcom_epoll_t vep;
 163
 164   u32 sndbuf_size;              // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
 165   u32 rcvbuf_size;              // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
 166   u32 user_mss;                 // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
 167
 168 #if VCL_ELOG
 169   elog_track_t elog_track;
 170 #endif
 171 } vcl_session_t;
 172
 173 typedef struct vppcom_cfg_t_
 174 {
 175   uword heapsize;
 176   u32 max_workers;
 177   uword segment_baseva;
 178   uword segment_size;
 179   uword add_segment_size;
 180   u32 preallocated_fifo_pairs;
 181   u32 rx_fifo_size;
 182   u32 tx_fifo_size;
 183   u32 event_queue_size;
 184   u32 listen_queue_size;
 185   u8 app_proxy_transport_tcp;
 186   u8 app_proxy_transport_udp;
 187   u8 app_scope_local;
 188   u8 app_scope_global;
 189   u8 *namespace_id;
 190   u64 namespace_secret;
 191   u8 use_mq_eventfd;
 192   f64 app_timeout;
 193   f64 session_timeout;
 194   f64 accept_timeout;
 195   u32 event_ring_size;
 196   char *event_log_path;
 197   u8 *vpp_app_socket_api;       /**< app socket api socket file name */
 198   u8 *vpp_bapi_socket_name;     /**< bapi socket transport socket name */
 199   u32 tls_engine;
 200   u8 mt_wrk_supported;
 201 } vppcom_cfg_t;
 202
 203 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
 204
 205 typedef struct vcl_cut_through_registration_
 206 {
 207   svm_msg_q_t *mq;
 208   svm_msg_q_t *peer_mq;
 209   u32 sid;
 210   u32 epoll_evt_conn_index;     /*< mq evt connection index part of
 211                                    the mqs evtfd epoll (if used) */
 212 } vcl_cut_through_registration_t;
 213
 214 typedef struct vcl_mq_evt_conn_
 215 {
 216   svm_msg_q_t *mq;
 217   int mq_fd;
 218 } vcl_mq_evt_conn_t;
 219
 220 typedef struct vcl_worker_
 221 {
 222   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 223
 224   /* Session pool */
 225   vcl_session_t *sessions;
 226
 227   /** Worker/thread index in current process */
 228   u32 wrk_index;
 229
 230   /** Worker index in vpp*/
 231   u32 vpp_wrk_index;
 232
 233   /**
 234    * Generic api client handle. When binary api is in used, it stores
 235    * the "client_index" and when socket api is use, it stores the sapi
 236    * client handle */
 237   u32 api_client_handle;
 238
 239   /** VPP binary api input queue */
 240   svm_queue_t *vl_input_queue;
 241
 242   /** VPP mq to be used for exchanging control messages */
 243   svm_msg_q_t *ctrl_mq;
 244
 245   /** Message queues epoll fd. Initialized only if using mqs with eventfds */
 246   int mqs_epfd;
 247
 248   /** Pool of event message queue event connections */
 249   vcl_mq_evt_conn_t *mq_evt_conns;
 250
 251   /** Per worker buffer for receiving mq epoll events */
 252   struct epoll_event *mq_events;
 253
 254   /** Hash table for disconnect processing */
 255   uword *session_index_by_vpp_handles;
 256
 257   /** Select bitmaps */
 258   clib_bitmap_t *rd_bitmap;
 259   clib_bitmap_t *wr_bitmap;
 260   clib_bitmap_t *ex_bitmap;
 261
 262   /** Our event message queue */
 263   svm_msg_q_t *app_event_queue;
 264
 265   /** For deadman timers */
 266   clib_time_t clib_time;
 267
 268   /** Vector acting as buffer for mq messages */
 269   svm_msg_q_msg_t *mq_msg_vector;
 270
 271   /** Vector of unhandled events */
 272   session_event_t *unhandled_evts_vector;
 273
 274   u32 *pending_session_wrk_updates;
 275
 276   /** Used also as a thread stop key buffer */
 277   pthread_t thread_id;
 278
 279   /** Current pid, may be different from main_pid if forked child */
 280   pid_t current_pid;
 281
 282   u32 forked_child;
 283
 284   clib_socket_t app_api_sock;
 285   socket_client_main_t bapi_sock_ctx;
 286   api_main_t bapi_api_ctx;
 287
 288   /** vcl needs next epoll_create to go to libc_epoll */
 289   u8 vcl_needs_real_epoll;
 290   volatile int rpc_done;
 291 } vcl_worker_t;
 292
 293 STATIC_ASSERT (sizeof (session_disconnected_msg_t) <= 16,
 294                "disconnected must fit in session_event_t");
 295 STATIC_ASSERT (sizeof (session_reset_msg_t) <= 16,
 296                "disconnected must fit in session_event_t");
 297
 298 typedef void (vcl_rpc_fn_t) (void *args);
 299
 300 typedef struct vppcom_main_t_
 301 {
 302   u8 is_init;
 303   u32 debug;
 304   pthread_t main_cpu;
 305
 306   /** Main process pid */
 307   pid_t main_pid;
 308
 309   /** App's index in vpp. It's used by vpp to identify the app */
 310   u32 app_index;
 311
 312   u8 *app_name;
 313
 314   /** VCL configuration */
 315   vppcom_cfg_t cfg;
 316
 317   volatile u32 forking;
 318
 319   /** Workers */
 320   vcl_worker_t *workers;
 321
 322   /** Lock to protect worker registrations */
 323   clib_spinlock_t workers_lock;
 324
 325   /** Lock to protect segment hash table */
 326   clib_rwlock_t segment_table_lock;
 327
 328   /** Mapped segments table */
 329   uword *segment_table;
 330
 331   /** Control mq obtained from attach */
 332   svm_msg_q_t *ctrl_mq;
 333
 334   fifo_segment_main_t segment_main;
 335
 336   vcl_rpc_fn_t *wrk_rpc_fn;
 337
 338   /*
 339    * Binary api context
 340    */
 341
 342   /* State of the connection, shared between msg RX thread and main thread */
 343   volatile vcl_bapi_app_state_t bapi_app_state;
 344
 345   /* VNET_API_ERROR_FOO -> "Foo" hash table */
 346   uword *error_string_by_error_number;
 347
 348 #ifdef VCL_ELOG
 349   /* VPP Event-logger */
 350   elog_main_t elog_main;
 351   elog_track_t elog_track;
 352 #endif
 353
 354 } vppcom_main_t;
 355
 356 extern vppcom_main_t *vcm;
 357 extern vppcom_main_t _vppcom_main;
 358
 359 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
 360 #define VCL_INVALID_SESSION_HANDLE ((u64)~0)
 361 #define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
 362 #define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
 363
 364 static inline vcl_session_t *
 365 vcl_session_alloc (vcl_worker_t * wrk)
 366 {
 367   vcl_session_t *s;
 368   pool_get (wrk->sessions, s);
 369   memset (s, 0, sizeof (*s));
 370   s->session_index = s - wrk->sessions;
 371   s->listener_index = VCL_INVALID_SESSION_INDEX;
 372   return s;
 373 }
 374
 375 static inline void
 376 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
 377 {
 378   /* Debug level set to 1 to avoid debug messages while ldp is cleaning up */
 379   VDBG (1, "session %u [0x%llx] removed", s->session_index, s->vpp_handle);
 380   pool_put (wrk->sessions, s);
 381 }
 382
 383 static inline vcl_session_t *
 384 vcl_session_get (vcl_worker_t * wrk, u32 session_index)
 385 {
 386   if (pool_is_free_index (wrk->sessions, session_index))
 387     return 0;
 388   return pool_elt_at_index (wrk->sessions, session_index);
 389 }
 390
 391 static inline vcl_session_handle_t
 392 vcl_session_handle_from_wrk_session_index (u32 session_index, u32 wrk_index)
 393 {
 394   ASSERT (session_index < 2 << 24);
 395   return (wrk_index << 24 | session_index);
 396 }
 397
 398 static inline vcl_session_handle_t
 399 vcl_session_handle_from_index (u32 session_index)
 400 {
 401   ASSERT (session_index < 2 << 24);
 402   return (vcl_get_worker_index () << 24 | session_index);
 403 }
 404
 405 static inline vcl_session_handle_t
 406 vcl_session_handle (vcl_session_t * s)
 407 {
 408   return vcl_session_handle_from_index (s->session_index);
 409 }
 410
 411 static inline void
 412 vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
 413 {
 414   *wrk_index = handle >> 24;
 415   *session_index = handle & 0xFFFFFF;
 416 }
 417
 418 static inline vcl_session_t *
 419 vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
 420 {
 421   u32 session_index, wrk_index;
 422   vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
 423   ASSERT (wrk_index == wrk->wrk_index);
 424   return vcl_session_get (wrk, session_index);
 425 }
 426
 427 static inline vcl_session_t *
 428 vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
 429 {
 430   uword *p;
 431   if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
 432     return vcl_session_get (wrk, (u32) p[0]);
 433   return 0;
 434 }
 435
 436 static inline u32
 437 vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
 438 {
 439   uword *p;
 440   if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
 441     return p[0];
 442   return VCL_INVALID_SESSION_INDEX;
 443 }
 444
 445 static inline void
 446 vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
 447 {
 448   hash_set (wrk->session_index_by_vpp_handles, handle, value);
 449 }
 450
 451 static inline void
 452 vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
 453 {
 454   hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
 455 }
 456
 457 static inline uword *
 458 vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
 459 {
 460   return hash_get (wrk->session_index_by_vpp_handles, handle);
 461 }
 462
 463 static inline void
 464 vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
 465                                 u32 value)
 466 {
 467   hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
 468 }
 469
 470 static inline void
 471 vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
 472 {
 473   hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
 474 }
 475
 476 static inline int
 477 vcl_session_is_connectable_listener (vcl_worker_t * wrk,
 478                                      vcl_session_t * session)
 479 {
 480   /* Tell if we session_handle is a QUIC session.
 481    * We can be in the following cases :
 482    * Listen session <- QUIC session <- Stream session
 483    * QUIC session <- Stream session
 484    */
 485   vcl_session_t *ls;
 486   if (session->session_type != VPPCOM_PROTO_QUIC)
 487     return 0;
 488   if (session->listener_index == VCL_INVALID_SESSION_INDEX)
 489     return !(session->session_state == VCL_STATE_LISTEN);
 490   ls = vcl_session_get_w_handle (wrk, session->listener_index);
 491   if (!ls)
 492     return VPPCOM_EBADFD;
 493   return ls->session_state == VCL_STATE_LISTEN;
 494 }
 495
 496 static inline vcl_session_t *
 497 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
 498 {
 499   uword *p;
 500   vcl_session_t *s;
 501
 502   p = hash_get (wrk->session_index_by_vpp_handles, handle);
 503   if (!p)
 504     {
 505       VDBG (0, "could not find listen session: unknown vpp listener handle"
 506             " %llx", handle);
 507       return 0;
 508     }
 509   s = vcl_session_get (wrk, p[0]);
 510   if (!s)
 511     {
 512       VDBG (1, "invalid listen session index (%u)", p[0]);
 513       return 0;
 514     }
 515
 516   ASSERT (s->session_state == VCL_STATE_LISTEN
 517           || s->session_state == VCL_STATE_LISTEN_NO_MQ
 518           || vcl_session_is_connectable_listener (wrk, s));
 519   return s;
 520 }
 521
 522 const char *vppcom_session_state_str (vcl_session_state_t state);
 523
 524 static inline u8
 525 vcl_session_is_ct (vcl_session_t * s)
 526 {
 527   return (s->ct_tx_fifo != 0);
 528 }
 529
 530 static inline u8
 531 vcl_session_is_cl (vcl_session_t * s)
 532 {
 533   if (s->session_type == VPPCOM_PROTO_UDP)
 534     return !(s->flags & VCL_SESSION_F_CONNECTED);
 535   return 0;
 536 }
 537
 538 static inline u8
 539 vcl_session_is_ready (vcl_session_t * s)
 540 {
 541   return (s->session_state == VCL_STATE_READY
 542           || s->session_state == VCL_STATE_VPP_CLOSING);
 543 }
 544
 545 static inline u8
 546 vcl_session_is_open (vcl_session_t * s)
 547 {
 548   return ((vcl_session_is_ready (s))
 549           || (s->session_state == VCL_STATE_LISTEN && vcl_session_is_cl (s)));
 550 }
 551
 552 static inline u8
 553 vcl_session_is_closing (vcl_session_t * s)
 554 {
 555   return (s->session_state == VCL_STATE_VPP_CLOSING
 556           || s->session_state == VCL_STATE_DISCONNECT);
 557 }
 558
 559 static inline u8
 560 vcl_session_is_closed (vcl_session_t * s)
 561 {
 562   return (!s || (s->session_state == VCL_STATE_CLOSED));
 563 }
 564
 565 static inline int
 566 vcl_session_closing_error (vcl_session_t * s)
 567 {
 568   /* Return 0 on closing sockets */
 569   return s->session_state == VCL_STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
 570 }
 571
 572 static inline int
 573 vcl_session_closed_error (vcl_session_t * s)
 574 {
 575   return s->session_state == VCL_STATE_DISCONNECT
 576     ? VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
 577 }
 578
 579 static inline void
 580 vcl_ip_copy_from_ep (ip46_address_t * ip, vppcom_endpt_t * ep)
 581 {
 582   if (ep->is_ip4)
 583     clib_memcpy_fast (&ip->ip4, ep->ip, sizeof (ip4_address_t));
 584   else
 585     clib_memcpy_fast (&ip->ip6, ep->ip, sizeof (ip6_address_t));
 586 }
 587
 588 static inline void
 589 vcl_ip_copy_to_ep (ip46_address_t * ip, vppcom_endpt_t * ep, u8 is_ip4)
 590 {
 591   ep->is_ip4 = is_ip4;
 592   if (is_ip4)
 593     clib_memcpy_fast (ep->ip, &ip->ip4, sizeof (ip4_address_t));
 594   else
 595     clib_memcpy_fast (ep->ip, &ip->ip6, sizeof (ip6_address_t));
 596 }
 597
 598 static inline int
 599 vcl_proto_is_dgram (uint8_t proto)
 600 {
 601   return proto == VPPCOM_PROTO_UDP;
 602 }
 603
 604 static inline u8
 605 vcl_session_has_attr (vcl_session_t * s, u8 attr)
 606 {
 607   return (s->attributes & (1 << attr)) ? 1 : 0;
 608 }
 609
 610 static inline void
 611 vcl_session_set_attr (vcl_session_t * s, u8 attr)
 612 {
 613   s->attributes |= 1 << attr;
 614 }
 615
 616 static inline void
 617 vcl_session_clear_attr (vcl_session_t * s, u8 attr)
 618 {
 619   s->attributes &= ~(1 << attr);
 620 }
 621
 622 /*
 623  * Helpers
 624  */
 625 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
 626 u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
 627 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
 628 int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
 629 int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
 630
 631 vcl_worker_t *vcl_worker_alloc_and_init (void);
 632 void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
 633 int vcl_worker_register_with_vpp (void);
 634 svm_msg_q_t *vcl_worker_ctrl_mq (vcl_worker_t * wrk);
 635
 636 void vcl_flush_mq_events (void);
 637 int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * session,
 638                          vcl_session_handle_t sh, u8 do_disconnect);
 639
 640 void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
 641 u32 vcl_segment_table_lookup (u64 segment_handle);
 642 void vcl_segment_table_del (u64 segment_handle);
 643
 644 int vcl_session_read_ready (vcl_session_t * session);
 645 int vcl_session_write_ready (vcl_session_t * session);
 646
 647 static inline vcl_worker_t *
 648 vcl_worker_get (u32 wrk_index)
 649 {
 650   return pool_elt_at_index (vcm->workers, wrk_index);
 651 }
 652
 653 static inline vcl_worker_t *
 654 vcl_worker_get_if_valid (u32 wrk_index)
 655 {
 656   if (pool_is_free_index (vcm->workers, wrk_index))
 657     return 0;
 658   return pool_elt_at_index (vcm->workers, wrk_index);
 659 }
 660
 661 static inline vcl_worker_t *
 662 vcl_worker_get_current (void)
 663 {
 664   return vcl_worker_get (vcl_get_worker_index ());
 665 }
 666
 667 static inline u8
 668 vcl_n_workers (void)
 669 {
 670   return pool_elts (vcm->workers);
 671 }
 672
 673 static inline u64
 674 vcl_vpp_worker_segment_handle (u32 wrk_index)
 675 {
 676   return (VCL_INVALID_SEGMENT_HANDLE - wrk_index - 1);
 677 }
 678
 679 void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
 680                                      u32 wrk_index);
 681 int vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len);
 682
 683 int vcl_segment_attach (u64 segment_handle, char *name,
 684                         ssvm_segment_type_t type, int fd);
 685 void vcl_segment_detach (u64 segment_handle);
 686 void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s);
 687
 688 int vcl_segment_attach_session (uword segment_handle, uword rxf_offset,
 689                                 uword txf_offset, uword mq_offset, u8 is_ct,
 690                                 vcl_session_t *s);
 691 int vcl_segment_attach_mq (uword segment_handle, uword mq_offset, u32 mq_index,
 692                            svm_msg_q_t **mq);
 693
 694 /*
 695  * VCL Binary API
 696  */
 697 int vcl_bapi_attach (void);
 698 int vcl_bapi_app_worker_add (void);
 699 void vcl_bapi_app_worker_del (vcl_worker_t * wrk);
 700 void vcl_bapi_disconnect_from_vpp (void);
 701 int vcl_bapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
 702 void vcl_bapi_send_application_tls_cert_add (vcl_session_t * session,
 703                                              char *cert, u32 cert_len);
 704 void vcl_bapi_send_application_tls_key_add (vcl_session_t * session,
 705                                             char *key, u32 key_len);
 706 u32 vcl_bapi_max_nsid_len (void);
 707 int vcl_bapi_worker_set (void);
 708
 709 /*
 710  * VCL Socket API
 711  */
 712 int vcl_sapi_attach (void);
 713 int vcl_sapi_app_worker_add (void);
 714 void vcl_sapi_app_worker_del (vcl_worker_t * wrk);
 715 void vcl_sapi_detach (vcl_worker_t * wrk);
 716 int vcl_sapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
 717
 718 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
 719
 720 /*
 721  * fd.io coding-style-patch-verification: ON
 722  *
 723  * Local Variables:
 724  * eval: (c-set-style "gnu")
 725  * End:
 726  */