diff options
author | Florin Coras <fcoras@cisco.com> | 2020-09-25 15:18:13 -0700 |
---|---|---|
committer | Damjan Marion <dmarion@me.com> | 2020-09-29 09:02:48 +0000 |
commit | d68faf8559da72aa6ad0526d5a86fb16587b1508 (patch) | |
tree | 8438ccf4ef312017465f073e5b7086abdd094cf3 /src/svm/svm_fifo.h | |
parent | a880b276d9998fa06c92355c4144fe3ca574c915 (diff) |
vcl svm: provide apps access to fifo chunks
Type: feature
Signed-off-by: Florin Coras <fcoras@cisco.com>
Change-Id: I2191b8594b1e87ecc00f237316457db249f73603
Diffstat (limited to 'src/svm/svm_fifo.h')
-rw-r--r-- | src/svm/svm_fifo.h | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/src/svm/svm_fifo.h b/src/svm/svm_fifo.h index f7503c8e900..93ef006fd48 100644 --- a/src/svm/svm_fifo.h +++ b/src/svm/svm_fifo.h @@ -348,8 +348,22 @@ int svm_fifo_dequeue_drop (svm_fifo_t * f, u32 len); * @param f fifo */ void svm_fifo_dequeue_drop_all (svm_fifo_t * f); -int svm_fifo_segments (svm_fifo_t * f, svm_fifo_seg_t * fs); -void svm_fifo_segments_free (svm_fifo_t * f, svm_fifo_seg_t * fs); +/** + * Get pointers to fifo chunks data in @ref svm_fifo_seg_t array + * + * Populates fifo segment array with pointers to fifo chunk data and lengths. + * Because this returns pointers to data, it must be paired with + * @ref svm_fifo_dequeue_drop to actually release the fifo chunks after the + * data is consumed. + * + * @param f fifo + * @param fs array of fifo segments allocated by caller + * @param n_segs number of fifo segments in array + * @param max_bytes max bytes to be mapped to fifo segments + * @return number of bytes in fifo segments or SVM_FIFO_EEMPTY + */ +int svm_fifo_segments (svm_fifo_t * f, svm_fifo_seg_t * fs, u32 n_segs, + u32 max_bytes); /** * Add io events subscriber to list * |