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