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