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->default_chunk.start_byte = 0;
 404   f->default_chunk.length = f->size;
 405   f->default_chunk.next = f->start_chunk = f->end_chunk = &f->default_chunk;
 406   f->head_chunk = f->tail_chunk = f->ooo_enq = f->ooo_deq = f->start_chunk;
 407 }
 408
 409 /**
 410  * Creates a fifo in the current heap. Fails vs blow up the process
 411  */
 412 svm_fifo_t *
 413 svm_fifo_create (u32 data_size_in_bytes)
 414 {
 415   svm_fifo_t *f;
 416   u32 rounded_data_size;
 417
 418   /* always round fifo data size to the next highest power-of-two */
 419   rounded_data_size = (1 << (max_log2 (data_size_in_bytes)));
 420   f = clib_mem_alloc_aligned_or_null (sizeof (*f) + rounded_data_size,
 421                                       CLIB_CACHE_LINE_BYTES);
 422   if (f == 0)
 423     return 0;
 424
 425   clib_memset (f, 0, sizeof (*f));
 426   svm_fifo_init (f, data_size_in_bytes);
 427   return f;
 428 }
 429
 430 /**
 431  * Creates a fifo chunk in the current heap
 432  */
 433 svm_fifo_chunk_t *
 434 svm_fifo_chunk_alloc (u32 size)
 435 {
 436   svm_fifo_chunk_t *c;
 437   u32 rounded_size;
 438
 439   /* round chunk size to the next highest power-of-two */
 440   rounded_size = (1 << (max_log2 (size)));
 441   c = clib_mem_alloc_aligned_or_null (sizeof (*c) + rounded_size,
 442                                       CLIB_CACHE_LINE_BYTES);
 443   if (c == 0)
 444     return 0;
 445
 446   clib_memset (c, 0, sizeof (*c));
 447   c->length = rounded_size;
 448   return c;
 449 }
 450
 451 static inline u8
 452 svm_fifo_chunk_includes_pos (svm_fifo_chunk_t * c, u32 pos)
 453 {
 454   return (pos >= c->start_byte && pos < c->start_byte + c->length);
 455 }
 456
 457 /**
 458  * Find chunk for given byte position
 459  *
 460  * @param f     fifo
 461  * @param pos   normalized position in fifo
 462  *
 463  * @return chunk that includes given position or 0
 464  */
 465 static svm_fifo_chunk_t *
 466 svm_fifo_find_chunk (svm_fifo_t * f, u32 pos)
 467 {
 468   rb_tree_t *rt = &f->chunk_lookup;
 469   rb_node_t *cur, *prev;
 470   svm_fifo_chunk_t *c;
 471
 472   cur = rb_node (rt, rt->root);
 473   while (pos != cur->key)
 474     {
 475       prev = cur;
 476       if (pos < cur->key)
 477         cur = rb_node_left (rt, cur);
 478       else
 479         cur = rb_node_right (rt, cur);
 480
 481       if (rb_node_is_tnil (rt, cur))
 482         {
 483           /* Hit tnil as a left child. Find predecessor */
 484           if (pos < prev->key)
 485             {
 486               cur = rb_tree_predecessor (rt, prev);
 487               c = uword_to_pointer (cur->opaque, svm_fifo_chunk_t *);
 488               if (svm_fifo_chunk_includes_pos (c, pos))
 489                 return c;
 490               return 0;
 491             }
 492           /* Hit tnil as a right child. Check if this is the one */
 493           c = uword_to_pointer (prev->opaque, svm_fifo_chunk_t *);
 494           if (svm_fifo_chunk_includes_pos (c, pos))
 495             return c;
 496
 497           return 0;
 498         }
 499     }
 500
 501   if (!rb_node_is_tnil (rt, cur))
 502     return uword_to_pointer (cur->opaque, svm_fifo_chunk_t *);
 503   return 0;
 504 }
 505
 506 static inline void
 507 svm_fifo_grow (svm_fifo_t * f, svm_fifo_chunk_t * c)
 508 {
 509   svm_fifo_chunk_t *prev;
 510   u32 add_bytes = 0;
 511
 512   if (!c)
 513     return;
 514
 515   f->end_chunk->next = c;
 516   while (c)
 517     {
 518       add_bytes += c->length;
 519       prev = c;
 520       c = c->next;
 521     }
 522   f->end_chunk = prev;
 523   prev->next = f->start_chunk;
 524   f->size += add_bytes;
 525   f->nitems = f->size - 1;
 526   f->new_chunks = 0;
 527 }
 528
 529 static void
 530 svm_fifo_try_grow (svm_fifo_t * f, u32 new_head)
 531 {
 532   if (new_head > f->tail)
 533     return;
 534
 535   svm_fifo_grow (f, f->new_chunks);
 536   f->flags &= ~SVM_FIFO_F_GROW;
 537 }
 538
 539 void
 540 svm_fifo_add_chunk (svm_fifo_t * f, svm_fifo_chunk_t * c)
 541 {
 542   svm_fifo_chunk_t *cur, *prev;
 543
 544   /* Initialize rbtree if needed and add default chunk to it. Expectation is
 545    * that this is called with the heap where the rbtree's pool is pushed. */
 546   if (!(f->flags & SVM_FIFO_F_MULTI_CHUNK))
 547     {
 548       rb_tree_init (&f->chunk_lookup);
 549       rb_tree_add2 (&f->chunk_lookup, 0, pointer_to_uword (f->start_chunk));
 550       f->flags |= SVM_FIFO_F_MULTI_CHUNK;
 551     }
 552
 553   /* Initialize chunks and add to lookup rbtree */
 554   cur = c;
 555   if (f->new_chunks)
 556     {
 557       prev = f->new_chunks;
 558       while (prev->next)
 559         prev = prev->next;
 560       prev->next = c;
 561     }
 562   else
 563     prev = f->end_chunk;
 564
 565   while (cur)
 566     {
 567       cur->start_byte = prev->start_byte + prev->length;
 568       rb_tree_add2 (&f->chunk_lookup, cur->start_byte,
 569                     pointer_to_uword (cur));
 570       prev = cur;
 571       cur = cur->next;
 572     }
 573
 574   /* If fifo is not wrapped, update the size now */
 575   if (!svm_fifo_is_wrapped (f))
 576     {
 577       ASSERT (!f->new_chunks);
 578       svm_fifo_grow (f, c);
 579       return;
 580     }
 581
 582   /* Postpone size update */
 583   if (!f->new_chunks)
 584     {
 585       f->new_chunks = c;
 586       f->flags |= SVM_FIFO_F_GROW;
 587     }
 588 }
 589
 590 /**
 591  * Removes chunks that are after fifo end byte
 592  */
 593 svm_fifo_chunk_t *
 594 svm_fifo_collect_chunks (svm_fifo_t * f)
 595 {
 596   svm_fifo_chunk_t *list, *cur;
 597
 598   f->flags &= ~SVM_FIFO_F_COLLECT_CHUNKS;
 599
 600   list = f->new_chunks;
 601   f->new_chunks = 0;
 602   cur = list;
 603   while (cur)
 604     {
 605       rb_tree_del (&f->chunk_lookup, cur->start_byte);
 606       cur = cur->next;
 607     }
 608
 609   return list;
 610 }
 611
 612 void
 613 svm_fifo_try_shrink (svm_fifo_t * f, u32 head, u32 tail)
 614 {
 615   u32 len_to_shrink = 0, tail_pos, len;
 616   svm_fifo_chunk_t *cur, *prev, *next, *start;
 617
 618   tail_pos = tail;
 619   if (f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX)
 620     {
 621       ooo_segment_t *last = ooo_segment_last (f);
 622       tail_pos = ooo_segment_end_pos (f, last);
 623     }
 624
 625   if (f->size_decrement)
 626     {
 627       /* Figure out available free space considering that there may be
 628        * ooo segments */
 629       len = clib_min (f->size_decrement, f_free_count (f, head, tail_pos));
 630       f->nitems -= len;
 631       f->size_decrement -= len;
 632     }
 633
 634   /* Remove tail chunks if the following hold:
 635    * - not wrapped
 636    * - last used byte less than start of last chunk
 637    */
 638   if (tail_pos >= head && tail_pos <= f->end_chunk->start_byte)
 639     {
 640       /* Lookup the last position not to be removed. Since size still needs
 641        * to be nitems + 1, nitems must fall within the usable space */
 642       tail_pos = tail_pos > 0 ? tail_pos - 1 : tail_pos;
 643       prev = svm_fifo_find_chunk (f, clib_max (f->nitems, tail_pos));
 644       next = prev->next;
 645       while (next != f->start_chunk)
 646         {
 647           cur = next;
 648           next = cur->next;
 649           len_to_shrink += cur->length;
 650         }
 651       if (len_to_shrink)
 652         {
 653           f->size -= len_to_shrink;
 654           start = prev->next;
 655           prev->next = f->start_chunk;
 656           f->end_chunk = prev;
 657           cur->next = f->new_chunks;
 658           f->new_chunks = start;
 659         }
 660     }
 661
 662   if (!f->size_decrement && f->size == f->nitems + 1)
 663     {
 664       f->flags &= ~SVM_FIFO_F_SHRINK;
 665       f->flags |= SVM_FIFO_F_COLLECT_CHUNKS;
 666       if (f->start_chunk == f->start_chunk->next)
 667         f->flags &= ~SVM_FIFO_F_MULTI_CHUNK;
 668     }
 669 }
 670
 671 /**
 672  * Request to reduce fifo size by amount of bytes
 673  */
 674 int
 675 svm_fifo_reduce_size (svm_fifo_t * f, u32 len, u8 try_shrink)
 676 {
 677   svm_fifo_chunk_t *cur;
 678   u32 actual_len = 0;
 679
 680   /* Abort if trying to reduce by more than fifo size or if
 681    * fifo is undergoing resizing already */
 682   if (len >= f->size || f->size > f->nitems + 1
 683       || (f->flags & SVM_FIFO_F_SHRINK) || (f->flags & SVM_FIFO_F_GROW))
 684     return 0;
 685
 686   /* last chunk that will not be removed */
 687   cur = svm_fifo_find_chunk (f, f->nitems - len);
 688
 689   /* sum length of chunks that will be removed */
 690   cur = cur->next;
 691   while (cur != f->start_chunk)
 692     {
 693       actual_len += cur->length;
 694       cur = cur->next;
 695     }
 696
 697   ASSERT (actual_len <= len);
 698   if (!actual_len)
 699     return 0;
 700
 701   f->size_decrement = actual_len;
 702   f->flags |= SVM_FIFO_F_SHRINK;
 703
 704   if (try_shrink)
 705     {
 706       u32 head, tail;
 707       f_load_head_tail_prod (f, &head, &tail);
 708       svm_fifo_try_shrink (f, head, tail);
 709     }
 710
 711   return actual_len;
 712 }
 713
 714 void
 715 svm_fifo_free_chunk_lookup (svm_fifo_t * f)
 716 {
 717   rb_tree_free_nodes (&f->chunk_lookup);
 718 }
 719
 720 void
 721 svm_fifo_free (svm_fifo_t * f)
 722 {
 723   ASSERT (f->refcnt > 0);
 724
 725   if (--f->refcnt == 0)
 726     {
 727       /* ooo data is not allocated on segment heap */
 728       svm_fifo_free_chunk_lookup (f);
 729       clib_mem_free (f);
 730     }
 731 }
 732
 733 void
 734 svm_fifo_overwrite_head (svm_fifo_t * f, u8 * src, u32 len)
 735 {
 736   u32 n_chunk;
 737   u32 head, tail, head_idx;
 738   svm_fifo_chunk_t *c;
 739
 740   ASSERT (len <= f->nitems);
 741
 742   f_load_head_tail_cons (f, &head, &tail);
 743   c = f->head_chunk;
 744   head_idx = head - c->start_byte;
 745   n_chunk = c->length - head_idx;
 746   if (len <= n_chunk)
 747     clib_memcpy_fast (&c->data[head_idx], src, len);
 748   else
 749     {
 750       clib_memcpy_fast (&c->data[head_idx], src, n_chunk);
 751       clib_memcpy_fast (&c->next->data[0], src + n_chunk, len - n_chunk);
 752     }
 753 }
 754
 755 int
 756 svm_fifo_enqueue (svm_fifo_t * f, u32 len, const u8 * src)
 757 {
 758   u32 tail, head, free_count;
 759
 760   f_load_head_tail_prod (f, &head, &tail);
 761
 762   /* free space in fifo can only increase during enqueue: SPSC */
 763   free_count = f_free_count (f, head, tail);
 764
 765   f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
 766
 767   if (PREDICT_FALSE (free_count == 0))
 768     return SVM_FIFO_EFULL;
 769
 770   /* number of bytes we're going to copy */
 771   len = clib_min (free_count, len);
 772   svm_fifo_copy_to_chunk (f, f->tail_chunk, tail, src, len, &f->tail_chunk);
 773   tail = (tail + len) % f->size;
 774
 775   svm_fifo_trace_add (f, head, len, 2);
 776
 777   /* collect out-of-order segments */
 778   if (PREDICT_FALSE (f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX))
 779     len += ooo_segment_try_collect (f, len, &tail);
 780
 781   /* store-rel: producer owned index (paired with load-acq in consumer) */
 782   clib_atomic_store_rel_n (&f->tail, tail);
 783
 784   return len;
 785 }
 786
 787 /**
 788  * Enqueue a future segment.
 789  *
 790  * Two choices: either copies the entire segment, or copies nothing
 791  * Returns 0 of the entire segment was copied
 792  * Returns -1 if none of the segment was copied due to lack of space
 793  */
 794 int
 795 svm_fifo_enqueue_with_offset (svm_fifo_t * f, u32 offset, u32 len, u8 * src)
 796 {
 797   u32 tail, head, free_count, tail_idx;
 798
 799   f_load_head_tail_prod (f, &head, &tail);
 800
 801   if (PREDICT_FALSE (f->flags & SVM_FIFO_F_SHRINK))
 802     svm_fifo_try_shrink (f, head, tail);
 803
 804   /* free space in fifo can only increase during enqueue: SPSC */
 805   free_count = f_free_count (f, head, tail);
 806
 807   /* will this request fit? */
 808   if ((len + offset) > free_count)
 809     return SVM_FIFO_EFULL;
 810
 811   f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
 812   svm_fifo_trace_add (f, offset, len, 1);
 813   ooo_segment_add (f, offset, head, tail, len);
 814   tail_idx = (tail + offset) % f->size;
 815
 816   if (!svm_fifo_chunk_includes_pos (f->ooo_enq, tail_idx))
 817     f->ooo_enq = svm_fifo_find_chunk (f, tail_idx);
 818
 819   svm_fifo_copy_to_chunk (f, f->ooo_enq, tail_idx, src, len, &f->ooo_enq);
 820
 821   return 0;
 822 }
 823
 824 /**
 825  * Advance tail
 826  */
 827 void
 828 svm_fifo_enqueue_nocopy (svm_fifo_t * f, u32 len)
 829 {
 830   u32 tail;
 831
 832   ASSERT (len <= svm_fifo_max_enqueue_prod (f));
 833   /* load-relaxed: producer owned index */
 834   tail = f->tail;
 835   tail = (tail + len) % f->size;
 836   /* store-rel: producer owned index (paired with load-acq in consumer) */
 837   clib_atomic_store_rel_n (&f->tail, tail);
 838 }
 839
 840 int
 841 svm_fifo_dequeue (svm_fifo_t * f, u32 len, u8 * dst)
 842 {
 843   u32 tail, head, cursize;
 844
 845   f_load_head_tail_cons (f, &head, &tail);
 846
 847   /* current size of fifo can only increase during dequeue: SPSC */
 848   cursize = f_cursize (f, head, tail);
 849
 850   if (PREDICT_FALSE (cursize == 0))
 851     return SVM_FIFO_EEMPTY;
 852
 853   len = clib_min (cursize, len);
 854   svm_fifo_copy_from_chunk (f, f->head_chunk, head, dst, len, &f->head_chunk);
 855   head = (head + len) % f->size;
 856
 857   if (PREDICT_FALSE (f->flags & SVM_FIFO_F_GROW))
 858     svm_fifo_try_grow (f, head);
 859
 860   /* store-rel: consumer owned index (paired with load-acq in producer) */
 861   clib_atomic_store_rel_n (&f->head, head);
 862
 863   return len;
 864 }
 865
 866 int
 867 svm_fifo_peek (svm_fifo_t * f, u32 offset, u32 len, u8 * dst)
 868 {
 869   u32 tail, head, cursize, head_idx;
 870
 871   f_load_head_tail_cons (f, &head, &tail);
 872
 873   /* current size of fifo can only increase during peek: SPSC */
 874   cursize = f_cursize (f, head, tail);
 875
 876   if (PREDICT_FALSE (cursize < offset))
 877     return SVM_FIFO_EEMPTY;
 878
 879   len = clib_min (cursize - offset, len);
 880   head_idx = (head + offset) % f->size;
 881   if (!svm_fifo_chunk_includes_pos (f->ooo_deq, head_idx))
 882     f->ooo_deq = svm_fifo_find_chunk (f, head_idx);
 883
 884   svm_fifo_copy_from_chunk (f, f->ooo_deq, head_idx, dst, len, &f->ooo_deq);
 885   return len;
 886 }
 887
 888 int
 889 svm_fifo_dequeue_drop (svm_fifo_t * f, u32 len)
 890 {
 891   u32 total_drop_bytes, tail, head, cursize;
 892
 893   f_load_head_tail_cons (f, &head, &tail);
 894
 895   /* number of bytes available */
 896   cursize = f_cursize (f, head, tail);
 897   if (PREDICT_FALSE (cursize == 0))
 898     return SVM_FIFO_EEMPTY;
 899
 900   svm_fifo_trace_add (f, tail, total_drop_bytes, 3);
 901
 902   /* number of bytes we're going to drop */
 903   total_drop_bytes = clib_min (cursize, len);
 904
 905   /* move head */
 906   head = (head + total_drop_bytes) % f->size;
 907
 908   /* store-rel: consumer owned index (paired with load-acq in producer) */
 909   clib_atomic_store_rel_n (&f->head, head);
 910
 911   return total_drop_bytes;
 912 }
 913
 914 void
 915 svm_fifo_dequeue_drop_all (svm_fifo_t * f)
 916 {
 917   /* consumer foreign index */
 918   u32 tail = clib_atomic_load_acq_n (&f->tail);
 919   /* store-rel: consumer owned index (paired with load-acq in producer) */
 920   clib_atomic_store_rel_n (&f->head, tail);
 921 }
 922
 923 int
 924 svm_fifo_segments (svm_fifo_t * f, svm_fifo_seg_t * fs)
 925 {
 926   u32 cursize, head, tail, head_idx;
 927
 928   f_load_head_tail_cons (f, &head, &tail);
 929
 930   /* consumer function, cursize can only increase while we're working */
 931   cursize = f_cursize (f, head, tail);
 932
 933   if (PREDICT_FALSE (cursize == 0))
 934     return SVM_FIFO_EEMPTY;
 935
 936   head_idx = head;
 937
 938   if (tail < head)
 939     {
 940       fs[0].len = f->size - head_idx;
 941       fs[0].data = f->head_chunk->data + head_idx;
 942       fs[1].len = cursize - fs[0].len;
 943       fs[1].data = f->head_chunk->data;
 944     }
 945   else
 946     {
 947       fs[0].len = cursize;
 948       fs[0].data = f->head_chunk->data + head_idx;
 949       fs[1].len = 0;
 950       fs[1].data = 0;
 951     }
 952   return cursize;
 953 }
 954
 955 void
 956 svm_fifo_segments_free (svm_fifo_t * f, svm_fifo_seg_t * fs)
 957 {
 958   u32 head;
 959
 960   /* consumer owned index */
 961   head = f->head;
 962
 963   ASSERT (fs[0].data == f->head_chunk->data + head);
 964   head = (head + fs[0].len + fs[1].len) % f->size;
 965   /* store-rel: consumer owned index (paired with load-acq in producer) */
 966   clib_atomic_store_rel_n (&f->head, head);
 967 }
 968
 969 /**
 970  * Clones fifo
 971  *
 972  * Assumptions:
 973  * - no prod and cons are accessing either dest or src fifo
 974  * - fifo is not multi chunk
 975  */
 976 void
 977 svm_fifo_clone (svm_fifo_t * df, svm_fifo_t * sf)
 978 {
 979   u32 head, tail;
 980   clib_memcpy_fast (df->head_chunk->data, sf->head_chunk->data, sf->size);
 981
 982   f_load_head_tail_all_acq (sf, &head, &tail);
 983   clib_atomic_store_rel_n (&df->head, head);
 984   clib_atomic_store_rel_n (&df->tail, tail);
 985 }
 986
 987 u32
 988 svm_fifo_n_ooo_segments (svm_fifo_t * f)
 989 {
 990   return pool_elts (f->ooo_segments);
 991 }
 992
 993 ooo_segment_t *
 994 svm_fifo_first_ooo_segment (svm_fifo_t * f)
 995 {
 996   return pool_elt_at_index (f->ooo_segments, f->ooos_list_head);
 997 }
 998
 999 /**
1000  * Set fifo pointers to requested offset
1001  */
1002 void
1003 svm_fifo_init_pointers (svm_fifo_t * f, u32 head, u32 tail)
1004 {
1005   head = head % f->size;
1006   tail = tail % f->size;
1007   clib_atomic_store_rel_n (&f->head, head);
1008   clib_atomic_store_rel_n (&f->tail, tail);
1009   if (f->flags & SVM_FIFO_F_MULTI_CHUNK)
1010     {
1011       svm_fifo_chunk_t *c;
1012       c = svm_fifo_find_chunk (f, head);
1013       ASSERT (c != 0);
1014       f->head_chunk = f->ooo_deq = c;
1015       c = svm_fifo_find_chunk (f, tail);
1016       ASSERT (c != 0);
1017       f->tail_chunk = f->ooo_enq = c;
1018     }
1019 }
1020
1021 void
1022 svm_fifo_add_subscriber (svm_fifo_t * f, u8 subscriber)
1023 {
1024   if (f->n_subscribers >= SVM_FIFO_MAX_EVT_SUBSCRIBERS)
1025     return;
1026   f->subscribers[f->n_subscribers++] = subscriber;
1027 }
1028
1029 void
1030 svm_fifo_del_subscriber (svm_fifo_t * f, u8 subscriber)
1031 {
1032   int i;
1033
1034   for (i = 0; i < f->n_subscribers; i++)
1035     {
1036       if (f->subscribers[i] != subscriber)
1037         continue;
1038       f->subscribers[i] = f->subscribers[f->n_subscribers - 1];
1039       f->n_subscribers--;
1040       break;
1041     }
1042 }
1043
1044 u8 *
1045 format_ooo_segment (u8 * s, va_list * args)
1046 {
1047   svm_fifo_t *f = va_arg (*args, svm_fifo_t *);
1048   ooo_segment_t *seg = va_arg (*args, ooo_segment_t *);
1049   u32 normalized_start = (seg->start + f->nitems - f->tail) % f->size;
1050   s = format (s, "[%u, %u], len %u, next %d, prev %d", normalized_start,
1051               (normalized_start + seg->length) % f->size, seg->length,
1052               seg->next, seg->prev);
1053   return s;
1054 }
1055
1056 u8 *
1057 svm_fifo_dump_trace (u8 * s, svm_fifo_t * f)
1058 {
1059 #if SVM_FIFO_TRACE
1060   svm_fifo_trace_elem_t *seg = 0;
1061   int i = 0;
1062
1063   if (f->trace)
1064     {
1065       vec_foreach (seg, f->trace)
1066       {
1067         s = format (s, "{%u, %u, %u}, ", seg->offset, seg->len, seg->action);
1068         i++;
1069         if (i % 5 == 0)
1070           s = format (s, "\n");
1071       }
1072       s = format (s, "\n");
1073     }
1074   return s;
1075 #else
1076   return 0;
1077 #endif
1078 }
1079
1080 u8 *
1081 svm_fifo_replay (u8 * s, svm_fifo_t * f, u8 no_read, u8 verbose)
1082 {
1083   int i, trace_len;
1084   u8 *data = 0;
1085   svm_fifo_trace_elem_t *trace;
1086   u32 offset;
1087   svm_fifo_t *dummy_fifo;
1088
1089   if (!f)
1090     return s;
1091
1092 #if SVM_FIFO_TRACE
1093   trace = f->trace;
1094   trace_len = vec_len (trace);
1095 #else
1096   trace = 0;
1097   trace_len = 0;
1098 #endif
1099
1100   dummy_fifo = svm_fifo_create (f->size);
1101   clib_memset (f->head_chunk->data, 0xFF, f->nitems);
1102   vec_validate (data, f->nitems);
1103   for (i = 0; i < vec_len (data); i++)
1104     data[i] = i;
1105
1106   for (i = 0; i < trace_len; i++)
1107     {
1108       offset = trace[i].offset;
1109       if (trace[i].action == 1)
1110         {
1111           if (verbose)
1112             s = format (s, "adding [%u, %u]:", trace[i].offset,
1113                         (trace[i].offset + trace[i].len) % dummy_fifo->size);
1114           svm_fifo_enqueue_with_offset (dummy_fifo, trace[i].offset,
1115                                         trace[i].len, &data[offset]);
1116         }
1117       else if (trace[i].action == 2)
1118         {
1119           if (verbose)
1120             s = format (s, "adding [%u, %u]:", 0, trace[i].len);
1121           svm_fifo_enqueue (dummy_fifo, trace[i].len, &data[offset]);
1122         }
1123       else if (!no_read)
1124         {
1125           if (verbose)
1126             s = format (s, "read: %u", trace[i].len);
1127           svm_fifo_dequeue_drop (dummy_fifo, trace[i].len);
1128         }
1129       if (verbose)
1130         s = format (s, "%U", format_svm_fifo, dummy_fifo, 1);
1131     }
1132
1133   s = format (s, "result: %U", format_svm_fifo, dummy_fifo, 1);
1134
1135   return s;
1136 }
1137
1138 u8 *
1139 format_ooo_list (u8 * s, va_list * args)
1140 {
1141   svm_fifo_t *f = va_arg (*args, svm_fifo_t *);
1142   u32 indent = va_arg (*args, u32);
1143   u32 ooo_segment_index = f->ooos_list_head;
1144   ooo_segment_t *seg;
1145
1146   while (ooo_segment_index != OOO_SEGMENT_INVALID_INDEX)
1147     {
1148       seg = pool_elt_at_index (f->ooo_segments, ooo_segment_index);
1149       s = format (s, "%U%U\n", format_white_space, indent, format_ooo_segment,
1150                   f, seg);
1151       ooo_segment_index = seg->next;
1152     }
1153
1154   return s;
1155 }
1156
1157 u8 *
1158 format_svm_fifo (u8 * s, va_list * args)
1159 {
1160   svm_fifo_t *f = va_arg (*args, svm_fifo_t *);
1161   int verbose = va_arg (*args, int);
1162   u32 indent;
1163
1164   if (!s)
1165     return s;
1166
1167   indent = format_get_indent (s);
1168   s = format (s, "cursize %u nitems %u has_event %d\n",
1169               svm_fifo_max_dequeue (f), f->nitems, f->has_event);
1170   s = format (s, "%Uhead %u tail %u segment manager %u\n", format_white_space,
1171               indent, (f->head % f->size), (f->tail % f->size),
1172               f->segment_manager);
1173
1174   if (verbose > 1)
1175     s = format (s, "%Uvpp session %d thread %d app session %d thread %d\n",
1176                 format_white_space, indent, f->master_session_index,
1177                 f->master_thread_index, f->client_session_index,
1178                 f->client_thread_index);
1179
1180   if (verbose)
1181     {
1182       s = format (s, "%Uooo pool %d active elts newest %u\n",
1183                   format_white_space, indent, pool_elts (f->ooo_segments),
1184                   f->ooos_newest);
1185       if (svm_fifo_has_ooo_data (f))
1186         s = format (s, " %U", format_ooo_list, f, indent, verbose);
1187     }
1188   return s;
1189 }
1190
1191 #endif
1192 /*
1193  * fd.io coding-style-patch-verification: ON
1194  *
1195  * Local Variables:
1196  * eval: (c-set-style "gnu")
1197  * End:
1198  */