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