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 } __clib_packed session_listen_msg_t;
 319
 320 STATIC_ASSERT (sizeof (session_listen_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
 321                "msg too large");
 322
 323 typedef struct session_listen_uri_msg_
 324 {
 325   u32 client_index;
 326   u32 context;
 327   u8 uri[56];
 328 } __clib_packed session_listen_uri_msg_t;
 329
 330 STATIC_ASSERT (sizeof (session_listen_uri_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
 331                "msg too large");
 332
 333 typedef struct session_bound_msg_
 334 {
 335   u32 context;
 336   u64 handle;
 337   i32 retval;
 338   u8 lcl_is_ip4;
 339   u8 lcl_ip[16];
 340   u16 lcl_port;
 341   uword rx_fifo;
 342   uword tx_fifo;
 343   uword vpp_evt_q;
 344   u32 segment_size;
 345   u8 segment_name_length;
 346   u8 segment_name[128];
 347 } __clib_packed session_bound_msg_t;
 348
 349 typedef struct session_unlisten_msg_
 350 {
 351   u32 client_index;
 352   u32 context;
 353   u32 wrk_index;
 354   session_handle_t handle;
 355 } __clib_packed session_unlisten_msg_t;
 356
 357 typedef struct session_unlisten_reply_msg_
 358 {
 359   u32 context;
 360   u64 handle;
 361   i32 retval;
 362 } __clib_packed session_unlisten_reply_msg_t;
 363
 364 typedef struct session_accepted_msg_
 365 {
 366   u32 context;
 367   u64 listener_handle;
 368   u64 handle;
 369   uword server_rx_fifo;
 370   uword server_tx_fifo;
 371   u64 segment_handle;
 372   uword vpp_event_queue_address;
 373   transport_endpoint_t rmt;
 374   u8 flags;
 375 } __clib_packed session_accepted_msg_t;
 376
 377 typedef struct session_accepted_reply_msg_
 378 {
 379   u32 context;
 380   i32 retval;
 381   u64 handle;
 382 } __clib_packed session_accepted_reply_msg_t;
 383
 384 typedef struct session_connect_msg_
 385 {
 386   u32 client_index;
 387   u32 context;
 388   u32 wrk_index;
 389   u32 vrf;
 390   u16 port;
 391   u16 lcl_port;
 392   u8 proto;
 393   u8 is_ip4;
 394   ip46_address_t ip;
 395   ip46_address_t lcl_ip;
 396   u8 hostname_len;
 397   u8 hostname[16];
 398   u64 parent_handle;
 399   u32 ckpair_index;
 400   u8 crypto_engine;
 401   u8 flags;
 402 } __clib_packed session_connect_msg_t;
 403
 404 STATIC_ASSERT (sizeof (session_connect_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
 405                "msg too large");
 406
 407 typedef struct session_connect_uri_msg_
 408 {
 409   u32 client_index;
 410   u32 context;
 411   u8 uri[56];
 412 } __clib_packed session_connect_uri_msg_t;
 413
 414 STATIC_ASSERT (sizeof (session_connect_uri_msg_t) <=
 415                SESSION_CTRL_MSG_MAX_SIZE, "msg too large");
 416
 417 typedef struct session_connected_msg_
 418 {
 419   u32 context;
 420   i32 retval;
 421   u64 handle;
 422   uword server_rx_fifo;
 423   uword server_tx_fifo;
 424   u64 segment_handle;
 425   uword ct_rx_fifo;
 426   uword ct_tx_fifo;
 427   u64 ct_segment_handle;
 428   uword vpp_event_queue_address;
 429   u32 segment_size;
 430   u8 segment_name_length;
 431   u8 segment_name[64];
 432   transport_endpoint_t lcl;
 433 } __clib_packed session_connected_msg_t;
 434
 435 typedef struct session_disconnect_msg_
 436 {
 437   u32 client_index;
 438   u32 context;
 439   session_handle_t handle;
 440 } __clib_packed session_disconnect_msg_t;
 441
 442 typedef struct session_disconnected_msg_
 443 {
 444   u32 client_index;
 445   u32 context;
 446   u64 handle;
 447 } __clib_packed session_disconnected_msg_t;
 448
 449 typedef struct session_disconnected_reply_msg_
 450 {
 451   u32 context;
 452   i32 retval;
 453   u64 handle;
 454 } __clib_packed session_disconnected_reply_msg_t;
 455
 456 typedef struct session_reset_msg_
 457 {
 458   u32 client_index;
 459   u32 context;
 460   u64 handle;
 461 } __clib_packed session_reset_msg_t;
 462
 463 typedef struct session_reset_reply_msg_
 464 {
 465   u32 context;
 466   i32 retval;
 467   u64 handle;
 468 } __clib_packed session_reset_reply_msg_t;
 469
 470 typedef struct session_req_worker_update_msg_
 471 {
 472   u64 session_handle;
 473 } __clib_packed session_req_worker_update_msg_t;
 474
 475 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
 476 typedef struct session_worker_update_msg_
 477 {
 478   u32 client_index;
 479   u16 wrk_index;
 480   u16 req_wrk_index;
 481   u64 handle;
 482 } __clib_packed session_worker_update_msg_t;
 483
 484 typedef struct session_worker_update_reply_msg_
 485 {
 486   u64 handle;
 487   uword rx_fifo;
 488   uword tx_fifo;
 489   u64 segment_handle;
 490 } __clib_packed session_worker_update_reply_msg_t;
 491
 492 typedef struct session_app_detach_msg_
 493 {
 494   u32 client_index;
 495   u32 context;
 496 } session_app_detach_msg_t;
 497
 498 typedef struct app_map_another_segment_msg_
 499 {
 500   u32 client_index;
 501   u32 context;
 502   u8 fd_flags;
 503   u32 segment_size;
 504   u8 segment_name[128];
 505   u64 segment_handle;
 506 } session_app_add_segment_msg_t;
 507
 508 typedef struct app_unmap_segment_msg_
 509 {
 510   u32 client_index;
 511   u32 context;
 512   u64 segment_handle;
 513 } session_app_del_segment_msg_t;
 514
 515 typedef struct session_migrate_msg_
 516 {
 517   uword vpp_evt_q;
 518   session_handle_t handle;
 519   session_handle_t new_handle;
 520   u32 vpp_thread_index;
 521 } __clib_packed session_migrated_msg_t;
 522
 523 typedef struct session_cleanup_msg_
 524 {
 525   session_handle_t handle;
 526   u8 type;
 527 } __clib_packed session_cleanup_msg_t;
 528
 529 typedef struct app_session_event_
 530 {
 531   svm_msg_q_msg_t msg;
 532   session_event_t *evt;
 533 } __clib_packed app_session_evt_t;
 534
 535 static inline void
 536 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
 537                            u8 evt_type)
 538 {
 539   svm_msg_q_lock_and_alloc_msg_w_ring (mq,
 540                                        SESSION_MQ_CTRL_EVT_RING,
 541                                        SVM_Q_WAIT, &app_evt->msg);
 542   app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
 543   clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
 544   app_evt->evt->event_type = evt_type;
 545 }
 546
 547 static inline void
 548 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
 549 {
 550   svm_msg_q_add_and_unlock (mq, &app_evt->msg);
 551 }
 552
 553 /**
 554  * Send fifo io event to vpp worker thread
 555  *
 556  * Because there may be multiple writers to one of vpp's queues, this
 557  * protects message allocation and enqueueing.
 558  *
 559  * @param mq            vpp message queue
 560  * @param f             fifo for which the event is sent
 561  * @param evt_type      type of event
 562  * @param noblock       flag to indicate is request is blocking or not
 563  * @return              0 if success, negative integer otherwise
 564  */
 565 static inline int
 566 app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
 567                         u8 noblock)
 568 {
 569   session_event_t *evt;
 570   svm_msg_q_msg_t msg;
 571
 572   if (noblock)
 573     {
 574       if (svm_msg_q_try_lock (mq))
 575         return -1;
 576       if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
 577         {
 578           svm_msg_q_unlock (mq);
 579           return -2;
 580         }
 581       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
 582       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
 583       evt->session_index = session_index;
 584       evt->event_type = evt_type;
 585       svm_msg_q_add_and_unlock (mq, &msg);
 586       return 0;
 587     }
 588   else
 589     {
 590       svm_msg_q_lock (mq);
 591       while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
 592              || svm_msg_q_is_full (mq))
 593         svm_msg_q_wait (mq);
 594       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
 595       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
 596       evt->session_index = session_index;
 597       evt->event_type = evt_type;
 598       svm_msg_q_add_and_unlock (mq, &msg);
 599       return 0;
 600     }
 601 }
 602
 603 always_inline int
 604 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
 605                     svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
 606                     u8 do_evt, u8 noblock)
 607 {
 608   u32 max_enqueue, actual_write;
 609   session_dgram_hdr_t hdr;
 610   int rv;
 611
 612   max_enqueue = svm_fifo_max_enqueue_prod (f);
 613   if (max_enqueue < (sizeof (session_dgram_hdr_t) + len))
 614     return 0;
 615
 616   max_enqueue -= sizeof (session_dgram_hdr_t);
 617   actual_write = clib_min (len, max_enqueue);
 618   hdr.data_length = actual_write;
 619   hdr.data_offset = 0;
 620   clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
 621   hdr.is_ip4 = at->is_ip4;
 622   hdr.rmt_port = at->rmt_port;
 623   clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
 624   hdr.lcl_port = at->lcl_port;
 625   rv = svm_fifo_enqueue (f, sizeof (hdr), (u8 *) & hdr);
 626   ASSERT (rv == sizeof (hdr));
 627
 628   rv = svm_fifo_enqueue (f, actual_write, data);
 629   if (do_evt)
 630     {
 631       if (rv > 0 && svm_fifo_set_event (f))
 632         app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
 633                                 noblock);
 634     }
 635   ASSERT (rv);
 636   return rv;
 637 }
 638
 639 always_inline int
 640 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
 641 {
 642   return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
 643                              len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
 644                              noblock);
 645 }
 646
 647 always_inline int
 648 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
 649                      u32 len, u8 evt_type, u8 do_evt, u8 noblock)
 650 {
 651   int rv;
 652
 653   rv = svm_fifo_enqueue (f, len, data);
 654   if (do_evt)
 655     {
 656       if (rv > 0 && svm_fifo_set_event (f))
 657         app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
 658                                 noblock);
 659     }
 660   return rv;
 661 }
 662
 663 always_inline int
 664 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
 665 {
 666   return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
 667                               SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
 668 }
 669
 670 always_inline int
 671 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
 672 {
 673   if (s->is_dgram)
 674     return app_send_dgram (s, data, len, noblock);
 675   return app_send_stream (s, data, len, noblock);
 676 }
 677
 678 always_inline int
 679 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
 680                     app_session_transport_t * at, u8 clear_evt, u8 peek)
 681 {
 682   session_dgram_pre_hdr_t ph;
 683   u32 max_deq;
 684   int rv;
 685
 686   max_deq = svm_fifo_max_dequeue_cons (f);
 687   if (max_deq <= sizeof (session_dgram_hdr_t))
 688     {
 689       if (clear_evt)
 690         svm_fifo_unset_event (f);
 691       return 0;
 692     }
 693
 694   if (clear_evt)
 695     svm_fifo_unset_event (f);
 696
 697   svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
 698   ASSERT (ph.data_length >= ph.data_offset);
 699
 700   /* Check if we have the full dgram */
 701   if (max_deq < (ph.data_length + SESSION_CONN_HDR_LEN)
 702       && len >= ph.data_length)
 703     return 0;
 704
 705   svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
 706   len = clib_min (len, ph.data_length - ph.data_offset);
 707   rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
 708   if (peek)
 709     return rv;
 710
 711   /* Discards data that did not fit in buffer */
 712   svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
 713
 714   return rv;
 715 }
 716
 717 always_inline int
 718 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
 719 {
 720   return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
 721 }
 722
 723 always_inline int
 724 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
 725 {
 726   if (clear_evt)
 727     svm_fifo_unset_event (f);
 728
 729   if (peek)
 730     return svm_fifo_peek (f, 0, len, buf);
 731
 732   return svm_fifo_dequeue (f, len, buf);
 733 }
 734
 735 always_inline int
 736 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
 737 {
 738   return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
 739 }
 740
 741 always_inline int
 742 app_recv (app_session_t * s, u8 * data, u32 len)
 743 {
 744   if (s->is_dgram)
 745     return app_recv_dgram (s, data, len);
 746   return app_recv_stream (s, data, len);
 747 }
 748
 749 /* *INDENT-OFF* */
 750 static char *session_error_str[] = {
 751 #define _(sym, str) str,
 752     foreach_session_error
 753 #undef _
 754 };
 755 /* *INDENT-ON* */
 756
 757 static inline u8 *
 758 format_session_error (u8 * s, va_list * args)
 759 {
 760   session_error_t error = va_arg (*args, session_error_t);
 761   if (-error >= 0 && -error < SESSION_N_ERRORS)
 762     s = format (s, "%s", session_error_str[-error]);
 763   else
 764     s = format (s, "invalid session err %u", -error);
 765   return s;
 766 }
 767 #endif /* __included_uri_h__ */
 768
 769 /*
 770  * fd.io coding-style-patch-verification: ON
 771  *
 772  * Local Variables:
 773  * eval: (c-set-style "gnu")
 774  * End:
 775  */