blob: 0c08dba7aa20dfe0e6dd89c3fefa94108d44b766 [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
Florin Coras6792ec02017-03-13 03:49:51 -070020#include <svm/svm_fifo.h>
Florin Corasf22f4e52019-12-19 16:10:58 -080021#include <svm/fifo_segment.h>
Florin Corasf6359c82017-06-19 12:26:09 -040022#include <vppinfra/cpu.h>
Dave Barach68b0fb02017-02-28 15:15:56 -050023
Florin Coras99ad2fc2019-04-18 21:25:49 -070024CLIB_MARCH_FN (svm_fifo_copy_to_chunk, void, svm_fifo_t * f,
25 svm_fifo_chunk_t * c, u32 tail_idx, const u8 * src, u32 len,
Florin Coras4375fa32019-04-19 15:56:00 -070026 svm_fifo_chunk_t ** last)
Florin Coras99ad2fc2019-04-18 21:25:49 -070027{
28 u32 n_chunk;
29
Florin Corasf22f4e52019-12-19 16:10:58 -080030 ASSERT (f_pos_geq (tail_idx, c->start_byte)
31 && f_pos_lt (tail_idx, c->start_byte + c->length));
Florin Coras99ad2fc2019-04-18 21:25:49 -070032
33 tail_idx -= c->start_byte;
34 n_chunk = c->length - tail_idx;
Florin Coras4375fa32019-04-19 15:56:00 -070035 if (n_chunk <= len)
Florin Coras99ad2fc2019-04-18 21:25:49 -070036 {
37 u32 to_copy = len;
38 clib_memcpy_fast (&c->data[tail_idx], src, n_chunk);
Florin Coras4375fa32019-04-19 15:56:00 -070039 c = c->next;
Florin Coras99ad2fc2019-04-18 21:25:49 -070040 while ((to_copy -= n_chunk))
41 {
Florin Coras99ad2fc2019-04-18 21:25:49 -070042 n_chunk = clib_min (c->length, to_copy);
43 clib_memcpy_fast (&c->data[0], src + (len - to_copy), n_chunk);
Florin Coras4375fa32019-04-19 15:56:00 -070044 c = c->length <= to_copy ? c->next : c;
Florin Coras99ad2fc2019-04-18 21:25:49 -070045 }
Florin Coras4375fa32019-04-19 15:56:00 -070046 if (*last)
47 *last = c;
Florin Coras99ad2fc2019-04-18 21:25:49 -070048 }
49 else
50 {
51 clib_memcpy_fast (&c->data[tail_idx], src, len);
52 }
53}
54
55CLIB_MARCH_FN (svm_fifo_copy_from_chunk, void, svm_fifo_t * f,
56 svm_fifo_chunk_t * c, u32 head_idx, u8 * dst, u32 len,
Florin Coras4375fa32019-04-19 15:56:00 -070057 svm_fifo_chunk_t ** last)
Florin Coras99ad2fc2019-04-18 21:25:49 -070058{
59 u32 n_chunk;
60
Florin Corasf22f4e52019-12-19 16:10:58 -080061 ASSERT (f_pos_geq (head_idx, c->start_byte)
62 && f_pos_lt (head_idx, c->start_byte + c->length));
Florin Coras4375fa32019-04-19 15:56:00 -070063
Florin Coras99ad2fc2019-04-18 21:25:49 -070064 head_idx -= c->start_byte;
65 n_chunk = c->length - head_idx;
Florin Coras4375fa32019-04-19 15:56:00 -070066 if (n_chunk <= len)
Florin Coras99ad2fc2019-04-18 21:25:49 -070067 {
68 u32 to_copy = len;
69 clib_memcpy_fast (dst, &c->data[head_idx], n_chunk);
Florin Coras4375fa32019-04-19 15:56:00 -070070 c = c->next;
Florin Coras99ad2fc2019-04-18 21:25:49 -070071 while ((to_copy -= n_chunk))
72 {
BenoƮt Gannedf601ae2020-10-20 14:31:55 +020073 CLIB_MEM_UNPOISON (c, sizeof (*c));
74 CLIB_MEM_UNPOISON (c->data, c->length);
Florin Coras99ad2fc2019-04-18 21:25:49 -070075 n_chunk = clib_min (c->length, to_copy);
76 clib_memcpy_fast (dst + (len - to_copy), &c->data[0], n_chunk);
Florin Coras4375fa32019-04-19 15:56:00 -070077 c = c->length <= to_copy ? c->next : c;
Florin Coras99ad2fc2019-04-18 21:25:49 -070078 }
Florin Coras4375fa32019-04-19 15:56:00 -070079 if (*last)
80 *last = c;
Florin Coras99ad2fc2019-04-18 21:25:49 -070081 }
82 else
83 {
84 clib_memcpy_fast (dst, &c->data[head_idx], len);
85 }
86}
87
88#ifndef CLIB_MARCH_VARIANT
89
90static inline void
91svm_fifo_copy_to_chunk (svm_fifo_t * f, svm_fifo_chunk_t * c, u32 tail_idx,
Florin Coras4375fa32019-04-19 15:56:00 -070092 const u8 * src, u32 len, svm_fifo_chunk_t ** last)
Florin Coras99ad2fc2019-04-18 21:25:49 -070093{
94 CLIB_MARCH_FN_SELECT (svm_fifo_copy_to_chunk) (f, c, tail_idx, src, len,
Florin Coras4375fa32019-04-19 15:56:00 -070095 last);
Florin Coras99ad2fc2019-04-18 21:25:49 -070096}
97
98static inline void
99svm_fifo_copy_from_chunk (svm_fifo_t * f, svm_fifo_chunk_t * c, u32 head_idx,
Florin Coras4375fa32019-04-19 15:56:00 -0700100 u8 * dst, u32 len, svm_fifo_chunk_t ** last)
Florin Coras99ad2fc2019-04-18 21:25:49 -0700101{
102 CLIB_MARCH_FN_SELECT (svm_fifo_copy_from_chunk) (f, c, head_idx, dst, len,
Florin Coras4375fa32019-04-19 15:56:00 -0700103 last);
Florin Coras99ad2fc2019-04-18 21:25:49 -0700104}
105
Florin Corasf03a59a2017-06-09 21:07:32 -0700106static inline u32
Florin Corasf22f4e52019-12-19 16:10:58 -0800107ooo_segment_end_pos (ooo_segment_t * s)
Florin Corasf03a59a2017-06-09 21:07:32 -0700108{
Florin Corasf22f4e52019-12-19 16:10:58 -0800109 return (s->start + s->length);
Florin Corasf03a59a2017-06-09 21:07:32 -0700110}
Dave Barach1f75cfd2017-04-14 16:46:44 -0400111
Florin Coras87b15ce2019-04-28 21:16:30 -0700112void
113svm_fifo_free_ooo_data (svm_fifo_t * f)
Dave Barach1f75cfd2017-04-14 16:46:44 -0400114{
Florin Coras87b15ce2019-04-28 21:16:30 -0700115 pool_free (f->ooo_segments);
116}
117
118static inline ooo_segment_t *
Florin Corasa7570b02019-05-02 12:52:19 -0700119ooo_segment_prev (svm_fifo_t * f, ooo_segment_t * s)
Florin Coras87b15ce2019-04-28 21:16:30 -0700120{
121 if (s->prev == OOO_SEGMENT_INVALID_INDEX)
122 return 0;
123 return pool_elt_at_index (f->ooo_segments, s->prev);
124}
125
126static inline ooo_segment_t *
127ooo_segment_next (svm_fifo_t * f, ooo_segment_t * s)
128{
129 if (s->next == OOO_SEGMENT_INVALID_INDEX)
130 return 0;
131 return pool_elt_at_index (f->ooo_segments, s->next);
132}
133
134static inline ooo_segment_t *
135ooo_segment_alloc (svm_fifo_t * f, u32 start, u32 length)
136{
137 ooo_segment_t *s;
138
139 pool_get (f->ooo_segments, s);
140
141 s->start = start;
142 s->length = length;
143 s->prev = s->next = OOO_SEGMENT_INVALID_INDEX;
144
Dave Barach1f75cfd2017-04-14 16:46:44 -0400145 return s;
146}
147
Florin Coras87b15ce2019-04-28 21:16:30 -0700148static inline void
149ooo_segment_free (svm_fifo_t * f, u32 index)
Florin Coras3eb50622017-07-13 01:24:57 -0400150{
Florin Coras87b15ce2019-04-28 21:16:30 -0700151 ooo_segment_t *cur, *prev = 0, *next = 0;
152 cur = pool_elt_at_index (f->ooo_segments, index);
Florin Coras3eb50622017-07-13 01:24:57 -0400153
Florin Coras87b15ce2019-04-28 21:16:30 -0700154 if (cur->next != OOO_SEGMENT_INVALID_INDEX)
Florin Coras3eb50622017-07-13 01:24:57 -0400155 {
Florin Coras87b15ce2019-04-28 21:16:30 -0700156 next = pool_elt_at_index (f->ooo_segments, cur->next);
157 next->prev = cur->prev;
Florin Coras3eb50622017-07-13 01:24:57 -0400158 }
Florin Coras87b15ce2019-04-28 21:16:30 -0700159
160 if (cur->prev != OOO_SEGMENT_INVALID_INDEX)
161 {
162 prev = pool_elt_at_index (f->ooo_segments, cur->prev);
163 prev->next = cur->next;
164 }
165 else
166 {
167 f->ooos_list_head = cur->next;
168 }
169
170 pool_put (f->ooo_segments, cur);
Florin Coras3eb50622017-07-13 01:24:57 -0400171}
172
Florin Coras87b15ce2019-04-28 21:16:30 -0700173/**
174 * Add segment to fifo's out-of-order segment list. Takes care of merging
175 * adjacent segments and removing overlapping ones.
176 */
177static void
178ooo_segment_add (svm_fifo_t * f, u32 offset, u32 head, u32 tail, u32 length)
Florin Coras3eb50622017-07-13 01:24:57 -0400179{
Florin Coras87b15ce2019-04-28 21:16:30 -0700180 ooo_segment_t *s, *new_s, *prev, *next, *it;
181 u32 new_index, s_end_pos, s_index;
182 u32 offset_pos, offset_end_pos;
Florin Coras3eb50622017-07-13 01:24:57 -0400183
Florin Corasf22f4e52019-12-19 16:10:58 -0800184 ASSERT (offset + length <= f_free_count (f, head, tail));
Florin Coras3eb50622017-07-13 01:24:57 -0400185
Florin Corasf22f4e52019-12-19 16:10:58 -0800186 offset_pos = tail + offset;
187 offset_end_pos = tail + offset + length;
Florin Coras3eb50622017-07-13 01:24:57 -0400188
Florin Coras87b15ce2019-04-28 21:16:30 -0700189 f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
Florin Coras3eb50622017-07-13 01:24:57 -0400190
Florin Coras87b15ce2019-04-28 21:16:30 -0700191 if (f->ooos_list_head == OOO_SEGMENT_INVALID_INDEX)
Florin Coras3eb50622017-07-13 01:24:57 -0400192 {
Florin Coras87b15ce2019-04-28 21:16:30 -0700193 s = ooo_segment_alloc (f, offset_pos, length);
194 f->ooos_list_head = s - f->ooo_segments;
195 f->ooos_newest = f->ooos_list_head;
196 return;
197 }
198
199 /* Find first segment that starts after new segment */
200 s = pool_elt_at_index (f->ooo_segments, f->ooos_list_head);
201 while (s->next != OOO_SEGMENT_INVALID_INDEX
Florin Corasf22f4e52019-12-19 16:10:58 -0800202 && f_pos_lt (s->start, offset_pos))
Florin Coras87b15ce2019-04-28 21:16:30 -0700203 s = pool_elt_at_index (f->ooo_segments, s->next);
204
205 /* If we have a previous and we overlap it, use it as starting point */
Florin Corasa7570b02019-05-02 12:52:19 -0700206 prev = ooo_segment_prev (f, s);
Florin Corasf22f4e52019-12-19 16:10:58 -0800207 if (prev && f_pos_leq (offset_pos, ooo_segment_end_pos (prev)))
Florin Coras87b15ce2019-04-28 21:16:30 -0700208 {
209 s = prev;
Florin Corasf22f4e52019-12-19 16:10:58 -0800210 s_end_pos = ooo_segment_end_pos (s);
Florin Coras87b15ce2019-04-28 21:16:30 -0700211
212 /* Since we have previous, offset start position cannot be smaller
213 * than prev->start. Check tail */
Florin Corasf22f4e52019-12-19 16:10:58 -0800214 ASSERT (f_pos_lt (s->start, offset_pos));
Florin Coras87b15ce2019-04-28 21:16:30 -0700215 goto check_tail;
216 }
217
218 s_index = s - f->ooo_segments;
Florin Corasf22f4e52019-12-19 16:10:58 -0800219 s_end_pos = ooo_segment_end_pos (s);
Florin Coras87b15ce2019-04-28 21:16:30 -0700220
221 /* No overlap, add before current segment */
Florin Corasf22f4e52019-12-19 16:10:58 -0800222 if (f_pos_lt (offset_end_pos, s->start))
Florin Coras87b15ce2019-04-28 21:16:30 -0700223 {
224 new_s = ooo_segment_alloc (f, offset_pos, length);
225 new_index = new_s - f->ooo_segments;
226
227 /* Pool might've moved, get segment again */
228 s = pool_elt_at_index (f->ooo_segments, s_index);
229 if (s->prev != OOO_SEGMENT_INVALID_INDEX)
Florin Coras3eb50622017-07-13 01:24:57 -0400230 {
Florin Coras87b15ce2019-04-28 21:16:30 -0700231 new_s->prev = s->prev;
232 prev = pool_elt_at_index (f->ooo_segments, new_s->prev);
233 prev->next = new_index;
Florin Coras3eb50622017-07-13 01:24:57 -0400234 }
Florin Coras87b15ce2019-04-28 21:16:30 -0700235 else
Florin Coras3eb50622017-07-13 01:24:57 -0400236 {
Florin Coras87b15ce2019-04-28 21:16:30 -0700237 /* New head */
238 f->ooos_list_head = new_index;
Florin Coras3eb50622017-07-13 01:24:57 -0400239 }
Florin Coras87b15ce2019-04-28 21:16:30 -0700240
241 new_s->next = s_index;
242 s->prev = new_index;
243 f->ooos_newest = new_index;
244 return;
245 }
246 /* No overlap, add after current segment */
Florin Corasf22f4e52019-12-19 16:10:58 -0800247 else if (f_pos_gt (offset_pos, s_end_pos))
Florin Coras87b15ce2019-04-28 21:16:30 -0700248 {
249 new_s = ooo_segment_alloc (f, offset_pos, length);
250 new_index = new_s - f->ooo_segments;
251
252 /* Pool might've moved, get segment again */
253 s = pool_elt_at_index (f->ooo_segments, s_index);
254
255 /* Needs to be last */
256 ASSERT (s->next == OOO_SEGMENT_INVALID_INDEX);
257
258 new_s->prev = s_index;
259 s->next = new_index;
260 f->ooos_newest = new_index;
261
262 return;
Florin Coras3eb50622017-07-13 01:24:57 -0400263 }
264
Florin Coras87b15ce2019-04-28 21:16:30 -0700265 /*
266 * Merge needed
267 */
Florin Coras3eb50622017-07-13 01:24:57 -0400268
Florin Coras87b15ce2019-04-28 21:16:30 -0700269 /* Merge at head */
Florin Corasf22f4e52019-12-19 16:10:58 -0800270 if (f_pos_lt (offset_pos, s->start))
Florin Coras87b15ce2019-04-28 21:16:30 -0700271 {
272 s->start = offset_pos;
Florin Corasf22f4e52019-12-19 16:10:58 -0800273 s->length = s_end_pos - s->start;
Florin Coras87b15ce2019-04-28 21:16:30 -0700274 f->ooos_newest = s - f->ooo_segments;
275 }
276
277check_tail:
278
279 /* Overlapping tail */
Florin Corasf22f4e52019-12-19 16:10:58 -0800280 if (f_pos_gt (offset_end_pos, s_end_pos))
Florin Coras87b15ce2019-04-28 21:16:30 -0700281 {
Florin Corasf22f4e52019-12-19 16:10:58 -0800282 s->length = offset_end_pos - s->start;
Florin Coras87b15ce2019-04-28 21:16:30 -0700283
284 /* Remove the completely overlapped segments in the tail */
285 it = ooo_segment_next (f, s);
Florin Corasf22f4e52019-12-19 16:10:58 -0800286 while (it && f_pos_leq (ooo_segment_end_pos (it), offset_end_pos))
Florin Coras87b15ce2019-04-28 21:16:30 -0700287 {
288 next = ooo_segment_next (f, it);
289 ooo_segment_free (f, it - f->ooo_segments);
290 it = next;
291 }
292
293 /* If partial overlap with last, merge */
Florin Corasf22f4e52019-12-19 16:10:58 -0800294 if (it && f_pos_leq (it->start, offset_end_pos))
Florin Coras87b15ce2019-04-28 21:16:30 -0700295 {
Florin Corasf22f4e52019-12-19 16:10:58 -0800296 s->length = ooo_segment_end_pos (it) - s->start;
Florin Coras87b15ce2019-04-28 21:16:30 -0700297 ooo_segment_free (f, it - f->ooo_segments);
298 }
299 f->ooos_newest = s - f->ooo_segments;
300 }
Florin Coras3eb50622017-07-13 01:24:57 -0400301}
302
Florin Coras87b15ce2019-04-28 21:16:30 -0700303/**
304 * Removes segments that can now be enqueued because the fifo's tail has
305 * advanced. Returns the number of bytes added to tail.
306 */
307static int
308ooo_segment_try_collect (svm_fifo_t * f, u32 n_bytes_enqueued, u32 * tail)
Dave Barach1f75cfd2017-04-14 16:46:44 -0400309{
Florin Coras87b15ce2019-04-28 21:16:30 -0700310 u32 s_index, bytes = 0;
311 ooo_segment_t *s;
312 i32 diff;
Dave Barach1f75cfd2017-04-14 16:46:44 -0400313
Florin Coras87b15ce2019-04-28 21:16:30 -0700314 s = pool_elt_at_index (f->ooo_segments, f->ooos_list_head);
Florin Corasf22f4e52019-12-19 16:10:58 -0800315 diff = *tail - s->start;
Florin Coras87b15ce2019-04-28 21:16:30 -0700316
317 ASSERT (diff != n_bytes_enqueued);
318
319 if (diff > n_bytes_enqueued)
320 return 0;
321
322 /* If last tail update overlaps one/multiple ooo segments, remove them */
323 while (0 <= diff && diff < n_bytes_enqueued)
Dave Barach1f75cfd2017-04-14 16:46:44 -0400324 {
Florin Coras87b15ce2019-04-28 21:16:30 -0700325 s_index = s - f->ooo_segments;
326
327 /* Segment end is beyond the tail. Advance tail and remove segment */
328 if (s->length > diff)
329 {
330 bytes = s->length - diff;
Florin Corasf22f4e52019-12-19 16:10:58 -0800331 *tail = *tail + bytes;
Florin Coras87b15ce2019-04-28 21:16:30 -0700332 ooo_segment_free (f, s_index);
333 break;
334 }
335
336 /* If we have next go on */
337 if (s->next != OOO_SEGMENT_INVALID_INDEX)
338 {
339 s = pool_elt_at_index (f->ooo_segments, s->next);
Florin Corasf22f4e52019-12-19 16:10:58 -0800340 diff = *tail - s->start;
Florin Coras87b15ce2019-04-28 21:16:30 -0700341 ooo_segment_free (f, s_index);
342 }
343 /* End of search */
344 else
345 {
346 ooo_segment_free (f, s_index);
347 break;
348 }
Dave Barach1f75cfd2017-04-14 16:46:44 -0400349 }
Florin Coras3eb50622017-07-13 01:24:57 -0400350
Florin Corasf22f4e52019-12-19 16:10:58 -0800351 ASSERT (bytes <= f->size);
Florin Coras87b15ce2019-04-28 21:16:30 -0700352 return bytes;
Florin Corasb59a7052017-04-18 22:07:29 -0700353}
354
Florin Corasf22f4e52019-12-19 16:10:58 -0800355__clib_unused static ooo_segment_t *
Florin Corasa7570b02019-05-02 12:52:19 -0700356ooo_segment_last (svm_fifo_t * f)
357{
358 ooo_segment_t *s;
359
360 if (f->ooos_list_head == OOO_SEGMENT_INVALID_INDEX)
361 return 0;
362
363 s = svm_fifo_first_ooo_segment (f);
364 while (s->next != OOO_SEGMENT_INVALID_INDEX)
365 s = pool_elt_at_index (f->ooo_segments, s->next);
366 return s;
367}
368
Florin Coras0a846802019-04-09 18:29:14 -0700369void
370svm_fifo_init (svm_fifo_t * f, u32 size)
371{
Florin Corasf22f4e52019-12-19 16:10:58 -0800372 svm_fifo_chunk_t *c, *prev;
Florin Coras2de9c0f2020-02-02 19:30:39 +0000373 u32 min_alloc;
Florin Corasf22f4e52019-12-19 16:10:58 -0800374
Florin Coras0a846802019-04-09 18:29:14 -0700375 f->size = size;
Florin Coras0a846802019-04-09 18:29:14 -0700376 f->ooos_list_head = OOO_SEGMENT_INVALID_INDEX;
Florin Coras0a846802019-04-09 18:29:14 -0700377 f->segment_index = SVM_FIFO_INVALID_INDEX;
378 f->refcnt = 1;
Florin Coras73cad332019-08-28 17:12:32 -0700379 f->head = f->tail = f->flags = 0;
Florin Corasf22f4e52019-12-19 16:10:58 -0800380 f->head_chunk = f->tail_chunk = f->start_chunk;
381 f->ooo_deq = f->ooo_enq = 0;
Florin Coras0a846802019-04-09 18:29:14 -0700382
Florin Coras2de9c0f2020-02-02 19:30:39 +0000383 min_alloc = size > 32 << 10 ? size >> 3 : 4096;
384 min_alloc = clib_min (min_alloc, 64 << 10);
Florin Corasf22f4e52019-12-19 16:10:58 -0800385 f->min_alloc = min_alloc;
Florin Coraseaacce42019-07-02 13:07:37 -0700386
Florin Corasf22f4e52019-12-19 16:10:58 -0800387 /*
388 * Initialize chunks
389 */
Florin Coraseaacce42019-07-02 13:07:37 -0700390 f->start_chunk->start_byte = 0;
391 prev = f->start_chunk;
Florin Coras91b36402020-11-17 15:56:38 -0800392 prev->enq_rb_index = prev->deq_rb_index = RBTREE_TNIL_INDEX;
Florin Coraseaacce42019-07-02 13:07:37 -0700393 c = prev->next;
394
Florin Corasf22f4e52019-12-19 16:10:58 -0800395 while (c)
Florin Coraseaacce42019-07-02 13:07:37 -0700396 {
397 c->start_byte = prev->start_byte + prev->length;
Florin Coras91b36402020-11-17 15:56:38 -0800398 c->enq_rb_index = c->deq_rb_index = RBTREE_TNIL_INDEX;
Florin Coraseaacce42019-07-02 13:07:37 -0700399 prev = c;
400 c = c->next;
401 }
402}
403
Florin Corasf22f4e52019-12-19 16:10:58 -0800404void
405svm_fifo_init_ooo_lookup (svm_fifo_t * f, u8 ooo_type)
406{
407 if (ooo_type == 0)
408 {
409 ASSERT (!rb_tree_is_init (&f->ooo_enq_lookup));
410 rb_tree_init (&f->ooo_enq_lookup);
411 }
412 else
413 {
414 ASSERT (!rb_tree_is_init (&f->ooo_deq_lookup));
415 rb_tree_init (&f->ooo_deq_lookup);
416 }
417}
418
Florin Corasb095a3c2019-04-25 12:58:46 -0700419/**
420 * Creates a fifo in the current heap. Fails vs blow up the process
421 */
Dave Barach68b0fb02017-02-28 15:15:56 -0500422svm_fifo_t *
Florin Corasf22f4e52019-12-19 16:10:58 -0800423svm_fifo_alloc (u32 data_size_in_bytes)
Dave Barach68b0fb02017-02-28 15:15:56 -0500424{
Dave Barach818eb542017-08-02 13:56:13 -0400425 u32 rounded_data_size;
Florin Corascefd5d82019-05-05 13:19:57 -0700426 svm_fifo_chunk_t *c;
427 svm_fifo_t *f;
Dave Barach68b0fb02017-02-28 15:15:56 -0500428
Florin Corascefd5d82019-05-05 13:19:57 -0700429 f = clib_mem_alloc_aligned_or_null (sizeof (*f), CLIB_CACHE_LINE_BYTES);
Dave Barach68b0fb02017-02-28 15:15:56 -0500430 if (f == 0)
431 return 0;
432
Dave Barachb7b92992018-10-17 10:38:51 -0400433 clib_memset (f, 0, sizeof (*f));
Florin Corascefd5d82019-05-05 13:19:57 -0700434
435 /* always round fifo data size to the next highest power-of-two */
436 rounded_data_size = (1 << (max_log2 (data_size_in_bytes)));
437 c = clib_mem_alloc_aligned_or_null (sizeof (*c) + rounded_data_size,
438 CLIB_CACHE_LINE_BYTES);
439 if (!c)
440 {
441 clib_mem_free (f);
442 return 0;
443 }
444
Florin Corasf22f4e52019-12-19 16:10:58 -0800445 clib_memset (c, 0, sizeof (*c));
Florin Corascefd5d82019-05-05 13:19:57 -0700446 c->start_byte = 0;
447 c->length = data_size_in_bytes;
Florin Corasf22f4e52019-12-19 16:10:58 -0800448 c->enq_rb_index = RBTREE_TNIL_INDEX;
449 c->deq_rb_index = RBTREE_TNIL_INDEX;
Florin Corascefd5d82019-05-05 13:19:57 -0700450 f->start_chunk = f->end_chunk = c;
451
Florin Coras0a846802019-04-09 18:29:14 -0700452 return f;
Dave Barach68b0fb02017-02-28 15:15:56 -0500453}
454
Florin Corasb095a3c2019-04-25 12:58:46 -0700455/**
456 * Creates a fifo chunk in the current heap
457 */
458svm_fifo_chunk_t *
459svm_fifo_chunk_alloc (u32 size)
460{
461 svm_fifo_chunk_t *c;
462 u32 rounded_size;
463
464 /* round chunk size to the next highest power-of-two */
465 rounded_size = (1 << (max_log2 (size)));
466 c = clib_mem_alloc_aligned_or_null (sizeof (*c) + rounded_size,
467 CLIB_CACHE_LINE_BYTES);
468 if (c == 0)
469 return 0;
470
471 clib_memset (c, 0, sizeof (*c));
472 c->length = rounded_size;
473 return c;
474}
475
Florin Corasf22f4e52019-12-19 16:10:58 -0800476/**
477 * Find chunk for given byte position
478 *
479 * @param f fifo
480 * @param pos normalized position in fifo
481 *
482 * @return chunk that includes given position or 0
483 */
484static svm_fifo_chunk_t *
485svm_fifo_find_chunk (svm_fifo_t * f, u32 pos)
Florin Coras4375fa32019-04-19 15:56:00 -0700486{
Florin Corasf22f4e52019-12-19 16:10:58 -0800487 svm_fifo_chunk_t *c;
488
489 c = f->start_chunk;
490 while (c && !f_chunk_includes_pos (c, pos))
491 c = c->next;
492
493 return c;
494}
495
496static svm_fifo_chunk_t *
497svm_fifo_find_next_chunk (svm_fifo_t * f, svm_fifo_chunk_t * start, u32 pos)
498{
499 svm_fifo_chunk_t *c;
500
501 ASSERT (start != 0);
502
503 c = start;
504 while (c && !f_chunk_includes_pos (c, pos))
505 c = c->next;
506
507 return c;
508}
509
510u32
511svm_fifo_max_read_chunk (svm_fifo_t * f)
512{
513 u32 head, tail, end_chunk;
514
515 f_load_head_tail_cons (f, &head, &tail);
516 ASSERT (!f->head_chunk || f_chunk_includes_pos (f->head_chunk, head));
517
518 if (!f->head_chunk)
519 {
520 f->head_chunk = svm_fifo_find_chunk (f, head);
521 if (PREDICT_FALSE (!f->head_chunk))
522 return 0;
523 }
524
525 end_chunk = f_chunk_end (f->head_chunk);
526
527 return f_pos_lt (end_chunk, tail) ? end_chunk - head : tail - head;
528}
529
530u32
531svm_fifo_max_write_chunk (svm_fifo_t * f)
532{
533 u32 head, tail;
534
535 f_load_head_tail_prod (f, &head, &tail);
536 ASSERT (!f->tail_chunk || f_chunk_includes_pos (f->tail_chunk, tail));
537
538 return f->tail_chunk ? f_chunk_end (f->tail_chunk) - tail : 0;
Florin Coras4375fa32019-04-19 15:56:00 -0700539}
540
Florin Corasb0208062019-12-12 12:09:29 -0800541static rb_node_t *
Florin Corasf22f4e52019-12-19 16:10:58 -0800542f_find_node_rbtree (rb_tree_t * rt, u32 pos)
Florin Corasb0208062019-12-12 12:09:29 -0800543{
544 rb_node_t *cur, *prev;
545
546 cur = rb_node (rt, rt->root);
547 if (PREDICT_FALSE (rb_node_is_tnil (rt, cur)))
548 return 0;
549
550 while (pos != cur->key)
551 {
552 prev = cur;
Florin Corasf22f4e52019-12-19 16:10:58 -0800553 if (f_pos_lt (pos, cur->key))
Florin Corasb0208062019-12-12 12:09:29 -0800554 {
555 cur = rb_node_left (rt, cur);
556 if (rb_node_is_tnil (rt, cur))
557 {
558 cur = rb_tree_predecessor (rt, prev);
559 break;
560 }
561 }
562 else
563 {
564 cur = rb_node_right (rt, cur);
565 if (rb_node_is_tnil (rt, cur))
566 {
567 cur = prev;
568 break;
569 }
570 }
571 }
572
573 if (rb_node_is_tnil (rt, cur))
574 return 0;
575
576 return cur;
577}
578
579static svm_fifo_chunk_t *
Florin Corasf22f4e52019-12-19 16:10:58 -0800580f_find_chunk_rbtree (rb_tree_t * rt, u32 pos)
Florin Corasb0208062019-12-12 12:09:29 -0800581{
582 svm_fifo_chunk_t *c;
583 rb_node_t *n;
584
Florin Corasf22f4e52019-12-19 16:10:58 -0800585 if (!rb_tree_is_init (rt))
586 return 0;
587
588 n = f_find_node_rbtree (rt, pos);
Florin Corasb0208062019-12-12 12:09:29 -0800589 if (!n)
590 return 0;
591 c = uword_to_pointer (n->opaque, svm_fifo_chunk_t *);
Florin Corasf22f4e52019-12-19 16:10:58 -0800592 if (f_chunk_includes_pos (c, pos))
Florin Corasb0208062019-12-12 12:09:29 -0800593 return c;
594
595 return 0;
596}
597
Florin Corasb0208062019-12-12 12:09:29 -0800598static void
Florin Corasf22f4e52019-12-19 16:10:58 -0800599f_update_ooo_enq (svm_fifo_t * f, u32 start_pos, u32 end_pos)
Florin Corasb0208062019-12-12 12:09:29 -0800600{
601 rb_tree_t *rt = &f->ooo_enq_lookup;
602 svm_fifo_chunk_t *c;
603 rb_node_t *cur;
604
Florin Corasf22f4e52019-12-19 16:10:58 -0800605 /* Use linear search if rbtree is not initialized */
606 if (PREDICT_FALSE (!rb_tree_is_init (rt)))
607 {
608 f->ooo_enq = svm_fifo_find_next_chunk (f, f->tail_chunk, start_pos);
609 return;
610 }
Florin Corasb0208062019-12-12 12:09:29 -0800611
612 if (rt->root == RBTREE_TNIL_INDEX)
613 {
614 c = f->tail_chunk;
Florin Corasf22f4e52019-12-19 16:10:58 -0800615 ASSERT (c->enq_rb_index == RBTREE_TNIL_INDEX);
616 c->enq_rb_index = rb_tree_add_custom (rt, c->start_byte,
617 pointer_to_uword (c), f_pos_lt);
Florin Corasb0208062019-12-12 12:09:29 -0800618 }
619 else
620 {
Florin Corasf22f4e52019-12-19 16:10:58 -0800621 cur = f_find_node_rbtree (rt, start_pos);
Florin Corasb0208062019-12-12 12:09:29 -0800622 c = uword_to_pointer (cur->opaque, svm_fifo_chunk_t *);
Florin Corasf22f4e52019-12-19 16:10:58 -0800623 ASSERT (f_pos_leq (c->start_byte, start_pos));
Florin Coras4375fa32019-04-19 15:56:00 -0700624 }
625
Florin Corasf22f4e52019-12-19 16:10:58 -0800626 if (f_chunk_includes_pos (c, start_pos))
Florin Corasb0208062019-12-12 12:09:29 -0800627 f->ooo_enq = c;
628
Florin Corasf22f4e52019-12-19 16:10:58 -0800629 if (f_chunk_includes_pos (c, end_pos))
Florin Corasb0208062019-12-12 12:09:29 -0800630 return;
631
632 do
633 {
634 c = c->next;
Florin Corasf22f4e52019-12-19 16:10:58 -0800635 if (!c || c->enq_rb_index != RBTREE_TNIL_INDEX)
Florin Corasb0208062019-12-12 12:09:29 -0800636 break;
637
Florin Corasf22f4e52019-12-19 16:10:58 -0800638 c->enq_rb_index = rb_tree_add_custom (rt, c->start_byte,
639 pointer_to_uword (c), f_pos_lt);
Florin Corasb0208062019-12-12 12:09:29 -0800640
Florin Corasf22f4e52019-12-19 16:10:58 -0800641 if (f_chunk_includes_pos (c, start_pos))
Florin Corasb0208062019-12-12 12:09:29 -0800642 f->ooo_enq = c;
Florin Corasb0208062019-12-12 12:09:29 -0800643 }
Florin Corasf22f4e52019-12-19 16:10:58 -0800644 while (!f_chunk_includes_pos (c, end_pos));
Florin Corasb0208062019-12-12 12:09:29 -0800645}
646
647static void
Florin Corasf22f4e52019-12-19 16:10:58 -0800648f_update_ooo_deq (svm_fifo_t * f, u32 start_pos, u32 end_pos)
Florin Corasb0208062019-12-12 12:09:29 -0800649{
650 rb_tree_t *rt = &f->ooo_deq_lookup;
651 rb_node_t *cur;
652 svm_fifo_chunk_t *c;
653
Florin Corasf22f4e52019-12-19 16:10:58 -0800654 /* Use linear search if rbtree is not initialized */
655 if (PREDICT_FALSE (!rb_tree_is_init (rt)))
656 {
657 f->ooo_deq = svm_fifo_find_chunk (f, start_pos);
658 return;
659 }
Florin Corasb0208062019-12-12 12:09:29 -0800660
661 if (rt->root == RBTREE_TNIL_INDEX)
662 {
Florin Corasf22f4e52019-12-19 16:10:58 -0800663 c = f->start_chunk;
664 ASSERT (c->deq_rb_index == RBTREE_TNIL_INDEX);
665 c->deq_rb_index = rb_tree_add_custom (rt, c->start_byte,
666 pointer_to_uword (c), f_pos_lt);
Florin Corasb0208062019-12-12 12:09:29 -0800667 }
668 else
669 {
Florin Corasf22f4e52019-12-19 16:10:58 -0800670 cur = f_find_node_rbtree (rt, start_pos);
Florin Corasb0208062019-12-12 12:09:29 -0800671 c = uword_to_pointer (cur->opaque, svm_fifo_chunk_t *);
Florin Corasf22f4e52019-12-19 16:10:58 -0800672 ASSERT (f_pos_leq (c->start_byte, start_pos));
Florin Corasb0208062019-12-12 12:09:29 -0800673 }
674
Florin Corasf22f4e52019-12-19 16:10:58 -0800675 if (f_chunk_includes_pos (c, start_pos))
Florin Corasb0208062019-12-12 12:09:29 -0800676 f->ooo_deq = c;
677
Florin Corasf22f4e52019-12-19 16:10:58 -0800678 if (f_chunk_includes_pos (c, end_pos))
Florin Corasb0208062019-12-12 12:09:29 -0800679 return;
680
681 do
682 {
683 c = c->next;
Florin Corasf22f4e52019-12-19 16:10:58 -0800684 if (!c || c->deq_rb_index != RBTREE_TNIL_INDEX)
Florin Corasb0208062019-12-12 12:09:29 -0800685 break;
686
Florin Corasf22f4e52019-12-19 16:10:58 -0800687 c->deq_rb_index = rb_tree_add_custom (rt, c->start_byte,
688 pointer_to_uword (c), f_pos_lt);
Florin Corasb0208062019-12-12 12:09:29 -0800689
Florin Corasf22f4e52019-12-19 16:10:58 -0800690 if (f_chunk_includes_pos (c, start_pos))
Florin Corasb0208062019-12-12 12:09:29 -0800691 f->ooo_deq = c;
Florin Corasb0208062019-12-12 12:09:29 -0800692 }
Florin Corasf22f4e52019-12-19 16:10:58 -0800693 while (!f_chunk_includes_pos (c, end_pos));
Florin Corasb0208062019-12-12 12:09:29 -0800694}
695
696static svm_fifo_chunk_t *
Florin Corasf22f4e52019-12-19 16:10:58 -0800697f_lookup_clear_enq_chunks (svm_fifo_t * f, svm_fifo_chunk_t * start,
698 u32 end_pos)
Florin Corasb0208062019-12-12 12:09:29 -0800699{
Florin Corasf22f4e52019-12-19 16:10:58 -0800700 rb_tree_t *rt = &f->ooo_enq_lookup;
Florin Corasb0208062019-12-12 12:09:29 -0800701 svm_fifo_chunk_t *c;
702 rb_node_t *n;
703
Florin Corasb0208062019-12-12 12:09:29 -0800704 c = start;
Florin Corasf22f4e52019-12-19 16:10:58 -0800705 while (c && !f_chunk_includes_pos (c, end_pos))
Florin Corasb0208062019-12-12 12:09:29 -0800706 {
Florin Corasf22f4e52019-12-19 16:10:58 -0800707 if (c->enq_rb_index != RBTREE_TNIL_INDEX)
Florin Corasb0208062019-12-12 12:09:29 -0800708 {
Florin Corasf22f4e52019-12-19 16:10:58 -0800709 n = rb_node (rt, c->enq_rb_index);
710 rb_tree_del_node (rt, n);
711 c->enq_rb_index = RBTREE_TNIL_INDEX;
Florin Corasb0208062019-12-12 12:09:29 -0800712 }
713
Florin Corasb0208062019-12-12 12:09:29 -0800714 c = c->next;
715 }
Florin Corasf22f4e52019-12-19 16:10:58 -0800716
717 /* No ooo segments left, so make sure the current chunk
718 * is not tracked in the enq rbtree */
719 if (f->ooos_list_head == OOO_SEGMENT_INVALID_INDEX
720 && c && c->enq_rb_index != RBTREE_TNIL_INDEX)
721 {
722 n = rb_node (rt, c->enq_rb_index);
723 rb_tree_del_node (rt, n);
724 c->enq_rb_index = RBTREE_TNIL_INDEX;
725 }
Florin Corasb0208062019-12-12 12:09:29 -0800726
727 return c;
Florin Coras99ad2fc2019-04-18 21:25:49 -0700728}
729
Florin Corasf22f4e52019-12-19 16:10:58 -0800730static svm_fifo_chunk_t *
731f_lookup_clear_deq_chunks (svm_fifo_t * f, svm_fifo_chunk_t * start,
732 u32 end_pos)
Florin Corasa7570b02019-05-02 12:52:19 -0700733{
Florin Corasf22f4e52019-12-19 16:10:58 -0800734 rb_tree_t *rt = &f->ooo_deq_lookup;
735 svm_fifo_chunk_t *c;
736 rb_node_t *n;
Florin Corasa7570b02019-05-02 12:52:19 -0700737
Florin Corasf22f4e52019-12-19 16:10:58 -0800738 c = start;
739 while (c && !f_chunk_includes_pos (c, end_pos))
Florin Corasa7570b02019-05-02 12:52:19 -0700740 {
Florin Corasf22f4e52019-12-19 16:10:58 -0800741 if (c->deq_rb_index != RBTREE_TNIL_INDEX)
742 {
743 n = rb_node (rt, c->deq_rb_index);
744 rb_tree_del_node (rt, n);
745 c->deq_rb_index = RBTREE_TNIL_INDEX;
746 }
747
Florin Corasa7570b02019-05-02 12:52:19 -0700748 c = c->next;
749 }
Florin Corasa7570b02019-05-02 12:52:19 -0700750
Florin Corasf22f4e52019-12-19 16:10:58 -0800751 return c;
Florin Corasa7570b02019-05-02 12:52:19 -0700752}
753
754void
Florin Corasb095a3c2019-04-25 12:58:46 -0700755svm_fifo_free_chunk_lookup (svm_fifo_t * f)
756{
Florin Corasb0208062019-12-12 12:09:29 -0800757 rb_tree_free_nodes (&f->ooo_enq_lookup);
758 rb_tree_free_nodes (&f->ooo_deq_lookup);
Florin Corasb095a3c2019-04-25 12:58:46 -0700759}
760
761void
Florin Coras6cf30ad2017-04-04 23:08:23 -0700762svm_fifo_free (svm_fifo_t * f)
763{
Dave Barach52851e62017-08-07 09:35:25 -0400764 ASSERT (f->refcnt > 0);
765
766 if (--f->refcnt == 0)
767 {
Florin Corasb095a3c2019-04-25 12:58:46 -0700768 /* ooo data is not allocated on segment heap */
769 svm_fifo_free_chunk_lookup (f);
Dave Barach52851e62017-08-07 09:35:25 -0400770 clib_mem_free (f);
771 }
Florin Coras6cf30ad2017-04-04 23:08:23 -0700772}
773
Florin Coras7fb0fe12018-04-09 09:24:52 -0700774void
Florin Coras87b15ce2019-04-28 21:16:30 -0700775svm_fifo_overwrite_head (svm_fifo_t * f, u8 * src, u32 len)
Florin Coras7fb0fe12018-04-09 09:24:52 -0700776{
Florin Coras0a846802019-04-09 18:29:14 -0700777 u32 n_chunk;
Sirshak Das28aa5392019-02-05 01:33:33 -0600778 u32 head, tail, head_idx;
Florin Coras0a846802019-04-09 18:29:14 -0700779 svm_fifo_chunk_t *c;
780
Florin Corasf22f4e52019-12-19 16:10:58 -0800781 ASSERT (len <= f->size);
Sirshak Das28aa5392019-02-05 01:33:33 -0600782
783 f_load_head_tail_cons (f, &head, &tail);
Florin Corasf22f4e52019-12-19 16:10:58 -0800784
785 if (!f->head_chunk)
786 f->head_chunk = svm_fifo_find_chunk (f, head);
787
Florin Coras0a846802019-04-09 18:29:14 -0700788 c = f->head_chunk;
Florin Coras29a59c32019-05-02 12:52:19 -0700789 head_idx = head - c->start_byte;
Florin Coras0a846802019-04-09 18:29:14 -0700790 n_chunk = c->length - head_idx;
791 if (len <= n_chunk)
Florin Coras87b15ce2019-04-28 21:16:30 -0700792 clib_memcpy_fast (&c->data[head_idx], src, len);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700793 else
794 {
Florin Corasf22f4e52019-12-19 16:10:58 -0800795 ASSERT (len - n_chunk <= c->next->length);
Florin Coras87b15ce2019-04-28 21:16:30 -0700796 clib_memcpy_fast (&c->data[head_idx], src, n_chunk);
797 clib_memcpy_fast (&c->next->data[0], src + n_chunk, len - n_chunk);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700798 }
799}
Dave Barach68b0fb02017-02-28 15:15:56 -0500800
Florin Corasf22f4e52019-12-19 16:10:58 -0800801static int
Florin Coras9e61d9a2020-02-05 21:13:18 +0000802f_try_chunk_alloc (svm_fifo_t * f, u32 head, u32 tail, u32 len)
Florin Corasf22f4e52019-12-19 16:10:58 -0800803{
Florin Coras9e61d9a2020-02-05 21:13:18 +0000804 svm_fifo_chunk_t *c, *cur, *prev;
Florin Corasf22f4e52019-12-19 16:10:58 -0800805 u32 alloc_size, free_alloced;
806
807 free_alloced = f_chunk_end (f->end_chunk) - tail;
Florin Corasf22f4e52019-12-19 16:10:58 -0800808
809 alloc_size = clib_min (f->min_alloc, f->size - (tail - head));
810 alloc_size = clib_max (alloc_size, len - free_alloced);
811
812 c = fsh_alloc_chunk (f->fs_hdr, f->slice_index, alloc_size);
813 if (PREDICT_FALSE (!c))
814 return -1;
815
Florin Coras9e61d9a2020-02-05 21:13:18 +0000816 cur = c;
817 prev = f->end_chunk;
818
819 while (cur)
820 {
821 cur->start_byte = prev->start_byte + prev->length;
822 cur->enq_rb_index = RBTREE_TNIL_INDEX;
823 cur->deq_rb_index = RBTREE_TNIL_INDEX;
824
825 prev = cur;
826 cur = cur->next;
827 }
828
829 prev->next = 0;
830 f->end_chunk->next = c;
831 f->end_chunk = prev;
832
833 if (!f->tail_chunk)
834 f->tail_chunk = c;
835
Florin Corasf22f4e52019-12-19 16:10:58 -0800836 return 0;
837}
838
Florin Coras99ad2fc2019-04-18 21:25:49 -0700839int
Florin Coras87b15ce2019-04-28 21:16:30 -0700840svm_fifo_enqueue (svm_fifo_t * f, u32 len, const u8 * src)
Dave Barach68b0fb02017-02-28 15:15:56 -0500841{
Florin Coras99ad2fc2019-04-18 21:25:49 -0700842 u32 tail, head, free_count;
Florin Corasf22f4e52019-12-19 16:10:58 -0800843 svm_fifo_chunk_t *old_tail_c;
844
845 f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
Florin Coras99ad2fc2019-04-18 21:25:49 -0700846
847 f_load_head_tail_prod (f, &head, &tail);
848
849 /* free space in fifo can only increase during enqueue: SPSC */
850 free_count = f_free_count (f, head, tail);
851
Florin Coras99ad2fc2019-04-18 21:25:49 -0700852 if (PREDICT_FALSE (free_count == 0))
Florin Coras87b15ce2019-04-28 21:16:30 -0700853 return SVM_FIFO_EFULL;
Florin Coras99ad2fc2019-04-18 21:25:49 -0700854
855 /* number of bytes we're going to copy */
856 len = clib_min (free_count, len);
Florin Corasf22f4e52019-12-19 16:10:58 -0800857
858 if (f_pos_gt (tail + len, f_chunk_end (f->end_chunk)))
859 {
Florin Coras9e61d9a2020-02-05 21:13:18 +0000860 if (PREDICT_FALSE (f_try_chunk_alloc (f, head, tail, len)))
Florin Corasf22f4e52019-12-19 16:10:58 -0800861 {
862 len = f_chunk_end (f->end_chunk) - tail;
863 if (!len)
864 return SVM_FIFO_EGROW;
865 }
866 }
867
868 old_tail_c = f->tail_chunk;
869
Florin Coras29a59c32019-05-02 12:52:19 -0700870 svm_fifo_copy_to_chunk (f, f->tail_chunk, tail, src, len, &f->tail_chunk);
Florin Corasf22f4e52019-12-19 16:10:58 -0800871 tail = tail + len;
Florin Coras99ad2fc2019-04-18 21:25:49 -0700872
Florin Coras87b15ce2019-04-28 21:16:30 -0700873 svm_fifo_trace_add (f, head, len, 2);
Florin Coras99ad2fc2019-04-18 21:25:49 -0700874
875 /* collect out-of-order segments */
876 if (PREDICT_FALSE (f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX))
Florin Coraseaacce42019-07-02 13:07:37 -0700877 {
878 len += ooo_segment_try_collect (f, len, &tail);
Florin Corasf22f4e52019-12-19 16:10:58 -0800879 /* Tail chunk might've changed even if nothing was collected */
880 f->tail_chunk = f_lookup_clear_enq_chunks (f, old_tail_c, tail);
881 f->ooo_enq = 0;
Florin Coraseaacce42019-07-02 13:07:37 -0700882 }
Florin Coras99ad2fc2019-04-18 21:25:49 -0700883
884 /* store-rel: producer owned index (paired with load-acq in consumer) */
885 clib_atomic_store_rel_n (&f->tail, tail);
886
887 return len;
888}
889
890/**
891 * Enqueue a future segment.
892 *
893 * Two choices: either copies the entire segment, or copies nothing
894 * Returns 0 of the entire segment was copied
895 * Returns -1 if none of the segment was copied due to lack of space
896 */
897int
898svm_fifo_enqueue_with_offset (svm_fifo_t * f, u32 offset, u32 len, u8 * src)
899{
Florin Corasf22f4e52019-12-19 16:10:58 -0800900 u32 tail, head, free_count, enq_pos;
Florin Coras99ad2fc2019-04-18 21:25:49 -0700901
902 f_load_head_tail_prod (f, &head, &tail);
903
904 /* free space in fifo can only increase during enqueue: SPSC */
905 free_count = f_free_count (f, head, tail);
Florin Corasf22f4e52019-12-19 16:10:58 -0800906 f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
Florin Coras99ad2fc2019-04-18 21:25:49 -0700907
908 /* will this request fit? */
909 if ((len + offset) > free_count)
Florin Coras87b15ce2019-04-28 21:16:30 -0700910 return SVM_FIFO_EFULL;
Florin Coras99ad2fc2019-04-18 21:25:49 -0700911
Florin Corasf22f4e52019-12-19 16:10:58 -0800912 enq_pos = tail + offset;
913
914 if (f_pos_gt (enq_pos + len, f_chunk_end (f->end_chunk)))
915 {
Florin Coras9e61d9a2020-02-05 21:13:18 +0000916 if (PREDICT_FALSE (f_try_chunk_alloc (f, head, tail, offset + len)))
Florin Corasf22f4e52019-12-19 16:10:58 -0800917 return SVM_FIFO_EGROW;
918 }
919
Florin Coras99ad2fc2019-04-18 21:25:49 -0700920 svm_fifo_trace_add (f, offset, len, 1);
Florin Coras99ad2fc2019-04-18 21:25:49 -0700921 ooo_segment_add (f, offset, head, tail, len);
Florin Coras4375fa32019-04-19 15:56:00 -0700922
Florin Corasf22f4e52019-12-19 16:10:58 -0800923 if (!f->ooo_enq || !f_chunk_includes_pos (f->ooo_enq, enq_pos))
924 f_update_ooo_enq (f, enq_pos, enq_pos + len);
Florin Coras4375fa32019-04-19 15:56:00 -0700925
Florin Corasf22f4e52019-12-19 16:10:58 -0800926 svm_fifo_copy_to_chunk (f, f->ooo_enq, enq_pos, src, len, &f->ooo_enq);
Florin Coras99ad2fc2019-04-18 21:25:49 -0700927
928 return 0;
929}
930
Florin Corasa7570b02019-05-02 12:52:19 -0700931/**
932 * Advance tail
933 */
934void
935svm_fifo_enqueue_nocopy (svm_fifo_t * f, u32 len)
936{
937 u32 tail;
938
939 ASSERT (len <= svm_fifo_max_enqueue_prod (f));
940 /* load-relaxed: producer owned index */
941 tail = f->tail;
Florin Corasf22f4e52019-12-19 16:10:58 -0800942 tail = tail + len;
Florin Coraseaacce42019-07-02 13:07:37 -0700943
Florin Corasf22f4e52019-12-19 16:10:58 -0800944 if (rb_tree_is_init (&f->ooo_enq_lookup))
945 {
946 f->tail_chunk = f_lookup_clear_enq_chunks (f, f->tail_chunk, tail);
947 f->ooo_enq = 0;
948 }
949 else
950 {
951 f->tail_chunk = svm_fifo_find_next_chunk (f, f->tail_chunk, tail);
952 }
Florin Coraseaacce42019-07-02 13:07:37 -0700953
Florin Corasa7570b02019-05-02 12:52:19 -0700954 /* store-rel: producer owned index (paired with load-acq in consumer) */
955 clib_atomic_store_rel_n (&f->tail, tail);
956}
957
Florin Corasc95cfa22020-11-24 08:41:17 -0800958int
959svm_fifo_enqueue_segments (svm_fifo_t * f, const svm_fifo_seg_t segs[],
960 u32 n_segs, u8 allow_partial)
961{
962 u32 tail, head, free_count, len = 0, i;
963 svm_fifo_chunk_t *old_tail_c;
964
965 f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
966
967 f_load_head_tail_prod (f, &head, &tail);
968
969 /* free space in fifo can only increase during enqueue: SPSC */
970 free_count = f_free_count (f, head, tail);
971
972 if (PREDICT_FALSE (free_count == 0))
973 return SVM_FIFO_EFULL;
974
975 for (i = 0; i < n_segs; i++)
976 len += segs[i].len;
977
978 old_tail_c = f->tail_chunk;
979
980 if (!allow_partial)
981 {
982 if (PREDICT_FALSE (free_count < len))
983 return SVM_FIFO_EFULL;
984
985 if (f_pos_gt (tail + len, f_chunk_end (f->end_chunk)))
986 {
987 if (PREDICT_FALSE (f_try_chunk_alloc (f, head, tail, len)))
988 return SVM_FIFO_EGROW;
989 }
990
991 for (i = 0; i < n_segs; i++)
992 {
993 svm_fifo_copy_to_chunk (f, f->tail_chunk, tail, segs[i].data,
994 segs[i].len, &f->tail_chunk);
995 tail += segs[i].len;
996 }
997 }
998 else
999 {
1000 len = clib_min (free_count, len);
1001
1002 if (f_pos_gt (tail + len, f_chunk_end (f->end_chunk)))
1003 {
1004 if (PREDICT_FALSE (f_try_chunk_alloc (f, head, tail, len)))
1005 {
1006 len = f_chunk_end (f->end_chunk) - tail;
1007 if (!len)
1008 return SVM_FIFO_EGROW;
1009 }
1010 }
1011
1012 i = 0;
1013 while (len)
1014 {
1015 u32 to_copy = clib_min (segs[i].len, len);
1016 svm_fifo_copy_to_chunk (f, f->tail_chunk, tail, segs[i].data,
1017 to_copy, &f->tail_chunk);
1018 len -= to_copy;
1019 tail += to_copy;
1020 i++;
1021 }
1022 }
1023
1024 /* collect out-of-order segments */
1025 if (PREDICT_FALSE (f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX))
1026 {
1027 len += ooo_segment_try_collect (f, len, &tail);
1028 /* Tail chunk might've changed even if nothing was collected */
1029 f->tail_chunk = f_lookup_clear_enq_chunks (f, old_tail_c, tail);
1030 f->ooo_enq = 0;
1031 }
1032
1033 /* store-rel: producer owned index (paired with load-acq in consumer) */
1034 clib_atomic_store_rel_n (&f->tail, tail);
1035
1036 return len;
1037}
1038
Florin Corasf22f4e52019-12-19 16:10:58 -08001039always_inline svm_fifo_chunk_t *
1040f_unlink_chunks (svm_fifo_t * f, u32 end_pos, u8 maybe_ooo)
1041{
1042 svm_fifo_chunk_t *start, *prev = 0, *c;
1043 rb_tree_t *rt;
1044 rb_node_t *n;
1045
1046 ASSERT (!f_chunk_includes_pos (f->start_chunk, end_pos));
1047
1048 if (maybe_ooo)
1049 rt = &f->ooo_deq_lookup;
1050
1051 c = f->start_chunk;
1052
1053 do
1054 {
1055 if (maybe_ooo && c->deq_rb_index != RBTREE_TNIL_INDEX)
1056 {
1057 n = rb_node (rt, c->deq_rb_index);
1058 ASSERT (n == f_find_node_rbtree (rt, c->start_byte));
1059 rb_tree_del_node (rt, n);
1060 c->deq_rb_index = RBTREE_TNIL_INDEX;
1061 }
1062 if (!c->next)
1063 break;
1064 prev = c;
1065 c = c->next;
1066 }
1067 while (!f_chunk_includes_pos (c, end_pos));
1068
1069 if (maybe_ooo)
1070 {
1071 if (f->ooo_deq && f_pos_lt (f->ooo_deq->start_byte, f_chunk_end (c)))
1072 f->ooo_deq = 0;
1073 }
1074 else
1075 {
1076 if (PREDICT_FALSE (f->ooo_deq != 0))
1077 f->ooo_deq = 0;
1078 }
1079
1080 /* Avoid unlinking the last chunk */
1081 if (!prev)
1082 return 0;
1083
1084 prev->next = 0;
1085 start = f->start_chunk;
1086 f->start_chunk = c;
1087
1088 return start;
1089}
1090
Florin Coras99ad2fc2019-04-18 21:25:49 -07001091int
Florin Coras87b15ce2019-04-28 21:16:30 -07001092svm_fifo_dequeue (svm_fifo_t * f, u32 len, u8 * dst)
Florin Coras99ad2fc2019-04-18 21:25:49 -07001093{
1094 u32 tail, head, cursize;
Dave Barach68b0fb02017-02-28 15:15:56 -05001095
Sirshak Das28aa5392019-02-05 01:33:33 -06001096 f_load_head_tail_cons (f, &head, &tail);
1097
1098 /* current size of fifo can only increase during dequeue: SPSC */
1099 cursize = f_cursize (f, head, tail);
1100
Florin Coras3e350af2017-03-30 02:54:28 -07001101 if (PREDICT_FALSE (cursize == 0))
Florin Coras87b15ce2019-04-28 21:16:30 -07001102 return SVM_FIFO_EEMPTY;
Dave Barach68b0fb02017-02-28 15:15:56 -05001103
Florin Coras99ad2fc2019-04-18 21:25:49 -07001104 len = clib_min (cursize, len);
Dave Barach68b0fb02017-02-28 15:15:56 -05001105
Florin Corasf22f4e52019-12-19 16:10:58 -08001106 if (!f->head_chunk)
1107 f->head_chunk = svm_fifo_find_chunk (f, head);
1108
1109 svm_fifo_copy_from_chunk (f, f->head_chunk, head, dst, len, &f->head_chunk);
1110 head = head + len;
1111
Florin Coras97d39e32020-09-04 08:57:27 -07001112 /* In order dequeues are not supported in combination with ooo peeking.
1113 * Use svm_fifo_dequeue_drop instead. */
1114 ASSERT (rb_tree_n_nodes (&f->ooo_deq_lookup) <= 1);
1115
Florin Corasf22f4e52019-12-19 16:10:58 -08001116 if (f_pos_geq (head, f_chunk_end (f->start_chunk)))
1117 fsh_collect_chunks (f->fs_hdr, f->slice_index,
1118 f_unlink_chunks (f, head, 0));
Florin Coras2309e7a2019-04-18 18:58:10 -07001119
Sirshak Das28aa5392019-02-05 01:33:33 -06001120 /* store-rel: consumer owned index (paired with load-acq in producer) */
1121 clib_atomic_store_rel_n (&f->head, head);
Dave Barach68b0fb02017-02-28 15:15:56 -05001122
Florin Coras0a846802019-04-09 18:29:14 -07001123 return len;
Dave Barach68b0fb02017-02-28 15:15:56 -05001124}
1125
Dave Barach68b0fb02017-02-28 15:15:56 -05001126int
Florin Coras4375fa32019-04-19 15:56:00 -07001127svm_fifo_peek (svm_fifo_t * f, u32 offset, u32 len, u8 * dst)
Florin Corasf6359c82017-06-19 12:26:09 -04001128{
Florin Coras4375fa32019-04-19 15:56:00 -07001129 u32 tail, head, cursize, head_idx;
Dave Barach68b0fb02017-02-28 15:15:56 -05001130
Sirshak Das28aa5392019-02-05 01:33:33 -06001131 f_load_head_tail_cons (f, &head, &tail);
1132
1133 /* current size of fifo can only increase during peek: SPSC */
1134 cursize = f_cursize (f, head, tail);
1135
Florin Coras4375fa32019-04-19 15:56:00 -07001136 if (PREDICT_FALSE (cursize < offset))
Florin Coras87b15ce2019-04-28 21:16:30 -07001137 return SVM_FIFO_EEMPTY;
Dave Barach68b0fb02017-02-28 15:15:56 -05001138
Florin Coras4375fa32019-04-19 15:56:00 -07001139 len = clib_min (cursize - offset, len);
Florin Corasf22f4e52019-12-19 16:10:58 -08001140 head_idx = head + offset;
Florin Corasb0208062019-12-12 12:09:29 -08001141
BenoƮt Gannedf601ae2020-10-20 14:31:55 +02001142 CLIB_MEM_UNPOISON (f->ooo_deq, sizeof (*f->ooo_deq));
Florin Corasf22f4e52019-12-19 16:10:58 -08001143 if (!f->ooo_deq || !f_chunk_includes_pos (f->ooo_deq, head_idx))
1144 f_update_ooo_deq (f, head_idx, head_idx + len);
Dave Barach68b0fb02017-02-28 15:15:56 -05001145
Florin Coras4375fa32019-04-19 15:56:00 -07001146 svm_fifo_copy_from_chunk (f, f->ooo_deq, head_idx, dst, len, &f->ooo_deq);
Florin Coras0a846802019-04-09 18:29:14 -07001147 return len;
Dave Barach68b0fb02017-02-28 15:15:56 -05001148}
1149
1150int
Florin Coras87b15ce2019-04-28 21:16:30 -07001151svm_fifo_dequeue_drop (svm_fifo_t * f, u32 len)
Dave Barach68b0fb02017-02-28 15:15:56 -05001152{
Florin Coras87b15ce2019-04-28 21:16:30 -07001153 u32 total_drop_bytes, tail, head, cursize;
Dave Barach68b0fb02017-02-28 15:15:56 -05001154
Sirshak Das28aa5392019-02-05 01:33:33 -06001155 f_load_head_tail_cons (f, &head, &tail);
1156
Florin Coras87b15ce2019-04-28 21:16:30 -07001157 /* number of bytes available */
Sirshak Das28aa5392019-02-05 01:33:33 -06001158 cursize = f_cursize (f, head, tail);
Florin Coras3e350af2017-03-30 02:54:28 -07001159 if (PREDICT_FALSE (cursize == 0))
Florin Coras87b15ce2019-04-28 21:16:30 -07001160 return SVM_FIFO_EEMPTY;
Dave Barach68b0fb02017-02-28 15:15:56 -05001161
Sirshak Das28aa5392019-02-05 01:33:33 -06001162 /* number of bytes we're going to drop */
Florin Coras87b15ce2019-04-28 21:16:30 -07001163 total_drop_bytes = clib_min (cursize, len);
Dave Barach68b0fb02017-02-28 15:15:56 -05001164
Nathan Skrzypczakb4c67752019-06-20 09:58:37 +02001165 svm_fifo_trace_add (f, tail, total_drop_bytes, 3);
1166
Sirshak Das28aa5392019-02-05 01:33:33 -06001167 /* move head */
Florin Corasf22f4e52019-12-19 16:10:58 -08001168 head = head + total_drop_bytes;
Florin Coras3eb50622017-07-13 01:24:57 -04001169
Florin Corasf22f4e52019-12-19 16:10:58 -08001170 if (f_pos_geq (head, f_chunk_end (f->start_chunk)))
1171 {
1172 fsh_collect_chunks (f->fs_hdr, f->slice_index,
1173 f_unlink_chunks (f, head, 1));
1174 f->head_chunk =
1175 f_chunk_includes_pos (f->start_chunk, head) ? f->start_chunk : 0;
1176 }
Florin Coras0a6562c2019-08-05 09:39:47 -07001177
Sirshak Das28aa5392019-02-05 01:33:33 -06001178 /* store-rel: consumer owned index (paired with load-acq in producer) */
1179 clib_atomic_store_rel_n (&f->head, head);
Dave Barach68b0fb02017-02-28 15:15:56 -05001180
1181 return total_drop_bytes;
1182}
1183
Florin Corasf22f4e52019-12-19 16:10:58 -08001184/**
1185 * Drop all data from fifo
1186 *
Florin Corasf22f4e52019-12-19 16:10:58 -08001187 */
Florin Coras25579b42018-06-06 17:55:02 -07001188void
1189svm_fifo_dequeue_drop_all (svm_fifo_t * f)
1190{
Florin Corasf22f4e52019-12-19 16:10:58 -08001191 u32 head, tail;
Florin Coraseaacce42019-07-02 13:07:37 -07001192
Florin Corasf22f4e52019-12-19 16:10:58 -08001193 f_load_head_tail_all_acq (f, &head, &tail);
Florin Coraseaacce42019-07-02 13:07:37 -07001194
Florin Corasf22f4e52019-12-19 16:10:58 -08001195 if (!f->head_chunk || !f_chunk_includes_pos (f->head_chunk, head))
1196 f->head_chunk = svm_fifo_find_chunk (f, head);
1197
1198 f->head_chunk = f_lookup_clear_deq_chunks (f, f->head_chunk, tail);
1199
1200 if (f_pos_geq (tail, f_chunk_end (f->start_chunk)))
1201 fsh_collect_chunks (f->fs_hdr, f->slice_index,
1202 f_unlink_chunks (f, tail, 0));
Florin Coras0a6562c2019-08-05 09:39:47 -07001203
Sirshak Das28aa5392019-02-05 01:33:33 -06001204 /* store-rel: consumer owned index (paired with load-acq in producer) */
1205 clib_atomic_store_rel_n (&f->head, tail);
Florin Coras25579b42018-06-06 17:55:02 -07001206}
1207
Florin Coras2cba8532018-09-11 16:33:36 -07001208int
Florin Corasf22f4e52019-12-19 16:10:58 -08001209svm_fifo_fill_chunk_list (svm_fifo_t * f)
1210{
1211 u32 head, tail;
1212
1213 f_load_head_tail_prod (f, &head, &tail);
1214
1215 if (f_chunk_end (f->end_chunk) - head >= f->size)
1216 return 0;
1217
Florin Coras9e61d9a2020-02-05 21:13:18 +00001218 if (f_try_chunk_alloc (f, head, tail, f->size - (tail - head)))
Florin Corasf22f4e52019-12-19 16:10:58 -08001219 return SVM_FIFO_EGROW;
1220
1221 return 0;
1222}
1223
1224int
Florin Coras40a5da82020-12-18 09:19:18 -08001225svm_fifo_provision_chunks (svm_fifo_t *f, svm_fifo_seg_t *fs, u32 n_segs,
1226 u32 len)
1227{
1228 u32 head, tail, n_avail, head_pos, n_bytes, fs_index = 1, clen;
1229 svm_fifo_chunk_t *c;
1230
1231 f_load_head_tail_prod (f, &head, &tail);
1232
1233 if (f_free_count (f, head, tail) < len)
1234 return SVM_FIFO_EFULL;
1235
1236 n_avail = f_chunk_end (f->end_chunk) - tail;
1237
1238 if (n_avail < len && f_try_chunk_alloc (f, head, tail, len))
1239 return SVM_FIFO_EGROW;
1240
1241 c = f->tail_chunk;
1242 head_pos = (tail - c->start_byte);
1243 fs[0].data = c->data + head_pos;
1244 fs[0].len = clib_min (c->length - head_pos, len);
1245 n_bytes = fs[0].len;
1246
1247 while (n_bytes < len && fs_index < n_segs)
1248 {
1249 c = c->next;
1250 clen = clib_min (c->length, len - n_bytes);
1251 fs[fs_index].data = c->data;
1252 fs[fs_index].len = clen;
1253 n_bytes += clen;
1254 fs_index += 1;
1255 }
1256
1257 return fs_index;
1258}
1259
1260int
Florin Corasd1cc38d2020-10-11 11:05:04 -07001261svm_fifo_segments (svm_fifo_t * f, u32 offset, svm_fifo_seg_t * fs,
1262 u32 n_segs, u32 max_bytes)
Florin Coras2cba8532018-09-11 16:33:36 -07001263{
Florin Corasd1cc38d2020-10-11 11:05:04 -07001264 u32 cursize, to_read, head, tail, fs_index = 1;
1265 u32 n_bytes, head_pos, len, start;
Florin Corasd68faf82020-09-25 15:18:13 -07001266 svm_fifo_chunk_t *c;
Florin Coras2cba8532018-09-11 16:33:36 -07001267
Sirshak Das28aa5392019-02-05 01:33:33 -06001268 f_load_head_tail_cons (f, &head, &tail);
1269
1270 /* consumer function, cursize can only increase while we're working */
1271 cursize = f_cursize (f, head, tail);
1272
Florin Coras2cba8532018-09-11 16:33:36 -07001273 if (PREDICT_FALSE (cursize == 0))
Florin Coras87b15ce2019-04-28 21:16:30 -07001274 return SVM_FIFO_EEMPTY;
Florin Coras2cba8532018-09-11 16:33:36 -07001275
Florin Corasd1cc38d2020-10-11 11:05:04 -07001276 if (offset >= cursize)
1277 return SVM_FIFO_EEMPTY;
1278
1279 to_read = clib_min (cursize - offset, max_bytes);
1280 start = head + offset;
1281
1282 if (!f->head_chunk)
1283 f->head_chunk = svm_fifo_find_chunk (f, head);
Florin Coras2cba8532018-09-11 16:33:36 -07001284
Florin Corasd68faf82020-09-25 15:18:13 -07001285 c = f->head_chunk;
Florin Corasd1cc38d2020-10-11 11:05:04 -07001286
1287 while (!f_chunk_includes_pos (c, start))
1288 c = c->next;
1289
1290 head_pos = start - c->start_byte;
Florin Corasd68faf82020-09-25 15:18:13 -07001291 fs[0].data = c->data + head_pos;
Florin Corasdfd1caf2020-12-21 10:25:19 -08001292 fs[0].len = clib_min (c->length - head_pos, to_read);
Florin Corasd68faf82020-09-25 15:18:13 -07001293 n_bytes = fs[0].len;
Florin Corasd68faf82020-09-25 15:18:13 -07001294
1295 while (n_bytes < to_read && fs_index < n_segs)
Florin Coras2cba8532018-09-11 16:33:36 -07001296 {
Florin Corasd1cc38d2020-10-11 11:05:04 -07001297 c = c->next;
Florin Corasd68faf82020-09-25 15:18:13 -07001298 len = clib_min (c->length, to_read - n_bytes);
1299 fs[fs_index].data = c->data;
1300 fs[fs_index].len = len;
1301 n_bytes += len;
Florin Corasd68faf82020-09-25 15:18:13 -07001302 fs_index += 1;
Florin Coras2cba8532018-09-11 16:33:36 -07001303 }
Florin Coras2cba8532018-09-11 16:33:36 -07001304
Florin Corasd68faf82020-09-25 15:18:13 -07001305 return n_bytes;
Sirshak Das28aa5392019-02-05 01:33:33 -06001306}
1307
Florin Coras87b15ce2019-04-28 21:16:30 -07001308/**
1309 * Clones fifo
1310 *
1311 * Assumptions:
1312 * - no prod and cons are accessing either dest or src fifo
1313 * - fifo is not multi chunk
1314 */
Sirshak Das28aa5392019-02-05 01:33:33 -06001315void
1316svm_fifo_clone (svm_fifo_t * df, svm_fifo_t * sf)
1317{
1318 u32 head, tail;
Florin Corasf22f4e52019-12-19 16:10:58 -08001319
1320 /* Support only single chunk clones for now */
1321 ASSERT (svm_fifo_n_chunks (sf) == 1);
1322
Florin Coras0a846802019-04-09 18:29:14 -07001323 clib_memcpy_fast (df->head_chunk->data, sf->head_chunk->data, sf->size);
Sirshak Das28aa5392019-02-05 01:33:33 -06001324
1325 f_load_head_tail_all_acq (sf, &head, &tail);
1326 clib_atomic_store_rel_n (&df->head, head);
1327 clib_atomic_store_rel_n (&df->tail, tail);
Florin Coras2cba8532018-09-11 16:33:36 -07001328}
1329
Dave Barach1f75cfd2017-04-14 16:46:44 -04001330u32
Florin Coras87b15ce2019-04-28 21:16:30 -07001331svm_fifo_n_ooo_segments (svm_fifo_t * f)
Dave Barach1f75cfd2017-04-14 16:46:44 -04001332{
1333 return pool_elts (f->ooo_segments);
1334}
1335
1336ooo_segment_t *
1337svm_fifo_first_ooo_segment (svm_fifo_t * f)
1338{
1339 return pool_elt_at_index (f->ooo_segments, f->ooos_list_head);
1340}
1341
Florin Corasc28764f2017-04-26 00:08:42 -07001342/**
1343 * Set fifo pointers to requested offset
1344 */
1345void
Florin Coras4375fa32019-04-19 15:56:00 -07001346svm_fifo_init_pointers (svm_fifo_t * f, u32 head, u32 tail)
Florin Corasc28764f2017-04-26 00:08:42 -07001347{
Florin Corasf22f4e52019-12-19 16:10:58 -08001348 svm_fifo_chunk_t *c;
1349
Florin Coras4375fa32019-04-19 15:56:00 -07001350 clib_atomic_store_rel_n (&f->head, head);
1351 clib_atomic_store_rel_n (&f->tail, tail);
Florin Corasf22f4e52019-12-19 16:10:58 -08001352
1353 c = svm_fifo_find_chunk (f, head);
1354 ASSERT (c != 0);
1355 f->head_chunk = f->ooo_deq = c;
1356 c = svm_fifo_find_chunk (f, tail);
1357 ASSERT (c != 0);
1358 f->tail_chunk = f->ooo_enq = c;
Florin Corasc28764f2017-04-26 00:08:42 -07001359}
1360
Florin Coras72b04282019-01-14 17:23:11 -08001361void
1362svm_fifo_add_subscriber (svm_fifo_t * f, u8 subscriber)
1363{
1364 if (f->n_subscribers >= SVM_FIFO_MAX_EVT_SUBSCRIBERS)
1365 return;
1366 f->subscribers[f->n_subscribers++] = subscriber;
1367}
1368
1369void
1370svm_fifo_del_subscriber (svm_fifo_t * f, u8 subscriber)
1371{
1372 int i;
1373
1374 for (i = 0; i < f->n_subscribers; i++)
1375 {
1376 if (f->subscribers[i] != subscriber)
1377 continue;
1378 f->subscribers[i] = f->subscribers[f->n_subscribers - 1];
1379 f->n_subscribers--;
1380 break;
1381 }
1382}
1383
Florin Coraseaacce42019-07-02 13:07:37 -07001384u8
1385svm_fifo_is_sane (svm_fifo_t * f)
1386{
Florin Corasf22f4e52019-12-19 16:10:58 -08001387 svm_fifo_chunk_t *tmp;
Florin Coraseaacce42019-07-02 13:07:37 -07001388
Florin Corasf22f4e52019-12-19 16:10:58 -08001389 if (f->head_chunk && !f_chunk_includes_pos (f->head_chunk, f->head))
1390 return 0;
1391 if (f->tail_chunk && !f_chunk_includes_pos (f->tail_chunk, f->tail))
1392 return 0;
1393 if (f->ooo_deq)
1394 {
1395 if (rb_tree_is_init (&f->ooo_deq_lookup))
1396 {
1397 if (f_pos_lt (f->ooo_deq->start_byte, f->start_chunk->start_byte)
1398 || f_pos_gt (f->ooo_deq->start_byte,
1399 f_chunk_end (f->end_chunk)))
1400 return 0;
1401
1402 tmp = f_find_chunk_rbtree (&f->ooo_deq_lookup,
1403 f->ooo_deq->start_byte);
1404 }
1405 else
1406 tmp = svm_fifo_find_chunk (f, f->ooo_deq->start_byte);
1407 if (tmp != f->ooo_deq)
1408 return 0;
1409 }
1410 if (f->ooo_enq)
1411 {
1412 if (rb_tree_is_init (&f->ooo_enq_lookup))
1413 {
1414 if (f_pos_lt (f->ooo_enq->start_byte, f->start_chunk->start_byte)
1415 || f_pos_gt (f->ooo_enq->start_byte,
1416 f_chunk_end (f->end_chunk)))
1417 return 0;
1418
1419 tmp = f_find_chunk_rbtree (&f->ooo_enq_lookup,
1420 f->ooo_enq->start_byte);
1421 }
1422 else
1423 {
1424 tmp = svm_fifo_find_next_chunk (f, f->tail_chunk,
1425 f->ooo_enq->start_byte);
1426 }
1427 if (tmp != f->ooo_enq)
1428 return 0;
1429 }
1430
1431 if (f->start_chunk->next)
Florin Coraseaacce42019-07-02 13:07:37 -07001432 {
1433 svm_fifo_chunk_t *c, *prev = 0, *tmp;
Florin Corasf22f4e52019-12-19 16:10:58 -08001434 u32 chunks_bytes = 0;
Florin Coraseaacce42019-07-02 13:07:37 -07001435
1436 c = f->start_chunk;
1437 do
1438 {
1439 tmp = svm_fifo_find_chunk (f, c->start_byte);
1440 if (tmp != c)
1441 return 0;
1442 if (prev && (prev->start_byte + prev->length != c->start_byte))
1443 return 0;
Florin Corasb0208062019-12-12 12:09:29 -08001444
Florin Corasf22f4e52019-12-19 16:10:58 -08001445 if (c->enq_rb_index != RBTREE_TNIL_INDEX)
Florin Corasb0208062019-12-12 12:09:29 -08001446 {
Florin Corasf22f4e52019-12-19 16:10:58 -08001447 tmp = f_find_chunk_rbtree (&f->ooo_enq_lookup, c->start_byte);
Florin Corasb0208062019-12-12 12:09:29 -08001448 if (tmp)
1449 {
Florin Corasb0208062019-12-12 12:09:29 -08001450 if (tmp != c)
1451 return 0;
1452 }
Florin Corasf22f4e52019-12-19 16:10:58 -08001453 }
1454 if (c->deq_rb_index != RBTREE_TNIL_INDEX)
1455 {
1456 tmp = f_find_chunk_rbtree (&f->ooo_deq_lookup, c->start_byte);
Florin Corasb0208062019-12-12 12:09:29 -08001457 if (tmp)
1458 {
Florin Corasb0208062019-12-12 12:09:29 -08001459 if (tmp != c)
1460 return 0;
1461 }
Florin Corasb0208062019-12-12 12:09:29 -08001462 }
1463
Florin Corasf22f4e52019-12-19 16:10:58 -08001464 chunks_bytes += c->length;
Florin Coraseaacce42019-07-02 13:07:37 -07001465 prev = c;
1466 c = c->next;
1467 }
Florin Corasf22f4e52019-12-19 16:10:58 -08001468 while (c);
Florin Coraseaacce42019-07-02 13:07:37 -07001469
Florin Corasf22f4e52019-12-19 16:10:58 -08001470 if (chunks_bytes < f->tail - f->head)
Florin Coraseaacce42019-07-02 13:07:37 -07001471 return 0;
1472 }
1473
1474 return 1;
1475}
1476
Florin Corasf22f4e52019-12-19 16:10:58 -08001477u32
1478svm_fifo_n_chunks (svm_fifo_t * f)
Ryujiro Shibuya8e20fe72019-10-16 06:30:02 +01001479{
Florin Corasf22f4e52019-12-19 16:10:58 -08001480 svm_fifo_chunk_t *c;
1481 int n_chunks = 0;
Ryujiro Shibuya8e20fe72019-10-16 06:30:02 +01001482
Florin Corasf22f4e52019-12-19 16:10:58 -08001483 c = f->start_chunk;
1484 while (c)
1485 {
1486 n_chunks++;
1487 c = c->next;
Ryujiro Shibuya8e20fe72019-10-16 06:30:02 +01001488 }
1489
Florin Corasf22f4e52019-12-19 16:10:58 -08001490 return n_chunks;
Ryujiro Shibuya8e20fe72019-10-16 06:30:02 +01001491}
1492
Florin Coras87b15ce2019-04-28 21:16:30 -07001493u8 *
1494format_ooo_segment (u8 * s, va_list * args)
1495{
Florin Corasf22f4e52019-12-19 16:10:58 -08001496 svm_fifo_t __clib_unused *f = va_arg (*args, svm_fifo_t *);
Florin Coras87b15ce2019-04-28 21:16:30 -07001497 ooo_segment_t *seg = va_arg (*args, ooo_segment_t *);
Florin Corasf22f4e52019-12-19 16:10:58 -08001498 s = format (s, "[%u, %u], len %u, next %d, prev %d", seg->start,
1499 seg->start + seg->length, seg->length, seg->next, seg->prev);
Florin Coras87b15ce2019-04-28 21:16:30 -07001500 return s;
1501}
1502
1503u8 *
1504svm_fifo_dump_trace (u8 * s, svm_fifo_t * f)
1505{
1506#if SVM_FIFO_TRACE
1507 svm_fifo_trace_elem_t *seg = 0;
1508 int i = 0;
1509
1510 if (f->trace)
1511 {
1512 vec_foreach (seg, f->trace)
1513 {
1514 s = format (s, "{%u, %u, %u}, ", seg->offset, seg->len, seg->action);
1515 i++;
1516 if (i % 5 == 0)
1517 s = format (s, "\n");
1518 }
1519 s = format (s, "\n");
1520 }
1521 return s;
1522#else
1523 return 0;
1524#endif
1525}
1526
1527u8 *
1528svm_fifo_replay (u8 * s, svm_fifo_t * f, u8 no_read, u8 verbose)
1529{
1530 int i, trace_len;
1531 u8 *data = 0;
1532 svm_fifo_trace_elem_t *trace;
1533 u32 offset;
Dave Barach11fb09e2020-08-06 12:10:09 -04001534 svm_fifo_t *placeholder_fifo;
Florin Coras87b15ce2019-04-28 21:16:30 -07001535
1536 if (!f)
1537 return s;
1538
1539#if SVM_FIFO_TRACE
1540 trace = f->trace;
1541 trace_len = vec_len (trace);
1542#else
1543 trace = 0;
1544 trace_len = 0;
1545#endif
1546
Dave Barach11fb09e2020-08-06 12:10:09 -04001547 placeholder_fifo = svm_fifo_alloc (f->size);
Florin Corasf22f4e52019-12-19 16:10:58 -08001548 svm_fifo_init (f, f->size);
1549 clib_memset (f->head_chunk->data, 0xFF, f->size);
1550 vec_validate (data, f->size);
Florin Coras87b15ce2019-04-28 21:16:30 -07001551 for (i = 0; i < vec_len (data); i++)
1552 data[i] = i;
1553
1554 for (i = 0; i < trace_len; i++)
1555 {
1556 offset = trace[i].offset;
1557 if (trace[i].action == 1)
1558 {
1559 if (verbose)
1560 s = format (s, "adding [%u, %u]:", trace[i].offset,
Florin Corasf22f4e52019-12-19 16:10:58 -08001561 (trace[i].offset + trace[i].len));
Dave Barach11fb09e2020-08-06 12:10:09 -04001562 svm_fifo_enqueue_with_offset (placeholder_fifo, trace[i].offset,
Florin Coras87b15ce2019-04-28 21:16:30 -07001563 trace[i].len, &data[offset]);
1564 }
1565 else if (trace[i].action == 2)
1566 {
1567 if (verbose)
1568 s = format (s, "adding [%u, %u]:", 0, trace[i].len);
Dave Barach11fb09e2020-08-06 12:10:09 -04001569 svm_fifo_enqueue (placeholder_fifo, trace[i].len, &data[offset]);
Florin Coras87b15ce2019-04-28 21:16:30 -07001570 }
1571 else if (!no_read)
1572 {
1573 if (verbose)
1574 s = format (s, "read: %u", trace[i].len);
Dave Barach11fb09e2020-08-06 12:10:09 -04001575 svm_fifo_dequeue_drop (placeholder_fifo, trace[i].len);
Florin Coras87b15ce2019-04-28 21:16:30 -07001576 }
1577 if (verbose)
Dave Barach11fb09e2020-08-06 12:10:09 -04001578 s = format (s, "%U", format_svm_fifo, placeholder_fifo, 1);
Florin Coras87b15ce2019-04-28 21:16:30 -07001579 }
1580
Dave Barach11fb09e2020-08-06 12:10:09 -04001581 s = format (s, "result: %U", format_svm_fifo, placeholder_fifo, 1);
Florin Coras87b15ce2019-04-28 21:16:30 -07001582
1583 return s;
1584}
1585
1586u8 *
1587format_ooo_list (u8 * s, va_list * args)
1588{
1589 svm_fifo_t *f = va_arg (*args, svm_fifo_t *);
1590 u32 indent = va_arg (*args, u32);
1591 u32 ooo_segment_index = f->ooos_list_head;
1592 ooo_segment_t *seg;
1593
1594 while (ooo_segment_index != OOO_SEGMENT_INVALID_INDEX)
1595 {
1596 seg = pool_elt_at_index (f->ooo_segments, ooo_segment_index);
1597 s = format (s, "%U%U\n", format_white_space, indent, format_ooo_segment,
1598 f, seg);
1599 ooo_segment_index = seg->next;
1600 }
1601
1602 return s;
1603}
1604
1605u8 *
1606format_svm_fifo (u8 * s, va_list * args)
1607{
1608 svm_fifo_t *f = va_arg (*args, svm_fifo_t *);
1609 int verbose = va_arg (*args, int);
1610 u32 indent;
1611
1612 if (!s)
1613 return s;
1614
1615 indent = format_get_indent (s);
Florin Corasf22f4e52019-12-19 16:10:58 -08001616 s = format (s, "cursize %u nitems %u has_event %d min_alloc %u\n",
1617 svm_fifo_max_dequeue (f), f->size, f->has_event, f->min_alloc);
Florin Coras87b15ce2019-04-28 21:16:30 -07001618 s = format (s, "%Uhead %u tail %u segment manager %u\n", format_white_space,
Florin Corasf22f4e52019-12-19 16:10:58 -08001619 indent, f->head, f->tail, f->segment_manager);
Florin Coras87b15ce2019-04-28 21:16:30 -07001620
1621 if (verbose > 1)
1622 s = format (s, "%Uvpp session %d thread %d app session %d thread %d\n",
1623 format_white_space, indent, f->master_session_index,
1624 f->master_thread_index, f->client_session_index,
1625 f->client_thread_index);
1626
1627 if (verbose)
1628 {
1629 s = format (s, "%Uooo pool %d active elts newest %u\n",
1630 format_white_space, indent, pool_elts (f->ooo_segments),
1631 f->ooos_newest);
1632 if (svm_fifo_has_ooo_data (f))
1633 s = format (s, " %U", format_ooo_list, f, indent, verbose);
1634 }
1635 return s;
1636}
1637
Florin Coras3aa7af32018-06-29 08:44:31 -07001638#endif
Dave Barach68b0fb02017-02-28 15:15:56 -05001639/*
1640 * fd.io coding-style-patch-verification: ON
1641 *
1642 * Local Variables:
1643 * eval: (c-set-style "gnu")
1644 * End:
1645 */