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
 237 typedef enum _app_options
 238 {
 239 #define _(sym, str) APP_OPTIONS_##sym,
 240   foreach_app_options_flags
 241 #undef _
 242 } app_options_t;
 243
 244 typedef enum _app_options_flags
 245 {
 246 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
 247   foreach_app_options_flags
 248 #undef _
 249 } app_options_flags_t;
 250
 251 #define foreach_fd_type                                         \
 252   _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment")            \
 253   _(MEMFD_SEGMENT, "Fd for memfd segment")                      \
 254   _(MQ_EVENTFD, "Event fd used by message queue")               \
 255   _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue")     \
 256
 257 typedef enum session_fd_type_
 258 {
 259 #define _(sym, str) SESSION_FD_##sym,
 260   foreach_fd_type
 261 #undef _
 262   SESSION_N_FD_TYPE
 263 } session_fd_type_t;
 264
 265 typedef enum session_fd_flag_
 266 {
 267 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
 268   foreach_fd_type
 269 #undef _
 270 } session_fd_flag_t;
 271
 272 int parse_uri (char *uri, session_endpoint_cfg_t * sep);
 273 int vnet_bind_uri (vnet_listen_args_t *);
 274 int vnet_unbind_uri (vnet_unlisten_args_t * a);
 275 int vnet_connect_uri (vnet_connect_args_t * a);
 276
 277 int vnet_application_attach (vnet_app_attach_args_t * a);
 278 int vnet_application_detach (vnet_app_detach_args_t * a);
 279 int vnet_listen (vnet_listen_args_t * a);
 280 int vnet_connect (vnet_connect_args_t * a);
 281 int vnet_unlisten (vnet_unlisten_args_t * a);
 282 int vnet_shutdown_session (vnet_shutdown_args_t *a);
 283 int vnet_disconnect_session (vnet_disconnect_args_t * a);
 284
 285 int vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a);
 286 int vnet_app_del_cert_key_pair (u32 index);
 287 /** Ask for app cb on pair deletion */
 288 int vnet_app_add_cert_key_interest (u32 index, u32 app_index);
 289
 290 typedef struct app_session_transport_
 291 {
 292   ip46_address_t rmt_ip;        /**< remote ip */
 293   ip46_address_t lcl_ip;        /**< local ip */
 294   u16 rmt_port;                 /**< remote port (network order) */
 295   u16 lcl_port;                 /**< local port (network order) */
 296   u8 is_ip4;                    /**< set if uses ip4 networking */
 297 } app_session_transport_t;
 298
 299 #define foreach_app_session_field                                       \
 300   _(svm_fifo_t, *rx_fifo)               /**< rx fifo */                 \
 301   _(svm_fifo_t, *tx_fifo)               /**< tx fifo */                 \
 302   _(session_type_t, session_type)       /**< session type */            \
 303   _(volatile u8, session_state)         /**< session state */           \
 304   _(u32, session_index)                 /**< index in owning pool */    \
 305   _(app_session_transport_t, transport) /**< transport info */          \
 306   _(svm_msg_q_t, *vpp_evt_q)            /**< vpp event queue  */        \
 307   _(u8, is_dgram)                       /**< flag for dgram mode */     \
 308
 309 typedef struct
 310 {
 311 #define _(type, name) type name;
 312   foreach_app_session_field
 313 #undef _
 314 } app_session_t;
 315
 316 typedef struct session_listen_msg_
 317 {
 318   u32 client_index;
 319   u32 context;                  /* Not needed but keeping it for compatibility with bapi */
 320   u32 wrk_index;
 321   u32 vrf;
 322   u16 port;
 323   u8 proto;
 324   u8 is_ip4;
 325   ip46_address_t ip;
 326   u8 flags;
 327   uword ext_config;
 328 } __clib_packed session_listen_msg_t;
 329
 330 STATIC_ASSERT (sizeof (session_listen_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
 331                "msg too large");
 332
 333 typedef struct session_listen_uri_msg_
 334 {
 335   u32 client_index;
 336   u32 context;
 337   u8 uri[56];
 338 } __clib_packed session_listen_uri_msg_t;
 339
 340 STATIC_ASSERT (sizeof (session_listen_uri_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
 341                "msg too large");
 342
 343 typedef struct session_bound_msg_
 344 {
 345   u32 context;
 346   u64 handle;
 347   i32 retval;
 348   u8 lcl_is_ip4;
 349   u8 lcl_ip[16];
 350   u16 lcl_port;
 351   uword rx_fifo;
 352   uword tx_fifo;
 353   uword vpp_evt_q;
 354   u64 segment_handle;
 355   u32 mq_index;
 356 } __clib_packed session_bound_msg_t;
 357
 358 typedef struct session_unlisten_msg_
 359 {
 360   u32 client_index;
 361   u32 context;
 362   u32 wrk_index;
 363   session_handle_t handle;
 364 } __clib_packed session_unlisten_msg_t;
 365
 366 typedef struct session_unlisten_reply_msg_
 367 {
 368   u32 context;
 369   u64 handle;
 370   i32 retval;
 371 } __clib_packed session_unlisten_reply_msg_t;
 372
 373 typedef struct session_accepted_msg_
 374 {
 375   u32 context;
 376   u64 listener_handle;
 377   u64 handle;
 378   uword server_rx_fifo;
 379   uword server_tx_fifo;
 380   u64 segment_handle;
 381   uword vpp_event_queue_address;
 382   u32 mq_index;
 383   transport_endpoint_t lcl;
 384   transport_endpoint_t rmt;
 385   u8 flags;
 386 } __clib_packed session_accepted_msg_t;
 387
 388 typedef struct session_accepted_reply_msg_
 389 {
 390   u32 context;
 391   i32 retval;
 392   u64 handle;
 393 } __clib_packed session_accepted_reply_msg_t;
 394
 395 typedef struct session_connect_msg_
 396 {
 397   u32 client_index;
 398   u32 context;
 399   u32 wrk_index;
 400   u32 vrf;
 401   u16 port;
 402   u16 lcl_port;
 403   u8 proto;
 404   u8 is_ip4;
 405   ip46_address_t ip;
 406   ip46_address_t lcl_ip;
 407   u64 parent_handle;
 408   u32 ckpair_index;
 409   u8 crypto_engine;
 410   u8 flags;
 411   u8 dscp;
 412   uword ext_config;
 413 } __clib_packed session_connect_msg_t;
 414
 415 STATIC_ASSERT (sizeof (session_connect_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
 416                "msg too large");
 417
 418 typedef struct session_connect_uri_msg_
 419 {
 420   u32 client_index;
 421   u32 context;
 422   u8 uri[56];
 423 } __clib_packed session_connect_uri_msg_t;
 424
 425 STATIC_ASSERT (sizeof (session_connect_uri_msg_t) <=
 426                SESSION_CTRL_MSG_MAX_SIZE, "msg too large");
 427
 428 typedef struct session_connected_msg_
 429 {
 430   u32 context;
 431   i32 retval;
 432   u64 handle;
 433   uword server_rx_fifo;
 434   uword server_tx_fifo;
 435   u64 segment_handle;
 436   uword ct_rx_fifo;
 437   uword ct_tx_fifo;
 438   u64 ct_segment_handle;
 439   uword vpp_event_queue_address;
 440   transport_endpoint_t lcl;
 441   u32 mq_index;
 442 } __clib_packed session_connected_msg_t;
 443
 444 typedef struct session_shutdown_msg_
 445 {
 446   u32 client_index;
 447   u32 context;
 448   session_handle_t handle;
 449 } __clib_packed session_shutdown_msg_t;
 450
 451 typedef struct session_disconnect_msg_
 452 {
 453   u32 client_index;
 454   u32 context;
 455   session_handle_t handle;
 456 } __clib_packed session_disconnect_msg_t;
 457
 458 typedef struct session_disconnected_msg_
 459 {
 460   u32 client_index;
 461   u32 context;
 462   u64 handle;
 463 } __clib_packed session_disconnected_msg_t;
 464
 465 typedef struct session_disconnected_reply_msg_
 466 {
 467   u32 context;
 468   i32 retval;
 469   u64 handle;
 470 } __clib_packed session_disconnected_reply_msg_t;
 471
 472 typedef struct session_reset_msg_
 473 {
 474   u32 client_index;
 475   u32 context;
 476   u64 handle;
 477 } __clib_packed session_reset_msg_t;
 478
 479 typedef struct session_reset_reply_msg_
 480 {
 481   u32 context;
 482   i32 retval;
 483   u64 handle;
 484 } __clib_packed session_reset_reply_msg_t;
 485
 486 typedef struct session_req_worker_update_msg_
 487 {
 488   u64 session_handle;
 489 } __clib_packed session_req_worker_update_msg_t;
 490
 491 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
 492 typedef struct session_worker_update_msg_
 493 {
 494   u32 client_index;
 495   u16 wrk_index;
 496   u16 req_wrk_index;
 497   u64 handle;
 498 } __clib_packed session_worker_update_msg_t;
 499
 500 typedef struct session_worker_update_reply_msg_
 501 {
 502   u64 handle;
 503   uword rx_fifo;
 504   uword tx_fifo;
 505   u64 segment_handle;
 506 } __clib_packed session_worker_update_reply_msg_t;
 507
 508 typedef struct session_app_detach_msg_
 509 {
 510   u32 client_index;
 511   u32 context;
 512 } session_app_detach_msg_t;
 513
 514 typedef struct app_map_another_segment_msg_
 515 {
 516   u32 client_index;
 517   u32 context;
 518   u8 fd_flags;
 519   u32 segment_size;
 520   u8 segment_name[128];
 521   u64 segment_handle;
 522 } session_app_add_segment_msg_t;
 523
 524 typedef struct app_unmap_segment_msg_
 525 {
 526   u32 client_index;
 527   u32 context;
 528   u64 segment_handle;
 529 } session_app_del_segment_msg_t;
 530
 531 typedef struct session_migrate_msg_
 532 {
 533   uword vpp_evt_q;
 534   session_handle_t handle;
 535   session_handle_t new_handle;
 536   u64 segment_handle;
 537   u32 vpp_thread_index;
 538 } __clib_packed session_migrated_msg_t;
 539
 540 typedef struct session_cleanup_msg_
 541 {
 542   session_handle_t handle;
 543   u8 type;
 544 } __clib_packed session_cleanup_msg_t;
 545
 546 typedef struct session_app_wrk_rpc_msg_
 547 {
 548   u32 client_index;     /**< app client index */
 549   u32 wrk_index;        /**< dst worker index */
 550   u8 data[64];          /**< rpc data */
 551 } __clib_packed session_app_wrk_rpc_msg_t;
 552
 553 typedef struct session_transport_attr_msg_
 554 {
 555   u32 client_index;
 556   session_handle_t handle;
 557   transport_endpt_attr_t attr;
 558   u8 is_get;
 559 } __clib_packed session_transport_attr_msg_t;
 560
 561 typedef struct session_transport_attr_reply_msg_
 562 {
 563   i32 retval;
 564   session_handle_t handle;
 565   transport_endpt_attr_t attr;
 566   u8 is_get;
 567 } __clib_packed session_transport_attr_reply_msg_t;
 568
 569 typedef struct app_session_event_
 570 {
 571   svm_msg_q_msg_t msg;
 572   session_event_t *evt;
 573 } __clib_packed app_session_evt_t;
 574
 575 static inline void
 576 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
 577                            u8 evt_type)
 578 {
 579   svm_msg_q_lock_and_alloc_msg_w_ring (mq,
 580                                        SESSION_MQ_CTRL_EVT_RING,
 581                                        SVM_Q_WAIT, &app_evt->msg);
 582   app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
 583   clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
 584   app_evt->evt->event_type = evt_type;
 585 }
 586
 587 static inline void
 588 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
 589 {
 590   svm_msg_q_add_and_unlock (mq, &app_evt->msg);
 591 }
 592
 593 /**
 594  * Send fifo io event to vpp worker thread
 595  *
 596  * Because there may be multiple writers to one of vpp's queues, this
 597  * protects message allocation and enqueueing.
 598  *
 599  * @param mq            vpp message queue
 600  * @param f             fifo for which the event is sent
 601  * @param evt_type      type of event
 602  * @param noblock       flag to indicate is request is blocking or not
 603  * @return              0 if success, negative integer otherwise
 604  */
 605 static inline int
 606 app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
 607                         u8 noblock)
 608 {
 609   session_event_t *evt;
 610   svm_msg_q_msg_t msg;
 611
 612   if (noblock)
 613     {
 614       if (svm_msg_q_try_lock (mq))
 615         return -1;
 616       if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
 617                          || svm_msg_q_is_full (mq)))
 618         {
 619           svm_msg_q_unlock (mq);
 620           return -2;
 621         }
 622       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
 623       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
 624       evt->session_index = session_index;
 625       evt->event_type = evt_type;
 626       svm_msg_q_add_and_unlock (mq, &msg);
 627       return 0;
 628     }
 629   else
 630     {
 631       svm_msg_q_lock (mq);
 632       while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
 633              || svm_msg_q_is_full (mq))
 634         svm_msg_q_wait_prod (mq);
 635       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
 636       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
 637       evt->session_index = session_index;
 638       evt->event_type = evt_type;
 639       svm_msg_q_add_and_unlock (mq, &msg);
 640       return 0;
 641     }
 642 }
 643
 644 always_inline int
 645 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
 646                     svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
 647                     u8 do_evt, u8 noblock)
 648 {
 649   session_dgram_hdr_t hdr;
 650   int rv;
 651
 652   if (svm_fifo_max_enqueue_prod (f) < (sizeof (session_dgram_hdr_t) + len))
 653     return 0;
 654
 655   hdr.data_length = len;
 656   hdr.data_offset = 0;
 657   clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
 658   hdr.is_ip4 = at->is_ip4;
 659   hdr.rmt_port = at->rmt_port;
 660   clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
 661   hdr.lcl_port = at->lcl_port;
 662
 663   /* *INDENT-OFF* */
 664   svm_fifo_seg_t segs[2] = {{ (u8 *) &hdr, sizeof (hdr) }, { data, len }};
 665   /* *INDENT-ON* */
 666
 667   rv = svm_fifo_enqueue_segments (f, segs, 2, 0 /* allow partial */ );
 668   if (PREDICT_FALSE (rv < 0))
 669     return 0;
 670
 671   if (do_evt)
 672     {
 673       if (svm_fifo_set_event (f))
 674         app_send_io_evt_to_vpp (vpp_evt_q, f->shr->master_session_index,
 675                                 evt_type, noblock);
 676     }
 677   return len;
 678 }
 679
 680 always_inline int
 681 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
 682 {
 683   return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
 684                              len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
 685                              noblock);
 686 }
 687
 688 always_inline int
 689 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
 690                      u32 len, u8 evt_type, u8 do_evt, u8 noblock)
 691 {
 692   int rv;
 693
 694   rv = svm_fifo_enqueue (f, len, data);
 695   if (do_evt)
 696     {
 697       if (rv > 0 && svm_fifo_set_event (f))
 698         app_send_io_evt_to_vpp (vpp_evt_q, f->shr->master_session_index,
 699                                 evt_type, noblock);
 700     }
 701   return rv;
 702 }
 703
 704 always_inline int
 705 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
 706 {
 707   return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
 708                               SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
 709 }
 710
 711 always_inline int
 712 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
 713 {
 714   if (s->is_dgram)
 715     return app_send_dgram (s, data, len, noblock);
 716   return app_send_stream (s, data, len, noblock);
 717 }
 718
 719 always_inline int
 720 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
 721                     app_session_transport_t * at, u8 clear_evt, u8 peek)
 722 {
 723   session_dgram_pre_hdr_t ph;
 724   u32 max_deq;
 725   int rv;
 726
 727   max_deq = svm_fifo_max_dequeue_cons (f);
 728   if (max_deq <= sizeof (session_dgram_hdr_t))
 729     {
 730       if (clear_evt)
 731         svm_fifo_unset_event (f);
 732       return 0;
 733     }
 734
 735   if (clear_evt)
 736     svm_fifo_unset_event (f);
 737
 738   svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
 739   ASSERT (ph.data_length >= ph.data_offset);
 740
 741   /* Check if we have the full dgram */
 742   if (max_deq < (ph.data_length + SESSION_CONN_HDR_LEN)
 743       && len >= ph.data_length)
 744     return 0;
 745
 746   svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
 747   len = clib_min (len, ph.data_length - ph.data_offset);
 748   rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
 749   if (peek)
 750     return rv;
 751
 752   /* Discards data that did not fit in buffer */
 753   svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
 754
 755   return rv;
 756 }
 757
 758 always_inline int
 759 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
 760 {
 761   return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
 762 }
 763
 764 always_inline int
 765 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
 766 {
 767   if (clear_evt)
 768     svm_fifo_unset_event (f);
 769
 770   if (peek)
 771     return svm_fifo_peek (f, 0, len, buf);
 772
 773   return svm_fifo_dequeue (f, len, buf);
 774 }
 775
 776 always_inline int
 777 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
 778 {
 779   return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
 780 }
 781
 782 always_inline int
 783 app_recv (app_session_t * s, u8 * data, u32 len)
 784 {
 785   if (s->is_dgram)
 786     return app_recv_dgram (s, data, len);
 787   return app_recv_stream (s, data, len);
 788 }
 789
 790 /* *INDENT-OFF* */
 791 static char *session_error_str[] = {
 792 #define _(sym, str) str,
 793     foreach_session_error
 794 #undef _
 795 };
 796 /* *INDENT-ON* */
 797
 798 static inline u8 *
 799 format_session_error (u8 * s, va_list * args)
 800 {
 801   session_error_t error = va_arg (*args, session_error_t);
 802   if (-error >= 0 && -error < SESSION_N_ERRORS)
 803     s = format (s, "%s", session_error_str[-error]);
 804   else
 805     s = format (s, "invalid session err %u", -error);
 806   return s;
 807 }
 808
 809 /*
 810  * Socket API messages
 811  */
 812
 813 typedef enum app_sapi_msg_type
 814 {
 815   APP_SAPI_MSG_TYPE_NONE,
 816   APP_SAPI_MSG_TYPE_ATTACH,
 817   APP_SAPI_MSG_TYPE_ATTACH_REPLY,
 818   APP_SAPI_MSG_TYPE_ADD_DEL_WORKER,
 819   APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY,
 820   APP_SAPI_MSG_TYPE_SEND_FDS,
 821   APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY,
 822   APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY_REPLY,
 823 } __clib_packed app_sapi_msg_type_e;
 824
 825 typedef struct app_sapi_attach_msg_
 826 {
 827   u8 name[64];
 828   u64 options[18];
 829 } __clib_packed app_sapi_attach_msg_t;
 830
 831 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
 832                sizeof (((app_sapi_attach_msg_t *) 0)->options),
 833                "Out of options, fix message definition");
 834
 835 typedef struct app_sapi_attach_reply_msg_
 836 {
 837   i32 retval;
 838   u32 app_index;
 839   u64 app_mq;
 840   u64 vpp_ctrl_mq;
 841   u64 segment_handle;
 842   u32 api_client_handle;
 843   u8 vpp_ctrl_mq_thread;
 844   u8 n_fds;
 845   u8 fd_flags;
 846 } __clib_packed app_sapi_attach_reply_msg_t;
 847
 848 typedef struct app_sapi_worker_add_del_msg_
 849 {
 850   u32 app_index;
 851   u32 wrk_index;
 852   u8 is_add;
 853 } __clib_packed app_sapi_worker_add_del_msg_t;
 854
 855 typedef struct app_sapi_worker_add_del_reply_msg_
 856 {
 857   i32 retval;
 858   u32 wrk_index;
 859   u64 app_event_queue_address;
 860   u64 segment_handle;
 861   u32 api_client_handle;
 862   u8 n_fds;
 863   u8 fd_flags;
 864   u8 is_add;
 865 } __clib_packed app_sapi_worker_add_del_reply_msg_t;
 866
 867 typedef struct app_sapi_cert_key_add_del_msg_
 868 {
 869   u32 context;
 870   u32 index;
 871   u16 cert_len;
 872   u16 certkey_len;
 873   u8 is_add;
 874 } __clib_packed app_sapi_cert_key_add_del_msg_t;
 875
 876 typedef struct app_sapi_cert_key_add_del_reply_msg_
 877 {
 878   u32 context;
 879   i32 retval;
 880   u32 index;
 881 } __clib_packed app_sapi_cert_key_add_del_reply_msg_t;
 882
 883 typedef struct app_sapi_msg_
 884 {
 885   app_sapi_msg_type_e type;
 886   union
 887   {
 888     app_sapi_attach_msg_t attach;
 889     app_sapi_attach_reply_msg_t attach_reply;
 890     app_sapi_worker_add_del_msg_t worker_add_del;
 891     app_sapi_worker_add_del_reply_msg_t worker_add_del_reply;
 892     app_sapi_cert_key_add_del_msg_t cert_key_add_del;
 893     app_sapi_cert_key_add_del_reply_msg_t cert_key_add_del_reply;
 894   };
 895 } __clib_packed app_sapi_msg_t;
 896
 897 static inline void
 898 session_endpoint_alloc_ext_cfg (session_endpoint_cfg_t *sep_ext,
 899                                 transport_endpt_ext_cfg_type_t type)
 900 {
 901   transport_endpt_ext_cfg_t *cfg;
 902   u32 cfg_size;
 903
 904   cfg_size = sizeof (transport_endpt_ext_cfg_t);
 905   cfg = clib_mem_alloc (cfg_size);
 906   clib_memset (cfg, 0, cfg_size);
 907   cfg->type = type;
 908   sep_ext->ext_cfg = cfg;
 909 }
 910
 911 #endif /* __included_uri_h__ */
 912
 913 /*
 914  * fd.io coding-style-patch-verification: ON
 915  *
 916  * Local Variables:
 917  * eval: (c-set-style "gnu")
 918  * End:
 919  */