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