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