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