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