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