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