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 } app_state_t;
  64
  65 typedef enum
  66 {
  67   STATE_START = 0,
  68   STATE_CONNECT = 0x01,
  69   STATE_LISTEN = 0x02,
  70   STATE_ACCEPT = 0x04,
  71   STATE_VPP_CLOSING = 0x08,
  72   STATE_DISCONNECT = 0x10,
  73   STATE_FAILED = 0x20,
  74   STATE_UPDATED = 0x40,
  75   STATE_LISTEN_NO_MQ = 0x80,
  76 } vcl_session_state_t;
  77
  78 #define SERVER_STATE_OPEN  (STATE_ACCEPT|STATE_VPP_CLOSING)
  79 #define CLIENT_STATE_OPEN  (STATE_CONNECT|STATE_VPP_CLOSING)
  80 #define STATE_OPEN (SERVER_STATE_OPEN | CLIENT_STATE_OPEN)
  81
  82 typedef struct epoll_event vppcom_epoll_event_t;
  83
  84 typedef struct
  85 {
  86   u32 next_sh;
  87   u32 prev_sh;
  88   u32 vep_sh;
  89   vppcom_epoll_event_t ev;
  90 #define VEP_DEFAULT_ET_MASK  (EPOLLIN|EPOLLOUT)
  91 #define VEP_UNSUPPORTED_EVENTS (EPOLLONESHOT|EPOLLEXCLUSIVE)
  92   u32 et_mask;
  93 } vppcom_epoll_t;
  94
  95 /* Select uses the vcl_si_set as if a clib_bitmap. Make sure they are the
  96  * same size */
  97 STATIC_ASSERT (sizeof (clib_bitmap_t) == sizeof (vcl_si_set),
  98                "vppcom bitmap size mismatch");
  99
 100 typedef struct
 101 {
 102   u8 is_ip4;
 103   ip46_address_t ip46;
 104 } vppcom_ip46_t;
 105
 106 #define VCL_ACCEPTED_F_CLOSED   (1 << 0)
 107 #define VCL_ACCEPTED_F_RESET    (1 << 1)
 108
 109 typedef struct vcl_session_msg
 110 {
 111   u32 next;
 112   union
 113   {
 114     session_accepted_msg_t accepted_msg;
 115   };
 116   u32 flags;
 117 } vcl_session_msg_t;
 118
 119 typedef enum
 120 {
 121   VCL_SESS_ATTR_SERVER,
 122   VCL_SESS_ATTR_CUT_THRU,
 123   VCL_SESS_ATTR_VEP,
 124   VCL_SESS_ATTR_VEP_SESSION,
 125   VCL_SESS_ATTR_LISTEN,         // SOL_SOCKET,SO_ACCEPTCONN
 126   VCL_SESS_ATTR_NONBLOCK,       // fcntl,O_NONBLOCK
 127   VCL_SESS_ATTR_REUSEADDR,      // SOL_SOCKET,SO_REUSEADDR
 128   VCL_SESS_ATTR_REUSEPORT,      // SOL_SOCKET,SO_REUSEPORT
 129   VCL_SESS_ATTR_BROADCAST,      // SOL_SOCKET,SO_BROADCAST
 130   VCL_SESS_ATTR_V6ONLY,         // SOL_TCP,IPV6_V6ONLY
 131   VCL_SESS_ATTR_KEEPALIVE,      // SOL_SOCKET,SO_KEEPALIVE
 132   VCL_SESS_ATTR_TCP_NODELAY,    // SOL_TCP,TCP_NODELAY
 133   VCL_SESS_ATTR_TCP_KEEPIDLE,   // SOL_TCP,TCP_KEEPIDLE
 134   VCL_SESS_ATTR_TCP_KEEPINTVL,  // SOL_TCP,TCP_KEEPINTVL
 135   VCL_SESS_ATTR_SHUT_RD,
 136   VCL_SESS_ATTR_SHUT_WR,
 137   VCL_SESS_ATTR_MAX
 138 } vppcom_session_attr_t;
 139
 140 #define VCL_SESS_ATTR_SET(ATTR, VAL)            \
 141 do {                                            \
 142   (ATTR) |= 1 << (VAL);                         \
 143  } while (0)
 144
 145 #define VCL_SESS_ATTR_CLR(ATTR, VAL)            \
 146 do {                                            \
 147   (ATTR) &= ~(1 << (VAL));                      \
 148  } while (0)
 149
 150 #define VCL_SESS_ATTR_TEST(ATTR, VAL)           \
 151   ((ATTR) & (1 << (VAL)) ? 1 : 0)
 152
 153 typedef struct
 154 {
 155   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 156 #define _(type, name) type name;
 157   foreach_app_session_field
 158 #undef _
 159   u32 sndbuf_size;              // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
 160   u32 rcvbuf_size;              // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
 161   u32 user_mss;                 // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
 162   u64 vpp_handle;
 163   u32 vpp_thread_index;
 164
 165   svm_fifo_t *ct_rx_fifo;
 166   svm_fifo_t *ct_tx_fifo;
 167
 168   /* Socket configuration state */
 169   u8 is_vep;
 170   u8 is_vep_session;
 171   /* VCL session index of the listening session (if any) */
 172   u32 listener_index;
 173   /* Accepted sessions on this listener */
 174   int n_accepted_sessions;
 175   u8 has_rx_evt;
 176   u32 attr;
 177   u64 parent_handle;
 178   vppcom_epoll_t vep;
 179   int libc_epfd;
 180   svm_msg_q_t *our_evt_q;
 181   vcl_session_msg_t *accept_evts_fifo;
 182 #if VCL_ELOG
 183   elog_track_t elog_track;
 184 #endif
 185 } vcl_session_t;
 186
 187 typedef struct vppcom_cfg_t_
 188 {
 189   uword heapsize;
 190   u32 max_workers;
 191   u32 vpp_api_q_length;
 192   uword segment_baseva;
 193   u32 segment_size;
 194   u32 add_segment_size;
 195   u32 preallocated_fifo_pairs;
 196   u32 rx_fifo_size;
 197   u32 tx_fifo_size;
 198   u32 event_queue_size;
 199   u32 listen_queue_size;
 200   u8 app_proxy_transport_tcp;
 201   u8 app_proxy_transport_udp;
 202   u8 app_scope_local;
 203   u8 app_scope_global;
 204   u8 *namespace_id;
 205   u64 namespace_secret;
 206   u8 use_mq_eventfd;
 207   f64 app_timeout;
 208   f64 session_timeout;
 209   f64 accept_timeout;
 210   u32 event_ring_size;
 211   char *event_log_path;
 212   u8 *vpp_api_filename;
 213   u8 *vpp_api_socket_name;
 214 } vppcom_cfg_t;
 215
 216 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
 217
 218 typedef struct vcl_cut_through_registration_
 219 {
 220   svm_msg_q_t *mq;
 221   svm_msg_q_t *peer_mq;
 222   u32 sid;
 223   u32 epoll_evt_conn_index;     /*< mq evt connection index part of
 224                                    the mqs evtfd epoll (if used) */
 225 } vcl_cut_through_registration_t;
 226
 227 typedef struct vcl_mq_evt_conn_
 228 {
 229   svm_msg_q_t *mq;
 230   int mq_fd;
 231 } vcl_mq_evt_conn_t;
 232
 233 typedef struct vcl_worker_
 234 {
 235   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 236
 237   /* Session pool */
 238   vcl_session_t *sessions;
 239
 240   /** Worker/thread index in current process */
 241   u32 wrk_index;
 242
 243   /** Worker index in vpp*/
 244   u32 vpp_wrk_index;
 245
 246   /** API client handle */
 247   u32 my_client_index;
 248
 249   /** State of the connection, shared between msg RX thread and main thread */
 250   volatile app_state_t wrk_state;
 251
 252   /** VPP binary api input queue */
 253   svm_queue_t *vl_input_queue;
 254
 255   /** VPP mq to be used for exchanging control messages */
 256   svm_msg_q_t *ctrl_mq;
 257
 258   /** Message queues epoll fd. Initialized only if using mqs with eventfds */
 259   int mqs_epfd;
 260
 261   /** Pool of event message queue event connections */
 262   vcl_mq_evt_conn_t *mq_evt_conns;
 263
 264   /** Per worker buffer for receiving mq epoll events */
 265   struct epoll_event *mq_events;
 266
 267   /** Hash table for disconnect processing */
 268   uword *session_index_by_vpp_handles;
 269
 270   /** Select bitmaps */
 271   clib_bitmap_t *rd_bitmap;
 272   clib_bitmap_t *wr_bitmap;
 273   clib_bitmap_t *ex_bitmap;
 274
 275   /** Our event message queue */
 276   svm_msg_q_t *app_event_queue;
 277
 278   /** VPP workers event message queues */
 279   svm_msg_q_t **vpp_event_queues;
 280
 281   /** For deadman timers */
 282   clib_time_t clib_time;
 283
 284   /** Vector acting as buffer for mq messages */
 285   svm_msg_q_msg_t *mq_msg_vector;
 286
 287   /** Vector of unhandled events */
 288   session_event_t *unhandled_evts_vector;
 289
 290   u32 *pending_session_wrk_updates;
 291
 292   /** Used also as a thread stop key buffer */
 293   pthread_t thread_id;
 294
 295   /** Current pid, may be different from main_pid if forked child */
 296   pid_t current_pid;
 297
 298   u32 forked_child;
 299
 300 } vcl_worker_t;
 301
 302 typedef struct vppcom_main_t_
 303 {
 304   u8 is_init;
 305   u32 debug;
 306   pthread_t main_cpu;
 307
 308   /** Main process pid */
 309   pid_t main_pid;
 310
 311   /** App's index in vpp. It's used by vpp to identify the app */
 312   u32 app_index;
 313
 314   /** State of the connection, shared between msg RX thread and main thread */
 315   volatile app_state_t app_state;
 316
 317   u8 *app_name;
 318
 319   /** VCL configuration */
 320   vppcom_cfg_t cfg;
 321
 322   volatile u32 forking;
 323
 324   /** Workers */
 325   vcl_worker_t *workers;
 326
 327   /** Lock to protect worker registrations */
 328   clib_spinlock_t workers_lock;
 329
 330   /** Lock to protect segment hash table */
 331   clib_rwlock_t segment_table_lock;
 332
 333   /** Mapped segments table */
 334   uword *segment_table;
 335
 336   fifo_segment_main_t segment_main;
 337
 338 #ifdef VCL_ELOG
 339   /* VPP Event-logger */
 340   elog_main_t elog_main;
 341   elog_track_t elog_track;
 342 #endif
 343
 344   /* VNET_API_ERROR_FOO -> "Foo" hash table */
 345   uword *error_string_by_error_number;
 346
 347 } vppcom_main_t;
 348
 349 extern vppcom_main_t *vcm;
 350
 351 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
 352 #define VCL_INVALID_SESSION_HANDLE ((u64)~0)
 353 #define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
 354 #define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
 355
 356 static inline vcl_session_t *
 357 vcl_session_alloc (vcl_worker_t * wrk)
 358 {
 359   vcl_session_t *s;
 360   pool_get (wrk->sessions, s);
 361   memset (s, 0, sizeof (*s));
 362   s->session_index = s - wrk->sessions;
 363   s->listener_index = VCL_INVALID_SESSION_INDEX;
 364   return s;
 365 }
 366
 367 static inline void
 368 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
 369 {
 370   pool_put (wrk->sessions, s);
 371 }
 372
 373 static inline vcl_session_t *
 374 vcl_session_get (vcl_worker_t * wrk, u32 session_index)
 375 {
 376   if (pool_is_free_index (wrk->sessions, session_index))
 377     return 0;
 378   return pool_elt_at_index (wrk->sessions, session_index);
 379 }
 380
 381 static inline vcl_session_handle_t
 382 vcl_session_handle_from_index (u32 session_index)
 383 {
 384   ASSERT (session_index < 2 << 24);
 385   return (vcl_get_worker_index () << 24 | session_index);
 386 }
 387
 388 static inline vcl_session_handle_t
 389 vcl_session_handle (vcl_session_t * s)
 390 {
 391   return vcl_session_handle_from_index (s->session_index);
 392 }
 393
 394 static inline void
 395 vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
 396 {
 397   *wrk_index = handle >> 24;
 398   *session_index = handle & 0xFFFFFF;
 399 }
 400
 401 static inline vcl_session_t *
 402 vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
 403 {
 404   u32 session_index, wrk_index;
 405   vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
 406   ASSERT (wrk_index == wrk->wrk_index);
 407   return vcl_session_get (wrk, session_index);
 408 }
 409
 410 static inline vcl_session_t *
 411 vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
 412 {
 413   uword *p;
 414   if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
 415     return vcl_session_get (wrk, (u32) p[0]);
 416   return 0;
 417 }
 418
 419 static inline u32
 420 vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
 421 {
 422   uword *p;
 423   if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
 424     return p[0];
 425   return VCL_INVALID_SESSION_INDEX;
 426 }
 427
 428 static inline void
 429 vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
 430 {
 431   hash_set (wrk->session_index_by_vpp_handles, handle, value);
 432 }
 433
 434 static inline void
 435 vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
 436 {
 437   hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
 438 }
 439
 440 static inline uword *
 441 vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
 442 {
 443   return hash_get (wrk->session_index_by_vpp_handles, handle);
 444 }
 445
 446 static inline void
 447 vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
 448                                 u32 value)
 449 {
 450   hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
 451 }
 452
 453 static inline void
 454 vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
 455 {
 456   hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
 457 }
 458
 459 static inline int
 460 vcl_session_is_connectable_listener (vcl_worker_t * wrk,
 461                                      vcl_session_t * session)
 462 {
 463   /* Tell if we session_handle is a QUIC session.
 464    * We can be in the following cases :
 465    * Listen session <- QUIC session <- Stream session
 466    * QUIC session <- Stream session
 467    */
 468   vcl_session_t *ls;
 469   if (session->session_type != VPPCOM_PROTO_QUIC)
 470     return 0;
 471   if (session->listener_index == VCL_INVALID_SESSION_INDEX)
 472     return !(session->session_state & STATE_LISTEN);
 473   ls = vcl_session_get_w_handle (wrk, session->listener_index);
 474   if (!ls)
 475     return VPPCOM_EBADFD;
 476   return ls->session_state & STATE_LISTEN;
 477 }
 478
 479 static inline vcl_session_t *
 480 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
 481 {
 482   uword *p;
 483   vcl_session_t *session;
 484
 485   p = hash_get (wrk->session_index_by_vpp_handles, handle);
 486   if (!p)
 487     {
 488       VDBG (0, "could not find listen session: unknown vpp listener handle"
 489             " %llx", handle);
 490       return 0;
 491     }
 492   session = vcl_session_get (wrk, p[0]);
 493   if (!session)
 494     {
 495       VDBG (1, "invalid listen session index (%u)", p[0]);
 496       return 0;
 497     }
 498
 499   ASSERT ((session->session_state & (STATE_LISTEN | STATE_LISTEN_NO_MQ)) ||
 500           vcl_session_is_connectable_listener (wrk, session));
 501   return session;
 502 }
 503
 504 const char *vppcom_session_state_str (vcl_session_state_t state);
 505
 506 static inline u8
 507 vcl_session_is_ct (vcl_session_t * s)
 508 {
 509   return (s->ct_tx_fifo != 0);
 510 }
 511
 512 static inline u8
 513 vcl_session_is_open (vcl_session_t * s)
 514 {
 515   return ((s->session_state & STATE_OPEN)
 516           || (s->session_state == STATE_LISTEN
 517               && s->session_type == VPPCOM_PROTO_UDP));
 518 }
 519
 520 static inline u8
 521 vcl_session_is_closing (vcl_session_t * s)
 522 {
 523   return (s->session_state == STATE_VPP_CLOSING
 524           || s->session_state == STATE_DISCONNECT);
 525 }
 526
 527 static inline int
 528 vcl_session_closing_error (vcl_session_t * s)
 529 {
 530   return s->session_state == STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
 531 }
 532
 533 static inline int
 534 vcl_session_closed_error (vcl_session_t * s)
 535 {
 536   return s->session_state == STATE_DISCONNECT
 537     ? VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
 538 }
 539
 540 /*
 541  * Helpers
 542  */
 543 int vcl_wait_for_app_state_change (app_state_t app_state);
 544 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
 545 u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
 546 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
 547 int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
 548 int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
 549
 550 vcl_worker_t *vcl_worker_alloc_and_init (void);
 551 void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
 552 int vcl_worker_register_with_vpp (void);
 553 int vcl_worker_set_bapi (void);
 554 svm_msg_q_t *vcl_worker_ctrl_mq (vcl_worker_t * wrk);
 555
 556 void vcl_flush_mq_events (void);
 557 void vcl_cleanup_bapi (void);
 558 int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * session,
 559                          vcl_session_handle_t sh, u8 do_disconnect);
 560
 561 void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
 562 u32 vcl_segment_table_lookup (u64 segment_handle);
 563 void vcl_segment_table_del (u64 segment_handle);
 564
 565 int vcl_session_read_ready (vcl_session_t * session);
 566 int vcl_session_write_ready (vcl_session_t * session);
 567
 568 static inline vcl_worker_t *
 569 vcl_worker_get (u32 wrk_index)
 570 {
 571   return pool_elt_at_index (vcm->workers, wrk_index);
 572 }
 573
 574 static inline vcl_worker_t *
 575 vcl_worker_get_if_valid (u32 wrk_index)
 576 {
 577   if (pool_is_free_index (vcm->workers, wrk_index))
 578     return 0;
 579   return pool_elt_at_index (vcm->workers, wrk_index);
 580 }
 581
 582 static inline vcl_worker_t *
 583 vcl_worker_get_current (void)
 584 {
 585   return vcl_worker_get (vcl_get_worker_index ());
 586 }
 587
 588 static inline u8
 589 vcl_n_workers (void)
 590 {
 591   return pool_elts (vcm->workers);
 592 }
 593
 594 static inline svm_msg_q_t *
 595 vcl_session_vpp_evt_q (vcl_worker_t * wrk, vcl_session_t * s)
 596 {
 597   return wrk->vpp_event_queues[s->vpp_thread_index];
 598 }
 599
 600 void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
 601                                      u32 wrk_index);
 602 /*
 603  * VCL Binary API
 604  */
 605 int vppcom_connect_to_vpp (char *app_name);
 606 void vppcom_disconnect_from_vpp (void);
 607 void vppcom_init_error_string_table (void);
 608 void vppcom_send_session_enable_disable (u8 is_enable);
 609 void vppcom_app_send_attach (void);
 610 void vppcom_app_send_detach (void);
 611 void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s);
 612 void vppcom_send_disconnect_session (u64 vpp_handle);
 613 void vppcom_api_hookup (void);
 614 void vppcom_send_application_tls_cert_add (vcl_session_t * session,
 615                                            char *cert, u32 cert_len);
 616 void vppcom_send_application_tls_key_add (vcl_session_t * session, char *key,
 617                                           u32 key_len);
 618 void vcl_send_app_worker_add_del (u8 is_add);
 619 void vcl_send_child_worker_del (vcl_worker_t * wrk);
 620
 621 u32 vcl_max_nsid_len (void);
 622
 623 u8 *format_api_error (u8 * s, va_list * args);
 624
 625 void vls_init ();
 626 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
 627
 628 /*
 629  * fd.io coding-style-patch-verification: ON
 630  *
 631  * Local Variables:
 632  * eval: (c-set-style "gnu")
 633  * End:
 634  */