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