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