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_event.h>
  22 #include <vcl/vcl_debug.h>
  23
  24 #if (CLIB_DEBUG > 0)
  25 /* Set VPPCOM_DEBUG_INIT 2 for connection debug,
  26  *                       3 for read/write debug output
  27  * or
  28  *    export VCL_DEBUG=<#> to set dynamically.
  29  */
  30 #define VPPCOM_DEBUG_INIT 1
  31 #else
  32 #define VPPCOM_DEBUG_INIT 0
  33 #endif
  34
  35 #define VPPCOM_DEBUG vcm->debug
  36
  37 extern __thread uword __vcl_worker_index;
  38
  39 static inline void
  40 vcl_set_worker_index (uword wrk_index)
  41 {
  42   __vcl_worker_index = wrk_index;
  43 }
  44
  45 static inline uword
  46 vcl_get_worker_index (void)
  47 {
  48   return __vcl_worker_index;
  49 }
  50
  51 /*
  52  * VPPCOM Private definitions and functions.
  53  */
  54 typedef enum
  55 {
  56   STATE_APP_START,
  57   STATE_APP_CONN_VPP,
  58   STATE_APP_ENABLED,
  59   STATE_APP_ATTACHED,
  60   STATE_APP_ADDING_WORKER,
  61   STATE_APP_FAILED,
  62   STATE_APP_READY
  63 } app_state_t;
  64
  65 typedef enum
  66 {
  67   STATE_START = 0x01,
  68   STATE_CONNECT = 0x02,
  69   STATE_LISTEN = 0x04,
  70   STATE_ACCEPT = 0x08,
  71   STATE_CLOSE_ON_EMPTY = 0x10,
  72   STATE_DISCONNECT = 0x20,
  73   STATE_FAILED = 0x40
  74 } session_state_t;
  75
  76 #define SERVER_STATE_OPEN  (STATE_ACCEPT|STATE_CLOSE_ON_EMPTY)
  77 #define CLIENT_STATE_OPEN  (STATE_CONNECT|STATE_CLOSE_ON_EMPTY)
  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 typedef struct vcl_session_msg
 100 {
 101   u32 next;
 102   union
 103   {
 104     session_accepted_msg_t accepted_msg;
 105   };
 106 } vcl_session_msg_t;
 107
 108 enum
 109 {
 110   VCL_SESS_ATTR_SERVER,
 111   VCL_SESS_ATTR_CUT_THRU,
 112   VCL_SESS_ATTR_VEP,
 113   VCL_SESS_ATTR_VEP_SESSION,
 114   VCL_SESS_ATTR_LISTEN,         // SOL_SOCKET,SO_ACCEPTCONN
 115   VCL_SESS_ATTR_NONBLOCK,       // fcntl,O_NONBLOCK
 116   VCL_SESS_ATTR_REUSEADDR,      // SOL_SOCKET,SO_REUSEADDR
 117   VCL_SESS_ATTR_REUSEPORT,      // SOL_SOCKET,SO_REUSEPORT
 118   VCL_SESS_ATTR_BROADCAST,      // SOL_SOCKET,SO_BROADCAST
 119   VCL_SESS_ATTR_V6ONLY,         // SOL_TCP,IPV6_V6ONLY
 120   VCL_SESS_ATTR_KEEPALIVE,      // SOL_SOCKET,SO_KEEPALIVE
 121   VCL_SESS_ATTR_TCP_NODELAY,    // SOL_TCP,TCP_NODELAY
 122   VCL_SESS_ATTR_TCP_KEEPIDLE,   // SOL_TCP,TCP_KEEPIDLE
 123   VCL_SESS_ATTR_TCP_KEEPINTVL,  // SOL_TCP,TCP_KEEPINTVL
 124   VCL_SESS_ATTR_MAX
 125 } vppcom_session_attr_t;
 126
 127 #define VCL_SESS_ATTR_SET(ATTR, VAL)            \
 128 do {                                            \
 129   (ATTR) |= 1 << (VAL);                         \
 130  } while (0)
 131
 132 #define VCL_SESS_ATTR_CLR(ATTR, VAL)            \
 133 do {                                            \
 134   (ATTR) &= ~(1 << (VAL));                      \
 135  } while (0)
 136
 137 #define VCL_SESS_ATTR_TEST(ATTR, VAL)           \
 138   ((ATTR) & (1 << (VAL)) ? 1 : 0)
 139
 140 typedef struct
 141 {
 142   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 143 #define _(type, name) type name;
 144   foreach_app_session_field
 145 #undef _
 146   u32 sndbuf_size;              // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
 147   u32 rcvbuf_size;              // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
 148   u32 user_mss;                 // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
 149   u8 *segment_name;
 150   u32 sm_seg_index;
 151   u32 client_context;
 152   u64 vpp_handle;
 153
 154   /* Socket configuration state */
 155   u8 is_vep;
 156   u8 is_vep_session;
 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   /** Used also as a thread stop key buffer */
 263   pthread_t thread_id;
 264 } vcl_worker_t;
 265
 266 typedef struct vppcom_main_t_
 267 {
 268   u8 is_init;
 269   u32 debug;
 270   pthread_t main_cpu;
 271
 272   /** VPP binary api input queue */
 273   svm_queue_t *vl_input_queue;
 274
 275   /** API client handle */
 276   u32 my_client_index;
 277
 278   /** State of the connection, shared between msg RX thread and main thread */
 279   volatile app_state_t app_state;
 280
 281   /** VCL configuration */
 282   vppcom_cfg_t cfg;
 283
 284   /** Flag indicating that a new segment is being mounted */
 285   volatile u32 mounting_segment;
 286
 287   /** Workers */
 288   vcl_worker_t *workers;
 289
 290   /** Lock to protect worker registrations */
 291   clib_spinlock_t workers_lock;
 292
 293 #ifdef VCL_ELOG
 294   /* VPP Event-logger */
 295   elog_main_t elog_main;
 296   elog_track_t elog_track;
 297 #endif
 298
 299   /* VNET_API_ERROR_FOO -> "Foo" hash table */
 300   uword *error_string_by_error_number;
 301
 302   /* Obsolete */
 303
 304   /* Event thread */
 305   vce_event_thread_t event_thread;
 306
 307   /* IO thread */
 308   vppcom_session_io_thread_t session_io_thread;
 309 } vppcom_main_t;
 310
 311 extern vppcom_main_t *vcm;
 312
 313 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
 314
 315 static inline vcl_session_t *
 316 vcl_session_alloc (vcl_worker_t * wrk)
 317 {
 318   vcl_session_t *s;
 319   pool_get (wrk->sessions, s);
 320   memset (s, 0, sizeof (*s));
 321   s->session_index = s - wrk->sessions;
 322   return s;
 323 }
 324
 325 static inline void
 326 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
 327 {
 328   pool_put (wrk->sessions, s);
 329 }
 330
 331 static inline vcl_session_t *
 332 vcl_session_get (vcl_worker_t * wrk, u32 session_index)
 333 {
 334   if (pool_is_free_index (wrk->sessions, session_index))
 335     return 0;
 336   return pool_elt_at_index (wrk->sessions, session_index);
 337 }
 338
 339 static inline int
 340 vcl_session_handle (vcl_session_t * s)
 341 {
 342   ASSERT (s->session_index < 2 << 24);
 343   return (vcl_get_worker_index () << 24 | s->session_index);
 344 }
 345
 346 static inline void
 347 vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
 348 {
 349   *wrk_index = handle >> 24;
 350   *session_index = handle & 0xFFFFFF;
 351 }
 352
 353 static inline vcl_session_t *
 354 vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
 355 {
 356   u32 session_index, wrk_index;
 357   vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
 358   ASSERT (wrk_index == wrk->wrk_index);
 359   return vcl_session_get (wrk, session_index);
 360 }
 361
 362 static inline vcl_session_t *
 363 vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
 364 {
 365   uword *p;
 366   if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
 367     return vcl_session_get (wrk, (u32) p[0]);
 368   return 0;
 369 }
 370
 371 static inline u32
 372 vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
 373 {
 374   uword *p;
 375   if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
 376     return p[0];
 377   return VCL_INVALID_SESSION_INDEX;
 378 }
 379
 380 static inline void
 381 vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
 382 {
 383   hash_set (wrk->session_index_by_vpp_handles, handle, value);
 384 }
 385
 386 static inline void
 387 vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
 388 {
 389   hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
 390 }
 391
 392 static inline uword *
 393 vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
 394 {
 395   return hash_get (wrk->session_index_by_vpp_handles, handle);
 396 }
 397
 398 static inline void
 399 vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
 400                                 u32 value)
 401 {
 402   /* Session and listener handles have different formats. The latter has
 403    * the thread index in the upper 32 bits while the former has the session
 404    * type. Knowing that, for listeners we just flip the MSB to 1 */
 405   listener_handle |= 1ULL << 63;
 406   hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
 407 }
 408
 409 static inline void
 410 vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
 411 {
 412   listener_handle |= 1ULL << 63;
 413   hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
 414 }
 415
 416 static inline vcl_session_t *
 417 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 listener_handle)
 418 {
 419   uword *p;
 420   u64 handle = listener_handle | (1ULL << 63);
 421   vcl_session_t *session;
 422
 423   p = hash_get (wrk->session_index_by_vpp_handles, handle);
 424   if (!p)
 425     {
 426       clib_warning ("VCL<%d>: couldn't find listen session: unknown vpp "
 427                     "listener handle %llx", getpid (), listener_handle);
 428       return 0;
 429     }
 430   if (pool_is_free_index (wrk->sessions, p[0]))
 431     {
 432       VDBG (1, "VCL<%d>: invalid listen session, sid (%u)", getpid (), p[0]);
 433       return 0;
 434     }
 435
 436   session = pool_elt_at_index (wrk->sessions, p[0]);
 437   ASSERT (session->session_state & STATE_LISTEN);
 438   return session;
 439 }
 440
 441 const char *vppcom_session_state_str (session_state_t state);
 442
 443 static inline u8
 444 vcl_session_is_ct (vcl_session_t * s)
 445 {
 446   return (s->our_evt_q != 0);
 447 }
 448
 449 /*
 450  * Helpers
 451  */
 452 int vcl_wait_for_app_state_change (app_state_t app_state);
 453 vcl_cut_through_registration_t
 454   * vcl_ct_registration_lock_and_alloc (vcl_worker_t * wrk);
 455 void vcl_ct_registration_del (vcl_worker_t * wrk,
 456                               vcl_cut_through_registration_t * ctr);
 457 u32 vcl_ct_registration_index (vcl_worker_t * wrk,
 458                                vcl_cut_through_registration_t * ctr);
 459 void vcl_ct_registration_lock (vcl_worker_t * wrk);
 460 void vcl_ct_registration_unlock (vcl_worker_t * wrk);
 461 vcl_cut_through_registration_t
 462   * vcl_ct_registration_lock_and_lookup (vcl_worker_t * wrk, uword mq_addr);
 463 void vcl_ct_registration_lookup_add (vcl_worker_t * wrk, uword mq_addr,
 464                                      u32 ctr_index);
 465 void vcl_ct_registration_lookup_del (vcl_worker_t * wrk, uword mq_addr);
 466 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
 467 u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
 468 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
 469 int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
 470 int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
 471
 472 vcl_worker_t *vcl_worker_alloc_and_init (void);
 473
 474 static inline vcl_worker_t *
 475 vcl_worker_get (u32 wrk_index)
 476 {
 477   return pool_elt_at_index (vcm->workers, wrk_index);
 478 }
 479
 480 static inline vcl_worker_t *
 481 vcl_worker_get_current (void)
 482 {
 483   return vcl_worker_get (vcl_get_worker_index ());
 484 }
 485
 486 /*
 487  * VCL Binary API
 488  */
 489 int vppcom_connect_to_vpp (char *app_name);
 490 void vppcom_init_error_string_table (void);
 491 void vppcom_send_session_enable_disable (u8 is_enable);
 492 void vppcom_app_send_attach (void);
 493 void vppcom_app_send_detach (void);
 494 void vppcom_send_connect_sock (vcl_session_t * session);
 495 void vppcom_send_disconnect_session (u64 vpp_handle);
 496 void vppcom_send_bind_sock (vcl_session_t * session);
 497 void vppcom_send_unbind_sock (u64 vpp_handle);
 498 void vppcom_api_hookup (void);
 499 void vppcom_send_accept_session_reply (u64 vpp_handle, u32 context, int rv);
 500 void vcl_send_app_worker_add_del (u8 is_add);
 501
 502 u32 vcl_max_nsid_len (void);
 503
 504 u8 *format_api_error (u8 * s, va_list * args);
 505
 506 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
 507
 508 /*
 509  * fd.io coding-style-patch-verification: ON
 510  *
 511  * Local Variables:
 512  * eval: (c-set-style "gnu")
 513  * End:
 514  */