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