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