src/vnet/session/application_interface.h

   1 /*
   2  * Copyright (c) 2016-2019 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 <vlibmemory/api.h>
  19 #include <svm/message_queue.h>
  20 #include <vnet/session/session_types.h>
  21 #include <vnet/tls/tls_test.h>
  22 #include <svm/fifo_segment.h>
  23
  24 typedef struct certificate_
  25 {
  26   u32 *app_interests;           /* vec of application index asking for deletion cb */
  27   u32 cert_key_index;           /* index in cert & key pool */
  28   u8 *key;
  29   u8 *cert;
  30 } app_cert_key_pair_t;
  31
  32 typedef struct session_cb_vft_
  33 {
  34   /** Notify server of new segment */
  35   int (*add_segment_callback) (u32 app_wrk_index, u64 segment_handle);
  36
  37   /** Notify server of new segment */
  38   int (*del_segment_callback) (u32 app_wrk_index, u64 segment_handle);
  39
  40   /** Notify server of newly accepted session */
  41   int (*session_accept_callback) (session_t * new_session);
  42
  43   /** Connection request callback */
  44   int (*session_connected_callback) (u32 app_wrk_index, u32 opaque,
  45                                      session_t * s, u8 code);
  46
  47   /** Notify app that session is closing */
  48   void (*session_disconnect_callback) (session_t * s);
  49
  50   /** Notify app that transport is closed */
  51   void (*session_transport_closed_callback) (session_t * s);
  52
  53   /** Notify app that session or transport are about to be removed */
  54   void (*session_cleanup_callback) (session_t * s, session_cleanup_ntf_t ntf);
  55
  56   /** Notify app that session was reset */
  57   void (*session_reset_callback) (session_t * s);
  58
  59   /** Notify app that session pool migration happened */
  60   void (*session_migrate_callback) (session_t * s, session_handle_t new_sh);
  61
  62   /** Direct RX callback for built-in application */
  63   int (*builtin_app_rx_callback) (session_t * session);
  64
  65   /** Direct TX callback for built-in application */
  66   int (*builtin_app_tx_callback) (session_t * session);
  67
  68   /** Cert and key pair delete notification */
  69   int (*app_cert_key_pair_delete_callback) (app_cert_key_pair_t * ckpair);
  70
  71   /** Delegate fifo-tuning-logic to application */
  72   int (*fifo_tuning_callback) (session_t * s, svm_fifo_t * f,
  73                                session_ft_action_t act, u32 bytes);
  74
  75 } session_cb_vft_t;
  76
  77 #define foreach_app_init_args                   \
  78   _(u32, api_client_index)                      \
  79   _(u8 *, name)                                 \
  80   _(u64 *, options)                             \
  81   _(u8 *, namespace_id)                         \
  82   _(session_cb_vft_t *, session_cb_vft)         \
  83   _(u32, app_index)                             \
  84
  85 typedef struct _vnet_app_attach_args_t
  86 {
  87 #define _(_type, _name) _type _name;
  88   foreach_app_init_args
  89 #undef _
  90   ssvm_private_t * segment;
  91   svm_msg_q_t *app_evt_q;
  92   u64 segment_handle;
  93 } vnet_app_attach_args_t;
  94
  95 typedef struct _vnet_app_detach_args_t
  96 {
  97   u32 app_index;
  98   u32 api_client_index;
  99 } vnet_app_detach_args_t;
 100
 101 typedef struct _vnet_bind_args_t
 102 {
 103   union
 104   {
 105     session_endpoint_cfg_t sep_ext;
 106     session_endpoint_t sep;
 107     char *uri;
 108   };
 109
 110   u32 app_index;
 111   u32 wrk_map_index;
 112
 113   /*
 114    * Results
 115    */
 116   char *segment_name;
 117   u32 segment_name_length;
 118   u64 server_event_queue_address;
 119   u64 handle;
 120 } vnet_listen_args_t;
 121
 122 typedef struct _vnet_unlisten_args_t
 123 {
 124   union
 125   {
 126     char *uri;
 127     u64 handle;                 /**< Session handle */
 128   };
 129   u32 app_index;                /**< Owning application index */
 130   u32 wrk_map_index;            /**< App's local pool worker index */
 131 } vnet_unlisten_args_t;
 132
 133 typedef struct _vnet_connect_args
 134 {
 135   union
 136   {
 137     session_endpoint_cfg_t sep_ext;
 138     session_endpoint_t sep;
 139     char *uri;
 140   };
 141   u32 app_index;
 142   u32 wrk_map_index;
 143   u32 api_context;
 144
 145   session_handle_t session_handle;
 146 } vnet_connect_args_t;
 147
 148 typedef struct _vnet_disconnect_args_t
 149 {
 150   session_handle_t handle;
 151   u32 app_index;
 152 } vnet_disconnect_args_t;
 153
 154 typedef struct _vnet_application_add_tls_cert_args_t
 155 {
 156   u32 app_index;
 157   u8 *cert;
 158 } vnet_app_add_tls_cert_args_t;
 159
 160 typedef struct _vnet_application_add_tls_key_args_t
 161 {
 162   u32 app_index;
 163   u8 *key;
 164 } vnet_app_add_tls_key_args_t;
 165
 166 typedef enum crypto_engine_type_
 167 {
 168   CRYPTO_ENGINE_NONE,
 169   CRYPTO_ENGINE_OPENSSL,
 170   CRYPTO_ENGINE_MBEDTLS,
 171   CRYPTO_ENGINE_VPP,
 172   CRYPTO_ENGINE_PICOTLS,
 173   CRYPTO_ENGINE_LAST = CRYPTO_ENGINE_PICOTLS,
 174 } crypto_engine_type_t;
 175
 176 typedef struct _vnet_app_add_cert_key_pair_args_
 177 {
 178   u8 *cert;
 179   u8 *key;
 180   u32 index;
 181 } vnet_app_add_cert_key_pair_args_t;
 182
 183 typedef struct crypto_ctx_
 184 {
 185   u32 ctx_index;                /**< index in crypto context pool */
 186   u32 n_subscribers;            /**< refcount of sessions using said context */
 187   u32 ckpair_index;             /**< certificate & key */
 188   u8 crypto_engine;
 189   void *data;                   /**< protocol specific data */
 190 } crypto_context_t;
 191
 192 /* Application attach options */
 193 typedef enum
 194 {
 195   APP_OPTIONS_FLAGS,
 196   APP_OPTIONS_EVT_QUEUE_SIZE,
 197   APP_OPTIONS_SEGMENT_SIZE,
 198   APP_OPTIONS_ADD_SEGMENT_SIZE,
 199   APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
 200   APP_OPTIONS_RX_FIFO_SIZE,
 201   APP_OPTIONS_TX_FIFO_SIZE,
 202   APP_OPTIONS_PREALLOC_FIFO_PAIRS,
 203   APP_OPTIONS_NAMESPACE,
 204   APP_OPTIONS_NAMESPACE_SECRET,
 205   APP_OPTIONS_PROXY_TRANSPORT,
 206   APP_OPTIONS_ACCEPT_COOKIE,
 207   APP_OPTIONS_TLS_ENGINE,
 208   APP_OPTIONS_MAX_FIFO_SIZE,
 209   APP_OPTIONS_HIGH_WATERMARK,
 210   APP_OPTIONS_LOW_WATERMARK,
 211   APP_OPTIONS_PCT_FIRST_ALLOC,
 212   APP_OPTIONS_N_OPTIONS
 213 } app_attach_options_index_t;
 214
 215 #define foreach_app_options_flags                               \
 216   _(ACCEPT_REDIRECT, "Use FIFO with redirects")                 \
 217   _(ADD_SEGMENT, "Add segment and signal app if needed")        \
 218   _(IS_BUILTIN, "Application is builtin")                       \
 219   _(IS_TRANSPORT_APP, "Application is a transport proto")       \
 220   _(IS_PROXY, "Application is proxying")                        \
 221   _(USE_GLOBAL_SCOPE, "App can use global session scope")       \
 222   _(USE_LOCAL_SCOPE, "App can use local session scope")         \
 223   _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling")           \
 224
 225 typedef enum _app_options
 226 {
 227 #define _(sym, str) APP_OPTIONS_##sym,
 228   foreach_app_options_flags
 229 #undef _
 230 } app_options_t;
 231
 232 typedef enum _app_options_flags
 233 {
 234 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
 235   foreach_app_options_flags
 236 #undef _
 237 } app_options_flags_t;
 238
 239 #define foreach_fd_type                                         \
 240   _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment")            \
 241   _(MEMFD_SEGMENT, "Fd for memfd segment")                      \
 242   _(MQ_EVENTFD, "Event fd used by message queue")               \
 243   _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue")     \
 244
 245 typedef enum session_fd_type_
 246 {
 247 #define _(sym, str) SESSION_FD_##sym,
 248   foreach_fd_type
 249 #undef _
 250   SESSION_N_FD_TYPE
 251 } session_fd_type_t;
 252
 253 typedef enum session_fd_flag_
 254 {
 255 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
 256   foreach_fd_type
 257 #undef _
 258 } session_fd_flag_t;
 259
 260 int parse_uri (char *uri, session_endpoint_cfg_t * sep);
 261 int vnet_bind_uri (vnet_listen_args_t *);
 262 int vnet_unbind_uri (vnet_unlisten_args_t * a);
 263 int vnet_connect_uri (vnet_connect_args_t * a);
 264
 265 int vnet_application_attach (vnet_app_attach_args_t * a);
 266 int vnet_application_detach (vnet_app_detach_args_t * a);
 267 int vnet_listen (vnet_listen_args_t * a);
 268 int vnet_connect (vnet_connect_args_t * a);
 269 int vnet_unlisten (vnet_unlisten_args_t * a);
 270 int vnet_disconnect_session (vnet_disconnect_args_t * a);
 271
 272 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
 273 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
 274 int vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a);
 275 int vnet_app_del_cert_key_pair (u32 index);
 276 /** Ask for app cb on pair deletion */
 277 int vnet_app_add_cert_key_interest (u32 index, u32 app_index);
 278
 279 typedef struct app_session_transport_
 280 {
 281   ip46_address_t rmt_ip;        /**< remote ip */
 282   ip46_address_t lcl_ip;        /**< local ip */
 283   u16 rmt_port;                 /**< remote port (network order) */
 284   u16 lcl_port;                 /**< local port (network order) */
 285   u8 is_ip4;                    /**< set if uses ip4 networking */
 286 } app_session_transport_t;
 287
 288 #define foreach_app_session_field                                       \
 289   _(svm_fifo_t, *rx_fifo)               /**< rx fifo */                 \
 290   _(svm_fifo_t, *tx_fifo)               /**< tx fifo */                 \
 291   _(session_type_t, session_type)       /**< session type */            \
 292   _(volatile u8, session_state)         /**< session state */           \
 293   _(u32, session_index)                 /**< index in owning pool */    \
 294   _(app_session_transport_t, transport) /**< transport info */          \
 295   _(svm_msg_q_t, *vpp_evt_q)            /**< vpp event queue  */        \
 296   _(u8, is_dgram)                       /**< flag for dgram mode */     \
 297
 298 typedef struct
 299 {
 300 #define _(type, name) type name;
 301   foreach_app_session_field
 302 #undef _
 303 } app_session_t;
 304
 305 typedef struct session_listen_msg_
 306 {
 307   u32 client_index;
 308   u32 context;                  /* Not needed but keeping it for compatibility with bapi */
 309   u32 wrk_index;
 310   u32 vrf;
 311   u16 port;
 312   u8 proto;
 313   u8 is_ip4;
 314   ip46_address_t ip;
 315   u32 ckpair_index;
 316   u8 crypto_engine;
 317 } __clib_packed session_listen_msg_t;
 318
 319 STATIC_ASSERT (sizeof (session_listen_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
 320                "msg too large");
 321
 322 typedef struct session_listen_uri_msg_
 323 {
 324   u32 client_index;
 325   u32 context;
 326   u8 uri[56];
 327 } __clib_packed session_listen_uri_msg_t;
 328
 329 STATIC_ASSERT (sizeof (session_listen_uri_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
 330                "msg too large");
 331
 332 typedef struct session_bound_msg_
 333 {
 334   u32 context;
 335   u64 handle;
 336   i32 retval;
 337   u8 lcl_is_ip4;
 338   u8 lcl_ip[16];
 339   u16 lcl_port;
 340   uword rx_fifo;
 341   uword tx_fifo;
 342   uword vpp_evt_q;
 343   u32 segment_size;
 344   u8 segment_name_length;
 345   u8 segment_name[128];
 346 } __clib_packed session_bound_msg_t;
 347
 348 typedef struct session_unlisten_msg_
 349 {
 350   u32 client_index;
 351   u32 context;
 352   u32 wrk_index;
 353   session_handle_t handle;
 354 } __clib_packed session_unlisten_msg_t;
 355
 356 typedef struct session_unlisten_reply_msg_
 357 {
 358   u32 context;
 359   u64 handle;
 360   i32 retval;
 361 } __clib_packed session_unlisten_reply_msg_t;
 362
 363 typedef struct session_accepted_msg_
 364 {
 365   u32 context;
 366   u64 listener_handle;
 367   u64 handle;
 368   uword server_rx_fifo;
 369   uword server_tx_fifo;
 370   u64 segment_handle;
 371   uword vpp_event_queue_address;
 372   transport_endpoint_t rmt;
 373   u8 flags;
 374 } __clib_packed session_accepted_msg_t;
 375
 376 typedef struct session_accepted_reply_msg_
 377 {
 378   u32 context;
 379   i32 retval;
 380   u64 handle;
 381 } __clib_packed session_accepted_reply_msg_t;
 382
 383 typedef struct session_connect_msg_
 384 {
 385   u32 client_index;
 386   u32 context;
 387   u32 wrk_index;
 388   u32 vrf;
 389   u16 port;
 390   u8 proto;
 391   u8 is_ip4;
 392   ip46_address_t ip;
 393   ip46_address_t lcl_ip;
 394   u8 hostname_len;
 395   u8 hostname[16];
 396   u64 parent_handle;
 397   u32 ckpair_index;
 398   u8 crypto_engine;
 399   u8 flags;
 400 } __clib_packed session_connect_msg_t;
 401
 402 STATIC_ASSERT (sizeof (session_connect_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
 403                "msg too large");
 404
 405 typedef struct session_connect_uri_msg_
 406 {
 407   u32 client_index;
 408   u32 context;
 409   u8 uri[56];
 410 } __clib_packed session_connect_uri_msg_t;
 411
 412 STATIC_ASSERT (sizeof (session_connect_uri_msg_t) <=
 413                SESSION_CTRL_MSG_MAX_SIZE, "msg too large");
 414
 415 typedef struct session_connected_msg_
 416 {
 417   u32 context;
 418   i32 retval;
 419   u64 handle;
 420   uword server_rx_fifo;
 421   uword server_tx_fifo;
 422   u64 segment_handle;
 423   uword ct_rx_fifo;
 424   uword ct_tx_fifo;
 425   u64 ct_segment_handle;
 426   uword vpp_event_queue_address;
 427   u32 segment_size;
 428   u8 segment_name_length;
 429   u8 segment_name[64];
 430   transport_endpoint_t lcl;
 431 } __clib_packed session_connected_msg_t;
 432
 433 typedef struct session_disconnect_msg_
 434 {
 435   u32 client_index;
 436   u32 context;
 437   session_handle_t handle;
 438 } __clib_packed session_disconnect_msg_t;
 439
 440 typedef struct session_disconnected_msg_
 441 {
 442   u32 client_index;
 443   u32 context;
 444   u64 handle;
 445 } __clib_packed session_disconnected_msg_t;
 446
 447 typedef struct session_disconnected_reply_msg_
 448 {
 449   u32 context;
 450   i32 retval;
 451   u64 handle;
 452 } __clib_packed session_disconnected_reply_msg_t;
 453
 454 typedef struct session_reset_msg_
 455 {
 456   u32 client_index;
 457   u32 context;
 458   u64 handle;
 459 } __clib_packed session_reset_msg_t;
 460
 461 typedef struct session_reset_reply_msg_
 462 {
 463   u32 context;
 464   i32 retval;
 465   u64 handle;
 466 } __clib_packed session_reset_reply_msg_t;
 467
 468 typedef struct session_req_worker_update_msg_
 469 {
 470   u64 session_handle;
 471 } __clib_packed session_req_worker_update_msg_t;
 472
 473 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
 474 typedef struct session_worker_update_msg_
 475 {
 476   u32 client_index;
 477   u16 wrk_index;
 478   u16 req_wrk_index;
 479   u64 handle;
 480 } __clib_packed session_worker_update_msg_t;
 481
 482 typedef struct session_worker_update_reply_msg_
 483 {
 484   u64 handle;
 485   uword rx_fifo;
 486   uword tx_fifo;
 487   u64 segment_handle;
 488 } __clib_packed session_worker_update_reply_msg_t;
 489
 490 typedef struct session_app_detach_msg_
 491 {
 492   u32 client_index;
 493   u32 context;
 494 } session_app_detach_msg_t;
 495
 496 typedef struct app_map_another_segment_msg_
 497 {
 498   u32 client_index;
 499   u32 context;
 500   u8 fd_flags;
 501   u32 segment_size;
 502   u8 segment_name[128];
 503   u64 segment_handle;
 504 } session_app_add_segment_msg_t;
 505
 506 typedef struct app_unmap_segment_msg_
 507 {
 508   u32 client_index;
 509   u32 context;
 510   u64 segment_handle;
 511 } session_app_del_segment_msg_t;
 512
 513 typedef struct session_migrate_msg_
 514 {
 515   uword vpp_evt_q;
 516   session_handle_t handle;
 517   session_handle_t new_handle;
 518   u32 vpp_thread_index;
 519 } __clib_packed session_migrated_msg_t;
 520
 521 typedef struct session_cleanup_msg_
 522 {
 523   session_handle_t handle;
 524 } __clib_packed session_cleanup_msg_t;
 525
 526 typedef struct app_session_event_
 527 {
 528   svm_msg_q_msg_t msg;
 529   session_event_t *evt;
 530 } __clib_packed app_session_evt_t;
 531
 532 static inline void
 533 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
 534                            u8 evt_type)
 535 {
 536   svm_msg_q_lock_and_alloc_msg_w_ring (mq,
 537                                        SESSION_MQ_CTRL_EVT_RING,
 538                                        SVM_Q_WAIT, &app_evt->msg);
 539   app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
 540   clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
 541   app_evt->evt->event_type = evt_type;
 542 }
 543
 544 static inline void
 545 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
 546 {
 547   svm_msg_q_add_and_unlock (mq, &app_evt->msg);
 548 }
 549
 550 /**
 551  * Send fifo io event to vpp worker thread
 552  *
 553  * Because there may be multiple writers to one of vpp's queues, this
 554  * protects message allocation and enqueueing.
 555  *
 556  * @param mq            vpp message queue
 557  * @param f             fifo for which the event is sent
 558  * @param evt_type      type of event
 559  * @param noblock       flag to indicate is request is blocking or not
 560  * @return              0 if success, negative integer otherwise
 561  */
 562 static inline int
 563 app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
 564                         u8 noblock)
 565 {
 566   session_event_t *evt;
 567   svm_msg_q_msg_t msg;
 568
 569   if (noblock)
 570     {
 571       if (svm_msg_q_try_lock (mq))
 572         return -1;
 573       if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
 574         {
 575           svm_msg_q_unlock (mq);
 576           return -2;
 577         }
 578       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
 579       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
 580       evt->session_index = session_index;
 581       evt->event_type = evt_type;
 582       svm_msg_q_add_and_unlock (mq, &msg);
 583       return 0;
 584     }
 585   else
 586     {
 587       svm_msg_q_lock (mq);
 588       while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
 589              || svm_msg_q_is_full (mq))
 590         svm_msg_q_wait (mq);
 591       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
 592       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
 593       evt->session_index = session_index;
 594       evt->event_type = evt_type;
 595       svm_msg_q_add_and_unlock (mq, &msg);
 596       return 0;
 597     }
 598 }
 599
 600 always_inline int
 601 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
 602                     svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
 603                     u8 do_evt, u8 noblock)
 604 {
 605   u32 max_enqueue, actual_write;
 606   session_dgram_hdr_t hdr;
 607   int rv;
 608
 609   max_enqueue = svm_fifo_max_enqueue_prod (f);
 610   if (max_enqueue <= sizeof (session_dgram_hdr_t))
 611     return 0;
 612
 613   max_enqueue -= sizeof (session_dgram_hdr_t);
 614   actual_write = clib_min (len, max_enqueue);
 615   hdr.data_length = actual_write;
 616   hdr.data_offset = 0;
 617   clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
 618   hdr.is_ip4 = at->is_ip4;
 619   hdr.rmt_port = at->rmt_port;
 620   clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
 621   hdr.lcl_port = at->lcl_port;
 622   rv = svm_fifo_enqueue (f, sizeof (hdr), (u8 *) & hdr);
 623   ASSERT (rv == sizeof (hdr));
 624
 625   rv = svm_fifo_enqueue (f, actual_write, data);
 626   if (do_evt)
 627     {
 628       if (rv > 0 && svm_fifo_set_event (f))
 629         app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
 630                                 noblock);
 631     }
 632   ASSERT (rv);
 633   return rv;
 634 }
 635
 636 always_inline int
 637 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
 638 {
 639   return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
 640                              len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
 641                              noblock);
 642 }
 643
 644 always_inline int
 645 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
 646                      u32 len, u8 evt_type, u8 do_evt, u8 noblock)
 647 {
 648   int rv;
 649
 650   rv = svm_fifo_enqueue (f, len, data);
 651   if (do_evt)
 652     {
 653       if (rv > 0 && svm_fifo_set_event (f))
 654         app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
 655                                 noblock);
 656     }
 657   return rv;
 658 }
 659
 660 always_inline int
 661 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
 662 {
 663   return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
 664                               SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
 665 }
 666
 667 always_inline int
 668 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
 669 {
 670   if (s->is_dgram)
 671     return app_send_dgram (s, data, len, noblock);
 672   return app_send_stream (s, data, len, noblock);
 673 }
 674
 675 always_inline int
 676 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
 677                     app_session_transport_t * at, u8 clear_evt, u8 peek)
 678 {
 679   session_dgram_pre_hdr_t ph;
 680   u32 max_deq;
 681   int rv;
 682
 683   max_deq = svm_fifo_max_dequeue_cons (f);
 684   if (max_deq < sizeof (session_dgram_hdr_t))
 685     {
 686       if (clear_evt)
 687         svm_fifo_unset_event (f);
 688       return 0;
 689     }
 690
 691   if (clear_evt)
 692     svm_fifo_unset_event (f);
 693
 694   svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
 695   ASSERT (ph.data_length >= ph.data_offset);
 696   if (!ph.data_offset)
 697     svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
 698   len = clib_min (len, ph.data_length - ph.data_offset);
 699   rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
 700   if (peek)
 701     return rv;
 702   ph.data_offset += rv;
 703   if (ph.data_offset == ph.data_length)
 704     svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
 705   else
 706     svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
 707   return rv;
 708 }
 709
 710 always_inline int
 711 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
 712 {
 713   return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
 714 }
 715
 716 always_inline int
 717 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
 718 {
 719   if (clear_evt)
 720     svm_fifo_unset_event (f);
 721
 722   if (peek)
 723     return svm_fifo_peek (f, 0, len, buf);
 724
 725   return svm_fifo_dequeue (f, len, buf);
 726 }
 727
 728 always_inline int
 729 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
 730 {
 731   return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
 732 }
 733
 734 always_inline int
 735 app_recv (app_session_t * s, u8 * data, u32 len)
 736 {
 737   if (s->is_dgram)
 738     return app_recv_dgram (s, data, len);
 739   return app_recv_stream (s, data, len);
 740 }
 741
 742 #endif /* __included_uri_h__ */
 743
 744 /*
 745  * fd.io coding-style-patch-verification: ON
 746  *
 747  * Local Variables:
 748  * eval: (c-set-style "gnu")
 749  * End:
 750  */