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