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