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