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