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
 141 typedef enum _app_options
 142 {
 143 #define _(sym, str) APP_OPTIONS_##sym,
 144   foreach_app_options_flags
 145 #undef _
 146 } app_options_t;
 147
 148 typedef enum _app_options_flags
 149 {
 150 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
 151   foreach_app_options_flags
 152 #undef _
 153 } app_options_flags_t;
 154
 155 int vnet_bind_uri (vnet_bind_args_t *);
 156 int vnet_unbind_uri (vnet_unbind_args_t * a);
 157 clib_error_t *vnet_connect_uri (vnet_connect_args_t * a);
 158
 159 clib_error_t *vnet_application_attach (vnet_app_attach_args_t * a);
 160 clib_error_t *vnet_bind (vnet_bind_args_t * a);
 161 clib_error_t *vnet_connect (vnet_connect_args_t * a);
 162 clib_error_t *vnet_unbind (vnet_unbind_args_t * a);
 163 int vnet_application_detach (vnet_app_detach_args_t * a);
 164 int vnet_disconnect_session (vnet_disconnect_args_t * a);
 165
 166 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
 167 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
 168
 169 extern const char test_srv_crt_rsa[];
 170 extern const u32 test_srv_crt_rsa_len;
 171 extern const char test_srv_key_rsa[];
 172 extern const u32 test_srv_key_rsa_len;
 173
 174 typedef struct app_session_transport_
 175 {
 176   ip46_address_t rmt_ip;        /**< remote ip */
 177   ip46_address_t lcl_ip;        /**< local ip */
 178   u16 rmt_port;                 /**< remote port (network order) */
 179   u16 lcl_port;                 /**< local port (network order) */
 180   u8 is_ip4;                    /**< set if uses ip4 networking */
 181 } app_session_transport_t;
 182
 183 #define foreach_app_session_field                                       \
 184   _(svm_fifo_t, *rx_fifo)               /**< rx fifo */                 \
 185   _(svm_fifo_t, *tx_fifo)               /**< tx fifo */                 \
 186   _(session_type_t, session_type)       /**< session type */            \
 187   _(volatile u8, session_state)         /**< session state */           \
 188   _(u32, session_index)                 /**< index in owning pool */    \
 189   _(app_session_transport_t, transport) /**< transport info */          \
 190   _(svm_msg_q_t, *vpp_evt_q)            /**< vpp event queue  */        \
 191   _(u8, is_dgram)                       /**< flag for dgram mode */     \
 192
 193 typedef struct
 194 {
 195 #define _(type, name) type name;
 196   foreach_app_session_field
 197 #undef _
 198 } app_session_t;
 199
 200 /**
 201  * Send fifo io event to vpp worker thread
 202  *
 203  * Because there may be multiple writers to one of vpp's queues, this
 204  * protects message allocation and enqueueing.
 205  *
 206  * @param mq            vpp message queue
 207  * @param f             fifo for which the event is sent
 208  * @param evt_type      type of event
 209  * @param noblock       flag to indicate is request is blocking or not
 210  * @return              0 if success, negative integer otherwise
 211  */
 212 static inline int
 213 app_send_io_evt_to_vpp (svm_msg_q_t * mq, svm_fifo_t * f, u8 evt_type,
 214                         u8 noblock)
 215 {
 216   session_fifo_event_t *evt;
 217   svm_msg_q_msg_t msg;
 218
 219   if (noblock)
 220     {
 221       if (svm_msg_q_try_lock (mq))
 222         return -1;
 223       if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
 224         {
 225           svm_msg_q_unlock (mq);
 226           return -2;
 227         }
 228       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
 229       if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg)))
 230         {
 231           svm_msg_q_unlock (mq);
 232           return -2;
 233         }
 234       evt = (session_fifo_event_t *) svm_msg_q_msg_data (mq, &msg);
 235       evt->fifo = f;
 236       evt->event_type = evt_type;
 237       svm_msg_q_add_w_lock (mq, &msg);
 238       svm_msg_q_unlock (mq);
 239       return 0;
 240     }
 241   else
 242     {
 243       svm_msg_q_lock (mq);
 244       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
 245       while (svm_msg_q_msg_is_invalid (&msg))
 246         {
 247           svm_msg_q_wait (mq);
 248           msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
 249         }
 250       evt = (session_fifo_event_t *) svm_msg_q_msg_data (mq, &msg);
 251       evt->fifo = f;
 252       evt->event_type = evt_type;
 253       if (svm_msg_q_is_full (mq))
 254         svm_msg_q_wait (mq);
 255       svm_msg_q_add_w_lock (mq, &msg);
 256       svm_msg_q_unlock (mq);
 257       return 0;
 258     }
 259 }
 260
 261 always_inline int
 262 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
 263                     svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 noblock)
 264 {
 265   u32 max_enqueue, actual_write;
 266   session_dgram_hdr_t hdr;
 267   int rv;
 268
 269   max_enqueue = svm_fifo_max_enqueue (f);
 270   if (max_enqueue <= sizeof (session_dgram_hdr_t))
 271     return 0;
 272
 273   max_enqueue -= sizeof (session_dgram_hdr_t);
 274   actual_write = clib_min (len, max_enqueue);
 275   hdr.data_length = actual_write;
 276   hdr.data_offset = 0;
 277   clib_memcpy (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
 278   hdr.is_ip4 = at->is_ip4;
 279   hdr.rmt_port = at->rmt_port;
 280   clib_memcpy (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
 281   hdr.lcl_port = at->lcl_port;
 282   rv = svm_fifo_enqueue_nowait (f, sizeof (hdr), (u8 *) & hdr);
 283   ASSERT (rv == sizeof (hdr));
 284
 285   if ((rv = svm_fifo_enqueue_nowait (f, actual_write, data)) > 0)
 286     {
 287       if (svm_fifo_set_event (f))
 288         app_send_io_evt_to_vpp (vpp_evt_q, f, FIFO_EVENT_APP_TX, noblock);
 289     }
 290   ASSERT (rv);
 291   return rv;
 292 }
 293
 294 always_inline int
 295 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
 296 {
 297   return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
 298                              len, noblock);
 299 }
 300
 301 always_inline int
 302 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
 303                      u32 len, u8 noblock)
 304 {
 305   int rv;
 306
 307   if ((rv = svm_fifo_enqueue_nowait (f, len, data)) > 0)
 308     {
 309       if (svm_fifo_set_event (f))
 310         app_send_io_evt_to_vpp (vpp_evt_q, f, FIFO_EVENT_APP_TX, noblock);
 311     }
 312   return rv;
 313 }
 314
 315 always_inline int
 316 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
 317 {
 318   return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len, noblock);
 319 }
 320
 321 always_inline int
 322 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
 323 {
 324   if (s->is_dgram)
 325     return app_send_dgram (s, data, len, noblock);
 326   return app_send_stream (s, data, len, noblock);
 327 }
 328
 329 always_inline int
 330 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
 331                     app_session_transport_t * at, u8 clear_evt)
 332 {
 333   session_dgram_pre_hdr_t ph;
 334   u32 max_deq;
 335   int rv;
 336
 337   if (clear_evt)
 338     svm_fifo_unset_event (f);
 339   max_deq = svm_fifo_max_dequeue (f);
 340   if (max_deq < sizeof (session_dgram_hdr_t))
 341     return 0;
 342
 343   svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
 344   ASSERT (ph.data_length >= ph.data_offset);
 345   if (!ph.data_offset)
 346     svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
 347   len = clib_min (len, ph.data_length - ph.data_offset);
 348   rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
 349   ph.data_offset += rv;
 350   if (ph.data_offset == ph.data_length)
 351     svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
 352   else
 353     svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
 354   return rv;
 355 }
 356
 357 always_inline int
 358 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
 359 {
 360   return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1);
 361 }
 362
 363 always_inline int
 364 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt)
 365 {
 366   if (clear_evt)
 367     svm_fifo_unset_event (f);
 368   return svm_fifo_dequeue_nowait (f, len, buf);
 369 }
 370
 371 always_inline int
 372 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
 373 {
 374   return app_recv_stream_raw (s->rx_fifo, buf, len, 1);
 375 }
 376
 377 always_inline int
 378 app_recv (app_session_t * s, u8 * data, u32 len)
 379 {
 380   if (s->is_dgram)
 381     return app_recv_dgram (s, data, len);
 382   return app_recv_stream (s, data, len);
 383 }
 384
 385 #endif /* __included_uri_h__ */
 386
 387 /*
 388  * fd.io coding-style-patch-verification: ON
 389  *
 390  * Local Variables:
 391  * eval: (c-set-style "gnu")
 392  * End:
 393  */