2ecabb032040e0e878980efcd78b385bdda35bf0
[vpp.git] / 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, u8 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_NAMESPACE,
204   APP_OPTIONS_NAMESPACE_SECRET,
205   APP_OPTIONS_PROXY_TRANSPORT,
206   APP_OPTIONS_ACCEPT_COOKIE,
207   APP_OPTIONS_TLS_ENGINE,
208   APP_OPTIONS_MAX_FIFO_SIZE,
209   APP_OPTIONS_HIGH_WATERMARK,
210   APP_OPTIONS_LOW_WATERMARK,
211   APP_OPTIONS_N_OPTIONS
212 } app_attach_options_index_t;
213
214 #define foreach_app_options_flags                               \
215   _(ACCEPT_REDIRECT, "Use FIFO with redirects")                 \
216   _(ADD_SEGMENT, "Add segment and signal app if needed")        \
217   _(IS_BUILTIN, "Application is builtin")                       \
218   _(IS_TRANSPORT_APP, "Application is a transport proto")       \
219   _(IS_PROXY, "Application is proxying")                        \
220   _(USE_GLOBAL_SCOPE, "App can use global session scope")       \
221   _(USE_LOCAL_SCOPE, "App can use local session scope")         \
222   _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling")           \
223
224 typedef enum _app_options
225 {
226 #define _(sym, str) APP_OPTIONS_##sym,
227   foreach_app_options_flags
228 #undef _
229 } app_options_t;
230
231 typedef enum _app_options_flags
232 {
233 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
234   foreach_app_options_flags
235 #undef _
236 } app_options_flags_t;
237
238 #define foreach_fd_type                                         \
239   _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment")            \
240   _(MEMFD_SEGMENT, "Fd for memfd segment")                      \
241   _(MQ_EVENTFD, "Event fd used by message queue")               \
242   _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue")     \
243
244 typedef enum session_fd_type_
245 {
246 #define _(sym, str) SESSION_FD_##sym,
247   foreach_fd_type
248 #undef _
249   SESSION_N_FD_TYPE
250 } session_fd_type_t;
251
252 typedef enum session_fd_flag_
253 {
254 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
255   foreach_fd_type
256 #undef _
257 } session_fd_flag_t;
258
259 int parse_uri (char *uri, session_endpoint_cfg_t * sep);
260 int vnet_bind_uri (vnet_listen_args_t *);
261 int vnet_unbind_uri (vnet_unlisten_args_t * a);
262 int vnet_connect_uri (vnet_connect_args_t * a);
263
264 int vnet_application_attach (vnet_app_attach_args_t * a);
265 int vnet_application_detach (vnet_app_detach_args_t * a);
266 int vnet_listen (vnet_listen_args_t * a);
267 int vnet_connect (vnet_connect_args_t * a);
268 int vnet_unlisten (vnet_unlisten_args_t * a);
269 int vnet_disconnect_session (vnet_disconnect_args_t * a);
270
271 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
272 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
273 int vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a);
274 int vnet_app_del_cert_key_pair (u32 index);
275 /** Ask for app cb on pair deletion */
276 int vnet_app_add_cert_key_interest (u32 index, u32 app_index);
277
278 typedef struct app_session_transport_
279 {
280   ip46_address_t rmt_ip;        /**< remote ip */
281   ip46_address_t lcl_ip;        /**< local ip */
282   u16 rmt_port;                 /**< remote port (network order) */
283   u16 lcl_port;                 /**< local port (network order) */
284   u8 is_ip4;                    /**< set if uses ip4 networking */
285 } app_session_transport_t;
286
287 #define foreach_app_session_field                                       \
288   _(svm_fifo_t, *rx_fifo)               /**< rx fifo */                 \
289   _(svm_fifo_t, *tx_fifo)               /**< tx fifo */                 \
290   _(session_type_t, session_type)       /**< session type */            \
291   _(volatile u8, session_state)         /**< session state */           \
292   _(u32, session_index)                 /**< index in owning pool */    \
293   _(app_session_transport_t, transport) /**< transport info */          \
294   _(svm_msg_q_t, *vpp_evt_q)            /**< vpp event queue  */        \
295   _(u8, is_dgram)                       /**< flag for dgram mode */     \
296
297 typedef struct
298 {
299 #define _(type, name) type name;
300   foreach_app_session_field
301 #undef _
302 } app_session_t;
303
304 typedef struct session_listen_msg_
305 {
306   u32 client_index;
307   u32 context;                  /* Not needed but keeping it for compatibility with bapi */
308   u32 wrk_index;
309   u32 vrf;
310   u16 port;
311   u8 proto;
312   u8 is_ip4;
313   ip46_address_t ip;
314   u32 ckpair_index;
315   u8 crypto_engine;
316 } __clib_packed session_listen_msg_t;
317
318 STATIC_ASSERT (sizeof (session_listen_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
319                "msg too large");
320
321 typedef struct session_listen_uri_msg_
322 {
323   u32 client_index;
324   u32 context;
325   u8 uri[56];
326 } __clib_packed session_listen_uri_msg_t;
327
328 STATIC_ASSERT (sizeof (session_listen_uri_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
329                "msg too large");
330
331 typedef struct session_bound_msg_
332 {
333   u32 context;
334   u64 handle;
335   i32 retval;
336   u8 lcl_is_ip4;
337   u8 lcl_ip[16];
338   u16 lcl_port;
339   uword rx_fifo;
340   uword tx_fifo;
341   uword vpp_evt_q;
342   u32 segment_size;
343   u8 segment_name_length;
344   u8 segment_name[128];
345 } __clib_packed session_bound_msg_t;
346
347 typedef struct session_unlisten_msg_
348 {
349   u32 client_index;
350   u32 context;
351   u32 wrk_index;
352   session_handle_t handle;
353 } __clib_packed session_unlisten_msg_t;
354
355 typedef struct session_unlisten_reply_msg_
356 {
357   u32 context;
358   u64 handle;
359   i32 retval;
360 } __clib_packed session_unlisten_reply_msg_t;
361
362 typedef struct session_accepted_msg_
363 {
364   u32 context;
365   u64 listener_handle;
366   u64 handle;
367   uword server_rx_fifo;
368   uword server_tx_fifo;
369   u64 segment_handle;
370   uword vpp_event_queue_address;
371   transport_endpoint_t rmt;
372   u8 flags;
373 } __clib_packed session_accepted_msg_t;
374
375 typedef struct session_accepted_reply_msg_
376 {
377   u32 context;
378   i32 retval;
379   u64 handle;
380 } __clib_packed session_accepted_reply_msg_t;
381
382 typedef struct session_connect_msg_
383 {
384   u32 client_index;
385   u32 context;
386   u32 wrk_index;
387   u32 vrf;
388   u16 port;
389   u8 proto;
390   u8 is_ip4;
391   ip46_address_t ip;
392   ip46_address_t lcl_ip;
393   u8 hostname_len;
394   u8 hostname[16];
395   u64 parent_handle;
396   u32 ckpair_index;
397   u8 crypto_engine;
398   u8 flags;
399 } __clib_packed session_connect_msg_t;
400
401 STATIC_ASSERT (sizeof (session_connect_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
402                "msg too large");
403
404 typedef struct session_connect_uri_msg_
405 {
406   u32 client_index;
407   u32 context;
408   u8 uri[56];
409 } __clib_packed session_connect_uri_msg_t;
410
411 STATIC_ASSERT (sizeof (session_connect_uri_msg_t) <=
412                SESSION_CTRL_MSG_MAX_SIZE, "msg too large");
413
414 typedef struct session_connected_msg_
415 {
416   u32 context;
417   i32 retval;
418   u64 handle;
419   uword server_rx_fifo;
420   uword server_tx_fifo;
421   u64 segment_handle;
422   uword ct_rx_fifo;
423   uword ct_tx_fifo;
424   u64 ct_segment_handle;
425   uword vpp_event_queue_address;
426   u32 segment_size;
427   u8 segment_name_length;
428   u8 segment_name[64];
429   transport_endpoint_t lcl;
430 } __clib_packed session_connected_msg_t;
431
432 typedef struct session_disconnect_msg_
433 {
434   u32 client_index;
435   u32 context;
436   session_handle_t handle;
437 } __clib_packed session_disconnect_msg_t;
438
439 typedef struct session_disconnected_msg_
440 {
441   u32 client_index;
442   u32 context;
443   u64 handle;
444 } __clib_packed session_disconnected_msg_t;
445
446 typedef struct session_disconnected_reply_msg_
447 {
448   u32 context;
449   i32 retval;
450   u64 handle;
451 } __clib_packed session_disconnected_reply_msg_t;
452
453 typedef struct session_reset_msg_
454 {
455   u32 client_index;
456   u32 context;
457   u64 handle;
458 } __clib_packed session_reset_msg_t;
459
460 typedef struct session_reset_reply_msg_
461 {
462   u32 context;
463   i32 retval;
464   u64 handle;
465 } __clib_packed session_reset_reply_msg_t;
466
467 typedef struct session_req_worker_update_msg_
468 {
469   u64 session_handle;
470 } __clib_packed session_req_worker_update_msg_t;
471
472 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
473 typedef struct session_worker_update_msg_
474 {
475   u32 client_index;
476   u16 wrk_index;
477   u16 req_wrk_index;
478   u64 handle;
479 } __clib_packed session_worker_update_msg_t;
480
481 typedef struct session_worker_update_reply_msg_
482 {
483   u64 handle;
484   uword rx_fifo;
485   uword tx_fifo;
486   u64 segment_handle;
487 } __clib_packed session_worker_update_reply_msg_t;
488
489 typedef struct session_app_detach_msg_
490 {
491   u32 client_index;
492   u32 context;
493 } session_app_detach_msg_t;
494
495 typedef struct app_map_another_segment_msg_
496 {
497   u32 client_index;
498   u32 context;
499   u8 fd_flags;
500   u32 segment_size;
501   u8 segment_name[128];
502   u64 segment_handle;
503 } session_app_add_segment_msg_t;
504
505 typedef struct app_unmap_segment_msg_
506 {
507   u32 client_index;
508   u32 context;
509   u64 segment_handle;
510 } session_app_del_segment_msg_t;
511
512 typedef struct session_migrate_msg_
513 {
514   uword vpp_evt_q;
515   session_handle_t handle;
516   session_handle_t new_handle;
517   u32 vpp_thread_index;
518 } __clib_packed session_migrated_msg_t;
519
520 typedef struct session_cleanup_msg_
521 {
522   session_handle_t handle;
523 } __clib_packed session_cleanup_msg_t;
524
525 typedef struct app_session_event_
526 {
527   svm_msg_q_msg_t msg;
528   session_event_t *evt;
529 } __clib_packed app_session_evt_t;
530
531 static inline void
532 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
533                            u8 evt_type)
534 {
535   svm_msg_q_lock_and_alloc_msg_w_ring (mq,
536                                        SESSION_MQ_CTRL_EVT_RING,
537                                        SVM_Q_WAIT, &app_evt->msg);
538   app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
539   clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
540   app_evt->evt->event_type = evt_type;
541 }
542
543 static inline void
544 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
545 {
546   svm_msg_q_add_and_unlock (mq, &app_evt->msg);
547 }
548
549 /**
550  * Send fifo io event to vpp worker thread
551  *
552  * Because there may be multiple writers to one of vpp's queues, this
553  * protects message allocation and enqueueing.
554  *
555  * @param mq            vpp message queue
556  * @param f             fifo for which the event is sent
557  * @param evt_type      type of event
558  * @param noblock       flag to indicate is request is blocking or not
559  * @return              0 if success, negative integer otherwise
560  */
561 static inline int
562 app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
563                         u8 noblock)
564 {
565   session_event_t *evt;
566   svm_msg_q_msg_t msg;
567
568   if (noblock)
569     {
570       if (svm_msg_q_try_lock (mq))
571         return -1;
572       if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
573         {
574           svm_msg_q_unlock (mq);
575           return -2;
576         }
577       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
578       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
579       evt->session_index = session_index;
580       evt->event_type = evt_type;
581       svm_msg_q_add_and_unlock (mq, &msg);
582       return 0;
583     }
584   else
585     {
586       svm_msg_q_lock (mq);
587       while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
588              || svm_msg_q_is_full (mq))
589         svm_msg_q_wait (mq);
590       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
591       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
592       evt->session_index = session_index;
593       evt->event_type = evt_type;
594       svm_msg_q_add_and_unlock (mq, &msg);
595       return 0;
596     }
597 }
598
599 always_inline int
600 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
601                     svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
602                     u8 do_evt, u8 noblock)
603 {
604   u32 max_enqueue, actual_write;
605   session_dgram_hdr_t hdr;
606   int rv;
607
608   max_enqueue = svm_fifo_max_enqueue_prod (f);
609   if (max_enqueue <= sizeof (session_dgram_hdr_t))
610     return 0;
611
612   max_enqueue -= sizeof (session_dgram_hdr_t);
613   actual_write = clib_min (len, max_enqueue);
614   hdr.data_length = actual_write;
615   hdr.data_offset = 0;
616   clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
617   hdr.is_ip4 = at->is_ip4;
618   hdr.rmt_port = at->rmt_port;
619   clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
620   hdr.lcl_port = at->lcl_port;
621   rv = svm_fifo_enqueue (f, sizeof (hdr), (u8 *) & hdr);
622   ASSERT (rv == sizeof (hdr));
623
624   rv = svm_fifo_enqueue (f, actual_write, data);
625   if (do_evt)
626     {
627       if (rv > 0 && svm_fifo_set_event (f))
628         app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
629                                 noblock);
630     }
631   ASSERT (rv);
632   return rv;
633 }
634
635 always_inline int
636 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
637 {
638   return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
639                              len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
640                              noblock);
641 }
642
643 always_inline int
644 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
645                      u32 len, u8 evt_type, u8 do_evt, u8 noblock)
646 {
647   int rv;
648
649   rv = svm_fifo_enqueue (f, len, data);
650   if (do_evt)
651     {
652       if (rv > 0 && svm_fifo_set_event (f))
653         app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
654                                 noblock);
655     }
656   return rv;
657 }
658
659 always_inline int
660 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
661 {
662   return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
663                               SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
664 }
665
666 always_inline int
667 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
668 {
669   if (s->is_dgram)
670     return app_send_dgram (s, data, len, noblock);
671   return app_send_stream (s, data, len, noblock);
672 }
673
674 always_inline int
675 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
676                     app_session_transport_t * at, u8 clear_evt, u8 peek)
677 {
678   session_dgram_pre_hdr_t ph;
679   u32 max_deq;
680   int rv;
681
682   max_deq = svm_fifo_max_dequeue_cons (f);
683   if (max_deq < sizeof (session_dgram_hdr_t))
684     {
685       if (clear_evt)
686         svm_fifo_unset_event (f);
687       return 0;
688     }
689
690   if (clear_evt)
691     svm_fifo_unset_event (f);
692
693   svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
694   ASSERT (ph.data_length >= ph.data_offset);
695   if (!ph.data_offset)
696     svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
697   len = clib_min (len, ph.data_length - ph.data_offset);
698   rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
699   if (peek)
700     return rv;
701   ph.data_offset += rv;
702   if (ph.data_offset == ph.data_length)
703     svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
704   else
705     svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
706   return rv;
707 }
708
709 always_inline int
710 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
711 {
712   return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
713 }
714
715 always_inline int
716 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
717 {
718   if (clear_evt)
719     svm_fifo_unset_event (f);
720
721   if (peek)
722     return svm_fifo_peek (f, 0, len, buf);
723
724   return svm_fifo_dequeue (f, len, buf);
725 }
726
727 always_inline int
728 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
729 {
730   return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
731 }
732
733 always_inline int
734 app_recv (app_session_t * s, u8 * data, u32 len)
735 {
736   if (s->is_dgram)
737     return app_recv_dgram (s, data, len);
738   return app_recv_stream (s, data, len);
739 }
740
741 #endif /* __included_uri_h__ */
742
743 /*
744  * fd.io coding-style-patch-verification: ON
745  *
746  * Local Variables:
747  * eval: (c-set-style "gnu")
748  * End:
749  */