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   vppcom_epoll_t vep;
 174   int libc_epfd;
 175   svm_msg_q_t *our_evt_q;
 176   vcl_session_msg_t *accept_evts_fifo;
 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   u32 vpp_api_q_length;
 187   uword segment_baseva;
 188   u32 segment_size;
 189   u32 add_segment_size;
 190   u32 preallocated_fifo_pairs;
 191   u32 rx_fifo_size;
 192   u32 tx_fifo_size;
 193   u32 event_queue_size;
 194   u32 listen_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   f64 accept_timeout;
 205   u32 event_ring_size;
 206   char *event_log_path;
 207   u8 *vpp_api_filename;
 208   u8 *vpp_api_socket_name;
 209 } vppcom_cfg_t;
 210
 211 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
 212
 213 typedef struct vcl_cut_through_registration_
 214 {
 215   svm_msg_q_t *mq;
 216   svm_msg_q_t *peer_mq;
 217   u32 sid;
 218   u32 epoll_evt_conn_index;     /*< mq evt connection index part of
 219                                    the mqs evtfd epoll (if used) */
 220 } vcl_cut_through_registration_t;
 221
 222 typedef struct vcl_mq_evt_conn_
 223 {
 224   svm_msg_q_t *mq;
 225   int mq_fd;
 226 } vcl_mq_evt_conn_t;
 227
 228 typedef struct vcl_worker_
 229 {
 230   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 231
 232   /* Session pool */
 233   vcl_session_t *sessions;
 234
 235   /** Worker/thread index in current process */
 236   u32 wrk_index;
 237
 238   /** Worker index in vpp*/
 239   u32 vpp_wrk_index;
 240
 241   /** API client handle */
 242   u32 my_client_index;
 243
 244   /** State of the connection, shared between msg RX thread and main thread */
 245   volatile app_state_t wrk_state;
 246
 247   /** VPP binary api input queue */
 248   svm_queue_t *vl_input_queue;
 249
 250   /** Message queues epoll fd. Initialized only if using mqs with eventfds */
 251   int mqs_epfd;
 252
 253   /** Pool of event message queue event connections */
 254   vcl_mq_evt_conn_t *mq_evt_conns;
 255
 256   /** Per worker buffer for receiving mq epoll events */
 257   struct epoll_event *mq_events;
 258
 259   /** Hash table for disconnect processing */
 260   uword *session_index_by_vpp_handles;
 261
 262   /** Select bitmaps */
 263   clib_bitmap_t *rd_bitmap;
 264   clib_bitmap_t *wr_bitmap;
 265   clib_bitmap_t *ex_bitmap;
 266
 267   /** Our event message queue */
 268   svm_msg_q_t *app_event_queue;
 269
 270   /** VPP workers event message queues */
 271   svm_msg_q_t **vpp_event_queues;
 272
 273   /** For deadman timers */
 274   clib_time_t clib_time;
 275
 276   /** Vector acting as buffer for mq messages */
 277   svm_msg_q_msg_t *mq_msg_vector;
 278
 279   /** Vector of unhandled events */
 280   session_event_t *unhandled_evts_vector;
 281
 282   u32 *pending_session_wrk_updates;
 283
 284   /** Used also as a thread stop key buffer */
 285   pthread_t thread_id;
 286
 287   /** Current pid, may be different from main_pid if forked child */
 288   pid_t current_pid;
 289
 290   u32 forked_child;
 291
 292 } vcl_worker_t;
 293
 294 typedef struct vppcom_main_t_
 295 {
 296   u8 is_init;
 297   u32 debug;
 298   pthread_t main_cpu;
 299
 300   /** Main process pid */
 301   pid_t main_pid;
 302
 303   /** App's index in vpp. It's used by vpp to identify the app */
 304   u32 app_index;
 305
 306   /** State of the connection, shared between msg RX thread and main thread */
 307   volatile app_state_t app_state;
 308
 309   u8 *app_name;
 310
 311   /** VCL configuration */
 312   vppcom_cfg_t cfg;
 313
 314   volatile u32 forking;
 315
 316   /** Workers */
 317   vcl_worker_t *workers;
 318
 319   /** Lock to protect worker registrations */
 320   clib_spinlock_t workers_lock;
 321
 322   /** Lock to protect segment hash table */
 323   clib_rwlock_t segment_table_lock;
 324
 325   /** Mapped segments table */
 326   uword *segment_table;
 327
 328   fifo_segment_main_t segment_main;
 329
 330 #ifdef VCL_ELOG
 331   /* VPP Event-logger */
 332   elog_main_t elog_main;
 333   elog_track_t elog_track;
 334 #endif
 335
 336   /* VNET_API_ERROR_FOO -> "Foo" hash table */
 337   uword *error_string_by_error_number;
 338
 339 } vppcom_main_t;
 340
 341 extern vppcom_main_t *vcm;
 342
 343 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
 344 #define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
 345 #define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
 346
 347 static inline vcl_session_t *
 348 vcl_session_alloc (vcl_worker_t * wrk)
 349 {
 350   vcl_session_t *s;
 351   pool_get (wrk->sessions, s);
 352   memset (s, 0, sizeof (*s));
 353   s->session_index = s - wrk->sessions;
 354   return s;
 355 }
 356
 357 static inline void
 358 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
 359 {
 360   pool_put (wrk->sessions, s);
 361 }
 362
 363 static inline vcl_session_t *
 364 vcl_session_get (vcl_worker_t * wrk, u32 session_index)
 365 {
 366   if (pool_is_free_index (wrk->sessions, session_index))
 367     return 0;
 368   return pool_elt_at_index (wrk->sessions, session_index);
 369 }
 370
 371 static inline vcl_session_handle_t
 372 vcl_session_handle_from_index (u32 session_index)
 373 {
 374   ASSERT (session_index < 2 << 24);
 375   return (vcl_get_worker_index () << 24 | session_index);
 376 }
 377
 378 static inline vcl_session_handle_t
 379 vcl_session_handle (vcl_session_t * s)
 380 {
 381   return vcl_session_handle_from_index (s->session_index);
 382 }
 383
 384 static inline void
 385 vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
 386 {
 387   *wrk_index = handle >> 24;
 388   *session_index = handle & 0xFFFFFF;
 389 }
 390
 391 static inline vcl_session_t *
 392 vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
 393 {
 394   u32 session_index, wrk_index;
 395   vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
 396   ASSERT (wrk_index == wrk->wrk_index);
 397   return vcl_session_get (wrk, session_index);
 398 }
 399
 400 static inline vcl_session_t *
 401 vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
 402 {
 403   uword *p;
 404   if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
 405     return vcl_session_get (wrk, (u32) p[0]);
 406   return 0;
 407 }
 408
 409 static inline u32
 410 vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
 411 {
 412   uword *p;
 413   if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
 414     return p[0];
 415   return VCL_INVALID_SESSION_INDEX;
 416 }
 417
 418 static inline void
 419 vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
 420 {
 421   hash_set (wrk->session_index_by_vpp_handles, handle, value);
 422 }
 423
 424 static inline void
 425 vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
 426 {
 427   hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
 428 }
 429
 430 static inline uword *
 431 vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
 432 {
 433   return hash_get (wrk->session_index_by_vpp_handles, handle);
 434 }
 435
 436 static inline void
 437 vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
 438                                 u32 value)
 439 {
 440   hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
 441 }
 442
 443 static inline void
 444 vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
 445 {
 446   hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
 447 }
 448
 449 static inline vcl_session_t *
 450 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
 451 {
 452   uword *p;
 453   vcl_session_t *session;
 454
 455   p = hash_get (wrk->session_index_by_vpp_handles, handle);
 456   if (!p)
 457     {
 458       VDBG (0, "could not find listen session: unknown vpp listener handle"
 459             " %llx", handle);
 460       return 0;
 461     }
 462   session = vcl_session_get (wrk, p[0]);
 463   if (!session)
 464     {
 465       VDBG (1, "invalid listen session index (%u)", p[0]);
 466       return 0;
 467     }
 468
 469   ASSERT (session->session_state & (STATE_LISTEN | STATE_LISTEN_NO_MQ));
 470   return session;
 471 }
 472
 473 const char *vppcom_session_state_str (vcl_session_state_t state);
 474
 475 static inline u8
 476 vcl_session_is_ct (vcl_session_t * s)
 477 {
 478   return (s->ct_tx_fifo != 0);
 479 }
 480
 481 static inline u8
 482 vcl_session_is_open (vcl_session_t * s)
 483 {
 484   return ((s->session_state & STATE_OPEN)
 485           || (s->session_state == STATE_LISTEN
 486               && s->session_type == VPPCOM_PROTO_UDP));
 487 }
 488
 489 static inline u8
 490 vcl_session_is_closing (vcl_session_t * s)
 491 {
 492   return (s->session_state == STATE_VPP_CLOSING
 493           || s->session_state == STATE_DISCONNECT);
 494 }
 495
 496 static inline int
 497 vcl_session_closing_error (vcl_session_t * s)
 498 {
 499   return s->session_state == STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
 500 }
 501
 502 static inline int
 503 vcl_session_closed_error (vcl_session_t * s)
 504 {
 505   return s->session_state == STATE_DISCONNECT
 506     ? VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
 507 }
 508
 509 /*
 510  * Helpers
 511  */
 512 int vcl_wait_for_app_state_change (app_state_t app_state);
 513 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
 514 u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
 515 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
 516 int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
 517 int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
 518
 519 vcl_worker_t *vcl_worker_alloc_and_init (void);
 520 void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
 521 int vcl_worker_register_with_vpp (void);
 522 int vcl_worker_set_bapi (void);
 523
 524 void vcl_flush_mq_events (void);
 525 void vcl_cleanup_bapi (void);
 526 int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * session,
 527                          vcl_session_handle_t sh, u8 do_disconnect);
 528
 529 void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
 530 u32 vcl_segment_table_lookup (u64 segment_handle);
 531 void vcl_segment_table_del (u64 segment_handle);
 532
 533 int vcl_session_read_ready (vcl_session_t * session);
 534 int vcl_session_write_ready (vcl_session_t * session);
 535
 536 static inline vcl_worker_t *
 537 vcl_worker_get (u32 wrk_index)
 538 {
 539   return pool_elt_at_index (vcm->workers, wrk_index);
 540 }
 541
 542 static inline vcl_worker_t *
 543 vcl_worker_get_if_valid (u32 wrk_index)
 544 {
 545   if (pool_is_free_index (vcm->workers, wrk_index))
 546     return 0;
 547   return pool_elt_at_index (vcm->workers, wrk_index);
 548 }
 549
 550 static inline vcl_worker_t *
 551 vcl_worker_get_current (void)
 552 {
 553   return vcl_worker_get (vcl_get_worker_index ());
 554 }
 555
 556 static inline u8
 557 vcl_n_workers (void)
 558 {
 559   return pool_elts (vcm->workers);
 560 }
 561
 562 static inline svm_msg_q_t *
 563 vcl_session_vpp_evt_q (vcl_worker_t * wrk, vcl_session_t * s)
 564 {
 565   return wrk->vpp_event_queues[s->vpp_thread_index];
 566 }
 567
 568 void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
 569                                      u32 wrk_index);
 570 /*
 571  * VCL Binary API
 572  */
 573 int vppcom_connect_to_vpp (char *app_name);
 574 void vppcom_init_error_string_table (void);
 575 void vppcom_send_session_enable_disable (u8 is_enable);
 576 void vppcom_app_send_attach (void);
 577 void vppcom_app_send_detach (void);
 578 void vppcom_send_connect_sock (vcl_session_t * session);
 579 void vppcom_send_disconnect_session (u64 vpp_handle);
 580 void vppcom_send_bind_sock (vcl_session_t * session);
 581 void vppcom_send_unbind_sock (vcl_worker_t * wrk, u64 vpp_handle);
 582 void vppcom_api_hookup (void);
 583 void vppcom_send_application_tls_cert_add (vcl_session_t * session,
 584                                            char *cert, u32 cert_len);
 585 void vppcom_send_application_tls_key_add (vcl_session_t * session, char *key,
 586                                           u32 key_len);
 587 void vcl_send_app_worker_add_del (u8 is_add);
 588 void vcl_send_child_worker_del (vcl_worker_t * wrk);
 589
 590 u32 vcl_max_nsid_len (void);
 591
 592 u8 *format_api_error (u8 * s, va_list * args);
 593
 594 void vls_init ();
 595 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
 596
 597 /*
 598  * fd.io coding-style-patch-verification: ON
 599  *
 600  * Local Variables:
 601  * eval: (c-set-style "gnu")
 602  * End:
 603  */