folly/MPMCQueue.h

   1 /*
   2  * Copyright 2016 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #pragma once
  18
  19 #include <algorithm>
  20 #include <atomic>
  21 #include <assert.h>
  22 #include <boost/noncopyable.hpp>
  23 #include <limits>
  24 #include <string.h>
  25 #include <type_traits>
  26
  27 #include <folly/Traits.h>
  28 #include <folly/detail/CacheLocality.h>
  29 #include <folly/detail/TurnSequencer.h>
  30 #include <folly/portability/Unistd.h>
  31
  32 namespace folly {
  33
  34 namespace detail {
  35
  36 template<typename T, template<typename> class Atom>
  37 struct SingleElementQueue;
  38
  39 template <typename T> class MPMCPipelineStageImpl;
  40
  41 /// MPMCQueue base CRTP template
  42 template <typename> class MPMCQueueBase;
  43
  44 } // namespace detail
  45
  46 /// MPMCQueue<T> is a high-performance bounded concurrent queue that
  47 /// supports multiple producers, multiple consumers, and optional blocking.
  48 /// The queue has a fixed capacity, for which all memory will be allocated
  49 /// up front.  The bulk of the work of enqueuing and dequeuing can be
  50 /// performed in parallel.
  51 ///
  52 /// MPMCQueue is linearizable.  That means that if a call to write(A)
  53 /// returns before a call to write(B) begins, then A will definitely end up
  54 /// in the queue before B, and if a call to read(X) returns before a call
  55 /// to read(Y) is started, that X will be something from earlier in the
  56 /// queue than Y.  This also means that if a read call returns a value, you
  57 /// can be sure that all previous elements of the queue have been assigned
  58 /// a reader (that reader might not yet have returned, but it exists).
  59 ///
  60 /// The underlying implementation uses a ticket dispenser for the head and
  61 /// the tail, spreading accesses across N single-element queues to produce
  62 /// a queue with capacity N.  The ticket dispensers use atomic increment,
  63 /// which is more robust to contention than a CAS loop.  Each of the
  64 /// single-element queues uses its own CAS to serialize access, with an
  65 /// adaptive spin cutoff.  When spinning fails on a single-element queue
  66 /// it uses futex()'s _BITSET operations to reduce unnecessary wakeups
  67 /// even if multiple waiters are present on an individual queue (such as
  68 /// when the MPMCQueue's capacity is smaller than the number of enqueuers
  69 /// or dequeuers).
  70 ///
  71 /// In benchmarks (contained in tao/queues/ConcurrentQueueTests)
  72 /// it handles 1 to 1, 1 to N, N to 1, and N to M thread counts better
  73 /// than any of the alternatives present in fbcode, for both small (~10)
  74 /// and large capacities.  In these benchmarks it is also faster than
  75 /// tbb::concurrent_bounded_queue for all configurations.  When there are
  76 /// many more threads than cores, MPMCQueue is _much_ faster than the tbb
  77 /// queue because it uses futex() to block and unblock waiting threads,
  78 /// rather than spinning with sched_yield.
  79 ///
  80 /// NOEXCEPT INTERACTION: tl;dr; If it compiles you're fine.  Ticket-based
  81 /// queues separate the assignment of queue positions from the actual
  82 /// construction of the in-queue elements, which means that the T
  83 /// constructor used during enqueue must not throw an exception.  This is
  84 /// enforced at compile time using type traits, which requires that T be
  85 /// adorned with accurate noexcept information.  If your type does not
  86 /// use noexcept, you will have to wrap it in something that provides
  87 /// the guarantee.  We provide an alternate safe implementation for types
  88 /// that don't use noexcept but that are marked folly::IsRelocatable
  89 /// and boost::has_nothrow_constructor, which is common for folly types.
  90 /// In particular, if you can declare FOLLY_ASSUME_FBVECTOR_COMPATIBLE
  91 /// then your type can be put in MPMCQueue.
  92 ///
  93 /// If you have a pool of N queue consumers that you want to shut down
  94 /// after the queue has drained, one way is to enqueue N sentinel values
  95 /// to the queue.  If the producer doesn't know how many consumers there
  96 /// are you can enqueue one sentinel and then have each consumer requeue
  97 /// two sentinels after it receives it (by requeuing 2 the shutdown can
  98 /// complete in O(log P) time instead of O(P)).
  99 template<typename T, template<typename> class Atom = std::atomic,
 100          bool Dynamic = false>
 101 class MPMCQueue : public detail::MPMCQueueBase<MPMCQueue<T,Atom,Dynamic>> {
 102   friend class detail::MPMCPipelineStageImpl<T>;
 103   using Slot = detail::SingleElementQueue<T,Atom>;
 104  public:
 105
 106   explicit MPMCQueue(size_t queueCapacity)
 107     : detail::MPMCQueueBase<MPMCQueue<T,Atom,Dynamic>>(queueCapacity)
 108   {
 109     this->stride_ = this->computeStride(queueCapacity);
 110     this->slots_ = new Slot[queueCapacity + 2 * this->kSlotPadding];
 111   }
 112
 113   MPMCQueue() noexcept { }
 114 };
 115
 116 /// The dynamic version of MPMCQueue allows dynamic expansion of queue
 117 /// capacity, such that a queue may start with a smaller capacity than
 118 /// specified and expand only if needed. Users may optionally specify
 119 /// the initial capacity and the expansion multiplier.
 120 ///
 121 /// The design uses a seqlock to enforce mutual exclusion among
 122 /// expansion attempts. Regular operations read up-to-date queue
 123 /// information (slots array, capacity, stride) inside read-only
 124 /// seqlock sections, which are unimpeded when no expansion is in
 125 /// progress.
 126 ///
 127 /// An expansion computes a new capacity, allocates a new slots array,
 128 /// and updates stride. No information needs to be copied from the
 129 /// current slots array to the new one. When this happens, new slots
 130 /// will not have sequence numbers that match ticket numbers. The
 131 /// expansion needs to compute a ticket offset such that operations
 132 /// that use new arrays can adjust the calculations of slot indexes
 133 /// and sequence numbers that take into account that the new slots
 134 /// start with sequence numbers of zero. The current ticket offset is
 135 /// packed with the seqlock in an atomic 64-bit integer. The initial
 136 /// offset is zero.
 137 ///
 138 /// Lagging write and read operations with tickets lower than the
 139 /// ticket offset of the current slots array (i.e., the minimum ticket
 140 /// number that can be served by the current array) must use earlier
 141 /// closed arrays instead of the current one. Information about closed
 142 /// slots arrays (array address, capacity, stride, and offset) is
 143 /// maintained in a logarithmic-sized structure. Each entry in that
 144 /// structure never need to be changed once set. The number of closed
 145 /// arrays is half the value of the seqlock (when unlocked).
 146 ///
 147 /// The acquisition of the seqlock to perform an expansion does not
 148 /// prevent the issuing of new push and pop tickets concurrently. The
 149 /// expansion must set the new ticket offset to a value that couldn't
 150 /// have been issued to an operation that has already gone through a
 151 /// seqlock read-only section (and hence obtained information for
 152 /// older closed arrays).
 153 ///
 154 /// Note that the total queue capacity can temporarily exceed the
 155 /// specified capacity when there are lagging consumers that haven't
 156 /// yet consumed all the elements in closed arrays. Users should not
 157 /// rely on the capacity of dynamic queues for synchronization, e.g.,
 158 /// they should not expect that a thread will definitely block on a
 159 /// call to blockingWrite() when the queue size is known to be equal
 160 /// to its capacity.
 161 ///
 162 /// The dynamic version is a partial specialization of MPMCQueue with
 163 /// Dynamic == true
 164 template <typename T, template<typename> class Atom>
 165 class MPMCQueue<T,Atom,true> :
 166       public detail::MPMCQueueBase<MPMCQueue<T,Atom,true>> {
 167   friend class detail::MPMCQueueBase<MPMCQueue<T,Atom,true>>;
 168   using Slot = detail::SingleElementQueue<T,Atom>;
 169
 170   struct ClosedArray {
 171     uint64_t offset_ {0};
 172     Slot* slots_ {nullptr};
 173     size_t capacity_ {0};
 174     int stride_ {0};
 175   };
 176
 177  public:
 178
 179   explicit MPMCQueue(size_t queueCapacity)
 180     : detail::MPMCQueueBase<MPMCQueue<T,Atom,true>>(queueCapacity)
 181   {
 182     size_t cap = std::min<size_t>(kDefaultMinDynamicCapacity, queueCapacity);
 183     initQueue(cap, kDefaultExpansionMultiplier);
 184   }
 185
 186   explicit MPMCQueue(size_t queueCapacity,
 187                      size_t minCapacity,
 188                      size_t expansionMultiplier)
 189     : detail::MPMCQueueBase<MPMCQueue<T,Atom,true>>(queueCapacity)
 190   {
 191     minCapacity = std::max<size_t>(1, minCapacity);
 192     size_t cap = std::min<size_t>(minCapacity, queueCapacity);
 193     expansionMultiplier = std::max<size_t>(2, expansionMultiplier);
 194     initQueue(cap, expansionMultiplier);
 195   }
 196
 197   MPMCQueue() noexcept {
 198     dmult_ = 0;
 199     closed_ = nullptr;
 200   }
 201
 202   MPMCQueue(MPMCQueue<T,Atom,true>&& rhs) noexcept {
 203     this->capacity_ = rhs.capacity_;
 204     this->slots_ = rhs.slots_;
 205     this->stride_ = rhs.stride_;
 206     this->dstate_.store(rhs.dstate_.load(std::memory_order_relaxed),
 207                         std::memory_order_relaxed);
 208     this->dcapacity_.store(rhs.dcapacity_.load(std::memory_order_relaxed),
 209                            std::memory_order_relaxed);
 210     this->pushTicket_.store(rhs.pushTicket_.load(std::memory_order_relaxed),
 211                             std::memory_order_relaxed);
 212     this->popTicket_.store(rhs.popTicket_.load(std::memory_order_relaxed),
 213                            std::memory_order_relaxed);
 214     this->pushSpinCutoff_.store(
 215       rhs.pushSpinCutoff_.load(std::memory_order_relaxed),
 216       std::memory_order_relaxed);
 217     this->popSpinCutoff_.store(
 218       rhs.popSpinCutoff_.load(std::memory_order_relaxed),
 219       std::memory_order_relaxed);
 220     dmult_ = rhs.dmult_;
 221     closed_ = rhs.closed_;
 222
 223     rhs.capacity_ = 0;
 224     rhs.slots_ = nullptr;
 225     rhs.stride_ = 0;
 226     rhs.dstate_.store(0, std::memory_order_relaxed);
 227     rhs.dcapacity_.store(0, std::memory_order_relaxed);
 228     rhs.pushTicket_.store(0, std::memory_order_relaxed);
 229     rhs.popTicket_.store(0, std::memory_order_relaxed);
 230     rhs.pushSpinCutoff_.store(0, std::memory_order_relaxed);
 231     rhs.popSpinCutoff_.store(0, std::memory_order_relaxed);
 232     rhs.dmult_ = 0;
 233     rhs.closed_ = nullptr;
 234   }
 235
 236   MPMCQueue<T,Atom, true> const& operator= (MPMCQueue<T,Atom, true>&& rhs) {
 237     if (this != &rhs) {
 238       this->~MPMCQueue();
 239       new (this) MPMCQueue(std::move(rhs));
 240     }
 241     return *this;
 242   }
 243
 244   ~MPMCQueue() {
 245     if (closed_ != nullptr) {
 246       for (int i = getNumClosed(this->dstate_.load()) - 1; i >= 0; --i) {
 247         delete[] closed_[i].slots_;
 248       }
 249       delete[] closed_;
 250     }
 251   }
 252
 253   size_t allocatedCapacity() const noexcept {
 254     return this->dcapacity_.load(std::memory_order_relaxed);
 255   }
 256
 257   template <typename ...Args>
 258   void blockingWrite(Args&&... args) noexcept {
 259     uint64_t ticket = this->pushTicket_++;
 260     Slot* slots;
 261     size_t cap;
 262     int stride;
 263     uint64_t state;
 264     uint64_t offset;
 265     do {
 266       if (!trySeqlockReadSection(state, slots, cap, stride)) {
 267         continue;
 268       }
 269       offset = getOffset(state);
 270       if (ticket < offset) {
 271         // There was an expansion after this ticket was issued.
 272         updateFromClosed(state, ticket, offset, slots, cap, stride);
 273         break;
 274       }
 275       if (slots[this->idx((ticket-offset), cap, stride)]
 276           .mayEnqueue(this->turn(ticket-offset, cap))) {
 277         // A slot is ready. No need to expand.
 278         break;
 279       } else if (this->popTicket_.load(std::memory_order_relaxed) + cap
 280                  > ticket) {
 281         // May block, but a pop is in progress. No need to expand.
 282         // Get seqlock read section info again in case an expansion
 283         // occurred with an equal or higher ticket.
 284         continue;
 285       } else {
 286         // May block. See if we can expand.
 287         if (tryExpand(state, cap)) {
 288           // This or another thread started an expansion. Get updated info.
 289           continue;
 290         } else {
 291           // Can't expand.
 292           break;
 293         }
 294       }
 295     } while (true);
 296     this->enqueueWithTicketBase(ticket-offset, slots, cap, stride,
 297                                 std::forward<Args>(args)...);
 298   }
 299
 300   void blockingReadWithTicket(uint64_t& ticket, T& elem) noexcept {
 301     ticket = this->popTicket_++;
 302     Slot* slots;
 303     size_t cap;
 304     int stride;
 305     uint64_t state;
 306     uint64_t offset;
 307     while (!trySeqlockReadSection(state, slots, cap, stride));
 308     offset = getOffset(state);
 309     if (ticket < offset) {
 310       // There was an expansion after the corresponding push ticket
 311       // was issued.
 312       updateFromClosed(state, ticket, offset, slots, cap, stride);
 313     }
 314     this->dequeueWithTicketBase(ticket-offset, slots, cap, stride, elem);
 315   }
 316
 317  private:
 318
 319   enum {
 320     kSeqlockBits = 6,
 321     kDefaultMinDynamicCapacity = 10,
 322     kDefaultExpansionMultiplier = 10,
 323   };
 324
 325   size_t dmult_;
 326
 327   //  Info about closed slots arrays for use by lagging operations
 328   ClosedArray* closed_;
 329
 330   void initQueue(const size_t cap, const size_t mult) {
 331     this->stride_ = this->computeStride(cap);
 332     this->slots_ = new Slot[cap + 2 * this->kSlotPadding];
 333     this->dstate_.store(0);
 334     this->dcapacity_.store(cap);
 335     dmult_ = mult;
 336     size_t maxClosed = 0;
 337     for (size_t expanded = cap;
 338          expanded < this->capacity_;
 339          expanded *= mult) {
 340       ++maxClosed;
 341     }
 342     closed_ = (maxClosed > 0) ? new ClosedArray[maxClosed] : nullptr;
 343   }
 344
 345   bool tryObtainReadyPushTicket(
 346       uint64_t& ticket, Slot*& slots, size_t& cap, int& stride
 347   ) noexcept {
 348     uint64_t state;
 349     do {
 350       ticket = this->pushTicket_.load(std::memory_order_acquire); // A
 351       if (!trySeqlockReadSection(state, slots, cap, stride)) {
 352         continue;
 353       }
 354       uint64_t offset = getOffset(state);
 355       if (ticket < offset) {
 356         // There was an expansion with offset greater than this ticket
 357         updateFromClosed(state, ticket, offset, slots, cap, stride);
 358       }
 359       if (slots[this->idx((ticket-offset), cap, stride)]
 360           .mayEnqueue(this->turn(ticket-offset, cap))) {
 361         // A slot is ready.
 362         if (this->pushTicket_.compare_exchange_strong(ticket, ticket + 1)) {
 363           // Adjust ticket
 364           ticket -= offset;
 365           return true;
 366         } else {
 367           continue;
 368         }
 369       } else {
 370         if (ticket != this->pushTicket_.load(std::memory_order_relaxed)) { // B
 371           // Try again. Ticket changed.
 372           continue;
 373         }
 374         // Likely to block.
 375         // Try to expand unless the ticket is for a closed array
 376         if (offset == getOffset(state)) {
 377           if (tryExpand(state, cap)) {
 378             // This or another thread started an expansion. Get up-to-date info.
 379             continue;
 380           }
 381         }
 382         return false;
 383       }
 384     } while (true);
 385   }
 386
 387   bool tryObtainPromisedPushTicket(
 388     uint64_t& ticket, Slot*& slots, size_t& cap, int& stride
 389   ) noexcept {
 390     uint64_t state;
 391     do {
 392       ticket = this->pushTicket_.load(std::memory_order_acquire);
 393       auto numPops = this->popTicket_.load(std::memory_order_acquire);
 394       if (!trySeqlockReadSection(state, slots, cap, stride)) {
 395         continue;
 396       }
 397       int64_t n = ticket - numPops;
 398       if (n >= static_cast<ssize_t>(this->capacity_)) {
 399         return false;
 400       }
 401       if ((n >= static_cast<ssize_t>(cap))) {
 402         if (tryExpand(state, cap)) {
 403           // This or another thread started an expansion. Start over
 404           // with a new state.
 405           continue;
 406         } else {
 407           // Can't expand.
 408           return false;
 409         }
 410       }
 411       uint64_t offset = getOffset(state);
 412       if (ticket < offset) {
 413         // There was an expansion with offset greater than this ticket
 414         updateFromClosed(state, ticket, offset, slots, cap, stride);
 415       }
 416       if (this->pushTicket_.compare_exchange_strong(ticket, ticket + 1)) {
 417         // Adjust ticket
 418         ticket -= offset;
 419         return true;
 420       }
 421     } while (true);
 422   }
 423
 424   bool tryObtainReadyPopTicket(
 425     uint64_t& ticket, Slot*& slots, size_t& cap, int& stride
 426   ) noexcept {
 427     uint64_t state;
 428     do {
 429       ticket = this->popTicket_.load(std::memory_order_relaxed);
 430       if (!trySeqlockReadSection(state, slots, cap, stride)) {
 431         continue;
 432       }
 433       uint64_t offset = getOffset(state);
 434       if (ticket < offset) {
 435         // There was an expansion after the corresponding push ticket
 436         // was issued.
 437         updateFromClosed(state, ticket, offset, slots, cap, stride);
 438       }
 439       if (slots[this->idx((ticket-offset), cap, stride)]
 440           .mayDequeue(this->turn(ticket-offset, cap))) {
 441         if (this->popTicket_.compare_exchange_strong(ticket, ticket + 1)) {
 442           // Adjust ticket
 443           ticket -= offset;
 444           return true;
 445         }
 446       } else {
 447         return false;
 448       }
 449     } while (true);
 450   }
 451
 452   bool tryObtainPromisedPopTicket(
 453     uint64_t& ticket, Slot*& slots, size_t& cap, int& stride
 454   ) noexcept {
 455     uint64_t state;
 456     do {
 457       ticket = this->popTicket_.load(std::memory_order_acquire);
 458       auto numPushes = this->pushTicket_.load(std::memory_order_acquire);
 459       if (!trySeqlockReadSection(state, slots, cap, stride)) {
 460         continue;
 461       }
 462       if (ticket >= numPushes) {
 463         return false;
 464       }
 465       if (this->popTicket_.compare_exchange_strong(ticket, ticket + 1)) {
 466         // Adjust ticket
 467         uint64_t offset = getOffset(state);
 468         if (ticket < offset) {
 469           // There was an expansion after the corresponding push
 470           // ticket was issued.
 471           updateFromClosed(state, ticket, offset, slots, cap, stride);
 472         }
 473         // Adjust ticket
 474         ticket -= offset;
 475         return true;
 476       }
 477     } while (true);
 478   }
 479
 480   /// Enqueues an element with a specific ticket number
 481   template <typename ...Args>
 482   void enqueueWithTicket(const uint64_t ticket, Args&&... args) noexcept {
 483     Slot* slots;
 484     size_t cap;
 485     int stride;
 486     uint64_t state;
 487     uint64_t offset;
 488     while (!trySeqlockReadSection(state, slots, cap, stride)) {}
 489     offset = getOffset(state);
 490     if (ticket < offset) {
 491       // There was an expansion after this ticket was issued.
 492       updateFromClosed(state, ticket, offset, slots, cap, stride);
 493     }
 494     this->enqueueWithTicketBase(ticket-offset, slots, cap, stride,
 495                                 std::forward<Args>(args)...);
 496   }
 497
 498   uint64_t getOffset(const uint64_t state) const noexcept {
 499     return state >> kSeqlockBits;
 500   }
 501
 502   int getNumClosed(const uint64_t state) const noexcept {
 503     return (state & ((1 << kSeqlockBits) - 1)) >> 1;
 504   }
 505
 506   /// Try to expand the queue. Returns true if this expansion was
 507   /// successful or a concurent expansion is in progress. Returns
 508   /// false if the queue has reached its maximum capacity or
 509   /// allocation has failed.
 510   bool tryExpand(const uint64_t state, const size_t cap) noexcept {
 511     if (cap == this->capacity_) {
 512       return false;
 513     }
 514     // Acquire seqlock
 515     uint64_t oldval = state;
 516     assert((state & 1) == 0);
 517     if (this->dstate_.compare_exchange_strong(oldval, state + 1)) {
 518       assert(cap == this->dcapacity_.load());
 519       uint64_t ticket = 1 + std::max(this->pushTicket_.load(),
 520                                      this->popTicket_.load());
 521       size_t newCapacity =
 522         std::min(dmult_ * cap, this->capacity_);
 523       Slot* newSlots =
 524         new (std::nothrow) Slot[newCapacity + 2 * this->kSlotPadding];
 525       if (newSlots == nullptr) {
 526         // Expansion failed. Restore the seqlock
 527         this->dstate_.store(state);
 528         return false;
 529       }
 530       // Successful expansion
 531       // calculate the current ticket offset
 532       uint64_t offset = getOffset(state);
 533       // calculate index in closed array
 534       int index = getNumClosed(state);
 535       assert((index << 1) < (1 << kSeqlockBits));
 536       // fill the info for the closed slots array
 537       closed_[index].offset_ = offset;
 538       closed_[index].slots_ = this->dslots_.load();
 539       closed_[index].capacity_ = cap;
 540       closed_[index].stride_ = this->dstride_.load();
 541       // update the new slots array info
 542       this->dslots_.store(newSlots);
 543       this->dcapacity_.store(newCapacity);
 544       this->dstride_.store(this->computeStride(newCapacity));
 545       // Release the seqlock and record the new ticket offset
 546       this->dstate_.store((ticket << kSeqlockBits) + (2 * (index + 1)));
 547       return true;
 548     } else { // failed to acquire seqlock
 549       // Someone acaquired the seqlock. Go back to the caller and get
 550       // up-to-date info.
 551       return true;
 552     }
 553   }
 554
 555   /// Seqlock read-only section
 556   bool trySeqlockReadSection(
 557     uint64_t& state, Slot*& slots, size_t& cap, int& stride
 558   ) noexcept {
 559     state = this->dstate_.load(std::memory_order_acquire);
 560     if (state & 1) {
 561       // Locked.
 562       return false;
 563     }
 564     // Start read-only section.
 565     slots = this->dslots_.load(std::memory_order_relaxed);
 566     cap = this->dcapacity_.load(std::memory_order_relaxed);
 567     stride = this->dstride_.load(std::memory_order_relaxed);
 568     // End of read-only section. Validate seqlock.
 569     std::atomic_thread_fence(std::memory_order_acquire);
 570     return (state == this->dstate_.load(std::memory_order_relaxed));
 571   }
 572
 573   /// Update local variables of a lagging operation using the
 574   /// most recent closed array with offset <= ticket
 575   void updateFromClosed(
 576     const uint64_t state, const uint64_t ticket,
 577     uint64_t& offset, Slot*& slots, size_t& cap, int& stride
 578   ) noexcept {
 579     for (int i = getNumClosed(state) - 1; i >= 0; --i) {
 580       offset = closed_[i].offset_;
 581       if (offset <= ticket) {
 582         slots = closed_[i].slots_;
 583         cap = closed_[i].capacity_;
 584         stride = closed_[i].stride_;
 585         return;;
 586       }
 587     }
 588     // A closed array with offset <= ticket should have been found
 589     assert(false);
 590   }
 591 };
 592
 593 namespace detail {
 594
 595 /// CRTP specialization of MPMCQueueBase
 596 template<
 597   template<
 598     typename T, template<typename> class Atom, bool Dynamic> class Derived,
 599   typename T, template<typename> class Atom, bool Dynamic>
 600 class MPMCQueueBase<Derived<T, Atom, Dynamic>> : boost::noncopyable {
 601
 602 // Note: Using CRTP static casts in several functions of this base
 603 // template instead of making called functions virtual or duplicating
 604 // the code of calling functions in the derived partially specialized
 605 // template
 606
 607   static_assert(std::is_nothrow_constructible<T,T&&>::value ||
 608                 folly::IsRelocatable<T>::value,
 609       "T must be relocatable or have a noexcept move constructor");
 610
 611  public:
 612   typedef T value_type;
 613
 614   using Slot = detail::SingleElementQueue<T,Atom>;
 615
 616   explicit MPMCQueueBase(size_t queueCapacity)
 617     : capacity_(queueCapacity)
 618     , pushTicket_(0)
 619     , popTicket_(0)
 620     , pushSpinCutoff_(0)
 621     , popSpinCutoff_(0)
 622   {
 623     if (queueCapacity == 0) {
 624       throw std::invalid_argument(
 625         "MPMCQueue with explicit capacity 0 is impossible"
 626         // Stride computation in derived classes would sigfpe if capacity is 0
 627       );
 628     }
 629
 630     // ideally this would be a static assert, but g++ doesn't allow it
 631     assert(alignof(MPMCQueue<T,Atom>)
 632            >= detail::CacheLocality::kFalseSharingRange);
 633     assert(static_cast<uint8_t*>(static_cast<void*>(&popTicket_))
 634            - static_cast<uint8_t*>(static_cast<void*>(&pushTicket_))
 635            >= detail::CacheLocality::kFalseSharingRange);
 636   }
 637
 638   /// A default-constructed queue is useful because a usable (non-zero
 639   /// capacity) queue can be moved onto it or swapped with it
 640   MPMCQueueBase() noexcept
 641     : capacity_(0)
 642     , slots_(nullptr)
 643     , stride_(0)
 644     , dstate_(0)
 645     , dcapacity_(0)
 646     , pushTicket_(0)
 647     , popTicket_(0)
 648     , pushSpinCutoff_(0)
 649     , popSpinCutoff_(0)
 650   {}
 651
 652   /// IMPORTANT: The move constructor is here to make it easier to perform
 653   /// the initialization phase, it is not safe to use when there are any
 654   /// concurrent accesses (this is not checked).
 655   MPMCQueueBase(MPMCQueueBase<Derived<T,Atom,Dynamic>>&& rhs) noexcept
 656     : capacity_(rhs.capacity_)
 657     , slots_(rhs.slots_)
 658     , stride_(rhs.stride_)
 659     , dstate_(rhs.dstate_.load(std::memory_order_relaxed))
 660     , dcapacity_(rhs.dcapacity_.load(std::memory_order_relaxed))
 661     , pushTicket_(rhs.pushTicket_.load(std::memory_order_relaxed))
 662     , popTicket_(rhs.popTicket_.load(std::memory_order_relaxed))
 663     , pushSpinCutoff_(rhs.pushSpinCutoff_.load(std::memory_order_relaxed))
 664     , popSpinCutoff_(rhs.popSpinCutoff_.load(std::memory_order_relaxed))
 665   {
 666     // relaxed ops are okay for the previous reads, since rhs queue can't
 667     // be in concurrent use
 668
 669     // zero out rhs
 670     rhs.capacity_ = 0;
 671     rhs.slots_ = nullptr;
 672     rhs.stride_ = 0;
 673     rhs.dstate_.store(0, std::memory_order_relaxed);
 674     rhs.dcapacity_.store(0, std::memory_order_relaxed);
 675     rhs.pushTicket_.store(0, std::memory_order_relaxed);
 676     rhs.popTicket_.store(0, std::memory_order_relaxed);
 677     rhs.pushSpinCutoff_.store(0, std::memory_order_relaxed);
 678     rhs.popSpinCutoff_.store(0, std::memory_order_relaxed);
 679   }
 680
 681   /// IMPORTANT: The move operator is here to make it easier to perform
 682   /// the initialization phase, it is not safe to use when there are any
 683   /// concurrent accesses (this is not checked).
 684   MPMCQueueBase<Derived<T,Atom,Dynamic>> const& operator=
 685     (MPMCQueueBase<Derived<T,Atom,Dynamic>>&& rhs) {
 686     if (this != &rhs) {
 687       this->~MPMCQueueBase();
 688       new (this) MPMCQueueBase(std::move(rhs));
 689     }
 690     return *this;
 691   }
 692
 693   /// MPMCQueue can only be safely destroyed when there are no
 694   /// pending enqueuers or dequeuers (this is not checked).
 695   ~MPMCQueueBase() {
 696     delete[] slots_;
 697   }
 698
 699   /// Returns the number of writes (including threads that are blocked waiting
 700   /// to write) minus the number of reads (including threads that are blocked
 701   /// waiting to read). So effectively, it becomes:
 702   /// elements in queue + pending(calls to write) - pending(calls to read).
 703   /// If nothing is pending, then the method returns the actual number of
 704   /// elements in the queue.
 705   /// The returned value can be negative if there are no writers and the queue
 706   /// is empty, but there is one reader that is blocked waiting to read (in
 707   /// which case, the returned size will be -1).
 708   ssize_t size() const noexcept {
 709     // since both pushes and pops increase monotonically, we can get a
 710     // consistent snapshot either by bracketing a read of popTicket_ with
 711     // two reads of pushTicket_ that return the same value, or the other
 712     // way around.  We maximize our chances by alternately attempting
 713     // both bracketings.
 714     uint64_t pushes = pushTicket_.load(std::memory_order_acquire); // A
 715     uint64_t pops = popTicket_.load(std::memory_order_acquire); // B
 716     while (true) {
 717       uint64_t nextPushes = pushTicket_.load(std::memory_order_acquire); // C
 718       if (pushes == nextPushes) {
 719         // pushTicket_ didn't change from A (or the previous C) to C,
 720         // so we can linearize at B (or D)
 721         return pushes - pops;
 722       }
 723       pushes = nextPushes;
 724       uint64_t nextPops = popTicket_.load(std::memory_order_acquire); // D
 725       if (pops == nextPops) {
 726         // popTicket_ didn't chance from B (or the previous D), so we
 727         // can linearize at C
 728         return pushes - pops;
 729       }
 730       pops = nextPops;
 731     }
 732   }
 733
 734   /// Returns true if there are no items available for dequeue
 735   bool isEmpty() const noexcept {
 736     return size() <= 0;
 737   }
 738
 739   /// Returns true if there is currently no empty space to enqueue
 740   bool isFull() const noexcept {
 741     // careful with signed -> unsigned promotion, since size can be negative
 742     return size() >= static_cast<ssize_t>(capacity_);
 743   }
 744
 745   /// Returns is a guess at size() for contexts that don't need a precise
 746   /// value, such as stats. More specifically, it returns the number of writes
 747   /// minus the number of reads, but after reading the number of writes, more
 748   /// writers could have came before the number of reads was sampled,
 749   /// and this method doesn't protect against such case.
 750   /// The returned value can be negative.
 751   ssize_t sizeGuess() const noexcept {
 752     return writeCount() - readCount();
 753   }
 754
 755   /// Doesn't change
 756   size_t capacity() const noexcept {
 757     return capacity_;
 758   }
 759
 760   /// Doesn't change for non-dynamic
 761   size_t allocatedCapacity() const noexcept {
 762     return capacity_;
 763   }
 764
 765   /// Returns the total number of calls to blockingWrite or successful
 766   /// calls to write, including those blockingWrite calls that are
 767   /// currently blocking
 768   uint64_t writeCount() const noexcept {
 769     return pushTicket_.load(std::memory_order_acquire);
 770   }
 771
 772   /// Returns the total number of calls to blockingRead or successful
 773   /// calls to read, including those blockingRead calls that are currently
 774   /// blocking
 775   uint64_t readCount() const noexcept {
 776     return popTicket_.load(std::memory_order_acquire);
 777   }
 778
 779   /// Enqueues a T constructed from args, blocking until space is
 780   /// available.  Note that this method signature allows enqueue via
 781   /// move, if args is a T rvalue, via copy, if args is a T lvalue, or
 782   /// via emplacement if args is an initializer list that can be passed
 783   /// to a T constructor.
 784   template <typename ...Args>
 785   void blockingWrite(Args&&... args) noexcept {
 786     enqueueWithTicketBase(pushTicket_++, slots_, capacity_, stride_,
 787                           std::forward<Args>(args)...);
 788   }
 789
 790   /// If an item can be enqueued with no blocking, does so and returns
 791   /// true, otherwise returns false.  This method is similar to
 792   /// writeIfNotFull, but if you don't have a specific need for that
 793   /// method you should use this one.
 794   ///
 795   /// One of the common usages of this method is to enqueue via the
 796   /// move constructor, something like q.write(std::move(x)).  If write
 797   /// returns false because the queue is full then x has not actually been
 798   /// consumed, which looks strange.  To understand why it is actually okay
 799   /// to use x afterward, remember that std::move is just a typecast that
 800   /// provides an rvalue reference that enables use of a move constructor
 801   /// or operator.  std::move doesn't actually move anything.  It could
 802   /// more accurately be called std::rvalue_cast or std::move_permission.
 803   template <typename ...Args>
 804   bool write(Args&&... args) noexcept {
 805     uint64_t ticket;
 806     Slot* slots;
 807     size_t cap;
 808     int stride;
 809     if (static_cast<Derived<T,Atom,Dynamic>*>(this)->
 810         tryObtainReadyPushTicket(ticket, slots, cap, stride)) {
 811       // we have pre-validated that the ticket won't block
 812       enqueueWithTicketBase(ticket, slots, cap, stride,
 813                             std::forward<Args>(args)...);
 814       return true;
 815     } else {
 816       return false;
 817     }
 818   }
 819
 820   template <class Clock, typename... Args>
 821   bool tryWriteUntil(const std::chrono::time_point<Clock>& when,
 822                      Args&&... args) noexcept {
 823     uint64_t ticket;
 824     Slot* slots;
 825     size_t cap;
 826     int stride;
 827     if (tryObtainPromisedPushTicketUntil(ticket, slots, cap, stride, when)) {
 828         // we have pre-validated that the ticket won't block, or rather that
 829         // it won't block longer than it takes another thread to dequeue an
 830         // element from the slot it identifies.
 831       enqueueWithTicketBase(ticket, slots, cap, stride,
 832                             std::forward<Args>(args)...);
 833       return true;
 834     } else {
 835       return false;
 836     }
 837   }
 838
 839   /// If the queue is not full, enqueues and returns true, otherwise
 840   /// returns false.  Unlike write this method can be blocked by another
 841   /// thread, specifically a read that has linearized (been assigned
 842   /// a ticket) but not yet completed.  If you don't really need this
 843   /// function you should probably use write.
 844   ///
 845   /// MPMCQueue isn't lock-free, so just because a read operation has
 846   /// linearized (and isFull is false) doesn't mean that space has been
 847   /// made available for another write.  In this situation write will
 848   /// return false, but writeIfNotFull will wait for the dequeue to finish.
 849   /// This method is required if you are composing queues and managing
 850   /// your own wakeup, because it guarantees that after every successful
 851   /// write a readIfNotEmpty will succeed.
 852   template <typename ...Args>
 853   bool writeIfNotFull(Args&&... args) noexcept {
 854     uint64_t ticket;
 855     Slot* slots;
 856     size_t cap;
 857     int stride;
 858     if (static_cast<Derived<T,Atom,Dynamic>*>(this)->
 859         tryObtainPromisedPushTicket(ticket, slots, cap, stride)) {
 860       // some other thread is already dequeuing the slot into which we
 861       // are going to enqueue, but we might have to wait for them to finish
 862       enqueueWithTicketBase(ticket, slots, cap, stride,
 863                             std::forward<Args>(args)...);
 864       return true;
 865     } else {
 866       return false;
 867     }
 868   }
 869
 870   /// Moves a dequeued element onto elem, blocking until an element
 871   /// is available
 872   void blockingRead(T& elem) noexcept {
 873     uint64_t ticket;
 874     static_cast<Derived<T,Atom,Dynamic>*>(this)->
 875       blockingReadWithTicket(ticket, elem);
 876   }
 877
 878   /// Same as blockingRead() but also records the ticket nunmer
 879   void blockingReadWithTicket(uint64_t& ticket, T& elem) noexcept {
 880     ticket = popTicket_++;
 881     dequeueWithTicketBase(ticket, slots_, capacity_, stride_, elem);
 882   }
 883
 884   /// If an item can be dequeued with no blocking, does so and returns
 885   /// true, otherwise returns false.
 886   bool read(T& elem) noexcept {
 887     uint64_t ticket;
 888     return readAndGetTicket(ticket, elem);
 889   }
 890
 891   /// Same as read() but also records the ticket nunmer
 892   bool readAndGetTicket(uint64_t& ticket, T& elem) noexcept {
 893     Slot* slots;
 894     size_t cap;
 895     int stride;
 896     if (static_cast<Derived<T,Atom,Dynamic>*>(this)->
 897         tryObtainReadyPopTicket(ticket, slots, cap, stride)) {
 898       // the ticket has been pre-validated to not block
 899       dequeueWithTicketBase(ticket, slots, cap, stride, elem);
 900       return true;
 901     } else {
 902       return false;
 903     }
 904   }
 905
 906   /// If the queue is not empty, dequeues and returns true, otherwise
 907   /// returns false.  If the matching write is still in progress then this
 908   /// method may block waiting for it.  If you don't rely on being able
 909   /// to dequeue (such as by counting completed write) then you should
 910   /// prefer read.
 911   bool readIfNotEmpty(T& elem) noexcept {
 912     uint64_t ticket;
 913     Slot* slots;
 914     size_t cap;
 915     int stride;
 916     if (static_cast<Derived<T,Atom,Dynamic>*>(this)->
 917         tryObtainPromisedPopTicket(ticket, slots, cap, stride)) {
 918       // the matching enqueue already has a ticket, but might not be done
 919       dequeueWithTicketBase(ticket, slots, cap, stride, elem);
 920       return true;
 921     } else {
 922       return false;
 923     }
 924   }
 925
 926  protected:
 927   enum {
 928     /// Once every kAdaptationFreq we will spin longer, to try to estimate
 929     /// the proper spin backoff
 930     kAdaptationFreq = 128,
 931
 932     /// To avoid false sharing in slots_ with neighboring memory
 933     /// allocations, we pad it with this many SingleElementQueue-s at
 934     /// each end
 935     kSlotPadding = (detail::CacheLocality::kFalseSharingRange - 1)
 936         / sizeof(Slot) + 1
 937   };
 938
 939   /// The maximum number of items in the queue at once
 940   size_t FOLLY_ALIGN_TO_AVOID_FALSE_SHARING capacity_;
 941
 942   /// Anonymous union for use when Dynamic = false and true, respectively
 943   union {
 944     /// An array of capacity_ SingleElementQueue-s, each of which holds
 945     /// either 0 or 1 item.  We over-allocate by 2 * kSlotPadding and don't
 946     /// touch the slots at either end, to avoid false sharing
 947     Slot* slots_;
 948     /// Current dynamic slots array of dcapacity_ SingleElementQueue-s
 949     Atom<Slot*> dslots_;
 950   };
 951
 952   /// Anonymous union for use when Dynamic = false and true, respectively
 953   union {
 954     /// The number of slots_ indices that we advance for each ticket, to
 955     /// avoid false sharing.  Ideally slots_[i] and slots_[i + stride_]
 956     /// aren't on the same cache line
 957     int stride_;
 958     /// Current stride
 959     Atom<int> dstride_;
 960   };
 961
 962   /// The following two memebers are used by dynamic MPMCQueue.
 963   /// Ideally they should be in MPMCQueue<T,Atom,true>, but we get
 964   /// better cache locality if they are in the same cache line as
 965   /// dslots_ and dstride_.
 966   ///
 967   /// Dynamic state. A packed seqlock and ticket offset
 968   Atom<uint64_t> dstate_;
 969   /// Dynamic capacity
 970   Atom<size_t> dcapacity_;
 971
 972   /// Enqueuers get tickets from here
 973   Atom<uint64_t> FOLLY_ALIGN_TO_AVOID_FALSE_SHARING pushTicket_;
 974
 975   /// Dequeuers get tickets from here
 976   Atom<uint64_t> FOLLY_ALIGN_TO_AVOID_FALSE_SHARING popTicket_;
 977
 978   /// This is how many times we will spin before using FUTEX_WAIT when
 979   /// the queue is full on enqueue, adaptively computed by occasionally
 980   /// spinning for longer and smoothing with an exponential moving average
 981   Atom<uint32_t> FOLLY_ALIGN_TO_AVOID_FALSE_SHARING pushSpinCutoff_;
 982
 983   /// The adaptive spin cutoff when the queue is empty on dequeue
 984   Atom<uint32_t> FOLLY_ALIGN_TO_AVOID_FALSE_SHARING popSpinCutoff_;
 985
 986   /// Alignment doesn't prevent false sharing at the end of the struct,
 987   /// so fill out the last cache line
 988   char padding_[detail::CacheLocality::kFalseSharingRange -
 989                 sizeof(Atom<uint32_t>)];
 990
 991   /// We assign tickets in increasing order, but we don't want to
 992   /// access neighboring elements of slots_ because that will lead to
 993   /// false sharing (multiple cores accessing the same cache line even
 994   /// though they aren't accessing the same bytes in that cache line).
 995   /// To avoid this we advance by stride slots per ticket.
 996   ///
 997   /// We need gcd(capacity, stride) to be 1 so that we will use all
 998   /// of the slots.  We ensure this by only considering prime strides,
 999   /// which either have no common divisors with capacity or else have
1000   /// a zero remainder after dividing by capacity.  That is sufficient
1001   /// to guarantee correctness, but we also want to actually spread the
1002   /// accesses away from each other to avoid false sharing (consider a
1003   /// stride of 7 with a capacity of 8).  To that end we try a few taking
1004   /// care to observe that advancing by -1 is as bad as advancing by 1
1005   /// when in comes to false sharing.
1006   ///
1007   /// The simple way to avoid false sharing would be to pad each
1008   /// SingleElementQueue, but since we have capacity_ of them that could
1009   /// waste a lot of space.
1010   static int computeStride(size_t capacity) noexcept {
1011     static const int smallPrimes[] = { 2, 3, 5, 7, 11, 13, 17, 19, 23 };
1012
1013     int bestStride = 1;
1014     size_t bestSep = 1;
1015     for (int stride : smallPrimes) {
1016       if ((stride % capacity) == 0 || (capacity % stride) == 0) {
1017         continue;
1018       }
1019       size_t sep = stride % capacity;
1020       sep = std::min(sep, capacity - sep);
1021       if (sep > bestSep) {
1022         bestStride = stride;
1023         bestSep = sep;
1024       }
1025     }
1026     return bestStride;
1027   }
1028
1029   /// Returns the index into slots_ that should be used when enqueuing or
1030   /// dequeuing with the specified ticket
1031   size_t idx(uint64_t ticket, size_t cap, int stride) noexcept {
1032     return ((ticket * stride) % cap) + kSlotPadding;
1033   }
1034
1035   /// Maps an enqueue or dequeue ticket to the turn should be used at the
1036   /// corresponding SingleElementQueue
1037   uint32_t turn(uint64_t ticket, size_t cap) noexcept {
1038     return ticket / cap;
1039   }
1040
1041   /// Tries to obtain a push ticket for which SingleElementQueue::enqueue
1042   /// won't block.  Returns true on immediate success, false on immediate
1043   /// failure.
1044   bool tryObtainReadyPushTicket(
1045     uint64_t& ticket, Slot*& slots, size_t& cap, int& stride
1046   ) noexcept {
1047     ticket = pushTicket_.load(std::memory_order_acquire); // A
1048     slots = slots_;
1049     cap = capacity_;
1050     stride = stride_;
1051     while (true) {
1052       if (!slots[idx(ticket, cap, stride)]
1053           .mayEnqueue(turn(ticket, cap))) {
1054         // if we call enqueue(ticket, ...) on the SingleElementQueue
1055         // right now it would block, but this might no longer be the next
1056         // ticket.  We can increase the chance of tryEnqueue success under
1057         // contention (without blocking) by rechecking the ticket dispenser
1058         auto prev = ticket;
1059         ticket = pushTicket_.load(std::memory_order_acquire); // B
1060         if (prev == ticket) {
1061           // mayEnqueue was bracketed by two reads (A or prev B or prev
1062           // failing CAS to B), so we are definitely unable to enqueue
1063           return false;
1064         }
1065       } else {
1066         // we will bracket the mayEnqueue check with a read (A or prev B
1067         // or prev failing CAS) and the following CAS.  If the CAS fails
1068         // it will effect a load of pushTicket_
1069         if (pushTicket_.compare_exchange_strong(ticket, ticket + 1)) {
1070           return true;
1071         }
1072       }
1073     }
1074   }
1075
1076   /// Tries until when to obtain a push ticket for which
1077   /// SingleElementQueue::enqueue  won't block.  Returns true on success, false
1078   /// on failure.
1079   /// ticket is filled on success AND failure.
1080   template <class Clock>
1081   bool tryObtainPromisedPushTicketUntil(
1082     uint64_t& ticket, Slot*& slots, size_t& cap, int& stride,
1083     const std::chrono::time_point<Clock>& when
1084   ) noexcept {
1085     bool deadlineReached = false;
1086     while (!deadlineReached) {
1087       if (static_cast<Derived<T,Atom,Dynamic>*>(this)->
1088           tryObtainPromisedPushTicket(ticket, slots, cap, stride)) {
1089         return true;
1090       }
1091       // ticket is a blocking ticket until the preceding ticket has been
1092       // processed: wait until this ticket's turn arrives. We have not reserved
1093       // this ticket so we will have to re-attempt to get a non-blocking ticket
1094       // if we wake up before we time-out.
1095       deadlineReached = !slots[idx(ticket, cap, stride)]
1096         .tryWaitForEnqueueTurnUntil(turn(ticket, cap), pushSpinCutoff_,
1097                                     (ticket % kAdaptationFreq) == 0, when);
1098     }
1099     return false;
1100   }
1101
1102   /// Tries to obtain a push ticket which can be satisfied if all
1103   /// in-progress pops complete.  This function does not block, but
1104   /// blocking may be required when using the returned ticket if some
1105   /// other thread's pop is still in progress (ticket has been granted but
1106   /// pop has not yet completed).
1107   bool tryObtainPromisedPushTicket(
1108     uint64_t& ticket, Slot*& slots, size_t& cap, int& stride
1109   ) noexcept {
1110     auto numPushes = pushTicket_.load(std::memory_order_acquire); // A
1111     slots = slots_;
1112     cap = capacity_;
1113     stride = stride_;
1114     while (true) {
1115       auto numPops = popTicket_.load(std::memory_order_acquire); // B
1116       // n will be negative if pops are pending
1117       int64_t n = numPushes - numPops;
1118       ticket = numPushes;
1119       if (n >= static_cast<ssize_t>(capacity_)) {
1120         // Full, linearize at B.  We don't need to recheck the read we
1121         // performed at A, because if numPushes was stale at B then the
1122         // real numPushes value is even worse
1123         return false;
1124       }
1125       if (pushTicket_.compare_exchange_strong(numPushes, numPushes + 1)) {
1126         return true;
1127       }
1128     }
1129   }
1130
1131   /// Tries to obtain a pop ticket for which SingleElementQueue::dequeue
1132   /// won't block.  Returns true on immediate success, false on immediate
1133   /// failure.
1134   bool tryObtainReadyPopTicket(
1135     uint64_t& ticket, Slot*& slots, size_t& cap, int& stride
1136   ) noexcept {
1137     ticket = popTicket_.load(std::memory_order_acquire);
1138     slots = slots_;
1139     cap = capacity_;
1140     stride = stride_;
1141     while (true) {
1142       if (!slots[idx(ticket, cap, stride)]
1143           .mayDequeue(turn(ticket, cap))) {
1144         auto prev = ticket;
1145         ticket = popTicket_.load(std::memory_order_acquire);
1146         if (prev == ticket) {
1147           return false;
1148         }
1149       } else {
1150         if (popTicket_.compare_exchange_strong(ticket, ticket + 1)) {
1151           return true;
1152         }
1153       }
1154     }
1155   }
1156
1157   /// Similar to tryObtainReadyPopTicket, but returns a pop ticket whose
1158   /// corresponding push ticket has already been handed out, rather than
1159   /// returning one whose corresponding push ticket has already been
1160   /// completed.  This means that there is a possibility that the caller
1161   /// will block when using the ticket, but it allows the user to rely on
1162   /// the fact that if enqueue has succeeded, tryObtainPromisedPopTicket
1163   /// will return true.  The "try" part of this is that we won't have
1164   /// to block waiting for someone to call enqueue, although we might
1165   /// have to block waiting for them to finish executing code inside the
1166   /// MPMCQueue itself.
1167   bool tryObtainPromisedPopTicket(
1168     uint64_t& ticket, Slot*& slots, size_t& cap, int& stride
1169   ) noexcept {
1170     auto numPops = popTicket_.load(std::memory_order_acquire); // A
1171     while (true) {
1172       auto numPushes = pushTicket_.load(std::memory_order_acquire); // B
1173       if (numPops >= numPushes) {
1174         // Empty, or empty with pending pops.  Linearize at B.  We don't
1175         // need to recheck the read we performed at A, because if numPops
1176         // is stale then the fresh value is larger and the >= is still true
1177         return false;
1178       }
1179       if (popTicket_.compare_exchange_strong(numPops, numPops + 1)) {
1180         ticket = numPops;
1181         slots = slots_;
1182         cap = capacity_;
1183         stride = stride_;
1184         return true;
1185       }
1186     }
1187   }
1188
1189   // Given a ticket, constructs an enqueued item using args
1190   template <typename ...Args>
1191   void enqueueWithTicketBase(
1192     uint64_t ticket, Slot* slots, size_t cap, int stride, Args&&... args
1193   ) noexcept {
1194     slots[idx(ticket, cap, stride)]
1195       .enqueue(turn(ticket, cap),
1196                pushSpinCutoff_,
1197                (ticket % kAdaptationFreq) == 0,
1198                std::forward<Args>(args)...);
1199   }
1200
1201   // To support tracking ticket numbers in MPMCPipelineStageImpl
1202   template <typename ...Args>
1203   void enqueueWithTicket(uint64_t ticket, Args&&... args) noexcept {
1204     enqueueWithTicketBase(ticket, slots_, capacity_, stride_,
1205                           std::forward<Args>(args)...);
1206   }
1207
1208   // Given a ticket, dequeues the corresponding element
1209   void dequeueWithTicketBase(
1210     uint64_t ticket, Slot* slots, size_t cap, int stride, T& elem
1211   ) noexcept {
1212     slots[idx(ticket, cap, stride)]
1213       .dequeue(turn(ticket, cap),
1214                popSpinCutoff_,
1215                (ticket % kAdaptationFreq) == 0,
1216                elem);
1217   }
1218 };
1219
1220 /// SingleElementQueue implements a blocking queue that holds at most one
1221 /// item, and that requires its users to assign incrementing identifiers
1222 /// (turns) to each enqueue and dequeue operation.  Note that the turns
1223 /// used by SingleElementQueue are doubled inside the TurnSequencer
1224 template <typename T, template <typename> class Atom>
1225 struct SingleElementQueue {
1226
1227   ~SingleElementQueue() noexcept {
1228     if ((sequencer_.uncompletedTurnLSB() & 1) == 1) {
1229       // we are pending a dequeue, so we have a constructed item
1230       destroyContents();
1231     }
1232   }
1233
1234   /// enqueue using in-place noexcept construction
1235   template <typename ...Args,
1236             typename = typename std::enable_if<
1237               std::is_nothrow_constructible<T,Args...>::value>::type>
1238   void enqueue(const uint32_t turn,
1239                Atom<uint32_t>& spinCutoff,
1240                const bool updateSpinCutoff,
1241                Args&&... args) noexcept {
1242     sequencer_.waitForTurn(turn * 2, spinCutoff, updateSpinCutoff);
1243     new (&contents_) T(std::forward<Args>(args)...);
1244     sequencer_.completeTurn(turn * 2);
1245   }
1246
1247   /// enqueue using move construction, either real (if
1248   /// is_nothrow_move_constructible) or simulated using relocation and
1249   /// default construction (if IsRelocatable and has_nothrow_constructor)
1250   template <typename = typename std::enable_if<
1251                 (folly::IsRelocatable<T>::value &&
1252                  boost::has_nothrow_constructor<T>::value) ||
1253                 std::is_nothrow_constructible<T, T&&>::value>::type>
1254   void enqueue(const uint32_t turn,
1255                Atom<uint32_t>& spinCutoff,
1256                const bool updateSpinCutoff,
1257                T&& goner) noexcept {
1258     enqueueImpl(
1259         turn,
1260         spinCutoff,
1261         updateSpinCutoff,
1262         std::move(goner),
1263         typename std::conditional<std::is_nothrow_constructible<T,T&&>::value,
1264                                   ImplByMove, ImplByRelocation>::type());
1265   }
1266
1267   /// Waits until either:
1268   /// 1: the dequeue turn preceding the given enqueue turn has arrived
1269   /// 2: the given deadline has arrived
1270   /// Case 1 returns true, case 2 returns false.
1271   template <class Clock>
1272   bool tryWaitForEnqueueTurnUntil(
1273       const uint32_t turn,
1274       Atom<uint32_t>& spinCutoff,
1275       const bool updateSpinCutoff,
1276       const std::chrono::time_point<Clock>& when) noexcept {
1277     return sequencer_.tryWaitForTurn(
1278         turn * 2, spinCutoff, updateSpinCutoff, &when);
1279   }
1280
1281   bool mayEnqueue(const uint32_t turn) const noexcept {
1282     return sequencer_.isTurn(turn * 2);
1283   }
1284
1285   void dequeue(uint32_t turn,
1286                Atom<uint32_t>& spinCutoff,
1287                const bool updateSpinCutoff,
1288                T& elem) noexcept {
1289     dequeueImpl(turn,
1290                 spinCutoff,
1291                 updateSpinCutoff,
1292                 elem,
1293                 typename std::conditional<folly::IsRelocatable<T>::value,
1294                                           ImplByRelocation,
1295                                           ImplByMove>::type());
1296   }
1297
1298   bool mayDequeue(const uint32_t turn) const noexcept {
1299     return sequencer_.isTurn(turn * 2 + 1);
1300   }
1301
1302  private:
1303   /// Storage for a T constructed with placement new
1304   typename std::aligned_storage<sizeof(T),alignof(T)>::type contents_;
1305
1306   /// Even turns are pushes, odd turns are pops
1307   TurnSequencer<Atom> sequencer_;
1308
1309   T* ptr() noexcept {
1310     return static_cast<T*>(static_cast<void*>(&contents_));
1311   }
1312
1313   void destroyContents() noexcept {
1314     try {
1315       ptr()->~T();
1316     } catch (...) {
1317       // g++ doesn't seem to have std::is_nothrow_destructible yet
1318     }
1319 #ifndef NDEBUG
1320     memset(&contents_, 'Q', sizeof(T));
1321 #endif
1322   }
1323
1324   /// Tag classes for dispatching to enqueue/dequeue implementation.
1325   struct ImplByRelocation {};
1326   struct ImplByMove {};
1327
1328   /// enqueue using nothrow move construction.
1329   void enqueueImpl(const uint32_t turn,
1330                    Atom<uint32_t>& spinCutoff,
1331                    const bool updateSpinCutoff,
1332                    T&& goner,
1333                    ImplByMove) noexcept {
1334     sequencer_.waitForTurn(turn * 2, spinCutoff, updateSpinCutoff);
1335     new (&contents_) T(std::move(goner));
1336     sequencer_.completeTurn(turn * 2);
1337   }
1338
1339   /// enqueue by simulating nothrow move with relocation, followed by
1340   /// default construction to a noexcept relocation.
1341   void enqueueImpl(const uint32_t turn,
1342                    Atom<uint32_t>& spinCutoff,
1343                    const bool updateSpinCutoff,
1344                    T&& goner,
1345                    ImplByRelocation) noexcept {
1346     sequencer_.waitForTurn(turn * 2, spinCutoff, updateSpinCutoff);
1347     memcpy(&contents_, &goner, sizeof(T));
1348     sequencer_.completeTurn(turn * 2);
1349     new (&goner) T();
1350   }
1351
1352   /// dequeue by destructing followed by relocation.  This version is preferred,
1353   /// because as much work as possible can be done before waiting.
1354   void dequeueImpl(uint32_t turn,
1355                    Atom<uint32_t>& spinCutoff,
1356                    const bool updateSpinCutoff,
1357                    T& elem,
1358                    ImplByRelocation) noexcept {
1359     try {
1360       elem.~T();
1361     } catch (...) {
1362       // unlikely, but if we don't complete our turn the queue will die
1363     }
1364     sequencer_.waitForTurn(turn * 2 + 1, spinCutoff, updateSpinCutoff);
1365     memcpy(&elem, &contents_, sizeof(T));
1366     sequencer_.completeTurn(turn * 2 + 1);
1367   }
1368
1369   /// dequeue by nothrow move assignment.
1370   void dequeueImpl(uint32_t turn,
1371                    Atom<uint32_t>& spinCutoff,
1372                    const bool updateSpinCutoff,
1373                    T& elem,
1374                    ImplByMove) noexcept {
1375     sequencer_.waitForTurn(turn * 2 + 1, spinCutoff, updateSpinCutoff);
1376     elem = std::move(*ptr());
1377     destroyContents();
1378     sequencer_.completeTurn(turn * 2 + 1);
1379   }
1380 };
1381
1382 } // namespace detail
1383
1384 } // namespace folly