Use ContinuePromise (facebookincubator#1410)

Summary:
Use ContinuePromise instead of VeloxPromise<bool> throughout the code base for
consistency (with ContinueFuture) and readability.

Pull Request resolved: facebookincubator#1410

Reviewed By: kagamiori

Differential Revision: D35617219

Pulled By: mbasmanova

fbshipit-source-id: 5bce0aad8f7bb9f97d94bc688751c5594aa23783

velox/common/future/VeloxPromise.h

@@ -68,4 +68,7 @@ std::pair<VeloxPromise<T>, folly::SemiFuture<T>> makeVeloxPromiseContract(
   auto f = p.getSemiFuture();
   return std::make_pair(std::move(p), std::move(f));
 }
+
+using ContinuePromise = VeloxPromise<bool>;
+
 } // namespace facebook::velox

velox/exec/CrossJoinBuild.cpp

@@ -19,7 +19,7 @@
 namespace facebook::velox::exec {
 
 void CrossJoinBridge::setData(std::vector<VectorPtr> data) {
-  std::vector<VeloxPromise<bool>> promises;
+  std::vector<ContinuePromise> promises;
   {
     std::lock_guard<std::mutex> l(mutex_);
     VELOX_CHECK(!data_.has_value(), "setData may be called only once");
@@ -72,7 +72,7 @@ BlockingReason CrossJoinBuild::isBlocked(ContinueFuture* future) {
 
 void CrossJoinBuild::noMoreInput() {
   Operator::noMoreInput();
-  std::vector<VeloxPromise<bool>> promises;
+  std::vector<ContinuePromise> promises;
   std::vector<std::shared_ptr<Driver>> peers;
   // The last Driver to hit CrossJoinBuild::finish gathers the data from
   // all build Drivers and hands it over to the probe side. At this

velox/exec/Exchange.h

@@ -177,7 +177,7 @@ class ExchangeQueue {
   bool atEnd_ = false;
   std::mutex mutex_;
   std::deque<std::unique_ptr<SerializedPage>> queue_;
-  std::vector<VeloxPromise<bool>> promises_;
+  std::vector<ContinuePromise> promises_;
   // When set, all promises will be realized and the next dequeue will
   // throw an exception with this message.
   std::string error_;

velox/exec/HashBuild.cpp

@@ -23,7 +23,7 @@ namespace facebook::velox::exec {
 void HashJoinBridge::setHashTable(std::unique_ptr<BaseHashTable> table) {
   VELOX_CHECK(table, "setHashTable called with null table");
 
-  std::vector<VeloxPromise<bool>> promises;
+  std::vector<ContinuePromise> promises;
   {
     std::lock_guard<std::mutex> l(mutex_);
     VELOX_CHECK(!table_, "setHashTable may be called only once");
@@ -35,7 +35,7 @@ void HashJoinBridge::setHashTable(std::unique_ptr<BaseHashTable> table) {
 }
 
 void HashJoinBridge::setAntiJoinHasNullKeys() {
-  std::vector<VeloxPromise<bool>> promises;
+  std::vector<ContinuePromise> promises;
   {
     std::lock_guard<std::mutex> l(mutex_);
     VELOX_CHECK(
@@ -191,7 +191,7 @@ void HashBuild::noMoreInput() {
   }
 
   Operator::noMoreInput();
-  std::vector<VeloxPromise<bool>> promises;
+  std::vector<ContinuePromise> promises;
   std::vector<std::shared_ptr<Driver>> peers;
   // The last Driver to hit HashBuild::finish gathers the data from
   // all build Drivers and hands it over to the probe side. At this

velox/exec/HashProbe.cpp

@@ -576,7 +576,7 @@ void HashProbe::ensureLoadedIfNotAtEnd(ChannelIndex channel) {
 void HashProbe::noMoreInput() {
   Operator::noMoreInput();
   if (isRightJoin(joinType_) || isFullJoin(joinType_)) {
-    std::vector<VeloxPromise<bool>> promises;
+    std::vector<ContinuePromise> promises;
     std::vector<std::shared_ptr<Driver>> peers;
     // The last Driver to hit HashProbe::finish is responsible for producing
     // non-matching build-side rows for the right join.

velox/exec/JoinBridge.cpp

@@ -18,14 +18,14 @@
 namespace facebook::velox::exec {
 
 // static
-void JoinBridge::notify(std::vector<VeloxPromise<bool>> promises) {
+void JoinBridge::notify(std::vector<ContinuePromise> promises) {
   for (auto& promise : promises) {
     promise.setValue(true);
   }
 }
 
 void JoinBridge::cancel() {
-  std::vector<VeloxPromise<bool>> promises;
+  std::vector<ContinuePromise> promises;
   {
     std::lock_guard<std::mutex> l(mutex_);
     cancelled_ = true;

velox/exec/JoinBridge.h

@@ -28,10 +28,10 @@ class JoinBridge {
   void cancel();
 
  protected:
-  static void notify(std::vector<VeloxPromise<bool>> promises);
+  static void notify(std::vector<ContinuePromise> promises);
 
   std::mutex mutex_;
-  std::vector<VeloxPromise<bool>> promises_;
+  std::vector<ContinuePromise> promises_;
   bool cancelled_{false};
 };
 } // namespace facebook::velox::exec

velox/exec/LocalPartition.cpp

@@ -19,7 +19,7 @@
 
 namespace facebook::velox::exec {
 namespace {
-void notify(std::vector<VeloxPromise<bool>>& promises) {
+void notify(std::vector<ContinuePromise>& promises) {
   for (auto& promise : promises) {
     promise.setValue(true);
   }
@@ -42,7 +42,7 @@ bool LocalExchangeMemoryManager::increaseMemoryUsage(
 }
 
 void LocalExchangeMemoryManager::decreaseMemoryUsage(int64_t removed) {
-  std::vector<VeloxPromise<bool>> promises;
+  std::vector<ContinuePromise> promises;
   {
     std::lock_guard<std::mutex> l(mutex_);
     bufferedBytes_ -= removed;
@@ -64,8 +64,8 @@ void LocalExchangeQueue::addProducer() {
 }
 
 void LocalExchangeQueue::noMoreProducers() {
-  std::vector<VeloxPromise<bool>> consumerPromises;
-  std::vector<VeloxPromise<bool>> producerPromises;
+  std::vector<ContinuePromise> consumerPromises;
+  std::vector<ContinuePromise> producerPromises;
   queue_.withWLock([&](auto& queue) {
     VELOX_CHECK(!noMoreProducers_, "noMoreProducers can be called only once");
     noMoreProducers_ = true;
@@ -88,7 +88,7 @@ BlockingReason LocalExchangeQueue::enqueue(
     ContinueFuture* future) {
   auto inputBytes = input->retainedSize();
 
-  std::vector<VeloxPromise<bool>> consumerPromises;
+  std::vector<ContinuePromise> consumerPromises;
   bool isClosed = queue_.withWLock([&](auto& queue) {
     if (closed_) {
       return true;
@@ -112,8 +112,8 @@ BlockingReason LocalExchangeQueue::enqueue(
 }
 
 void LocalExchangeQueue::noMoreData() {
-  std::vector<VeloxPromise<bool>> consumerPromises;
-  std::vector<VeloxPromise<bool>> producerPromises;
+  std::vector<ContinuePromise> consumerPromises;
+  std::vector<ContinuePromise> producerPromises;
   queue_.withWLock([&](auto queue) {
     VELOX_CHECK_GT(pendingProducers_, 0);
     --pendingProducers_;
@@ -132,7 +132,7 @@ BlockingReason LocalExchangeQueue::next(
     ContinueFuture* future,
     memory::MemoryPool* pool,
     RowVectorPtr* data) {
-  std::vector<VeloxPromise<bool>> producerPromises;
+  std::vector<ContinuePromise> producerPromises;
   auto blockingReason = queue_.withWLock([&](auto& queue) {
     *data = nullptr;
     if (queue.empty()) {
@@ -192,8 +192,8 @@ bool LocalExchangeQueue::isFinished() {
 }
 
 void LocalExchangeQueue::close() {
-  std::vector<VeloxPromise<bool>> producerPromises;
-  std::vector<VeloxPromise<bool>> consumerPromises;
+  std::vector<ContinuePromise> producerPromises;
+  std::vector<ContinuePromise> consumerPromises;
   queue_.withWLock([&](auto& queue) {
     uint64_t freedBytes = 0;
     while (!queue.empty()) {

velox/exec/LocalPartition.h

@@ -37,7 +37,7 @@ class LocalExchangeMemoryManager {
   const int64_t maxBufferSize_;
   std::mutex mutex_;
   int64_t bufferedBytes_{0};
-  std::vector<VeloxPromise<bool>> promises_;
+  std::vector<ContinuePromise> promises_;
 };
 
 /// Buffers data for a single partition produced by local exchange. Allows
@@ -102,11 +102,11 @@ class LocalExchangeQueue {
   // Satisfied when data becomes available or all producers report that they
   // finished producing, e.g. queue_ is not empty or noMoreProducers_ is true
   // and pendingProducers_ is zero.
-  std::vector<VeloxPromise<bool>> consumerPromises_;
+  std::vector<ContinuePromise> consumerPromises_;
   // Satisfied when all data has been fetched and no more data will be produced,
   // e.g. queue_ is empty, noMoreProducers_ is true and pendingProducers_ is
   // zero.
-  std::vector<VeloxPromise<bool>> producerPromises_;
+  std::vector<ContinuePromise> producerPromises_;
   int pendingProducers_{0};
   bool noMoreProducers_{false};
   bool closed_{false};

velox/exec/MergeSource.cpp

@@ -104,8 +104,8 @@ class LocalMergeSource : public MergeSource {
 
     bool atEnd_{false};
     boost::circular_buffer<RowVectorPtr> data_;
-    std::vector<VeloxPromise<bool>> consumerPromises_;
-    std::vector<VeloxPromise<bool>> producerPromises_;
+    std::vector<ContinuePromise> consumerPromises_;
+    std::vector<ContinuePromise> producerPromises_;
   };
 
   folly::Synchronized<LocalMergeSourceQueue> queue_;
@@ -192,7 +192,7 @@ std::shared_ptr<MergeSource> MergeSource::createMergeExchangeSource(
 }
 
 namespace {
-void notify(std::optional<VeloxPromise<bool>>& promise) {
+void notify(std::optional<ContinuePromise>& promise) {
   if (promise) {
     promise->setValue(true);
     promise.reset();
@@ -215,7 +215,7 @@ BlockingReason MergeJoinSource::next(
       return BlockingReason::kNotBlocked;
     }
 
-    consumerPromise_ = VeloxPromise<bool>("MergeJoinSource::next");
+    consumerPromise_ = ContinuePromise("MergeJoinSource::next");
     *future = consumerPromise_->getSemiFuture();
     return BlockingReason::kWaitForExchange;
   });
@@ -242,7 +242,7 @@ BlockingReason MergeJoinSource::enqueue(
     state.data = std::move(data);
     notify(consumerPromise_);
 
-    producerPromise_ = VeloxPromise<bool>("MergeJoinSource::enqueue");
+    producerPromise_ = ContinuePromise("MergeJoinSource::enqueue");
     *future = producerPromise_->getSemiFuture();
     return BlockingReason::kWaitForConsumer;
   });

velox/exec/MergeSource.h

@@ -65,11 +65,11 @@ class MergeJoinSource {
   // Satisfied when data becomes available or the producer reports that it
   // finished producing, e.g. state_.data is not nullptr or state_.atEnd is
   // true.
-  std::optional<VeloxPromise<bool>> consumerPromise_;
+  std::optional<ContinuePromise> consumerPromise_;
 
   // Satisfied when previously enqueued data has been consumed, e.g. state_.data
   // is nullptr.
-  std::optional<VeloxPromise<bool>> producerPromise_;
+  std::optional<ContinuePromise> producerPromise_;
 };
 
 } // namespace facebook::velox::exec

velox/exec/PartitionedOutputBufferManager.cpp

@@ -138,7 +138,7 @@ namespace {
 // producers which will allocate more memory.
 void releaseAfterAcknowledge(
     std::vector<std::shared_ptr<SerializedPage>>& freed,
-    std::vector<VeloxPromise<bool>>& promises) {
+    std::vector<ContinuePromise>& promises) {
   freed.clear();
   for (auto& promise : promises) {
     promise.setValue(true);
@@ -167,7 +167,7 @@ void PartitionedOutputBuffer::updateBroadcastOutputBuffers(
     bool noMoreBuffers) {
   VELOX_CHECK(broadcast_);
 
-  std::vector<VeloxPromise<bool>> promises;
+  std::vector<ContinuePromise> promises;
   {
     std::lock_guard<std::mutex> l(mutex_);
 
@@ -316,7 +316,7 @@ bool PartitionedOutputBuffer::isFinishedLocked() {
 
 void PartitionedOutputBuffer::acknowledge(int destination, int64_t sequence) {
   std::vector<std::shared_ptr<SerializedPage>> freed;
-  std::vector<VeloxPromise<bool>> promises;
+  std::vector<ContinuePromise> promises;
   {
     std::lock_guard<std::mutex> l(mutex_);
     VELOX_CHECK_LT(destination, buffers_.size());
@@ -334,7 +334,7 @@ void PartitionedOutputBuffer::acknowledge(int destination, int64_t sequence) {
 
 void PartitionedOutputBuffer::updateAfterAcknowledgeLocked(
     const std::vector<std::shared_ptr<SerializedPage>>& freed,
-    std::vector<VeloxPromise<bool>>& promises) {
+    std::vector<ContinuePromise>& promises) {
   uint64_t totalFreed = 0;
   for (const auto& free : freed) {
     if (free.unique()) {
@@ -359,7 +359,7 @@ void PartitionedOutputBuffer::updateAfterAcknowledgeLocked(
 
 bool PartitionedOutputBuffer::deleteResults(int destination) {
   std::vector<std::shared_ptr<SerializedPage>> freed;
-  std::vector<VeloxPromise<bool>> promises;
+  std::vector<ContinuePromise> promises;
   bool isFinished;
   {
     std::lock_guard<std::mutex> l(mutex_);
@@ -393,7 +393,7 @@ void PartitionedOutputBuffer::getData(
     DataAvailableCallback notify) {
   std::vector<std::shared_ptr<SerializedPage>> data;
   std::vector<std::shared_ptr<SerializedPage>> freed;
-  std::vector<VeloxPromise<bool>> promises;
+  std::vector<ContinuePromise> promises;
   {
     std::lock_guard<std::mutex> l(mutex_);
 

velox/exec/PartitionedOutputBufferManager.h

@@ -153,7 +153,7 @@ class PartitionedOutputBuffer {
   // 'promises'.
   void updateAfterAcknowledgeLocked(
       const std::vector<std::shared_ptr<SerializedPage>>& freed,
-      std::vector<VeloxPromise<bool>>& promises);
+      std::vector<ContinuePromise>& promises);
 
   /// Given an updated total number of broadcast buffers, add any missing ones
   /// and enqueue data that has been produced so far (e.g. dataToBroadcast_).
@@ -181,7 +181,7 @@ class PartitionedOutputBuffer {
   std::mutex mutex_;
   // Actual data size in 'buffers_'.
   uint64_t totalSize_ = 0;
-  std::vector<VeloxPromise<bool>> promises_;
+  std::vector<ContinuePromise> promises_;
   // One buffer per destination
   std::vector<std::unique_ptr<DestinationBuffer>> buffers_;
   uint32_t numFinished_{0};

velox/exec/Task.cpp

@@ -891,7 +891,7 @@ bool Task::allPeersFinished(
     const core::PlanNodeId& planNodeId,
     Driver* caller,
     ContinueFuture* future,
-    std::vector<VeloxPromise<bool>>& promises,
+    std::vector<ContinuePromise>& promises,
     std::vector<std::shared_ptr<Driver>>& peers) {
   std::lock_guard<std::mutex> l(mutex_);
   if (exception_) {
@@ -993,8 +993,8 @@ std::string Task::shortId(const std::string& id) {
 
 /// Moves split promises from one vector to another.
 static void movePromisesOut(
-    std::vector<VeloxPromise<bool>>& from,
-    std::vector<VeloxPromise<bool>>& to) {
+    std::vector<ContinuePromise>& from,
+    std::vector<ContinuePromise>& to) {
   for (auto& promise : from) {
     to.push_back(std::move(promise));
   }

velox/exec/Task.h

@@ -31,8 +31,6 @@ class PartitionedOutputBufferManager;
 class HashJoinBridge;
 class CrossJoinBridge;
 
-using ContinuePromise = VeloxPromise<bool>;
-
 class Task : public std::enable_shared_from_this<Task> {
  public:
   /// Creates a task to execute a plan fragment, but doesn't start execution
@@ -333,7 +331,7 @@ class Task : public std::enable_shared_from_this<Task> {
       const core::PlanNodeId& planNodeId,
       Driver* FOLLY_NONNULL caller,
       ContinueFuture* FOLLY_NONNULL future,
-      std::vector<VeloxPromise<bool>>& promises,
+      std::vector<ContinuePromise>& promises,
       std::vector<std::shared_ptr<Driver>>& peers);
 
   // Adds HashJoinBridge's for all the specified plan node IDs.
@@ -654,7 +652,7 @@ class Task : public std::enable_shared_from_this<Task> {
   /// Stores separate splits state for each plan node.
   std::unordered_map<core::PlanNodeId, SplitsState> splitsStates_;
 
-  std::vector<VeloxPromise<bool>> stateChangePromises_;
+  std::vector<ContinuePromise> stateChangePromises_;
 
   TaskStats taskStats_;
   std::unique_ptr<memory::MemoryPool> pool_;
@@ -686,7 +684,7 @@ class Task : public std::enable_shared_from_this<Task> {
   // Promises for the futures returned to callers of requestPause() or
   // terminate(). They are fulfilled when the last thread stops
   // running for 'this'.
-  std::vector<VeloxPromise<bool>> threadFinishPromises_;
+  std::vector<ContinuePromise> threadFinishPromises_;
 };
 
 /// Listener invoked on task completion.

velox/exec/TaskStructs.h

@@ -34,7 +34,7 @@ enum TaskState { kRunning, kFinished, kCanceled, kAborted, kFailed };
 struct BarrierState {
   int32_t numRequested;
   std::vector<std::shared_ptr<Driver>> drivers;
-  std::vector<VeloxPromise<bool>> promises;
+  std::vector<ContinuePromise> promises;
 };
 
 /// Structure to accumulate splits for distribution.
@@ -44,7 +44,7 @@ struct SplitsStore {
   /// Signal, that no more splits will arrive.
   bool noMoreSplits{false};
   /// Blocking promises given out when out of splits to distribute.
-  std::vector<VeloxPromise<bool>> splitPromises;
+  std::vector<ContinuePromise> splitPromises;
 };
 
 /// Structure contains the current info on splits for a particular plan node.