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