src/svm/svm_fifo.c

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #include <svm/svm_fifo.h>
  17 #include <vppinfra/cpu.h>
  18
  19 static inline u8
  20 position_lt (svm_fifo_t * f, u32 a, u32 b)
  21 {
  22   return (ooo_segment_distance_from_tail (f, a)
  23           < ooo_segment_distance_from_tail (f, b));
  24 }
  25
  26 static inline u8
  27 position_leq (svm_fifo_t * f, u32 a, u32 b)
  28 {
  29   return (ooo_segment_distance_from_tail (f, a)
  30           <= ooo_segment_distance_from_tail (f, b));
  31 }
  32
  33 static inline u8
  34 position_gt (svm_fifo_t * f, u32 a, u32 b)
  35 {
  36   return (ooo_segment_distance_from_tail (f, a)
  37           > ooo_segment_distance_from_tail (f, b));
  38 }
  39
  40 static inline u32
  41 position_diff (svm_fifo_t * f, u32 posa, u32 posb)
  42 {
  43   return ooo_segment_distance_from_tail (f, posa)
  44     - ooo_segment_distance_from_tail (f, posb);
  45 }
  46
  47 static inline u32
  48 ooo_segment_end_pos (svm_fifo_t * f, ooo_segment_t * s)
  49 {
  50   return (s->start + s->length) % f->nitems;
  51 }
  52
  53 u8 *
  54 format_ooo_segment (u8 * s, va_list * args)
  55 {
  56   svm_fifo_t *f = va_arg (*args, svm_fifo_t *);
  57   ooo_segment_t *seg = va_arg (*args, ooo_segment_t *);
  58   u32 normalized_start = (seg->start + f->nitems - f->tail) % f->nitems;
  59   s = format (s, "[%u, %u], len %u, next %d, prev %d", normalized_start,
  60               (normalized_start + seg->length) % f->nitems, seg->length,
  61               seg->next, seg->prev);
  62   return s;
  63 }
  64
  65 u8 *
  66 svm_fifo_dump_trace (u8 * s, svm_fifo_t * f)
  67 {
  68 #if SVM_FIFO_TRACE
  69   svm_fifo_trace_elem_t *seg = 0;
  70   int i = 0;
  71
  72   if (f->trace)
  73     {
  74       vec_foreach (seg, f->trace)
  75       {
  76         s = format (s, "{%u, %u, %u}, ", seg->offset, seg->len, seg->action);
  77         i++;
  78         if (i % 5 == 0)
  79           s = format (s, "\n");
  80       }
  81       s = format (s, "\n");
  82     }
  83   return s;
  84 #else
  85   return 0;
  86 #endif
  87 }
  88
  89 u8 *
  90 svm_fifo_replay (u8 * s, svm_fifo_t * f, u8 no_read, u8 verbose)
  91 {
  92   int i, trace_len;
  93   u8 *data = 0;
  94   svm_fifo_trace_elem_t *trace;
  95   u32 offset;
  96   svm_fifo_t *dummy_fifo;
  97
  98   if (!f)
  99     return s;
 100
 101 #if SVM_FIFO_TRACE
 102   trace = f->trace;
 103   trace_len = vec_len (trace);
 104 #else
 105   trace = 0;
 106   trace_len = 0;
 107 #endif
 108
 109   dummy_fifo = svm_fifo_create (f->nitems);
 110   memset (f->data, 0xFF, f->nitems);
 111
 112   vec_validate (data, f->nitems);
 113   for (i = 0; i < vec_len (data); i++)
 114     data[i] = i;
 115
 116   for (i = 0; i < trace_len; i++)
 117     {
 118       offset = trace[i].offset;
 119       if (trace[i].action == 1)
 120         {
 121           if (verbose)
 122             s = format (s, "adding [%u, %u]:", trace[i].offset,
 123                         (trace[i].offset +
 124                          trace[i].len) % dummy_fifo->nitems);
 125           svm_fifo_enqueue_with_offset (dummy_fifo, trace[i].offset,
 126                                         trace[i].len, &data[offset]);
 127         }
 128       else if (trace[i].action == 2)
 129         {
 130           if (verbose)
 131             s = format (s, "adding [%u, %u]:", 0, trace[i].len);
 132           svm_fifo_enqueue_nowait (dummy_fifo, trace[i].len, &data[offset]);
 133         }
 134       else if (!no_read)
 135         {
 136           if (verbose)
 137             s = format (s, "read: %u", trace[i].len);
 138           svm_fifo_dequeue_drop (dummy_fifo, trace[i].len);
 139         }
 140       if (verbose)
 141         s = format (s, "%U", format_svm_fifo, dummy_fifo, 1);
 142     }
 143
 144   s = format (s, "result: %U", format_svm_fifo, dummy_fifo, 1);
 145
 146   return s;
 147 }
 148
 149 u8 *
 150 format_ooo_list (u8 * s, va_list * args)
 151 {
 152   svm_fifo_t *f = va_arg (*args, svm_fifo_t *);
 153   u32 ooo_segment_index = f->ooos_list_head;
 154   ooo_segment_t *seg;
 155
 156   while (ooo_segment_index != OOO_SEGMENT_INVALID_INDEX)
 157     {
 158       seg = pool_elt_at_index (f->ooo_segments, ooo_segment_index);
 159       s = format (s, "  %U\n", format_ooo_segment, f, seg);
 160       ooo_segment_index = seg->next;
 161     }
 162
 163   return s;
 164 }
 165
 166 u8 *
 167 format_svm_fifo (u8 * s, va_list * args)
 168 {
 169   svm_fifo_t *f = va_arg (*args, svm_fifo_t *);
 170   int verbose = va_arg (*args, int);
 171
 172   if (!s)
 173     return s;
 174
 175   s = format (s, "cursize %u nitems %u has_event %d\n",
 176               f->cursize, f->nitems, f->has_event);
 177   s = format (s, " head %d tail %d\n", f->head, f->tail);
 178
 179   if (verbose > 1)
 180     s = format
 181       (s, " server session %d thread %d client session %d thread %d\n",
 182        f->master_session_index, f->master_thread_index,
 183        f->client_session_index, f->client_thread_index);
 184
 185   if (verbose)
 186     {
 187       s = format (s, " ooo pool %d active elts newest %u\n",
 188                   pool_elts (f->ooo_segments), f->ooos_newest);
 189       if (svm_fifo_has_ooo_data (f))
 190         s = format (s, " %U", format_ooo_list, f, verbose);
 191     }
 192   return s;
 193 }
 194
 195 /** create an svm fifo, in the current heap. Fails vs blow up the process */
 196 svm_fifo_t *
 197 svm_fifo_create (u32 data_size_in_bytes)
 198 {
 199   svm_fifo_t *f;
 200   u32 rounded_data_size;
 201
 202   /* always round fifo data size to the next highest power-of-two */
 203   rounded_data_size = (1 << (max_log2 (data_size_in_bytes)));
 204   f = clib_mem_alloc_aligned_or_null (sizeof (*f) + rounded_data_size,
 205                                       CLIB_CACHE_LINE_BYTES);
 206   if (f == 0)
 207     return 0;
 208
 209   memset (f, 0, sizeof (*f));
 210   f->nitems = data_size_in_bytes;
 211   f->ooos_list_head = OOO_SEGMENT_INVALID_INDEX;
 212   f->refcnt = 1;
 213   return (f);
 214 }
 215
 216 void
 217 svm_fifo_free (svm_fifo_t * f)
 218 {
 219   ASSERT (f->refcnt > 0);
 220
 221   if (--f->refcnt == 0)
 222     {
 223       pool_free (f->ooo_segments);
 224       clib_mem_free (f);
 225     }
 226 }
 227
 228 always_inline ooo_segment_t *
 229 ooo_segment_new (svm_fifo_t * f, u32 start, u32 length)
 230 {
 231   ooo_segment_t *s;
 232
 233   pool_get (f->ooo_segments, s);
 234
 235   s->start = start;
 236   s->length = length;
 237
 238   s->prev = s->next = OOO_SEGMENT_INVALID_INDEX;
 239
 240   return s;
 241 }
 242
 243 always_inline void
 244 ooo_segment_del (svm_fifo_t * f, u32 index)
 245 {
 246   ooo_segment_t *cur, *prev = 0, *next = 0;
 247   cur = pool_elt_at_index (f->ooo_segments, index);
 248
 249   if (cur->next != OOO_SEGMENT_INVALID_INDEX)
 250     {
 251       next = pool_elt_at_index (f->ooo_segments, cur->next);
 252       next->prev = cur->prev;
 253     }
 254
 255   if (cur->prev != OOO_SEGMENT_INVALID_INDEX)
 256     {
 257       prev = pool_elt_at_index (f->ooo_segments, cur->prev);
 258       prev->next = cur->next;
 259     }
 260   else
 261     {
 262       f->ooos_list_head = cur->next;
 263     }
 264
 265   pool_put (f->ooo_segments, cur);
 266 }
 267
 268 /**
 269  * Add segment to fifo's out-of-order segment list. Takes care of merging
 270  * adjacent segments and removing overlapping ones.
 271  */
 272 static void
 273 ooo_segment_add (svm_fifo_t * f, u32 offset, u32 length)
 274 {
 275   ooo_segment_t *s, *new_s, *prev, *next, *it;
 276   u32 new_index, s_end_pos, s_index;
 277   u32 normalized_position, normalized_end_position;
 278
 279   ASSERT (offset + length <= ooo_segment_distance_from_tail (f, f->head));
 280   normalized_position = (f->tail + offset) % f->nitems;
 281   normalized_end_position = (f->tail + offset + length) % f->nitems;
 282
 283   f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
 284
 285   if (f->ooos_list_head == OOO_SEGMENT_INVALID_INDEX)
 286     {
 287       s = ooo_segment_new (f, normalized_position, length);
 288       f->ooos_list_head = s - f->ooo_segments;
 289       f->ooos_newest = f->ooos_list_head;
 290       return;
 291     }
 292
 293   /* Find first segment that starts after new segment */
 294   s = pool_elt_at_index (f->ooo_segments, f->ooos_list_head);
 295   while (s->next != OOO_SEGMENT_INVALID_INDEX
 296          && position_lt (f, s->start, normalized_position))
 297     s = pool_elt_at_index (f->ooo_segments, s->next);
 298
 299   /* If we have a previous and we overlap it, use it as starting point */
 300   prev = ooo_segment_get_prev (f, s);
 301   if (prev
 302       && position_leq (f, normalized_position, ooo_segment_end_pos (f, prev)))
 303     {
 304       s = prev;
 305       s_end_pos = ooo_segment_end_pos (f, s);
 306
 307       /* Since we have previous, normalized start position cannot be smaller
 308        * than prev->start. Check tail */
 309       ASSERT (position_lt (f, s->start, normalized_position));
 310       goto check_tail;
 311     }
 312
 313   s_index = s - f->ooo_segments;
 314   s_end_pos = ooo_segment_end_pos (f, s);
 315
 316   /* No overlap, add before current segment */
 317   if (position_lt (f, normalized_end_position, s->start))
 318     {
 319       new_s = ooo_segment_new (f, normalized_position, length);
 320       new_index = new_s - f->ooo_segments;
 321
 322       /* Pool might've moved, get segment again */
 323       s = pool_elt_at_index (f->ooo_segments, s_index);
 324       if (s->prev != OOO_SEGMENT_INVALID_INDEX)
 325         {
 326           new_s->prev = s->prev;
 327           prev = pool_elt_at_index (f->ooo_segments, new_s->prev);
 328           prev->next = new_index;
 329         }
 330       else
 331         {
 332           /* New head */
 333           f->ooos_list_head = new_index;
 334         }
 335
 336       new_s->next = s_index;
 337       s->prev = new_index;
 338       f->ooos_newest = new_index;
 339       return;
 340     }
 341   /* No overlap, add after current segment */
 342   else if (position_gt (f, normalized_position, s_end_pos))
 343     {
 344       new_s = ooo_segment_new (f, normalized_position, length);
 345       new_index = new_s - f->ooo_segments;
 346
 347       /* Pool might've moved, get segment again */
 348       s = pool_elt_at_index (f->ooo_segments, s_index);
 349
 350       /* Needs to be last */
 351       ASSERT (s->next == OOO_SEGMENT_INVALID_INDEX);
 352
 353       new_s->prev = s_index;
 354       s->next = new_index;
 355       f->ooos_newest = new_index;
 356
 357       return;
 358     }
 359
 360   /*
 361    * Merge needed
 362    */
 363
 364   /* Merge at head */
 365   if (position_lt (f, normalized_position, s->start))
 366     {
 367       s->start = normalized_position;
 368       s->length = position_diff (f, s_end_pos, s->start);
 369       f->ooos_newest = s - f->ooo_segments;
 370     }
 371
 372 check_tail:
 373
 374   /* Overlapping tail */
 375   if (position_gt (f, normalized_end_position, s_end_pos))
 376     {
 377       s->length = position_diff (f, normalized_end_position, s->start);
 378
 379       /* Remove the completely overlapped segments in the tail */
 380       it = ooo_segment_next (f, s);
 381       while (it && position_leq (f, ooo_segment_end_pos (f, it),
 382                                  normalized_end_position))
 383         {
 384           next = ooo_segment_next (f, it);
 385           ooo_segment_del (f, it - f->ooo_segments);
 386           it = next;
 387         }
 388
 389       /* If partial overlap with last, merge */
 390       if (it && position_leq (f, it->start, normalized_end_position))
 391         {
 392           s->length = position_diff (f, ooo_segment_end_pos (f, it),
 393                                      s->start);
 394           ooo_segment_del (f, it - f->ooo_segments);
 395         }
 396       f->ooos_newest = s - f->ooo_segments;
 397     }
 398 }
 399
 400 /**
 401  * Removes segments that can now be enqueued because the fifo's tail has
 402  * advanced. Returns the number of bytes added to tail.
 403  */
 404 static int
 405 ooo_segment_try_collect (svm_fifo_t * f, u32 n_bytes_enqueued)
 406 {
 407   ooo_segment_t *s;
 408   u32 index, bytes = 0;
 409   i32 diff;
 410
 411   s = pool_elt_at_index (f->ooo_segments, f->ooos_list_head);
 412   diff = ooo_segment_distance_to_tail (f, s->start);
 413
 414   ASSERT (diff != n_bytes_enqueued);
 415
 416   if (diff > n_bytes_enqueued)
 417     return 0;
 418
 419   /* If last tail update overlaps one/multiple ooo segments, remove them */
 420   while (0 <= diff && diff < n_bytes_enqueued)
 421     {
 422       index = s - f->ooo_segments;
 423
 424       /* Segment end is beyond the tail. Advance tail and remove segment */
 425       if (s->length > diff)
 426         {
 427           bytes = s->length - diff;
 428           f->tail += bytes;
 429           f->tail %= f->nitems;
 430           ooo_segment_del (f, index);
 431           break;
 432         }
 433
 434       /* If we have next go on */
 435       if (s->next != OOO_SEGMENT_INVALID_INDEX)
 436         {
 437           s = pool_elt_at_index (f->ooo_segments, s->next);
 438           diff = ooo_segment_distance_to_tail (f, s->start);
 439           ooo_segment_del (f, index);
 440         }
 441       /* End of search */
 442       else
 443         {
 444           ooo_segment_del (f, index);
 445           break;
 446         }
 447     }
 448
 449   ASSERT (bytes <= f->nitems);
 450   return bytes;
 451 }
 452
 453 static int
 454 svm_fifo_enqueue_internal (svm_fifo_t * f, u32 max_bytes,
 455                            const u8 * copy_from_here)
 456 {
 457   u32 total_copy_bytes, first_copy_bytes, second_copy_bytes;
 458   u32 cursize, nitems;
 459
 460   /* read cursize, which can only increase while we're working */
 461   cursize = svm_fifo_max_dequeue (f);
 462   f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
 463
 464   if (PREDICT_FALSE (cursize == f->nitems))
 465     return SVM_FIFO_FULL;
 466
 467   nitems = f->nitems;
 468
 469   /* Number of bytes we're going to copy */
 470   total_copy_bytes = (nitems - cursize) < max_bytes ?
 471     (nitems - cursize) : max_bytes;
 472
 473   if (PREDICT_TRUE (copy_from_here != 0))
 474     {
 475       /* Number of bytes in first copy segment */
 476       first_copy_bytes = ((nitems - f->tail) < total_copy_bytes)
 477         ? (nitems - f->tail) : total_copy_bytes;
 478
 479       clib_memcpy (&f->data[f->tail], copy_from_here, first_copy_bytes);
 480       f->tail += first_copy_bytes;
 481       f->tail = (f->tail == nitems) ? 0 : f->tail;
 482
 483       /* Number of bytes in second copy segment, if any */
 484       second_copy_bytes = total_copy_bytes - first_copy_bytes;
 485       if (second_copy_bytes)
 486         {
 487           clib_memcpy (&f->data[f->tail], copy_from_here + first_copy_bytes,
 488                        second_copy_bytes);
 489           f->tail += second_copy_bytes;
 490           f->tail = (f->tail == nitems) ? 0 : f->tail;
 491         }
 492     }
 493   else
 494     {
 495       ASSERT (0);
 496
 497       /* Account for a zero-copy enqueue done elsewhere */
 498       ASSERT (max_bytes <= (nitems - cursize));
 499       f->tail += max_bytes;
 500       f->tail = f->tail % nitems;
 501       total_copy_bytes = max_bytes;
 502     }
 503
 504   svm_fifo_trace_add (f, f->head, total_copy_bytes, 2);
 505
 506   /* Any out-of-order segments to collect? */
 507   if (PREDICT_FALSE (f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX))
 508     total_copy_bytes += ooo_segment_try_collect (f, total_copy_bytes);
 509
 510   /* Atomically increase the queue length */
 511   ASSERT (cursize + total_copy_bytes <= nitems);
 512   __sync_fetch_and_add (&f->cursize, total_copy_bytes);
 513
 514   return (total_copy_bytes);
 515 }
 516
 517 #define SVM_ENQUEUE_CLONE_TEMPLATE(arch, fn, tgt)                       \
 518   uword                                                                 \
 519   __attribute__ ((flatten))                                             \
 520   __attribute__ ((target (tgt)))                                        \
 521   CLIB_CPU_OPTIMIZED                                                    \
 522   fn ## _ ## arch ( svm_fifo_t * f, u32 max_bytes, u8 * copy_from_here) \
 523   { return fn (f, max_bytes, copy_from_here);}
 524
 525 static int
 526 svm_fifo_enqueue_nowait_ma (svm_fifo_t * f, u32 max_bytes,
 527                             const u8 * copy_from_here)
 528 {
 529   return svm_fifo_enqueue_internal (f, max_bytes, copy_from_here);
 530 }
 531
 532 foreach_march_variant (SVM_ENQUEUE_CLONE_TEMPLATE,
 533                        svm_fifo_enqueue_nowait_ma);
 534 CLIB_MULTIARCH_SELECT_FN (svm_fifo_enqueue_nowait_ma);
 535
 536 int
 537 svm_fifo_enqueue_nowait (svm_fifo_t * f, u32 max_bytes,
 538                          const u8 * copy_from_here)
 539 {
 540 #if CLIB_DEBUG > 0
 541   return svm_fifo_enqueue_nowait_ma (f, max_bytes, copy_from_here);
 542 #else
 543   static int (*fp) (svm_fifo_t *, u32, const u8 *);
 544
 545   if (PREDICT_FALSE (fp == 0))
 546     fp = (void *) svm_fifo_enqueue_nowait_ma_multiarch_select ();
 547
 548   return (*fp) (f, max_bytes, copy_from_here);
 549 #endif
 550 }
 551
 552 /**
 553  * Enqueue a future segment.
 554  *
 555  * Two choices: either copies the entire segment, or copies nothing
 556  * Returns 0 of the entire segment was copied
 557  * Returns -1 if none of the segment was copied due to lack of space
 558  */
 559 static int
 560 svm_fifo_enqueue_with_offset_internal (svm_fifo_t * f,
 561                                        u32 offset,
 562                                        u32 required_bytes,
 563                                        u8 * copy_from_here)
 564 {
 565   u32 total_copy_bytes, first_copy_bytes, second_copy_bytes;
 566   u32 cursize, nitems, normalized_offset;
 567
 568   f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
 569
 570   /* read cursize, which can only increase while we're working */
 571   cursize = svm_fifo_max_dequeue (f);
 572   nitems = f->nitems;
 573
 574   ASSERT (required_bytes < nitems);
 575
 576   normalized_offset = (f->tail + offset) % nitems;
 577
 578   /* Will this request fit? */
 579   if ((required_bytes + offset) > (nitems - cursize))
 580     return -1;
 581
 582   svm_fifo_trace_add (f, offset, required_bytes, 1);
 583
 584   ooo_segment_add (f, offset, required_bytes);
 585
 586   /* Number of bytes we're going to copy */
 587   total_copy_bytes = required_bytes;
 588
 589   /* Number of bytes in first copy segment */
 590   first_copy_bytes = ((nitems - normalized_offset) < total_copy_bytes)
 591     ? (nitems - normalized_offset) : total_copy_bytes;
 592
 593   clib_memcpy (&f->data[normalized_offset], copy_from_here, first_copy_bytes);
 594
 595   /* Number of bytes in second copy segment, if any */
 596   second_copy_bytes = total_copy_bytes - first_copy_bytes;
 597   if (second_copy_bytes)
 598     {
 599       normalized_offset += first_copy_bytes;
 600       normalized_offset %= nitems;
 601
 602       ASSERT (normalized_offset == 0);
 603
 604       clib_memcpy (&f->data[normalized_offset],
 605                    copy_from_here + first_copy_bytes, second_copy_bytes);
 606     }
 607
 608   return (0);
 609 }
 610
 611
 612 int
 613 svm_fifo_enqueue_with_offset (svm_fifo_t * f,
 614                               u32 offset,
 615                               u32 required_bytes, u8 * copy_from_here)
 616 {
 617   return svm_fifo_enqueue_with_offset_internal (f, offset, required_bytes,
 618                                                 copy_from_here);
 619 }
 620
 621 void
 622 svm_fifo_overwrite_head (svm_fifo_t * f, u8 * data, u32 len)
 623 {
 624   u32 first_chunk;
 625   ASSERT (len <= f->nitems);
 626   if (len < f->nitems - f->head)
 627     clib_memcpy (&f->data[f->head], data, len);
 628   else
 629     {
 630       first_chunk = len - (f->nitems - f->head);
 631       clib_memcpy (&f->data[f->head], data, first_chunk);
 632       clib_memcpy (f->data, data + first_chunk, len - first_chunk);
 633     }
 634 }
 635
 636 static int
 637 svm_fifo_dequeue_internal (svm_fifo_t * f, u32 max_bytes, u8 * copy_here)
 638 {
 639   u32 total_copy_bytes, first_copy_bytes, second_copy_bytes;
 640   u32 cursize, nitems;
 641
 642   /* read cursize, which can only increase while we're working */
 643   cursize = svm_fifo_max_dequeue (f);
 644   if (PREDICT_FALSE (cursize == 0))
 645     return -2;                  /* nothing in the fifo */
 646
 647   nitems = f->nitems;
 648
 649   /* Number of bytes we're going to copy */
 650   total_copy_bytes = (cursize < max_bytes) ? cursize : max_bytes;
 651
 652   if (PREDICT_TRUE (copy_here != 0))
 653     {
 654       /* Number of bytes in first copy segment */
 655       first_copy_bytes = ((nitems - f->head) < total_copy_bytes)
 656         ? (nitems - f->head) : total_copy_bytes;
 657       clib_memcpy (copy_here, &f->data[f->head], first_copy_bytes);
 658       f->head += first_copy_bytes;
 659       f->head = (f->head == nitems) ? 0 : f->head;
 660
 661       /* Number of bytes in second copy segment, if any */
 662       second_copy_bytes = total_copy_bytes - first_copy_bytes;
 663       if (second_copy_bytes)
 664         {
 665           clib_memcpy (copy_here + first_copy_bytes,
 666                        &f->data[f->head], second_copy_bytes);
 667           f->head += second_copy_bytes;
 668           f->head = (f->head == nitems) ? 0 : f->head;
 669         }
 670     }
 671   else
 672     {
 673       ASSERT (0);
 674       /* Account for a zero-copy dequeue done elsewhere */
 675       ASSERT (max_bytes <= cursize);
 676       f->head += max_bytes;
 677       f->head = f->head % nitems;
 678       cursize -= max_bytes;
 679       total_copy_bytes = max_bytes;
 680     }
 681
 682   ASSERT (f->head <= nitems);
 683   ASSERT (cursize >= total_copy_bytes);
 684   __sync_fetch_and_sub (&f->cursize, total_copy_bytes);
 685
 686   return (total_copy_bytes);
 687 }
 688
 689 static int
 690 svm_fifo_dequeue_nowait_ma (svm_fifo_t * f, u32 max_bytes, u8 * copy_here)
 691 {
 692   return svm_fifo_dequeue_internal (f, max_bytes, copy_here);
 693 }
 694
 695 #define SVM_FIFO_DEQUEUE_CLONE_TEMPLATE(arch, fn, tgt)          \
 696   uword                                                         \
 697   __attribute__ ((flatten))                                     \
 698   __attribute__ ((target (tgt)))                                \
 699   CLIB_CPU_OPTIMIZED                                            \
 700   fn ## _ ## arch ( svm_fifo_t * f, u32 max_bytes,              \
 701                     u8 * copy_here)                             \
 702   { return fn (f, max_bytes, copy_here);}
 703
 704 foreach_march_variant (SVM_FIFO_DEQUEUE_CLONE_TEMPLATE,
 705                        svm_fifo_dequeue_nowait_ma);
 706 CLIB_MULTIARCH_SELECT_FN (svm_fifo_dequeue_nowait_ma);
 707
 708 int
 709 svm_fifo_dequeue_nowait (svm_fifo_t * f, u32 max_bytes, u8 * copy_here)
 710 {
 711 #if CLIB_DEBUG > 0
 712   return svm_fifo_dequeue_nowait_ma (f, max_bytes, copy_here);
 713 #else
 714   static int (*fp) (svm_fifo_t *, u32, u8 *);
 715
 716   if (PREDICT_FALSE (fp == 0))
 717     fp = (void *) svm_fifo_dequeue_nowait_ma_multiarch_select ();
 718
 719   return (*fp) (f, max_bytes, copy_here);
 720 #endif
 721 }
 722
 723 static int
 724 svm_fifo_peek_ma (svm_fifo_t * f, u32 relative_offset, u32 max_bytes,
 725                   u8 * copy_here)
 726 {
 727   u32 total_copy_bytes, first_copy_bytes, second_copy_bytes;
 728   u32 cursize, nitems, real_head;
 729
 730   /* read cursize, which can only increase while we're working */
 731   cursize = svm_fifo_max_dequeue (f);
 732   if (PREDICT_FALSE (cursize < relative_offset))
 733     return -2;                  /* nothing in the fifo */
 734
 735   nitems = f->nitems;
 736   real_head = f->head + relative_offset;
 737   real_head = real_head >= nitems ? real_head - nitems : real_head;
 738
 739   /* Number of bytes we're going to copy */
 740   total_copy_bytes = (cursize - relative_offset < max_bytes) ?
 741     cursize - relative_offset : max_bytes;
 742
 743   if (PREDICT_TRUE (copy_here != 0))
 744     {
 745       /* Number of bytes in first copy segment */
 746       first_copy_bytes =
 747         ((nitems - real_head) < total_copy_bytes) ?
 748         (nitems - real_head) : total_copy_bytes;
 749       clib_memcpy (copy_here, &f->data[real_head], first_copy_bytes);
 750
 751       /* Number of bytes in second copy segment, if any */
 752       second_copy_bytes = total_copy_bytes - first_copy_bytes;
 753       if (second_copy_bytes)
 754         {
 755           clib_memcpy (copy_here + first_copy_bytes, &f->data[0],
 756                        second_copy_bytes);
 757         }
 758     }
 759   return total_copy_bytes;
 760 }
 761
 762 #define SVM_FIFO_PEEK_CLONE_TEMPLATE(arch, fn, tgt)                     \
 763   uword                                                                 \
 764   __attribute__ ((flatten))                                             \
 765   __attribute__ ((target (tgt)))                                        \
 766   CLIB_CPU_OPTIMIZED                                                    \
 767   fn ## _ ## arch ( svm_fifo_t * f, u32 relative_offset, u32 max_bytes, \
 768                     u8 * copy_here)                                     \
 769   { return fn (f, relative_offset, max_bytes, copy_here);}
 770
 771 foreach_march_variant (SVM_FIFO_PEEK_CLONE_TEMPLATE, svm_fifo_peek_ma);
 772 CLIB_MULTIARCH_SELECT_FN (svm_fifo_peek_ma);
 773
 774 int
 775 svm_fifo_peek (svm_fifo_t * f, u32 relative_offset, u32 max_bytes,
 776                u8 * copy_here)
 777 {
 778 #if CLIB_DEBUG > 0
 779   return svm_fifo_peek_ma (f, relative_offset, max_bytes, copy_here);
 780 #else
 781   static int (*fp) (svm_fifo_t *, u32, u32, u8 *);
 782
 783   if (PREDICT_FALSE (fp == 0))
 784     fp = (void *) svm_fifo_peek_ma_multiarch_select ();
 785
 786   return (*fp) (f, relative_offset, max_bytes, copy_here);
 787 #endif
 788 }
 789
 790 int
 791 svm_fifo_dequeue_drop (svm_fifo_t * f, u32 max_bytes)
 792 {
 793   u32 total_drop_bytes, first_drop_bytes, second_drop_bytes;
 794   u32 cursize, nitems;
 795
 796   /* read cursize, which can only increase while we're working */
 797   cursize = svm_fifo_max_dequeue (f);
 798   if (PREDICT_FALSE (cursize == 0))
 799     return -2;                  /* nothing in the fifo */
 800
 801   nitems = f->nitems;
 802
 803   /* Number of bytes we're going to drop */
 804   total_drop_bytes = (cursize < max_bytes) ? cursize : max_bytes;
 805
 806   svm_fifo_trace_add (f, f->tail, total_drop_bytes, 3);
 807
 808   /* Number of bytes in first copy segment */
 809   first_drop_bytes =
 810     ((nitems - f->head) < total_drop_bytes) ?
 811     (nitems - f->head) : total_drop_bytes;
 812   f->head += first_drop_bytes;
 813   f->head = (f->head == nitems) ? 0 : f->head;
 814
 815   /* Number of bytes in second drop segment, if any */
 816   second_drop_bytes = total_drop_bytes - first_drop_bytes;
 817   if (second_drop_bytes)
 818     {
 819       f->head += second_drop_bytes;
 820       f->head = (f->head == nitems) ? 0 : f->head;
 821     }
 822
 823   ASSERT (f->head <= nitems);
 824   ASSERT (cursize >= total_drop_bytes);
 825   __sync_fetch_and_sub (&f->cursize, total_drop_bytes);
 826
 827   return total_drop_bytes;
 828 }
 829
 830 u32
 831 svm_fifo_number_ooo_segments (svm_fifo_t * f)
 832 {
 833   return pool_elts (f->ooo_segments);
 834 }
 835
 836 ooo_segment_t *
 837 svm_fifo_first_ooo_segment (svm_fifo_t * f)
 838 {
 839   return pool_elt_at_index (f->ooo_segments, f->ooos_list_head);
 840 }
 841
 842 /**
 843  * Set fifo pointers to requested offset
 844  */
 845 void
 846 svm_fifo_init_pointers (svm_fifo_t * f, u32 pointer)
 847 {
 848   f->head = f->tail = pointer % f->nitems;
 849 }
 850
 851 /*
 852  * fd.io coding-style-patch-verification: ON
 853  *
 854  * Local Variables:
 855  * eval: (c-set-style "gnu")
 856  * End:
 857  */