src/vnet/session/application_interface.h

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