src/svm/svm_fifo.h

   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 #ifndef __included_ssvm_fifo_h__
  20 #define __included_ssvm_fifo_h__
  21
  22 #include <vppinfra/clib.h>
  23 #include <vppinfra/vec.h>
  24 #include <vppinfra/pool.h>
  25 #include <vppinfra/format.h>
  26 #include <svm/fifo_types.h>
  27
  28 #define OOO_SEGMENT_INVALID_INDEX       ((u32)~0)
  29 #define SVM_FIFO_INVALID_SESSION_INDEX  ((u32)~0)
  30 #define SVM_FIFO_INVALID_INDEX          ((u32)~0)
  31
  32 typedef enum svm_fifo_deq_ntf_
  33 {
  34   SVM_FIFO_NO_DEQ_NOTIF = 0,            /**< No notification requested */
  35   SVM_FIFO_WANT_DEQ_NOTIF = 1,          /**< Notify on dequeue */
  36   SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL = 2,  /**< Notify on transition from full */
  37   SVM_FIFO_WANT_DEQ_NOTIF_IF_EMPTY = 4, /**< Notify on transition to empty */
  38 } svm_fifo_deq_ntf_t;
  39
  40 typedef enum svm_fifo_flag_
  41 {
  42   SVM_FIFO_F_LL_TRACKED = 1 << 0,
  43 } svm_fifo_flag_t;
  44
  45 typedef enum
  46 {
  47   SVM_FIFO_EFULL = -2,
  48   SVM_FIFO_EEMPTY = -3,
  49   SVM_FIFO_EGROW = -4,
  50 } svm_fifo_err_t;
  51
  52 typedef struct svm_fifo_seg_
  53 {
  54   u8 *data;
  55   u32 len;
  56 } svm_fifo_seg_t;
  57
  58 #if SVM_FIFO_TRACE
  59 #define svm_fifo_trace_add(_f, _s, _l, _t)              \
  60 {                                                       \
  61   svm_fifo_trace_elem_t *trace_elt;                     \
  62   vec_add2(_f->trace, trace_elt, 1);                    \
  63   trace_elt->offset = _s;                               \
  64   trace_elt->len = _l;                                  \
  65   trace_elt->action = _t;                               \
  66 }
  67 #else
  68 #define svm_fifo_trace_add(_f, _s, _l, _t)
  69 #endif
  70
  71 u8 *svm_fifo_dump_trace (u8 * s, svm_fifo_t * f);
  72 u8 *svm_fifo_replay (u8 * s, svm_fifo_t * f, u8 no_read, u8 verbose);
  73
  74 /**
  75  * Load head and tail optimized for consumer
  76  *
  77  * Internal function.
  78  */
  79 static inline void
  80 f_load_head_tail_cons (svm_fifo_t * f, u32 * head, u32 * tail)
  81 {
  82   /* load-relaxed: consumer owned index */
  83   *head = f->shr->head;
  84   /* load-acq: consumer foreign index (paired with store-rel in producer) */
  85   *tail = clib_atomic_load_acq_n (&f->shr->tail);
  86 }
  87
  88 /** Load head and tail optimized for producer
  89  *
  90  * Internal function
  91  */
  92 static inline void
  93 f_load_head_tail_prod (svm_fifo_t * f, u32 * head, u32 * tail)
  94 {
  95   /* load relaxed: producer owned index */
  96   *tail = f->shr->tail;
  97   /* load-acq: producer foreign index (paired with store-rel in consumer) */
  98   *head = clib_atomic_load_acq_n (&f->shr->head);
  99 }
 100
 101 /**
 102  * Load head and tail independent of producer/consumer role
 103  *
 104  * Internal function.
 105  */
 106 static inline void
 107 f_load_head_tail_all_acq (svm_fifo_t * f, u32 * head, u32 * tail)
 108 {
 109   /* load-acq : consumer foreign index (paired with store-rel) */
 110   *tail = clib_atomic_load_acq_n (&f->shr->tail);
 111   /* load-acq : producer foriegn index (paired with store-rel) */
 112   *head = clib_atomic_load_acq_n (&f->shr->head);
 113 }
 114
 115 /**
 116  * Fifo current size, i.e., number of bytes enqueued
 117  *
 118  * Internal function.
 119  */
 120 static inline u32
 121 f_cursize (svm_fifo_t * f, u32 head, u32 tail)
 122 {
 123   return tail - head;
 124 }
 125
 126 /**
 127  * Fifo free bytes, i.e., number of free bytes
 128  *
 129  * Internal function
 130  */
 131 static inline u32
 132 f_free_count (svm_fifo_t * f, u32 head, u32 tail)
 133 {
 134   return (f->shr->size - f_cursize (f, head, tail));
 135 }
 136
 137 always_inline u32
 138 f_chunk_end (svm_fifo_chunk_t * c)
 139 {
 140   return c->start_byte + c->length;
 141 }
 142
 143 always_inline int
 144 f_pos_lt (u32 a, u32 b)
 145 {
 146   return ((i32) (a - b) < 0);
 147 }
 148
 149 always_inline int
 150 f_pos_leq (u32 a, u32 b)
 151 {
 152   return ((i32) (a - b) <= 0);
 153 }
 154
 155 always_inline int
 156 f_pos_gt (u32 a, u32 b)
 157 {
 158   return ((i32) (a - b) > 0);
 159 }
 160
 161 always_inline int
 162 f_pos_geq (u32 a, u32 b)
 163 {
 164   return ((i32) (a - b) >= 0);
 165 }
 166
 167 always_inline u8
 168 f_chunk_includes_pos (svm_fifo_chunk_t * c, u32 pos)
 169 {
 170   return (f_pos_geq (pos, c->start_byte)
 171           && f_pos_lt (pos, c->start_byte + c->length));
 172 }
 173
 174 /**
 175  * Create fifo of requested size
 176  *
 177  * Allocates fifo on current heap.
 178  *
 179  * @param size          data size in bytes for fifo to be allocated. Will be
 180  *                      rounded to the next highest power-of-two value.
 181  * @return              pointer to new fifo
 182  */
 183 svm_fifo_t *svm_fifo_alloc (u32 size);
 184 /**
 185  * Initialize fifo
 186  *
 187  * @param f             fifo
 188  * @param size          size for fifo
 189  */
 190 void svm_fifo_init (svm_fifo_t * f, u32 size);
 191 /**
 192  * Allocate a fifo chunk on heap
 193  *
 194  * If the chunk is allocated on a fifo segment, this should be called
 195  * with the segment's heap pushed.
 196  *
 197  * @param size  chunk size in bytes. Will be rounded to the next highest
 198  *              power-of-two
 199  * @return      new chunk or 0 if alloc failed
 200  */
 201 svm_fifo_chunk_t *svm_fifo_chunk_alloc (u32 size);
 202 /**
 203  * Ensure the whole fifo size is writeable
 204  *
 205  * Allocates enough chunks to cover the whole fifo size.
 206  *
 207  * @param f     fifo
 208  */
 209 int svm_fifo_fill_chunk_list (svm_fifo_t * f);
 210 /**
 211  * Provision and return chunks for number of bytes requested
 212  *
 213  * Allocates enough chunks to cover the bytes requested and returns them
 214  * in the fifo segment array. The number of bytes provisioned may be less
 215  * than requested if not enough segments were provided.
 216  *
 217  * @param f             fifo
 218  * @param fs            array of fifo segments
 219  * @param n_segs        length of fifo segments array
 220  * @param len           number of bytes to preallocate
 221  * @return              number of fifo segments provisioned or error
 222  */
 223 int svm_fifo_provision_chunks (svm_fifo_t *f, svm_fifo_seg_t *fs, u32 n_segs,
 224                                u32 len);
 225 /**
 226  * Initialize rbtrees used for ooo lookups
 227  *
 228  * @param f             fifo
 229  * @param ooo_type      type of ooo operation (0 enqueue, 1 dequeue)
 230  */
 231 void svm_fifo_init_ooo_lookup (svm_fifo_t * f, u8 ooo_type);
 232 /**
 233  * Free fifo and associated state
 234  *
 235  * @param f     fifo
 236  */
 237 void svm_fifo_free (svm_fifo_t * f);
 238 /**
 239  * Cleanup fifo chunk lookup rb tree
 240  *
 241  * The rb tree is allocated in segment heap so this should be called
 242  * with it pushed.
 243  *
 244  * @param f     fifo to cleanup
 245  */
 246 void svm_fifo_free_chunk_lookup (svm_fifo_t * f);
 247 /**
 248  * Cleanup fifo ooo data
 249  *
 250  * The ooo data is allocated in producer process memory. The fifo
 251  * segment heap should not be pushed.
 252  *
 253  * @param f     fifo to cleanup
 254  */
 255 void svm_fifo_free_ooo_data (svm_fifo_t * f);
 256 /**
 257  * Init fifo head and tail
 258  *
 259  * @param f     fifo
 260  * @param head  head value that will be matched to a chunk
 261  * @param tail  tail value that will be matched to a chunk
 262  */
 263 void svm_fifo_init_pointers (svm_fifo_t * f, u32 head, u32 tail);
 264 /**
 265  * Clone fifo
 266  *
 267  * Clones single/default chunk fifo. It does not work for fifos with
 268  * multiple chunks.
 269  */
 270 void svm_fifo_clone (svm_fifo_t * df, svm_fifo_t * sf);
 271 /**
 272  * Enqueue data to fifo
 273  *
 274  * Data is enqueued and tail pointer is updated atomically. If the new data
 275  * enqueued partly overlaps or "touches" an out-of-order segment, said segment
 276  * is "consumed" and the number of bytes returned is appropriately updated.
 277  *
 278  * @param f     fifo
 279  * @param len   length of data to copy
 280  * @param src   buffer from where to copy the data
 281  * @return      number of contiguous bytes that can be consumed or error
 282  */
 283 int svm_fifo_enqueue (svm_fifo_t * f, u32 len, const u8 * src);
 284 /**
 285  * Enqueue data to fifo with offset
 286  *
 287  * Data is enqueued without updating tail pointer. Instead, an out-of-order
 288  * list of segments is generated and maintained. Fifo takes care of coalescing
 289  * contiguous or overlapping segments.
 290  *
 291  * @param f             fifo
 292  * @param offset        offset at which to copy the data
 293  * @param len           len of data to copy
 294  * @param src           buffer from where to copy the data
 295  * @return              0 if enqueue was successful, error otherwise
 296  */
 297 int svm_fifo_enqueue_with_offset (svm_fifo_t * f, u32 offset, u32 len,
 298                                   u8 * src);
 299
 300 /**
 301  * Advance tail pointer
 302  *
 303  * Useful for moving tail pointer after external enqueue.
 304  *
 305  * @param f             fifo
 306  * @param len           number of bytes to add to tail
 307  */
 308 void svm_fifo_enqueue_nocopy (svm_fifo_t * f, u32 len);
 309 /**
 310  * Enqueue array of @ref svm_fifo_seg_t in order
 311  *
 312  * @param f             fifo
 313  * @param segs          array of segments to enqueue
 314  * @param n_segs        number of segments
 315  * @param allow_partial if set partial enqueues are allowed
 316  * @return              len if enqueue was successful, error otherwise
 317  */
 318 int svm_fifo_enqueue_segments (svm_fifo_t * f, const svm_fifo_seg_t segs[],
 319                                u32 n_segs, u8 allow_partial);
 320 /**
 321  * Overwrite fifo head with new data
 322  *
 323  * This should be typically used by dgram transport protocols that need
 324  * to update the dgram header after dequeuing a chunk of data. It assumes
 325  * that the dgram header is at most spread over two chunks.
 326  *
 327  * @param f             fifo
 328  * @param src           src of new data
 329  * @param len           length of new data
 330  */
 331 void svm_fifo_overwrite_head (svm_fifo_t * f, u8 * src, u32 len);
 332 /**
 333  * Dequeue data from fifo
 334  *
 335  * Data is dequeued to consumer provided buffer and head is atomically
 336  * updated. This should not be used in combination with ooo lookups. If
 337  * ooo peeking of data is needed in combination with dequeuing use @ref
 338  * svm_fifo_dequeue_drop.
 339  *
 340  * @param f             fifo
 341  * @param len           length of data to dequeue
 342  * @param dst           buffer to where to dequeue the data
 343  * @return              number of bytes dequeued or error
 344  */
 345 int svm_fifo_dequeue (svm_fifo_t * f, u32 len, u8 * dst);
 346 /**
 347  * Peek data from fifo
 348  *
 349  * Data is copied from requested offset into provided dst buffer. Head is
 350  * not updated.
 351  *
 352  * @param f             fifo
 353  * @param offset        offset from which to copy the data
 354  * @param len           length of data to copy
 355  * @param dst           buffer to where to dequeue the data
 356  * @return              number of bytes peeked
 357  */
 358 int svm_fifo_peek (svm_fifo_t * f, u32 offset, u32 len, u8 * dst);
 359 /**
 360  * Dequeue and drop bytes from fifo
 361  *
 362  * Advances fifo head by requested amount of bytes.
 363  *
 364  * @param f             fifo
 365  * @param len           number of bytes to drop
 366  * @return              number of bytes dropped
 367  */
 368 int svm_fifo_dequeue_drop (svm_fifo_t * f, u32 len);
 369 /**
 370  * Dequeue and drop all bytes from fifo
 371  *
 372  * Advances head to tail position.
 373  *
 374  * @param f             fifo
 375  */
 376 void svm_fifo_dequeue_drop_all (svm_fifo_t * f);
 377 /**
 378  * Get pointers to fifo chunks data in @ref svm_fifo_seg_t array
 379  *
 380  * Populates fifo segment array with pointers to fifo chunk data and lengths.
 381  * Because this returns pointers to data, it must be paired with
 382  * @ref svm_fifo_dequeue_drop to actually release the fifo chunks after the
 383  * data is consumed.
 384  *
 385  * @param f             fifo
 386  * @param offset        offset from where to retrieve segments
 387  * @param fs            array of fifo segments allocated by caller
 388  * @param n_segs        number of fifo segments in array
 389  * @param max_bytes     max bytes to be mapped to fifo segments
 390  * @return              number of bytes in fifo segments or SVM_FIFO_EEMPTY
 391  */
 392 int svm_fifo_segments (svm_fifo_t * f, u32 offset, svm_fifo_seg_t * fs,
 393                        u32 n_segs, u32 max_bytes);
 394 /**
 395  * Add io events subscriber to list
 396  *
 397  * @param f     fifo
 398  * @param sub   subscriber opaque index (typically app worker index)
 399  */
 400 void svm_fifo_add_subscriber (svm_fifo_t * f, u8 sub);
 401 /**
 402  * Remove io events subscriber form list
 403  *
 404  * @param f     fifo
 405  * @param sub   subscriber index to be removed
 406  */
 407 void svm_fifo_del_subscriber (svm_fifo_t * f, u8 subscriber);
 408 /**
 409  * Number of out-of-order segments for fifo
 410  *
 411  * @param f     fifo
 412  * @return      number of out of order segments
 413  */
 414 u32 svm_fifo_n_ooo_segments (svm_fifo_t * f);
 415 /**
 416  * First out-of-order segment for fifo
 417  *
 418  * @param f     fifo
 419  * @return      first out-of-order segment for fifo
 420  */
 421 ooo_segment_t *svm_fifo_first_ooo_segment (svm_fifo_t * f);
 422 /**
 423  * Check if fifo is sane. Debug only.
 424  *
 425  * @param f     fifo
 426  * @return      1 if sane, 0 otherwise
 427  */
 428 u8 svm_fifo_is_sane (svm_fifo_t * f);
 429 /**
 430  * Number of chunks linked into the fifo
 431  *
 432  * @param f     fifo
 433  * @return      number of chunks in fifo linked list
 434  */
 435 u32 svm_fifo_n_chunks (svm_fifo_t * f);
 436 format_function_t format_svm_fifo;
 437
 438 /**
 439  * Fifo max bytes to dequeue optimized for consumer
 440  *
 441  * @param f     fifo
 442  * @return      max number of bytes that can be dequeued
 443  */
 444 static inline u32
 445 svm_fifo_max_dequeue_cons (svm_fifo_t * f)
 446 {
 447   u32 tail, head;
 448   f_load_head_tail_cons (f, &head, &tail);
 449   return f_cursize (f, head, tail);
 450 }
 451
 452 /**
 453  * Fifo max bytes to dequeue optimized for producer
 454  *
 455  * @param f     fifo
 456  * @return      max number of bytes that can be dequeued
 457  */
 458 static inline u32
 459 svm_fifo_max_dequeue_prod (svm_fifo_t * f)
 460 {
 461   u32 tail, head;
 462   f_load_head_tail_prod (f, &head, &tail);
 463   return f_cursize (f, head, tail);
 464 }
 465
 466 /**
 467  * Fifo max bytes to dequeue
 468  *
 469  * Note: use producer or consumer specific functions for performance:
 470  * @ref svm_fifo_max_dequeue_cons (svm_fifo_t *f)
 471  * @ref svm_fifo_max_dequeue_prod (svm_fifo_t *f)
 472  */
 473 static inline u32
 474 svm_fifo_max_dequeue (svm_fifo_t * f)
 475 {
 476   u32 tail, head;
 477   f_load_head_tail_all_acq (f, &head, &tail);
 478   return f_cursize (f, head, tail);
 479 }
 480
 481 /**
 482  * Check if fifo is full optimized for producer
 483  *
 484  * @param f     fifo
 485  * @return      1 if fifo is full 0 otherwise
 486  */
 487 static inline int
 488 svm_fifo_is_full_prod (svm_fifo_t * f)
 489 {
 490   return (svm_fifo_max_dequeue_prod (f) == f->shr->size);
 491 }
 492
 493 /* Check if fifo is full.
 494  *
 495  * Note: use producer or consumer specific functions for performance.
 496  * @ref svm_fifo_is_full_prod (svm_fifo_t * f)
 497  * add cons version if needed
 498  */
 499 static inline int
 500 svm_fifo_is_full (svm_fifo_t * f)
 501 {
 502   return (svm_fifo_max_dequeue (f) == f->shr->size);
 503 }
 504
 505 /**
 506  * Check if fifo is empty optimized for consumer
 507  *
 508  * @param f     fifo
 509  * @return      1 if fifo is empty 0 otherwise
 510  */
 511 static inline int
 512 svm_fifo_is_empty_cons (svm_fifo_t * f)
 513 {
 514   return (svm_fifo_max_dequeue_cons (f) == 0);
 515 }
 516
 517 /**
 518  * Check if fifo is empty optimized for producer
 519  *
 520  * @param f     fifo
 521  * @return      1 if fifo is empty 0 otherwise
 522  */
 523 static inline int
 524 svm_fifo_is_empty_prod (svm_fifo_t * f)
 525 {
 526   return (svm_fifo_max_dequeue_prod (f) == 0);
 527 }
 528
 529 /**
 530  * Check if fifo is empty
 531  *
 532  * Note: use producer or consumer specific functions for perfomance.
 533  * @ref svm_fifo_is_empty_cons (svm_fifo_t * f)
 534  * @ref svm_fifo_is_empty_prod (svm_fifo_t * f)
 535  */
 536 static inline int
 537 svm_fifo_is_empty (svm_fifo_t * f)
 538 {
 539   return (svm_fifo_max_dequeue (f) == 0);
 540 }
 541
 542 /**
 543  * Check if fifo is wrapped
 544  *
 545  * @param f     fifo
 546  * @return      1 if 'normalized' head is ahead of tail
 547  */
 548 static inline u8
 549 svm_fifo_is_wrapped (svm_fifo_t * f)
 550 {
 551   u32 head, tail;
 552   f_load_head_tail_all_acq (f, &head, &tail);
 553   return head > tail;
 554 }
 555
 556 /**
 557  * Maximum number of bytes that can be enqueued into fifo
 558  *
 559  * Optimized for producer
 560  *
 561  * @param f     fifo
 562  * @return      max number of bytes that can be enqueued into fifo
 563  */
 564 static inline u32
 565 svm_fifo_max_enqueue_prod (svm_fifo_t * f)
 566 {
 567   u32 head, tail;
 568   f_load_head_tail_prod (f, &head, &tail);
 569   return f_free_count (f, head, tail);
 570 }
 571
 572 /* Maximum number of bytes that can be enqueued into fifo
 573  *
 574  * Note: use producer or consumer specific functions for performance.
 575  * @ref svm_fifo_max_enqueue_prod (svm_fifo_t *f)
 576  * add consumer specific version if needed.
 577  */
 578 static inline u32
 579 svm_fifo_max_enqueue (svm_fifo_t * f)
 580 {
 581   u32 head, tail;
 582   f_load_head_tail_all_acq (f, &head, &tail);
 583   return f_free_count (f, head, tail);
 584 }
 585
 586 /**
 587  * Max contiguous chunk of data that can be read.
 588  *
 589  * Should only be called by consumers.
 590  */
 591 u32 svm_fifo_max_read_chunk (svm_fifo_t * f);
 592
 593 /**
 594  * Max contiguous chunk of data that can be written
 595  *
 596  * Should only be called by producers
 597  */
 598 u32 svm_fifo_max_write_chunk (svm_fifo_t * f);
 599
 600 /**
 601  * Fifo head chunk getter
 602  *
 603  * @param f     fifo
 604  * @return      head chunk pointer
 605  */
 606 static inline svm_fifo_chunk_t *
 607 svm_fifo_head_chunk (svm_fifo_t * f)
 608 {
 609   return f->shr->head_chunk;
 610 }
 611
 612 /**
 613  * Fifo head pointer getter
 614  *
 615  * @param f     fifo
 616  * @return      head pointer
 617  */
 618 static inline u8 *
 619 svm_fifo_head (svm_fifo_t * f)
 620 {
 621   if (!f->shr->head_chunk)
 622     return 0;
 623   /* load-relaxed: consumer owned index */
 624   return (f->shr->head_chunk->data +
 625           (f->shr->head - f->shr->head_chunk->start_byte));
 626 }
 627
 628 /**
 629  * Fifo tail chunk getter
 630  *
 631  * @param f     fifo
 632  * @return      tail chunk pointer
 633  */
 634 static inline svm_fifo_chunk_t *
 635 svm_fifo_tail_chunk (svm_fifo_t * f)
 636 {
 637   return f->shr->tail_chunk;
 638 }
 639
 640 /**
 641  * Fifo tail pointer getter
 642  *
 643  * @param f     fifo
 644  * @return      tail pointer
 645  */
 646 static inline u8 *
 647 svm_fifo_tail (svm_fifo_t * f)
 648 {
 649   /* load-relaxed: producer owned index */
 650   return (f->shr->tail_chunk->data +
 651           (f->shr->tail - f->shr->tail_chunk->start_byte));
 652 }
 653
 654 /**
 655  * Fifo number of subscribers getter
 656  *
 657  * @param f     fifo
 658  * @return      number of subscribers
 659  */
 660 static inline u8
 661 svm_fifo_n_subscribers (svm_fifo_t * f)
 662 {
 663   return f->shr->n_subscribers;
 664 }
 665
 666 /**
 667  * Check if fifo has out-of-order data
 668  *
 669  * @param f     fifo
 670  * @return      1 if fifo has ooo data, 0 otherwise
 671  */
 672 static inline u8
 673 svm_fifo_has_ooo_data (svm_fifo_t * f)
 674 {
 675   return f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX;
 676 }
 677
 678 static inline ooo_segment_t *
 679 svm_fifo_newest_ooo_segment (svm_fifo_t * f)
 680 {
 681   if (f->ooos_newest == OOO_SEGMENT_INVALID_INDEX)
 682     return 0;
 683   return pool_elt_at_index (f->ooo_segments, f->ooos_newest);
 684 }
 685
 686 static inline void
 687 svm_fifo_newest_ooo_segment_reset (svm_fifo_t * f)
 688 {
 689   f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
 690 }
 691
 692 static inline u32
 693 ooo_segment_offset_prod (svm_fifo_t * f, ooo_segment_t * s)
 694 {
 695   u32 tail;
 696   /* load-relaxed: producer owned index */
 697   tail = f->shr->tail;
 698
 699   return (s->start - tail);
 700 }
 701
 702 static inline u32
 703 ooo_segment_length (svm_fifo_t * f, ooo_segment_t * s)
 704 {
 705   return s->length;
 706 }
 707
 708 static inline u32
 709 svm_fifo_size (svm_fifo_t * f)
 710 {
 711   return f->shr->size;
 712 }
 713
 714 static inline void
 715 svm_fifo_set_size (svm_fifo_t * f, u32 size)
 716 {
 717   if (size > (1 << f->fs_hdr->max_log2_fifo_size))
 718     return;
 719   fsh_virtual_mem_update (f->fs_hdr, f->shr->slice_index,
 720                           (int) f->shr->size - size);
 721   f->shr->size = size;
 722 }
 723
 724 /**
 725  * Check if fifo has io event
 726  *
 727  * @param f     fifo
 728  * @return      1 if fifo has event, 0 otherwise
 729  */
 730 static inline int
 731 svm_fifo_has_event (svm_fifo_t * f)
 732 {
 733   return f->shr->has_event;
 734 }
 735
 736 /**
 737  * Set fifo event flag.
 738  *
 739  * Forces release semantics.
 740  *
 741  * @param f     fifo
 742  * @return      1 if flag was not set, 0 otherwise
 743  */
 744 always_inline u8
 745 svm_fifo_set_event (svm_fifo_t * f)
 746 {
 747   return !clib_atomic_swap_rel_n (&f->shr->has_event, 1);
 748 }
 749
 750 /**
 751  * Unset fifo event flag.
 752  *
 753  * Forces acquire semantics
 754  *
 755  * @param f     fifo
 756  */
 757 always_inline void
 758 svm_fifo_unset_event (svm_fifo_t * f)
 759 {
 760   clib_atomic_swap_acq_n (&f->shr->has_event, 0);
 761 }
 762
 763 /**
 764  * Set specific want notification flag
 765  *
 766  * For list of flags see @ref svm_fifo_deq_ntf_t
 767  *
 768  * @param f             fifo
 769  * @param ntf_type      type of notification requested
 770  */
 771 static inline void
 772 svm_fifo_add_want_deq_ntf (svm_fifo_t * f, u8 ntf_type)
 773 {
 774   f->shr->want_deq_ntf |= ntf_type;
 775 }
 776
 777 /**
 778  * Clear specific want notification flag
 779  *
 780  * For list of flags see @ref svm_fifo_ntf_t
 781  *
 782  * @param f             fifo
 783  * @param ntf_type      type of notification to be cleared
 784  */
 785 static inline void
 786 svm_fifo_del_want_deq_ntf (svm_fifo_t * f, u8 ntf_type)
 787 {
 788   f->shr->want_deq_ntf &= ~ntf_type;
 789 }
 790
 791 /**
 792  * Clear the want notification flag and set has notification
 793  *
 794  * Should be used after enqueuing an event. This clears the
 795  * SVM_FIFO_WANT_NOTIF flag but it does not clear
 796  * SVM_FIFO_WANT_NOTIF_IF_FULL. If the latter was set, has_ntf is
 797  * set to avoid enqueueing events for for all dequeue operations until
 798  * it is manually cleared.
 799  *
 800  * @param f     fifo
 801  */
 802 static inline void
 803 svm_fifo_clear_deq_ntf (svm_fifo_t * f)
 804 {
 805   /* Set the flag if want_notif_if_full was the only ntf requested */
 806   f->shr->has_deq_ntf =
 807     f->shr->want_deq_ntf == SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL;
 808   svm_fifo_del_want_deq_ntf (f, SVM_FIFO_WANT_DEQ_NOTIF);
 809 }
 810
 811 /**
 812  * Clear has notification flag
 813  *
 814  * The fifo generates only one event per SVM_FIFO_WANT_NOTIF_IF_FULL
 815  * request and sets has_ntf. To received new events the flag must be
 816  * cleared using this function.
 817  *
 818  * @param f     fifo
 819  */
 820 static inline void
 821 svm_fifo_reset_has_deq_ntf (svm_fifo_t * f)
 822 {
 823   f->shr->has_deq_ntf = 0;
 824 }
 825
 826 /**
 827  * Check if fifo needs dequeue notification
 828  *
 829  * Determines based on notification request flags and state of the fifo if
 830  * an event should be generated.
 831  *
 832  * @param f             fifo
 833  * @param n_last_deq    number of bytes last dequeued
 834  * @return              1 if event should be generated, 0 otherwise
 835  */
 836 static inline u8
 837 svm_fifo_needs_deq_ntf (svm_fifo_t * f, u32 n_last_deq)
 838 {
 839   u8 want_ntf = f->shr->want_deq_ntf;
 840
 841   if (PREDICT_TRUE (want_ntf == SVM_FIFO_NO_DEQ_NOTIF))
 842     return 0;
 843   else if (want_ntf & SVM_FIFO_WANT_DEQ_NOTIF)
 844     return 1;
 845   if (want_ntf & SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL)
 846     {
 847       u32 max_deq = svm_fifo_max_dequeue_cons (f);
 848       u32 size = f->shr->size;
 849       if (!f->shr->has_deq_ntf && max_deq < size &&
 850           max_deq + n_last_deq >= size)
 851         return 1;
 852     }
 853   if (want_ntf & SVM_FIFO_WANT_DEQ_NOTIF_IF_EMPTY)
 854     {
 855       if (!f->shr->has_deq_ntf && svm_fifo_is_empty (f))
 856         return 1;
 857     }
 858   return 0;
 859 }
 860
 861 #endif /* __included_ssvm_fifo_h__ */
 862
 863 /*
 864  * fd.io coding-style-patch-verification: ON
 865  *
 866  * Local Variables:
 867  * eval: (c-set-style "gnu")
 868  * End:
 869  */