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