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:
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #ifndef __included_ssvm_fifo_h__
20 #define __included_ssvm_fifo_h__
22 #include <vppinfra/clib.h>
23 #include <vppinfra/vec.h>
24 #include <vppinfra/pool.h>
25 #include <vppinfra/format.h>
26 #include <vppinfra/rbtree.h>
28 /** Out-of-order segment */
31 u32 next; /**< Next linked-list element pool index */
32 u32 prev; /**< Previous linked-list element pool index */
34 u32 start; /**< Start of segment, normalized*/
35 u32 length; /**< Length of segment */
38 #define SVM_FIFO_TRACE (0)
39 #define OOO_SEGMENT_INVALID_INDEX ((u32)~0)
40 #define SVM_FIFO_INVALID_SESSION_INDEX ((u32)~0)
41 #define SVM_FIFO_INVALID_INDEX ((u32)~0)
42 #define SVM_FIFO_MAX_EVT_SUBSCRIBERS 7
46 SVM_FIFO_NO_TX_NOTIF = 0,
47 SVM_FIFO_WANT_TX_NOTIF = 1,
48 SVM_FIFO_WANT_TX_NOTIF_IF_FULL = 2,
56 } svm_fifo_trace_elem_t;
58 typedef struct svm_fifo_chunk_
62 struct svm_fifo_chunk_ *next;
66 typedef enum svm_fifo_flag_
68 SVM_FIFO_F_SIZE_UPDATE = 1 << 0,
69 SVM_FIFO_F_MULTI_CHUNK = 1 << 1,
70 SVM_FIFO_F_LL_TRACKED = 1 << 2,
73 typedef struct _svm_fifo
75 CLIB_CACHE_LINE_ALIGN_MARK (shared_first);
76 u32 size; /**< size of the fifo */
77 u32 nitems; /**< usable size(size-1) */
78 u8 flags; /**< fifo flags */
79 svm_fifo_chunk_t *start_chunk;/**< first chunk in fifo chunk list */
80 svm_fifo_chunk_t *end_chunk; /**< end chunk in fifo chunk list */
81 svm_fifo_chunk_t *new_chunks; /**< chunks yet to be added to list */
82 rb_tree_t chunk_lookup;
84 CLIB_CACHE_LINE_ALIGN_MARK (shared_second);
85 volatile u32 has_event; /**< non-zero if deq event exists */
87 u32 master_session_index;
88 u32 client_session_index;
89 u8 master_thread_index;
90 u8 client_thread_index;
93 u32 ct_session_index; /**< Local session index for vpp */
94 u32 freelist_index; /**< aka log2(allocated_size) - const. */
95 i8 refcnt; /**< reference count */
96 struct _svm_fifo *next; /**< next in freelist/active chain */
97 struct _svm_fifo *prev; /**< prev in active chain */
99 CLIB_CACHE_LINE_ALIGN_MARK (consumer);
100 u32 head; /**< fifo head position/byte */
101 svm_fifo_chunk_t *head_chunk; /**< tracks chunk where head lands */
102 svm_fifo_chunk_t *ooo_deq; /**< last chunk used for ooo dequeue */
103 volatile u32 want_tx_ntf; /**< producer wants nudge */
104 volatile u32 has_tx_ntf;
106 CLIB_CACHE_LINE_ALIGN_MARK (producer);
107 u32 tail; /**< fifo tail position/byte */
108 u32 ooos_list_head; /**< Head of out-of-order linked-list */
109 svm_fifo_chunk_t *tail_chunk; /**< tracks chunk where tail lands */
110 svm_fifo_chunk_t *ooo_enq; /**< last chunk used for ooo enqueue */
111 ooo_segment_t *ooo_segments; /**< Pool of ooo segments */
112 u32 ooos_newest; /**< Last segment to have been updated */
113 volatile u8 n_subscribers;
114 u8 subscribers[SVM_FIFO_MAX_EVT_SUBSCRIBERS];
117 svm_fifo_trace_elem_t *trace;
120 svm_fifo_chunk_t default_chunk;
128 typedef struct svm_fifo_seg_
135 #define svm_fifo_trace_add(_f, _s, _l, _t) \
137 svm_fifo_trace_elem_t *trace_elt; \
138 vec_add2(_f->trace, trace_elt, 1); \
139 trace_elt->offset = _s; \
140 trace_elt->len = _l; \
141 trace_elt->action = _t; \
144 #define svm_fifo_trace_add(_f, _s, _l, _t)
147 u8 *svm_fifo_dump_trace (u8 * s, svm_fifo_t * f);
148 u8 *svm_fifo_replay (u8 * s, svm_fifo_t * f, u8 no_read, u8 verbose);
150 /* internal function */
152 f_load_head_tail_cons (svm_fifo_t * f, u32 * head, u32 * tail)
154 /* load-relaxed: consumer owned index */
156 /* load-acq: consumer foreign index (paired with store-rel in producer) */
157 *tail = clib_atomic_load_acq_n (&f->tail);
160 /* internal function */
162 f_load_head_tail_prod (svm_fifo_t * f, u32 * head, u32 * tail)
164 /* load relaxed: producer owned index */
166 /* load-acq: producer foreign index (paired with store-rel in consumer) */
167 *head = clib_atomic_load_acq_n (&f->head);
170 /* producer consumer role independent */
171 /* internal function */
173 f_load_head_tail_all_acq (svm_fifo_t * f, u32 * head, u32 * tail)
175 /* load-acq : consumer foreign index (paired with store-rel) */
176 *tail = clib_atomic_load_acq_n (&f->tail);
177 /* load-acq : producer foriegn index (paired with store-rel) */
178 *head = clib_atomic_load_acq_n (&f->head);
181 /* internal function */
183 f_free_count (svm_fifo_t * f, u32 head, u32 tail)
185 return (f->nitems + head - tail);
188 /* internal function */
190 f_cursize (svm_fifo_t * f, u32 head, u32 tail)
192 return (f->nitems - f_free_count (f, head, tail));
195 /* used by consumer */
197 svm_fifo_max_dequeue_cons (svm_fifo_t * f)
200 f_load_head_tail_cons (f, &head, &tail);
201 return f_cursize (f, head, tail);
204 /* used by producer*/
206 svm_fifo_max_dequeue_prod (svm_fifo_t * f)
209 f_load_head_tail_prod (f, &head, &tail);
210 return f_cursize (f, head, tail);
213 /* use producer or consumer specific functions for perfomance.
214 * svm_fifo_max_dequeue_cons (svm_fifo_t *f)
215 * svm_fifo_max_dequeue_prod (svm_fifo_t *f)
218 svm_fifo_max_dequeue (svm_fifo_t * f)
221 f_load_head_tail_all_acq (f, &head, &tail);
222 return f_cursize (f, head, tail);
225 /* used by producer */
227 svm_fifo_is_full_prod (svm_fifo_t * f)
229 return (svm_fifo_max_dequeue_prod (f) == f->nitems);
232 /* use producer or consumer specific functions for perfomance.
233 * svm_fifo_is_full_prod (svm_fifo_t * f)
234 * add cons version if needed
237 svm_fifo_is_full (svm_fifo_t * f)
239 return (svm_fifo_max_dequeue (f) == f->nitems);
242 /* used by consumer */
244 svm_fifo_is_empty_cons (svm_fifo_t * f)
246 return (svm_fifo_max_dequeue_cons (f) == 0);
249 /* used by producer */
251 svm_fifo_is_empty_prod (svm_fifo_t * f)
253 return (svm_fifo_max_dequeue_prod (f) == 0);
256 /* use producer or consumer specific functions for perfomance.
257 * svm_fifo_is_empty_cons (svm_fifo_t * f)
258 * svm_fifo_is_empty_prod (svm_fifo_t * f)
261 svm_fifo_is_empty (svm_fifo_t * f)
263 return (svm_fifo_max_dequeue (f) == 0);
267 svm_fifo_is_wrapped (svm_fifo_t * f)
270 f_load_head_tail_all_acq (f, &head, &tail);
271 return head % f->size > tail % f->size;
274 /* used by producer*/
276 svm_fifo_max_enqueue_prod (svm_fifo_t * f)
279 f_load_head_tail_prod (f, &head, &tail);
280 return f_free_count (f, head, tail);
283 /* use producer or consumer specfic functions for perfomance.
284 * svm_fifo_max_enqueue_prod (svm_fifo_t *f)
285 * add consumer specific version if needed.
288 svm_fifo_max_enqueue (svm_fifo_t * f)
291 f_load_head_tail_all_acq (f, &head, &tail);
292 return f_free_count (f, head, tail);
296 svm_fifo_has_event (svm_fifo_t * f)
302 svm_fifo_has_ooo_data (svm_fifo_t * f)
304 return f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX;
308 * Sets fifo event flag.
310 * Also acts as a release ordering.
312 * @return 1 if flag was not set.
315 svm_fifo_set_event (svm_fifo_t * f)
317 /* return __sync_lock_test_and_set (&f->has_event, 1) == 0;
318 return __sync_bool_compare_and_swap (&f->has_event, 0, 1); */
319 return !clib_atomic_swap_rel_n (&f->has_event, 1);
323 * Unsets fifo event flag.
325 * Also acts as an acquire barrier.
328 svm_fifo_unset_event (svm_fifo_t * f)
330 clib_atomic_swap_acq_n (&f->has_event, 0);
333 svm_fifo_t *svm_fifo_create (u32 data_size_in_bytes);
334 void svm_fifo_init (svm_fifo_t * f, u32 size);
337 * Allocate a fifo chunk on heap
339 * If the chunk is allocated on a fifo segment, this should be called
340 * with the segment's heap pushed.
342 * @param size chunk size in bytes. Will be rounded to the next highest
344 * @return new chunk or 0 if alloc failed
346 svm_fifo_chunk_t *svm_fifo_chunk_alloc (u32 size);
349 * Grow fifo size by adding chunk to chunk list
351 * If fifos are allocated on a segment, this should be called with
352 * the segment's heap pushed.
354 * @param f fifo to be extended
355 * @param c chunk or linked list of chunks to be added
357 void svm_fifo_add_chunk (svm_fifo_t * f, svm_fifo_chunk_t * c);
358 void svm_fifo_free (svm_fifo_t * f);
360 * Cleanup fifo chunk lookup rb tree
362 * The rb tree is allocated in segment heap so this should be called
365 * @param f fifo to cleanup
367 void svm_fifo_free_chunk_lookup (svm_fifo_t * f);
369 * Cleanup fifo ooo data
371 * The ooo data is allocated in producer process memory. The fifo
372 * segment heap should not be pushed.
374 * @param f fifo to cleanup
376 void svm_fifo_free_ooo_data (svm_fifo_t * f);
378 int svm_fifo_enqueue_nowait (svm_fifo_t * f, u32 max_bytes,
379 const u8 * copy_from_here);
380 int svm_fifo_enqueue_with_offset (svm_fifo_t * f, u32 offset,
381 u32 required_bytes, u8 * copy_from_here);
382 int svm_fifo_dequeue_nowait (svm_fifo_t * f, u32 max_bytes, u8 * copy_here);
384 int svm_fifo_peek (svm_fifo_t * f, u32 offset, u32 max_bytes, u8 * copy_here);
385 int svm_fifo_dequeue_drop (svm_fifo_t * f, u32 max_bytes);
386 void svm_fifo_dequeue_drop_all (svm_fifo_t * f);
387 int svm_fifo_segments (svm_fifo_t * f, svm_fifo_seg_t * fs);
388 void svm_fifo_segments_free (svm_fifo_t * f, svm_fifo_seg_t * fs);
389 void svm_fifo_init_pointers (svm_fifo_t * f, u32 head, u32 tail);
390 void svm_fifo_clone (svm_fifo_t * df, svm_fifo_t * sf);
391 void svm_fifo_overwrite_head (svm_fifo_t * f, u8 * data, u32 len);
392 void svm_fifo_add_subscriber (svm_fifo_t * f, u8 subscriber);
393 void svm_fifo_del_subscriber (svm_fifo_t * f, u8 subscriber);
394 format_function_t format_svm_fifo;
397 * Max contiguous chunk of data that can be read
400 svm_fifo_max_read_chunk (svm_fifo_t * f)
403 u32 head_idx, tail_idx;
404 f_load_head_tail_cons (f, &head, &tail);
405 head_idx = head % f->size;
406 tail_idx = tail % f->size;
407 return tail_idx > head_idx ? (tail_idx - head_idx) : (f->size - head_idx);
411 * Max contiguous chunk of data that can be written
414 svm_fifo_max_write_chunk (svm_fifo_t * f)
417 u32 head_idx, tail_idx;
418 f_load_head_tail_prod (f, &head, &tail);
419 head_idx = head % f->size;
420 tail_idx = tail % f->size;
421 return tail_idx >= head_idx ? (f->size - tail_idx) : (head_idx - tail_idx);
425 * Advance tail pointer
427 * Useful for moving tail pointer after external enqueue.
430 svm_fifo_enqueue_nocopy (svm_fifo_t * f, u32 bytes)
432 ASSERT (bytes <= svm_fifo_max_enqueue_prod (f));
433 /* load-relaxed: producer owned index */
436 /* store-rel: producer owned index (paired with load-acq in consumer) */
437 clib_atomic_store_rel_n (&f->tail, tail);
441 svm_fifo_head (svm_fifo_t * f)
443 /* load-relaxed: consumer owned index */
444 return (f->head_chunk->data
445 + ((f->head % f->size) - f->head_chunk->start_byte));
449 svm_fifo_tail (svm_fifo_t * f)
451 /* load-relaxed: producer owned index */
452 return (f->tail_chunk->data
453 + ((f->tail % f->size) - f->tail_chunk->start_byte));
457 svm_fifo_add_want_tx_ntf (svm_fifo_t * f, u8 ntf_type)
459 f->want_tx_ntf |= ntf_type;
463 svm_fifo_del_want_tx_ntf (svm_fifo_t * f, u8 ntf_type)
465 f->want_tx_ntf &= ~ntf_type;
469 svm_fifo_clear_tx_ntf (svm_fifo_t * f)
471 /* Set the flag if want_tx_notif_if_full was the only ntf requested */
472 f->has_tx_ntf = f->want_tx_ntf == SVM_FIFO_WANT_TX_NOTIF_IF_FULL;
473 svm_fifo_del_want_tx_ntf (f, SVM_FIFO_WANT_TX_NOTIF);
477 svm_fifo_reset_tx_ntf (svm_fifo_t * f)
483 svm_fifo_needs_tx_ntf (svm_fifo_t * f, u32 n_last_deq)
485 u8 want_ntf = f->want_tx_ntf;
487 if (PREDICT_TRUE (want_ntf == SVM_FIFO_NO_TX_NOTIF))
489 else if (want_ntf & SVM_FIFO_WANT_TX_NOTIF)
491 else if (want_ntf & SVM_FIFO_WANT_TX_NOTIF_IF_FULL)
493 u32 max_deq = svm_fifo_max_dequeue_cons (f);
494 u32 nitems = f->nitems;
495 if (!f->has_tx_ntf && max_deq < nitems
496 && max_deq + n_last_deq >= nitems)
505 svm_fifo_n_subscribers (svm_fifo_t * f)
507 return f->n_subscribers;
510 u32 svm_fifo_number_ooo_segments (svm_fifo_t * f);
511 ooo_segment_t *svm_fifo_first_ooo_segment (svm_fifo_t * f);
513 always_inline ooo_segment_t *
514 svm_fifo_newest_ooo_segment (svm_fifo_t * f)
516 if (f->ooos_newest == OOO_SEGMENT_INVALID_INDEX)
518 return pool_elt_at_index (f->ooo_segments, f->ooos_newest);
522 svm_fifo_newest_ooo_segment_reset (svm_fifo_t * f)
524 f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
528 ooo_segment_distance_from_tail (svm_fifo_t * f, u32 pos, u32 tail)
530 return ((pos - tail) % f->size);
534 ooo_segment_distance_to_tail (svm_fifo_t * f, u32 pos, u32 tail)
536 return ((tail - pos) % f->size);
540 ooo_segment_offset_prod (svm_fifo_t * f, ooo_segment_t * s)
543 /* load-relaxed: producer owned index */
546 return ooo_segment_distance_from_tail (f, s->start, tail);
550 ooo_segment_length (svm_fifo_t * f, ooo_segment_t * s)
555 always_inline ooo_segment_t *
556 ooo_segment_get_prev (svm_fifo_t * f, ooo_segment_t * s)
558 if (s->prev == OOO_SEGMENT_INVALID_INDEX)
560 return pool_elt_at_index (f->ooo_segments, s->prev);
563 always_inline ooo_segment_t *
564 ooo_segment_next (svm_fifo_t * f, ooo_segment_t * s)
566 if (s->next == OOO_SEGMENT_INVALID_INDEX)
568 return pool_elt_at_index (f->ooo_segments, s->next);
571 #endif /* __included_ssvm_fifo_h__ */
574 * fd.io coding-style-patch-verification: ON
577 * eval: (c-set-style "gnu")