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   uword ext_config;
 412 } __clib_packed session_connect_msg_t;
 413
 414 STATIC_ASSERT (sizeof (session_connect_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
 415                "msg too large");
 416
 417 typedef struct session_connect_uri_msg_
 418 {
 419   u32 client_index;
 420   u32 context;
 421   u8 uri[56];
 422 } __clib_packed session_connect_uri_msg_t;
 423
 424 STATIC_ASSERT (sizeof (session_connect_uri_msg_t) <=
 425                SESSION_CTRL_MSG_MAX_SIZE, "msg too large");
 426
 427 typedef struct session_connected_msg_
 428 {
 429   u32 context;
 430   i32 retval;
 431   u64 handle;
 432   uword server_rx_fifo;
 433   uword server_tx_fifo;
 434   u64 segment_handle;
 435   uword ct_rx_fifo;
 436   uword ct_tx_fifo;
 437   u64 ct_segment_handle;
 438   uword vpp_event_queue_address;
 439   transport_endpoint_t lcl;
 440   u32 mq_index;
 441 } __clib_packed session_connected_msg_t;
 442
 443 typedef struct session_shutdown_msg_
 444 {
 445   u32 client_index;
 446   u32 context;
 447   session_handle_t handle;
 448 } __clib_packed session_shutdown_msg_t;
 449
 450 typedef struct session_disconnect_msg_
 451 {
 452   u32 client_index;
 453   u32 context;
 454   session_handle_t handle;
 455 } __clib_packed session_disconnect_msg_t;
 456
 457 typedef struct session_disconnected_msg_
 458 {
 459   u32 client_index;
 460   u32 context;
 461   u64 handle;
 462 } __clib_packed session_disconnected_msg_t;
 463
 464 typedef struct session_disconnected_reply_msg_
 465 {
 466   u32 context;
 467   i32 retval;
 468   u64 handle;
 469 } __clib_packed session_disconnected_reply_msg_t;
 470
 471 typedef struct session_reset_msg_
 472 {
 473   u32 client_index;
 474   u32 context;
 475   u64 handle;
 476 } __clib_packed session_reset_msg_t;
 477
 478 typedef struct session_reset_reply_msg_
 479 {
 480   u32 context;
 481   i32 retval;
 482   u64 handle;
 483 } __clib_packed session_reset_reply_msg_t;
 484
 485 typedef struct session_req_worker_update_msg_
 486 {
 487   u64 session_handle;
 488 } __clib_packed session_req_worker_update_msg_t;
 489
 490 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
 491 typedef struct session_worker_update_msg_
 492 {
 493   u32 client_index;
 494   u16 wrk_index;
 495   u16 req_wrk_index;
 496   u64 handle;
 497 } __clib_packed session_worker_update_msg_t;
 498
 499 typedef struct session_worker_update_reply_msg_
 500 {
 501   u64 handle;
 502   uword rx_fifo;
 503   uword tx_fifo;
 504   u64 segment_handle;
 505 } __clib_packed session_worker_update_reply_msg_t;
 506
 507 typedef struct session_app_detach_msg_
 508 {
 509   u32 client_index;
 510   u32 context;
 511 } session_app_detach_msg_t;
 512
 513 typedef struct app_map_another_segment_msg_
 514 {
 515   u32 client_index;
 516   u32 context;
 517   u8 fd_flags;
 518   u32 segment_size;
 519   u8 segment_name[128];
 520   u64 segment_handle;
 521 } session_app_add_segment_msg_t;
 522
 523 typedef struct app_unmap_segment_msg_
 524 {
 525   u32 client_index;
 526   u32 context;
 527   u64 segment_handle;
 528 } session_app_del_segment_msg_t;
 529
 530 typedef struct session_migrate_msg_
 531 {
 532   uword vpp_evt_q;
 533   session_handle_t handle;
 534   session_handle_t new_handle;
 535   u64 segment_handle;
 536   u32 vpp_thread_index;
 537 } __clib_packed session_migrated_msg_t;
 538
 539 typedef struct session_cleanup_msg_
 540 {
 541   session_handle_t handle;
 542   u8 type;
 543 } __clib_packed session_cleanup_msg_t;
 544
 545 typedef struct session_app_wrk_rpc_msg_
 546 {
 547   u32 client_index;     /**< app client index */
 548   u32 wrk_index;        /**< dst worker index */
 549   u8 data[64];          /**< rpc data */
 550 } __clib_packed session_app_wrk_rpc_msg_t;
 551
 552 typedef struct session_transport_attr_msg_
 553 {
 554   u32 client_index;
 555   session_handle_t handle;
 556   transport_endpt_attr_t attr;
 557   u8 is_get;
 558 } __clib_packed session_transport_attr_msg_t;
 559
 560 typedef struct session_transport_attr_reply_msg_
 561 {
 562   i32 retval;
 563   session_handle_t handle;
 564   transport_endpt_attr_t attr;
 565   u8 is_get;
 566 } __clib_packed session_transport_attr_reply_msg_t;
 567
 568 typedef struct app_session_event_
 569 {
 570   svm_msg_q_msg_t msg;
 571   session_event_t *evt;
 572 } __clib_packed app_session_evt_t;
 573
 574 static inline void
 575 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
 576                            u8 evt_type)
 577 {
 578   svm_msg_q_lock_and_alloc_msg_w_ring (mq,
 579                                        SESSION_MQ_CTRL_EVT_RING,
 580                                        SVM_Q_WAIT, &app_evt->msg);
 581   app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
 582   clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
 583   app_evt->evt->event_type = evt_type;
 584 }
 585
 586 static inline void
 587 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
 588 {
 589   svm_msg_q_add_and_unlock (mq, &app_evt->msg);
 590 }
 591
 592 /**
 593  * Send fifo io event to vpp worker thread
 594  *
 595  * Because there may be multiple writers to one of vpp's queues, this
 596  * protects message allocation and enqueueing.
 597  *
 598  * @param mq            vpp message queue
 599  * @param f             fifo for which the event is sent
 600  * @param evt_type      type of event
 601  * @param noblock       flag to indicate is request is blocking or not
 602  * @return              0 if success, negative integer otherwise
 603  */
 604 static inline int
 605 app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
 606                         u8 noblock)
 607 {
 608   session_event_t *evt;
 609   svm_msg_q_msg_t msg;
 610
 611   if (noblock)
 612     {
 613       if (svm_msg_q_try_lock (mq))
 614         return -1;
 615       if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
 616                          || svm_msg_q_is_full (mq)))
 617         {
 618           svm_msg_q_unlock (mq);
 619           return -2;
 620         }
 621       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
 622       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
 623       evt->session_index = session_index;
 624       evt->event_type = evt_type;
 625       svm_msg_q_add_and_unlock (mq, &msg);
 626       return 0;
 627     }
 628   else
 629     {
 630       svm_msg_q_lock (mq);
 631       while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
 632              || svm_msg_q_is_full (mq))
 633         svm_msg_q_wait_prod (mq);
 634       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
 635       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
 636       evt->session_index = session_index;
 637       evt->event_type = evt_type;
 638       svm_msg_q_add_and_unlock (mq, &msg);
 639       return 0;
 640     }
 641 }
 642
 643 always_inline int
 644 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
 645                     svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
 646                     u8 do_evt, u8 noblock)
 647 {
 648   session_dgram_hdr_t hdr;
 649   int rv;
 650
 651   if (svm_fifo_max_enqueue_prod (f) < (sizeof (session_dgram_hdr_t) + len))
 652     return 0;
 653
 654   hdr.data_length = len;
 655   hdr.data_offset = 0;
 656   clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
 657   hdr.is_ip4 = at->is_ip4;
 658   hdr.rmt_port = at->rmt_port;
 659   clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
 660   hdr.lcl_port = at->lcl_port;
 661
 662   /* *INDENT-OFF* */
 663   svm_fifo_seg_t segs[2] = {{ (u8 *) &hdr, sizeof (hdr) }, { data, len }};
 664   /* *INDENT-ON* */
 665
 666   rv = svm_fifo_enqueue_segments (f, segs, 2, 0 /* allow partial */ );
 667   if (PREDICT_FALSE (rv < 0))
 668     return 0;
 669
 670   if (do_evt)
 671     {
 672       if (svm_fifo_set_event (f))
 673         app_send_io_evt_to_vpp (vpp_evt_q, f->shr->master_session_index,
 674                                 evt_type, noblock);
 675     }
 676   return len;
 677 }
 678
 679 always_inline int
 680 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
 681 {
 682   return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
 683                              len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
 684                              noblock);
 685 }
 686
 687 always_inline int
 688 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
 689                      u32 len, u8 evt_type, u8 do_evt, u8 noblock)
 690 {
 691   int rv;
 692
 693   rv = svm_fifo_enqueue (f, len, data);
 694   if (do_evt)
 695     {
 696       if (rv > 0 && svm_fifo_set_event (f))
 697         app_send_io_evt_to_vpp (vpp_evt_q, f->shr->master_session_index,
 698                                 evt_type, noblock);
 699     }
 700   return rv;
 701 }
 702
 703 always_inline int
 704 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
 705 {
 706   return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
 707                               SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
 708 }
 709
 710 always_inline int
 711 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
 712 {
 713   if (s->is_dgram)
 714     return app_send_dgram (s, data, len, noblock);
 715   return app_send_stream (s, data, len, noblock);
 716 }
 717
 718 always_inline int
 719 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
 720                     app_session_transport_t * at, u8 clear_evt, u8 peek)
 721 {
 722   session_dgram_pre_hdr_t ph;
 723   u32 max_deq;
 724   int rv;
 725
 726   max_deq = svm_fifo_max_dequeue_cons (f);
 727   if (max_deq <= sizeof (session_dgram_hdr_t))
 728     {
 729       if (clear_evt)
 730         svm_fifo_unset_event (f);
 731       return 0;
 732     }
 733
 734   if (clear_evt)
 735     svm_fifo_unset_event (f);
 736
 737   svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
 738   ASSERT (ph.data_length >= ph.data_offset);
 739
 740   /* Check if we have the full dgram */
 741   if (max_deq < (ph.data_length + SESSION_CONN_HDR_LEN)
 742       && len >= ph.data_length)
 743     return 0;
 744
 745   svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
 746   len = clib_min (len, ph.data_length - ph.data_offset);
 747   rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
 748   if (peek)
 749     return rv;
 750
 751   /* Discards data that did not fit in buffer */
 752   svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
 753
 754   return rv;
 755 }
 756
 757 always_inline int
 758 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
 759 {
 760   return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
 761 }
 762
 763 always_inline int
 764 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
 765 {
 766   if (clear_evt)
 767     svm_fifo_unset_event (f);
 768
 769   if (peek)
 770     return svm_fifo_peek (f, 0, len, buf);
 771
 772   return svm_fifo_dequeue (f, len, buf);
 773 }
 774
 775 always_inline int
 776 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
 777 {
 778   return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
 779 }
 780
 781 always_inline int
 782 app_recv (app_session_t * s, u8 * data, u32 len)
 783 {
 784   if (s->is_dgram)
 785     return app_recv_dgram (s, data, len);
 786   return app_recv_stream (s, data, len);
 787 }
 788
 789 /* *INDENT-OFF* */
 790 static char *session_error_str[] = {
 791 #define _(sym, str) str,
 792     foreach_session_error
 793 #undef _
 794 };
 795 /* *INDENT-ON* */
 796
 797 static inline u8 *
 798 format_session_error (u8 * s, va_list * args)
 799 {
 800   session_error_t error = va_arg (*args, session_error_t);
 801   if (-error >= 0 && -error < SESSION_N_ERRORS)
 802     s = format (s, "%s", session_error_str[-error]);
 803   else
 804     s = format (s, "invalid session err %u", -error);
 805   return s;
 806 }
 807
 808 /*
 809  * Socket API messages
 810  */
 811
 812 typedef enum app_sapi_msg_type
 813 {
 814   APP_SAPI_MSG_TYPE_NONE,
 815   APP_SAPI_MSG_TYPE_ATTACH,
 816   APP_SAPI_MSG_TYPE_ATTACH_REPLY,
 817   APP_SAPI_MSG_TYPE_ADD_DEL_WORKER,
 818   APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY,
 819   APP_SAPI_MSG_TYPE_SEND_FDS,
 820   APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY,
 821   APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY_REPLY,
 822 } __clib_packed app_sapi_msg_type_e;
 823
 824 typedef struct app_sapi_attach_msg_
 825 {
 826   u8 name[64];
 827   u64 options[18];
 828 } __clib_packed app_sapi_attach_msg_t;
 829
 830 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
 831                sizeof (((app_sapi_attach_msg_t *) 0)->options),
 832                "Out of options, fix message definition");
 833
 834 typedef struct app_sapi_attach_reply_msg_
 835 {
 836   i32 retval;
 837   u32 app_index;
 838   u64 app_mq;
 839   u64 vpp_ctrl_mq;
 840   u64 segment_handle;
 841   u32 api_client_handle;
 842   u8 vpp_ctrl_mq_thread;
 843   u8 n_fds;
 844   u8 fd_flags;
 845 } __clib_packed app_sapi_attach_reply_msg_t;
 846
 847 typedef struct app_sapi_worker_add_del_msg_
 848 {
 849   u32 app_index;
 850   u32 wrk_index;
 851   u8 is_add;
 852 } __clib_packed app_sapi_worker_add_del_msg_t;
 853
 854 typedef struct app_sapi_worker_add_del_reply_msg_
 855 {
 856   i32 retval;
 857   u32 wrk_index;
 858   u64 app_event_queue_address;
 859   u64 segment_handle;
 860   u32 api_client_handle;
 861   u8 n_fds;
 862   u8 fd_flags;
 863   u8 is_add;
 864 } __clib_packed app_sapi_worker_add_del_reply_msg_t;
 865
 866 typedef struct app_sapi_cert_key_add_del_msg_
 867 {
 868   u32 context;
 869   u32 index;
 870   u16 cert_len;
 871   u16 certkey_len;
 872   u8 is_add;
 873 } __clib_packed app_sapi_cert_key_add_del_msg_t;
 874
 875 typedef struct app_sapi_cert_key_add_del_reply_msg_
 876 {
 877   u32 context;
 878   i32 retval;
 879   u32 index;
 880 } __clib_packed app_sapi_cert_key_add_del_reply_msg_t;
 881
 882 typedef struct app_sapi_msg_
 883 {
 884   app_sapi_msg_type_e type;
 885   union
 886   {
 887     app_sapi_attach_msg_t attach;
 888     app_sapi_attach_reply_msg_t attach_reply;
 889     app_sapi_worker_add_del_msg_t worker_add_del;
 890     app_sapi_worker_add_del_reply_msg_t worker_add_del_reply;
 891     app_sapi_cert_key_add_del_msg_t cert_key_add_del;
 892     app_sapi_cert_key_add_del_reply_msg_t cert_key_add_del_reply;
 893   };
 894 } __clib_packed app_sapi_msg_t;
 895
 896 static inline void
 897 session_endpoint_alloc_ext_cfg (session_endpoint_cfg_t *sep_ext,
 898                                 transport_endpt_ext_cfg_type_t type)
 899 {
 900   transport_endpt_ext_cfg_t *cfg;
 901   u32 cfg_size;
 902
 903   cfg_size = sizeof (transport_endpt_ext_cfg_t);
 904   cfg = clib_mem_alloc (cfg_size);
 905   clib_memset (cfg, 0, cfg_size);
 906   cfg->type = type;
 907   sep_ext->ext_cfg = cfg;
 908 }
 909
 910 #endif /* __included_uri_h__ */
 911
 912 /*
 913  * fd.io coding-style-patch-verification: ON
 914  *
 915  * Local Variables:
 916  * eval: (c-set-style "gnu")
 917  * End:
 918  */