src/svm/svm_fifo.c

   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 <vppinfra/cpu.h>
  22
  23 CLIB_MARCH_FN (svm_fifo_copy_to_chunk, void, svm_fifo_t * f,
  24                svm_fifo_chunk_t * c, u32 tail_idx, const u8 * src, u32 len,
  25                svm_fifo_chunk_t ** last)
  26 {
  27   u32 n_chunk;
  28
  29   ASSERT (tail_idx >= c->start_byte && tail_idx < c->start_byte + c->length);
  30
  31   tail_idx -= c->start_byte;
  32   n_chunk = c->length - tail_idx;
  33   if (n_chunk <= len)
  34     {
  35       u32 to_copy = len;
  36       clib_memcpy_fast (&c->data[tail_idx], src, n_chunk);
  37       c = c->next;
  38       while ((to_copy -= n_chunk))
  39         {
  40           n_chunk = clib_min (c->length, to_copy);
  41           clib_memcpy_fast (&c->data[0], src + (len - to_copy), n_chunk);
  42           c = c->length <= to_copy ? c->next : c;
  43         }
  44       if (*last)
  45         *last = c;
  46     }
  47   else
  48     {
  49       clib_memcpy_fast (&c->data[tail_idx], src, len);
  50     }
  51 }
  52
  53 CLIB_MARCH_FN (svm_fifo_copy_from_chunk, void, svm_fifo_t * f,
  54                svm_fifo_chunk_t * c, u32 head_idx, u8 * dst, u32 len,
  55                svm_fifo_chunk_t ** last)
  56 {
  57   u32 n_chunk;
  58
  59   ASSERT (head_idx >= c->start_byte && head_idx < c->start_byte + c->length);
  60
  61   head_idx -= c->start_byte;
  62   n_chunk = c->length - head_idx;
  63   if (n_chunk <= len)
  64     {
  65       u32 to_copy = len;
  66       clib_memcpy_fast (dst, &c->data[head_idx], n_chunk);
  67       c = c->next;
  68       while ((to_copy -= n_chunk))
  69         {
  70           n_chunk = clib_min (c->length, to_copy);
  71           clib_memcpy_fast (dst + (len - to_copy), &c->data[0], n_chunk);
  72           c = c->length <= to_copy ? c->next : c;
  73         }
  74       if (*last)
  75         *last = c;
  76     }
  77   else
  78     {
  79       clib_memcpy_fast (dst, &c->data[head_idx], len);
  80     }
  81 }
  82
  83 #ifndef CLIB_MARCH_VARIANT
  84
  85 static inline void
  86 svm_fifo_copy_to_chunk (svm_fifo_t * f, svm_fifo_chunk_t * c, u32 tail_idx,
  87                         const u8 * src, u32 len, svm_fifo_chunk_t ** last)
  88 {
  89   CLIB_MARCH_FN_SELECT (svm_fifo_copy_to_chunk) (f, c, tail_idx, src, len,
  90                                                  last);
  91 }
  92
  93 static inline void
  94 svm_fifo_copy_from_chunk (svm_fifo_t * f, svm_fifo_chunk_t * c, u32 head_idx,
  95                           u8 * dst, u32 len, svm_fifo_chunk_t ** last)
  96 {
  97   CLIB_MARCH_FN_SELECT (svm_fifo_copy_from_chunk) (f, c, head_idx, dst, len,
  98                                                    last);
  99 }
 100
 101 static inline u8
 102 position_lt (svm_fifo_t * f, u32 a, u32 b, u32 tail)
 103 {
 104   return (f_distance_to (f, a, tail) < f_distance_to (f, b, tail));
 105 }
 106
 107 static inline u8
 108 position_leq (svm_fifo_t * f, u32 a, u32 b, u32 tail)
 109 {
 110   return (f_distance_to (f, a, tail) <= f_distance_to (f, b, tail));
 111 }
 112
 113 static inline u8
 114 position_gt (svm_fifo_t * f, u32 a, u32 b, u32 tail)
 115 {
 116   return (f_distance_to (f, a, tail) > f_distance_to (f, b, tail));
 117 }
 118
 119 static inline u32
 120 position_diff (svm_fifo_t * f, u32 a, u32 b, u32 tail)
 121 {
 122   return f_distance_to (f, a, tail) - f_distance_to (f, b, tail);
 123 }
 124
 125 static inline u32
 126 ooo_segment_end_pos (svm_fifo_t * f, ooo_segment_t * s)
 127 {
 128   return (s->start + s->length) % f->size;
 129 }
 130
 131 void
 132 svm_fifo_free_ooo_data (svm_fifo_t * f)
 133 {
 134   pool_free (f->ooo_segments);
 135 }
 136
 137 static inline ooo_segment_t *
 138 ooo_segment_prev (svm_fifo_t * f, ooo_segment_t * s)
 139 {
 140   if (s->prev == OOO_SEGMENT_INVALID_INDEX)
 141     return 0;
 142   return pool_elt_at_index (f->ooo_segments, s->prev);
 143 }
 144
 145 static inline ooo_segment_t *
 146 ooo_segment_next (svm_fifo_t * f, ooo_segment_t * s)
 147 {
 148   if (s->next == OOO_SEGMENT_INVALID_INDEX)
 149     return 0;
 150   return pool_elt_at_index (f->ooo_segments, s->next);
 151 }
 152
 153 static inline ooo_segment_t *
 154 ooo_segment_alloc (svm_fifo_t * f, u32 start, u32 length)
 155 {
 156   ooo_segment_t *s;
 157
 158   pool_get (f->ooo_segments, s);
 159
 160   s->start = start;
 161   s->length = length;
 162   s->prev = s->next = OOO_SEGMENT_INVALID_INDEX;
 163
 164   return s;
 165 }
 166
 167 static inline void
 168 ooo_segment_free (svm_fifo_t * f, u32 index)
 169 {
 170   ooo_segment_t *cur, *prev = 0, *next = 0;
 171   cur = pool_elt_at_index (f->ooo_segments, index);
 172
 173   if (cur->next != OOO_SEGMENT_INVALID_INDEX)
 174     {
 175       next = pool_elt_at_index (f->ooo_segments, cur->next);
 176       next->prev = cur->prev;
 177     }
 178
 179   if (cur->prev != OOO_SEGMENT_INVALID_INDEX)
 180     {
 181       prev = pool_elt_at_index (f->ooo_segments, cur->prev);
 182       prev->next = cur->next;
 183     }
 184   else
 185     {
 186       f->ooos_list_head = cur->next;
 187     }
 188
 189   pool_put (f->ooo_segments, cur);
 190 }
 191
 192 /**
 193  * Add segment to fifo's out-of-order segment list. Takes care of merging
 194  * adjacent segments and removing overlapping ones.
 195  */
 196 static void
 197 ooo_segment_add (svm_fifo_t * f, u32 offset, u32 head, u32 tail, u32 length)
 198 {
 199   ooo_segment_t *s, *new_s, *prev, *next, *it;
 200   u32 new_index, s_end_pos, s_index;
 201   u32 offset_pos, offset_end_pos;
 202
 203   ASSERT (offset + length <= f_distance_to (f, head, tail) || head == tail);
 204
 205   offset_pos = (tail + offset) % f->size;
 206   offset_end_pos = (tail + offset + length) % f->size;
 207
 208   f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
 209
 210   if (f->ooos_list_head == OOO_SEGMENT_INVALID_INDEX)
 211     {
 212       s = ooo_segment_alloc (f, offset_pos, length);
 213       f->ooos_list_head = s - f->ooo_segments;
 214       f->ooos_newest = f->ooos_list_head;
 215       return;
 216     }
 217
 218   /* Find first segment that starts after new segment */
 219   s = pool_elt_at_index (f->ooo_segments, f->ooos_list_head);
 220   while (s->next != OOO_SEGMENT_INVALID_INDEX
 221          && position_lt (f, s->start, offset_pos, tail))
 222     s = pool_elt_at_index (f->ooo_segments, s->next);
 223
 224   /* If we have a previous and we overlap it, use it as starting point */
 225   prev = ooo_segment_prev (f, s);
 226   if (prev
 227       && position_leq (f, offset_pos, ooo_segment_end_pos (f, prev), tail))
 228     {
 229       s = prev;
 230       s_end_pos = ooo_segment_end_pos (f, s);
 231
 232       /* Since we have previous, offset start position cannot be smaller
 233        * than prev->start. Check tail */
 234       ASSERT (position_lt (f, s->start, offset_pos, tail));
 235       goto check_tail;
 236     }
 237
 238   s_index = s - f->ooo_segments;
 239   s_end_pos = ooo_segment_end_pos (f, s);
 240
 241   /* No overlap, add before current segment */
 242   if (position_lt (f, offset_end_pos, s->start, tail))
 243     {
 244       new_s = ooo_segment_alloc (f, offset_pos, length);
 245       new_index = new_s - f->ooo_segments;
 246
 247       /* Pool might've moved, get segment again */
 248       s = pool_elt_at_index (f->ooo_segments, s_index);
 249       if (s->prev != OOO_SEGMENT_INVALID_INDEX)
 250         {
 251           new_s->prev = s->prev;
 252           prev = pool_elt_at_index (f->ooo_segments, new_s->prev);
 253           prev->next = new_index;
 254         }
 255       else
 256         {
 257           /* New head */
 258           f->ooos_list_head = new_index;
 259         }
 260
 261       new_s->next = s_index;
 262       s->prev = new_index;
 263       f->ooos_newest = new_index;
 264       return;
 265     }
 266   /* No overlap, add after current segment */
 267   else if (position_gt (f, offset_pos, s_end_pos, tail))
 268     {
 269       new_s = ooo_segment_alloc (f, offset_pos, length);
 270       new_index = new_s - f->ooo_segments;
 271
 272       /* Pool might've moved, get segment again */
 273       s = pool_elt_at_index (f->ooo_segments, s_index);
 274
 275       /* Needs to be last */
 276       ASSERT (s->next == OOO_SEGMENT_INVALID_INDEX);
 277
 278       new_s->prev = s_index;
 279       s->next = new_index;
 280       f->ooos_newest = new_index;
 281
 282       return;
 283     }
 284
 285   /*
 286    * Merge needed
 287    */
 288
 289   /* Merge at head */
 290   if (position_lt (f, offset_pos, s->start, tail))
 291     {
 292       s->start = offset_pos;
 293       s->length = position_diff (f, s_end_pos, s->start, tail);
 294       f->ooos_newest = s - f->ooo_segments;
 295     }
 296
 297 check_tail:
 298
 299   /* Overlapping tail */
 300   if (position_gt (f, offset_end_pos, s_end_pos, tail))
 301     {
 302       s->length = position_diff (f, offset_end_pos, s->start, tail);
 303
 304       /* Remove the completely overlapped segments in the tail */
 305       it = ooo_segment_next (f, s);
 306       while (it && position_leq (f, ooo_segment_end_pos (f, it),
 307                                  offset_end_pos, tail))
 308         {
 309           next = ooo_segment_next (f, it);
 310           ooo_segment_free (f, it - f->ooo_segments);
 311           it = next;
 312         }
 313
 314       /* If partial overlap with last, merge */
 315       if (it && position_leq (f, it->start, offset_end_pos, tail))
 316         {
 317           s->length = position_diff (f, ooo_segment_end_pos (f, it),
 318                                      s->start, tail);
 319           ooo_segment_free (f, it - f->ooo_segments);
 320         }
 321       f->ooos_newest = s - f->ooo_segments;
 322     }
 323 }
 324
 325 /**
 326  * Removes segments that can now be enqueued because the fifo's tail has
 327  * advanced. Returns the number of bytes added to tail.
 328  */
 329 static int
 330 ooo_segment_try_collect (svm_fifo_t * f, u32 n_bytes_enqueued, u32 * tail)
 331 {
 332   u32 s_index, bytes = 0;
 333   ooo_segment_t *s;
 334   i32 diff;
 335
 336   s = pool_elt_at_index (f->ooo_segments, f->ooos_list_head);
 337   diff = f_distance_from (f, s->start, *tail);
 338
 339   ASSERT (diff != n_bytes_enqueued);
 340
 341   if (diff > n_bytes_enqueued)
 342     return 0;
 343
 344   /* If last tail update overlaps one/multiple ooo segments, remove them */
 345   while (0 <= diff && diff < n_bytes_enqueued)
 346     {
 347       s_index = s - f->ooo_segments;
 348
 349       /* Segment end is beyond the tail. Advance tail and remove segment */
 350       if (s->length > diff)
 351         {
 352           bytes = s->length - diff;
 353           *tail = (*tail + bytes) % f->size;
 354           ooo_segment_free (f, s_index);
 355           break;
 356         }
 357
 358       /* If we have next go on */
 359       if (s->next != OOO_SEGMENT_INVALID_INDEX)
 360         {
 361           s = pool_elt_at_index (f->ooo_segments, s->next);
 362           diff = f_distance_from (f, s->start, *tail);
 363           ooo_segment_free (f, s_index);
 364         }
 365       /* End of search */
 366       else
 367         {
 368           ooo_segment_free (f, s_index);
 369           break;
 370         }
 371     }
 372
 373   ASSERT (bytes <= f->nitems);
 374   return bytes;
 375 }
 376
 377 static ooo_segment_t *
 378 ooo_segment_last (svm_fifo_t * f)
 379 {
 380   ooo_segment_t *s;
 381
 382   if (f->ooos_list_head == OOO_SEGMENT_INVALID_INDEX)
 383     return 0;
 384
 385   s = svm_fifo_first_ooo_segment (f);
 386   while (s->next != OOO_SEGMENT_INVALID_INDEX)
 387     s = pool_elt_at_index (f->ooo_segments, s->next);
 388   return s;
 389 }
 390
 391 void
 392 svm_fifo_init (svm_fifo_t * f, u32 size)
 393 {
 394   f->size = size;
 395   /*
 396    * usable size of the fifo set to rounded_data_size - 1
 397    * to differentiate between free fifo and empty fifo.
 398    */
 399   f->nitems = f->size - 1;
 400   f->ooos_list_head = OOO_SEGMENT_INVALID_INDEX;
 401   f->segment_index = SVM_FIFO_INVALID_INDEX;
 402   f->refcnt = 1;
 403   f->flags = 0;
 404   f->head_chunk = f->tail_chunk = f->ooo_enq = f->ooo_deq = f->start_chunk;
 405 }
 406
 407 void
 408 svm_fifo_init_chunks (svm_fifo_t * f)
 409 {
 410   svm_fifo_chunk_t *c, *prev;
 411
 412   if (f->start_chunk->next == f->start_chunk)
 413     return;
 414
 415   f->flags |= SVM_FIFO_F_MULTI_CHUNK;
 416   rb_tree_init (&f->chunk_lookup);
 417   rb_tree_add2 (&f->chunk_lookup, 0, pointer_to_uword (f->start_chunk));
 418
 419   f->start_chunk->start_byte = 0;
 420   prev = f->start_chunk;
 421   c = prev->next;
 422
 423   while (c != f->start_chunk)
 424     {
 425       c->start_byte = prev->start_byte + prev->length;
 426       rb_tree_add2 (&f->chunk_lookup, c->start_byte, pointer_to_uword (c));
 427       prev = c;
 428       c = c->next;
 429     }
 430 }
 431
 432 /**
 433  * Creates a fifo in the current heap. Fails vs blow up the process
 434  */
 435 svm_fifo_t *
 436 svm_fifo_create (u32 data_size_in_bytes)
 437 {
 438   u32 rounded_data_size;
 439   svm_fifo_chunk_t *c;
 440   svm_fifo_t *f;
 441
 442   f = clib_mem_alloc_aligned_or_null (sizeof (*f), CLIB_CACHE_LINE_BYTES);
 443   if (f == 0)
 444     return 0;
 445
 446   clib_memset (f, 0, sizeof (*f));
 447
 448   /* always round fifo data size to the next highest power-of-two */
 449   rounded_data_size = (1 << (max_log2 (data_size_in_bytes)));
 450   c = clib_mem_alloc_aligned_or_null (sizeof (*c) + rounded_data_size,
 451                                       CLIB_CACHE_LINE_BYTES);
 452   if (!c)
 453     {
 454       clib_mem_free (f);
 455       return 0;
 456     }
 457
 458   c->next = c;
 459   c->start_byte = 0;
 460   c->length = data_size_in_bytes;
 461   f->start_chunk = f->end_chunk = c;
 462
 463   svm_fifo_init (f, data_size_in_bytes);
 464   return f;
 465 }
 466
 467 /**
 468  * Creates a fifo chunk in the current heap
 469  */
 470 svm_fifo_chunk_t *
 471 svm_fifo_chunk_alloc (u32 size)
 472 {
 473   svm_fifo_chunk_t *c;
 474   u32 rounded_size;
 475
 476   /* round chunk size to the next highest power-of-two */
 477   rounded_size = (1 << (max_log2 (size)));
 478   c = clib_mem_alloc_aligned_or_null (sizeof (*c) + rounded_size,
 479                                       CLIB_CACHE_LINE_BYTES);
 480   if (c == 0)
 481     return 0;
 482
 483   clib_memset (c, 0, sizeof (*c));
 484   c->length = rounded_size;
 485   return c;
 486 }
 487
 488 static inline u8
 489 svm_fifo_chunk_includes_pos (svm_fifo_chunk_t * c, u32 pos)
 490 {
 491   return (pos >= c->start_byte && pos < c->start_byte + c->length);
 492 }
 493
 494 /**
 495  * Find chunk for given byte position
 496  *
 497  * @param f     fifo
 498  * @param pos   normalized position in fifo
 499  *
 500  * @return chunk that includes given position or 0
 501  */
 502 static svm_fifo_chunk_t *
 503 svm_fifo_find_chunk (svm_fifo_t * f, u32 pos)
 504 {
 505   rb_tree_t *rt = &f->chunk_lookup;
 506   rb_node_t *cur, *prev;
 507   svm_fifo_chunk_t *c;
 508
 509   cur = rb_node (rt, rt->root);
 510   while (pos != cur->key)
 511     {
 512       prev = cur;
 513       if (pos < cur->key)
 514         cur = rb_node_left (rt, cur);
 515       else
 516         cur = rb_node_right (rt, cur);
 517
 518       if (rb_node_is_tnil (rt, cur))
 519         {
 520           /* Hit tnil as a left child. Find predecessor */
 521           if (pos < prev->key)
 522             {
 523               cur = rb_tree_predecessor (rt, prev);
 524               if (rb_node_is_tnil (rt, cur))
 525                 return 0;
 526               c = uword_to_pointer (cur->opaque, svm_fifo_chunk_t *);
 527               if (svm_fifo_chunk_includes_pos (c, pos))
 528                 return c;
 529               return 0;
 530             }
 531           /* Hit tnil as a right child. Check if this is the one */
 532           c = uword_to_pointer (prev->opaque, svm_fifo_chunk_t *);
 533           if (svm_fifo_chunk_includes_pos (c, pos))
 534             return c;
 535
 536           return 0;
 537         }
 538     }
 539
 540   if (!rb_node_is_tnil (rt, cur))
 541     return uword_to_pointer (cur->opaque, svm_fifo_chunk_t *);
 542   return 0;
 543 }
 544
 545 static inline void
 546 svm_fifo_grow (svm_fifo_t * f, svm_fifo_chunk_t * c)
 547 {
 548   svm_fifo_chunk_t *prev;
 549   u32 add_bytes = 0;
 550
 551   if (!c)
 552     return;
 553
 554   f->end_chunk->next = c;
 555   while (c)
 556     {
 557       add_bytes += c->length;
 558       prev = c;
 559       c = c->next;
 560     }
 561   f->end_chunk = prev;
 562   prev->next = f->start_chunk;
 563   f->size += add_bytes;
 564   f->nitems = f->size - 1;
 565   f->new_chunks = 0;
 566 }
 567
 568 static void
 569 svm_fifo_try_grow (svm_fifo_t * f, u32 new_head)
 570 {
 571   if (new_head > f->tail)
 572     return;
 573
 574   svm_fifo_grow (f, f->new_chunks);
 575   f->flags &= ~SVM_FIFO_F_GROW;
 576 }
 577
 578 void
 579 svm_fifo_add_chunk (svm_fifo_t * f, svm_fifo_chunk_t * c)
 580 {
 581   svm_fifo_chunk_t *cur, *prev;
 582
 583   /* Initialize rbtree if needed and add default chunk to it. Expectation is
 584    * that this is called with the heap where the rbtree's pool is pushed. */
 585   if (!(f->flags & SVM_FIFO_F_MULTI_CHUNK))
 586     {
 587       ASSERT (f->start_chunk->next == f->start_chunk);
 588       rb_tree_init (&f->chunk_lookup);
 589       rb_tree_add2 (&f->chunk_lookup, 0, pointer_to_uword (f->start_chunk));
 590       f->flags |= SVM_FIFO_F_MULTI_CHUNK;
 591     }
 592
 593   /* Initialize chunks and add to lookup rbtree */
 594   cur = c;
 595   if (f->new_chunks)
 596     {
 597       prev = f->new_chunks;
 598       while (prev->next)
 599         prev = prev->next;
 600       prev->next = c;
 601     }
 602   else
 603     prev = f->end_chunk;
 604
 605   while (cur)
 606     {
 607       cur->start_byte = prev->start_byte + prev->length;
 608       rb_tree_add2 (&f->chunk_lookup, cur->start_byte,
 609                     pointer_to_uword (cur));
 610       prev = cur;
 611       cur = cur->next;
 612     }
 613
 614   /* If fifo is not wrapped, update the size now */
 615   if (!svm_fifo_is_wrapped (f))
 616     {
 617       ASSERT (!f->new_chunks);
 618       svm_fifo_grow (f, c);
 619       return;
 620     }
 621
 622   /* Postpone size update */
 623   if (!f->new_chunks)
 624     {
 625       f->new_chunks = c;
 626       f->flags |= SVM_FIFO_F_GROW;
 627     }
 628 }
 629
 630 /**
 631  * Removes chunks that are after fifo end byte
 632  */
 633 svm_fifo_chunk_t *
 634 svm_fifo_collect_chunks (svm_fifo_t * f)
 635 {
 636   svm_fifo_chunk_t *list, *cur;
 637
 638   f->flags &= ~SVM_FIFO_F_COLLECT_CHUNKS;
 639
 640   list = f->new_chunks;
 641   f->new_chunks = 0;
 642   cur = list;
 643   while (cur)
 644     {
 645       rb_tree_del (&f->chunk_lookup, cur->start_byte);
 646       cur = cur->next;
 647     }
 648
 649   return list;
 650 }
 651
 652 void
 653 svm_fifo_try_shrink (svm_fifo_t * f, u32 head, u32 tail)
 654 {
 655   u32 len_to_shrink = 0, tail_pos, len, last_pos;
 656   svm_fifo_chunk_t *cur, *prev, *next, *start;
 657
 658   tail_pos = tail;
 659   if (f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX)
 660     {
 661       ooo_segment_t *last = ooo_segment_last (f);
 662       tail_pos = ooo_segment_end_pos (f, last);
 663     }
 664
 665   if (f->size_decrement)
 666     {
 667       /* Figure out available free space considering that there may be
 668        * ooo segments */
 669       len = clib_min (f->size_decrement, f_free_count (f, head, tail_pos));
 670       f->nitems -= len;
 671       f->size_decrement -= len;
 672     }
 673
 674   /* Remove tail chunks if the following hold:
 675    * - not wrapped
 676    * - last used byte less than start of last chunk
 677    */
 678   if (tail_pos >= head && tail_pos < f->end_chunk->start_byte)
 679     {
 680       /* Lookup the last position not to be removed. Since size still needs
 681        * to be nitems + 1, nitems must fall within the usable space. Also,
 682        * first segment is not removable, so tail_pos can be 0. */
 683       last_pos = tail_pos > 0 ? tail_pos - 1 : tail_pos;
 684       prev = svm_fifo_find_chunk (f, clib_max (f->nitems, last_pos));
 685       next = prev->next;
 686       /* If tail_pos is first position in next, skip the chunk, otherwise,
 687        * we must update the tail and, if fifo size is 0, even the head.
 688        * We should not invalidate the tail for the caller and must not change
 689        * consumer owned variables from code that's typically called by the
 690        * producer */
 691       if (next->start_byte == tail_pos)
 692         {
 693           prev = next;
 694           next = next->next;
 695         }
 696       while (next != f->start_chunk)
 697         {
 698           cur = next;
 699           next = cur->next;
 700           len_to_shrink += cur->length;
 701         }
 702       if (len_to_shrink)
 703         {
 704           f->size -= len_to_shrink;
 705           start = prev->next;
 706           prev->next = f->start_chunk;
 707           f->end_chunk = prev;
 708           cur->next = f->new_chunks;
 709           f->new_chunks = start;
 710         }
 711     }
 712
 713   if (!f->size_decrement && f->size == f->nitems + 1)
 714     {
 715       f->flags &= ~SVM_FIFO_F_SHRINK;
 716       f->flags |= SVM_FIFO_F_COLLECT_CHUNKS;
 717       if (f->start_chunk == f->start_chunk->next)
 718         f->flags &= ~SVM_FIFO_F_MULTI_CHUNK;
 719     }
 720 }
 721
 722 /**
 723  * Request to reduce fifo size by amount of bytes
 724  */
 725 int
 726 svm_fifo_reduce_size (svm_fifo_t * f, u32 len, u8 try_shrink)
 727 {
 728   svm_fifo_chunk_t *cur;
 729   u32 actual_len = 0;
 730
 731   /* Abort if trying to reduce by more than fifo size or if
 732    * fifo is undergoing resizing already */
 733   if (len >= f->size || f->size > f->nitems + 1
 734       || (f->flags & SVM_FIFO_F_SHRINK) || (f->flags & SVM_FIFO_F_GROW))
 735     return 0;
 736
 737   /* last chunk that will not be removed */
 738   cur = svm_fifo_find_chunk (f, f->nitems - len);
 739
 740   /* sum length of chunks that will be removed */
 741   cur = cur->next;
 742   while (cur != f->start_chunk)
 743     {
 744       actual_len += cur->length;
 745       cur = cur->next;
 746     }
 747
 748   ASSERT (actual_len <= len);
 749   if (!actual_len)
 750     return 0;
 751
 752   f->size_decrement = actual_len;
 753   f->flags |= SVM_FIFO_F_SHRINK;
 754
 755   if (try_shrink)
 756     {
 757       u32 head, tail;
 758       f_load_head_tail_prod (f, &head, &tail);
 759       svm_fifo_try_shrink (f, head, tail);
 760     }
 761
 762   return actual_len;
 763 }
 764
 765 void
 766 svm_fifo_free_chunk_lookup (svm_fifo_t * f)
 767 {
 768   rb_tree_free_nodes (&f->chunk_lookup);
 769 }
 770
 771 void
 772 svm_fifo_free (svm_fifo_t * f)
 773 {
 774   ASSERT (f->refcnt > 0);
 775
 776   if (--f->refcnt == 0)
 777     {
 778       /* ooo data is not allocated on segment heap */
 779       svm_fifo_free_chunk_lookup (f);
 780       clib_mem_free (f);
 781     }
 782 }
 783
 784 void
 785 svm_fifo_overwrite_head (svm_fifo_t * f, u8 * src, u32 len)
 786 {
 787   u32 n_chunk;
 788   u32 head, tail, head_idx;
 789   svm_fifo_chunk_t *c;
 790
 791   ASSERT (len <= f->nitems);
 792
 793   f_load_head_tail_cons (f, &head, &tail);
 794   c = f->head_chunk;
 795   head_idx = head - c->start_byte;
 796   n_chunk = c->length - head_idx;
 797   if (len <= n_chunk)
 798     clib_memcpy_fast (&c->data[head_idx], src, len);
 799   else
 800     {
 801       clib_memcpy_fast (&c->data[head_idx], src, n_chunk);
 802       clib_memcpy_fast (&c->next->data[0], src + n_chunk, len - n_chunk);
 803     }
 804 }
 805
 806 int
 807 svm_fifo_enqueue (svm_fifo_t * f, u32 len, const u8 * src)
 808 {
 809   u32 tail, head, free_count;
 810
 811   f_load_head_tail_prod (f, &head, &tail);
 812
 813   /* free space in fifo can only increase during enqueue: SPSC */
 814   free_count = f_free_count (f, head, tail);
 815
 816   f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
 817
 818   if (PREDICT_FALSE (free_count == 0))
 819     return SVM_FIFO_EFULL;
 820
 821   /* number of bytes we're going to copy */
 822   len = clib_min (free_count, len);
 823   svm_fifo_copy_to_chunk (f, f->tail_chunk, tail, src, len, &f->tail_chunk);
 824   tail = (tail + len) % f->size;
 825
 826   svm_fifo_trace_add (f, head, len, 2);
 827
 828   /* collect out-of-order segments */
 829   if (PREDICT_FALSE (f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX))
 830     {
 831       len += ooo_segment_try_collect (f, len, &tail);
 832       if (!svm_fifo_chunk_includes_pos (f->tail_chunk, tail))
 833         f->tail_chunk = svm_fifo_find_chunk (f, tail);
 834     }
 835
 836   /* store-rel: producer owned index (paired with load-acq in consumer) */
 837   clib_atomic_store_rel_n (&f->tail, tail);
 838
 839   return len;
 840 }
 841
 842 /**
 843  * Enqueue a future segment.
 844  *
 845  * Two choices: either copies the entire segment, or copies nothing
 846  * Returns 0 of the entire segment was copied
 847  * Returns -1 if none of the segment was copied due to lack of space
 848  */
 849 int
 850 svm_fifo_enqueue_with_offset (svm_fifo_t * f, u32 offset, u32 len, u8 * src)
 851 {
 852   u32 tail, head, free_count, tail_idx;
 853
 854   f_load_head_tail_prod (f, &head, &tail);
 855
 856   if (PREDICT_FALSE (f->flags & SVM_FIFO_F_SHRINK))
 857     svm_fifo_try_shrink (f, head, tail);
 858
 859   /* free space in fifo can only increase during enqueue: SPSC */
 860   free_count = f_free_count (f, head, tail);
 861
 862   /* will this request fit? */
 863   if ((len + offset) > free_count)
 864     return SVM_FIFO_EFULL;
 865
 866   f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
 867   svm_fifo_trace_add (f, offset, len, 1);
 868   ooo_segment_add (f, offset, head, tail, len);
 869   tail_idx = (tail + offset) % f->size;
 870
 871   if (!svm_fifo_chunk_includes_pos (f->ooo_enq, tail_idx))
 872     f->ooo_enq = svm_fifo_find_chunk (f, tail_idx);
 873
 874   svm_fifo_copy_to_chunk (f, f->ooo_enq, tail_idx, src, len, &f->ooo_enq);
 875
 876   return 0;
 877 }
 878
 879 /**
 880  * Advance tail
 881  */
 882 void
 883 svm_fifo_enqueue_nocopy (svm_fifo_t * f, u32 len)
 884 {
 885   u32 tail;
 886
 887   ASSERT (len <= svm_fifo_max_enqueue_prod (f));
 888   /* load-relaxed: producer owned index */
 889   tail = f->tail;
 890   tail = (tail + len) % f->size;
 891
 892   if (!svm_fifo_chunk_includes_pos (f->tail_chunk, tail))
 893     f->tail_chunk = svm_fifo_find_chunk (f, tail);
 894
 895   /* store-rel: producer owned index (paired with load-acq in consumer) */
 896   clib_atomic_store_rel_n (&f->tail, tail);
 897 }
 898
 899 int
 900 svm_fifo_dequeue (svm_fifo_t * f, u32 len, u8 * dst)
 901 {
 902   u32 tail, head, cursize;
 903
 904   f_load_head_tail_cons (f, &head, &tail);
 905
 906   /* current size of fifo can only increase during dequeue: SPSC */
 907   cursize = f_cursize (f, head, tail);
 908
 909   if (PREDICT_FALSE (cursize == 0))
 910     return SVM_FIFO_EEMPTY;
 911
 912   len = clib_min (cursize, len);
 913   svm_fifo_copy_from_chunk (f, f->head_chunk, head, dst, len, &f->head_chunk);
 914   head = (head + len) % f->size;
 915
 916   if (PREDICT_FALSE (f->flags & SVM_FIFO_F_GROW))
 917     svm_fifo_try_grow (f, head);
 918
 919   /* store-rel: consumer owned index (paired with load-acq in producer) */
 920   clib_atomic_store_rel_n (&f->head, head);
 921
 922   return len;
 923 }
 924
 925 int
 926 svm_fifo_peek (svm_fifo_t * f, u32 offset, u32 len, u8 * dst)
 927 {
 928   u32 tail, head, cursize, head_idx;
 929
 930   f_load_head_tail_cons (f, &head, &tail);
 931
 932   /* current size of fifo can only increase during peek: SPSC */
 933   cursize = f_cursize (f, head, tail);
 934
 935   if (PREDICT_FALSE (cursize < offset))
 936     return SVM_FIFO_EEMPTY;
 937
 938   len = clib_min (cursize - offset, len);
 939   head_idx = (head + offset) % f->size;
 940   if (!svm_fifo_chunk_includes_pos (f->ooo_deq, head_idx))
 941     f->ooo_deq = svm_fifo_find_chunk (f, head_idx);
 942
 943   svm_fifo_copy_from_chunk (f, f->ooo_deq, head_idx, dst, len, &f->ooo_deq);
 944   return len;
 945 }
 946
 947 int
 948 svm_fifo_dequeue_drop (svm_fifo_t * f, u32 len)
 949 {
 950   u32 total_drop_bytes, tail, head, cursize;
 951
 952   f_load_head_tail_cons (f, &head, &tail);
 953
 954   /* number of bytes available */
 955   cursize = f_cursize (f, head, tail);
 956   if (PREDICT_FALSE (cursize == 0))
 957     return SVM_FIFO_EEMPTY;
 958
 959   /* number of bytes we're going to drop */
 960   total_drop_bytes = clib_min (cursize, len);
 961
 962   svm_fifo_trace_add (f, tail, total_drop_bytes, 3);
 963
 964   /* move head */
 965   head = (head + total_drop_bytes) % f->size;
 966
 967   if (!svm_fifo_chunk_includes_pos (f->head_chunk, head))
 968     f->head_chunk = svm_fifo_find_chunk (f, head);
 969
 970   if (PREDICT_FALSE (f->flags & SVM_FIFO_F_GROW))
 971     svm_fifo_try_grow (f, head);
 972
 973   /* store-rel: consumer owned index (paired with load-acq in producer) */
 974   clib_atomic_store_rel_n (&f->head, head);
 975
 976   return total_drop_bytes;
 977 }
 978
 979 void
 980 svm_fifo_dequeue_drop_all (svm_fifo_t * f)
 981 {
 982   /* consumer foreign index */
 983   u32 tail = clib_atomic_load_acq_n (&f->tail);
 984
 985   if (!svm_fifo_chunk_includes_pos (f->head_chunk, tail))
 986     f->head_chunk = svm_fifo_find_chunk (f, tail);
 987
 988   if (PREDICT_FALSE (f->flags & SVM_FIFO_F_GROW))
 989     svm_fifo_try_grow (f, tail);
 990
 991   /* store-rel: consumer owned index (paired with load-acq in producer) */
 992   clib_atomic_store_rel_n (&f->head, tail);
 993 }
 994
 995 int
 996 svm_fifo_segments (svm_fifo_t * f, svm_fifo_seg_t * fs)
 997 {
 998   u32 cursize, head, tail, head_idx;
 999
1000   f_load_head_tail_cons (f, &head, &tail);
1001
1002   /* consumer function, cursize can only increase while we're working */
1003   cursize = f_cursize (f, head, tail);
1004
1005   if (PREDICT_FALSE (cursize == 0))
1006     return SVM_FIFO_EEMPTY;
1007
1008   head_idx = head;
1009
1010   if (tail < head)
1011     {
1012       fs[0].len = f->size - head_idx;
1013       fs[0].data = f->head_chunk->data + head_idx;
1014       fs[1].len = cursize - fs[0].len;
1015       fs[1].data = f->head_chunk->data;
1016     }
1017   else
1018     {
1019       fs[0].len = cursize;
1020       fs[0].data = f->head_chunk->data + head_idx;
1021       fs[1].len = 0;
1022       fs[1].data = 0;
1023     }
1024   return cursize;
1025 }
1026
1027 void
1028 svm_fifo_segments_free (svm_fifo_t * f, svm_fifo_seg_t * fs)
1029 {
1030   u32 head;
1031
1032   /* consumer owned index */
1033   head = f->head;
1034
1035   ASSERT (fs[0].data == f->head_chunk->data + head);
1036   head = (head + fs[0].len + fs[1].len) % f->size;
1037   /* store-rel: consumer owned index (paired with load-acq in producer) */
1038   clib_atomic_store_rel_n (&f->head, head);
1039 }
1040
1041 /**
1042  * Clones fifo
1043  *
1044  * Assumptions:
1045  * - no prod and cons are accessing either dest or src fifo
1046  * - fifo is not multi chunk
1047  */
1048 void
1049 svm_fifo_clone (svm_fifo_t * df, svm_fifo_t * sf)
1050 {
1051   u32 head, tail;
1052   clib_memcpy_fast (df->head_chunk->data, sf->head_chunk->data, sf->size);
1053
1054   f_load_head_tail_all_acq (sf, &head, &tail);
1055   clib_atomic_store_rel_n (&df->head, head);
1056   clib_atomic_store_rel_n (&df->tail, tail);
1057 }
1058
1059 u32
1060 svm_fifo_n_ooo_segments (svm_fifo_t * f)
1061 {
1062   return pool_elts (f->ooo_segments);
1063 }
1064
1065 ooo_segment_t *
1066 svm_fifo_first_ooo_segment (svm_fifo_t * f)
1067 {
1068   return pool_elt_at_index (f->ooo_segments, f->ooos_list_head);
1069 }
1070
1071 /**
1072  * Set fifo pointers to requested offset
1073  */
1074 void
1075 svm_fifo_init_pointers (svm_fifo_t * f, u32 head, u32 tail)
1076 {
1077   head = head % f->size;
1078   tail = tail % f->size;
1079   clib_atomic_store_rel_n (&f->head, head);
1080   clib_atomic_store_rel_n (&f->tail, tail);
1081   if (f->flags & SVM_FIFO_F_MULTI_CHUNK)
1082     {
1083       svm_fifo_chunk_t *c;
1084       c = svm_fifo_find_chunk (f, head);
1085       ASSERT (c != 0);
1086       f->head_chunk = f->ooo_deq = c;
1087       c = svm_fifo_find_chunk (f, tail);
1088       ASSERT (c != 0);
1089       f->tail_chunk = f->ooo_enq = c;
1090     }
1091 }
1092
1093 void
1094 svm_fifo_add_subscriber (svm_fifo_t * f, u8 subscriber)
1095 {
1096   if (f->n_subscribers >= SVM_FIFO_MAX_EVT_SUBSCRIBERS)
1097     return;
1098   f->subscribers[f->n_subscribers++] = subscriber;
1099 }
1100
1101 void
1102 svm_fifo_del_subscriber (svm_fifo_t * f, u8 subscriber)
1103 {
1104   int i;
1105
1106   for (i = 0; i < f->n_subscribers; i++)
1107     {
1108       if (f->subscribers[i] != subscriber)
1109         continue;
1110       f->subscribers[i] = f->subscribers[f->n_subscribers - 1];
1111       f->n_subscribers--;
1112       break;
1113     }
1114 }
1115
1116 u8
1117 svm_fifo_is_sane (svm_fifo_t * f)
1118 {
1119   if (f->size - 1 != f->nitems && !(f->flags & SVM_FIFO_F_SHRINK))
1120     return 0;
1121   if (!svm_fifo_chunk_includes_pos (f->head_chunk, f->head))
1122     return 0;
1123   if (!svm_fifo_chunk_includes_pos (f->tail_chunk, f->tail))
1124     return 0;
1125
1126   if (f->start_chunk->next != f->start_chunk)
1127     {
1128       svm_fifo_chunk_t *c, *prev = 0, *tmp;
1129       u32 size = 0;
1130
1131       if (!(f->flags & SVM_FIFO_F_MULTI_CHUNK))
1132         return 0;
1133
1134       c = f->start_chunk;
1135       do
1136         {
1137           tmp = svm_fifo_find_chunk (f, c->start_byte);
1138           if (tmp != c)
1139             return 0;
1140           if (prev && (prev->start_byte + prev->length != c->start_byte))
1141             return 0;
1142           size += c->length;
1143           prev = c;
1144           c = c->next;
1145         }
1146       while (c != f->start_chunk);
1147
1148       if (size != f->size)
1149         return 0;
1150     }
1151
1152   return 1;
1153 }
1154
1155 u8 *
1156 format_ooo_segment (u8 * s, va_list * args)
1157 {
1158   svm_fifo_t *f = va_arg (*args, svm_fifo_t *);
1159   ooo_segment_t *seg = va_arg (*args, ooo_segment_t *);
1160   u32 normalized_start = (seg->start + f->nitems - f->tail) % f->size;
1161   s = format (s, "[%u, %u], len %u, next %d, prev %d", normalized_start,
1162               (normalized_start + seg->length) % f->size, seg->length,
1163               seg->next, seg->prev);
1164   return s;
1165 }
1166
1167 u8 *
1168 svm_fifo_dump_trace (u8 * s, svm_fifo_t * f)
1169 {
1170 #if SVM_FIFO_TRACE
1171   svm_fifo_trace_elem_t *seg = 0;
1172   int i = 0;
1173
1174   if (f->trace)
1175     {
1176       vec_foreach (seg, f->trace)
1177       {
1178         s = format (s, "{%u, %u, %u}, ", seg->offset, seg->len, seg->action);
1179         i++;
1180         if (i % 5 == 0)
1181           s = format (s, "\n");
1182       }
1183       s = format (s, "\n");
1184     }
1185   return s;
1186 #else
1187   return 0;
1188 #endif
1189 }
1190
1191 u8 *
1192 svm_fifo_replay (u8 * s, svm_fifo_t * f, u8 no_read, u8 verbose)
1193 {
1194   int i, trace_len;
1195   u8 *data = 0;
1196   svm_fifo_trace_elem_t *trace;
1197   u32 offset;
1198   svm_fifo_t *dummy_fifo;
1199
1200   if (!f)
1201     return s;
1202
1203 #if SVM_FIFO_TRACE
1204   trace = f->trace;
1205   trace_len = vec_len (trace);
1206 #else
1207   trace = 0;
1208   trace_len = 0;
1209 #endif
1210
1211   dummy_fifo = svm_fifo_create (f->size);
1212   clib_memset (f->head_chunk->data, 0xFF, f->nitems);
1213   vec_validate (data, f->nitems);
1214   for (i = 0; i < vec_len (data); i++)
1215     data[i] = i;
1216
1217   for (i = 0; i < trace_len; i++)
1218     {
1219       offset = trace[i].offset;
1220       if (trace[i].action == 1)
1221         {
1222           if (verbose)
1223             s = format (s, "adding [%u, %u]:", trace[i].offset,
1224                         (trace[i].offset + trace[i].len) % dummy_fifo->size);
1225           svm_fifo_enqueue_with_offset (dummy_fifo, trace[i].offset,
1226                                         trace[i].len, &data[offset]);
1227         }
1228       else if (trace[i].action == 2)
1229         {
1230           if (verbose)
1231             s = format (s, "adding [%u, %u]:", 0, trace[i].len);
1232           svm_fifo_enqueue (dummy_fifo, trace[i].len, &data[offset]);
1233         }
1234       else if (!no_read)
1235         {
1236           if (verbose)
1237             s = format (s, "read: %u", trace[i].len);
1238           svm_fifo_dequeue_drop (dummy_fifo, trace[i].len);
1239         }
1240       if (verbose)
1241         s = format (s, "%U", format_svm_fifo, dummy_fifo, 1);
1242     }
1243
1244   s = format (s, "result: %U", format_svm_fifo, dummy_fifo, 1);
1245
1246   return s;
1247 }
1248
1249 u8 *
1250 format_ooo_list (u8 * s, va_list * args)
1251 {
1252   svm_fifo_t *f = va_arg (*args, svm_fifo_t *);
1253   u32 indent = va_arg (*args, u32);
1254   u32 ooo_segment_index = f->ooos_list_head;
1255   ooo_segment_t *seg;
1256
1257   while (ooo_segment_index != OOO_SEGMENT_INVALID_INDEX)
1258     {
1259       seg = pool_elt_at_index (f->ooo_segments, ooo_segment_index);
1260       s = format (s, "%U%U\n", format_white_space, indent, format_ooo_segment,
1261                   f, seg);
1262       ooo_segment_index = seg->next;
1263     }
1264
1265   return s;
1266 }
1267
1268 u8 *
1269 format_svm_fifo (u8 * s, va_list * args)
1270 {
1271   svm_fifo_t *f = va_arg (*args, svm_fifo_t *);
1272   int verbose = va_arg (*args, int);
1273   u32 indent;
1274
1275   if (!s)
1276     return s;
1277
1278   indent = format_get_indent (s);
1279   s = format (s, "cursize %u nitems %u has_event %d\n",
1280               svm_fifo_max_dequeue (f), f->nitems, f->has_event);
1281   s = format (s, "%Uhead %u tail %u segment manager %u\n", format_white_space,
1282               indent, (f->head % f->size), (f->tail % f->size),
1283               f->segment_manager);
1284
1285   if (verbose > 1)
1286     s = format (s, "%Uvpp session %d thread %d app session %d thread %d\n",
1287                 format_white_space, indent, f->master_session_index,
1288                 f->master_thread_index, f->client_session_index,
1289                 f->client_thread_index);
1290
1291   if (verbose)
1292     {
1293       s = format (s, "%Uooo pool %d active elts newest %u\n",
1294                   format_white_space, indent, pool_elts (f->ooo_segments),
1295                   f->ooos_newest);
1296       if (svm_fifo_has_ooo_data (f))
1297         s = format (s, " %U", format_ooo_list, f, indent, verbose);
1298     }
1299   return s;
1300 }
1301
1302 #endif
1303 /*
1304  * fd.io coding-style-patch-verification: ON
1305  *
1306  * Local Variables:
1307  * eval: (c-set-style "gnu")
1308  * End:
1309  */