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