FD.io VPP  v21.01.1
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  * Enqueue array of @ref svm_fifo_seg_t in order
296  *
297  * @param f fifo
298  * @param segs array of segments to enqueue
299  * @param n_segs number of segments
300  * @param allow_partial if set partial enqueues are allowed
301  * @return len if enqueue was successful, error otherwise
302  */
304  u32 n_segs, u8 allow_partial);
305 /**
306  * Overwrite fifo head with new data
307  *
308  * This should be typically used by dgram transport protocols that need
309  * to update the dgram header after dequeuing a chunk of data. It assumes
310  * that the dgram header is at most spread over two chunks.
311  *
312  * @param f fifo
313  * @param src src of new data
314  * @param len length of new data
315  */
317 /**
318  * Dequeue data from fifo
319  *
320  * Data is dequeued to consumer provided buffer and head is atomically
321  * updated. This should not be used in combination with ooo lookups. If
322  * ooo peeking of data is needed in combination with dequeuing use @ref
323  * svm_fifo_dequeue_drop.
324  *
325  * @param f fifo
326  * @param len length of data to dequeue
327  * @param dst buffer to where to dequeue the data
328  * @return number of bytes dequeued or error
329  */
330 int svm_fifo_dequeue (svm_fifo_t * f, u32 len, u8 * dst);
331 /**
332  * Peek data from fifo
333  *
334  * Data is copied from requested offset into provided dst buffer. Head is
335  * not updated.
336  *
337  * @param f fifo
338  * @param offset offset from which to copy the data
339  * @param len length of data to copy
340  * @param dst buffer to where to dequeue the data
341  * @return number of bytes peeked
342  */
343 int svm_fifo_peek (svm_fifo_t * f, u32 offset, u32 len, u8 * dst);
344 /**
345  * Dequeue and drop bytes from fifo
346  *
347  * Advances fifo head by requested amount of bytes.
348  *
349  * @param f fifo
350  * @param len number of bytes to drop
351  * @return number of bytes dropped
352  */
354 /**
355  * Dequeue and drop all bytes from fifo
356  *
357  * Advances head to tail position.
358  *
359  * @param f fifo
360  */
362 /**
363  * Get pointers to fifo chunks data in @ref svm_fifo_seg_t array
364  *
365  * Populates fifo segment array with pointers to fifo chunk data and lengths.
366  * Because this returns pointers to data, it must be paired with
367  * @ref svm_fifo_dequeue_drop to actually release the fifo chunks after the
368  * data is consumed.
369  *
370  * @param f fifo
371  * @param offset offset from where to retrieve segments
372  * @param fs array of fifo segments allocated by caller
373  * @param n_segs number of fifo segments in array
374  * @param max_bytes max bytes to be mapped to fifo segments
375  * @return number of bytes in fifo segments or SVM_FIFO_EEMPTY
376  */
378  u32 n_segs, u32 max_bytes);
379 /**
380  * Add io events subscriber to list
381  *
382  * @param f fifo
383  * @param sub subscriber opaque index (typically app worker index)
384  */
385 void svm_fifo_add_subscriber (svm_fifo_t * f, u8 sub);
386 /**
387  * Remove io events subscriber form list
388  *
389  * @param f fifo
390  * @param sub subscriber index to be removed
391  */
392 void svm_fifo_del_subscriber (svm_fifo_t * f, u8 subscriber);
393 /**
394  * Number of out-of-order segments for fifo
395  *
396  * @param f fifo
397  * @return number of out of order segments
398  */
400 /**
401  * First out-of-order segment for fifo
402  *
403  * @param f fifo
404  * @return first out-of-order segment for fifo
405  */
407 /**
408  * Check if fifo is sane. Debug only.
409  *
410  * @param f fifo
411  * @return 1 if sane, 0 otherwise
412  */
414 /**
415  * Number of chunks linked into the fifo
416  *
417  * @param f fifo
418  * @return number of chunks in fifo linked list
419  */
422 
423 /**
424  * Fifo max bytes to dequeue optimized for consumer
425  *
426  * @param f fifo
427  * @return max number of bytes that can be dequeued
428  */
429 static inline u32
431 {
432  u32 tail, head;
433  f_load_head_tail_cons (f, &head, &tail);
434  return f_cursize (f, head, tail);
435 }
436 
437 /**
438  * Fifo max bytes to dequeue optimized for producer
439  *
440  * @param f fifo
441  * @return max number of bytes that can be dequeued
442  */
443 static inline u32
445 {
446  u32 tail, head;
447  f_load_head_tail_prod (f, &head, &tail);
448  return f_cursize (f, head, tail);
449 }
450 
451 /**
452  * Fifo max bytes to dequeue
453  *
454  * Note: use producer or consumer specific functions for performance:
455  * @ref svm_fifo_max_dequeue_cons (svm_fifo_t *f)
456  * @ref svm_fifo_max_dequeue_prod (svm_fifo_t *f)
457  */
458 static inline u32
460 {
461  u32 tail, head;
462  f_load_head_tail_all_acq (f, &head, &tail);
463  return f_cursize (f, head, tail);
464 }
465 
466 /**
467  * Check if fifo is full optimized for producer
468  *
469  * @param f fifo
470  * @return 1 if fifo is full 0 otherwise
471  */
472 static inline int
474 {
475  return (svm_fifo_max_dequeue_prod (f) == f->size);
476 }
477 
478 /* Check if fifo is full.
479  *
480  * Note: use producer or consumer specific functions for performance.
481  * @ref svm_fifo_is_full_prod (svm_fifo_t * f)
482  * add cons version if needed
483  */
484 static inline int
486 {
487  return (svm_fifo_max_dequeue (f) == f->size);
488 }
489 
490 /**
491  * Check if fifo is empty optimized for consumer
492  *
493  * @param f fifo
494  * @return 1 if fifo is empty 0 otherwise
495  */
496 static inline int
498 {
499  return (svm_fifo_max_dequeue_cons (f) == 0);
500 }
501 
502 /**
503  * Check if fifo is empty optimized for producer
504  *
505  * @param f fifo
506  * @return 1 if fifo is empty 0 otherwise
507  */
508 static inline int
510 {
511  return (svm_fifo_max_dequeue_prod (f) == 0);
512 }
513 
514 /**
515  * Check if fifo is empty
516  *
517  * Note: use producer or consumer specific functions for perfomance.
518  * @ref svm_fifo_is_empty_cons (svm_fifo_t * f)
519  * @ref svm_fifo_is_empty_prod (svm_fifo_t * f)
520  */
521 static inline int
523 {
524  return (svm_fifo_max_dequeue (f) == 0);
525 }
526 
527 /**
528  * Check if fifo is wrapped
529  *
530  * @param f fifo
531  * @return 1 if 'normalized' head is ahead of tail
532  */
533 static inline u8
535 {
536  u32 head, tail;
537  f_load_head_tail_all_acq (f, &head, &tail);
538  return head > tail;
539 }
540 
541 /**
542  * Maximum number of bytes that can be enqueued into fifo
543  *
544  * Optimized for producer
545  *
546  * @param f fifo
547  * @return max number of bytes that can be enqueued into fifo
548  */
549 static inline u32
551 {
552  u32 head, tail;
553  f_load_head_tail_prod (f, &head, &tail);
554  return f_free_count (f, head, tail);
555 }
556 
557 /* Maximum number of bytes that can be enqueued into fifo
558  *
559  * Note: use producer or consumer specific functions for performance.
560  * @ref svm_fifo_max_enqueue_prod (svm_fifo_t *f)
561  * add consumer specific version if needed.
562  */
563 static inline u32
565 {
566  u32 head, tail;
567  f_load_head_tail_all_acq (f, &head, &tail);
568  return f_free_count (f, head, tail);
569 }
570 
571 /**
572  * Max contiguous chunk of data that can be read.
573  *
574  * Should only be called by consumers.
575  */
577 
578 /**
579  * Max contiguous chunk of data that can be written
580  *
581  * Should only be called by producers
582  */
584 
585 /**
586  * Fifo head chunk getter
587  *
588  * @param f fifo
589  * @return head chunk pointer
590  */
591 static inline svm_fifo_chunk_t *
593 {
594  return f->head_chunk;
595 }
596 
597 /**
598  * Fifo head pointer getter
599  *
600  * @param f fifo
601  * @return head pointer
602  */
603 static inline u8 *
605 {
606  if (!f->head_chunk)
607  return 0;
608  /* load-relaxed: consumer owned index */
609  return (f->head_chunk->data + (f->head - f->head_chunk->start_byte));
610 }
611 
612 /**
613  * Fifo tail chunk getter
614  *
615  * @param f fifo
616  * @return tail chunk pointer
617  */
618 static inline svm_fifo_chunk_t *
620 {
621  return f->tail_chunk;
622 }
623 
624 /**
625  * Fifo tail pointer getter
626  *
627  * @param f fifo
628  * @return tail pointer
629  */
630 static inline u8 *
632 {
633  /* load-relaxed: producer owned index */
634  return (f->tail_chunk->data + (f->tail - f->tail_chunk->start_byte));
635 }
636 
637 /**
638  * Fifo number of subscribers getter
639  *
640  * @param f fifo
641  * @return number of subscribers
642  */
643 static inline u8
645 {
646  return f->n_subscribers;
647 }
648 
649 /**
650  * Check if fifo has out-of-order data
651  *
652  * @param f fifo
653  * @return 1 if fifo has ooo data, 0 otherwise
654  */
655 static inline u8
657 {
658  return f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX;
659 }
660 
661 static inline ooo_segment_t *
663 {
664  if (f->ooos_newest == OOO_SEGMENT_INVALID_INDEX)
665  return 0;
666  return pool_elt_at_index (f->ooo_segments, f->ooos_newest);
667 }
668 
669 static inline void
671 {
672  f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
673 }
674 
675 static inline u32
677 {
678  u32 tail;
679  /* load-relaxed: producer owned index */
680  tail = f->tail;
681 
682  return (s->start - tail);
683 }
684 
685 static inline u32
687 {
688  return s->length;
689 }
690 
691 static inline u32
693 {
694  return f->size;
695 }
696 
697 static inline void
699 {
700  if (size > (1 << f->fs_hdr->max_log2_chunk_size))
701  return;
702  fsh_virtual_mem_update (f->fs_hdr, f->slice_index, (int) f->size - size);
703  f->size = size;
704 }
705 
706 /**
707  * Check if fifo has io event
708  *
709  * @param f fifo
710  * @return 1 if fifo has event, 0 otherwise
711  */
712 static inline int
714 {
715  return f->has_event;
716 }
717 
718 /**
719  * Set fifo event flag.
720  *
721  * Forces release semantics.
722  *
723  * @param f fifo
724  * @return 1 if flag was not set, 0 otherwise
725  */
728 {
729  return !clib_atomic_swap_rel_n (&f->has_event, 1);
730 }
731 
732 /**
733  * Unset fifo event flag.
734  *
735  * Forces acquire semantics
736  *
737  * @param f fifo
738  */
739 always_inline void
741 {
742  clib_atomic_swap_acq_n (&f->has_event, 0);
743 }
744 
745 /**
746  * Set specific want notification flag
747  *
748  * For list of flags see @ref svm_fifo_deq_ntf_t
749  *
750  * @param f fifo
751  * @param ntf_type type of notification requested
752  */
753 static inline void
755 {
756  f->want_deq_ntf |= ntf_type;
757 }
758 
759 /**
760  * Clear specific want notification flag
761  *
762  * For list of flags see @ref svm_fifo_ntf_t
763  *
764  * @param f fifo
765  * @param ntf_type type of notification to be cleared
766  */
767 static inline void
769 {
770  f->want_deq_ntf &= ~ntf_type;
771 }
772 
773 /**
774  * Clear the want notification flag and set has notification
775  *
776  * Should be used after enqueuing an event. This clears the
777  * SVM_FIFO_WANT_NOTIF flag but it does not clear
778  * SVM_FIFO_WANT_NOTIF_IF_FULL. If the latter was set, has_ntf is
779  * set to avoid enqueueing events for for all dequeue operations until
780  * it is manually cleared.
781  *
782  * @param f fifo
783  */
784 static inline void
786 {
787  /* Set the flag if want_notif_if_full was the only ntf requested */
788  f->has_deq_ntf = f->want_deq_ntf == SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL;
790 }
791 
792 /**
793  * Clear has notification flag
794  *
795  * The fifo generates only one event per SVM_FIFO_WANT_NOTIF_IF_FULL
796  * request and sets has_ntf. To received new events the flag must be
797  * cleared using this function.
798  *
799  * @param f fifo
800  */
801 static inline void
803 {
804  f->has_deq_ntf = 0;
805 }
806 
807 /**
808  * Check if fifo needs dequeue notification
809  *
810  * Determines based on notification request flags and state of the fifo if
811  * an event should be generated.
812  *
813  * @param f fifo
814  * @param n_last_deq number of bytes last dequeued
815  * @return 1 if event should be generated, 0 otherwise
816  */
817 static inline u8
819 {
820  u8 want_ntf = f->want_deq_ntf;
821 
822  if (PREDICT_TRUE (want_ntf == SVM_FIFO_NO_DEQ_NOTIF))
823  return 0;
824  else if (want_ntf & SVM_FIFO_WANT_DEQ_NOTIF)
825  return 1;
826  if (want_ntf & SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL)
827  {
828  u32 max_deq = svm_fifo_max_dequeue_cons (f);
829  u32 size = f->size;
830  if (!f->has_deq_ntf && max_deq < size && max_deq + n_last_deq >= size)
831  return 1;
832  }
833  if (want_ntf & SVM_FIFO_WANT_DEQ_NOTIF_IF_EMPTY)
834  {
835  if (!f->has_deq_ntf && svm_fifo_is_empty (f))
836  return 1;
837  }
838  return 0;
839 }
840 
841 #endif /* __included_ssvm_fifo_h__ */
842 
843 /*
844  * fd.io coding-style-patch-verification: ON
845  *
846  * Local Variables:
847  * eval: (c-set-style "gnu")
848  * End:
849  */
void svm_fifo_add_subscriber(svm_fifo_t *f, u8 sub)
Add io events subscriber to list.
Definition: svm_fifo.c:1326
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:840
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:550
a
Definition: bitmap.h:544
void svm_fifo_clone(svm_fifo_t *df, svm_fifo_t *sf)
Clone fifo.
Definition: svm_fifo.c:1280
static void svm_fifo_set_size(svm_fifo_t *f, u32 size)
Definition: svm_fifo.h:698
static int svm_fifo_is_full(svm_fifo_t *f)
Definition: svm_fifo.h:485
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:1492
static u32 svm_fifo_size(svm_fifo_t *f)
Definition: svm_fifo.h:692
static u8 svm_fifo_has_ooo_data(svm_fifo_t *f)
Check if fifo has out-of-order data.
Definition: svm_fifo.h:656
format_function_t format_svm_fifo
Definition: svm_fifo.h:421
void svm_fifo_free_ooo_data(svm_fifo_t *f)
Cleanup fifo ooo data.
Definition: svm_fifo.c:113
#define PREDICT_TRUE(x)
Definition: clib.h:122
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:509
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:497
static void svm_fifo_reset_has_deq_ntf(svm_fifo_t *f)
Clear has notification flag.
Definition: svm_fifo.h:802
u32 svm_fifo_max_read_chunk(svm_fifo_t *f)
Max contiguous chunk of data that can be read.
Definition: svm_fifo.c:511
void fsh_virtual_mem_update(fifo_segment_header_t *fsh, u32 slice_index, int n_bytes)
Definition: fifo_segment.c:112
static u32 svm_fifo_max_enqueue(svm_fifo_t *f)
Definition: svm_fifo.h:564
static u8 * svm_fifo_tail(svm_fifo_t *f)
Fifo tail pointer getter.
Definition: svm_fifo.h:631
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:522
static svm_fifo_chunk_t * svm_fifo_head_chunk(svm_fifo_t *f)
Fifo head chunk getter.
Definition: svm_fifo.h:592
static u32 svm_fifo_max_dequeue(svm_fifo_t *f)
Fifo max bytes to dequeue.
Definition: svm_fifo.h:459
static u32 svm_fifo_max_dequeue_cons(svm_fifo_t *f)
Fifo max bytes to dequeue optimized for consumer.
Definition: svm_fifo.h:430
const cJSON *const b
Definition: cJSON.h:255
static u32 ooo_segment_length(svm_fifo_t *f, ooo_segment_t *s)
Definition: svm_fifo.h:686
u8 * svm_fifo_dump_trace(u8 *s, svm_fifo_t *f)
Definition: svm_fifo.c:1468
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:1209
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:604
void svm_fifo_init_ooo_lookup(svm_fifo_t *f, u8 ooo_type)
Initialize rbtrees used for ooo lookups.
Definition: svm_fifo.c:405
static int svm_fifo_is_full_prod(svm_fifo_t *f)
Check if fifo is full optimized for producer.
Definition: svm_fifo.h:473
static void svm_fifo_newest_ooo_segment_reset(svm_fifo_t *f)
Definition: svm_fifo.h:670
int svm_fifo_peek(svm_fifo_t *f, u32 offset, u32 len, u8 *dst)
Peek data from fifo.
Definition: svm_fifo.c:1127
u8 svm_fifo_is_sane(svm_fifo_t *f)
Check if fifo is sane.
Definition: svm_fifo.c:1349
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:546
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:1189
u32 svm_fifo_n_ooo_segments(svm_fifo_t *f)
Number of out-of-order segments for fifo.
Definition: svm_fifo.c:1295
u32 size
Definition: vhost_user.h:106
#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:740
static u32 svm_fifo_max_dequeue_prod(svm_fifo_t *f)
Fifo max bytes to dequeue optimized for producer.
Definition: svm_fifo.h:444
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:662
static u8 svm_fifo_set_event(svm_fifo_t *f)
Set fifo event flag.
Definition: svm_fifo.h:727
svm_fifo_chunk_t * svm_fifo_chunk_alloc(u32 size)
Allocate a fifo chunk on heap.
Definition: svm_fifo.c:459
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:818
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:1092
void svm_fifo_overwrite_head(svm_fifo_t *f, u8 *src, u32 len)
Overwrite fifo head with new data.
Definition: svm_fifo.c:775
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:423
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:531
void svm_fifo_free_chunk_lookup(svm_fifo_t *f)
Cleanup fifo chunk lookup rb tree.
Definition: svm_fifo.c:755
#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:1151
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:762
int svm_fifo_enqueue_segments(svm_fifo_t *f, const svm_fifo_seg_t segs[], u32 n_segs, u8 allow_partial)
Enqueue array of svm_fifo_seg_t in order.
Definition: svm_fifo.c:959
static void svm_fifo_clear_deq_ntf(svm_fifo_t *f)
Clear the want notification flag and set has notification.
Definition: svm_fifo.h:785
static void svm_fifo_add_want_deq_ntf(svm_fifo_t *f, u8 ntf_type)
Set specific want notification flag.
Definition: svm_fifo.h:754
u32 svm_fifo_n_chunks(svm_fifo_t *f)
Number of chunks linked into the fifo.
Definition: svm_fifo.c:1442
static u8 svm_fifo_is_wrapped(svm_fifo_t *f)
Check if fifo is wrapped.
Definition: svm_fifo.h:534
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:935
void svm_fifo_init(svm_fifo_t *f, u32 size)
Initialize fifo.
Definition: svm_fifo.c:370
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:768
int svm_fifo_segments(svm_fifo_t *f, u32 offset, svm_fifo_seg_t *fs, u32 n_segs, u32 max_bytes)
Get pointers to fifo chunks data in svm_fifo_seg_t array.
Definition: svm_fifo.c:1225
static u32 ooo_segment_offset_prod(svm_fifo_t *f, ooo_segment_t *s)
Definition: svm_fifo.h:676
static u8 svm_fifo_n_subscribers(svm_fifo_t *f)
Fifo number of subscribers getter.
Definition: svm_fifo.h:644
void svm_fifo_init_pointers(svm_fifo_t *f, u32 head, u32 tail)
Init fifo head and tail.
Definition: svm_fifo.c:1310
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:713
#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:1334
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:898
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:1301
static svm_fifo_chunk_t * svm_fifo_tail_chunk(svm_fifo_t *f)
Fifo tail chunk getter.
Definition: svm_fifo.h:619
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