Line data Source code
1 : /*
2 : * Copyright (c) 2016-2019 Cisco and/or its affiliates.
3 : * Copyright (c) 2019 Arm Limited
4 : * Copyright (c) 2010-2017 Intel Corporation and/or its affiliates.
5 : * Copyright (c) 2007-2009 Kip Macy kmacy@freebsd.org
6 : * Inspired from DPDK rte_ring.h (SPSC only) (derived from freebsd bufring.h).
7 : * Licensed under the Apache License, Version 2.0 (the "License");
8 : * you may not use this file except in compliance with the License.
9 : * You may obtain a copy of the License at:
10 : *
11 : * http://www.apache.org/licenses/LICENSE-2.0
12 : *
13 : * Unless required by applicable law or agreed to in writing, software
14 : * distributed under the License is distributed on an "AS IS" BASIS,
15 : * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 : * See the License for the specific language governing permissions and
17 : * limitations under the License.
18 : */
19 :
20 : #include <svm/svm_fifo.h>
21 : #include <svm/fifo_segment.h>
22 : #include <vppinfra/cpu.h>
23 :
24 : #define F_INVALID_CPTR (fs_sptr_t) ~0ULL
25 :
26 1551906 : CLIB_MARCH_FN (svm_fifo_copy_to_chunk, void, svm_fifo_t *f,
27 : svm_fifo_chunk_t *c, u32 tail_idx, const u8 *src, u32 len,
28 : fs_sptr_t *last)
29 : {
30 : u32 n_chunk;
31 :
32 1549980 : ASSERT (f_pos_geq (tail_idx, c->start_byte)
33 : && f_pos_lt (tail_idx, c->start_byte + c->length));
34 :
35 1549980 : tail_idx -= c->start_byte;
36 1549980 : n_chunk = c->length - tail_idx;
37 1549980 : if (n_chunk <= len)
38 : {
39 220235 : u32 to_copy = len;
40 220235 : clib_memcpy_fast (&c->data[tail_idx], src, n_chunk);
41 220235 : c = f_cptr (f, c->next);
42 439452 : while ((to_copy -= n_chunk))
43 : {
44 219217 : n_chunk = clib_min (c->length, to_copy);
45 219217 : clib_memcpy_fast (&c->data[0], src + (len - to_copy), n_chunk);
46 219217 : c = c->length <= to_copy ? f_cptr (f, c->next) : c;
47 : }
48 220235 : if (*last)
49 220235 : *last = f_csptr (f, c);
50 : }
51 : else
52 : {
53 1329750 : clib_memcpy_fast (&c->data[tail_idx], src, len);
54 : }
55 1549980 : }
56 :
57 6394056 : CLIB_MARCH_FN (svm_fifo_copy_from_chunk, void, svm_fifo_t *f,
58 : svm_fifo_chunk_t *c, u32 head_idx, u8 *dst, u32 len,
59 : fs_sptr_t *last)
60 : {
61 : u32 n_chunk;
62 :
63 6392130 : ASSERT (f_pos_geq (head_idx, c->start_byte)
64 : && f_pos_lt (head_idx, c->start_byte + c->length));
65 :
66 6392130 : head_idx -= c->start_byte;
67 6392130 : n_chunk = c->length - head_idx;
68 6392130 : if (n_chunk <= len)
69 : {
70 212543 : u32 to_copy = len;
71 212543 : clib_memcpy_fast (dst, &c->data[head_idx], n_chunk);
72 212543 : c = f_cptr (f, c->next);
73 427196 : while ((to_copy -= n_chunk))
74 : {
75 214653 : clib_mem_unpoison (c, sizeof (*c));
76 214653 : clib_mem_unpoison (c->data, c->length);
77 214653 : n_chunk = clib_min (c->length, to_copy);
78 214653 : clib_memcpy_fast (dst + (len - to_copy), &c->data[0], n_chunk);
79 214653 : c = c->length <= to_copy ? f_cptr (f, c->next) : c;
80 : }
81 212543 : if (*last)
82 212543 : *last = f_csptr (f, c);
83 : }
84 : else
85 : {
86 6179590 : clib_memcpy_fast (dst, &c->data[head_idx], len);
87 : }
88 6392130 : }
89 :
90 : #ifndef CLIB_MARCH_VARIANT
91 :
92 : static inline void
93 1549980 : svm_fifo_copy_to_chunk (svm_fifo_t *f, svm_fifo_chunk_t *c, u32 tail_idx,
94 : const u8 *src, u32 len, fs_sptr_t *last)
95 : {
96 1549980 : CLIB_MARCH_FN_SELECT (svm_fifo_copy_to_chunk) (f, c, tail_idx, src, len,
97 : last);
98 1549980 : }
99 :
100 : static inline void
101 6392130 : svm_fifo_copy_from_chunk (svm_fifo_t *f, svm_fifo_chunk_t *c, u32 head_idx,
102 : u8 *dst, u32 len, fs_sptr_t *last)
103 : {
104 6392130 : CLIB_MARCH_FN_SELECT (svm_fifo_copy_from_chunk) (f, c, head_idx, dst, len,
105 : last);
106 6392130 : }
107 :
108 : static inline u32
109 35567 : ooo_segment_end_pos (ooo_segment_t * s)
110 : {
111 35567 : return (s->start + s->length);
112 : }
113 :
114 : void
115 705 : svm_fifo_free_ooo_data (svm_fifo_t * f)
116 : {
117 705 : pool_free (f->ooo_segments);
118 705 : }
119 :
120 : static inline ooo_segment_t *
121 30078 : ooo_segment_prev (svm_fifo_t * f, ooo_segment_t * s)
122 : {
123 30078 : if (s->prev == OOO_SEGMENT_INVALID_INDEX)
124 29572 : return 0;
125 506 : return pool_elt_at_index (f->ooo_segments, s->prev);
126 : }
127 :
128 : static inline ooo_segment_t *
129 8255 : ooo_segment_next (svm_fifo_t * f, ooo_segment_t * s)
130 : {
131 8255 : if (s->next == OOO_SEGMENT_INVALID_INDEX)
132 3294 : return 0;
133 4961 : return pool_elt_at_index (f->ooo_segments, s->next);
134 : }
135 :
136 : static inline ooo_segment_t *
137 5049 : ooo_segment_alloc (svm_fifo_t * f, u32 start, u32 length)
138 : {
139 : ooo_segment_t *s;
140 :
141 5049 : pool_get (f->ooo_segments, s);
142 :
143 5049 : s->start = start;
144 5049 : s->length = length;
145 5049 : s->prev = s->next = OOO_SEGMENT_INVALID_INDEX;
146 :
147 5049 : return s;
148 : }
149 :
150 : static inline void
151 5048 : ooo_segment_free (svm_fifo_t * f, u32 index)
152 : {
153 5048 : ooo_segment_t *cur, *prev = 0, *next = 0;
154 5048 : cur = pool_elt_at_index (f->ooo_segments, index);
155 :
156 5048 : if (cur->next != OOO_SEGMENT_INVALID_INDEX)
157 : {
158 4819 : next = pool_elt_at_index (f->ooo_segments, cur->next);
159 4819 : next->prev = cur->prev;
160 : }
161 :
162 5048 : if (cur->prev != OOO_SEGMENT_INVALID_INDEX)
163 : {
164 4925 : prev = pool_elt_at_index (f->ooo_segments, cur->prev);
165 4925 : prev->next = cur->next;
166 : }
167 : else
168 : {
169 123 : f->ooos_list_head = cur->next;
170 : }
171 :
172 5048 : pool_put (f->ooo_segments, cur);
173 5048 : }
174 :
175 : /**
176 : * Add segment to fifo's out-of-order segment list. Takes care of merging
177 : * adjacent segments and removing overlapping ones.
178 : */
179 : static void
180 30199 : ooo_segment_add (svm_fifo_t * f, u32 offset, u32 head, u32 tail, u32 length)
181 : {
182 : ooo_segment_t *s, *new_s, *prev, *next, *it;
183 : u32 new_index, s_end_pos, s_index;
184 : u32 offset_pos, offset_end_pos;
185 :
186 30199 : ASSERT (offset + length <= f_free_count (f, head, tail));
187 :
188 30199 : offset_pos = tail + offset;
189 30199 : offset_end_pos = tail + offset + length;
190 :
191 30199 : f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
192 :
193 30199 : if (f->ooos_list_head == OOO_SEGMENT_INVALID_INDEX)
194 : {
195 121 : s = ooo_segment_alloc (f, offset_pos, length);
196 121 : f->ooos_list_head = s - f->ooo_segments;
197 121 : f->ooos_newest = f->ooos_list_head;
198 121 : return;
199 : }
200 :
201 : /* Find first segment that starts after new segment */
202 30078 : s = pool_elt_at_index (f->ooo_segments, f->ooos_list_head);
203 31576 : while (s->next != OOO_SEGMENT_INVALID_INDEX
204 6763 : && f_pos_lt (s->start, offset_pos))
205 1498 : s = pool_elt_at_index (f->ooo_segments, s->next);
206 :
207 : /* If we have a previous and we overlap it, use it as starting point */
208 30078 : prev = ooo_segment_prev (f, s);
209 30078 : if (prev && f_pos_leq (offset_pos, ooo_segment_end_pos (prev)))
210 : {
211 154 : s = prev;
212 154 : s_end_pos = ooo_segment_end_pos (s);
213 :
214 : /* Since we have previous, offset start position cannot be smaller
215 : * than prev->start. Check tail */
216 154 : ASSERT (f_pos_lt (s->start, offset_pos));
217 154 : goto check_tail;
218 : }
219 :
220 29924 : s_index = s - f->ooo_segments;
221 29924 : s_end_pos = ooo_segment_end_pos (s);
222 :
223 : /* No overlap, add before current segment */
224 29924 : if (f_pos_lt (offset_end_pos, s->start))
225 : {
226 4905 : new_s = ooo_segment_alloc (f, offset_pos, length);
227 4905 : new_index = new_s - f->ooo_segments;
228 :
229 : /* Pool might've moved, get segment again */
230 4905 : s = pool_elt_at_index (f->ooo_segments, s_index);
231 4905 : if (s->prev != OOO_SEGMENT_INVALID_INDEX)
232 : {
233 5 : new_s->prev = s->prev;
234 5 : prev = pool_elt_at_index (f->ooo_segments, new_s->prev);
235 5 : prev->next = new_index;
236 : }
237 : else
238 : {
239 : /* New head */
240 4900 : f->ooos_list_head = new_index;
241 : }
242 :
243 4905 : new_s->next = s_index;
244 4905 : s->prev = new_index;
245 4905 : f->ooos_newest = new_index;
246 4905 : return;
247 : }
248 : /* No overlap, add after current segment */
249 25019 : else if (f_pos_gt (offset_pos, s_end_pos))
250 : {
251 23 : new_s = ooo_segment_alloc (f, offset_pos, length);
252 23 : new_index = new_s - f->ooo_segments;
253 :
254 : /* Pool might've moved, get segment again */
255 23 : s = pool_elt_at_index (f->ooo_segments, s_index);
256 :
257 : /* Needs to be last */
258 23 : ASSERT (s->next == OOO_SEGMENT_INVALID_INDEX);
259 :
260 23 : new_s->prev = s_index;
261 23 : s->next = new_index;
262 23 : f->ooos_newest = new_index;
263 :
264 23 : return;
265 : }
266 :
267 : /*
268 : * Merge needed
269 : */
270 :
271 : /* Merge at head */
272 24996 : if (f_pos_lt (offset_pos, s->start))
273 : {
274 21674 : s->start = offset_pos;
275 21674 : s->length = s_end_pos - s->start;
276 21674 : f->ooos_newest = s - f->ooo_segments;
277 : }
278 :
279 3322 : check_tail:
280 :
281 : /* Overlapping tail */
282 25150 : if (f_pos_gt (offset_end_pos, s_end_pos))
283 : {
284 3352 : s->length = offset_end_pos - s->start;
285 :
286 : /* Remove the completely overlapped segments in the tail */
287 3352 : it = ooo_segment_next (f, s);
288 8255 : while (it && f_pos_leq (ooo_segment_end_pos (it), offset_end_pos))
289 : {
290 4903 : next = ooo_segment_next (f, it);
291 4903 : ooo_segment_free (f, it - f->ooo_segments);
292 4903 : it = next;
293 : }
294 :
295 : /* If partial overlap with last, merge */
296 3352 : if (it && f_pos_leq (it->start, offset_end_pos))
297 : {
298 22 : s->length = ooo_segment_end_pos (it) - s->start;
299 22 : ooo_segment_free (f, it - f->ooo_segments);
300 : }
301 3352 : f->ooos_newest = s - f->ooo_segments;
302 : }
303 : }
304 :
305 : /**
306 : * Removes segments that can now be enqueued because the fifo's tail has
307 : * advanced. Returns the number of bytes added to tail.
308 : */
309 : static int
310 120 : ooo_segment_try_collect (svm_fifo_t * f, u32 n_bytes_enqueued, u32 * tail)
311 : {
312 120 : u32 s_index, bytes = 0;
313 : ooo_segment_t *s;
314 : i32 diff;
315 :
316 120 : s = pool_elt_at_index (f->ooo_segments, f->ooos_list_head);
317 120 : diff = *tail - s->start;
318 :
319 120 : ASSERT (diff != n_bytes_enqueued);
320 :
321 120 : if (diff > n_bytes_enqueued)
322 0 : return 0;
323 :
324 : /* If last tail update overlaps one/multiple ooo segments, remove them */
325 123 : while (0 <= diff && diff < n_bytes_enqueued)
326 : {
327 123 : s_index = s - f->ooo_segments;
328 :
329 : /* Segment end is beyond the tail. Advance tail and remove segment */
330 123 : if (s->length > diff)
331 : {
332 119 : bytes = s->length - diff;
333 119 : *tail = *tail + bytes;
334 119 : ooo_segment_free (f, s_index);
335 119 : break;
336 : }
337 :
338 : /* If we have next go on */
339 4 : if (s->next != OOO_SEGMENT_INVALID_INDEX)
340 : {
341 3 : s = pool_elt_at_index (f->ooo_segments, s->next);
342 3 : diff = *tail - s->start;
343 3 : ooo_segment_free (f, s_index);
344 : }
345 : /* End of search */
346 : else
347 : {
348 1 : ooo_segment_free (f, s_index);
349 1 : break;
350 : }
351 : }
352 :
353 120 : ASSERT (bytes <= f->shr->size);
354 120 : return bytes;
355 : }
356 :
357 : __clib_unused static ooo_segment_t *
358 0 : ooo_segment_last (svm_fifo_t * f)
359 : {
360 : ooo_segment_t *s;
361 :
362 0 : if (f->ooos_list_head == OOO_SEGMENT_INVALID_INDEX)
363 0 : return 0;
364 :
365 0 : s = svm_fifo_first_ooo_segment (f);
366 0 : while (s->next != OOO_SEGMENT_INVALID_INDEX)
367 0 : s = pool_elt_at_index (f->ooo_segments, s->next);
368 0 : return s;
369 : }
370 :
371 : void
372 993 : svm_fifo_init (svm_fifo_t * f, u32 size)
373 : {
374 : svm_fifo_chunk_t *c, *prev;
375 : u32 min_alloc;
376 :
377 993 : f->shr->size = size;
378 993 : f->ooos_list_head = OOO_SEGMENT_INVALID_INDEX;
379 993 : f->segment_index = SVM_FIFO_INVALID_INDEX;
380 993 : f->refcnt = 1;
381 993 : f->shr->head = f->shr->tail = f->flags = 0;
382 993 : f->shr->head_chunk = f->shr->tail_chunk = f->shr->start_chunk;
383 993 : f->ooo_deq = f->ooo_enq = 0;
384 :
385 993 : min_alloc = size > 32 << 10 ? size >> 3 : 4096;
386 993 : min_alloc = clib_min (min_alloc, 64 << 10);
387 993 : f->shr->min_alloc = min_alloc;
388 :
389 : /*
390 : * Initialize chunks
391 : */
392 993 : prev = f_start_cptr (f);
393 993 : prev->start_byte = 0;
394 993 : prev->enq_rb_index = prev->deq_rb_index = RBTREE_TNIL_INDEX;
395 993 : c = f_cptr (f, prev->next);
396 :
397 1073 : while (c)
398 : {
399 80 : c->start_byte = prev->start_byte + prev->length;
400 80 : c->enq_rb_index = c->deq_rb_index = RBTREE_TNIL_INDEX;
401 80 : ASSERT (c->length >= 1 << FS_MIN_LOG2_CHUNK_SZ);
402 80 : prev = c;
403 80 : c = f_cptr (f, c->next);
404 : }
405 993 : }
406 :
407 : void
408 553 : svm_fifo_init_ooo_lookup (svm_fifo_t * f, u8 ooo_type)
409 : {
410 553 : if (ooo_type == 0)
411 : {
412 267 : ASSERT (!rb_tree_is_init (&f->ooo_enq_lookup));
413 267 : rb_tree_init (&f->ooo_enq_lookup);
414 : }
415 : else
416 : {
417 286 : ASSERT (!rb_tree_is_init (&f->ooo_deq_lookup));
418 286 : rb_tree_init (&f->ooo_deq_lookup);
419 : }
420 553 : }
421 :
422 : /**
423 : * Creates a fifo in the current heap. Fails vs blow up the process
424 : */
425 : svm_fifo_t *
426 0 : svm_fifo_alloc (u32 data_size_in_bytes)
427 : {
428 : u32 rounded_data_size;
429 : svm_fifo_chunk_t *c;
430 : svm_fifo_t *f;
431 :
432 0 : f = clib_mem_alloc_aligned_or_null (sizeof (*f), CLIB_CACHE_LINE_BYTES);
433 0 : if (f == 0)
434 0 : return 0;
435 :
436 0 : clib_memset (f, 0, sizeof (*f));
437 :
438 : /* always round fifo data size to the next highest power-of-two */
439 0 : rounded_data_size = (1 << (max_log2 (data_size_in_bytes)));
440 0 : c = clib_mem_alloc_aligned_or_null (sizeof (*c) + rounded_data_size,
441 : CLIB_CACHE_LINE_BYTES);
442 0 : if (!c)
443 : {
444 0 : clib_mem_free (f);
445 0 : return 0;
446 : }
447 :
448 0 : clib_memset (c, 0, sizeof (*c));
449 0 : c->start_byte = 0;
450 0 : c->length = data_size_in_bytes;
451 0 : c->enq_rb_index = RBTREE_TNIL_INDEX;
452 0 : c->deq_rb_index = RBTREE_TNIL_INDEX;
453 0 : f->shr->start_chunk = f->shr->end_chunk = f_csptr (f, c);
454 :
455 0 : return f;
456 : }
457 :
458 : /**
459 : * Creates a fifo chunk in the current heap
460 : */
461 : svm_fifo_chunk_t *
462 0 : svm_fifo_chunk_alloc (u32 size)
463 : {
464 : svm_fifo_chunk_t *c;
465 : u32 rounded_size;
466 :
467 : /* round chunk size to the next highest power-of-two */
468 0 : rounded_size = (1 << (max_log2 (size)));
469 0 : c = clib_mem_alloc_aligned_or_null (sizeof (*c) + rounded_size,
470 : CLIB_CACHE_LINE_BYTES);
471 0 : if (c == 0)
472 0 : return 0;
473 :
474 0 : clib_memset (c, 0, sizeof (*c));
475 0 : c->length = rounded_size;
476 0 : return c;
477 : }
478 :
479 : /**
480 : * Find chunk for given byte position
481 : *
482 : * @param f fifo
483 : * @param pos normalized position in fifo
484 : *
485 : * @return chunk that includes given position or 0
486 : */
487 : static svm_fifo_chunk_t *
488 30241 : svm_fifo_find_chunk (svm_fifo_t * f, u32 pos)
489 : {
490 : svm_fifo_chunk_t *c;
491 :
492 30241 : c = f_start_cptr (f);
493 3707410 : while (c && !f_chunk_includes_pos (c, pos))
494 3677170 : c = f_cptr (f, c->next);
495 :
496 30241 : return c;
497 : }
498 :
499 : static svm_fifo_chunk_t *
500 980 : svm_fifo_find_next_chunk (svm_fifo_t * f, svm_fifo_chunk_t * start, u32 pos)
501 : {
502 : svm_fifo_chunk_t *c;
503 :
504 980 : ASSERT (start != 0);
505 :
506 980 : c = start;
507 2359 : while (c && !f_chunk_includes_pos (c, pos))
508 1379 : c = f_cptr (f, c->next);
509 :
510 980 : return c;
511 : }
512 :
513 : u32
514 2 : svm_fifo_max_read_chunk (svm_fifo_t * f)
515 : {
516 : u32 head, tail, end_chunk;
517 :
518 2 : f_load_head_tail_cons (f, &head, &tail);
519 2 : ASSERT (!f->shr->head_chunk || f_chunk_includes_pos (f_head_cptr (f), head));
520 :
521 2 : if (!f->shr->head_chunk)
522 : {
523 0 : f->shr->head_chunk = f_csptr (f, svm_fifo_find_chunk (f, head));
524 0 : if (PREDICT_FALSE (!f->shr->head_chunk))
525 0 : return 0;
526 : }
527 :
528 2 : end_chunk = f_chunk_end (f_head_cptr (f));
529 :
530 2 : return f_pos_lt (end_chunk, tail) ? end_chunk - head : tail - head;
531 : }
532 :
533 : u32
534 2 : svm_fifo_max_write_chunk (svm_fifo_t * f)
535 : {
536 : svm_fifo_chunk_t *tail_chunk;
537 : u32 head, tail;
538 :
539 2 : f_load_head_tail_prod (f, &head, &tail);
540 2 : tail_chunk = f_tail_cptr (f);
541 :
542 2 : ASSERT (!tail_chunk || f_chunk_includes_pos (tail_chunk, tail));
543 :
544 2 : return tail_chunk ? f_chunk_end (tail_chunk) - tail : 0;
545 : }
546 :
547 : static rb_node_t *
548 14245 : f_find_node_rbtree (rb_tree_t * rt, u32 pos)
549 : {
550 : rb_node_t *cur, *prev;
551 :
552 14245 : cur = rb_node (rt, rt->root);
553 14245 : if (PREDICT_FALSE (rb_node_is_tnil (rt, cur)))
554 0 : return 0;
555 :
556 1065900 : while (pos != cur->key)
557 : {
558 1053710 : prev = cur;
559 1053710 : if (f_pos_lt (pos, cur->key))
560 : {
561 6134 : cur = rb_node_left (rt, cur);
562 6134 : if (rb_node_is_tnil (rt, cur))
563 : {
564 1024 : cur = rb_tree_predecessor (rt, prev);
565 1024 : break;
566 : }
567 : }
568 : else
569 : {
570 1047570 : cur = rb_node_right (rt, cur);
571 1047570 : if (rb_node_is_tnil (rt, cur))
572 : {
573 1034 : cur = prev;
574 1034 : break;
575 : }
576 : }
577 : }
578 :
579 14245 : if (rb_node_is_tnil (rt, cur))
580 0 : return 0;
581 :
582 14245 : return cur;
583 : }
584 :
585 : static svm_fifo_chunk_t *
586 2063 : f_find_chunk_rbtree (rb_tree_t * rt, u32 pos)
587 : {
588 : svm_fifo_chunk_t *c;
589 : rb_node_t *n;
590 :
591 2063 : if (!rb_tree_is_init (rt))
592 0 : return 0;
593 :
594 2063 : n = f_find_node_rbtree (rt, pos);
595 2063 : if (!n)
596 0 : return 0;
597 2063 : c = uword_to_pointer (n->opaque, svm_fifo_chunk_t *);
598 2063 : if (f_chunk_includes_pos (c, pos))
599 2063 : return c;
600 :
601 0 : return 0;
602 : }
603 :
604 : static void
605 27 : f_update_ooo_enq (svm_fifo_t * f, u32 start_pos, u32 end_pos)
606 : {
607 27 : rb_tree_t *rt = &f->ooo_enq_lookup;
608 : svm_fifo_chunk_t *c;
609 : rb_node_t *cur;
610 :
611 : /* Use linear search if rbtree is not initialized */
612 27 : if (PREDICT_FALSE (!rb_tree_is_init (rt)))
613 : {
614 27 : f->ooo_enq = svm_fifo_find_next_chunk (f, f_tail_cptr (f), start_pos);
615 27 : return;
616 : }
617 :
618 0 : if (rt->root == RBTREE_TNIL_INDEX)
619 : {
620 0 : c = f_tail_cptr (f);
621 0 : ASSERT (c->enq_rb_index == RBTREE_TNIL_INDEX);
622 0 : c->enq_rb_index = rb_tree_add_custom (rt, c->start_byte,
623 : pointer_to_uword (c), f_pos_lt);
624 : }
625 : else
626 : {
627 0 : cur = f_find_node_rbtree (rt, start_pos);
628 0 : c = uword_to_pointer (cur->opaque, svm_fifo_chunk_t *);
629 0 : ASSERT (f_pos_leq (c->start_byte, start_pos));
630 : }
631 :
632 0 : if (f_chunk_includes_pos (c, start_pos))
633 0 : f->ooo_enq = c;
634 :
635 0 : if (f_chunk_includes_pos (c, end_pos))
636 0 : return;
637 :
638 : do
639 : {
640 0 : c = f_cptr (f, c->next);
641 0 : if (!c || c->enq_rb_index != RBTREE_TNIL_INDEX)
642 : break;
643 :
644 0 : c->enq_rb_index = rb_tree_add_custom (rt, c->start_byte,
645 : pointer_to_uword (c), f_pos_lt);
646 :
647 0 : if (f_chunk_includes_pos (c, start_pos))
648 0 : f->ooo_enq = c;
649 : }
650 0 : while (!f_chunk_includes_pos (c, end_pos));
651 : }
652 :
653 : static void
654 32572 : f_update_ooo_deq (svm_fifo_t * f, u32 start_pos, u32 end_pos)
655 : {
656 32572 : rb_tree_t *rt = &f->ooo_deq_lookup;
657 : rb_node_t *cur;
658 : svm_fifo_chunk_t *c;
659 :
660 : /* Use linear search if rbtree is not initialized */
661 32572 : if (PREDICT_FALSE (!rb_tree_is_init (rt)))
662 : {
663 22698 : f->ooo_deq = svm_fifo_find_chunk (f, start_pos);
664 22698 : return;
665 : }
666 :
667 9874 : if (rt->root == RBTREE_TNIL_INDEX)
668 : {
669 7816 : c = f_start_cptr (f);
670 7816 : ASSERT (c->deq_rb_index == RBTREE_TNIL_INDEX);
671 7816 : c->deq_rb_index = rb_tree_add_custom (rt, c->start_byte,
672 : pointer_to_uword (c), f_pos_lt);
673 : }
674 : else
675 : {
676 2058 : cur = f_find_node_rbtree (rt, start_pos);
677 2058 : c = uword_to_pointer (cur->opaque, svm_fifo_chunk_t *);
678 2058 : ASSERT (f_pos_leq (c->start_byte, start_pos));
679 : }
680 :
681 9874 : if (f_chunk_includes_pos (c, start_pos))
682 9870 : f->ooo_deq = c;
683 :
684 9874 : if (f_chunk_includes_pos (c, end_pos))
685 8337 : return;
686 :
687 : do
688 : {
689 3582 : c = f_cptr (f, c->next);
690 3582 : if (!c || c->deq_rb_index != RBTREE_TNIL_INDEX)
691 : break;
692 :
693 2557 : c->deq_rb_index = rb_tree_add_custom (rt, c->start_byte,
694 : pointer_to_uword (c), f_pos_lt);
695 :
696 2557 : if (f_chunk_includes_pos (c, start_pos))
697 4 : f->ooo_deq = c;
698 : }
699 2557 : while (!f_chunk_includes_pos (c, end_pos));
700 : }
701 :
702 : static svm_fifo_chunk_t *
703 120 : f_lookup_clear_enq_chunks (svm_fifo_t * f, svm_fifo_chunk_t * start,
704 : u32 end_pos)
705 : {
706 120 : rb_tree_t *rt = &f->ooo_enq_lookup;
707 : svm_fifo_chunk_t *c;
708 : rb_node_t *n;
709 :
710 120 : c = start;
711 1152 : while (c && !f_chunk_includes_pos (c, end_pos))
712 : {
713 1032 : if (c->enq_rb_index != RBTREE_TNIL_INDEX)
714 : {
715 0 : n = rb_node (rt, c->enq_rb_index);
716 0 : rb_tree_del_node (rt, n);
717 0 : c->enq_rb_index = RBTREE_TNIL_INDEX;
718 : }
719 :
720 1032 : c = f_cptr (f, c->next);
721 : }
722 :
723 : /* No ooo segments left, so make sure the current chunk
724 : * is not tracked in the enq rbtree */
725 120 : if (f->ooos_list_head == OOO_SEGMENT_INVALID_INDEX
726 120 : && c && c->enq_rb_index != RBTREE_TNIL_INDEX)
727 : {
728 0 : n = rb_node (rt, c->enq_rb_index);
729 0 : rb_tree_del_node (rt, n);
730 0 : c->enq_rb_index = RBTREE_TNIL_INDEX;
731 : }
732 :
733 120 : return c;
734 : }
735 :
736 : static svm_fifo_chunk_t *
737 121 : f_lookup_clear_deq_chunks (svm_fifo_t * f, svm_fifo_chunk_t * start,
738 : u32 end_pos)
739 : {
740 121 : rb_tree_t *rt = &f->ooo_deq_lookup;
741 : svm_fifo_chunk_t *c;
742 : rb_node_t *n;
743 :
744 121 : c = start;
745 153 : while (c && !f_chunk_includes_pos (c, end_pos))
746 : {
747 32 : if (c->deq_rb_index != RBTREE_TNIL_INDEX)
748 : {
749 2 : n = rb_node (rt, c->deq_rb_index);
750 2 : rb_tree_del_node (rt, n);
751 2 : c->deq_rb_index = RBTREE_TNIL_INDEX;
752 : }
753 :
754 32 : c = f_cptr (f, c->next);
755 : }
756 :
757 121 : return c;
758 : }
759 :
760 : void
761 705 : svm_fifo_free_chunk_lookup (svm_fifo_t * f)
762 : {
763 705 : rb_tree_free_nodes (&f->ooo_enq_lookup);
764 705 : rb_tree_free_nodes (&f->ooo_deq_lookup);
765 705 : }
766 :
767 : void
768 0 : svm_fifo_free (svm_fifo_t * f)
769 : {
770 0 : ASSERT (f->refcnt > 0);
771 :
772 0 : if (--f->refcnt == 0)
773 : {
774 : /* ooo data is not allocated on segment heap */
775 0 : svm_fifo_free_chunk_lookup (f);
776 0 : clib_mem_free (f);
777 : }
778 0 : }
779 :
780 : void
781 0 : svm_fifo_overwrite_head (svm_fifo_t * f, u8 * src, u32 len)
782 : {
783 : u32 n_chunk;
784 : u32 head, tail, head_idx;
785 : svm_fifo_chunk_t *c;
786 :
787 0 : ASSERT (len <= f->shr->size);
788 :
789 0 : f_load_head_tail_cons (f, &head, &tail);
790 :
791 0 : if (!f->shr->head_chunk)
792 0 : f->shr->head_chunk = f_csptr (f, svm_fifo_find_chunk (f, head));
793 :
794 0 : c = f_head_cptr (f);
795 0 : head_idx = head - c->start_byte;
796 0 : n_chunk = c->length - head_idx;
797 0 : if (len <= n_chunk)
798 0 : clib_memcpy_fast (&c->data[head_idx], src, len);
799 : else
800 : {
801 0 : ASSERT (len - n_chunk <= f_cptr (f, c->next)->length);
802 0 : clib_memcpy_fast (&c->data[head_idx], src, n_chunk);
803 0 : clib_memcpy_fast (&f_cptr (f, c->next)->data[0], src + n_chunk,
804 0 : len - n_chunk);
805 : }
806 0 : }
807 :
808 : static int
809 220968 : f_try_chunk_alloc (svm_fifo_t * f, u32 head, u32 tail, u32 len)
810 : {
811 : svm_fifo_chunk_t *c, *cur, *prev;
812 : u32 alloc_size, free_alloced;
813 :
814 220968 : prev = f_end_cptr (f);
815 220968 : free_alloced = f_chunk_end (prev) - tail;
816 :
817 220968 : alloc_size = clib_min (f->shr->min_alloc, f->shr->size - (tail - head));
818 220968 : alloc_size = clib_max (alloc_size, len - free_alloced);
819 :
820 220968 : c = fsh_alloc_chunk (f->fs_hdr, f->shr->slice_index, alloc_size);
821 220968 : if (PREDICT_FALSE (!c))
822 516 : return -1;
823 :
824 220452 : cur = c;
825 :
826 440934 : while (cur)
827 : {
828 220482 : cur->start_byte = prev->start_byte + prev->length;
829 220482 : cur->enq_rb_index = RBTREE_TNIL_INDEX;
830 220482 : cur->deq_rb_index = RBTREE_TNIL_INDEX;
831 :
832 220482 : prev = cur;
833 220482 : cur = f_cptr (f, cur->next);
834 : }
835 :
836 220452 : f_csptr_link (f, f->shr->end_chunk, c);
837 220452 : prev->next = 0;
838 220452 : f->shr->end_chunk = f_csptr (f, prev);
839 :
840 220452 : if (!f->shr->tail_chunk)
841 981 : f->shr->tail_chunk = f_csptr (f, c);
842 :
843 220452 : return 0;
844 : }
845 :
846 : int
847 4112600 : svm_fifo_enqueue (svm_fifo_t * f, u32 len, const u8 * src)
848 : {
849 : u32 tail, head, free_count;
850 : svm_fifo_chunk_t *old_tail_c;
851 :
852 4112600 : f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
853 :
854 4112600 : f_load_head_tail_prod (f, &head, &tail);
855 :
856 : /* free space in fifo can only increase during enqueue: SPSC */
857 4112600 : free_count = f_free_count (f, head, tail);
858 :
859 4112600 : if (PREDICT_FALSE (free_count == 0))
860 2832560 : return SVM_FIFO_EFULL;
861 :
862 : /* number of bytes we're going to copy */
863 1280040 : len = clib_min (free_count, len);
864 :
865 1280040 : if (f_pos_gt (tail + len, f_chunk_end (f_end_cptr (f))))
866 : {
867 201560 : if (PREDICT_FALSE (f_try_chunk_alloc (f, head, tail, len)))
868 : {
869 516 : len = f_chunk_end (f_end_cptr (f)) - tail;
870 516 : if (!len)
871 513 : return SVM_FIFO_EGROW;
872 : }
873 : }
874 :
875 1279530 : old_tail_c = f_tail_cptr (f);
876 :
877 1279530 : svm_fifo_copy_to_chunk (f, old_tail_c, tail, src, len, &f->shr->tail_chunk);
878 1279530 : tail = tail + len;
879 :
880 : svm_fifo_trace_add (f, head, len, 2);
881 :
882 : /* collect out-of-order segments */
883 1279530 : if (PREDICT_FALSE (f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX))
884 : {
885 120 : len += ooo_segment_try_collect (f, len, &tail);
886 : /* Tail chunk might've changed even if nothing was collected */
887 240 : f->shr->tail_chunk =
888 120 : f_csptr (f, f_lookup_clear_enq_chunks (f, old_tail_c, tail));
889 120 : f->ooo_enq = 0;
890 : }
891 :
892 : /* store-rel: producer owned index (paired with load-acq in consumer) */
893 1279530 : clib_atomic_store_rel_n (&f->shr->tail, tail);
894 :
895 1279530 : return len;
896 : }
897 :
898 : /**
899 : * Enqueue a future segment.
900 : *
901 : * Two choices: either copies the entire segment, or copies nothing
902 : * Returns 0 of the entire segment was copied
903 : * Returns -1 if none of the segment was copied due to lack of space
904 : */
905 : int
906 30199 : svm_fifo_enqueue_with_offset (svm_fifo_t * f, u32 offset, u32 len, u8 * src)
907 : {
908 : u32 tail, head, free_count, enq_pos;
909 30199 : fs_sptr_t last = F_INVALID_CPTR;
910 :
911 30199 : f_load_head_tail_prod (f, &head, &tail);
912 :
913 : /* free space in fifo can only increase during enqueue: SPSC */
914 30199 : free_count = f_free_count (f, head, tail);
915 30199 : f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
916 :
917 : /* will this request fit? */
918 30199 : if ((len + offset) > free_count)
919 0 : return SVM_FIFO_EFULL;
920 :
921 30199 : enq_pos = tail + offset;
922 :
923 30199 : if (f_pos_gt (enq_pos + len, f_chunk_end (f_end_cptr (f))))
924 : {
925 1033 : if (PREDICT_FALSE (f_try_chunk_alloc (f, head, tail, offset + len)))
926 0 : return SVM_FIFO_EGROW;
927 : }
928 :
929 : svm_fifo_trace_add (f, offset, len, 1);
930 30199 : ooo_segment_add (f, offset, head, tail, len);
931 :
932 30199 : if (!f->ooo_enq || !f_chunk_includes_pos (f->ooo_enq, enq_pos))
933 27 : f_update_ooo_enq (f, enq_pos, enq_pos + len);
934 :
935 30199 : svm_fifo_copy_to_chunk (f, f->ooo_enq, enq_pos, src, len, &last);
936 30199 : if (last != F_INVALID_CPTR)
937 1036 : f->ooo_enq = f_cptr (f, last);
938 :
939 30199 : return 0;
940 : }
941 :
942 : /**
943 : * Advance tail
944 : */
945 : void
946 951 : svm_fifo_enqueue_nocopy (svm_fifo_t * f, u32 len)
947 : {
948 : u32 tail;
949 :
950 951 : ASSERT (len <= svm_fifo_max_enqueue_prod (f));
951 : /* load-relaxed: producer owned index */
952 951 : tail = f->shr->tail;
953 951 : tail = tail + len;
954 :
955 951 : if (rb_tree_is_init (&f->ooo_enq_lookup))
956 : {
957 0 : f->shr->tail_chunk =
958 0 : f_csptr (f, f_lookup_clear_enq_chunks (f, f_tail_cptr (f), tail));
959 0 : f->ooo_enq = 0;
960 : }
961 : else
962 : {
963 951 : f->shr->tail_chunk =
964 951 : f_csptr (f, svm_fifo_find_next_chunk (f, f_tail_cptr (f), tail));
965 : }
966 :
967 : /* store-rel: producer owned index (paired with load-acq in consumer) */
968 951 : clib_atomic_store_rel_n (&f->shr->tail, tail);
969 951 : }
970 :
971 : int
972 120129 : svm_fifo_enqueue_segments (svm_fifo_t * f, const svm_fifo_seg_t segs[],
973 : u32 n_segs, u8 allow_partial)
974 : {
975 120129 : u32 tail, head, free_count, len = 0, i;
976 : svm_fifo_chunk_t *old_tail_c;
977 :
978 120129 : f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
979 :
980 120129 : f_load_head_tail_prod (f, &head, &tail);
981 :
982 : /* free space in fifo can only increase during enqueue: SPSC */
983 120129 : free_count = f_free_count (f, head, tail);
984 :
985 120129 : if (PREDICT_FALSE (free_count == 0))
986 0 : return SVM_FIFO_EFULL;
987 :
988 360387 : for (i = 0; i < n_segs; i++)
989 240258 : len += segs[i].len;
990 :
991 120129 : old_tail_c = f_tail_cptr (f);
992 :
993 120129 : if (!allow_partial)
994 : {
995 120129 : if (PREDICT_FALSE (free_count < len))
996 0 : return SVM_FIFO_EFULL;
997 :
998 120129 : if (f_pos_gt (tail + len, f_chunk_end (f_end_cptr (f))))
999 : {
1000 17785 : if (PREDICT_FALSE (f_try_chunk_alloc (f, head, tail, len)))
1001 0 : return SVM_FIFO_EGROW;
1002 : }
1003 :
1004 360387 : for (i = 0; i < n_segs; i++)
1005 : {
1006 240258 : svm_fifo_copy_to_chunk (f, f_tail_cptr (f), tail, segs[i].data,
1007 240258 : segs[i].len, &f->shr->tail_chunk);
1008 240258 : tail += segs[i].len;
1009 : }
1010 : }
1011 : else
1012 : {
1013 0 : u32 n_left = clib_min (free_count, len);
1014 :
1015 0 : if (f_pos_gt (tail + n_left, f_chunk_end (f_end_cptr (f))))
1016 : {
1017 0 : if (PREDICT_FALSE (f_try_chunk_alloc (f, head, tail, n_left)))
1018 : {
1019 0 : n_left = f_chunk_end (f_end_cptr (f)) - tail;
1020 0 : if (!n_left)
1021 0 : return SVM_FIFO_EGROW;
1022 : }
1023 : }
1024 :
1025 0 : len = n_left;
1026 0 : i = 0;
1027 0 : while (n_left)
1028 : {
1029 0 : u32 to_copy = clib_min (segs[i].len, n_left);
1030 0 : svm_fifo_copy_to_chunk (f, f_tail_cptr (f), tail, segs[i].data,
1031 0 : to_copy, &f->shr->tail_chunk);
1032 0 : n_left -= to_copy;
1033 0 : tail += to_copy;
1034 0 : i++;
1035 : }
1036 : }
1037 :
1038 : /* collect out-of-order segments */
1039 120129 : if (PREDICT_FALSE (f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX))
1040 : {
1041 0 : len += ooo_segment_try_collect (f, len, &tail);
1042 : /* Tail chunk might've changed even if nothing was collected */
1043 0 : f->shr->tail_chunk =
1044 0 : f_csptr (f, f_lookup_clear_enq_chunks (f, old_tail_c, tail));
1045 0 : f->ooo_enq = 0;
1046 : }
1047 :
1048 : /* store-rel: producer owned index (paired with load-acq in consumer) */
1049 120129 : clib_atomic_store_rel_n (&f->shr->tail, tail);
1050 :
1051 120129 : return len;
1052 : }
1053 :
1054 : always_inline svm_fifo_chunk_t *
1055 211537 : f_unlink_chunks (svm_fifo_t * f, u32 end_pos, u8 maybe_ooo)
1056 : {
1057 211537 : svm_fifo_chunk_t *start, *prev = 0, *c;
1058 : rb_tree_t *rt;
1059 : rb_node_t *n;
1060 :
1061 211537 : if (maybe_ooo)
1062 46576 : rt = &f->ooo_deq_lookup;
1063 :
1064 211537 : c = f_start_cptr (f);
1065 211537 : ASSERT (!f_chunk_includes_pos (c, end_pos));
1066 :
1067 : do
1068 : {
1069 219465 : if (maybe_ooo && c->deq_rb_index != RBTREE_TNIL_INDEX)
1070 : {
1071 10124 : n = rb_node (rt, c->deq_rb_index);
1072 10124 : ASSERT (n == f_find_node_rbtree (rt, c->start_byte));
1073 10124 : rb_tree_del_node (rt, n);
1074 10124 : c->deq_rb_index = RBTREE_TNIL_INDEX;
1075 : }
1076 219465 : if (!c->next)
1077 99 : break;
1078 219366 : prev = c;
1079 219366 : c = f_cptr (f, c->next);
1080 : }
1081 219366 : while (!f_chunk_includes_pos (c, end_pos));
1082 :
1083 211537 : if (maybe_ooo)
1084 : {
1085 46576 : if (f->ooo_deq && f_pos_lt (f->ooo_deq->start_byte, f_chunk_end (c)))
1086 20733 : f->ooo_deq = 0;
1087 : }
1088 : else
1089 : {
1090 164961 : if (PREDICT_FALSE (f->ooo_deq != 0))
1091 4 : f->ooo_deq = 0;
1092 : }
1093 :
1094 : /* Avoid unlinking the last chunk */
1095 211537 : if (!prev)
1096 87 : return 0;
1097 :
1098 211450 : prev->next = 0;
1099 211450 : start = f_start_cptr (f);
1100 211450 : f->shr->start_chunk = f_csptr (f, c);
1101 :
1102 211450 : return start;
1103 : }
1104 :
1105 : int
1106 7750040 : svm_fifo_dequeue (svm_fifo_t * f, u32 len, u8 * dst)
1107 : {
1108 : u32 tail, head, cursize;
1109 :
1110 7750040 : f_load_head_tail_cons (f, &head, &tail);
1111 :
1112 : /* current size of fifo can only increase during dequeue: SPSC */
1113 7750040 : cursize = f_cursize (f, head, tail);
1114 :
1115 7750040 : if (PREDICT_FALSE (cursize == 0))
1116 6914740 : return SVM_FIFO_EEMPTY;
1117 :
1118 835298 : len = clib_min (cursize, len);
1119 :
1120 835298 : if (!f->shr->head_chunk)
1121 30 : f->shr->head_chunk = f_csptr (f, svm_fifo_find_chunk (f, head));
1122 :
1123 835298 : svm_fifo_copy_from_chunk (f, f_head_cptr (f), head, dst, len,
1124 835298 : &f->shr->head_chunk);
1125 835298 : head = head + len;
1126 :
1127 : /* In order dequeues are not supported in combination with ooo peeking.
1128 : * Use svm_fifo_dequeue_drop instead. */
1129 835298 : ASSERT (rb_tree_n_nodes (&f->ooo_deq_lookup) <= 1);
1130 :
1131 835298 : if (f_pos_geq (head, f_chunk_end (f_start_cptr (f))))
1132 164943 : fsh_collect_chunks (f->fs_hdr, f->shr->slice_index,
1133 : f_unlink_chunks (f, head, 0));
1134 :
1135 : /* store-rel: consumer owned index (paired with load-acq in producer) */
1136 835298 : clib_atomic_store_rel_n (&f->shr->head, head);
1137 :
1138 835298 : return len;
1139 : }
1140 :
1141 : int
1142 5556830 : svm_fifo_peek (svm_fifo_t * f, u32 offset, u32 len, u8 * dst)
1143 : {
1144 : u32 tail, head, cursize, head_idx;
1145 5556830 : fs_sptr_t last = F_INVALID_CPTR;
1146 :
1147 5556830 : f_load_head_tail_cons (f, &head, &tail);
1148 :
1149 : /* current size of fifo can only increase during peek: SPSC */
1150 5556830 : cursize = f_cursize (f, head, tail);
1151 :
1152 5556830 : if (PREDICT_FALSE (cursize < offset))
1153 0 : return SVM_FIFO_EEMPTY;
1154 :
1155 5556830 : len = clib_min (cursize - offset, len);
1156 5556830 : head_idx = head + offset;
1157 :
1158 5556830 : clib_mem_unpoison (f->ooo_deq, sizeof (*f->ooo_deq));
1159 5556830 : if (!f->ooo_deq || !f_chunk_includes_pos (f->ooo_deq, head_idx))
1160 32572 : f_update_ooo_deq (f, head_idx, head_idx + len);
1161 :
1162 5556830 : svm_fifo_copy_from_chunk (f, f->ooo_deq, head_idx, dst, len, &last);
1163 5556830 : if (last != F_INVALID_CPTR)
1164 47630 : f->ooo_deq = f_cptr (f, last);
1165 5556830 : return len;
1166 : }
1167 :
1168 : int
1169 126672 : svm_fifo_dequeue_drop (svm_fifo_t * f, u32 len)
1170 : {
1171 : u32 total_drop_bytes, tail, head, cursize;
1172 :
1173 126672 : f_load_head_tail_cons (f, &head, &tail);
1174 :
1175 : /* number of bytes available */
1176 126672 : cursize = f_cursize (f, head, tail);
1177 126672 : if (PREDICT_FALSE (cursize == 0))
1178 387 : return SVM_FIFO_EEMPTY;
1179 :
1180 : /* number of bytes we're going to drop */
1181 126285 : total_drop_bytes = clib_min (cursize, len);
1182 :
1183 : svm_fifo_trace_add (f, tail, total_drop_bytes, 3);
1184 :
1185 : /* move head */
1186 126285 : head = head + total_drop_bytes;
1187 :
1188 126285 : if (f_pos_geq (head, f_chunk_end (f_start_cptr (f))))
1189 : {
1190 46576 : fsh_collect_chunks (f->fs_hdr, f->shr->slice_index,
1191 : f_unlink_chunks (f, head, 1));
1192 93152 : f->shr->head_chunk = f_chunk_includes_pos (f_start_cptr (f), head) ?
1193 46576 : f->shr->start_chunk :
1194 : 0;
1195 : }
1196 :
1197 : /* store-rel: consumer owned index (paired with load-acq in producer) */
1198 126285 : clib_atomic_store_rel_n (&f->shr->head, head);
1199 :
1200 126285 : return total_drop_bytes;
1201 : }
1202 :
1203 : /**
1204 : * Drop all data from fifo
1205 : *
1206 : */
1207 : void
1208 121 : svm_fifo_dequeue_drop_all (svm_fifo_t * f)
1209 : {
1210 : u32 head, tail;
1211 :
1212 121 : f_load_head_tail_all_acq (f, &head, &tail);
1213 :
1214 121 : if (!f->shr->head_chunk || !f_chunk_includes_pos (f_head_cptr (f), head))
1215 10 : f->shr->head_chunk = f_csptr (f, svm_fifo_find_chunk (f, head));
1216 :
1217 242 : f->shr->head_chunk =
1218 121 : f_csptr (f, f_lookup_clear_deq_chunks (f, f_head_cptr (f), tail));
1219 :
1220 121 : if (f_pos_geq (tail, f_chunk_end (f_start_cptr (f))))
1221 18 : fsh_collect_chunks (f->fs_hdr, f->shr->slice_index,
1222 : f_unlink_chunks (f, tail, 0));
1223 :
1224 : /* store-rel: consumer owned index (paired with load-acq in producer) */
1225 121 : clib_atomic_store_rel_n (&f->shr->head, tail);
1226 121 : }
1227 :
1228 : int
1229 89 : svm_fifo_fill_chunk_list (svm_fifo_t * f)
1230 : {
1231 : u32 head, tail;
1232 :
1233 89 : f_load_head_tail_prod (f, &head, &tail);
1234 :
1235 89 : if (f_chunk_end (f_end_cptr (f)) - head >= f->shr->size)
1236 63 : return 0;
1237 :
1238 26 : if (f_try_chunk_alloc (f, head, tail, f->shr->size - (tail - head)))
1239 0 : return SVM_FIFO_EGROW;
1240 :
1241 26 : return 0;
1242 : }
1243 :
1244 : int
1245 3096 : svm_fifo_provision_chunks (svm_fifo_t *f, svm_fifo_seg_t *fs, u32 n_segs,
1246 : u32 len)
1247 : {
1248 3096 : u32 head, tail, n_avail, head_pos, n_bytes, fs_index = 1, clen;
1249 : svm_fifo_chunk_t *c;
1250 :
1251 3096 : f_load_head_tail_prod (f, &head, &tail);
1252 :
1253 3096 : if (f_free_count (f, head, tail) < len)
1254 0 : return SVM_FIFO_EFULL;
1255 :
1256 3096 : n_avail = f_chunk_end (f_end_cptr (f)) - tail;
1257 :
1258 3096 : if (n_avail < len && f_try_chunk_alloc (f, head, tail, len))
1259 0 : return SVM_FIFO_EGROW;
1260 :
1261 3096 : if (!fs || !n_segs)
1262 1583 : return 0;
1263 :
1264 1513 : c = f_tail_cptr (f);
1265 1513 : head_pos = (tail - c->start_byte);
1266 1513 : fs[0].data = c->data + head_pos;
1267 1513 : fs[0].len = clib_min (c->length - head_pos, len);
1268 1513 : n_bytes = fs[0].len;
1269 :
1270 3008 : while (n_bytes < len && fs_index < n_segs)
1271 : {
1272 1495 : c = f_cptr (f, c->next);
1273 1495 : clen = clib_min (c->length, len - n_bytes);
1274 1495 : fs[fs_index].data = c->data;
1275 1495 : fs[fs_index].len = clen;
1276 1495 : n_bytes += clen;
1277 1495 : fs_index += 1;
1278 : }
1279 :
1280 1513 : return fs_index;
1281 : }
1282 :
1283 : int
1284 583 : svm_fifo_segments (svm_fifo_t *f, u32 offset, svm_fifo_seg_t *fs, u32 *n_segs,
1285 : u32 max_bytes)
1286 : {
1287 583 : u32 cursize, to_read, head, tail, fs_index = 1;
1288 : u32 n_bytes, head_pos, len, start;
1289 : svm_fifo_chunk_t *c;
1290 :
1291 583 : f_load_head_tail_cons (f, &head, &tail);
1292 :
1293 : /* consumer function, cursize can only increase while we're working */
1294 583 : cursize = f_cursize (f, head, tail);
1295 :
1296 583 : if (PREDICT_FALSE (cursize == 0))
1297 0 : return SVM_FIFO_EEMPTY;
1298 :
1299 583 : if (offset >= cursize)
1300 0 : return SVM_FIFO_EEMPTY;
1301 :
1302 583 : to_read = clib_min (cursize - offset, max_bytes);
1303 583 : start = head + offset;
1304 :
1305 583 : if (!f->shr->head_chunk)
1306 0 : f->shr->head_chunk = f_csptr (f, svm_fifo_find_chunk (f, head));
1307 :
1308 583 : c = f_head_cptr (f);
1309 :
1310 583 : while (!f_chunk_includes_pos (c, start))
1311 0 : c = f_cptr (f, c->next);
1312 :
1313 583 : head_pos = start - c->start_byte;
1314 583 : fs[0].data = c->data + head_pos;
1315 583 : fs[0].len = clib_min (c->length - head_pos, to_read);
1316 583 : n_bytes = fs[0].len;
1317 :
1318 1137 : while (n_bytes < to_read && fs_index < *n_segs)
1319 : {
1320 554 : c = f_cptr (f, c->next);
1321 554 : len = clib_min (c->length, to_read - n_bytes);
1322 554 : fs[fs_index].data = c->data;
1323 554 : fs[fs_index].len = len;
1324 554 : n_bytes += len;
1325 554 : fs_index += 1;
1326 : }
1327 583 : *n_segs = fs_index;
1328 :
1329 583 : return n_bytes;
1330 : }
1331 :
1332 : /**
1333 : * Clones fifo
1334 : *
1335 : * Assumptions:
1336 : * - no prod and cons are accessing either dest or src fifo
1337 : * - fifo is not multi chunk
1338 : */
1339 : void
1340 0 : svm_fifo_clone (svm_fifo_t * df, svm_fifo_t * sf)
1341 : {
1342 : u32 head, tail;
1343 :
1344 : /* Support only single chunk clones for now */
1345 0 : ASSERT (svm_fifo_n_chunks (sf) == 1);
1346 :
1347 0 : clib_memcpy_fast (f_head_cptr (df)->data, f_head_cptr (sf)->data,
1348 0 : f_head_cptr (sf)->length);
1349 :
1350 0 : f_load_head_tail_all_acq (sf, &head, &tail);
1351 0 : clib_atomic_store_rel_n (&df->shr->head, head);
1352 0 : clib_atomic_store_rel_n (&df->shr->tail, tail);
1353 0 : }
1354 :
1355 : u32
1356 5239 : svm_fifo_n_ooo_segments (svm_fifo_t * f)
1357 : {
1358 5239 : return pool_elts (f->ooo_segments);
1359 : }
1360 :
1361 : ooo_segment_t *
1362 7 : svm_fifo_first_ooo_segment (svm_fifo_t * f)
1363 : {
1364 7 : return pool_elt_at_index (f->ooo_segments, f->ooos_list_head);
1365 : }
1366 :
1367 : /**
1368 : * Set fifo pointers to requested offset
1369 : */
1370 : void
1371 110 : svm_fifo_init_pointers (svm_fifo_t * f, u32 head, u32 tail)
1372 : {
1373 : svm_fifo_chunk_t *c;
1374 :
1375 110 : clib_atomic_store_rel_n (&f->shr->head, head);
1376 110 : clib_atomic_store_rel_n (&f->shr->tail, tail);
1377 :
1378 110 : c = svm_fifo_find_chunk (f, head);
1379 110 : ASSERT (c != 0);
1380 110 : f->ooo_deq = c;
1381 110 : f->shr->head_chunk = f_csptr (f, c);
1382 110 : c = svm_fifo_find_chunk (f, tail);
1383 110 : ASSERT (c != 0);
1384 110 : f->ooo_enq = c;
1385 110 : f->shr->tail_chunk = f_csptr (f, c);
1386 110 : }
1387 :
1388 : void
1389 0 : svm_fifo_add_subscriber (svm_fifo_t * f, u8 subscriber)
1390 : {
1391 0 : if (f->shr->n_subscribers >= SVM_FIFO_MAX_EVT_SUBSCRIBERS)
1392 0 : return;
1393 0 : f->shr->subscribers[f->shr->n_subscribers++] = subscriber;
1394 : }
1395 :
1396 : void
1397 0 : svm_fifo_del_subscriber (svm_fifo_t * f, u8 subscriber)
1398 : {
1399 : int i;
1400 :
1401 0 : for (i = 0; i < f->shr->n_subscribers; i++)
1402 : {
1403 0 : if (f->shr->subscribers[i] != subscriber)
1404 0 : continue;
1405 0 : f->shr->subscribers[i] = f->shr->subscribers[f->shr->n_subscribers - 1];
1406 0 : f->shr->n_subscribers--;
1407 0 : break;
1408 : }
1409 0 : }
1410 :
1411 : u8
1412 36 : svm_fifo_is_sane (svm_fifo_t * f)
1413 : {
1414 : svm_fifo_chunk_t *tmp;
1415 :
1416 61 : if (f->shr->head_chunk &&
1417 25 : !f_chunk_includes_pos (f_head_cptr (f), f->shr->head))
1418 0 : return 0;
1419 59 : if (f->shr->tail_chunk &&
1420 23 : !f_chunk_includes_pos (f_tail_cptr (f), f->shr->tail))
1421 0 : return 0;
1422 36 : if (f->ooo_deq)
1423 : {
1424 5 : if (rb_tree_is_init (&f->ooo_deq_lookup))
1425 : {
1426 5 : if (f_pos_lt (f->ooo_deq->start_byte,
1427 10 : f_start_cptr (f)->start_byte) ||
1428 5 : f_pos_gt (f->ooo_deq->start_byte, f_chunk_end (f_end_cptr (f))))
1429 0 : return 0;
1430 :
1431 5 : tmp = f_find_chunk_rbtree (&f->ooo_deq_lookup,
1432 5 : f->ooo_deq->start_byte);
1433 : }
1434 : else
1435 0 : tmp = svm_fifo_find_chunk (f, f->ooo_deq->start_byte);
1436 5 : if (tmp != f->ooo_deq)
1437 0 : return 0;
1438 : }
1439 36 : if (f->ooo_enq)
1440 : {
1441 2 : if (rb_tree_is_init (&f->ooo_enq_lookup))
1442 : {
1443 0 : if (f_pos_lt (f->ooo_enq->start_byte,
1444 0 : f_start_cptr (f)->start_byte) ||
1445 0 : f_pos_gt (f->ooo_enq->start_byte, f_chunk_end (f_end_cptr (f))))
1446 0 : return 0;
1447 :
1448 0 : tmp = f_find_chunk_rbtree (&f->ooo_enq_lookup,
1449 0 : f->ooo_enq->start_byte);
1450 : }
1451 : else
1452 : {
1453 2 : tmp = svm_fifo_find_next_chunk (f, f_tail_cptr (f),
1454 2 : f->ooo_enq->start_byte);
1455 : }
1456 2 : if (tmp != f->ooo_enq)
1457 0 : return 0;
1458 : }
1459 :
1460 36 : if (f_start_cptr (f)->next)
1461 : {
1462 26 : svm_fifo_chunk_t *c, *prev = 0, *tmp;
1463 26 : u32 chunks_bytes = 0;
1464 :
1465 26 : c = f_start_cptr (f);
1466 : do
1467 : {
1468 7283 : tmp = svm_fifo_find_chunk (f, c->start_byte);
1469 7283 : if (tmp != c)
1470 0 : return 0;
1471 7283 : if (prev && (prev->start_byte + prev->length != c->start_byte))
1472 0 : return 0;
1473 :
1474 7283 : if (c->enq_rb_index != RBTREE_TNIL_INDEX)
1475 : {
1476 0 : tmp = f_find_chunk_rbtree (&f->ooo_enq_lookup, c->start_byte);
1477 0 : if (tmp)
1478 : {
1479 0 : if (tmp != c)
1480 0 : return 0;
1481 : }
1482 : }
1483 7283 : if (c->deq_rb_index != RBTREE_TNIL_INDEX)
1484 : {
1485 2058 : tmp = f_find_chunk_rbtree (&f->ooo_deq_lookup, c->start_byte);
1486 2058 : if (tmp)
1487 : {
1488 2058 : if (tmp != c)
1489 0 : return 0;
1490 : }
1491 : }
1492 :
1493 7283 : chunks_bytes += c->length;
1494 7283 : prev = c;
1495 7283 : c = f_cptr (f, c->next);
1496 : }
1497 7283 : while (c);
1498 :
1499 26 : if (chunks_bytes < f->shr->tail - f->shr->head)
1500 0 : return 0;
1501 : }
1502 :
1503 36 : return 1;
1504 : }
1505 :
1506 : u32
1507 18 : svm_fifo_n_chunks (svm_fifo_t * f)
1508 : {
1509 : svm_fifo_chunk_t *c;
1510 18 : int n_chunks = 0;
1511 :
1512 18 : c = f_start_cptr (f);
1513 6182 : while (c)
1514 : {
1515 6164 : n_chunks++;
1516 6164 : c = f_cptr (f, c->next);
1517 : }
1518 :
1519 18 : return n_chunks;
1520 : }
1521 :
1522 : u8 *
1523 0 : format_ooo_segment (u8 * s, va_list * args)
1524 : {
1525 0 : svm_fifo_t __clib_unused *f = va_arg (*args, svm_fifo_t *);
1526 0 : ooo_segment_t *seg = va_arg (*args, ooo_segment_t *);
1527 0 : s = format (s, "[%u, %u], len %u, next %d, prev %d", seg->start,
1528 0 : seg->start + seg->length, seg->length, seg->next, seg->prev);
1529 0 : return s;
1530 : }
1531 :
1532 : u8 *
1533 0 : svm_fifo_dump_trace (u8 * s, svm_fifo_t * f)
1534 : {
1535 : #if SVM_FIFO_TRACE
1536 : svm_fifo_trace_elem_t *seg = 0;
1537 : int i = 0;
1538 :
1539 : if (f->trace)
1540 : {
1541 : vec_foreach (seg, f->trace)
1542 : {
1543 : s = format (s, "{%u, %u, %u}, ", seg->offset, seg->len, seg->action);
1544 : i++;
1545 : if (i % 5 == 0)
1546 : s = format (s, "\n");
1547 : }
1548 : s = format (s, "\n");
1549 : }
1550 : return s;
1551 : #else
1552 0 : return 0;
1553 : #endif
1554 : }
1555 :
1556 : u8 *
1557 0 : svm_fifo_replay (u8 * s, svm_fifo_t * f, u8 no_read, u8 verbose)
1558 : {
1559 : int i, trace_len;
1560 0 : u8 *data = 0;
1561 : svm_fifo_trace_elem_t *trace;
1562 : u32 offset;
1563 : svm_fifo_t *placeholder_fifo;
1564 :
1565 0 : if (!f)
1566 0 : return s;
1567 :
1568 : #if SVM_FIFO_TRACE
1569 : trace = f->trace;
1570 : trace_len = vec_len (trace);
1571 : #else
1572 0 : trace = 0;
1573 0 : trace_len = 0;
1574 : #endif
1575 :
1576 0 : placeholder_fifo = svm_fifo_alloc (f->shr->size);
1577 0 : svm_fifo_init (f, f->shr->size);
1578 0 : clib_memset (f_head_cptr (f)->data, 0xFF, f->shr->size);
1579 0 : vec_validate (data, f->shr->size);
1580 0 : for (i = 0; i < vec_len (data); i++)
1581 0 : data[i] = i;
1582 :
1583 0 : for (i = 0; i < trace_len; i++)
1584 : {
1585 0 : offset = trace[i].offset;
1586 0 : if (trace[i].action == 1)
1587 : {
1588 0 : if (verbose)
1589 0 : s = format (s, "adding [%u, %u]:", trace[i].offset,
1590 0 : (trace[i].offset + trace[i].len));
1591 0 : svm_fifo_enqueue_with_offset (placeholder_fifo, trace[i].offset,
1592 0 : trace[i].len, &data[offset]);
1593 : }
1594 0 : else if (trace[i].action == 2)
1595 : {
1596 0 : if (verbose)
1597 0 : s = format (s, "adding [%u, %u]:", 0, trace[i].len);
1598 0 : svm_fifo_enqueue (placeholder_fifo, trace[i].len, &data[offset]);
1599 : }
1600 0 : else if (!no_read)
1601 : {
1602 0 : if (verbose)
1603 0 : s = format (s, "read: %u", trace[i].len);
1604 0 : svm_fifo_dequeue_drop (placeholder_fifo, trace[i].len);
1605 : }
1606 0 : if (verbose)
1607 0 : s = format (s, "%U", format_svm_fifo, placeholder_fifo, 1);
1608 : }
1609 :
1610 0 : s = format (s, "result: %U", format_svm_fifo, placeholder_fifo, 1);
1611 :
1612 0 : return s;
1613 : }
1614 :
1615 : u8 *
1616 0 : format_ooo_list (u8 * s, va_list * args)
1617 : {
1618 0 : svm_fifo_t *f = va_arg (*args, svm_fifo_t *);
1619 0 : u32 indent = va_arg (*args, u32);
1620 0 : u32 ooo_segment_index = f->ooos_list_head;
1621 : ooo_segment_t *seg;
1622 :
1623 0 : while (ooo_segment_index != OOO_SEGMENT_INVALID_INDEX)
1624 : {
1625 0 : seg = pool_elt_at_index (f->ooo_segments, ooo_segment_index);
1626 0 : s = format (s, "%U%U\n", format_white_space, indent, format_ooo_segment,
1627 : f, seg);
1628 0 : ooo_segment_index = seg->next;
1629 : }
1630 :
1631 0 : return s;
1632 : }
1633 :
1634 : u8 *
1635 31 : format_svm_fifo (u8 * s, va_list * args)
1636 : {
1637 31 : svm_fifo_t *f = va_arg (*args, svm_fifo_t *);
1638 31 : int verbose = va_arg (*args, int);
1639 : u32 indent;
1640 :
1641 31 : if (!s)
1642 1 : return s;
1643 :
1644 30 : indent = format_get_indent (s);
1645 30 : s = format (s, "cursize %u nitems %u has_event %d min_alloc %u\n",
1646 30 : svm_fifo_max_dequeue (f), f->shr->size, f->shr->has_event,
1647 30 : f->shr->min_alloc);
1648 30 : s = format (s, "%Uhead %u tail %u segment manager %u\n", format_white_space,
1649 30 : indent, f->shr->head, f->shr->tail, f->segment_manager);
1650 :
1651 30 : if (verbose > 1)
1652 30 : s = format (s, "%Uvpp session %d thread %d app session %d thread %d\n",
1653 30 : format_white_space, indent, f->shr->master_session_index,
1654 30 : f->master_thread_index, f->shr->client_session_index,
1655 30 : f->client_thread_index);
1656 :
1657 30 : if (verbose)
1658 : {
1659 30 : s = format (s, "%Uooo pool %d active elts newest %u\n",
1660 30 : format_white_space, indent, pool_elts (f->ooo_segments),
1661 : f->ooos_newest);
1662 30 : if (svm_fifo_has_ooo_data (f))
1663 0 : s = format (s, " %U", format_ooo_list, f, indent, verbose);
1664 : }
1665 30 : return s;
1666 : }
1667 :
1668 : #endif
1669 : /*
1670 : * fd.io coding-style-patch-verification: ON
1671 : *
1672 : * Local Variables:
1673 : * eval: (c-set-style "gnu")
1674 : * End:
1675 : */
|
