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->head;
  84   /* load-acq: consumer foreign index (paired with store-rel in producer) */
  85   *tail = clib_atomic_load_acq_n (&f->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->tail;
  97   /* load-acq: producer foreign index (paired with store-rel in consumer) */
  98   *head = clib_atomic_load_acq_n (&f->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->tail);
 111   /* load-acq : producer foriegn index (paired with store-rel) */
 112   *head = clib_atomic_load_acq_n (&f->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->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  * Initialize rbtrees used for ooo lookups
 212  *
 213  * @param f             fifo
 214  * @param ooo_type      type of ooo operation (0 enqueue, 1 dequeue)
 215  */
 216 void svm_fifo_init_ooo_lookup (svm_fifo_t * f, u8 ooo_type);
 217 /**
 218  * Free fifo and associated state
 219  *
 220  * @param f     fifo
 221  */
 222 void svm_fifo_free (svm_fifo_t * f);
 223 /**
 224  * Cleanup fifo chunk lookup rb tree
 225  *
 226  * The rb tree is allocated in segment heap so this should be called
 227  * with it pushed.
 228  *
 229  * @param f     fifo to cleanup
 230  */
 231 void svm_fifo_free_chunk_lookup (svm_fifo_t * f);
 232 /**
 233  * Cleanup fifo ooo data
 234  *
 235  * The ooo data is allocated in producer process memory. The fifo
 236  * segment heap should not be pushed.
 237  *
 238  * @param f     fifo to cleanup
 239  */
 240 void svm_fifo_free_ooo_data (svm_fifo_t * f);
 241 /**
 242  * Init fifo head and tail
 243  *
 244  * @param f     fifo
 245  * @param head  head value that will be matched to a chunk
 246  * @param tail  tail value that will be matched to a chunk
 247  */
 248 void svm_fifo_init_pointers (svm_fifo_t * f, u32 head, u32 tail);
 249 /**
 250  * Clone fifo
 251  *
 252  * Clones single/default chunk fifo. It does not work for fifos with
 253  * multiple chunks.
 254  */
 255 void svm_fifo_clone (svm_fifo_t * df, svm_fifo_t * sf);
 256 /**
 257  * Enqueue data to fifo
 258  *
 259  * Data is enqueued and tail pointer is updated atomically. If the new data
 260  * enqueued partly overlaps or "touches" an out-of-order segment, said segment
 261  * is "consumed" and the number of bytes returned is appropriately updated.
 262  *
 263  * @param f     fifo
 264  * @param len   length of data to copy
 265  * @param src   buffer from where to copy the data
 266  * @return      number of contiguous bytes that can be consumed or error
 267  */
 268 int svm_fifo_enqueue (svm_fifo_t * f, u32 len, const u8 * src);
 269 /**
 270  * Enqueue data to fifo with offset
 271  *
 272  * Data is enqueued without updating tail pointer. Instead, an out-of-order
 273  * list of segments is generated and maintained. Fifo takes care of coalescing
 274  * contiguous or overlapping segments.
 275  *
 276  * @param f             fifo
 277  * @param offset        offset at which to copy the data
 278  * @param len           len of data to copy
 279  * @param src           buffer from where to copy the data
 280  * @return              0 if enqueue was successful, error otherwise
 281  */
 282 int svm_fifo_enqueue_with_offset (svm_fifo_t * f, u32 offset, u32 len,
 283                                   u8 * src);
 284
 285 /**
 286  * Advance tail pointer
 287  *
 288  * Useful for moving tail pointer after external enqueue.
 289  *
 290  * @param f             fifo
 291  * @param len           number of bytes to add to tail
 292  */
 293 void svm_fifo_enqueue_nocopy (svm_fifo_t * f, u32 len);
 294 /**
 295  * Overwrite fifo head with new data
 296  *
 297  * This should be typically used by dgram transport protocols that need
 298  * to update the dgram header after dequeuing a chunk of data. It assumes
 299  * that the dgram header is at most spread over two chunks.
 300  *
 301  * @param f             fifo
 302  * @param src           src of new data
 303  * @param len           length of new data
 304  */
 305 void svm_fifo_overwrite_head (svm_fifo_t * f, u8 * src, u32 len);
 306 /**
 307  * Dequeue data from fifo
 308  *
 309  * Data is dequeued to consumer provided buffer and head is atomically
 310  * updated. This should not be used in combination with ooo lookups. If
 311  * ooo peeking of data is needed in combination with dequeuing use @ref
 312  * svm_fifo_dequeue_drop.
 313  *
 314  * @param f             fifo
 315  * @param len           length of data to dequeue
 316  * @param dst           buffer to where to dequeue the data
 317  * @return              number of bytes dequeued or error
 318  */
 319 int svm_fifo_dequeue (svm_fifo_t * f, u32 len, u8 * dst);
 320 /**
 321  * Peek data from fifo
 322  *
 323  * Data is copied from requested offset into provided dst buffer. Head is
 324  * not updated.
 325  *
 326  * @param f             fifo
 327  * @param offset        offset from which to copy the data
 328  * @param len           length of data to copy
 329  * @param dst           buffer to where to dequeue the data
 330  * @return              number of bytes peeked
 331  */
 332 int svm_fifo_peek (svm_fifo_t * f, u32 offset, u32 len, u8 * dst);
 333 /**
 334  * Dequeue and drop bytes from fifo
 335  *
 336  * Advances fifo head by requested amount of bytes.
 337  *
 338  * @param f             fifo
 339  * @param len           number of bytes to drop
 340  * @return              number of bytes dropped
 341  */
 342 int svm_fifo_dequeue_drop (svm_fifo_t * f, u32 len);
 343 /**
 344  * Dequeue and drop all bytes from fifo
 345  *
 346  * Advances head to tail position.
 347  *
 348  * @param f             fifo
 349  */
 350 void svm_fifo_dequeue_drop_all (svm_fifo_t * f);
 351 /**
 352  * Get pointers to fifo chunks data in @ref svm_fifo_seg_t array
 353  *
 354  * Populates fifo segment array with pointers to fifo chunk data and lengths.
 355  * Because this returns pointers to data, it must be paired with
 356  * @ref svm_fifo_dequeue_drop to actually release the fifo chunks after the
 357  * data is consumed.
 358  *
 359  * @param f             fifo
 360  * @param fs            array of fifo segments allocated by caller
 361  * @param n_segs        number of fifo segments in array
 362  * @param max_bytes     max bytes to be mapped to fifo segments
 363  * @return              number of bytes in fifo segments or SVM_FIFO_EEMPTY
 364  */
 365 int svm_fifo_segments (svm_fifo_t * f, svm_fifo_seg_t * fs, u32 n_segs,
 366                        u32 max_bytes);
 367 /**
 368  * Add io events subscriber to list
 369  *
 370  * @param f     fifo
 371  * @param sub   subscriber opaque index (typically app worker index)
 372  */
 373 void svm_fifo_add_subscriber (svm_fifo_t * f, u8 sub);
 374 /**
 375  * Remove io events subscriber form list
 376  *
 377  * @param f     fifo
 378  * @param sub   subscriber index to be removed
 379  */
 380 void svm_fifo_del_subscriber (svm_fifo_t * f, u8 subscriber);
 381 /**
 382  * Number of out-of-order segments for fifo
 383  *
 384  * @param f     fifo
 385  * @return      number of out of order segments
 386  */
 387 u32 svm_fifo_n_ooo_segments (svm_fifo_t * f);
 388 /**
 389  * First out-of-order segment for fifo
 390  *
 391  * @param f     fifo
 392  * @return      first out-of-order segment for fifo
 393  */
 394 ooo_segment_t *svm_fifo_first_ooo_segment (svm_fifo_t * f);
 395 /**
 396  * Check if fifo is sane. Debug only.
 397  *
 398  * @param f     fifo
 399  * @return      1 if sane, 0 otherwise
 400  */
 401 u8 svm_fifo_is_sane (svm_fifo_t * f);
 402 /**
 403  * Number of chunks linked into the fifo
 404  *
 405  * @param f     fifo
 406  * @return      number of chunks in fifo linked list
 407  */
 408 u32 svm_fifo_n_chunks (svm_fifo_t * f);
 409 format_function_t format_svm_fifo;
 410
 411 /**
 412  * Fifo max bytes to dequeue optimized for consumer
 413  *
 414  * @param f     fifo
 415  * @return      max number of bytes that can be dequeued
 416  */
 417 static inline u32
 418 svm_fifo_max_dequeue_cons (svm_fifo_t * f)
 419 {
 420   u32 tail, head;
 421   f_load_head_tail_cons (f, &head, &tail);
 422   return f_cursize (f, head, tail);
 423 }
 424
 425 /**
 426  * Fifo max bytes to dequeue optimized for producer
 427  *
 428  * @param f     fifo
 429  * @return      max number of bytes that can be dequeued
 430  */
 431 static inline u32
 432 svm_fifo_max_dequeue_prod (svm_fifo_t * f)
 433 {
 434   u32 tail, head;
 435   f_load_head_tail_prod (f, &head, &tail);
 436   return f_cursize (f, head, tail);
 437 }
 438
 439 /**
 440  * Fifo max bytes to dequeue
 441  *
 442  * Note: use producer or consumer specific functions for performance:
 443  * @ref svm_fifo_max_dequeue_cons (svm_fifo_t *f)
 444  * @ref svm_fifo_max_dequeue_prod (svm_fifo_t *f)
 445  */
 446 static inline u32
 447 svm_fifo_max_dequeue (svm_fifo_t * f)
 448 {
 449   u32 tail, head;
 450   f_load_head_tail_all_acq (f, &head, &tail);
 451   return f_cursize (f, head, tail);
 452 }
 453
 454 /**
 455  * Check if fifo is full optimized for producer
 456  *
 457  * @param f     fifo
 458  * @return      1 if fifo is full 0 otherwise
 459  */
 460 static inline int
 461 svm_fifo_is_full_prod (svm_fifo_t * f)
 462 {
 463   return (svm_fifo_max_dequeue_prod (f) == f->size);
 464 }
 465
 466 /* Check if fifo is full.
 467  *
 468  * Note: use producer or consumer specific functions for performance.
 469  * @ref svm_fifo_is_full_prod (svm_fifo_t * f)
 470  * add cons version if needed
 471  */
 472 static inline int
 473 svm_fifo_is_full (svm_fifo_t * f)
 474 {
 475   return (svm_fifo_max_dequeue (f) == f->size);
 476 }
 477
 478 /**
 479  * Check if fifo is empty optimized for consumer
 480  *
 481  * @param f     fifo
 482  * @return      1 if fifo is empty 0 otherwise
 483  */
 484 static inline int
 485 svm_fifo_is_empty_cons (svm_fifo_t * f)
 486 {
 487   return (svm_fifo_max_dequeue_cons (f) == 0);
 488 }
 489
 490 /**
 491  * Check if fifo is empty optimized for producer
 492  *
 493  * @param f     fifo
 494  * @return      1 if fifo is empty 0 otherwise
 495  */
 496 static inline int
 497 svm_fifo_is_empty_prod (svm_fifo_t * f)
 498 {
 499   return (svm_fifo_max_dequeue_prod (f) == 0);
 500 }
 501
 502 /**
 503  * Check if fifo is empty
 504  *
 505  * Note: use producer or consumer specific functions for perfomance.
 506  * @ref svm_fifo_is_empty_cons (svm_fifo_t * f)
 507  * @ref svm_fifo_is_empty_prod (svm_fifo_t * f)
 508  */
 509 static inline int
 510 svm_fifo_is_empty (svm_fifo_t * f)
 511 {
 512   return (svm_fifo_max_dequeue (f) == 0);
 513 }
 514
 515 /**
 516  * Check if fifo is wrapped
 517  *
 518  * @param f     fifo
 519  * @return      1 if 'normalized' head is ahead of tail
 520  */
 521 static inline u8
 522 svm_fifo_is_wrapped (svm_fifo_t * f)
 523 {
 524   u32 head, tail;
 525   f_load_head_tail_all_acq (f, &head, &tail);
 526   return head > tail;
 527 }
 528
 529 /**
 530  * Maximum number of bytes that can be enqueued into fifo
 531  *
 532  * Optimized for producer
 533  *
 534  * @param f     fifo
 535  * @return      max number of bytes that can be enqueued into fifo
 536  */
 537 static inline u32
 538 svm_fifo_max_enqueue_prod (svm_fifo_t * f)
 539 {
 540   u32 head, tail;
 541   f_load_head_tail_prod (f, &head, &tail);
 542   return f_free_count (f, head, tail);
 543 }
 544
 545 /* Maximum number of bytes that can be enqueued into fifo
 546  *
 547  * Note: use producer or consumer specific functions for performance.
 548  * @ref svm_fifo_max_enqueue_prod (svm_fifo_t *f)
 549  * add consumer specific version if needed.
 550  */
 551 static inline u32
 552 svm_fifo_max_enqueue (svm_fifo_t * f)
 553 {
 554   u32 head, tail;
 555   f_load_head_tail_all_acq (f, &head, &tail);
 556   return f_free_count (f, head, tail);
 557 }
 558
 559 /**
 560  * Max contiguous chunk of data that can be read.
 561  *
 562  * Should only be called by consumers.
 563  */
 564 u32 svm_fifo_max_read_chunk (svm_fifo_t * f);
 565
 566 /**
 567  * Max contiguous chunk of data that can be written
 568  *
 569  * Should only be called by producers
 570  */
 571 u32 svm_fifo_max_write_chunk (svm_fifo_t * f);
 572
 573 /**
 574  * Fifo head chunk getter
 575  *
 576  * @param f     fifo
 577  * @return      head chunk pointer
 578  */
 579 static inline svm_fifo_chunk_t *
 580 svm_fifo_head_chunk (svm_fifo_t * f)
 581 {
 582   return f->head_chunk;
 583 }
 584
 585 /**
 586  * Fifo head pointer getter
 587  *
 588  * @param f     fifo
 589  * @return      head pointer
 590  */
 591 static inline u8 *
 592 svm_fifo_head (svm_fifo_t * f)
 593 {
 594   if (!f->head_chunk)
 595     return 0;
 596   /* load-relaxed: consumer owned index */
 597   return (f->head_chunk->data + (f->head - f->head_chunk->start_byte));
 598 }
 599
 600 /**
 601  * Fifo tail chunk getter
 602  *
 603  * @param f     fifo
 604  * @return      tail chunk pointer
 605  */
 606 static inline svm_fifo_chunk_t *
 607 svm_fifo_tail_chunk (svm_fifo_t * f)
 608 {
 609   return f->tail_chunk;
 610 }
 611
 612 /**
 613  * Fifo tail pointer getter
 614  *
 615  * @param f     fifo
 616  * @return      tail pointer
 617  */
 618 static inline u8 *
 619 svm_fifo_tail (svm_fifo_t * f)
 620 {
 621   /* load-relaxed: producer owned index */
 622   return (f->tail_chunk->data + (f->tail - f->tail_chunk->start_byte));
 623 }
 624
 625 /**
 626  * Fifo number of subscribers getter
 627  *
 628  * @param f     fifo
 629  * @return      number of subscribers
 630  */
 631 static inline u8
 632 svm_fifo_n_subscribers (svm_fifo_t * f)
 633 {
 634   return f->n_subscribers;
 635 }
 636
 637 /**
 638  * Check if fifo has out-of-order data
 639  *
 640  * @param f     fifo
 641  * @return      1 if fifo has ooo data, 0 otherwise
 642  */
 643 static inline u8
 644 svm_fifo_has_ooo_data (svm_fifo_t * f)
 645 {
 646   return f->ooos_list_head != OOO_SEGMENT_INVALID_INDEX;
 647 }
 648
 649 static inline ooo_segment_t *
 650 svm_fifo_newest_ooo_segment (svm_fifo_t * f)
 651 {
 652   if (f->ooos_newest == OOO_SEGMENT_INVALID_INDEX)
 653     return 0;
 654   return pool_elt_at_index (f->ooo_segments, f->ooos_newest);
 655 }
 656
 657 static inline void
 658 svm_fifo_newest_ooo_segment_reset (svm_fifo_t * f)
 659 {
 660   f->ooos_newest = OOO_SEGMENT_INVALID_INDEX;
 661 }
 662
 663 static inline u32
 664 ooo_segment_offset_prod (svm_fifo_t * f, ooo_segment_t * s)
 665 {
 666   u32 tail;
 667   /* load-relaxed: producer owned index */
 668   tail = f->tail;
 669
 670   return (s->start - tail);
 671 }
 672
 673 static inline u32
 674 ooo_segment_length (svm_fifo_t * f, ooo_segment_t * s)
 675 {
 676   return s->length;
 677 }
 678
 679 static inline u32
 680 svm_fifo_size (svm_fifo_t * f)
 681 {
 682   return f->size;
 683 }
 684
 685 static inline void
 686 svm_fifo_set_size (svm_fifo_t * f, u32 size)
 687 {
 688   if (size > (1 << f->fs_hdr->max_log2_chunk_size))
 689     return;
 690   fsh_virtual_mem_update (f->fs_hdr, f->slice_index, (int) f->size - size);
 691   f->size = size;
 692 }
 693
 694 /**
 695  * Check if fifo has io event
 696  *
 697  * @param f     fifo
 698  * @return      1 if fifo has event, 0 otherwise
 699  */
 700 static inline int
 701 svm_fifo_has_event (svm_fifo_t * f)
 702 {
 703   return f->has_event;
 704 }
 705
 706 /**
 707  * Set fifo event flag.
 708  *
 709  * Forces release semantics.
 710  *
 711  * @param f     fifo
 712  * @return      1 if flag was not set, 0 otherwise
 713  */
 714 always_inline u8
 715 svm_fifo_set_event (svm_fifo_t * f)
 716 {
 717   return !clib_atomic_swap_rel_n (&f->has_event, 1);
 718 }
 719
 720 /**
 721  * Unset fifo event flag.
 722  *
 723  * Forces acquire semantics
 724  *
 725  * @param f     fifo
 726  */
 727 always_inline void
 728 svm_fifo_unset_event (svm_fifo_t * f)
 729 {
 730   clib_atomic_swap_acq_n (&f->has_event, 0);
 731 }
 732
 733 /**
 734  * Set specific want notification flag
 735  *
 736  * For list of flags see @ref svm_fifo_deq_ntf_t
 737  *
 738  * @param f             fifo
 739  * @param ntf_type      type of notification requested
 740  */
 741 static inline void
 742 svm_fifo_add_want_deq_ntf (svm_fifo_t * f, u8 ntf_type)
 743 {
 744   f->want_deq_ntf |= ntf_type;
 745 }
 746
 747 /**
 748  * Clear specific want notification flag
 749  *
 750  * For list of flags see @ref svm_fifo_ntf_t
 751  *
 752  * @param f             fifo
 753  * @param ntf_type      type of notification to be cleared
 754  */
 755 static inline void
 756 svm_fifo_del_want_deq_ntf (svm_fifo_t * f, u8 ntf_type)
 757 {
 758   f->want_deq_ntf &= ~ntf_type;
 759 }
 760
 761 /**
 762  * Clear the want notification flag and set has notification
 763  *
 764  * Should be used after enqueuing an event. This clears the
 765  * SVM_FIFO_WANT_NOTIF flag but it does not clear
 766  * SVM_FIFO_WANT_NOTIF_IF_FULL. If the latter was set, has_ntf is
 767  * set to avoid enqueueing events for for all dequeue operations until
 768  * it is manually cleared.
 769  *
 770  * @param f     fifo
 771  */
 772 static inline void
 773 svm_fifo_clear_deq_ntf (svm_fifo_t * f)
 774 {
 775   /* Set the flag if want_notif_if_full was the only ntf requested */
 776   f->has_deq_ntf = f->want_deq_ntf == SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL;
 777   svm_fifo_del_want_deq_ntf (f, SVM_FIFO_WANT_DEQ_NOTIF);
 778 }
 779
 780 /**
 781  * Clear has notification flag
 782  *
 783  * The fifo generates only one event per SVM_FIFO_WANT_NOTIF_IF_FULL
 784  * request and sets has_ntf. To received new events the flag must be
 785  * cleared using this function.
 786  *
 787  * @param f     fifo
 788  */
 789 static inline void
 790 svm_fifo_reset_has_deq_ntf (svm_fifo_t * f)
 791 {
 792   f->has_deq_ntf = 0;
 793 }
 794
 795 /**
 796  * Check if fifo needs dequeue notification
 797  *
 798  * Determines based on notification request flags and state of the fifo if
 799  * an event should be generated.
 800  *
 801  * @param f             fifo
 802  * @param n_last_deq    number of bytes last dequeued
 803  * @return              1 if event should be generated, 0 otherwise
 804  */
 805 static inline u8
 806 svm_fifo_needs_deq_ntf (svm_fifo_t * f, u32 n_last_deq)
 807 {
 808   u8 want_ntf = f->want_deq_ntf;
 809
 810   if (PREDICT_TRUE (want_ntf == SVM_FIFO_NO_DEQ_NOTIF))
 811     return 0;
 812   else if (want_ntf & SVM_FIFO_WANT_DEQ_NOTIF)
 813     return 1;
 814   if (want_ntf & SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL)
 815     {
 816       u32 max_deq = svm_fifo_max_dequeue_cons (f);
 817       u32 size = f->size;
 818       if (!f->has_deq_ntf && max_deq < size && max_deq + n_last_deq >= size)
 819         return 1;
 820     }
 821   if (want_ntf & SVM_FIFO_WANT_DEQ_NOTIF_IF_EMPTY)
 822     {
 823       if (!f->has_deq_ntf && svm_fifo_is_empty (f))
 824         return 1;
 825     }
 826   return 0;
 827 }
 828
 829 #endif /* __included_ssvm_fifo_h__ */
 830
 831 /*
 832  * fd.io coding-style-patch-verification: ON
 833  *
 834  * Local Variables:
 835  * eval: (c-set-style "gnu")
 836  * End:
 837  */