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