/*
- * Copyright 2015 Facebook, Inc.
+ * Copyright 2016 Facebook, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
// Where create and destroy are functions, Singleton<T>::CreateFunc
// Singleton<T>::TeardownFunc.
//
+// For example, if you need to pass arguments to your class's constructor:
+// class X {
+// public:
+// X(int a1, std::string a2);
+// // ...
+// }
+// Make your singleton like this:
+// folly::Singleton<X> singleton_x([]() { return new X(42, "foo"); });
+//
// The above examples detail a situation where an expensive singleton is loaded
// on-demand (thus only if needed). However if there is an expensive singleton
// that will likely be needed, and initialization takes a potentially long time,
#pragma once
#include <folly/Baton.h>
+#include <folly/Demangle.h>
#include <folly/Exception.h>
+#include <folly/Executor.h>
#include <folly/Hash.h>
#include <folly/Memory.h>
#include <folly/RWSpinLock.h>
-#include <folly/Demangle.h>
-#include <folly/Executor.h>
-#include <folly/futures/Future.h>
-#include <folly/io/async/Request.h>
+#include <folly/Synchronized.h>
+#include <folly/detail/StaticSingletonManager.h>
+#include <folly/experimental/ReadMostlySharedPtr.h>
#include <algorithm>
-#include <vector>
-#include <mutex>
-#include <thread>
+#include <atomic>
#include <condition_variable>
+#include <functional>
+#include <memory>
+#include <mutex>
#include <string>
+#include <thread>
+#include <typeindex>
+#include <typeinfo>
#include <unordered_map>
#include <unordered_set>
-#include <functional>
-#include <typeinfo>
-#include <typeindex>
+#include <vector>
#include <glog/logging.h>
// SingletonHolders.
class SingletonHolderBase {
public:
+ explicit SingletonHolderBase(TypeDescriptor typeDesc) : type_(typeDesc) {}
virtual ~SingletonHolderBase() = default;
- virtual TypeDescriptor type() = 0;
+ TypeDescriptor type() const {
+ return type_;
+ }
virtual bool hasLiveInstance() = 0;
virtual void createInstance() = 0;
virtual bool creationStarted() = 0;
+ virtual void preDestroyInstance(ReadMostlyMainPtrDeleter<>&) = 0;
virtual void destroyInstance() = 0;
- protected:
- static constexpr std::chrono::seconds kDestroyWaitTime{5};
+ private:
+ TypeDescriptor type_;
};
// An actual instance of a singleton, tracking the instance itself,
inline T* get();
inline std::weak_ptr<T> get_weak();
+ inline std::shared_ptr<T> try_get();
+ inline folly::ReadMostlySharedPtr<T> try_get_fast();
void registerSingleton(CreateFunc c, TeardownFunc t);
void registerSingletonMock(CreateFunc c, TeardownFunc t);
- virtual TypeDescriptor type() override;
virtual bool hasLiveInstance() override;
virtual void createInstance() override;
virtual bool creationStarted() override;
+ virtual void preDestroyInstance(ReadMostlyMainPtrDeleter<>&) override;
virtual void destroyInstance() override;
private:
Living,
};
- TypeDescriptor type_;
SingletonVault& vault_;
// mutex protects the entire entry during construction/destruction
// The singleton itself and related functions.
- // holds a shared_ptr to singleton instance, set when state is changed from
- // Dead to Living. Reset when state is changed from Living to Dead.
- std::shared_ptr<T> instance_;
+ // holds a ReadMostlyMainPtr to singleton instance, set when state is changed
+ // from Dead to Living. Reset when state is changed from Living to Dead.
+ folly::ReadMostlyMainPtr<T> instance_;
+ // used to release all ReadMostlyMainPtrs at once
+ folly::ReadMostlySharedPtr<T> instance_copy_;
// weak_ptr to the singleton instance, set when state is changed from Dead
// to Living. We never write to this object after initialization, so it is
// safe to read it from different threads w/o synchronization if we know
// that state is set to Living
std::weak_ptr<T> instance_weak_;
+ // Fast equivalent of instance_weak_
+ folly::ReadMostlyWeakPtr<T> instance_weak_fast_;
// Time we wait on destroy_baton after releasing Singleton shared_ptr.
std::shared_ptr<folly::Baton<>> destroy_baton_;
T* instance_ptr_ = nullptr;
Relaxed, // Singletons can be created before registrationComplete()
};
- explicit SingletonVault(Type type = Type::Relaxed) : type_(type) {}
+ /**
+ * Clears all singletons in the given vault at ctor and dtor times.
+ * Useful for unit-tests that need to clear the world.
+ *
+ * This need can arise when a unit-test needs to swap out an object used by a
+ * singleton for a test-double, but the singleton needing its dependency to be
+ * swapped has a type or a tag local to some other translation unit and
+ * unavailable in the current translation unit.
+ *
+ * Other, better approaches to this need are "plz 2 refactor" ....
+ */
+ struct ScopedExpunger {
+ SingletonVault* vault;
+ explicit ScopedExpunger(SingletonVault* v) : vault(v) { expunge(); }
+ ~ScopedExpunger() { expunge(); }
+ void expunge() {
+ vault->destroyInstances();
+ vault->reenableInstances();
+ }
+ };
+
+ explicit SingletonVault(Type type = Type::Strict) : type_(type) {}
// Destructor is only called by unit tests to check destroyInstances.
~SingletonVault();
/**
* Schedule eager singletons' initializations through the given executor.
- * Return a future which is fulfilled after all the initialization functions
- * complete.
+ * If baton ptr is not null, its `post` method is called after all
+ * early initialization has completed.
+ *
+ * If exceptions are thrown during initialization, this method will still
+ * `post` the baton to indicate completion. The exception will not propagate
+ * and future attempts to `try_get` or `get_weak` the failed singleton will
+ * retry initialization.
+ *
+ * Sample usage:
+ *
+ * wangle::IOThreadPoolExecutor executor(max_concurrency_level);
+ * folly::Baton<> done;
+ * doEagerInitVia(executor, &done);
+ * done.wait(); // or 'timed_wait', or spin with 'try_wait'
+ *
*/
- Future<Unit> doEagerInitVia(Executor* exe);
+ void doEagerInitVia(Executor& exe, folly::Baton<>* done = nullptr);
// Destroy all singletons; when complete, the vault can't create
// singletons once again until reenableInstances() is called.
// For testing; how many registered and living singletons we have.
size_t registeredSingletonCount() const {
- RWSpinLock::ReadHolder rh(&mutex_);
-
- return singletons_.size();
+ return singletons_.rlock()->size();
}
+ /**
+ * Flips to true if eager initialization was used, and has completed.
+ * Never set to true if "doEagerInit()" or "doEagerInitVia" never called.
+ */
+ bool eagerInitComplete() const;
+
size_t livingSingletonCount() const {
- RWSpinLock::ReadHolder rh(&mutex_);
+ auto singletons = singletons_.rlock();
size_t ret = 0;
- for (const auto& p : singletons_) {
+ for (const auto& p : *singletons) {
if (p.second->hasLiveInstance()) {
++ret;
}
// tests only.
template <typename VaultTag = detail::DefaultTag>
static SingletonVault* singleton() {
- static SingletonVault* vault = new SingletonVault();
+ /* library-local */ static auto vault =
+ detail::createGlobal<SingletonVault, VaultTag>();
return vault;
}
typedef std::string(*StackTraceGetterPtr)();
static std::atomic<StackTraceGetterPtr>& stackTraceGetter() {
- static std::atomic<StackTraceGetterPtr> stackTraceGetterPtr;
- return stackTraceGetterPtr;
+ /* library-local */ static auto stackTraceGetterPtr = detail::
+ createGlobal<std::atomic<StackTraceGetterPtr>, SingletonVault>();
+ return *stackTraceGetterPtr;
+ }
+
+ void setType(Type type) {
+ type_ = type;
}
private:
Quiescing,
};
+ struct State {
+ SingletonVaultState state{SingletonVaultState::Running};
+ bool registrationComplete{false};
+ };
+
// Each singleton in the vault can be in two states: dead
// (registered but never created), living (CreateFunc returned an instance).
- void stateCheck(SingletonVaultState expected,
- const char* msg="Unexpected singleton state change") {
- if (expected != state_) {
- throw std::logic_error(msg);
+ static void stateCheck(
+ SingletonVaultState expected,
+ const State& state,
+ const char* msg = "Unexpected singleton state change") {
+ if (expected != state.state) {
+ throw std::logic_error(msg);
}
}
typedef std::unordered_map<detail::TypeDescriptor,
detail::SingletonHolderBase*,
detail::TypeDescriptorHasher> SingletonMap;
+ folly::Synchronized<SingletonMap> singletons_;
+ folly::Synchronized<std::unordered_set<detail::SingletonHolderBase*>>
+ eagerInitSingletons_;
+ folly::Synchronized<std::vector<detail::TypeDescriptor>> creationOrder_;
- mutable folly::RWSpinLock mutex_;
- SingletonMap singletons_;
- std::unordered_set<detail::SingletonHolderBase*> eagerInitSingletons_;
- std::vector<detail::TypeDescriptor> creation_order_;
- SingletonVaultState state_{SingletonVaultState::Running};
- bool registrationComplete_{false};
- folly::RWSpinLock stateMutex_;
- Type type_{Type::Relaxed};
+ folly::Synchronized<State> state_;
+
+ Type type_;
};
// This is the wrapper class that most users actually interact with.
// Generally your program life cycle should be fine with calling
// get() repeatedly rather than saving the reference, and then not
// call get() during process shutdown.
- static T* get() __attribute__ ((__deprecated__("Replaced by try_get"))) {
- return getEntry().get();
- }
+ FOLLY_DEPRECATED("Replaced by try_get")
+ static T* get() { return getEntry().get(); }
// If, however, you do need to hold a reference to the specific
// singleton, you can try to do so with a weak_ptr. Avoid this when
// possible but the inability to lock the weak pointer can be a
// signal that the vault has been destroyed.
- static std::weak_ptr<T> get_weak() {
- return getEntry().get_weak();
- }
+ FOLLY_DEPRECATED("Replaced by try_get")
+ static std::weak_ptr<T> get_weak() { return getEntry().get_weak(); }
// Preferred alternative to get_weak, it returns shared_ptr that can be
// stored; a singleton won't be destroyed unless shared_ptr is destroyed.
// Avoid holding these shared_ptrs beyond the scope of a function;
// don't put them in member variables, always use try_get() instead
+ //
+ // try_get() can return nullptr if the singleton was destroyed, caller is
+ // responsible for handling nullptr return
static std::shared_ptr<T> try_get() {
- auto ret = get_weak().lock();
- if (!ret) {
- LOG(DFATAL) <<
- "folly::Singleton<" << getEntry().type().name() <<
- ">::get_weak() called on destructed singleton; "
- "returning nullptr, possible segfault coming";
- }
- return ret;
+ return getEntry().try_get();
}
- explicit Singleton(std::nullptr_t _ = nullptr,
- typename Singleton::TeardownFunc t = nullptr) :
- Singleton ([]() { return new T; }, std::move(t)) {
+ static folly::ReadMostlySharedPtr<T> try_get_fast() {
+ return getEntry().try_get_fast();
}
+ explicit Singleton(std::nullptr_t /* _ */ = nullptr,
+ typename Singleton::TeardownFunc t = nullptr)
+ : Singleton([]() { return new T; }, std::move(t)) {}
+
explicit Singleton(typename Singleton::CreateFunc c,
typename Singleton::TeardownFunc t = nullptr) {
if (c == nullptr) {
* the injection. The returned mock singleton is functionality identical to
* regular singletons.
*/
- static void make_mock(std::nullptr_t c = nullptr,
+ static void make_mock(std::nullptr_t /* c */ = nullptr,
typename Singleton<T>::TeardownFunc t = nullptr) {
make_mock([]() { return new T; }, t);
}
}
};
+template <typename T, typename Tag = detail::DefaultTag>
+class LeakySingleton {
+ public:
+ using CreateFunc = std::function<T*()>;
+
+ LeakySingleton() : LeakySingleton([] { return new T(); }) {}
+
+ explicit LeakySingleton(CreateFunc createFunc) {
+ auto& entry = entryInstance();
+ if (entry.state != State::NotRegistered) {
+ LOG(FATAL) << "Double registration of singletons of the same "
+ << "underlying type; check for multiple definitions "
+ << "of type folly::LeakySingleton<" + entry.type_.name() + ">";
+ }
+ entry.createFunc = createFunc;
+ entry.state = State::Dead;
+ }
+
+ static T& get() { return instance(); }
+
+ private:
+ enum class State { NotRegistered, Dead, Living };
+
+ struct Entry {
+ Entry() {}
+ Entry(const Entry&) = delete;
+ Entry& operator=(const Entry&) = delete;
+
+ std::atomic<State> state{State::NotRegistered};
+ T* ptr{nullptr};
+ CreateFunc createFunc;
+ std::mutex mutex;
+ detail::TypeDescriptor type_{typeid(T), typeid(Tag)};
+ };
+
+ static Entry& entryInstance() {
+ /* library-local */ static auto entry = detail::createGlobal<Entry, Tag>();
+ return *entry;
+ }
+
+ static T& instance() {
+ auto& entry = entryInstance();
+ if (UNLIKELY(entry.state != State::Living)) {
+ createInstance();
+ }
+
+ return *entry.ptr;
+ }
+
+ static void createInstance() {
+ auto& entry = entryInstance();
+
+ std::lock_guard<std::mutex> lg(entry.mutex);
+ if (entry.state == State::Living) {
+ return;
+ }
+
+ if (entry.state == State::NotRegistered) {
+ auto ptr = SingletonVault::stackTraceGetter().load();
+ LOG(FATAL) << "Creating instance for unregistered singleton: "
+ << entry.type_.name() << "\n"
+ << "Stacktrace:"
+ << "\n" << (ptr ? (*ptr)() : "(not available)");
+ }
+
+ entry.ptr = entry.createFunc();
+ entry.state = State::Living;
+ }
+};
}
#include <folly/Singleton-inl.h>
projects / folly.git / blobdiff