FD.io VPP  v20.05.1-5-g09f167997
Vector Packet Processing
svm_fifo.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2019 Cisco and/or its affiliates.
3  * Copyright (c) 2019 Arm Limited
4  * Copyright (c) 2010-2017 Intel Corporation and/or its affiliates.
5  * Copyright (c) 2007-2009 Kip Macy kmacy@freebsd.org
6  * Inspired from DPDK rte_ring.h (SPSC only) (derived from freebsd bufring.h).
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at:
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  */
19 #ifndef __included_ssvm_fifo_h__
20 #define __included_ssvm_fifo_h__
21 
22 #include <vppinfra/clib.h>
23 #include <vppinfra/vec.h>
24 #include <vppinfra/pool.h>
25 #include <vppinfra/format.h>
26 #include <svm/fifo_types.h>
27 
28 #define OOO_SEGMENT_INVALID_INDEX ((u32)~0)
29 #define SVM_FIFO_INVALID_SESSION_INDEX ((u32)~0)
30 #define SVM_FIFO_INVALID_INDEX ((u32)~0)
31 
32 typedef enum svm_fifo_deq_ntf_
33 {
34  SVM_FIFO_NO_DEQ_NOTIF = 0, /**< No notification requested */
35  SVM_FIFO_WANT_DEQ_NOTIF = 1, /**< Notify on dequeue */
36  SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL = 2, /**< Notify on transition from full */
37  SVM_FIFO_WANT_DEQ_NOTIF_IF_EMPTY = 4, /**< Notify on transition to empty */
39 
40 typedef enum svm_fifo_flag_
41 {
44 
45 typedef enum
46 {
51 
52 typedef struct svm_fifo_seg_
53 {
54  u8 *data;
57 
58 #if SVM_FIFO_TRACE
59 #define svm_fifo_trace_add(_f, _s, _l, _t) \
60 { \
61  svm_fifo_trace_elem_t *trace_elt; \
62  vec_add2(_f->trace, trace_elt, 1); \
63  trace_elt->offset = _s; \
64  trace_elt->len = _l; \
65  trace_elt->action = _t; \
66 }
67 #else
68 #define svm_fifo_trace_add(_f, _s, _l, _t)
69 #endif
70 
72 u8 *svm_fifo_replay (u8 * s, svm_fifo_t * f, u8 no_read, u8 verbose);
73 
74 /**
75  * Load head and tail optimized for consumer
76  *
77  * Internal function.
78  */
79 static inline void
80 f_load_head_tail_cons (svm_fifo_t * f, u32 * head, u32 * tail)
81 {
82  /* load-relaxed: consumer owned index */
83  *head = f->head;
84  /* load-acq: consumer foreign index (paired with store-rel in producer) */
85  *tail = clib_atomic_load_acq_n (&f->tail);
86 }
87 
88 /** Load head and tail optimized for producer
89  *
90  * Internal function
91  */
92 static inline void
93 f_load_head_tail_prod (svm_fifo_t * f, u32 * head, u32 * tail)
94 {
95  /* load relaxed: producer owned index */
96  *tail = f->tail;
97  /* load-acq: producer foreign index (paired with store-rel in consumer) */
98  *head = clib_atomic_load_acq_n (&f->head);
99 }
100 
101 /**
102  * Load head and tail independent of producer/consumer role
103  *
104  * Internal function.
105  */
106 static inline void
108 {
109  /* load-acq : consumer foreign index (paired with store-rel) */
110  *tail = clib_atomic_load_acq_n (&f->tail);
111  /* load-acq : producer foriegn index (paired with store-rel) */
112  *head = clib_atomic_load_acq_n (&f->head);
113 }
114 
115 /**
116  * Fifo current size, i.e., number of bytes enqueued
117  *
118  * Internal function.
119  */
120 static inline u32
121 f_cursize (svm_fifo_t * f, u32 head, u32 tail)
122 {
123  return tail - head;
124 }
125 
126 /**
127  * Fifo free bytes, i.e., number of free bytes
128  *
129  * Internal function
130  */
131 static inline u32
132 f_free_count (svm_fifo_t * f, u32 head, u32 tail)
133 {
134  return (f->size - f_cursize (f, head, tail));
135 }
136 
139 {
140  return c->start_byte + c->length;
141 }
142 
143 always_inline int
145 {
146  return ((i32) (a - b) < 0);
147 }
148 
149 always_inline int
151 {
152  return ((i32) (a - b) <= 0);
153 }
154 
155 always_inline int
157 {
158  return ((i32) (a - b) > 0);
159 }
160 
161 always_inline int
163 {
164  return ((i32) (a - b) >= 0);
165 }
166 
169 {
170  return (f_pos_geq (pos, c->start_byte)
171  && f_pos_lt (pos, c->start_byte + c->length));
172 }
173 
174 /**
175  * Create fifo of requested size
176  *
177  * Allocates fifo on current heap.
178  *
179  * @param size data size in bytes for fifo to be allocated. Will be
180  * rounded to the next highest power-of-two value.
181  * @return pointer to new fifo
182  */
184 /**
185  * Initialize fifo
186  *
187  * @param f fifo
188  * @param size size for fifo
189  */
190 void svm_fifo_init (svm_fifo_t * f, u32 size);
191 /**
192  * Allocate a fifo chunk on heap
193  *
194  * If the chunk is allocated on a fifo segment, this should be called
195  * with the segment's heap pushed.
196  *
197  * @param size chunk size in bytes. Will be rounded to the next highest
198  * power-of-two
199  * @return new chunk or 0 if alloc failed
200  */
202 /**
203  * Ensure the whole fifo size is writeable
204  *
205  * Allocates enough chunks to cover the whole fifo size.
206  *
207  * @param f fifo
208  */
210 /**
211  * Initialize rbtrees used for ooo lookups
212  *
213  * @param f fifo
214  * @param ooo_type type of ooo operation (0 enqueue, 1 dequeue)
215  */
216 void svm_fifo_init_ooo_lookup (svm_fifo_t * f, u8 ooo_type);
217 /**
218  * Free fifo and associated state
219  *
220  * @param f fifo
221  */
222 void svm_fifo_free (svm_fifo_t * f);
223 /**
224  * Cleanup fifo chunk lookup rb tree
225  *
226  * The rb tree is allocated in segment heap so this should be called
227  * with it pushed.
228  *
229  * @param f fifo to cleanup
230  */
232 /**
233  * Cleanup fifo ooo data
234  *
235  * The ooo data is allocated in producer process memory. The fifo
236  * segment heap should not be pushed.
237  *
238  * @param f fifo to cleanup
239  */
241 /**
242  * Init fifo head and tail
243  *
244  * @param f fifo
245  * @param head head value that will be matched to a chunk
246  * @param tail tail value that will be matched to a chunk
247  */
248 void svm_fifo_init_pointers (svm_fifo_t * f, u32 head, u32 tail);
249 /**
250  * Clone fifo
251  *
252  * Clones single/default chunk fifo. It does not work for fifos with
253  * multiple chunks.
254  */
255 void svm_fifo_clone (svm_fifo_t * df, svm_fifo_t * sf);
256 /**
257  * Enqueue data to fifo
258  *
259  * Data is enqueued and tail pointer is updated atomically. If the new data
260  * enqueued partly overlaps or "touches" an out-of-order segment, said segment
261  * is "consumed" and the number of bytes returned is appropriately updated.
262  *
263  * @param f fifo
264  * @param len length of data to copy
265  * @param src buffer from where to copy the data
266  * @return number of contiguous bytes that can be consumed or error
267  */
268 int svm_fifo_enqueue (svm_fifo_t * f, u32 len, const u8 * src);
269 /**
270  * Enqueue data to fifo with offset
271  *
272  * Data is enqueued without updating tail pointer. Instead, an out-of-order
273  * list of segments is generated and maintained. Fifo takes care of coalescing
274  * contiguous or overlapping segments.
275  *
276  * @param f fifo
277  * @param offset offset at which to copy the data
278  * @param len len of data to copy
279  * @param src buffer from where to copy the data
280  * @return 0 if enqueue was successful, error otherwise
281  */
283  u8 * src);
284 
285 /**
286  * Advance tail pointer
287  *
288  * Useful for moving tail pointer after external enqueue.
289  *
290  * @param f fifo
291  * @param len number of bytes to add to tail
292  */
294 /**
295  * Overwrite fifo head with new data
296  *
297  * This should be typically used by dgram transport protocols that need
298  * to update the dgram header after dequeueing a chunk of data. It assumes
299  * that the dgram header is at most spread over two chunks.
300  *
301  * @param f fifo
302  * @param src src of new data
303  * @param len length of new data
304  */
306 /**
307  * Dequeue data from fifo
308  *
309  * Data is dequeued to consumer provided buffer and head is atomically
310  * updated.
311  *
312  * @param f fifo
313  * @param len length of data to dequeue
314  * @param dst buffer to where to dequeue the data
315  * @return number of bytes dequeued or error
316  */
317 int svm_fifo_dequeue (svm_fifo_t * f, u32 len, u8 * dst);
318 /**
319  * Peek data from fifo
320  *
321  * Data is copied from requested offset into provided dst buffer. Head is
322  * not updated.
323  *
324  * @param f fifo
325  * @param offset offset from which to copy the data
326  * @param len length of data to copy
327  * @param dst buffer to where to dequeue the data
328  * @return number of bytes peeked
329  */
330 int svm_fifo_peek (svm_fifo_t * f, u32 offset, u32 len, u8 * dst);
331 /**
332  * Dequeue and drop bytes from fifo
333  *
334  * Advances fifo head by requested amount of bytes.
335  *
336  * @param f fifo
337  * @param len number of bytes to drop
338  * @return number of bytes dropped
339  */
341 /**
342  * Dequeue and drop all bytes from fifo
343  *
344  * Advances head to tail position.
345  *
346  * @param f fifo
347  */
351 /**
352  * Add io events subscriber to list
353  *
354  * @param f fifo
355  * @param sub subscriber opaque index (typically app worker index)
356  */
357 void svm_fifo_add_subscriber (svm_fifo_t * f, u8 sub);
358 /**
359  * Remove io events subscriber form list
360  *
361  * @param f fifo
362  * @param sub subscriber index to be removed
363  */
364 void svm_fifo_del_subscriber (svm_fifo_t * f, u8 subscriber);
365 /**
366  * Number of out-of-order segments for fifo
367  *
368  * @param f fifo
369  * @return number of out of order segments
370  */
372 /**
373  * First out-of-order segment for fifo
374  *
375  * @param f fifo
376  * @return first out-of-order segment for fifo
377  */
379 /**
380  * Check if fifo is sane. Debug only.
381  *
382  * @param f fifo
383  * @return 1 if sane, 0 otherwise
384  */
386 /**
387  * Number of chunks linked into the fifo
388  *
389  * @param f fifo
390  * @return number of chunks in fifo linked list
391  */
394 
395 /**
396  * Fifo max bytes to dequeue optimized for consumer
397  *
398  * @param f fifo
399  * @return max number of bytes that can be dequeued
400  */
401 static inline u32
403 {
404  u32 tail, head;
405  f_load_head_tail_cons (f, &head, &tail);
406  return f_cursize (f, head, tail);
407 }
408 
409 /**
410  * Fifo max bytes to dequeue optimized for producer
411  *
412  * @param f fifo
413  * @return max number of bytes that can be dequeued
414  */
415 static inline u32
417 {
418  u32 tail, head;
419  f_load_head_tail_prod (f, &head, &tail);
420  return f_cursize (f, head, tail);
421 }
422 
423 /**
424  * Fifo max bytes to dequeue
425  *
426  * Note: use producer or consumer specific functions for performance:
427  * @ref svm_fifo_max_dequeue_cons (svm_fifo_t *f)
428  * @ref svm_fifo_max_dequeue_prod (svm_fifo_t *f)
429  */
430 static inline u32
432 {
433  u32 tail, head;
434  f_load_head_tail_all_acq (f, &head, &tail);
435  return f_cursize (f, head, tail);
436 }
437 
438 /**
439  * Check if fifo is full optimized for producer
440  *
441  * @param f fifo
442  * @return 1 if fifo is full 0 otherwise
443  */
444 static inline int
446 {
447  return (svm_fifo_max_dequeue_prod (f) == f->size);
448 }
449 
450 /* Check if fifo is full.
451  *
452  * Note: use producer or consumer specific functions for performance.
453  * @ref svm_fifo_is_full_prod (svm_fifo_t * f)
454  * add cons version if needed
455  */
456 static inline int
458 {
459  return (svm_fifo_max_dequeue (f) == f->size);
460 }
461 
462 /**
463  * Check if fifo is empty optimized for consumer
464  *
465  * @param f fifo
466  * @return 1 if fifo is empty 0 otherwise
467  */
468 static inline int
470 {
471  return (svm_fifo_max_dequeue_cons (f) == 0);
472 }
473 
474 /**
475  * Check if fifo is empty optimized for producer
476  *
477  * @param f fifo
478  * @return 1 if fifo is empty 0 otherwise
479  */
480 static inline int
482 {
483  return (svm_fifo_max_dequeue_prod (f) == 0);
484 }
485 
486 /**
487  * Check if fifo is empty
488  *
489  * Note: use producer or consumer specific functions for perfomance.
490  * @ref svm_fifo_is_empty_cons (svm_fifo_t * f)
491  * @ref svm_fifo_is_empty_prod (svm_fifo_t * f)
492  */
493 static inline int
495 {
496  return (svm_fifo_max_dequeue (f) == 0);
497 }
498 
499 /**
500  * Check if fifo is wrapped
501  *
502  * @param f fifo
503  * @return 1 if 'normalized' head is ahead of tail
504  */
505 static inline u8
507 {
508  u32 head, tail;
509  f_load_head_tail_all_acq (f, &head, &tail);
510  return head > tail;
511 }
512 
513 /**
514  * Maximum number of bytes that can be enqueued into fifo
515  *
516  * Optimized for producer
517  *
518  * @param f fifo
519  * @return max number of bytes that can be enqueued into fifo
520  */
521 static inline u32
523 {
524  u32 head, tail;
525  f_load_head_tail_prod (f, &head, &tail);
526  return f_free_count (f, head, tail);
527 }
528 
529 /* Maximum number of bytes that can be enqueued into fifo
530  *
531  * Note: use producer or consumer specific functions for performance.
532  * @ref svm_fifo_max_enqueue_prod (svm_fifo_t *f)
533  * add consumer specific version if needed.
534  */
535 static inline u32
537 {
538  u32 head, tail;
539  f_load_head_tail_all_acq (f, &head, &tail);
540  return f_free_count (f, head, tail);
541 }
542 
543 /**
544  * Max contiguous chunk of data that can be read.
545  *
546  * Should only be called by consumers.
547  */
549 
550 /**
551  * Max contiguous chunk of data that can be written
552  *
553  * Should only be called by producers
554  */
556 
557 /**
558  * Fifo head chunk getter
559  *
560  * @param f fifo
561  * @return head chunk pointer
562  */
563 static inline svm_fifo_chunk_t *
565 {
566  return f->head_chunk;
567 }
568 
569 /**
570  * Fifo head pointer getter
571  *
572  * @param f fifo
573  * @return head pointer
574  */
575 static inline u8 *
577 {
578  if (!f->head_chunk)
579  return 0;
580  /* load-relaxed: consumer owned index */
581  return (f->head_chunk->data + (f->head - f->head_chunk->start_byte));
582 }
583 
584 /**
585  * Fifo tail chunk getter
586  *
587  * @param f fifo
588  * @return tail chunk pointer
589  */
590 static inline svm_fifo_chunk_t *
592 {
593  return f->tail_chunk;
594 }
595 
596 /**
597  * Fifo tail pointer getter
598  *
599  * @param f fifo
600  * @return tail pointer
601  */
602 static inline u8 *
604 {
605  /* load-relaxed: producer owned index */
606  return (f->tail_chunk->data + (f->tail - f->tail_chunk->start_byte));
607 }
608 
609 /**
610  * Fifo number of subscribers getter
611  *
612  * @param f fifo
613  * @return number of subscribers
614  */
615 static inline u8
617 {
618  return f->n_subscribers;
619 }
620 
621 /**
622  * Check if fifo has out-of-order data
623  *
624  * @param f fifo
625  * @return 1 if fifo has ooo data, 0 otherwise
626  */
627 static inline u8
629 {
630  return f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX;
631 }
632 
633 static inline ooo_segment_t *
635 {
636  if (f->ooos_newest == OOO_SEGMENT_INVALID_INDEX)
637  return 0;
638  return pool_elt_at_index (f->ooo_segments, f->ooos_newest);
639 }
640 
641 static inline void
643 {
644  f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
645 }
646 
647 static inline u32
649 {
650  u32 tail;
651  /* load-relaxed: producer owned index */
652  tail = f->tail;
653 
654  return (s->start - tail);
655 }
656 
657 static inline u32
659 {
660  return s->length;
661 }
662 
663 static inline u32
665 {
666  return f->size;
667 }
668 
669 static inline void
671 {
672  if (size > (1 << f->fs_hdr->max_log2_chunk_size))
673  return;
674  fsh_virtual_mem_update (f->fs_hdr, f->slice_index, (int) f->size - size);
675  f->size = size;
676 }
677 
678 /**
679  * Check if fifo has io event
680  *
681  * @param f fifo
682  * @return 1 if fifo has event, 0 otherwise
683  */
684 static inline int
686 {
687  return f->has_event;
688 }
689 
690 /**
691  * Set fifo event flag.
692  *
693  * Forces release semantics.
694  *
695  * @param f fifo
696  * @return 1 if flag was not set, 0 otherwise
697  */
700 {
701  return !clib_atomic_swap_rel_n (&f->has_event, 1);
702 }
703 
704 /**
705  * Unset fifo event flag.
706  *
707  * Forces acquire semantics
708  *
709  * @param f fifo
710  */
711 always_inline void
713 {
714  clib_atomic_swap_acq_n (&f->has_event, 0);
715 }
716 
717 /**
718  * Set specific want notification flag
719  *
720  * For list of flags see @ref svm_fifo_deq_ntf_t
721  *
722  * @param f fifo
723  * @param ntf_type type of notification requested
724  */
725 static inline void
727 {
728  f->want_deq_ntf |= ntf_type;
729 }
730 
731 /**
732  * Clear specific want notification flag
733  *
734  * For list of flags see @ref svm_fifo_ntf_t
735  *
736  * @param f fifo
737  * @param ntf_type type of notification to be cleared
738  */
739 static inline void
741 {
742  f->want_deq_ntf &= ~ntf_type;
743 }
744 
745 /**
746  * Clear the want notification flag and set has notification
747  *
748  * Should be used after enqueuing an event. This clears the
749  * SVM_FIFO_WANT_NOTIF flag but it does not clear
750  * SVM_FIFO_WANT_NOTIF_IF_FULL. If the latter was set, has_ntf is
751  * set to avoid enqueueing events for for all dequeue operations until
752  * it is manually cleared.
753  *
754  * @param f fifo
755  */
756 static inline void
758 {
759  /* Set the flag if want_notif_if_full was the only ntf requested */
760  f->has_deq_ntf = f->want_deq_ntf == SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL;
762 }
763 
764 /**
765  * Clear has notification flag
766  *
767  * The fifo generates only one event per SVM_FIFO_WANT_NOTIF_IF_FULL
768  * request and sets has_ntf. To received new events the flag must be
769  * cleared using this function.
770  *
771  * @param f fifo
772  */
773 static inline void
775 {
776  f->has_deq_ntf = 0;
777 }
778 
779 /**
780  * Check if fifo needs dequeue notification
781  *
782  * Determines based on notification request flags and state of the fifo if
783  * an event should be generated.
784  *
785  * @param f fifo
786  * @param n_last_deq number of bytes last dequeued
787  * @return 1 if event should be generated, 0 otherwise
788  */
789 static inline u8
791 {
792  u8 want_ntf = f->want_deq_ntf;
793 
794  if (PREDICT_TRUE (want_ntf == SVM_FIFO_NO_DEQ_NOTIF))
795  return 0;
796  else if (want_ntf & SVM_FIFO_WANT_DEQ_NOTIF)
797  return 1;
798  if (want_ntf & SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL)
799  {
800  u32 max_deq = svm_fifo_max_dequeue_cons (f);
801  u32 size = f->size;
802  if (!f->has_deq_ntf && max_deq < size && max_deq + n_last_deq >= size)
803  return 1;
804  }
805  if (want_ntf & SVM_FIFO_WANT_DEQ_NOTIF_IF_EMPTY)
806  {
807  if (!f->has_deq_ntf && svm_fifo_is_empty (f))
808  return 1;
809  }
810  return 0;
811 }
812 
813 #endif /* __included_ssvm_fifo_h__ */
814 
815 /*
816  * fd.io coding-style-patch-verification: ON
817  *
818  * Local Variables:
819  * eval: (c-set-style "gnu")
820  * End:
821  */
void svm_fifo_add_subscriber(svm_fifo_t *f, u8 sub)
Add io events subscriber to list.
Definition: svm_fifo.c:1234
u32 length
length of chunk in bytes
Definition: fifo_types.h:32
static void f_load_head_tail_all_acq(svm_fifo_t *f, u32 *head, u32 *tail)
Load head and tail independent of producer/consumer role.
Definition: svm_fifo.h:107
int svm_fifo_enqueue(svm_fifo_t *f, u32 len, const u8 *src)
Enqueue data to fifo.
Definition: svm_fifo.c:836
static u32 svm_fifo_max_enqueue_prod(svm_fifo_t *f)
Maximum number of bytes that can be enqueued into fifo.
Definition: svm_fifo.h:522
a
Definition: bitmap.h:538
void svm_fifo_clone(svm_fifo_t *df, svm_fifo_t *sf)
Clone fifo.
Definition: svm_fifo.c:1188
static void svm_fifo_set_size(svm_fifo_t *f, u32 size)
Definition: svm_fifo.h:670
static int svm_fifo_is_full(svm_fifo_t *f)
Definition: svm_fifo.h:457
Notify on dequeue.
Definition: svm_fifo.h:35
u8 * svm_fifo_replay(u8 *s, svm_fifo_t *f, u8 no_read, u8 verbose)
Definition: svm_fifo.c:1400
static u32 svm_fifo_size(svm_fifo_t *f)
Definition: svm_fifo.h:664
static u8 svm_fifo_has_ooo_data(svm_fifo_t *f)
Check if fifo has out-of-order data.
Definition: svm_fifo.h:628
format_function_t format_svm_fifo
Definition: svm_fifo.h:393
void svm_fifo_free_ooo_data(svm_fifo_t *f)
Cleanup fifo ooo data.
Definition: svm_fifo.c:111
#define PREDICT_TRUE(x)
Definition: clib.h:119
svm_fifo_flag_
Definition: svm_fifo.h:40
static u32 f_free_count(svm_fifo_t *f, u32 head, u32 tail)
Fifo free bytes, i.e., number of free bytes.
Definition: svm_fifo.h:132
Fixed length block allocator.
static int svm_fifo_is_empty_prod(svm_fifo_t *f)
Check if fifo is empty optimized for producer.
Definition: svm_fifo.h:481
static void f_load_head_tail_cons(svm_fifo_t *f, u32 *head, u32 *tail)
Load head and tail optimized for consumer.
Definition: svm_fifo.h:80
vl_api_address_t src
Definition: gre.api:54
static int svm_fifo_is_empty_cons(svm_fifo_t *f)
Check if fifo is empty optimized for consumer.
Definition: svm_fifo.h:469
static void svm_fifo_reset_has_deq_ntf(svm_fifo_t *f)
Clear has notification flag.
Definition: svm_fifo.h:774
u32 svm_fifo_max_read_chunk(svm_fifo_t *f)
Max contiguous chunk of data that can be read.
Definition: svm_fifo.c:507
void fsh_virtual_mem_update(fifo_segment_header_t *fsh, u32 slice_index, int n_bytes)
Definition: fifo_segment.c:115
static u32 svm_fifo_max_enqueue(svm_fifo_t *f)
Definition: svm_fifo.h:536
static u8 * svm_fifo_tail(svm_fifo_t *f)
Fifo tail pointer getter.
Definition: svm_fifo.h:603
unsigned char u8
Definition: types.h:56
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
static int svm_fifo_is_empty(svm_fifo_t *f)
Check if fifo is empty.
Definition: svm_fifo.h:494
int svm_fifo_segments(svm_fifo_t *f, svm_fifo_seg_t *fs)
Definition: svm_fifo.c:1135
static svm_fifo_chunk_t * svm_fifo_head_chunk(svm_fifo_t *f)
Fifo head chunk getter.
Definition: svm_fifo.h:564
static u32 svm_fifo_max_dequeue(svm_fifo_t *f)
Fifo max bytes to dequeue.
Definition: svm_fifo.h:431
static u32 svm_fifo_max_dequeue_cons(svm_fifo_t *f)
Fifo max bytes to dequeue optimized for consumer.
Definition: svm_fifo.h:402
static u32 ooo_segment_length(svm_fifo_t *f, ooo_segment_t *s)
Definition: svm_fifo.h:658
u8 * svm_fifo_dump_trace(u8 *s, svm_fifo_t *f)
Definition: svm_fifo.c:1376
unsigned int u32
Definition: types.h:88
int svm_fifo_fill_chunk_list(svm_fifo_t *f)
Ensure the whole fifo size is writeable.
Definition: svm_fifo.c:1119
struct svm_fifo_seg_ svm_fifo_seg_t
svm_fifo_deq_ntf_
Definition: svm_fifo.h:32
static u8 * svm_fifo_head(svm_fifo_t *f)
Fifo head pointer getter.
Definition: svm_fifo.h:576
void svm_fifo_init_ooo_lookup(svm_fifo_t *f, u8 ooo_type)
Initialize rbtrees used for ooo lookups.
Definition: svm_fifo.c:401
static int svm_fifo_is_full_prod(svm_fifo_t *f)
Check if fifo is full optimized for producer.
Definition: svm_fifo.h:445
static void svm_fifo_newest_ooo_segment_reset(svm_fifo_t *f)
Definition: svm_fifo.h:642
int svm_fifo_peek(svm_fifo_t *f, u32 offset, u32 len, u8 *dst)
Peek data from fifo.
Definition: svm_fifo.c:1038
u8 svm_fifo_is_sane(svm_fifo_t *f)
Check if fifo is sane.
Definition: svm_fifo.c:1257
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:534
static int f_pos_gt(u32 a, u32 b)
Definition: svm_fifo.h:156
void svm_fifo_dequeue_drop_all(svm_fifo_t *f)
Dequeue and drop all bytes from fifo.
Definition: svm_fifo.c:1099
u32 svm_fifo_n_ooo_segments(svm_fifo_t *f)
Number of out-of-order segments for fifo.
Definition: svm_fifo.c:1203
u64 size
Definition: vhost_user.h:150
#define always_inline
Definition: ipsec.h:28
static u32 f_chunk_end(svm_fifo_chunk_t *c)
Definition: svm_fifo.h:138
static void svm_fifo_unset_event(svm_fifo_t *f)
Unset fifo event flag.
Definition: svm_fifo.h:712
static u32 svm_fifo_max_dequeue_prod(svm_fifo_t *f)
Fifo max bytes to dequeue optimized for producer.
Definition: svm_fifo.h:416
vl_api_address_t dst
Definition: gre.api:55
static ooo_segment_t * svm_fifo_newest_ooo_segment(svm_fifo_t *f)
Definition: svm_fifo.h:634
static u8 svm_fifo_set_event(svm_fifo_t *f)
Set fifo event flag.
Definition: svm_fifo.h:699
svm_fifo_chunk_t * svm_fifo_chunk_alloc(u32 size)
Allocate a fifo chunk on heap.
Definition: svm_fifo.c:455
static u8 svm_fifo_needs_deq_ntf(svm_fifo_t *f, u32 n_last_deq)
Check if fifo needs dequeue notification.
Definition: svm_fifo.h:790
svmdb_client_t * c
static u32 f_cursize(svm_fifo_t *f, u32 head, u32 tail)
Fifo current size, i.e., number of bytes enqueued.
Definition: svm_fifo.h:121
int svm_fifo_dequeue(svm_fifo_t *f, u32 len, u8 *dst)
Dequeue data from fifo.
Definition: svm_fifo.c:1007
void svm_fifo_overwrite_head(svm_fifo_t *f, u8 *src, u32 len)
Overwrite fifo head with new data.
Definition: svm_fifo.c:771
static void f_load_head_tail_prod(svm_fifo_t *f, u32 *head, u32 *tail)
Load head and tail optimized for producer.
Definition: svm_fifo.h:93
u32 start_byte
chunk start byte
Definition: fifo_types.h:31
#define OOO_SEGMENT_INVALID_INDEX
Definition: svm_fifo.h:28
svm_fifo_t * svm_fifo_alloc(u32 size)
Create fifo of requested size.
Definition: svm_fifo.c:419
signed int i32
Definition: types.h:77
static u8 f_chunk_includes_pos(svm_fifo_chunk_t *c, u32 pos)
Definition: svm_fifo.h:168
u32 svm_fifo_max_write_chunk(svm_fifo_t *f)
Max contiguous chunk of data that can be written.
Definition: svm_fifo.c:527
void svm_fifo_free_chunk_lookup(svm_fifo_t *f)
Cleanup fifo chunk lookup rb tree.
Definition: svm_fifo.c:751
#define clib_atomic_swap_acq_n(a, b)
Definition: atomics.h:51
static int f_pos_geq(u32 a, u32 b)
Definition: svm_fifo.h:162
int svm_fifo_dequeue_drop(svm_fifo_t *f, u32 len)
Dequeue and drop bytes from fifo.
Definition: svm_fifo.c:1061
Notify on transition to empty.
Definition: svm_fifo.h:37
void svm_fifo_free(svm_fifo_t *f)
Free fifo and associated state.
Definition: svm_fifo.c:758
static void svm_fifo_clear_deq_ntf(svm_fifo_t *f)
Clear the want notification flag and set has notification.
Definition: svm_fifo.h:757
static void svm_fifo_add_want_deq_ntf(svm_fifo_t *f, u8 ntf_type)
Set specific want notification flag.
Definition: svm_fifo.h:726
u32 svm_fifo_n_chunks(svm_fifo_t *f)
Number of chunks linked into the fifo.
Definition: svm_fifo.c:1350
static u8 svm_fifo_is_wrapped(svm_fifo_t *f)
Check if fifo is wrapped.
Definition: svm_fifo.h:506
Notify on transition from full.
Definition: svm_fifo.h:36
u32 length
Length of segment.
Definition: fifo_types.h:44
void svm_fifo_enqueue_nocopy(svm_fifo_t *f, u32 len)
Advance tail pointer.
Definition: svm_fifo.c:931
void svm_fifo_init(svm_fifo_t *f, u32 size)
Initialize fifo.
Definition: svm_fifo.c:368
static int f_pos_leq(u32 a, u32 b)
Definition: svm_fifo.h:150
template key/value backing page structure
Definition: bihash_doc.h:44
#define clib_atomic_swap_rel_n(a, b)
Definition: atomics.h:52
enum svm_fifo_deq_ntf_ svm_fifo_deq_ntf_t
No notification requested.
Definition: svm_fifo.h:34
enum svm_fifo_flag_ svm_fifo_flag_t
static void svm_fifo_del_want_deq_ntf(svm_fifo_t *f, u8 ntf_type)
Clear specific want notification flag.
Definition: svm_fifo.h:740
static u32 ooo_segment_offset_prod(svm_fifo_t *f, ooo_segment_t *s)
Definition: svm_fifo.h:648
static u8 svm_fifo_n_subscribers(svm_fifo_t *f)
Fifo number of subscribers getter.
Definition: svm_fifo.h:616
void svm_fifo_init_pointers(svm_fifo_t *f, u32 head, u32 tail)
Init fifo head and tail.
Definition: svm_fifo.c:1218
void svm_fifo_segments_free(svm_fifo_t *f, svm_fifo_seg_t *fs)
Definition: svm_fifo.c:1167
svm_fifo_err_t
Definition: svm_fifo.h:45
static int svm_fifo_has_event(svm_fifo_t *f)
Check if fifo has io event.
Definition: svm_fifo.h:685
#define clib_atomic_load_acq_n(a)
Definition: atomics.h:48
void svm_fifo_del_subscriber(svm_fifo_t *f, u8 subscriber)
Remove io events subscriber form list.
Definition: svm_fifo.c:1242
struct _svm_fifo svm_fifo_t
int svm_fifo_enqueue_with_offset(svm_fifo_t *f, u32 offset, u32 len, u8 *src)
Enqueue data to fifo with offset.
Definition: svm_fifo.c:894
u32 start
Start of segment, normalized.
Definition: fifo_types.h:43
ooo_segment_t * svm_fifo_first_ooo_segment(svm_fifo_t *f)
First out-of-order segment for fifo.
Definition: svm_fifo.c:1209
static svm_fifo_chunk_t * svm_fifo_tail_chunk(svm_fifo_t *f)
Fifo tail chunk getter.
Definition: svm_fifo.h:591
CLIB vectors are ubiquitous dynamically resized arrays with by user defined "headers".
static int f_pos_lt(u32 a, u32 b)
Definition: svm_fifo.h:144