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