blob: 2a054526865aaf3961e02054ef08c2c75ffbc7a3 [file] [log] [blame]
Dave Barach68b0fb02017-02-28 15:15:56 -05001/*
Florin Corasc5df8c72019-04-08 07:42:30 -07002 * Copyright (c) 2016-2019 Cisco and/or its affiliates.
Sirshak Das28aa5392019-02-05 01:33:33 -06003 * 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).
Dave Barach68b0fb02017-02-28 15:15:56 -05007 * 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>
Dave Barach68b0fb02017-02-28 15:15:56 -050024#include <vppinfra/pool.h>
25#include <vppinfra/format.h>
Florin Corasf22f4e52019-12-19 16:10:58 -080026#include <svm/fifo_types.h>
Dave Barach68b0fb02017-02-28 15:15:56 -050027
Florin Coras326b81e2018-10-04 19:03:05 -070028#define OOO_SEGMENT_INVALID_INDEX ((u32)~0)
29#define SVM_FIFO_INVALID_SESSION_INDEX ((u32)~0)
Florin Corasfa76a762018-11-29 12:40:10 -080030#define SVM_FIFO_INVALID_INDEX ((u32)~0)
Dave Barach68b0fb02017-02-28 15:15:56 -050031
Florin Coras2d379d82019-06-28 12:45:12 -070032typedef enum svm_fifo_deq_ntf_
Florin Coras1bcad5c2019-01-09 20:04:38 -080033{
Florin Coras2d379d82019-06-28 12:45:12 -070034 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 */
38} svm_fifo_deq_ntf_t;
Florin Coras1bcad5c2019-01-09 20:04:38 -080039
Florin Coras2309e7a2019-04-18 18:58:10 -070040typedef enum svm_fifo_flag_
41{
Florin Corasf22f4e52019-12-19 16:10:58 -080042 SVM_FIFO_F_LL_TRACKED = 1 << 0,
Florin Coras2309e7a2019-04-18 18:58:10 -070043} svm_fifo_flag_t;
44
Florin Coras7fb0fe12018-04-09 09:24:52 -070045typedef enum
46{
Florin Coras87b15ce2019-04-28 21:16:30 -070047 SVM_FIFO_EFULL = -2,
48 SVM_FIFO_EEMPTY = -3,
Florin Corasf22f4e52019-12-19 16:10:58 -080049 SVM_FIFO_EGROW = -4,
Florin Coras7fb0fe12018-04-09 09:24:52 -070050} svm_fifo_err_t;
51
Florin Coras88001c62019-04-24 14:44:46 -070052typedef struct svm_fifo_seg_
Florin Coras2cba8532018-09-11 16:33:36 -070053{
54 u8 *data;
55 u32 len;
Florin Coras88001c62019-04-24 14:44:46 -070056} svm_fifo_seg_t;
Florin Coras2cba8532018-09-11 16:33:36 -070057
Florin Coras3eb50622017-07-13 01:24:57 -040058#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
71u8 *svm_fifo_dump_trace (u8 * s, svm_fifo_t * f);
72u8 *svm_fifo_replay (u8 * s, svm_fifo_t * f, u8 no_read, u8 verbose);
73
Florin Coras87b15ce2019-04-28 21:16:30 -070074/**
75 * Load head and tail optimized for consumer
76 *
77 * Internal function.
78 */
Sirshak Das28aa5392019-02-05 01:33:33 -060079static inline void
80f_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
Florin Coras87b15ce2019-04-28 21:16:30 -070088/** Load head and tail optimized for producer
89 *
90 * Internal function
91 */
Sirshak Das28aa5392019-02-05 01:33:33 -060092static inline void
93f_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
Florin Corasa7570b02019-05-02 12:52:19 -0700101/**
102 * Load head and tail independent of producer/consumer role
Florin Coras87b15ce2019-04-28 21:16:30 -0700103 *
104 * Internal function.
105 */
Sirshak Das28aa5392019-02-05 01:33:33 -0600106static inline void
107f_load_head_tail_all_acq (svm_fifo_t * f, u32 * head, u32 * tail)
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
Florin Coras87b15ce2019-04-28 21:16:30 -0700115/**
Florin Coras29a59c32019-05-02 12:52:19 -0700116 * Fifo current size, i.e., number of bytes enqueued
117 *
118 * Internal function.
119 */
120static inline u32
121f_cursize (svm_fifo_t * f, u32 head, u32 tail)
122{
Florin Corasf22f4e52019-12-19 16:10:58 -0800123 return tail - head;
Florin Coras29a59c32019-05-02 12:52:19 -0700124}
125
126/**
127 * Fifo free bytes, i.e., number of free bytes
128 *
129 * Internal function
130 */
131static inline u32
132f_free_count (svm_fifo_t * f, u32 head, u32 tail)
133{
Florin Corasf22f4e52019-12-19 16:10:58 -0800134 return (f->size - f_cursize (f, head, tail));
Florin Coras29a59c32019-05-02 12:52:19 -0700135}
136
Florin Corasf22f4e52019-12-19 16:10:58 -0800137always_inline u32
138f_chunk_end (svm_fifo_chunk_t * c)
139{
140 return c->start_byte + c->length;
141}
142
143always_inline int
144f_pos_lt (u32 a, u32 b)
145{
146 return ((i32) (a - b) < 0);
147}
148
149always_inline int
150f_pos_leq (u32 a, u32 b)
151{
152 return ((i32) (a - b) <= 0);
153}
154
155always_inline int
156f_pos_gt (u32 a, u32 b)
157{
158 return ((i32) (a - b) > 0);
159}
160
161always_inline int
162f_pos_geq (u32 a, u32 b)
163{
164 return ((i32) (a - b) >= 0);
165}
166
167always_inline u8
168f_chunk_includes_pos (svm_fifo_chunk_t * c, u32 pos)
169{
170 return (f_pos_geq (pos, c->start_byte)
171 && f_pos_lt (pos, c->start_byte + c->length));
172}
Florin Corasa7570b02019-05-02 12:52:19 -0700173
174/**
Florin Coras87b15ce2019-04-28 21:16:30 -0700175 * Create fifo of requested size
Florin Coras41c9e042018-09-11 00:10:41 -0700176 *
Florin Coras87b15ce2019-04-28 21:16:30 -0700177 * 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
Florin Coras6792ec02017-03-13 03:49:51 -0700182 */
Florin Corasf22f4e52019-12-19 16:10:58 -0800183svm_fifo_t *svm_fifo_alloc (u32 size);
Florin Coras87b15ce2019-04-28 21:16:30 -0700184/**
185 * Initialize fifo
186 *
Florin Coraseaacce42019-07-02 13:07:37 -0700187 * @param f fifo
Florin Coras87b15ce2019-04-28 21:16:30 -0700188 * @param size size for fifo
189 */
Florin Coras0a846802019-04-09 18:29:14 -0700190void svm_fifo_init (svm_fifo_t * f, u32 size);
Florin Corasb095a3c2019-04-25 12:58:46 -0700191/**
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 */
201svm_fifo_chunk_t *svm_fifo_chunk_alloc (u32 size);
Florin Coras4375fa32019-04-19 15:56:00 -0700202/**
Florin Coras9e61d9a2020-02-05 21:13:18 +0000203 * Ensure the whole fifo size is writeable
Florin Coras4375fa32019-04-19 15:56:00 -0700204 *
Florin Coras9e61d9a2020-02-05 21:13:18 +0000205 * Allocates enough chunks to cover the whole fifo size.
Florin Coras4375fa32019-04-19 15:56:00 -0700206 *
Florin Coras9e61d9a2020-02-05 21:13:18 +0000207 * @param f fifo
Florin Coras4375fa32019-04-19 15:56:00 -0700208 */
Florin Corasf22f4e52019-12-19 16:10:58 -0800209int svm_fifo_fill_chunk_list (svm_fifo_t * f);
Florin Coras9e61d9a2020-02-05 21:13:18 +0000210/**
Florin Coras40a5da82020-12-18 09:19:18 -0800211 * Provision and return chunks for number of bytes requested
212 *
213 * Allocates enough chunks to cover the bytes requested and returns them
214 * in the fifo segment array. The number of bytes provisioned may be less
215 * than requested if not enough segments were provided.
216 *
217 * @param f fifo
218 * @param fs array of fifo segments
219 * @param n_segs length of fifo segments array
220 * @param len number of bytes to preallocate
221 * @return number of fifo segments provisioned or error
222 */
223int svm_fifo_provision_chunks (svm_fifo_t *f, svm_fifo_seg_t *fs, u32 n_segs,
224 u32 len);
225/**
Florin Coras9e61d9a2020-02-05 21:13:18 +0000226 * Initialize rbtrees used for ooo lookups
227 *
228 * @param f fifo
229 * @param ooo_type type of ooo operation (0 enqueue, 1 dequeue)
230 */
Florin Corasf22f4e52019-12-19 16:10:58 -0800231void svm_fifo_init_ooo_lookup (svm_fifo_t * f, u8 ooo_type);
Florin Corasa7570b02019-05-02 12:52:19 -0700232/**
Florin Coras87b15ce2019-04-28 21:16:30 -0700233 * Free fifo and associated state
234 *
235 * @param f fifo
236 */
Florin Coras6cf30ad2017-04-04 23:08:23 -0700237void svm_fifo_free (svm_fifo_t * f);
Florin Corasb095a3c2019-04-25 12:58:46 -0700238/**
239 * Cleanup fifo chunk lookup rb tree
240 *
241 * The rb tree is allocated in segment heap so this should be called
242 * with it pushed.
243 *
244 * @param f fifo to cleanup
245 */
246void svm_fifo_free_chunk_lookup (svm_fifo_t * f);
247/**
248 * Cleanup fifo ooo data
249 *
250 * The ooo data is allocated in producer process memory. The fifo
251 * segment heap should not be pushed.
252 *
253 * @param f fifo to cleanup
254 */
255void svm_fifo_free_ooo_data (svm_fifo_t * f);
Florin Coras87b15ce2019-04-28 21:16:30 -0700256/**
257 * Init fifo head and tail
258 *
259 * @param f fifo
260 * @param head head value that will be matched to a chunk
261 * @param tail tail value that will be matched to a chunk
262 */
263void svm_fifo_init_pointers (svm_fifo_t * f, u32 head, u32 tail);
264/**
265 * Clone fifo
266 *
267 * Clones single/default chunk fifo. It does not work for fifos with
268 * multiple chunks.
269 */
270void svm_fifo_clone (svm_fifo_t * df, svm_fifo_t * sf);
271/**
272 * Enqueue data to fifo
273 *
274 * Data is enqueued and tail pointer is updated atomically. If the new data
275 * enqueued partly overlaps or "touches" an out-of-order segment, said segment
276 * is "consumed" and the number of bytes returned is appropriately updated.
277 *
278 * @param f fifo
279 * @param len length of data to copy
280 * @param src buffer from where to copy the data
281 * @return number of contiguous bytes that can be consumed or error
282 */
283int svm_fifo_enqueue (svm_fifo_t * f, u32 len, const u8 * src);
284/**
285 * Enqueue data to fifo with offset
286 *
287 * Data is enqueued without updating tail pointer. Instead, an out-of-order
288 * list of segments is generated and maintained. Fifo takes care of coalescing
289 * contiguous or overlapping segments.
290 *
291 * @param f fifo
292 * @param offset offset at which to copy the data
293 * @param len len of data to copy
294 * @param src buffer from where to copy the data
295 * @return 0 if enqueue was successful, error otherwise
296 */
297int svm_fifo_enqueue_with_offset (svm_fifo_t * f, u32 offset, u32 len,
298 u8 * src);
Florin Corasa7570b02019-05-02 12:52:19 -0700299
300/**
301 * Advance tail pointer
302 *
303 * Useful for moving tail pointer after external enqueue.
304 *
305 * @param f fifo
306 * @param len number of bytes to add to tail
307 */
308void svm_fifo_enqueue_nocopy (svm_fifo_t * f, u32 len);
Florin Coras87b15ce2019-04-28 21:16:30 -0700309/**
Florin Corasc95cfa22020-11-24 08:41:17 -0800310 * Enqueue array of @ref svm_fifo_seg_t in order
311 *
312 * @param f fifo
313 * @param segs array of segments to enqueue
314 * @param n_segs number of segments
315 * @param allow_partial if set partial enqueues are allowed
316 * @return len if enqueue was successful, error otherwise
317 */
318int svm_fifo_enqueue_segments (svm_fifo_t * f, const svm_fifo_seg_t segs[],
319 u32 n_segs, u8 allow_partial);
320/**
Florin Coras87b15ce2019-04-28 21:16:30 -0700321 * Overwrite fifo head with new data
322 *
323 * This should be typically used by dgram transport protocols that need
Florin Coras97d39e32020-09-04 08:57:27 -0700324 * to update the dgram header after dequeuing a chunk of data. It assumes
Florin Coras87b15ce2019-04-28 21:16:30 -0700325 * that the dgram header is at most spread over two chunks.
326 *
327 * @param f fifo
328 * @param src src of new data
329 * @param len length of new data
330 */
331void svm_fifo_overwrite_head (svm_fifo_t * f, u8 * src, u32 len);
332/**
333 * Dequeue data from fifo
334 *
335 * Data is dequeued to consumer provided buffer and head is atomically
Florin Coras97d39e32020-09-04 08:57:27 -0700336 * updated. This should not be used in combination with ooo lookups. If
337 * ooo peeking of data is needed in combination with dequeuing use @ref
338 * svm_fifo_dequeue_drop.
Florin Coras87b15ce2019-04-28 21:16:30 -0700339 *
340 * @param f fifo
341 * @param len length of data to dequeue
342 * @param dst buffer to where to dequeue the data
343 * @return number of bytes dequeued or error
344 */
345int svm_fifo_dequeue (svm_fifo_t * f, u32 len, u8 * dst);
346/**
347 * Peek data from fifo
348 *
349 * Data is copied from requested offset into provided dst buffer. Head is
350 * not updated.
351 *
352 * @param f fifo
353 * @param offset offset from which to copy the data
354 * @param len length of data to copy
355 * @param dst buffer to where to dequeue the data
356 * @return number of bytes peeked
357 */
358int svm_fifo_peek (svm_fifo_t * f, u32 offset, u32 len, u8 * dst);
359/**
360 * Dequeue and drop bytes from fifo
361 *
362 * Advances fifo head by requested amount of bytes.
363 *
364 * @param f fifo
365 * @param len number of bytes to drop
366 * @return number of bytes dropped
367 */
368int svm_fifo_dequeue_drop (svm_fifo_t * f, u32 len);
369/**
370 * Dequeue and drop all bytes from fifo
371 *
372 * Advances head to tail position.
373 *
374 * @param f fifo
375 */
Florin Coras25579b42018-06-06 17:55:02 -0700376void svm_fifo_dequeue_drop_all (svm_fifo_t * f);
Florin Corasd68faf82020-09-25 15:18:13 -0700377/**
378 * Get pointers to fifo chunks data in @ref svm_fifo_seg_t array
379 *
380 * Populates fifo segment array with pointers to fifo chunk data and lengths.
381 * Because this returns pointers to data, it must be paired with
382 * @ref svm_fifo_dequeue_drop to actually release the fifo chunks after the
383 * data is consumed.
384 *
385 * @param f fifo
Florin Corasd1cc38d2020-10-11 11:05:04 -0700386 * @param offset offset from where to retrieve segments
Florin Corasd68faf82020-09-25 15:18:13 -0700387 * @param fs array of fifo segments allocated by caller
388 * @param n_segs number of fifo segments in array
389 * @param max_bytes max bytes to be mapped to fifo segments
390 * @return number of bytes in fifo segments or SVM_FIFO_EEMPTY
391 */
Florin Corasd1cc38d2020-10-11 11:05:04 -0700392int svm_fifo_segments (svm_fifo_t * f, u32 offset, svm_fifo_seg_t * fs,
393 u32 n_segs, u32 max_bytes);
Florin Coras87b15ce2019-04-28 21:16:30 -0700394/**
395 * Add io events subscriber to list
396 *
397 * @param f fifo
398 * @param sub subscriber opaque index (typically app worker index)
399 */
400void svm_fifo_add_subscriber (svm_fifo_t * f, u8 sub);
401/**
402 * Remove io events subscriber form list
403 *
404 * @param f fifo
405 * @param sub subscriber index to be removed
406 */
Florin Coras72b04282019-01-14 17:23:11 -0800407void svm_fifo_del_subscriber (svm_fifo_t * f, u8 subscriber);
Florin Coras87b15ce2019-04-28 21:16:30 -0700408/**
409 * Number of out-of-order segments for fifo
410 *
411 * @param f fifo
412 * @return number of out of order segments
413 */
414u32 svm_fifo_n_ooo_segments (svm_fifo_t * f);
Florin Coraseaacce42019-07-02 13:07:37 -0700415/**
Florin Coras87b15ce2019-04-28 21:16:30 -0700416 * First out-of-order segment for fifo
417 *
418 * @param f fifo
419 * @return first out-of-order segment for fifo
420 */
421ooo_segment_t *svm_fifo_first_ooo_segment (svm_fifo_t * f);
Florin Coraseaacce42019-07-02 13:07:37 -0700422/**
423 * Check if fifo is sane. Debug only.
424 *
425 * @param f fifo
426 * @return 1 if sane, 0 otherwise
427 */
428u8 svm_fifo_is_sane (svm_fifo_t * f);
Florin Coras9e61d9a2020-02-05 21:13:18 +0000429/**
430 * Number of chunks linked into the fifo
431 *
432 * @param f fifo
433 * @return number of chunks in fifo linked list
434 */
Florin Corasf22f4e52019-12-19 16:10:58 -0800435u32 svm_fifo_n_chunks (svm_fifo_t * f);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700436format_function_t format_svm_fifo;
437
Florin Coras58d36f02018-03-09 13:05:53 -0800438/**
Florin Coras87b15ce2019-04-28 21:16:30 -0700439 * Fifo max bytes to dequeue optimized for consumer
440 *
441 * @param f fifo
442 * @return max number of bytes that can be dequeued
443 */
444static inline u32
445svm_fifo_max_dequeue_cons (svm_fifo_t * f)
446{
447 u32 tail, head;
448 f_load_head_tail_cons (f, &head, &tail);
449 return f_cursize (f, head, tail);
450}
451
452/**
453 * Fifo max bytes to dequeue optimized for producer
454 *
455 * @param f fifo
456 * @return max number of bytes that can be dequeued
457 */
458static inline u32
459svm_fifo_max_dequeue_prod (svm_fifo_t * f)
460{
461 u32 tail, head;
462 f_load_head_tail_prod (f, &head, &tail);
463 return f_cursize (f, head, tail);
464}
465
466/**
467 * Fifo max bytes to dequeue
468 *
469 * Note: use producer or consumer specific functions for performance:
470 * @ref svm_fifo_max_dequeue_cons (svm_fifo_t *f)
471 * @ref svm_fifo_max_dequeue_prod (svm_fifo_t *f)
472 */
473static inline u32
474svm_fifo_max_dequeue (svm_fifo_t * f)
475{
476 u32 tail, head;
477 f_load_head_tail_all_acq (f, &head, &tail);
478 return f_cursize (f, head, tail);
479}
480
481/**
482 * Check if fifo is full optimized for producer
483 *
484 * @param f fifo
485 * @return 1 if fifo is full 0 otherwise
486 */
487static inline int
488svm_fifo_is_full_prod (svm_fifo_t * f)
489{
Florin Corasf22f4e52019-12-19 16:10:58 -0800490 return (svm_fifo_max_dequeue_prod (f) == f->size);
Florin Coras87b15ce2019-04-28 21:16:30 -0700491}
492
493/* Check if fifo is full.
494 *
495 * Note: use producer or consumer specific functions for performance.
496 * @ref svm_fifo_is_full_prod (svm_fifo_t * f)
497 * add cons version if needed
498 */
499static inline int
500svm_fifo_is_full (svm_fifo_t * f)
501{
Florin Corasf22f4e52019-12-19 16:10:58 -0800502 return (svm_fifo_max_dequeue (f) == f->size);
Florin Coras87b15ce2019-04-28 21:16:30 -0700503}
504
505/**
506 * Check if fifo is empty optimized for consumer
507 *
508 * @param f fifo
509 * @return 1 if fifo is empty 0 otherwise
510 */
511static inline int
512svm_fifo_is_empty_cons (svm_fifo_t * f)
513{
514 return (svm_fifo_max_dequeue_cons (f) == 0);
515}
516
517/**
518 * Check if fifo is empty optimized for producer
519 *
520 * @param f fifo
521 * @return 1 if fifo is empty 0 otherwise
522 */
523static inline int
524svm_fifo_is_empty_prod (svm_fifo_t * f)
525{
526 return (svm_fifo_max_dequeue_prod (f) == 0);
527}
528
529/**
530 * Check if fifo is empty
531 *
532 * Note: use producer or consumer specific functions for perfomance.
533 * @ref svm_fifo_is_empty_cons (svm_fifo_t * f)
534 * @ref svm_fifo_is_empty_prod (svm_fifo_t * f)
535 */
536static inline int
537svm_fifo_is_empty (svm_fifo_t * f)
538{
539 return (svm_fifo_max_dequeue (f) == 0);
540}
541
542/**
543 * Check if fifo is wrapped
544 *
545 * @param f fifo
546 * @return 1 if 'normalized' head is ahead of tail
547 */
548static inline u8
549svm_fifo_is_wrapped (svm_fifo_t * f)
550{
551 u32 head, tail;
552 f_load_head_tail_all_acq (f, &head, &tail);
Florin Coras29a59c32019-05-02 12:52:19 -0700553 return head > tail;
Florin Coras87b15ce2019-04-28 21:16:30 -0700554}
555
556/**
557 * Maximum number of bytes that can be enqueued into fifo
558 *
559 * Optimized for producer
560 *
561 * @param f fifo
562 * @return max number of bytes that can be enqueued into fifo
563 */
564static inline u32
565svm_fifo_max_enqueue_prod (svm_fifo_t * f)
566{
567 u32 head, tail;
568 f_load_head_tail_prod (f, &head, &tail);
569 return f_free_count (f, head, tail);
570}
571
572/* Maximum number of bytes that can be enqueued into fifo
573 *
574 * Note: use producer or consumer specific functions for performance.
575 * @ref svm_fifo_max_enqueue_prod (svm_fifo_t *f)
576 * add consumer specific version if needed.
577 */
578static inline u32
579svm_fifo_max_enqueue (svm_fifo_t * f)
580{
581 u32 head, tail;
582 f_load_head_tail_all_acq (f, &head, &tail);
583 return f_free_count (f, head, tail);
584}
585
586/**
Florin Corasf22f4e52019-12-19 16:10:58 -0800587 * Max contiguous chunk of data that can be read.
588 *
589 * Should only be called by consumers.
Florin Coras58d36f02018-03-09 13:05:53 -0800590 */
Florin Corasf22f4e52019-12-19 16:10:58 -0800591u32 svm_fifo_max_read_chunk (svm_fifo_t * f);
Florin Coras58d36f02018-03-09 13:05:53 -0800592
593/**
594 * Max contiguous chunk of data that can be written
Florin Corasf22f4e52019-12-19 16:10:58 -0800595 *
596 * Should only be called by producers
Florin Coras58d36f02018-03-09 13:05:53 -0800597 */
Florin Corasf22f4e52019-12-19 16:10:58 -0800598u32 svm_fifo_max_write_chunk (svm_fifo_t * f);
599
Florin Coras9e61d9a2020-02-05 21:13:18 +0000600/**
601 * Fifo head chunk getter
602 *
603 * @param f fifo
604 * @return head chunk pointer
605 */
Florin Corasf22f4e52019-12-19 16:10:58 -0800606static inline svm_fifo_chunk_t *
607svm_fifo_head_chunk (svm_fifo_t * f)
Florin Coras58d36f02018-03-09 13:05:53 -0800608{
Florin Corasf22f4e52019-12-19 16:10:58 -0800609 return f->head_chunk;
Florin Coras58d36f02018-03-09 13:05:53 -0800610}
611
Florin Coras9e61d9a2020-02-05 21:13:18 +0000612/**
613 * Fifo head pointer getter
614 *
615 * @param f fifo
616 * @return head pointer
617 */
Florin Coras87b15ce2019-04-28 21:16:30 -0700618static inline u8 *
Florin Coras58d36f02018-03-09 13:05:53 -0800619svm_fifo_head (svm_fifo_t * f)
620{
Florin Corasf22f4e52019-12-19 16:10:58 -0800621 if (!f->head_chunk)
622 return 0;
Sirshak Das28aa5392019-02-05 01:33:33 -0600623 /* load-relaxed: consumer owned index */
Florin Coras29a59c32019-05-02 12:52:19 -0700624 return (f->head_chunk->data + (f->head - f->head_chunk->start_byte));
Florin Coras58d36f02018-03-09 13:05:53 -0800625}
626
Florin Coras9e61d9a2020-02-05 21:13:18 +0000627/**
628 * Fifo tail chunk getter
629 *
630 * @param f fifo
631 * @return tail chunk pointer
632 */
Florin Corasf22f4e52019-12-19 16:10:58 -0800633static inline svm_fifo_chunk_t *
634svm_fifo_tail_chunk (svm_fifo_t * f)
635{
636 return f->tail_chunk;
637}
638
Florin Coras9e61d9a2020-02-05 21:13:18 +0000639/**
640 * Fifo tail pointer getter
641 *
642 * @param f fifo
643 * @return tail pointer
644 */
Florin Coras87b15ce2019-04-28 21:16:30 -0700645static inline u8 *
Florin Coras58d36f02018-03-09 13:05:53 -0800646svm_fifo_tail (svm_fifo_t * f)
647{
Sirshak Das28aa5392019-02-05 01:33:33 -0600648 /* load-relaxed: producer owned index */
Florin Coras29a59c32019-05-02 12:52:19 -0700649 return (f->tail_chunk->data + (f->tail - f->tail_chunk->start_byte));
Florin Coras1bcad5c2019-01-09 20:04:38 -0800650}
651
Florin Coras9e61d9a2020-02-05 21:13:18 +0000652/**
653 * Fifo number of subscribers getter
654 *
655 * @param f fifo
656 * @return number of subscribers
657 */
Florin Coras87b15ce2019-04-28 21:16:30 -0700658static inline u8
659svm_fifo_n_subscribers (svm_fifo_t * f)
660{
661 return f->n_subscribers;
662}
663
664/**
665 * Check if fifo has out-of-order data
666 *
667 * @param f fifo
668 * @return 1 if fifo has ooo data, 0 otherwise
669 */
670static inline u8
671svm_fifo_has_ooo_data (svm_fifo_t * f)
672{
673 return f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX;
674}
675
676static inline ooo_segment_t *
677svm_fifo_newest_ooo_segment (svm_fifo_t * f)
678{
679 if (f->ooos_newest == OOO_SEGMENT_INVALID_INDEX)
680 return 0;
681 return pool_elt_at_index (f->ooo_segments, f->ooos_newest);
682}
683
684static inline void
685svm_fifo_newest_ooo_segment_reset (svm_fifo_t * f)
686{
687 f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
688}
689
690static inline u32
691ooo_segment_offset_prod (svm_fifo_t * f, ooo_segment_t * s)
692{
693 u32 tail;
694 /* load-relaxed: producer owned index */
695 tail = f->tail;
696
Florin Corasf22f4e52019-12-19 16:10:58 -0800697 return (s->start - tail);
Florin Coras87b15ce2019-04-28 21:16:30 -0700698}
699
700static inline u32
701ooo_segment_length (svm_fifo_t * f, ooo_segment_t * s)
702{
703 return s->length;
704}
705
Florin Corasf22f4e52019-12-19 16:10:58 -0800706static inline u32
707svm_fifo_size (svm_fifo_t * f)
708{
709 return f->size;
710}
711
712static inline void
713svm_fifo_set_size (svm_fifo_t * f, u32 size)
714{
Florin Coras0e6199d2020-04-17 20:15:22 +0000715 if (size > (1 << f->fs_hdr->max_log2_chunk_size))
716 return;
Florin Coras06d47752020-03-06 02:23:58 +0000717 fsh_virtual_mem_update (f->fs_hdr, f->slice_index, (int) f->size - size);
Florin Corasf22f4e52019-12-19 16:10:58 -0800718 f->size = size;
719}
720
Florin Coras87b15ce2019-04-28 21:16:30 -0700721/**
722 * Check if fifo has io event
723 *
724 * @param f fifo
725 * @return 1 if fifo has event, 0 otherwise
726 */
727static inline int
728svm_fifo_has_event (svm_fifo_t * f)
729{
730 return f->has_event;
731}
732
733/**
734 * Set fifo event flag.
735 *
736 * Forces release semantics.
737 *
738 * @param f fifo
739 * @return 1 if flag was not set, 0 otherwise
740 */
741always_inline u8
742svm_fifo_set_event (svm_fifo_t * f)
743{
744 return !clib_atomic_swap_rel_n (&f->has_event, 1);
745}
746
747/**
748 * Unset fifo event flag.
749 *
750 * Forces acquire semantics
751 *
752 * @param f fifo
753 */
754always_inline void
755svm_fifo_unset_event (svm_fifo_t * f)
756{
757 clib_atomic_swap_acq_n (&f->has_event, 0);
758}
759
760/**
Florin Coras2d379d82019-06-28 12:45:12 -0700761 * Set specific want notification flag
Florin Coras87b15ce2019-04-28 21:16:30 -0700762 *
Florin Coras2d379d82019-06-28 12:45:12 -0700763 * For list of flags see @ref svm_fifo_deq_ntf_t
Florin Coras87b15ce2019-04-28 21:16:30 -0700764 *
765 * @param f fifo
766 * @param ntf_type type of notification requested
767 */
Florin Coras1bcad5c2019-01-09 20:04:38 -0800768static inline void
Florin Coras2d379d82019-06-28 12:45:12 -0700769svm_fifo_add_want_deq_ntf (svm_fifo_t * f, u8 ntf_type)
Florin Coras1bcad5c2019-01-09 20:04:38 -0800770{
Florin Coras2d379d82019-06-28 12:45:12 -0700771 f->want_deq_ntf |= ntf_type;
Florin Coras1bcad5c2019-01-09 20:04:38 -0800772}
773
Florin Coras87b15ce2019-04-28 21:16:30 -0700774/**
Florin Coras2d379d82019-06-28 12:45:12 -0700775 * Clear specific want notification flag
Florin Coras87b15ce2019-04-28 21:16:30 -0700776 *
Florin Coras2d379d82019-06-28 12:45:12 -0700777 * For list of flags see @ref svm_fifo_ntf_t
Florin Coras87b15ce2019-04-28 21:16:30 -0700778 *
779 * @param f fifo
780 * @param ntf_type type of notification to be cleared
781 */
Florin Coras1bcad5c2019-01-09 20:04:38 -0800782static inline void
Florin Coras2d379d82019-06-28 12:45:12 -0700783svm_fifo_del_want_deq_ntf (svm_fifo_t * f, u8 ntf_type)
Florin Coras1bcad5c2019-01-09 20:04:38 -0800784{
Florin Coras2d379d82019-06-28 12:45:12 -0700785 f->want_deq_ntf &= ~ntf_type;
Florin Coras1bcad5c2019-01-09 20:04:38 -0800786}
787
Florin Coras87b15ce2019-04-28 21:16:30 -0700788/**
Florin Coras2d379d82019-06-28 12:45:12 -0700789 * Clear the want notification flag and set has notification
Florin Coras87b15ce2019-04-28 21:16:30 -0700790 *
Florin Coras2d379d82019-06-28 12:45:12 -0700791 * Should be used after enqueuing an event. This clears the
792 * SVM_FIFO_WANT_NOTIF flag but it does not clear
793 * SVM_FIFO_WANT_NOTIF_IF_FULL. If the latter was set, has_ntf is
794 * set to avoid enqueueing events for for all dequeue operations until
Florin Coras87b15ce2019-04-28 21:16:30 -0700795 * it is manually cleared.
796 *
797 * @param f fifo
798 */
Florin Coras1bcad5c2019-01-09 20:04:38 -0800799static inline void
Florin Coras2d379d82019-06-28 12:45:12 -0700800svm_fifo_clear_deq_ntf (svm_fifo_t * f)
Florin Coras1bcad5c2019-01-09 20:04:38 -0800801{
Florin Coras2d379d82019-06-28 12:45:12 -0700802 /* Set the flag if want_notif_if_full was the only ntf requested */
803 f->has_deq_ntf = f->want_deq_ntf == SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL;
804 svm_fifo_del_want_deq_ntf (f, SVM_FIFO_WANT_DEQ_NOTIF);
Florin Coras1bcad5c2019-01-09 20:04:38 -0800805}
806
Florin Coras87b15ce2019-04-28 21:16:30 -0700807/**
Florin Coras2d379d82019-06-28 12:45:12 -0700808 * Clear has notification flag
Florin Coras87b15ce2019-04-28 21:16:30 -0700809 *
Florin Coras2d379d82019-06-28 12:45:12 -0700810 * The fifo generates only one event per SVM_FIFO_WANT_NOTIF_IF_FULL
811 * request and sets has_ntf. To received new events the flag must be
Florin Coras87b15ce2019-04-28 21:16:30 -0700812 * cleared using this function.
813 *
814 * @param f fifo
815 */
Florin Coras1bcad5c2019-01-09 20:04:38 -0800816static inline void
Florin Coras2d379d82019-06-28 12:45:12 -0700817svm_fifo_reset_has_deq_ntf (svm_fifo_t * f)
Florin Coras1bcad5c2019-01-09 20:04:38 -0800818{
Florin Coras2d379d82019-06-28 12:45:12 -0700819 f->has_deq_ntf = 0;
Florin Coras1bcad5c2019-01-09 20:04:38 -0800820}
821
Florin Coras87b15ce2019-04-28 21:16:30 -0700822/**
Florin Coras2d379d82019-06-28 12:45:12 -0700823 * Check if fifo needs dequeue notification
Florin Coras87b15ce2019-04-28 21:16:30 -0700824 *
Florin Coras2d379d82019-06-28 12:45:12 -0700825 * Determines based on notification request flags and state of the fifo if
826 * an event should be generated.
Florin Coras87b15ce2019-04-28 21:16:30 -0700827 *
828 * @param f fifo
829 * @param n_last_deq number of bytes last dequeued
Florin Coras2d379d82019-06-28 12:45:12 -0700830 * @return 1 if event should be generated, 0 otherwise
Florin Coras87b15ce2019-04-28 21:16:30 -0700831 */
Florin Coras1bcad5c2019-01-09 20:04:38 -0800832static inline u8
Florin Coras2d379d82019-06-28 12:45:12 -0700833svm_fifo_needs_deq_ntf (svm_fifo_t * f, u32 n_last_deq)
Florin Coras1bcad5c2019-01-09 20:04:38 -0800834{
Florin Coras2d379d82019-06-28 12:45:12 -0700835 u8 want_ntf = f->want_deq_ntf;
Florin Coras1bcad5c2019-01-09 20:04:38 -0800836
Florin Coras2d379d82019-06-28 12:45:12 -0700837 if (PREDICT_TRUE (want_ntf == SVM_FIFO_NO_DEQ_NOTIF))
Florin Coras1bcad5c2019-01-09 20:04:38 -0800838 return 0;
Florin Coras2d379d82019-06-28 12:45:12 -0700839 else if (want_ntf & SVM_FIFO_WANT_DEQ_NOTIF)
Florin Coras1bcad5c2019-01-09 20:04:38 -0800840 return 1;
Florin Coras2d379d82019-06-28 12:45:12 -0700841 if (want_ntf & SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL)
Florin Coras1bcad5c2019-01-09 20:04:38 -0800842 {
Sirshak Das28aa5392019-02-05 01:33:33 -0600843 u32 max_deq = svm_fifo_max_dequeue_cons (f);
Florin Corasf22f4e52019-12-19 16:10:58 -0800844 u32 size = f->size;
845 if (!f->has_deq_ntf && max_deq < size && max_deq + n_last_deq >= size)
Florin Coras1bcad5c2019-01-09 20:04:38 -0800846 return 1;
Nathan Skrzypczake82a7ad2019-05-22 18:41:50 +0200847 }
Florin Coras2d379d82019-06-28 12:45:12 -0700848 if (want_ntf & SVM_FIFO_WANT_DEQ_NOTIF_IF_EMPTY)
Nathan Skrzypczake82a7ad2019-05-22 18:41:50 +0200849 {
Florin Coras2d379d82019-06-28 12:45:12 -0700850 if (!f->has_deq_ntf && svm_fifo_is_empty (f))
Nathan Skrzypczake82a7ad2019-05-22 18:41:50 +0200851 return 1;
Florin Coras1bcad5c2019-01-09 20:04:38 -0800852 }
853 return 0;
854}
855
Dave Barach68b0fb02017-02-28 15:15:56 -0500856#endif /* __included_ssvm_fifo_h__ */
857
858/*
859 * fd.io coding-style-patch-verification: ON
860 *
861 * Local Variables:
862 * eval: (c-set-style "gnu")
863 * End:
864 */