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