src/vnet/session/application_interface.h

   1 /*
   2  * Copyright (c) 2016-2019 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   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 #ifndef __included_uri_h__
  16 #define __included_uri_h__
  17
  18 #include <vlibmemory/api.h>
  19 #include <svm/message_queue.h>
  20 #include <svm/svm_fifo_segment.h>
  21 #include <vnet/session/session_types.h>
  22 #include <vnet/tls/tls_test.h>
  23
  24 typedef struct _stream_session_cb_vft
  25 {
  26   /** Notify server of new segment */
  27   int (*add_segment_callback) (u32 api_client_index, u64 segment_handle);
  28
  29   /** Notify server of new segment */
  30   int (*del_segment_callback) (u32 api_client_index, u64 segment_handle);
  31
  32   /** Notify server of newly accepted session */
  33   int (*session_accept_callback) (session_t * new_session);
  34
  35   /** Connection request callback */
  36   int (*session_connected_callback) (u32 app_wrk_index, u32 opaque,
  37                                      session_t * s, u8 code);
  38
  39   /** Notify app that session is closing */
  40   void (*session_disconnect_callback) (session_t * s);
  41
  42   /** Notify app that session was reset */
  43   void (*session_reset_callback) (session_t * s);
  44
  45   /** Direct RX callback for built-in application */
  46   int (*builtin_app_rx_callback) (session_t * session);
  47
  48   /** Direct TX callback for built-in application */
  49   int (*builtin_app_tx_callback) (session_t * session);
  50
  51 } session_cb_vft_t;
  52
  53 #define foreach_app_init_args                   \
  54   _(u32, api_client_index)                      \
  55   _(u8 *, name)                                 \
  56   _(u64 *, options)                             \
  57   _(u8 *, namespace_id)                         \
  58   _(session_cb_vft_t *, session_cb_vft)         \
  59   _(u32, app_index)                             \
  60
  61 typedef struct _vnet_app_attach_args_t
  62 {
  63 #define _(_type, _name) _type _name;
  64   foreach_app_init_args
  65 #undef _
  66   ssvm_private_t * segment;
  67   svm_msg_q_t *app_evt_q;
  68   u64 segment_handle;
  69 } vnet_app_attach_args_t;
  70
  71 typedef struct _vnet_app_detach_args_t
  72 {
  73   u32 app_index;
  74   u32 api_client_index;
  75 } vnet_app_detach_args_t;
  76
  77 typedef struct _vnet_bind_args_t
  78 {
  79   union
  80   {
  81     session_endpoint_cfg_t sep_ext;
  82     session_endpoint_t sep;
  83     char *uri;
  84   };
  85
  86   u32 app_index;
  87   u32 wrk_map_index;
  88
  89   /*
  90    * Results
  91    */
  92   char *segment_name;
  93   u32 segment_name_length;
  94   u64 server_event_queue_address;
  95   u64 handle;
  96 } vnet_listen_args_t;
  97
  98 typedef struct _vnet_unlisten_args_t
  99 {
 100   union
 101   {
 102     char *uri;
 103     u64 handle;                 /**< Session handle */
 104   };
 105   u32 app_index;                /**< Owning application index */
 106   u32 wrk_map_index;            /**< App's local pool worker index */
 107 } vnet_unlisten_args_t;
 108
 109 typedef struct _vnet_connect_args
 110 {
 111   union
 112   {
 113     session_endpoint_cfg_t sep_ext;
 114     session_endpoint_t sep;
 115     char *uri;
 116   };
 117   u32 app_index;
 118   u32 wrk_map_index;
 119   u32 api_context;
 120
 121   session_handle_t session_handle;
 122 } vnet_connect_args_t;
 123
 124 typedef struct _vnet_disconnect_args_t
 125 {
 126   session_handle_t handle;
 127   u32 app_index;
 128 } vnet_disconnect_args_t;
 129
 130 typedef struct _vnet_application_add_tls_cert_args_t
 131 {
 132   u32 app_index;
 133   u8 *cert;
 134 } vnet_app_add_tls_cert_args_t;
 135
 136 typedef struct _vnet_application_add_tls_key_args_t
 137 {
 138   u32 app_index;
 139   u8 *key;
 140 } vnet_app_add_tls_key_args_t;
 141
 142 typedef enum tls_engine_type_
 143 {
 144   TLS_ENGINE_NONE,
 145   TLS_ENGINE_MBEDTLS,
 146   TLS_ENGINE_OPENSSL,
 147   TLS_N_ENGINES
 148 } tls_engine_type_t;
 149
 150 /* Application attach options */
 151 typedef enum
 152 {
 153   APP_OPTIONS_FLAGS,
 154   APP_OPTIONS_EVT_QUEUE_SIZE,
 155   APP_OPTIONS_SEGMENT_SIZE,
 156   APP_OPTIONS_ADD_SEGMENT_SIZE,
 157   APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
 158   APP_OPTIONS_RX_FIFO_SIZE,
 159   APP_OPTIONS_TX_FIFO_SIZE,
 160   APP_OPTIONS_PREALLOC_FIFO_PAIRS,
 161   APP_OPTIONS_NAMESPACE,
 162   APP_OPTIONS_NAMESPACE_SECRET,
 163   APP_OPTIONS_PROXY_TRANSPORT,
 164   APP_OPTIONS_ACCEPT_COOKIE,
 165   APP_OPTIONS_TLS_ENGINE,
 166   APP_OPTIONS_N_OPTIONS
 167 } app_attach_options_index_t;
 168
 169 #define foreach_app_options_flags                               \
 170   _(ACCEPT_REDIRECT, "Use FIFO with redirects")                 \
 171   _(ADD_SEGMENT, "Add segment and signal app if needed")        \
 172   _(IS_BUILTIN, "Application is builtin")                       \
 173   _(IS_TRANSPORT_APP, "Application is a transport proto")       \
 174   _(IS_PROXY, "Application is proxying")                        \
 175   _(USE_GLOBAL_SCOPE, "App can use global session scope")       \
 176   _(USE_LOCAL_SCOPE, "App can use local session scope")         \
 177   _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling")           \
 178
 179 typedef enum _app_options
 180 {
 181 #define _(sym, str) APP_OPTIONS_##sym,
 182   foreach_app_options_flags
 183 #undef _
 184 } app_options_t;
 185
 186 typedef enum _app_options_flags
 187 {
 188 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
 189   foreach_app_options_flags
 190 #undef _
 191 } app_options_flags_t;
 192
 193 #define foreach_fd_type                                         \
 194   _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment")            \
 195   _(MEMFD_SEGMENT, "Fd for memfd segment")                      \
 196   _(MQ_EVENTFD, "Event fd used by message queue")               \
 197   _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue")     \
 198
 199 typedef enum session_fd_type_
 200 {
 201 #define _(sym, str) SESSION_FD_##sym,
 202   foreach_fd_type
 203 #undef _
 204   SESSION_N_FD_TYPE
 205 } session_fd_type_t;
 206
 207 typedef enum session_fd_flag_
 208 {
 209 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
 210   foreach_fd_type
 211 #undef _
 212 } session_fd_flag_t;
 213
 214 int vnet_bind_uri (vnet_listen_args_t *);
 215 int vnet_unbind_uri (vnet_unlisten_args_t * a);
 216 int vnet_connect_uri (vnet_connect_args_t * a);
 217
 218 int vnet_application_attach (vnet_app_attach_args_t * a);
 219 int vnet_application_detach (vnet_app_detach_args_t * a);
 220 int vnet_listen (vnet_listen_args_t * a);
 221 int vnet_connect (vnet_connect_args_t * a);
 222 int vnet_unlisten (vnet_unlisten_args_t * a);
 223 int vnet_disconnect_session (vnet_disconnect_args_t * a);
 224
 225 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
 226 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
 227
 228 typedef struct app_session_transport_
 229 {
 230   ip46_address_t rmt_ip;        /**< remote ip */
 231   ip46_address_t lcl_ip;        /**< local ip */
 232   u16 rmt_port;                 /**< remote port (network order) */
 233   u16 lcl_port;                 /**< local port (network order) */
 234   u8 is_ip4;                    /**< set if uses ip4 networking */
 235 } app_session_transport_t;
 236
 237 #define foreach_app_session_field                                       \
 238   _(svm_fifo_t, *rx_fifo)               /**< rx fifo */                 \
 239   _(svm_fifo_t, *tx_fifo)               /**< tx fifo */                 \
 240   _(session_type_t, session_type)       /**< session type */            \
 241   _(volatile u8, session_state)         /**< session state */           \
 242   _(u32, session_index)                 /**< index in owning pool */    \
 243   _(app_session_transport_t, transport) /**< transport info */          \
 244   _(svm_msg_q_t, *vpp_evt_q)            /**< vpp event queue  */        \
 245   _(u8, is_dgram)                       /**< flag for dgram mode */     \
 246
 247 typedef struct
 248 {
 249 #define _(type, name) type name;
 250   foreach_app_session_field
 251 #undef _
 252 } app_session_t;
 253
 254 typedef struct session_bound_msg_
 255 {
 256   u32 context;
 257   u64 handle;
 258   i32 retval;
 259   u8 lcl_is_ip4;
 260   u8 lcl_ip[16];
 261   u16 lcl_port;
 262   uword rx_fifo;
 263   uword tx_fifo;
 264   uword vpp_evt_q;
 265   u32 segment_size;
 266   u8 segment_name_length;
 267   u8 segment_name[128];
 268 } __clib_packed session_bound_msg_t;
 269
 270 typedef struct session_unlisten_reply_msg_
 271 {
 272   u32 context;
 273   u64 handle;
 274   i32 retval;
 275 } __clib_packed session_unlisten_reply_msg_t;
 276
 277 typedef struct session_accepted_msg_
 278 {
 279   u32 context;
 280   u64 listener_handle;
 281   u64 handle;
 282   uword server_rx_fifo;
 283   uword server_tx_fifo;
 284   u64 segment_handle;
 285   uword vpp_event_queue_address;
 286   uword server_event_queue_address;
 287   uword client_event_queue_address;
 288   u16 port;
 289   u8 is_ip4;
 290   u8 ip[16];
 291 } __clib_packed session_accepted_msg_t;
 292
 293 typedef struct session_accepted_reply_msg_
 294 {
 295   u32 context;
 296   i32 retval;
 297   u64 handle;
 298 } __clib_packed session_accepted_reply_msg_t;
 299
 300 /* Make sure this is not too large, otherwise it won't fit when dequeued in
 301  * the session queue node */
 302 STATIC_ASSERT (sizeof (session_accepted_reply_msg_t) <= 16, "accept reply");
 303
 304 typedef struct session_connected_msg_
 305 {
 306   u32 context;
 307   i32 retval;
 308   u64 handle;
 309   uword server_rx_fifo;
 310   uword server_tx_fifo;
 311   u64 segment_handle;
 312   uword vpp_event_queue_address;
 313   uword client_event_queue_address;
 314   uword server_event_queue_address;
 315   u32 segment_size;
 316   u8 segment_name_length;
 317   u8 segment_name[64];
 318   u8 lcl_ip[16];
 319   u8 is_ip4;
 320   u16 lcl_port;
 321 } __clib_packed session_connected_msg_t;
 322
 323 typedef struct session_disconnected_msg_
 324 {
 325   u32 client_index;
 326   u32 context;
 327   u64 handle;
 328 } __clib_packed session_disconnected_msg_t;
 329
 330 typedef struct session_disconnected_reply_msg_
 331 {
 332   u32 context;
 333   i32 retval;
 334   u64 handle;
 335 } __clib_packed session_disconnected_reply_msg_t;
 336
 337 typedef struct session_reset_msg_
 338 {
 339   u32 client_index;
 340   u32 context;
 341   u64 handle;
 342 } __clib_packed session_reset_msg_t;
 343
 344 typedef struct session_reset_reply_msg_
 345 {
 346   u32 context;
 347   i32 retval;
 348   u64 handle;
 349 } __clib_packed session_reset_reply_msg_t;
 350
 351 typedef struct session_req_worker_update_msg_
 352 {
 353   u64 session_handle;
 354 } __clib_packed session_req_worker_update_msg_t;
 355
 356 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
 357 typedef struct session_worker_update_msg_
 358 {
 359   u32 client_index;
 360   u16 wrk_index;
 361   u16 req_wrk_index;
 362   u64 handle;
 363 } __clib_packed session_worker_update_msg_t;
 364
 365 typedef struct session_worker_update_reply_msg_
 366 {
 367   u64 handle;
 368   uword rx_fifo;
 369   uword tx_fifo;
 370   u64 segment_handle;
 371 } __clib_packed session_worker_update_reply_msg_t;
 372
 373 typedef struct app_session_event_
 374 {
 375   svm_msg_q_msg_t msg;
 376   session_event_t *evt;
 377 } __clib_packed app_session_evt_t;
 378
 379 static inline void
 380 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
 381                            u8 evt_type)
 382 {
 383   svm_msg_q_lock_and_alloc_msg_w_ring (mq,
 384                                        SESSION_MQ_CTRL_EVT_RING,
 385                                        SVM_Q_WAIT, &app_evt->msg);
 386   svm_msg_q_unlock (mq);
 387   app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
 388   clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
 389   app_evt->evt->event_type = evt_type;
 390 }
 391
 392 static inline void
 393 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
 394 {
 395   svm_msg_q_add (mq, &app_evt->msg, SVM_Q_WAIT);
 396 }
 397
 398 /**
 399  * Send fifo io event to vpp worker thread
 400  *
 401  * Because there may be multiple writers to one of vpp's queues, this
 402  * protects message allocation and enqueueing.
 403  *
 404  * @param mq            vpp message queue
 405  * @param f             fifo for which the event is sent
 406  * @param evt_type      type of event
 407  * @param noblock       flag to indicate is request is blocking or not
 408  * @return              0 if success, negative integer otherwise
 409  */
 410 static inline int
 411 app_send_io_evt_to_vpp (svm_msg_q_t * mq, svm_fifo_t * f, u8 evt_type,
 412                         u8 noblock)
 413 {
 414   session_event_t *evt;
 415   svm_msg_q_msg_t msg;
 416
 417   if (noblock)
 418     {
 419       if (svm_msg_q_try_lock (mq))
 420         return -1;
 421       if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
 422         {
 423           svm_msg_q_unlock (mq);
 424           return -2;
 425         }
 426       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
 427       if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg)))
 428         {
 429           svm_msg_q_unlock (mq);
 430           return -2;
 431         }
 432       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
 433       evt->fifo = f;
 434       evt->event_type = evt_type;
 435       svm_msg_q_add_and_unlock (mq, &msg);
 436       return 0;
 437     }
 438   else
 439     {
 440       svm_msg_q_lock (mq);
 441       while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING))
 442         svm_msg_q_wait (mq);
 443       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
 444       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
 445       evt->fifo = f;
 446       evt->event_type = evt_type;
 447       if (svm_msg_q_is_full (mq))
 448         svm_msg_q_wait (mq);
 449       svm_msg_q_add_and_unlock (mq, &msg);
 450       return 0;
 451     }
 452 }
 453
 454 always_inline int
 455 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
 456                     svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
 457                     u8 noblock)
 458 {
 459   u32 max_enqueue, actual_write;
 460   session_dgram_hdr_t hdr;
 461   int rv;
 462
 463   max_enqueue = svm_fifo_max_enqueue (f);
 464   if (max_enqueue <= sizeof (session_dgram_hdr_t))
 465     return 0;
 466
 467   max_enqueue -= sizeof (session_dgram_hdr_t);
 468   actual_write = clib_min (len, max_enqueue);
 469   hdr.data_length = actual_write;
 470   hdr.data_offset = 0;
 471   clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
 472   hdr.is_ip4 = at->is_ip4;
 473   hdr.rmt_port = at->rmt_port;
 474   clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
 475   hdr.lcl_port = at->lcl_port;
 476   rv = svm_fifo_enqueue_nowait (f, sizeof (hdr), (u8 *) & hdr);
 477   ASSERT (rv == sizeof (hdr));
 478
 479   if ((rv = svm_fifo_enqueue_nowait (f, actual_write, data)) > 0)
 480     {
 481       if (svm_fifo_set_event (f))
 482         app_send_io_evt_to_vpp (vpp_evt_q, f, evt_type, noblock);
 483     }
 484   ASSERT (rv);
 485   return rv;
 486 }
 487
 488 always_inline int
 489 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
 490 {
 491   return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
 492                              len, SESSION_IO_EVT_TX, noblock);
 493 }
 494
 495 always_inline int
 496 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
 497                      u32 len, u8 evt_type, u8 noblock)
 498 {
 499   int rv;
 500
 501   if ((rv = svm_fifo_enqueue_nowait (f, len, data)) > 0)
 502     {
 503       if (svm_fifo_set_event (f))
 504         app_send_io_evt_to_vpp (vpp_evt_q, f, evt_type, noblock);
 505     }
 506   return rv;
 507 }
 508
 509 always_inline int
 510 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
 511 {
 512   return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
 513                               SESSION_IO_EVT_TX, noblock);
 514 }
 515
 516 always_inline int
 517 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
 518 {
 519   if (s->is_dgram)
 520     return app_send_dgram (s, data, len, noblock);
 521   return app_send_stream (s, data, len, noblock);
 522 }
 523
 524 always_inline int
 525 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
 526                     app_session_transport_t * at, u8 clear_evt, u8 peek)
 527 {
 528   session_dgram_pre_hdr_t ph;
 529   u32 max_deq;
 530   int rv;
 531
 532   max_deq = svm_fifo_max_dequeue (f);
 533   if (max_deq < sizeof (session_dgram_hdr_t))
 534     {
 535       if (clear_evt)
 536         svm_fifo_unset_event (f);
 537       return 0;
 538     }
 539
 540   if (clear_evt)
 541     svm_fifo_unset_event (f);
 542
 543   svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
 544   ASSERT (ph.data_length >= ph.data_offset);
 545   if (!ph.data_offset)
 546     svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
 547   len = clib_min (len, ph.data_length - ph.data_offset);
 548   rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
 549   if (peek)
 550     return rv;
 551   ph.data_offset += rv;
 552   if (ph.data_offset == ph.data_length)
 553     svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
 554   else
 555     svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
 556   return rv;
 557 }
 558
 559 always_inline int
 560 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
 561 {
 562   return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
 563 }
 564
 565 always_inline int
 566 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
 567 {
 568   if (clear_evt)
 569     svm_fifo_unset_event (f);
 570
 571   if (peek)
 572     return svm_fifo_peek (f, 0, len, buf);
 573
 574   return svm_fifo_dequeue_nowait (f, len, buf);
 575 }
 576
 577 always_inline int
 578 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
 579 {
 580   return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
 581 }
 582
 583 always_inline int
 584 app_recv (app_session_t * s, u8 * data, u32 len)
 585 {
 586   if (s->is_dgram)
 587     return app_recv_dgram (s, data, len);
 588   return app_recv_stream (s, data, len);
 589 }
 590
 591 #endif /* __included_uri_h__ */
 592
 593 /*
 594  * fd.io coding-style-patch-verification: ON
 595  *
 596  * Local Variables:
 597  * eval: (c-set-style "gnu")
 598  * End:
 599  */