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