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