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
  18 #define offset_lt(_a, _b) ((i32)((_a)-(_b)) < 0)
  19 #define offset_leq(_a, _b) ((i32)((_a)-(_b)) <= 0)
  20
  21 u8 *
  22 format_ooo_segment (u8 * s, va_list * args)
  23 {
  24   ooo_segment_t *seg = va_arg (*args, ooo_segment_t *);
  25
  26   s = format (s, "pos %u, len %u, next %d, prev %d",
  27               seg->start, seg->length, seg->next, seg->prev);
  28   return s;
  29 }
  30
  31 u8 *
  32 format_ooo_list (u8 * s, va_list * args)
  33 {
  34   svm_fifo_t *f = va_arg (*args, svm_fifo_t *);
  35   u32 ooo_segment_index = f->ooos_list_head;
  36   ooo_segment_t *seg;
  37
  38   while (ooo_segment_index != OOO_SEGMENT_INVALID_INDEX)
  39     {
  40       seg = pool_elt_at_index (f->ooo_segments, ooo_segment_index);
  41       s = format (s, "  %U\n", format_ooo_segment, seg);
  42       ooo_segment_index = seg->next;
  43     }
  44   return s;
  45 }
  46
  47 u8 *
  48 format_svm_fifo (u8 * s, va_list * args)
  49 {
  50   svm_fifo_t *f = va_arg (*args, svm_fifo_t *);
  51   int verbose = va_arg (*args, int);
  52
  53   s = format (s, "cursize %u nitems %u has_event %d\n",
  54               f->cursize, f->nitems, f->has_event);
  55   s = format (s, "head %d tail %d\n", f->head, f->tail);
  56
  57   if (verbose > 1)
  58     s = format
  59       (s, "server session %d thread %d client session %d thread %d\n",
  60        f->server_session_index, f->server_thread_index,
  61        f->client_session_index, f->client_thread_index);
  62
  63   if (verbose)
  64     {
  65       s = format (s, "ooo pool %d active elts\n",
  66                   pool_elts (f->ooo_segments));
  67       s = format (s, "%U", format_ooo_list, f);
  68     }
  69   return s;
  70 }
  71
  72 /** create an svm fifo, in the current heap. Fails vs blow up the process */
  73 svm_fifo_t *
  74 svm_fifo_create (u32 data_size_in_bytes)
  75 {
  76   svm_fifo_t *f;
  77
  78   f = clib_mem_alloc_aligned_or_null (sizeof (*f) + data_size_in_bytes,
  79                                       CLIB_CACHE_LINE_BYTES);
  80   if (f == 0)
  81     return 0;
  82
  83   memset (f, 0, sizeof (*f) + data_size_in_bytes);
  84   f->nitems = data_size_in_bytes;
  85   f->ooos_list_head = OOO_SEGMENT_INVALID_INDEX;
  86
  87   return (f);
  88 }
  89
  90 void
  91 svm_fifo_free (svm_fifo_t * f)
  92 {
  93   pool_free (f->ooo_segments);
  94   clib_mem_free (f);
  95 }
  96
  97 always_inline ooo_segment_t *
  98 ooo_segment_new (svm_fifo_t * f, u32 start, u32 length)
  99 {
 100   ooo_segment_t *s;
 101
 102   pool_get (f->ooo_segments, s);
 103
 104   s->start = start;
 105   s->length = length;
 106
 107   s->prev = s->next = OOO_SEGMENT_INVALID_INDEX;
 108
 109   return s;
 110 }
 111
 112 always_inline void
 113 ooo_segment_del (svm_fifo_t * f, u32 index)
 114 {
 115   ooo_segment_t *cur, *prev = 0, *next = 0;
 116   cur = pool_elt_at_index (f->ooo_segments, index);
 117
 118   if (cur->next != OOO_SEGMENT_INVALID_INDEX)
 119     {
 120       next = pool_elt_at_index (f->ooo_segments, cur->next);
 121       next->prev = cur->prev;
 122     }
 123
 124   if (cur->prev != OOO_SEGMENT_INVALID_INDEX)
 125     {
 126       prev = pool_elt_at_index (f->ooo_segments, cur->prev);
 127       prev->next = cur->next;
 128     }
 129   else
 130     {
 131       f->ooos_list_head = cur->next;
 132     }
 133
 134   pool_put (f->ooo_segments, cur);
 135 }
 136
 137 /**
 138  * Add segment to fifo's out-of-order segment list. Takes care of merging
 139  * adjacent segments and removing overlapping ones.
 140  */
 141 static void
 142 ooo_segment_add (svm_fifo_t * f, u32 offset, u32 length)
 143 {
 144   ooo_segment_t *s, *new_s, *prev, *next, *it;
 145   u32 new_index, end_offset, s_sof, s_eof, s_index;
 146
 147   end_offset = offset + length;
 148
 149   if (f->ooos_list_head == OOO_SEGMENT_INVALID_INDEX)
 150     {
 151       s = ooo_segment_new (f, offset, length);
 152       f->ooos_list_head = s - f->ooo_segments;
 153       f->ooos_newest = f->ooos_list_head;
 154       return;
 155     }
 156
 157   /* Find first segment that starts after new segment */
 158   s = pool_elt_at_index (f->ooo_segments, f->ooos_list_head);
 159   while (s->next != OOO_SEGMENT_INVALID_INDEX
 160          && offset_leq (ooo_segment_offset (f, s), offset))
 161     s = pool_elt_at_index (f->ooo_segments, s->next);
 162
 163   s_index = s - f->ooo_segments;
 164   s_sof = ooo_segment_offset (f, s);
 165   s_eof = ooo_segment_end_offset (f, s);
 166   prev = ooo_segment_get_prev (f, s);
 167
 168   /* No overlap, add before current segment */
 169   if (offset_lt (end_offset, s_sof)
 170       && (!prev || offset_lt (prev->start + prev->length, offset)))
 171     {
 172       new_s = ooo_segment_new (f, offset, length);
 173       new_index = new_s - f->ooo_segments;
 174
 175       /* Pool might've moved, get segment again */
 176       s = pool_elt_at_index (f->ooo_segments, s_index);
 177       if (s->prev != OOO_SEGMENT_INVALID_INDEX)
 178         {
 179           new_s->prev = s->prev;
 180           prev = pool_elt_at_index (f->ooo_segments, new_s->prev);
 181           prev->next = new_index;
 182         }
 183       else
 184         {
 185           /* New head */
 186           f->ooos_list_head = new_index;
 187         }
 188
 189       new_s->next = s - f->ooo_segments;
 190       s->prev = new_index;
 191       f->ooos_newest = new_index;
 192       return;
 193     }
 194   /* No overlap, add after current segment */
 195   else if (offset_lt (s_eof, offset))
 196     {
 197       new_s = ooo_segment_new (f, offset, length);
 198       new_index = new_s - f->ooo_segments;
 199
 200       /* Pool might've moved, get segment again */
 201       s = pool_elt_at_index (f->ooo_segments, s_index);
 202
 203       if (s->next != OOO_SEGMENT_INVALID_INDEX)
 204         {
 205           new_s->next = s->next;
 206           next = pool_elt_at_index (f->ooo_segments, new_s->next);
 207           next->prev = new_index;
 208         }
 209
 210       new_s->prev = s - f->ooo_segments;
 211       s->next = new_index;
 212       f->ooos_newest = new_index;
 213
 214       return;
 215     }
 216
 217   /*
 218    * Merge needed
 219    */
 220
 221   /* Merge at head */
 222   if (offset_leq (offset, s_sof))
 223     {
 224       /* If we have a previous, check if we overlap */
 225       if (s->prev != OOO_SEGMENT_INVALID_INDEX)
 226         {
 227           prev = pool_elt_at_index (f->ooo_segments, s->prev);
 228
 229           /* New segment merges prev and current. Remove previous and
 230            * update position of current. */
 231           if (offset_leq (offset, ooo_segment_end_offset (f, prev)))
 232             {
 233               s->start = prev->start;
 234               s->length = s_eof - ooo_segment_offset (f, prev);
 235               ooo_segment_del (f, s->prev);
 236             }
 237           else
 238             {
 239               s->start = offset;
 240               s->length = s_eof - ooo_segment_offset (f, s);
 241             }
 242         }
 243       else
 244         {
 245           s->start = offset;
 246           s->length = s_eof - ooo_segment_offset (f, s);
 247         }
 248
 249       /* The new segment's tail may cover multiple smaller ones */
 250       if (offset_lt (s_eof, end_offset))
 251         {
 252           /* Remove segments completely covered */
 253           it = (s->next != OOO_SEGMENT_INVALID_INDEX) ?
 254             pool_elt_at_index (f->ooo_segments, s->next) : 0;
 255           while (it && offset_lt (ooo_segment_end_offset (f, it), end_offset))
 256             {
 257               next = (it->next != OOO_SEGMENT_INVALID_INDEX) ?
 258                 pool_elt_at_index (f->ooo_segments, it->next) : 0;
 259               ooo_segment_del (f, it - f->ooo_segments);
 260               it = next;
 261             }
 262
 263           /* Update length. Segment's start might have changed. */
 264           s->length = end_offset - ooo_segment_offset (f, s);
 265
 266           /* If partial overlap with last, merge */
 267           if (it && offset_lt (ooo_segment_offset (f, it), end_offset))
 268             {
 269               s->length +=
 270                 it->length - (ooo_segment_offset (f, it) - end_offset);
 271               ooo_segment_del (f, it - f->ooo_segments);
 272             }
 273         }
 274     }
 275   /* Last but overlapping previous */
 276   else if (offset_leq (s_eof, end_offset))
 277     {
 278       s->length = end_offset - ooo_segment_offset (f, s);
 279     }
 280   /* New segment completely covered by current one */
 281   else
 282     {
 283       /* Do Nothing */
 284     }
 285
 286   /* Most recently updated segment */
 287   f->ooos_newest = s - f->ooo_segments;
 288 }
 289
 290 /**
 291  * Removes segments that can now be enqueued because the fifo's tail has
 292  * advanced. Returns the number of bytes added to tail.
 293  */
 294 static int
 295 ooo_segment_try_collect (svm_fifo_t * f, u32 n_bytes_enqueued)
 296 {
 297   ooo_segment_t *s;
 298   u32 index, bytes = 0, diff;
 299   u32 cursize;
 300
 301   /* current size has not yet been updated */
 302   cursize = svm_fifo_max_dequeue (f) + n_bytes_enqueued;
 303
 304   s = pool_elt_at_index (f->ooo_segments, f->ooos_list_head);
 305
 306   diff = (f->nitems + (i32) (f->tail - s->start)) % f->nitems;
 307   if (diff > cursize)
 308     return 0;
 309
 310   /* If last tail update overlaps one/multiple ooo segments, remove them */
 311   while (0 < diff && diff < cursize)
 312     {
 313       index = s - f->ooo_segments;
 314
 315       /* Segment end is beyond the tail. Advance tail and remove segment */
 316       if (diff < s->length)
 317         {
 318           f->tail += s->length - diff;
 319           f->tail %= f->nitems;
 320           bytes = s->length - diff;
 321           ooo_segment_del (f, index);
 322           break;
 323         }
 324
 325       /* If we have next go on */
 326       if (s->next != OOO_SEGMENT_INVALID_INDEX)
 327         {
 328           s = pool_elt_at_index (f->ooo_segments, s->next);
 329           diff = (f->nitems + (i32) (f->tail - s->start)) % f->nitems;
 330           ooo_segment_del (f, index);
 331         }
 332       /* End of search */
 333       else
 334         {
 335           ooo_segment_del (f, index);
 336           break;
 337         }
 338     }
 339
 340   /* If tail is adjacent to an ooo segment, 'consume' it */
 341   if (diff == 0)
 342     {
 343       bytes = ((f->nitems - cursize) >= s->length) ? s->length :
 344         f->nitems - cursize;
 345
 346       f->tail += bytes;
 347       f->tail %= f->nitems;
 348
 349       ooo_segment_del (f, s - f->ooo_segments);
 350     }
 351
 352   return bytes;
 353 }
 354
 355 static int
 356 svm_fifo_enqueue_internal (svm_fifo_t * f,
 357                            int pid, u32 max_bytes, u8 * copy_from_here)
 358 {
 359   u32 total_copy_bytes, first_copy_bytes, second_copy_bytes;
 360   u32 cursize, nitems;
 361
 362   /* read cursize, which can only increase while we're working */
 363   cursize = svm_fifo_max_dequeue (f);
 364
 365   if (PREDICT_FALSE (cursize == f->nitems))
 366     return -2;                  /* fifo stuffed */
 367
 368   nitems = f->nitems;
 369
 370   /* Number of bytes we're going to copy */
 371   total_copy_bytes = (nitems - cursize) < max_bytes ?
 372     (nitems - cursize) : max_bytes;
 373
 374   if (PREDICT_TRUE (copy_from_here != 0))
 375     {
 376       /* Number of bytes in first copy segment */
 377       first_copy_bytes = ((nitems - f->tail) < total_copy_bytes)
 378         ? (nitems - f->tail) : total_copy_bytes;
 379
 380       clib_memcpy (&f->data[f->tail], copy_from_here, first_copy_bytes);
 381       f->tail += first_copy_bytes;
 382       f->tail = (f->tail == nitems) ? 0 : f->tail;
 383
 384       /* Number of bytes in second copy segment, if any */
 385       second_copy_bytes = total_copy_bytes - first_copy_bytes;
 386       if (second_copy_bytes)
 387         {
 388           clib_memcpy (&f->data[f->tail], copy_from_here + first_copy_bytes,
 389                        second_copy_bytes);
 390           f->tail += second_copy_bytes;
 391           f->tail = (f->tail == nitems) ? 0 : f->tail;
 392         }
 393     }
 394   else
 395     {
 396       /* Account for a zero-copy enqueue done elsewhere */
 397       ASSERT (max_bytes <= (nitems - cursize));
 398       f->tail += max_bytes;
 399       f->tail = f->tail % nitems;
 400       total_copy_bytes = max_bytes;
 401     }
 402
 403   /* Any out-of-order segments to collect? */
 404   if (PREDICT_FALSE (f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX))
 405     total_copy_bytes += ooo_segment_try_collect (f, total_copy_bytes);
 406
 407   /* Atomically increase the queue length */
 408   __sync_fetch_and_add (&f->cursize, total_copy_bytes);
 409
 410   return (total_copy_bytes);
 411 }
 412
 413 int
 414 svm_fifo_enqueue_nowait (svm_fifo_t * f,
 415                          int pid, u32 max_bytes, u8 * copy_from_here)
 416 {
 417   return svm_fifo_enqueue_internal (f, pid, max_bytes, copy_from_here);
 418 }
 419
 420 /**
 421  * Enqueue a future segment.
 422  *
 423  * Two choices: either copies the entire segment, or copies nothing
 424  * Returns 0 of the entire segment was copied
 425  * Returns -1 if none of the segment was copied due to lack of space
 426  */
 427 static int
 428 svm_fifo_enqueue_with_offset_internal (svm_fifo_t * f,
 429                                        int pid,
 430                                        u32 offset,
 431                                        u32 required_bytes,
 432                                        u8 * copy_from_here)
 433 {
 434   u32 total_copy_bytes, first_copy_bytes, second_copy_bytes;
 435   u32 cursize, nitems;
 436   u32 normalized_offset;
 437   int rv;
 438
 439   /* Users would do well to avoid this */
 440   if (PREDICT_FALSE (f->tail == (offset % f->nitems)))
 441     {
 442       rv = svm_fifo_enqueue_internal (f, pid, required_bytes, copy_from_here);
 443       if (rv > 0)
 444         return 0;
 445       return -1;
 446     }
 447
 448   /* read cursize, which can only increase while we're working */
 449   cursize = svm_fifo_max_dequeue (f);
 450   nitems = f->nitems;
 451
 452   /* Will this request fit? */
 453   if ((required_bytes + (offset - f->tail) % nitems) > (nitems - cursize))
 454     return -1;
 455
 456   ooo_segment_add (f, offset, required_bytes);
 457
 458   /* Number of bytes we're going to copy */
 459   total_copy_bytes = required_bytes;
 460   normalized_offset = offset % nitems;
 461
 462   /* Number of bytes in first copy segment */
 463   first_copy_bytes = ((nitems - normalized_offset) < total_copy_bytes)
 464     ? (nitems - normalized_offset) : total_copy_bytes;
 465
 466   clib_memcpy (&f->data[normalized_offset], copy_from_here, first_copy_bytes);
 467
 468   /* Number of bytes in second copy segment, if any */
 469   second_copy_bytes = total_copy_bytes - first_copy_bytes;
 470   if (second_copy_bytes)
 471     {
 472       normalized_offset += first_copy_bytes;
 473       normalized_offset %= nitems;
 474
 475       ASSERT (normalized_offset == 0);
 476
 477       clib_memcpy (&f->data[normalized_offset],
 478                    copy_from_here + first_copy_bytes, second_copy_bytes);
 479     }
 480
 481   return (0);
 482 }
 483
 484
 485 int
 486 svm_fifo_enqueue_with_offset (svm_fifo_t * f,
 487                               int pid,
 488                               u32 offset,
 489                               u32 required_bytes, u8 * copy_from_here)
 490 {
 491   return svm_fifo_enqueue_with_offset_internal
 492     (f, pid, offset, required_bytes, copy_from_here);
 493 }
 494
 495
 496 static int
 497 svm_fifo_dequeue_internal (svm_fifo_t * f,
 498                            int pid, u32 max_bytes, u8 * copy_here)
 499 {
 500   u32 total_copy_bytes, first_copy_bytes, second_copy_bytes;
 501   u32 cursize, nitems;
 502
 503   /* read cursize, which can only increase while we're working */
 504   cursize = svm_fifo_max_dequeue (f);
 505   if (PREDICT_FALSE (cursize == 0))
 506     return -2;                  /* nothing in the fifo */
 507
 508   nitems = f->nitems;
 509
 510   /* Number of bytes we're going to copy */
 511   total_copy_bytes = (cursize < max_bytes) ? cursize : max_bytes;
 512
 513   if (PREDICT_TRUE (copy_here != 0))
 514     {
 515       /* Number of bytes in first copy segment */
 516       first_copy_bytes = ((nitems - f->head) < total_copy_bytes)
 517         ? (nitems - f->head) : total_copy_bytes;
 518       clib_memcpy (copy_here, &f->data[f->head], first_copy_bytes);
 519       f->head += first_copy_bytes;
 520       f->head = (f->head == nitems) ? 0 : f->head;
 521
 522       /* Number of bytes in second copy segment, if any */
 523       second_copy_bytes = total_copy_bytes - first_copy_bytes;
 524       if (second_copy_bytes)
 525         {
 526           clib_memcpy (copy_here + first_copy_bytes,
 527                        &f->data[f->head], second_copy_bytes);
 528           f->head += second_copy_bytes;
 529           f->head = (f->head == nitems) ? 0 : f->head;
 530         }
 531     }
 532   else
 533     {
 534       /* Account for a zero-copy dequeue done elsewhere */
 535       ASSERT (max_bytes <= cursize);
 536       f->head += max_bytes;
 537       f->head = f->head % nitems;
 538       cursize -= max_bytes;
 539       total_copy_bytes = max_bytes;
 540     }
 541
 542   __sync_fetch_and_sub (&f->cursize, total_copy_bytes);
 543
 544   return (total_copy_bytes);
 545 }
 546
 547 int
 548 svm_fifo_dequeue_nowait (svm_fifo_t * f,
 549                          int pid, u32 max_bytes, u8 * copy_here)
 550 {
 551   return svm_fifo_dequeue_internal (f, pid, max_bytes, copy_here);
 552 }
 553
 554 int
 555 svm_fifo_peek (svm_fifo_t * f, int pid, u32 relative_offset, u32 max_bytes,
 556                u8 * copy_here)
 557 {
 558   u32 total_copy_bytes, first_copy_bytes, second_copy_bytes;
 559   u32 cursize, nitems, real_head;
 560
 561   /* read cursize, which can only increase while we're working */
 562   cursize = svm_fifo_max_dequeue (f);
 563   if (PREDICT_FALSE (cursize == 0))
 564     return -2;                  /* nothing in the fifo */
 565
 566   nitems = f->nitems;
 567   real_head = f->head + relative_offset;
 568   real_head = real_head >= nitems ? real_head - nitems : real_head;
 569
 570   /* Number of bytes we're going to copy */
 571   total_copy_bytes = (cursize < max_bytes) ? cursize : max_bytes;
 572
 573   if (PREDICT_TRUE (copy_here != 0))
 574     {
 575       /* Number of bytes in first copy segment */
 576       first_copy_bytes =
 577         ((nitems - real_head) < total_copy_bytes) ?
 578         (nitems - real_head) : total_copy_bytes;
 579       clib_memcpy (copy_here, &f->data[real_head], first_copy_bytes);
 580
 581       /* Number of bytes in second copy segment, if any */
 582       second_copy_bytes = total_copy_bytes - first_copy_bytes;
 583       if (second_copy_bytes)
 584         {
 585           clib_memcpy (copy_here + first_copy_bytes, &f->data[0],
 586                        second_copy_bytes);
 587         }
 588     }
 589   return total_copy_bytes;
 590 }
 591
 592 int
 593 svm_fifo_dequeue_drop (svm_fifo_t * f, int pid, u32 max_bytes)
 594 {
 595   u32 total_drop_bytes, first_drop_bytes, second_drop_bytes;
 596   u32 cursize, nitems;
 597
 598   /* read cursize, which can only increase while we're working */
 599   cursize = svm_fifo_max_dequeue (f);
 600   if (PREDICT_FALSE (cursize == 0))
 601     return -2;                  /* nothing in the fifo */
 602
 603   nitems = f->nitems;
 604
 605   /* Number of bytes we're going to drop */
 606   total_drop_bytes = (cursize < max_bytes) ? cursize : max_bytes;
 607
 608   /* Number of bytes in first copy segment */
 609   first_drop_bytes =
 610     ((nitems - f->head) < total_drop_bytes) ?
 611     (nitems - f->head) : total_drop_bytes;
 612   f->head += first_drop_bytes;
 613   f->head = (f->head == nitems) ? 0 : f->head;
 614
 615   /* Number of bytes in second drop segment, if any */
 616   second_drop_bytes = total_drop_bytes - first_drop_bytes;
 617   if (second_drop_bytes)
 618     {
 619       f->head += second_drop_bytes;
 620       f->head = (f->head == nitems) ? 0 : f->head;
 621     }
 622
 623   __sync_fetch_and_sub (&f->cursize, total_drop_bytes);
 624
 625   return total_drop_bytes;
 626 }
 627
 628 u32
 629 svm_fifo_number_ooo_segments (svm_fifo_t * f)
 630 {
 631   return pool_elts (f->ooo_segments);
 632 }
 633
 634 ooo_segment_t *
 635 svm_fifo_first_ooo_segment (svm_fifo_t * f)
 636 {
 637   return pool_elt_at_index (f->ooo_segments, f->ooos_list_head);
 638 }
 639
 640 /*
 641  * fd.io coding-style-patch-verification: ON
 642  *
 643  * Local Variables:
 644  * eval: (c-set-style "gnu")
 645  * End:
 646  */