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 /*
  38  * VPPCOM Private definitions and functions.
  39  */
  40 typedef enum
  41 {
  42   STATE_APP_START,
  43   STATE_APP_CONN_VPP,
  44   STATE_APP_ENABLED,
  45   STATE_APP_ATTACHED,
  46 } app_state_t;
  47
  48 typedef enum
  49 {
  50   STATE_START = 0x01,
  51   STATE_CONNECT = 0x02,
  52   STATE_LISTEN = 0x04,
  53   STATE_ACCEPT = 0x08,
  54   STATE_CLOSE_ON_EMPTY = 0x10,
  55   STATE_DISCONNECT = 0x20,
  56   STATE_FAILED = 0x40
  57 } session_state_t;
  58
  59 #define SERVER_STATE_OPEN  (STATE_ACCEPT|STATE_CLOSE_ON_EMPTY)
  60 #define CLIENT_STATE_OPEN  (STATE_CONNECT|STATE_CLOSE_ON_EMPTY)
  61 #define STATE_OPEN (SERVER_STATE_OPEN | CLIENT_STATE_OPEN)
  62
  63 typedef struct epoll_event vppcom_epoll_event_t;
  64
  65 typedef struct
  66 {
  67   u32 next_sid;
  68   u32 prev_sid;
  69   u32 vep_idx;
  70   vppcom_epoll_event_t ev;
  71 #define VEP_DEFAULT_ET_MASK  (EPOLLIN|EPOLLOUT)
  72 #define VEP_UNSUPPORTED_EVENTS (EPOLLONESHOT|EPOLLEXCLUSIVE)
  73   u32 et_mask;
  74 } vppcom_epoll_t;
  75
  76 typedef struct
  77 {
  78   u8 is_ip4;
  79   ip46_address_t ip46;
  80 } vppcom_ip46_t;
  81
  82 typedef struct vcl_session_msg
  83 {
  84   u32 next;
  85   union
  86   {
  87     session_accepted_msg_t accepted_msg;
  88   };
  89 } vcl_session_msg_t;
  90
  91 enum
  92 {
  93   VCL_SESS_ATTR_SERVER,
  94   VCL_SESS_ATTR_CUT_THRU,
  95   VCL_SESS_ATTR_VEP,
  96   VCL_SESS_ATTR_VEP_SESSION,
  97   VCL_SESS_ATTR_LISTEN,         // SOL_SOCKET,SO_ACCEPTCONN
  98   VCL_SESS_ATTR_NONBLOCK,       // fcntl,O_NONBLOCK
  99   VCL_SESS_ATTR_REUSEADDR,      // SOL_SOCKET,SO_REUSEADDR
 100   VCL_SESS_ATTR_REUSEPORT,      // SOL_SOCKET,SO_REUSEPORT
 101   VCL_SESS_ATTR_BROADCAST,      // SOL_SOCKET,SO_BROADCAST
 102   VCL_SESS_ATTR_V6ONLY,         // SOL_TCP,IPV6_V6ONLY
 103   VCL_SESS_ATTR_KEEPALIVE,      // SOL_SOCKET,SO_KEEPALIVE
 104   VCL_SESS_ATTR_TCP_NODELAY,    // SOL_TCP,TCP_NODELAY
 105   VCL_SESS_ATTR_TCP_KEEPIDLE,   // SOL_TCP,TCP_KEEPIDLE
 106   VCL_SESS_ATTR_TCP_KEEPINTVL,  // SOL_TCP,TCP_KEEPINTVL
 107   VCL_SESS_ATTR_MAX
 108 } vppcom_session_attr_t;
 109
 110 #define VCL_SESS_ATTR_SET(ATTR, VAL)            \
 111 do {                                            \
 112   (ATTR) |= 1 << (VAL);                         \
 113  } while (0)
 114
 115 #define VCL_SESS_ATTR_CLR(ATTR, VAL)            \
 116 do {                                            \
 117   (ATTR) &= ~(1 << (VAL));                      \
 118  } while (0)
 119
 120 #define VCL_SESS_ATTR_TEST(ATTR, VAL)           \
 121   ((ATTR) & (1 << (VAL)) ? 1 : 0)
 122
 123 typedef struct
 124 {
 125 #define _(type, name) type name;
 126   foreach_app_session_field
 127 #undef _
 128   u32 sndbuf_size;              // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
 129   u32 rcvbuf_size;              // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
 130   u32 user_mss;                 // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
 131   u8 *segment_name;
 132   u32 sm_seg_index;
 133   u32 client_context;
 134   u64 vpp_handle;
 135
 136   /* Socket configuration state */
 137   u8 is_vep;
 138   u8 is_vep_session;
 139   u32 attr;
 140   u32 wait_cont_idx;
 141   vppcom_epoll_t vep;
 142   int libc_epfd;
 143   svm_msg_q_t *our_evt_q;
 144   u64 options[16];
 145   vce_event_handler_reg_t *poll_reg;
 146   vcl_session_msg_t *accept_evts_fifo;
 147 #if VCL_ELOG
 148   elog_track_t elog_track;
 149 #endif
 150 } vcl_session_t;
 151
 152 typedef struct vppcom_cfg_t_
 153 {
 154   u64 heapsize;
 155   u32 vpp_api_q_length;
 156   u64 segment_baseva;
 157   u32 segment_size;
 158   u32 add_segment_size;
 159   u32 preallocated_fifo_pairs;
 160   u32 rx_fifo_size;
 161   u32 tx_fifo_size;
 162   u32 event_queue_size;
 163   u32 listen_queue_size;
 164   u8 app_proxy_transport_tcp;
 165   u8 app_proxy_transport_udp;
 166   u8 app_scope_local;
 167   u8 app_scope_global;
 168   u8 *namespace_id;
 169   u64 namespace_secret;
 170   u8 use_mq_eventfd;
 171   f64 app_timeout;
 172   f64 session_timeout;
 173   f64 accept_timeout;
 174   u32 event_ring_size;
 175   char *event_log_path;
 176   u8 *vpp_api_filename;
 177   u8 *vpp_api_socket_name;
 178 } vppcom_cfg_t;
 179
 180 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
 181
 182 typedef struct vcl_cut_through_registration_
 183 {
 184   svm_msg_q_t *mq;
 185   svm_msg_q_t *peer_mq;
 186   u32 sid;
 187   u32 epoll_evt_conn_index;     /*< mq evt connection index part of
 188                                    the mqs evtfd epoll (if used) */
 189 } vcl_cut_through_registration_t;
 190
 191 typedef struct vcl_mq_evt_conn_
 192 {
 193   svm_msg_q_t *mq;
 194   int mq_fd;
 195 } vcl_mq_evt_conn_t;
 196
 197 typedef struct vppcom_main_t_
 198 {
 199   u8 init;
 200   u32 debug;
 201   int main_cpu;
 202
 203   /* FIFO for accepted connections - used in epoll/select */
 204   clib_spinlock_t session_fifo_lockp;
 205   u32 *client_session_index_fifo;
 206
 207   /* vpp input queue */
 208   svm_queue_t *vl_input_queue;
 209
 210   /* API client handle */
 211   u32 my_client_index;
 212   /* Session pool */
 213   clib_spinlock_t sessions_lockp;
 214   vcl_session_t *sessions;
 215
 216   /** Message queues epoll fd. Initialized only if using mqs with eventfds */
 217   int mqs_epfd;
 218
 219   /** Pool of event message queue event connections */
 220   vcl_mq_evt_conn_t *mq_evt_conns;
 221
 222   /** Per worker buffer for receiving mq epoll events */
 223   struct epoll_event *mq_events;
 224
 225   /* Hash table for disconnect processing */
 226   uword *session_index_by_vpp_handles;
 227
 228   /* Select bitmaps */
 229   clib_bitmap_t *rd_bitmap;
 230   clib_bitmap_t *wr_bitmap;
 231   clib_bitmap_t *ex_bitmap;
 232
 233   /* Our event queue */
 234   svm_msg_q_t *app_event_queue;
 235
 236   svm_msg_q_t **vpp_event_queues;
 237
 238   /* unique segment name counter */
 239   u32 unique_segment_index;
 240
 241   /* For deadman timers */
 242   clib_time_t clib_time;
 243
 244   /* State of the connection, shared between msg RX thread and main thread */
 245   volatile app_state_t app_state;
 246
 247   vppcom_cfg_t cfg;
 248
 249   /* Event thread */
 250   vce_event_thread_t event_thread;
 251
 252   /* IO thread */
 253   vppcom_session_io_thread_t session_io_thread;
 254
 255   /* pool of ctrl msgs */
 256   vcl_session_msg_t *ctrl_evt_pool;
 257
 258   /** Pool of cut through registrations */
 259   vcl_cut_through_registration_t *cut_through_registrations;
 260
 261   /** Lock for accessing ct registration pool */
 262   clib_spinlock_t ct_registration_lock;
 263
 264   /** Cut-through registration by mq address hash table */
 265   uword *ct_registration_by_mq;
 266
 267   svm_msg_q_msg_t *mq_msg_vector;
 268
 269   /** Flag indicating that a new segment is being mounted */
 270   volatile u32 mounting_segment;
 271
 272 #ifdef VCL_ELOG
 273   /* VPP Event-logger */
 274   elog_main_t elog_main;
 275   elog_track_t elog_track;
 276 #endif
 277
 278   /* VNET_API_ERROR_FOO -> "Foo" hash table */
 279   uword *error_string_by_error_number;
 280 } vppcom_main_t;
 281
 282 extern vppcom_main_t *vcm;
 283
 284 #define VCL_SESSION_LOCK_AND_GET(I, S)                          \
 285 do {                                                            \
 286   clib_spinlock_lock (&vcm->sessions_lockp);                    \
 287   rv = vppcom_session_at_index (I, S);                          \
 288   if (PREDICT_FALSE (rv))                                       \
 289     {                                                           \
 290       clib_spinlock_unlock (&vcm->sessions_lockp);              \
 291       clib_warning ("VCL<%d>: ERROR: Invalid ##I (%u)!",        \
 292                     getpid (), I);                              \
 293       goto done;                                                \
 294     }                                                           \
 295 } while (0)
 296
 297 #define VCL_SESSION_LOCK() clib_spinlock_lock (&(vcm->sessions_lockp))
 298 #define VCL_SESSION_UNLOCK() clib_spinlock_unlock (&(vcm->sessions_lockp))
 299
 300 #define VCL_IO_SESSIONS_LOCK() \
 301   clib_spinlock_lock (&(vcm->session_io_thread.io_sessions_lockp))
 302 #define VCL_IO_SESSIONS_UNLOCK() \
 303   clib_spinlock_unlock (&(vcm->session_io_thread.io_sessions_lockp))
 304
 305 #define VCL_ACCEPT_FIFO_LOCK() clib_spinlock_lock (&(vcm->session_fifo_lockp))
 306 #define VCL_ACCEPT_FIFO_UNLOCK() \
 307   clib_spinlock_unlock (&(vcm->session_fifo_lockp))
 308
 309 #define VCL_EVENTS_LOCK() \
 310   clib_spinlock_lock (&(vcm->event_thread.events_lockp))
 311 #define VCL_EVENTS_UNLOCK() \
 312   clib_spinlock_unlock (&(vcm->event_thread.events_lockp))
 313
 314 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
 315
 316 static inline vcl_session_t *
 317 vcl_session_alloc (void)
 318 {
 319   vcl_session_t *s;
 320   pool_get (vcm->sessions, s);
 321   memset (s, 0, sizeof (*s));
 322   return s;
 323 }
 324
 325 static inline void
 326 vcl_session_free (vcl_session_t * s)
 327 {
 328   pool_put (vcm->sessions, s);
 329 }
 330
 331 static inline vcl_session_t *
 332 vcl_session_get (u32 session_index)
 333 {
 334   if (pool_is_free_index (vcm->sessions, session_index))
 335     return 0;
 336   return pool_elt_at_index (vcm->sessions, session_index);
 337 }
 338
 339 static inline u32
 340 vcl_session_index (vcl_session_t * s)
 341 {
 342   return (s - vcm->sessions);
 343 }
 344
 345 static inline vcl_session_t *
 346 vcl_session_get_w_handle (u64 handle)
 347 {
 348   uword *p;
 349   if ((p = hash_get (vcm->session_index_by_vpp_handles, handle)))
 350     return vcl_session_get ((u32) p[0]);
 351   return 0;
 352 }
 353
 354 static inline u32
 355 vcl_session_get_index_from_handle (u64 handle)
 356 {
 357   uword *p;
 358   if ((p = hash_get (vcm->session_index_by_vpp_handles, handle)))
 359     return p[0];
 360   return VCL_INVALID_SESSION_INDEX;
 361 }
 362
 363 static inline u8
 364 vcl_session_is_ct (vcl_session_t * s)
 365 {
 366   return (s->our_evt_q != 0);
 367 }
 368
 369 static inline int
 370 vppcom_session_at_index (u32 session_index, vcl_session_t * volatile *sess)
 371 {
 372   /* Assumes that caller has acquired spinlock: vcm->sessions_lockp */
 373   if (PREDICT_FALSE ((session_index == ~0) ||
 374                      pool_is_free_index (vcm->sessions, session_index)))
 375     {
 376       clib_warning ("VCL<%d>: invalid session, sid (%u) has been closed!",
 377                     getpid (), session_index);
 378       return VPPCOM_EBADFD;
 379     }
 380   *sess = pool_elt_at_index (vcm->sessions, session_index);
 381   return VPPCOM_OK;
 382 }
 383
 384 static inline void
 385 vppcom_session_table_add_listener (u64 listener_handle, u32 value)
 386 {
 387   /* Session and listener handles have different formats. The latter has
 388    * the thread index in the upper 32 bits while the former has the session
 389    * type. Knowing that, for listeners we just flip the MSB to 1 */
 390   listener_handle |= 1ULL << 63;
 391   hash_set (vcm->session_index_by_vpp_handles, listener_handle, value);
 392 }
 393
 394 static inline vcl_session_t *
 395 vppcom_session_table_lookup_listener (u64 listener_handle)
 396 {
 397   uword *p;
 398   u64 handle = listener_handle | (1ULL << 63);
 399   vcl_session_t *session;
 400
 401   p = hash_get (vcm->session_index_by_vpp_handles, handle);
 402   if (!p)
 403     {
 404       clib_warning ("VCL<%d>: couldn't find listen session: unknown vpp "
 405                     "listener handle %llx", getpid (), listener_handle);
 406       return 0;
 407     }
 408   if (pool_is_free_index (vcm->sessions, p[0]))
 409     {
 410       VDBG (1, "VCL<%d>: invalid listen session, sid (%u)", getpid (), p[0]);
 411       return 0;
 412     }
 413
 414   session = pool_elt_at_index (vcm->sessions, p[0]);
 415   ASSERT (session->session_state & STATE_LISTEN);
 416   return session;
 417 }
 418
 419 const char *vppcom_session_state_str (session_state_t state);
 420
 421 /*
 422  * Helpers
 423  */
 424 vcl_cut_through_registration_t *vcl_ct_registration_lock_and_alloc (void);
 425 void vcl_ct_registration_del (vcl_cut_through_registration_t * ctr);
 426 u32 vcl_ct_registration_index (vcl_cut_through_registration_t * ctr);
 427 void vcl_ct_registration_unlock (void);
 428 vcl_cut_through_registration_t *vcl_ct_registration_get (u32 ctr_index);
 429 vcl_cut_through_registration_t *vcl_ct_registration_lock_and_lookup (uword);
 430 void vcl_ct_registration_lookup_add (uword mq_addr, u32 ctr_index);
 431 void vcl_ct_registration_lookup_del (uword mq_addr);
 432 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (void);
 433 u32 vcl_mq_evt_conn_index (vcl_mq_evt_conn_t * mqc);
 434 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (u32 mq_conn_idx);
 435 int vcl_mq_epoll_add_evfd (svm_msg_q_t * mq);
 436 int vcl_mq_epoll_del_evfd (u32 mqc_index);
 437
 438 /*
 439  * VCL Binary API
 440  */
 441 int vppcom_connect_to_vpp (char *app_name);
 442 void vppcom_init_error_string_table (void);
 443 void vppcom_send_session_enable_disable (u8 is_enable);
 444 void vppcom_app_send_attach (void);
 445 void vppcom_app_send_detach (void);
 446 void vppcom_send_connect_sock (vcl_session_t * session, u32 session_index);
 447 void vppcom_send_disconnect_session_reply (u64 vpp_handle, u32 session_index,
 448                                            int rv);
 449 void vppcom_send_disconnect_session (u64 vpp_handle, u32 session_index);
 450 void vppcom_send_bind_sock (vcl_session_t * session, u32 session_index);
 451 void vppcom_send_unbind_sock (u64 vpp_handle);
 452 void vppcom_api_hookup (void);
 453 void vppcom_send_accept_session_reply (u64 handle, u32 context, int retval);
 454
 455 u32 vcl_max_nsid_len (void);
 456
 457 u8 *format_api_error (u8 * s, va_list * args);
 458
 459 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
 460
 461 /*
 462  * fd.io coding-style-patch-verification: ON
 463  *
 464  * Local Variables:
 465  * eval: (c-set-style "gnu")
 466  * End:
 467  */