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