From: Hans Fugal Date: Wed, 15 Oct 2014 16:31:52 +0000 (-0700) Subject: (wangle) s/State/Core/ X-Git-Tag: v0.22.0~281 X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=ff25b9504aa16da11906eb2807fd37127cb7c538;p=folly.git (wangle) s/State/Core/ Summary: codemod `State` is such an overloaded term, and not really the best to describe this backing future/promise object. Yes, it holds the state but it's more than that and it gets in the way of calling the states of the state machines `State`s. Test Plan: builds and tests pass Reviewed By: davejwatson@fb.com Subscribers: trunkagent, net-systems@, fugalh, exa, njormrod FB internal diff: D1615707 --- diff --git a/folly/wangle/Future-inl.h b/folly/wangle/Future-inl.h index e66e504c..cf10e9f4 100644 --- a/folly/wangle/Future-inl.h +++ b/folly/wangle/Future-inl.h @@ -19,7 +19,7 @@ #include #include -#include +#include #include namespace folly { namespace wangle { @@ -35,13 +35,13 @@ struct isFuture > { }; template -Future::Future(Future&& other) noexcept : state_(nullptr) { +Future::Future(Future&& other) noexcept : core_(nullptr) { *this = std::move(other); } template Future& Future::operator=(Future&& other) { - std::swap(state_, other.state_); + std::swap(core_, other.core_); return *this; } @@ -52,15 +52,15 @@ Future::~Future() { template void Future::detach() { - if (state_) { - state_->detachFuture(); - state_ = nullptr; + if (core_) { + core_->detachFuture(); + core_ = nullptr; } } template void Future::throwIfInvalid() const { - if (!state_) + if (!core_) throw NoState(); } @@ -68,7 +68,7 @@ template template void Future::setCallback_(F&& func) { throwIfInvalid(); - state_->setCallback(std::move(func)); + core_->setCallback(std::move(func)); } template @@ -95,10 +95,10 @@ Future::then(F&& func) { sophisticated that avoids making a new Future object when it can, as an optimization. But this is correct. - state_ can't be moved, it is explicitly disallowed (as is copying). But + core_ can't be moved, it is explicitly disallowed (as is copying). But if there's ever a reason to allow it, this is one place that makes that assumption and would need to be fixed. We use a standard shared pointer - for state_ (by copying it in), which means in essence obj holds a shared + for core_ (by copying it in), which means in essence obj holds a shared pointer to itself. But this shouldn't leak because Promise will not outlive the continuation, because Promise will setException() with a broken Promise if it is destructed before completed. We could use a @@ -110,11 +110,11 @@ Future::then(F&& func) { We have to move in the Promise and func using the MoveWrapper hack. (func could be copied but it's a big drag on perf). - Two subtle but important points about this design. detail::State has no + Two subtle but important points about this design. detail::Core has no back pointers to Future or Promise, so if Future or Promise get moved (and they will be moved in performant code) we don't have to do anything fancy. And because we store the continuation in the - detail::State, not in the Future, we can execute the continuation even + detail::Core, not in the Future, we can execute the continuation even after the Future has gone out of scope. This is an intentional design decision. It is likely we will want to be able to cancel a continuation in some circumstances, but I think it should be explicit not implicit @@ -172,21 +172,21 @@ template typename std::add_lvalue_reference::type Future::value() { throwIfInvalid(); - return state_->value(); + return core_->value(); } template typename std::add_lvalue_reference::type Future::value() const { throwIfInvalid(); - return state_->value(); + return core_->value(); } template Try& Future::getTry() { throwIfInvalid(); - return state_->getTry(); + return core_->getTry(); } template @@ -195,7 +195,7 @@ inline Future Future::via(Executor* executor) { throwIfInvalid(); this->deactivate(); - state_->setExecutor(executor); + core_->setExecutor(executor); return std::move(*this); } @@ -203,7 +203,7 @@ inline Future Future::via(Executor* executor) { template bool Future::isReady() const { throwIfInvalid(); - return state_->ready(); + return core_->ready(); } // makeFuture diff --git a/folly/wangle/Future.h b/folly/wangle/Future.h index df30efc5..3f46034b 100644 --- a/folly/wangle/Future.h +++ b/folly/wangle/Future.h @@ -199,23 +199,23 @@ class Future { /// /// Inactive Futures will activate upon destruction. void activate() { - state_->activate(); + core_->activate(); } void deactivate() { - state_->deactivate(); + core_->deactivate(); } bool isActive() { - return state_->isActive(); + return core_->isActive(); } private: - typedef detail::State* statePtr; + typedef detail::Core* corePtr; - // shared state object - statePtr state_; + // shared core state object + corePtr core_; explicit - Future(statePtr obj) : state_(obj) {} + Future(corePtr obj) : core_(obj) {} void detach(); diff --git a/folly/wangle/Promise-inl.h b/folly/wangle/Promise-inl.h index 04cc9a3f..98993c7c 100644 --- a/folly/wangle/Promise-inl.h +++ b/folly/wangle/Promise-inl.h @@ -20,31 +20,31 @@ #include #include -#include +#include namespace folly { namespace wangle { template -Promise::Promise() : retrieved_(false), state_(new detail::State()) +Promise::Promise() : retrieved_(false), core_(new detail::Core()) {} template -Promise::Promise(Promise&& other) : state_(nullptr) { +Promise::Promise(Promise&& other) : core_(nullptr) { *this = std::move(other); } template Promise& Promise::operator=(Promise&& other) { - std::swap(state_, other.state_); + std::swap(core_, other.core_); std::swap(retrieved_, other.retrieved_); return *this; } template void Promise::throwIfFulfilled() { - if (!state_) + if (!core_) throw NoState(); - if (state_->ready()) + if (core_->ready()) throw PromiseAlreadySatisfied(); } @@ -61,11 +61,11 @@ Promise::~Promise() { template void Promise::detach() { - if (state_) { + if (core_) { if (!retrieved_) - state_->detachFuture(); - state_->detachPromise(); - state_ = nullptr; + core_->detachFuture(); + core_->detachPromise(); + core_ = nullptr; } } @@ -73,7 +73,7 @@ template Future Promise::getFuture() { throwIfRetrieved(); retrieved_ = true; - return Future(state_); + return Future(core_); } template @@ -85,13 +85,13 @@ void Promise::setException(E const& e) { template void Promise::setException(std::exception_ptr const& e) { throwIfFulfilled(); - state_->setException(e); + core_->setException(e); } template void Promise::fulfilTry(Try&& t) { throwIfFulfilled(); - state_->fulfil(std::move(t)); + core_->fulfil(std::move(t)); } template diff --git a/folly/wangle/Promise.h b/folly/wangle/Promise.h index e14350e3..a4eb94b1 100644 --- a/folly/wangle/Promise.h +++ b/folly/wangle/Promise.h @@ -38,7 +38,7 @@ public: Promise(Promise&&); Promise& operator=(Promise&&); - /** Return a Future tied to the shared state. This can be called only + /** Return a Future tied to the shared core state. This can be called only once, thereafter Future already retrieved exception will be raised. */ Future getFuture(); @@ -76,13 +76,13 @@ public: void fulfil(F&& func); private: - typedef typename Future::statePtr statePtr; + typedef typename Future::corePtr corePtr; // Whether the Future has been retrieved (a one-time operation). bool retrieved_; - // shared state object - statePtr state_; + // shared core state object + corePtr core_; void throwIfFulfilled(); void throwIfRetrieved(); diff --git a/folly/wangle/detail/Core.h b/folly/wangle/detail/Core.h new file mode 100644 index 00000000..f237c619 --- /dev/null +++ b/folly/wangle/detail/Core.h @@ -0,0 +1,265 @@ +/* + * Copyright 2014 Facebook, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#pragma once + +#include +#include +#include +#include + +#include + +#include +#include +#include +#include + +namespace folly { namespace wangle { namespace detail { + +// As of GCC 4.8.1, the std::function in libstdc++ optimizes only for pointers +// to functions, using a helper avoids a call to malloc. +template +void empty_callback(Try&&) { } + +/** The shared state object for Future and Promise. */ +template +class Core { + public: + // This must be heap-constructed. There's probably a way to enforce that in + // code but since this is just internal detail code and I don't know how + // off-hand, I'm punting. + Core() = default; + ~Core() { + assert(calledBack_); + assert(detached_ == 2); + } + + // not copyable + Core(Core const&) = delete; + Core& operator=(Core const&) = delete; + + // not movable (see comment in the implementation of Future::then) + Core(Core&&) noexcept = delete; + Core& operator=(Core&&) = delete; + + Try& getTry() { + return *value_; + } + + template + void setCallback(F func) { + { + std::lock_guard lock(mutex_); + + if (callback_) { + throw std::logic_error("setCallback called twice"); + } + + callback_ = std::move(func); + } + + maybeCallback(); + } + + void fulfil(Try&& t) { + { + std::lock_guard lock(mutex_); + + if (ready()) { + throw std::logic_error("fulfil called twice"); + } + + value_ = std::move(t); + assert(ready()); + } + + maybeCallback(); + } + + void setException(std::exception_ptr const& e) { + fulfil(Try(e)); + } + + template void setException(E const& e) { + fulfil(Try(std::make_exception_ptr(e))); + } + + bool ready() const { + return value_.hasValue(); + } + + typename std::add_lvalue_reference::type value() { + if (ready()) { + return value_->value(); + } else { + throw FutureNotReady(); + } + } + + // Called by a destructing Future + void detachFuture() { + if (!callback_) { + setCallback(empty_callback); + } + activate(); + detachOne(); + } + + // Called by a destructing Promise + void detachPromise() { + if (!ready()) { + setException(BrokenPromise()); + } + detachOne(); + } + + void deactivate() { + std::lock_guard lock(mutex_); + active_ = false; + } + + void activate() { + { + std::lock_guard lock(mutex_); + active_ = true; + } + maybeCallback(); + } + + bool isActive() { return active_; } + + void setExecutor(Executor* x) { + std::lock_guard lock(mutex_); + executor_ = x; + } + + private: + void maybeCallback() { + std::unique_lock lock(mutex_); + if (!calledBack_ && + value_ && callback_ && isActive()) { + // TODO(5306911) we should probably try/catch here + if (executor_) { + MoveWrapper>> val(std::move(value_)); + MoveWrapper&&)>> cb(std::move(callback_)); + executor_->add([cb, val]() mutable { (*cb)(std::move(**val)); }); + calledBack_ = true; + } else { + calledBack_ = true; + lock.unlock(); + callback_(std::move(*value_)); + } + } + } + + void detachOne() { + bool shouldDelete; + { + std::lock_guard lock(mutex_); + detached_++; + assert(detached_ == 1 || detached_ == 2); + shouldDelete = (detached_ == 2); + } + + if (shouldDelete) { + // we should have already executed the callback with the value + assert(calledBack_); + delete this; + } + } + + folly::Optional> value_; + std::function&&)> callback_; + bool calledBack_ = false; + unsigned char detached_ = 0; + bool active_ = true; + Executor* executor_ = nullptr; + + // this lock isn't meant to protect all accesses to members, only the ones + // that need to be threadsafe: the act of setting value_ and callback_, and + // seeing if they are set and whether we should then continue. + std::mutex mutex_; +}; + +template +struct VariadicContext { + VariadicContext() : total(0), count(0) {} + Promise... > > p; + std::tuple... > results; + size_t total; + std::atomic count; + typedef Future...>> type; +}; + +template +typename std::enable_if::type +whenAllVariadicHelper(VariadicContext *ctx, THead&& head, Fs&&... tail) { + head.setCallback_([ctx](Try&& t) { + std::get(ctx->results) = std::move(t); + if (++ctx->count == ctx->total) { + ctx->p.setValue(std::move(ctx->results)); + delete ctx; + } + }); +} + +template +typename std::enable_if::type +whenAllVariadicHelper(VariadicContext *ctx, THead&& head, Fs&&... tail) { + head.setCallback_([ctx](Try&& t) { + std::get(ctx->results) = std::move(t); + if (++ctx->count == ctx->total) { + ctx->p.setValue(std::move(ctx->results)); + delete ctx; + } + }); + // template tail-recursion + whenAllVariadicHelper(ctx, std::forward(tail)...); +} + +template +struct WhenAllContext { + explicit WhenAllContext() : count(0), total(0) {} + Promise > > p; + std::vector > results; + std::atomic count; + size_t total; +}; + +template +struct WhenAnyContext { + explicit WhenAnyContext(size_t n) : done(false), ref_count(n) {}; + Promise>> p; + std::atomic done; + std::atomic ref_count; + void decref() { + if (--ref_count == 0) { + delete this; + } + } +}; + +template +struct WhenAllLaterContext { + explicit WhenAllLaterContext() : count(0), total(0) {} + std::function>&&)> fn; + std::vector > results; + std::atomic count; + size_t total; +}; + +}}} // namespace diff --git a/folly/wangle/detail/State.h b/folly/wangle/detail/State.h deleted file mode 100644 index c06e2236..00000000 --- a/folly/wangle/detail/State.h +++ /dev/null @@ -1,265 +0,0 @@ -/* - * Copyright 2014 Facebook, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -#pragma once - -#include -#include -#include -#include - -#include - -#include -#include -#include -#include - -namespace folly { namespace wangle { namespace detail { - -// As of GCC 4.8.1, the std::function in libstdc++ optimizes only for pointers -// to functions, using a helper avoids a call to malloc. -template -void empty_callback(Try&&) { } - -/** The shared state object for Future and Promise. */ -template -class State { - public: - // This must be heap-constructed. There's probably a way to enforce that in - // code but since this is just internal detail code and I don't know how - // off-hand, I'm punting. - State() = default; - ~State() { - assert(calledBack_); - assert(detached_ == 2); - } - - // not copyable - State(State const&) = delete; - State& operator=(State const&) = delete; - - // not movable (see comment in the implementation of Future::then) - State(State&&) noexcept = delete; - State& operator=(State&&) = delete; - - Try& getTry() { - return *value_; - } - - template - void setCallback(F func) { - { - std::lock_guard lock(mutex_); - - if (callback_) { - throw std::logic_error("setCallback called twice"); - } - - callback_ = std::move(func); - } - - maybeCallback(); - } - - void fulfil(Try&& t) { - { - std::lock_guard lock(mutex_); - - if (ready()) { - throw std::logic_error("fulfil called twice"); - } - - value_ = std::move(t); - assert(ready()); - } - - maybeCallback(); - } - - void setException(std::exception_ptr const& e) { - fulfil(Try(e)); - } - - template void setException(E const& e) { - fulfil(Try(std::make_exception_ptr(e))); - } - - bool ready() const { - return value_.hasValue(); - } - - typename std::add_lvalue_reference::type value() { - if (ready()) { - return value_->value(); - } else { - throw FutureNotReady(); - } - } - - // Called by a destructing Future - void detachFuture() { - if (!callback_) { - setCallback(empty_callback); - } - activate(); - detachOne(); - } - - // Called by a destructing Promise - void detachPromise() { - if (!ready()) { - setException(BrokenPromise()); - } - detachOne(); - } - - void deactivate() { - std::lock_guard lock(mutex_); - active_ = false; - } - - void activate() { - { - std::lock_guard lock(mutex_); - active_ = true; - } - maybeCallback(); - } - - bool isActive() { return active_; } - - void setExecutor(Executor* x) { - std::lock_guard lock(mutex_); - executor_ = x; - } - - private: - void maybeCallback() { - std::unique_lock lock(mutex_); - if (!calledBack_ && - value_ && callback_ && isActive()) { - // TODO(5306911) we should probably try/catch here - if (executor_) { - MoveWrapper>> val(std::move(value_)); - MoveWrapper&&)>> cb(std::move(callback_)); - executor_->add([cb, val]() mutable { (*cb)(std::move(**val)); }); - calledBack_ = true; - } else { - calledBack_ = true; - lock.unlock(); - callback_(std::move(*value_)); - } - } - } - - void detachOne() { - bool shouldDelete; - { - std::lock_guard lock(mutex_); - detached_++; - assert(detached_ == 1 || detached_ == 2); - shouldDelete = (detached_ == 2); - } - - if (shouldDelete) { - // we should have already executed the callback with the value - assert(calledBack_); - delete this; - } - } - - folly::Optional> value_; - std::function&&)> callback_; - bool calledBack_ = false; - unsigned char detached_ = 0; - bool active_ = true; - Executor* executor_ = nullptr; - - // this lock isn't meant to protect all accesses to members, only the ones - // that need to be threadsafe: the act of setting value_ and callback_, and - // seeing if they are set and whether we should then continue. - std::mutex mutex_; -}; - -template -struct VariadicContext { - VariadicContext() : total(0), count(0) {} - Promise... > > p; - std::tuple... > results; - size_t total; - std::atomic count; - typedef Future...>> type; -}; - -template -typename std::enable_if::type -whenAllVariadicHelper(VariadicContext *ctx, THead&& head, Fs&&... tail) { - head.setCallback_([ctx](Try&& t) { - std::get(ctx->results) = std::move(t); - if (++ctx->count == ctx->total) { - ctx->p.setValue(std::move(ctx->results)); - delete ctx; - } - }); -} - -template -typename std::enable_if::type -whenAllVariadicHelper(VariadicContext *ctx, THead&& head, Fs&&... tail) { - head.setCallback_([ctx](Try&& t) { - std::get(ctx->results) = std::move(t); - if (++ctx->count == ctx->total) { - ctx->p.setValue(std::move(ctx->results)); - delete ctx; - } - }); - // template tail-recursion - whenAllVariadicHelper(ctx, std::forward(tail)...); -} - -template -struct WhenAllContext { - explicit WhenAllContext() : count(0), total(0) {} - Promise > > p; - std::vector > results; - std::atomic count; - size_t total; -}; - -template -struct WhenAnyContext { - explicit WhenAnyContext(size_t n) : done(false), ref_count(n) {}; - Promise>> p; - std::atomic done; - std::atomic ref_count; - void decref() { - if (--ref_count == 0) { - delete this; - } - } -}; - -template -struct WhenAllLaterContext { - explicit WhenAllLaterContext() : count(0), total(0) {} - std::function>&&)> fn; - std::vector > results; - std::atomic count; - size_t total; -}; - -}}} // namespace