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 <vlib/vlib.h>
  19 #include <vnet/vnet.h>
  20 #include <svm/svm_fifo_segment.h>
  21 #include <vnet/session/session.h>
  22 #include <vnet/session/application.h>
  23 #include <vnet/session/transport.h>
  24 #include <vnet/tls/tls.h>
  25
  26 typedef struct _vnet_app_attach_args_t
  27 {
  28   /** Binary API client index */
  29   u32 api_client_index;
  30
  31   /** Application name. Used by builtin apps */
  32   u8 *name;
  33
  34   /** Application and segment manager options */
  35   u64 *options;
  36
  37   /** ID of the namespace the app has access to */
  38   u8 *namespace_id;
  39
  40   /** Session to application callback functions */
  41   session_cb_vft_t *session_cb_vft;
  42
  43   /*
  44    * Results
  45    */
  46   ssvm_private_t *segment;
  47   u64 app_event_queue_address;
  48   u32 app_index;
  49 } vnet_app_attach_args_t;
  50
  51 typedef struct _vnet_app_detach_args_t
  52 {
  53   u32 app_index;
  54 } vnet_app_detach_args_t;
  55
  56 typedef struct _vnet_bind_args_t
  57 {
  58   union
  59   {
  60     char *uri;
  61     session_endpoint_t sep;
  62   };
  63
  64   u32 app_index;
  65
  66   /*
  67    * Results
  68    */
  69   char *segment_name;
  70   u32 segment_name_length;
  71   u64 server_event_queue_address;
  72   u64 handle;
  73 } vnet_bind_args_t;
  74
  75 typedef struct _vnet_unbind_args_t
  76 {
  77   union
  78   {
  79     char *uri;
  80     u64 handle;
  81   };
  82   u32 app_index;
  83 } vnet_unbind_args_t;
  84
  85 typedef struct _vnet_connect_args
  86 {
  87   union
  88   {
  89     char *uri;
  90     session_endpoint_extended_t sep;
  91   };
  92   u32 app_index;
  93   u32 api_context;
  94
  95   session_handle_t session_handle;
  96 } vnet_connect_args_t;
  97
  98 typedef struct _vnet_disconnect_args_t
  99 {
 100   session_handle_t handle;
 101   u32 app_index;
 102 } vnet_disconnect_args_t;
 103
 104 typedef struct _vnet_application_add_tls_cert_args_t
 105 {
 106   u32 app_index;
 107   u8 *cert;
 108 } vnet_app_add_tls_cert_args_t;
 109
 110 typedef struct _vnet_application_add_tls_key_args_t
 111 {
 112   u32 app_index;
 113   u8 *key;
 114 } vnet_app_add_tls_key_args_t;
 115
 116 /* Application attach options */
 117 typedef enum
 118 {
 119   APP_OPTIONS_FLAGS,
 120   APP_OPTIONS_EVT_QUEUE_SIZE,
 121   APP_OPTIONS_SEGMENT_SIZE,
 122   APP_OPTIONS_ADD_SEGMENT_SIZE,
 123   APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
 124   APP_OPTIONS_RX_FIFO_SIZE,
 125   APP_OPTIONS_TX_FIFO_SIZE,
 126   APP_OPTIONS_PREALLOC_FIFO_PAIRS,
 127   APP_OPTIONS_NAMESPACE,
 128   APP_OPTIONS_NAMESPACE_SECRET,
 129   APP_OPTIONS_PROXY_TRANSPORT,
 130   APP_OPTIONS_ACCEPT_COOKIE,
 131   APP_OPTIONS_TLS_ENGINE,
 132   APP_OPTIONS_N_OPTIONS
 133 } app_attach_options_index_t;
 134
 135 #define foreach_app_options_flags                               \
 136   _(ACCEPT_REDIRECT, "Use FIFO with redirects")                 \
 137   _(ADD_SEGMENT, "Add segment and signal app if needed")        \
 138   _(IS_BUILTIN, "Application is builtin")                       \
 139   _(IS_PROXY, "Application is proxying")                        \
 140   _(USE_GLOBAL_SCOPE, "App can use global session scope")       \
 141   _(USE_LOCAL_SCOPE, "App can use local session scope")
 142
 143 typedef enum _app_options
 144 {
 145 #define _(sym, str) APP_OPTIONS_##sym,
 146   foreach_app_options_flags
 147 #undef _
 148 } app_options_t;
 149
 150 typedef enum _app_options_flags
 151 {
 152 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
 153   foreach_app_options_flags
 154 #undef _
 155 } app_options_flags_t;
 156
 157 int vnet_bind_uri (vnet_bind_args_t *);
 158 int vnet_unbind_uri (vnet_unbind_args_t * a);
 159 clib_error_t *vnet_connect_uri (vnet_connect_args_t * a);
 160
 161 clib_error_t *vnet_application_attach (vnet_app_attach_args_t * a);
 162 clib_error_t *vnet_bind (vnet_bind_args_t * a);
 163 clib_error_t *vnet_connect (vnet_connect_args_t * a);
 164 clib_error_t *vnet_unbind (vnet_unbind_args_t * a);
 165 int vnet_application_detach (vnet_app_detach_args_t * a);
 166 int vnet_disconnect_session (vnet_disconnect_args_t * a);
 167
 168 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
 169 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
 170
 171 extern const char test_srv_crt_rsa[];
 172 extern const u32 test_srv_crt_rsa_len;
 173 extern const char test_srv_key_rsa[];
 174 extern const u32 test_srv_key_rsa_len;
 175
 176 typedef struct app_session_transport_
 177 {
 178   ip46_address_t rmt_ip;        /**< remote ip */
 179   ip46_address_t lcl_ip;        /**< local ip */
 180   u16 rmt_port;                 /**< remote port (network order) */
 181   u16 lcl_port;                 /**< local port (network order) */
 182   u8 is_ip4;                    /**< set if uses ip4 networking */
 183 } app_session_transport_t;
 184
 185 #define foreach_app_session_field                                       \
 186   _(svm_fifo_t, *rx_fifo)               /**< rx fifo */                 \
 187   _(svm_fifo_t, *tx_fifo)               /**< tx fifo */                 \
 188   _(session_type_t, session_type)       /**< session type */            \
 189   _(volatile u8, session_state)         /**< session state */           \
 190   _(u32, session_index)                 /**< index in owning pool */    \
 191   _(app_session_transport_t, transport) /**< transport info */          \
 192   _(svm_queue_t, *vpp_evt_q)            /**< vpp event queue  */        \
 193   _(u8, is_dgram)                       /**< flag for dgram mode */     \
 194
 195 typedef struct
 196 {
 197 #define _(type, name) type name;
 198   foreach_app_session_field
 199 #undef _
 200 } app_session_t;
 201
 202 always_inline int
 203 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
 204                     svm_queue_t * vpp_evt_q, u8 * data, u32 len, u8 noblock)
 205 {
 206   u32 max_enqueue, actual_write;
 207   session_dgram_hdr_t hdr;
 208   session_fifo_event_t evt;
 209   int rv;
 210
 211   max_enqueue = svm_fifo_max_enqueue (f);
 212   if (max_enqueue <= sizeof (session_dgram_hdr_t))
 213     return 0;
 214
 215   max_enqueue -= sizeof (session_dgram_hdr_t);
 216   actual_write = clib_min (len, max_enqueue);
 217   hdr.data_length = actual_write;
 218   hdr.data_offset = 0;
 219   clib_memcpy (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
 220   hdr.is_ip4 = at->is_ip4;
 221   hdr.rmt_port = at->rmt_port;
 222   clib_memcpy (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
 223   hdr.lcl_port = at->lcl_port;
 224   rv = svm_fifo_enqueue_nowait (f, sizeof (hdr), (u8 *) & hdr);
 225   ASSERT (rv == sizeof (hdr));
 226
 227   if ((rv = svm_fifo_enqueue_nowait (f, actual_write, data)) > 0)
 228     {
 229       if (svm_fifo_set_event (f))
 230         {
 231           evt.fifo = f;
 232           evt.event_type = FIFO_EVENT_APP_TX;
 233           svm_queue_add (vpp_evt_q, (u8 *) & evt, noblock);
 234         }
 235     }
 236   ASSERT (rv);
 237   return rv;
 238 }
 239
 240 always_inline int
 241 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
 242 {
 243   return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
 244                              len, noblock);
 245 }
 246
 247 always_inline int
 248 app_send_stream_raw (svm_fifo_t * f, svm_queue_t * vpp_evt_q, u8 * data,
 249                      u32 len, u8 noblock)
 250 {
 251   session_fifo_event_t evt;
 252   int rv;
 253
 254   if ((rv = svm_fifo_enqueue_nowait (f, len, data)) > 0)
 255     {
 256       if (svm_fifo_set_event (f))
 257         {
 258           evt.fifo = f;
 259           evt.event_type = FIFO_EVENT_APP_TX;
 260           svm_queue_add (vpp_evt_q, (u8 *) & evt, noblock);
 261         }
 262     }
 263   return rv;
 264 }
 265
 266 always_inline int
 267 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
 268 {
 269   return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len, noblock);
 270 }
 271
 272 always_inline int
 273 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
 274 {
 275   if (s->is_dgram)
 276     return app_send_dgram (s, data, len, noblock);
 277   return app_send_stream (s, data, len, noblock);
 278 }
 279
 280 always_inline int
 281 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
 282                     app_session_transport_t * at, u8 clear_evt)
 283 {
 284   session_dgram_pre_hdr_t ph;
 285   u32 max_deq;
 286   int rv;
 287
 288   if (clear_evt)
 289     svm_fifo_unset_event (f);
 290   max_deq = svm_fifo_max_dequeue (f);
 291   if (max_deq < sizeof (session_dgram_hdr_t))
 292     return 0;
 293
 294   svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
 295   ASSERT (ph.data_length >= ph.data_offset);
 296   if (!ph.data_offset)
 297     svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
 298   len = clib_min (len, ph.data_length - ph.data_offset);
 299   rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
 300   ph.data_offset += rv;
 301   if (ph.data_offset == ph.data_length)
 302     svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
 303   else
 304     svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
 305   return rv;
 306 }
 307
 308 always_inline int
 309 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
 310 {
 311   return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1);
 312 }
 313
 314 always_inline int
 315 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt)
 316 {
 317   if (clear_evt)
 318     svm_fifo_unset_event (f);
 319   return svm_fifo_dequeue_nowait (f, len, buf);
 320 }
 321
 322 always_inline int
 323 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
 324 {
 325   return app_recv_stream_raw (s->rx_fifo, buf, len, 1);
 326 }
 327
 328 always_inline int
 329 app_recv (app_session_t * s, u8 * data, u32 len)
 330 {
 331   if (s->is_dgram)
 332     return app_recv_dgram (s, data, len);
 333   return app_recv_stream (s, data, len);
 334 }
 335
 336 #endif /* __included_uri_h__ */
 337
 338 /*
 339  * fd.io coding-style-patch-verification: ON
 340  *
 341  * Local Variables:
 342  * eval: (c-set-style "gnu")
 343  * End:
 344  */