src/vnet/session/application_interface.h

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