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, session_error_t 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   _(u8, use_sock_api)                           \
  85
  86 typedef struct _vnet_app_attach_args_t
  87 {
  88 #define _(_type, _name) _type _name;
  89   foreach_app_init_args
  90 #undef _
  91   ssvm_private_t * segment;
  92   svm_msg_q_t *app_evt_q;
  93   u64 segment_handle;
  94 } vnet_app_attach_args_t;
  95
  96 typedef struct _vnet_app_detach_args_t
  97 {
  98   u32 app_index;
  99   u32 api_client_index;
 100 } vnet_app_detach_args_t;
 101
 102 typedef struct _vnet_bind_args_t
 103 {
 104   union
 105   {
 106     session_endpoint_cfg_t sep_ext;
 107     session_endpoint_t sep;
 108     char *uri;
 109   };
 110
 111   u32 app_index;
 112   u32 wrk_map_index;
 113
 114   /*
 115    * Results
 116    */
 117   char *segment_name;
 118   u32 segment_name_length;
 119   u64 server_event_queue_address;
 120   u64 handle;
 121 } vnet_listen_args_t;
 122
 123 typedef struct _vnet_unlisten_args_t
 124 {
 125   union
 126   {
 127     char *uri;
 128     u64 handle;                 /**< Session handle */
 129   };
 130   u32 app_index;                /**< Owning application index */
 131   u32 wrk_map_index;            /**< App's local pool worker index */
 132 } vnet_unlisten_args_t;
 133
 134 typedef struct _vnet_connect_args
 135 {
 136   union
 137   {
 138     session_endpoint_cfg_t sep_ext;
 139     session_endpoint_t sep;
 140     char *uri;
 141   };
 142   u32 app_index;
 143   u32 wrk_map_index;
 144   u32 api_context;
 145
 146   session_handle_t session_handle;
 147 } vnet_connect_args_t;
 148
 149 typedef struct _vnet_disconnect_args_t
 150 {
 151   session_handle_t handle;
 152   u32 app_index;
 153 } vnet_disconnect_args_t;
 154
 155 typedef struct _vnet_application_add_tls_cert_args_t
 156 {
 157   u32 app_index;
 158   u8 *cert;
 159 } vnet_app_add_tls_cert_args_t;
 160
 161 typedef struct _vnet_application_add_tls_key_args_t
 162 {
 163   u32 app_index;
 164   u8 *key;
 165 } vnet_app_add_tls_key_args_t;
 166
 167 typedef enum crypto_engine_type_
 168 {
 169   CRYPTO_ENGINE_NONE,
 170   CRYPTO_ENGINE_OPENSSL,
 171   CRYPTO_ENGINE_MBEDTLS,
 172   CRYPTO_ENGINE_VPP,
 173   CRYPTO_ENGINE_PICOTLS,
 174   CRYPTO_ENGINE_LAST = CRYPTO_ENGINE_PICOTLS,
 175 } crypto_engine_type_t;
 176
 177 typedef struct _vnet_app_add_cert_key_pair_args_
 178 {
 179   u8 *cert;
 180   u8 *key;
 181   u32 cert_len;
 182   u32 key_len;
 183   u32 index;
 184 } vnet_app_add_cert_key_pair_args_t;
 185
 186 typedef struct crypto_ctx_
 187 {
 188   u32 ctx_index;                /**< index in crypto context pool */
 189   u32 n_subscribers;            /**< refcount of sessions using said context */
 190   u32 ckpair_index;             /**< certificate & key */
 191   u8 crypto_engine;
 192   void *data;                   /**< protocol specific data */
 193 } crypto_context_t;
 194
 195 /* Application attach options */
 196 typedef enum
 197 {
 198   APP_OPTIONS_FLAGS,
 199   APP_OPTIONS_EVT_QUEUE_SIZE,
 200   APP_OPTIONS_SEGMENT_SIZE,
 201   APP_OPTIONS_ADD_SEGMENT_SIZE,
 202   APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
 203   APP_OPTIONS_RX_FIFO_SIZE,
 204   APP_OPTIONS_TX_FIFO_SIZE,
 205   APP_OPTIONS_PREALLOC_FIFO_PAIRS,
 206   APP_OPTIONS_PREALLOC_FIFO_HDRS,
 207   APP_OPTIONS_NAMESPACE,
 208   APP_OPTIONS_NAMESPACE_SECRET,
 209   APP_OPTIONS_PROXY_TRANSPORT,
 210   APP_OPTIONS_ACCEPT_COOKIE,
 211   APP_OPTIONS_TLS_ENGINE,
 212   APP_OPTIONS_MAX_FIFO_SIZE,
 213   APP_OPTIONS_HIGH_WATERMARK,
 214   APP_OPTIONS_LOW_WATERMARK,
 215   APP_OPTIONS_PCT_FIRST_ALLOC,
 216   APP_OPTIONS_N_OPTIONS
 217 } app_attach_options_index_t;
 218
 219 #define foreach_app_options_flags                               \
 220   _(ACCEPT_REDIRECT, "Use FIFO with redirects")                 \
 221   _(ADD_SEGMENT, "Add segment and signal app if needed")        \
 222   _(IS_BUILTIN, "Application is builtin")                       \
 223   _(IS_TRANSPORT_APP, "Application is a transport proto")       \
 224   _(IS_PROXY, "Application is proxying")                        \
 225   _(USE_GLOBAL_SCOPE, "App can use global session scope")       \
 226   _(USE_LOCAL_SCOPE, "App can use local session scope")         \
 227   _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling")           \
 228
 229 typedef enum _app_options
 230 {
 231 #define _(sym, str) APP_OPTIONS_##sym,
 232   foreach_app_options_flags
 233 #undef _
 234 } app_options_t;
 235
 236 typedef enum _app_options_flags
 237 {
 238 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
 239   foreach_app_options_flags
 240 #undef _
 241 } app_options_flags_t;
 242
 243 #define foreach_fd_type                                         \
 244   _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment")            \
 245   _(MEMFD_SEGMENT, "Fd for memfd segment")                      \
 246   _(MQ_EVENTFD, "Event fd used by message queue")               \
 247   _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue")     \
 248
 249 typedef enum session_fd_type_
 250 {
 251 #define _(sym, str) SESSION_FD_##sym,
 252   foreach_fd_type
 253 #undef _
 254   SESSION_N_FD_TYPE
 255 } session_fd_type_t;
 256
 257 typedef enum session_fd_flag_
 258 {
 259 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
 260   foreach_fd_type
 261 #undef _
 262 } session_fd_flag_t;
 263
 264 int parse_uri (char *uri, session_endpoint_cfg_t * sep);
 265 int vnet_bind_uri (vnet_listen_args_t *);
 266 int vnet_unbind_uri (vnet_unlisten_args_t * a);
 267 int vnet_connect_uri (vnet_connect_args_t * a);
 268
 269 int vnet_application_attach (vnet_app_attach_args_t * a);
 270 int vnet_application_detach (vnet_app_detach_args_t * a);
 271 int vnet_listen (vnet_listen_args_t * a);
 272 int vnet_connect (vnet_connect_args_t * a);
 273 int vnet_unlisten (vnet_unlisten_args_t * a);
 274 int vnet_disconnect_session (vnet_disconnect_args_t * a);
 275
 276 int vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a);
 277 int vnet_app_del_cert_key_pair (u32 index);
 278 /** Ask for app cb on pair deletion */
 279 int vnet_app_add_cert_key_interest (u32 index, u32 app_index);
 280
 281 typedef struct app_session_transport_
 282 {
 283   ip46_address_t rmt_ip;        /**< remote ip */
 284   ip46_address_t lcl_ip;        /**< local ip */
 285   u16 rmt_port;                 /**< remote port (network order) */
 286   u16 lcl_port;                 /**< local port (network order) */
 287   u8 is_ip4;                    /**< set if uses ip4 networking */
 288 } app_session_transport_t;
 289
 290 #define foreach_app_session_field                                       \
 291   _(svm_fifo_t, *rx_fifo)               /**< rx fifo */                 \
 292   _(svm_fifo_t, *tx_fifo)               /**< tx fifo */                 \
 293   _(session_type_t, session_type)       /**< session type */            \
 294   _(volatile u8, session_state)         /**< session state */           \
 295   _(u32, session_index)                 /**< index in owning pool */    \
 296   _(app_session_transport_t, transport) /**< transport info */          \
 297   _(svm_msg_q_t, *vpp_evt_q)            /**< vpp event queue  */        \
 298   _(u8, is_dgram)                       /**< flag for dgram mode */     \
 299
 300 typedef struct
 301 {
 302 #define _(type, name) type name;
 303   foreach_app_session_field
 304 #undef _
 305 } app_session_t;
 306
 307 typedef struct session_listen_msg_
 308 {
 309   u32 client_index;
 310   u32 context;                  /* Not needed but keeping it for compatibility with bapi */
 311   u32 wrk_index;
 312   u32 vrf;
 313   u16 port;
 314   u8 proto;
 315   u8 is_ip4;
 316   ip46_address_t ip;
 317   u32 ckpair_index;
 318   u8 crypto_engine;
 319   u8 flags;
 320 } __clib_packed session_listen_msg_t;
 321
 322 STATIC_ASSERT (sizeof (session_listen_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
 323                "msg too large");
 324
 325 typedef struct session_listen_uri_msg_
 326 {
 327   u32 client_index;
 328   u32 context;
 329   u8 uri[56];
 330 } __clib_packed session_listen_uri_msg_t;
 331
 332 STATIC_ASSERT (sizeof (session_listen_uri_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
 333                "msg too large");
 334
 335 typedef struct session_bound_msg_
 336 {
 337   u32 context;
 338   u64 handle;
 339   i32 retval;
 340   u8 lcl_is_ip4;
 341   u8 lcl_ip[16];
 342   u16 lcl_port;
 343   uword rx_fifo;
 344   uword tx_fifo;
 345   uword vpp_evt_q;
 346   u64 segment_handle;
 347 } __clib_packed session_bound_msg_t;
 348
 349 typedef struct session_unlisten_msg_
 350 {
 351   u32 client_index;
 352   u32 context;
 353   u32 wrk_index;
 354   session_handle_t handle;
 355 } __clib_packed session_unlisten_msg_t;
 356
 357 typedef struct session_unlisten_reply_msg_
 358 {
 359   u32 context;
 360   u64 handle;
 361   i32 retval;
 362 } __clib_packed session_unlisten_reply_msg_t;
 363
 364 typedef struct session_accepted_msg_
 365 {
 366   u32 context;
 367   u64 listener_handle;
 368   u64 handle;
 369   uword server_rx_fifo;
 370   uword server_tx_fifo;
 371   u64 segment_handle;
 372   uword vpp_event_queue_address;
 373   u32 mq_index;
 374   transport_endpoint_t rmt;
 375   u8 flags;
 376 } __clib_packed session_accepted_msg_t;
 377
 378 typedef struct session_accepted_reply_msg_
 379 {
 380   u32 context;
 381   i32 retval;
 382   u64 handle;
 383 } __clib_packed session_accepted_reply_msg_t;
 384
 385 typedef struct session_connect_msg_
 386 {
 387   u32 client_index;
 388   u32 context;
 389   u32 wrk_index;
 390   u32 vrf;
 391   u16 port;
 392   u16 lcl_port;
 393   u8 proto;
 394   u8 is_ip4;
 395   ip46_address_t ip;
 396   ip46_address_t lcl_ip;
 397   u8 hostname_len;
 398   u8 hostname[16];
 399   u64 parent_handle;
 400   u32 ckpair_index;
 401   u8 crypto_engine;
 402   u8 flags;
 403 } __clib_packed session_connect_msg_t;
 404
 405 STATIC_ASSERT (sizeof (session_connect_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
 406                "msg too large");
 407
 408 typedef struct session_connect_uri_msg_
 409 {
 410   u32 client_index;
 411   u32 context;
 412   u8 uri[56];
 413 } __clib_packed session_connect_uri_msg_t;
 414
 415 STATIC_ASSERT (sizeof (session_connect_uri_msg_t) <=
 416                SESSION_CTRL_MSG_MAX_SIZE, "msg too large");
 417
 418 typedef struct session_connected_msg_
 419 {
 420   u32 context;
 421   i32 retval;
 422   u64 handle;
 423   uword server_rx_fifo;
 424   uword server_tx_fifo;
 425   u64 segment_handle;
 426   uword ct_rx_fifo;
 427   uword ct_tx_fifo;
 428   u64 ct_segment_handle;
 429   uword vpp_event_queue_address;
 430   u32 segment_size;
 431   u8 segment_name_length;
 432   u8 segment_name[64];
 433   transport_endpoint_t lcl;
 434 } __clib_packed session_connected_msg_t;
 435
 436 typedef struct session_disconnect_msg_
 437 {
 438   u32 client_index;
 439   u32 context;
 440   session_handle_t handle;
 441 } __clib_packed session_disconnect_msg_t;
 442
 443 typedef struct session_disconnected_msg_
 444 {
 445   u32 client_index;
 446   u32 context;
 447   u64 handle;
 448 } __clib_packed session_disconnected_msg_t;
 449
 450 typedef struct session_disconnected_reply_msg_
 451 {
 452   u32 context;
 453   i32 retval;
 454   u64 handle;
 455 } __clib_packed session_disconnected_reply_msg_t;
 456
 457 typedef struct session_reset_msg_
 458 {
 459   u32 client_index;
 460   u32 context;
 461   u64 handle;
 462 } __clib_packed session_reset_msg_t;
 463
 464 typedef struct session_reset_reply_msg_
 465 {
 466   u32 context;
 467   i32 retval;
 468   u64 handle;
 469 } __clib_packed session_reset_reply_msg_t;
 470
 471 typedef struct session_req_worker_update_msg_
 472 {
 473   u64 session_handle;
 474 } __clib_packed session_req_worker_update_msg_t;
 475
 476 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
 477 typedef struct session_worker_update_msg_
 478 {
 479   u32 client_index;
 480   u16 wrk_index;
 481   u16 req_wrk_index;
 482   u64 handle;
 483 } __clib_packed session_worker_update_msg_t;
 484
 485 typedef struct session_worker_update_reply_msg_
 486 {
 487   u64 handle;
 488   uword rx_fifo;
 489   uword tx_fifo;
 490   u64 segment_handle;
 491 } __clib_packed session_worker_update_reply_msg_t;
 492
 493 typedef struct session_app_detach_msg_
 494 {
 495   u32 client_index;
 496   u32 context;
 497 } session_app_detach_msg_t;
 498
 499 typedef struct app_map_another_segment_msg_
 500 {
 501   u32 client_index;
 502   u32 context;
 503   u8 fd_flags;
 504   u32 segment_size;
 505   u8 segment_name[128];
 506   u64 segment_handle;
 507 } session_app_add_segment_msg_t;
 508
 509 typedef struct app_unmap_segment_msg_
 510 {
 511   u32 client_index;
 512   u32 context;
 513   u64 segment_handle;
 514 } session_app_del_segment_msg_t;
 515
 516 typedef struct session_migrate_msg_
 517 {
 518   uword vpp_evt_q;
 519   session_handle_t handle;
 520   session_handle_t new_handle;
 521   u64 segment_handle;
 522   u32 vpp_thread_index;
 523 } __clib_packed session_migrated_msg_t;
 524
 525 typedef struct session_cleanup_msg_
 526 {
 527   session_handle_t handle;
 528   u8 type;
 529 } __clib_packed session_cleanup_msg_t;
 530
 531 typedef struct session_app_wrk_rpc_msg_
 532 {
 533   u32 client_index;     /**< app client index */
 534   u32 wrk_index;        /**< dst worker index */
 535   u8 data[64];          /**< rpc data */
 536 } __clib_packed session_app_wrk_rpc_msg_t;
 537
 538 typedef struct session_transport_attr_msg_
 539 {
 540   u32 client_index;
 541   session_handle_t handle;
 542   transport_endpt_attr_t attr;
 543   u8 is_get;
 544 } __clib_packed session_transport_attr_msg_t;
 545
 546 typedef struct session_transport_attr_reply_msg_
 547 {
 548   i32 retval;
 549   session_handle_t handle;
 550   transport_endpt_attr_t attr;
 551   u8 is_get;
 552 } __clib_packed session_transport_attr_reply_msg_t;
 553
 554 typedef struct app_session_event_
 555 {
 556   svm_msg_q_msg_t msg;
 557   session_event_t *evt;
 558 } __clib_packed app_session_evt_t;
 559
 560 static inline void
 561 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
 562                            u8 evt_type)
 563 {
 564   svm_msg_q_lock_and_alloc_msg_w_ring (mq,
 565                                        SESSION_MQ_CTRL_EVT_RING,
 566                                        SVM_Q_WAIT, &app_evt->msg);
 567   app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
 568   clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
 569   app_evt->evt->event_type = evt_type;
 570 }
 571
 572 static inline void
 573 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
 574 {
 575   svm_msg_q_add_and_unlock (mq, &app_evt->msg);
 576 }
 577
 578 /**
 579  * Send fifo io event to vpp worker thread
 580  *
 581  * Because there may be multiple writers to one of vpp's queues, this
 582  * protects message allocation and enqueueing.
 583  *
 584  * @param mq            vpp message queue
 585  * @param f             fifo for which the event is sent
 586  * @param evt_type      type of event
 587  * @param noblock       flag to indicate is request is blocking or not
 588  * @return              0 if success, negative integer otherwise
 589  */
 590 static inline int
 591 app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
 592                         u8 noblock)
 593 {
 594   session_event_t *evt;
 595   svm_msg_q_msg_t msg;
 596
 597   if (noblock)
 598     {
 599       if (svm_msg_q_try_lock (mq))
 600         return -1;
 601       if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
 602                          || svm_msg_q_is_full (mq)))
 603         {
 604           svm_msg_q_unlock (mq);
 605           return -2;
 606         }
 607       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
 608       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
 609       evt->session_index = session_index;
 610       evt->event_type = evt_type;
 611       svm_msg_q_add_and_unlock (mq, &msg);
 612       return 0;
 613     }
 614   else
 615     {
 616       svm_msg_q_lock (mq);
 617       while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
 618              || svm_msg_q_is_full (mq))
 619         svm_msg_q_wait_prod (mq);
 620       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
 621       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
 622       evt->session_index = session_index;
 623       evt->event_type = evt_type;
 624       svm_msg_q_add_and_unlock (mq, &msg);
 625       return 0;
 626     }
 627 }
 628
 629 always_inline int
 630 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
 631                     svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
 632                     u8 do_evt, u8 noblock)
 633 {
 634   session_dgram_hdr_t hdr;
 635   int rv;
 636
 637   if (svm_fifo_max_enqueue_prod (f) < (sizeof (session_dgram_hdr_t) + len))
 638     return 0;
 639
 640   hdr.data_length = len;
 641   hdr.data_offset = 0;
 642   clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
 643   hdr.is_ip4 = at->is_ip4;
 644   hdr.rmt_port = at->rmt_port;
 645   clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
 646   hdr.lcl_port = at->lcl_port;
 647
 648   /* *INDENT-OFF* */
 649   svm_fifo_seg_t segs[2] = {{ (u8 *) &hdr, sizeof (hdr) }, { data, len }};
 650   /* *INDENT-ON* */
 651
 652   rv = svm_fifo_enqueue_segments (f, segs, 2, 0 /* allow partial */ );
 653   if (PREDICT_FALSE (rv < 0))
 654     return 0;
 655
 656   if (do_evt)
 657     {
 658       if (svm_fifo_set_event (f))
 659         app_send_io_evt_to_vpp (vpp_evt_q, f->shr->master_session_index,
 660                                 evt_type, noblock);
 661     }
 662   return len;
 663 }
 664
 665 always_inline int
 666 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
 667 {
 668   return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
 669                              len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
 670                              noblock);
 671 }
 672
 673 always_inline int
 674 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
 675                      u32 len, u8 evt_type, u8 do_evt, u8 noblock)
 676 {
 677   int rv;
 678
 679   rv = svm_fifo_enqueue (f, len, data);
 680   if (do_evt)
 681     {
 682       if (rv > 0 && svm_fifo_set_event (f))
 683         app_send_io_evt_to_vpp (vpp_evt_q, f->shr->master_session_index,
 684                                 evt_type, noblock);
 685     }
 686   return rv;
 687 }
 688
 689 always_inline int
 690 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
 691 {
 692   return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
 693                               SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
 694 }
 695
 696 always_inline int
 697 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
 698 {
 699   if (s->is_dgram)
 700     return app_send_dgram (s, data, len, noblock);
 701   return app_send_stream (s, data, len, noblock);
 702 }
 703
 704 always_inline int
 705 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
 706                     app_session_transport_t * at, u8 clear_evt, u8 peek)
 707 {
 708   session_dgram_pre_hdr_t ph;
 709   u32 max_deq;
 710   int rv;
 711
 712   max_deq = svm_fifo_max_dequeue_cons (f);
 713   if (max_deq <= sizeof (session_dgram_hdr_t))
 714     {
 715       if (clear_evt)
 716         svm_fifo_unset_event (f);
 717       return 0;
 718     }
 719
 720   if (clear_evt)
 721     svm_fifo_unset_event (f);
 722
 723   svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
 724   ASSERT (ph.data_length >= ph.data_offset);
 725
 726   /* Check if we have the full dgram */
 727   if (max_deq < (ph.data_length + SESSION_CONN_HDR_LEN)
 728       && len >= ph.data_length)
 729     return 0;
 730
 731   svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
 732   len = clib_min (len, ph.data_length - ph.data_offset);
 733   rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
 734   if (peek)
 735     return rv;
 736
 737   /* Discards data that did not fit in buffer */
 738   svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
 739
 740   return rv;
 741 }
 742
 743 always_inline int
 744 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
 745 {
 746   return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
 747 }
 748
 749 always_inline int
 750 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
 751 {
 752   if (clear_evt)
 753     svm_fifo_unset_event (f);
 754
 755   if (peek)
 756     return svm_fifo_peek (f, 0, len, buf);
 757
 758   return svm_fifo_dequeue (f, len, buf);
 759 }
 760
 761 always_inline int
 762 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
 763 {
 764   return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
 765 }
 766
 767 always_inline int
 768 app_recv (app_session_t * s, u8 * data, u32 len)
 769 {
 770   if (s->is_dgram)
 771     return app_recv_dgram (s, data, len);
 772   return app_recv_stream (s, data, len);
 773 }
 774
 775 /* *INDENT-OFF* */
 776 static char *session_error_str[] = {
 777 #define _(sym, str) str,
 778     foreach_session_error
 779 #undef _
 780 };
 781 /* *INDENT-ON* */
 782
 783 static inline u8 *
 784 format_session_error (u8 * s, va_list * args)
 785 {
 786   session_error_t error = va_arg (*args, session_error_t);
 787   if (-error >= 0 && -error < SESSION_N_ERRORS)
 788     s = format (s, "%s", session_error_str[-error]);
 789   else
 790     s = format (s, "invalid session err %u", -error);
 791   return s;
 792 }
 793
 794 /*
 795  * Socket API messages
 796  */
 797
 798 typedef enum app_sapi_msg_type
 799 {
 800   APP_SAPI_MSG_TYPE_NONE,
 801   APP_SAPI_MSG_TYPE_ATTACH,
 802   APP_SAPI_MSG_TYPE_ATTACH_REPLY,
 803   APP_SAPI_MSG_TYPE_ADD_DEL_WORKER,
 804   APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY,
 805   APP_SAPI_MSG_TYPE_SEND_FDS,
 806 } __clib_packed app_sapi_msg_type_e;
 807
 808 typedef struct app_sapi_attach_msg_
 809 {
 810   u8 name[64];
 811   u64 options[18];
 812 } __clib_packed app_sapi_attach_msg_t;
 813
 814 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
 815                sizeof (((app_sapi_attach_msg_t *) 0)->options),
 816                "Out of options, fix message definition");
 817
 818 typedef struct app_sapi_attach_reply_msg_
 819 {
 820   i32 retval;
 821   u32 app_index;
 822   u64 app_mq;
 823   u64 vpp_ctrl_mq;
 824   u64 segment_handle;
 825   u32 api_client_handle;
 826   u8 vpp_ctrl_mq_thread;
 827   u8 n_fds;
 828   u8 fd_flags;
 829 } __clib_packed app_sapi_attach_reply_msg_t;
 830
 831 typedef struct app_sapi_worker_add_del_msg_
 832 {
 833   u32 app_index;
 834   u32 wrk_index;
 835   u8 is_add;
 836 } __clib_packed app_sapi_worker_add_del_msg_t;
 837
 838 typedef struct app_sapi_worker_add_del_reply_msg_
 839 {
 840   i32 retval;
 841   u32 wrk_index;
 842   u64 app_event_queue_address;
 843   u64 segment_handle;
 844   u32 api_client_handle;
 845   u8 n_fds;
 846   u8 fd_flags;
 847   u8 is_add;
 848 } __clib_packed app_sapi_worker_add_del_reply_msg_t;
 849
 850 typedef struct app_sapi_msg_
 851 {
 852   app_sapi_msg_type_e type;
 853   union
 854   {
 855     app_sapi_attach_msg_t attach;
 856     app_sapi_attach_reply_msg_t attach_reply;
 857     app_sapi_worker_add_del_msg_t worker_add_del;
 858     app_sapi_worker_add_del_reply_msg_t worker_add_del_reply;
 859   };
 860 } __clib_packed app_sapi_msg_t;
 861
 862 #endif /* __included_uri_h__ */
 863
 864 /*
 865  * fd.io coding-style-patch-verification: ON
 866  *
 867  * Local Variables:
 868  * eval: (c-set-style "gnu")
 869  * End:
 870  */