src/vcl/vcl_private.h

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