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