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