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