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