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