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