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