2 * Copyright 2016 Facebook, Inc.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 // SingletonVault - a library to manage the creation and destruction
18 // of interdependent singletons.
20 // Basic usage of this class is very simple; suppose you have a class
21 // called MyExpensiveService, and you only want to construct one (ie,
22 // it's a singleton), but you only want to construct it if it is used.
25 // class MyExpensiveService { ... };
28 // namespace { folly::Singleton<MyExpensiveService> the_singleton; }
30 // Code can access it via:
32 // MyExpensiveService* instance = Singleton<MyExpensiveService>::get();
34 // std::weak_ptr<MyExpensiveService> instance =
35 // Singleton<MyExpensiveService>::get_weak();
37 // You also can directly access it by the variable defining the
38 // singleton rather than via get(), and even treat that variable like
39 // a smart pointer (dereferencing it or using the -> operator).
41 // Please note, however, that all non-weak_ptr interfaces are
42 // inherently subject to races with destruction. Use responsibly.
44 // The singleton will be created on demand. If the constructor for
45 // MyExpensiveService actually makes use of *another* Singleton, then
46 // the right thing will happen -- that other singleton will complete
47 // construction before get() returns. However, in the event of a
48 // circular dependency, a runtime error will occur.
50 // You can have multiple singletons of the same underlying type, but
51 // each must be given a unique tag. If no tag is specified - default tag is used
56 // folly::Singleton<MyExpensiveService> s_default;
57 // folly::Singleton<MyExpensiveService, Tag1> s1;
58 // folly::Singleton<MyExpensiveService, Tag2> s2;
61 // MyExpensiveService* svc_default = s_default.get();
62 // MyExpensiveService* svc1 = s1.get();
63 // MyExpensiveService* svc2 = s2.get();
65 // By default, the singleton instance is constructed via new and
66 // deleted via delete, but this is configurable:
68 // namespace { folly::Singleton<MyExpensiveService> the_singleton(create,
71 // Where create and destroy are functions, Singleton<T>::CreateFunc
72 // Singleton<T>::TeardownFunc.
74 // The above examples detail a situation where an expensive singleton is loaded
75 // on-demand (thus only if needed). However if there is an expensive singleton
76 // that will likely be needed, and initialization takes a potentially long time,
77 // e.g. while initializing, parsing some files, talking to remote services,
78 // making uses of other singletons, and so on, the initialization of those can
79 // be scheduled up front, or "eagerly".
81 // In that case the singleton can be declared this way:
84 // auto the_singleton =
85 // folly::Singleton<MyExpensiveService>(/* optional create, destroy args */)
86 // .shouldEagerInit();
89 // This way the singleton's instance is built at program initialization,
90 // if the program opted-in to that feature by calling "doEagerInit" or
91 // "doEagerInitVia" during its startup.
93 // What if you need to destroy all of your singletons? Say, some of
94 // your singletons manage threads, but you need to fork? Or your unit
95 // test wants to clean up all global state? Then you can call
96 // SingletonVault::singleton()->destroyInstances(), which invokes the
97 // TeardownFunc for each singleton, in the reverse order they were
98 // created. It is your responsibility to ensure your singletons can
99 // handle cases where the singletons they depend on go away, however.
100 // Singletons won't be recreated after destroyInstances call. If you
101 // want to re-enable singleton creation (say after fork was called) you
102 // should call reenableInstances.
105 #include <folly/Baton.h>
106 #include <folly/Exception.h>
107 #include <folly/Hash.h>
108 #include <folly/Memory.h>
109 #include <folly/RWSpinLock.h>
110 #include <folly/Demangle.h>
111 #include <folly/Executor.h>
112 #include <folly/experimental/ReadMostlySharedPtr.h>
113 #include <folly/detail/StaticSingletonManager.h>
117 #include <condition_variable>
118 #include <functional>
125 #include <unordered_map>
126 #include <unordered_set>
129 #include <glog/logging.h>
131 // use this guard to handleSingleton breaking change in 3rd party code
132 #ifndef FOLLY_SINGLETON_TRY_GET
133 #define FOLLY_SINGLETON_TRY_GET
138 // For actual usage, please see the Singleton<T> class at the bottom
139 // of this file; that is what you will actually interact with.
141 // SingletonVault is the class that manages singleton instances. It
142 // is unaware of the underlying types of singletons, and simply
143 // manages lifecycles and invokes CreateFunc and TeardownFunc when
144 // appropriate. In general, you won't need to interact with the
145 // SingletonVault itself.
147 // A vault goes through a few stages of life:
149 // 1. Registration phase; singletons can be registered:
150 // a) Strict: no singleton can be created in this stage.
151 // b) Relaxed: singleton can be created (the default vault is Relaxed).
152 // 2. registrationComplete() has been called; singletons can no
153 // longer be registered, but they can be created.
154 // 3. A vault can return to stage 1 when destroyInstances is called.
156 // In general, you don't need to worry about any of the above; just
157 // ensure registrationComplete() is called near the top of your main()
158 // function, otherwise no singletons can be instantiated.
160 class SingletonVault;
164 struct DefaultTag {};
166 // A TypeDescriptor is the unique handle for a given singleton. It is
167 // a combinaiton of the type and of the optional name, and is used as
168 // a key in unordered_maps.
169 class TypeDescriptor {
171 TypeDescriptor(const std::type_info& ti,
172 const std::type_info& tag_ti)
173 : ti_(ti), tag_ti_(tag_ti) {
176 TypeDescriptor(const TypeDescriptor& other)
177 : ti_(other.ti_), tag_ti_(other.tag_ti_) {
180 TypeDescriptor& operator=(const TypeDescriptor& other) {
181 if (this != &other) {
183 tag_ti_ = other.tag_ti_;
189 std::string name() const {
190 auto ret = demangle(ti_.name());
191 if (tag_ti_ != std::type_index(typeid(DefaultTag))) {
193 ret += demangle(tag_ti_.name());
195 return ret.toStdString();
198 friend class TypeDescriptorHasher;
200 bool operator==(const TypeDescriptor& other) const {
201 return ti_ == other.ti_ && tag_ti_ == other.tag_ti_;
206 std::type_index tag_ti_;
209 class TypeDescriptorHasher {
211 size_t operator()(const TypeDescriptor& ti) const {
212 return folly::hash::hash_combine(ti.ti_, ti.tag_ti_);
216 // This interface is used by SingletonVault to interact with SingletonHolders.
217 // Having a non-template interface allows SingletonVault to keep a list of all
219 class SingletonHolderBase {
221 virtual ~SingletonHolderBase() = default;
223 virtual TypeDescriptor type() = 0;
224 virtual bool hasLiveInstance() = 0;
225 virtual void createInstance() = 0;
226 virtual bool creationStarted() = 0;
227 virtual void destroyInstance() = 0;
230 static constexpr std::chrono::seconds kDestroyWaitTime{5};
233 // An actual instance of a singleton, tracking the instance itself,
234 // its state as described above, and the create and teardown
236 template <typename T>
237 struct SingletonHolder : public SingletonHolderBase {
239 typedef std::function<void(T*)> TeardownFunc;
240 typedef std::function<T*(void)> CreateFunc;
242 template <typename Tag, typename VaultTag>
243 inline static SingletonHolder<T>& singleton();
246 inline std::weak_ptr<T> get_weak();
247 inline std::shared_ptr<T> try_get();
248 inline folly::ReadMostlySharedPtr<T> try_get_fast();
250 void registerSingleton(CreateFunc c, TeardownFunc t);
251 void registerSingletonMock(CreateFunc c, TeardownFunc t);
252 virtual TypeDescriptor type() override;
253 virtual bool hasLiveInstance() override;
254 virtual void createInstance() override;
255 virtual bool creationStarted() override;
256 virtual void destroyInstance() override;
259 SingletonHolder(TypeDescriptor type, SingletonVault& vault);
261 enum class SingletonHolderState {
267 TypeDescriptor type_;
268 SingletonVault& vault_;
270 // mutex protects the entire entry during construction/destruction
273 // State of the singleton entry. If state is Living, instance_ptr and
274 // instance_weak can be safely accessed w/o synchronization.
275 std::atomic<SingletonHolderState> state_{SingletonHolderState::NotRegistered};
277 // the thread creating the singleton (only valid while creating an object)
278 std::atomic<std::thread::id> creating_thread_;
280 // The singleton itself and related functions.
282 // holds a ReadMostlyMainPtr to singleton instance, set when state is changed
283 // from Dead to Living. Reset when state is changed from Living to Dead.
284 folly::ReadMostlyMainPtr<T> instance_;
285 // weak_ptr to the singleton instance, set when state is changed from Dead
286 // to Living. We never write to this object after initialization, so it is
287 // safe to read it from different threads w/o synchronization if we know
288 // that state is set to Living
289 std::weak_ptr<T> instance_weak_;
290 // Fast equivalent of instance_weak_
291 folly::ReadMostlyWeakPtr<T> instance_weak_fast_;
292 // Time we wait on destroy_baton after releasing Singleton shared_ptr.
293 std::shared_ptr<folly::Baton<>> destroy_baton_;
294 T* instance_ptr_ = nullptr;
295 CreateFunc create_ = nullptr;
296 TeardownFunc teardown_ = nullptr;
298 std::shared_ptr<std::atomic<bool>> print_destructor_stack_trace_;
300 SingletonHolder(const SingletonHolder&) = delete;
301 SingletonHolder& operator=(const SingletonHolder&) = delete;
302 SingletonHolder& operator=(SingletonHolder&&) = delete;
303 SingletonHolder(SingletonHolder&&) = delete;
308 class SingletonVault {
311 Strict, // Singletons can't be created before registrationComplete()
312 Relaxed, // Singletons can be created before registrationComplete()
316 * Clears all singletons in the given vault at ctor and dtor times.
317 * Useful for unit-tests that need to clear the world.
319 * This need can arise when a unit-test needs to swap out an object used by a
320 * singleton for a test-double, but the singleton needing its dependency to be
321 * swapped has a type or a tag local to some other translation unit and
322 * unavailable in the current translation unit.
324 * Other, better approaches to this need are "plz 2 refactor" ....
326 struct ScopedExpunger {
327 SingletonVault* vault;
328 explicit ScopedExpunger(SingletonVault* v) : vault(v) { expunge(); }
329 ~ScopedExpunger() { expunge(); }
331 vault->destroyInstances();
332 vault->reenableInstances();
336 explicit SingletonVault(Type type = Type::Relaxed) : type_(type) {}
338 // Destructor is only called by unit tests to check destroyInstances.
341 typedef std::function<void(void*)> TeardownFunc;
342 typedef std::function<void*(void)> CreateFunc;
344 // Ensure that Singleton has not been registered previously and that
345 // registration is not complete. If validations succeeds,
346 // register a singleton of a given type with the create and teardown
348 void registerSingleton(detail::SingletonHolderBase* entry);
351 * Called by `Singleton<T>.shouldEagerInit()` to ensure the instance
352 * is built when `doEagerInit[Via]` is called; see those methods
355 void addEagerInitSingleton(detail::SingletonHolderBase* entry);
357 // Mark registration is complete; no more singletons can be
358 // registered at this point.
359 void registrationComplete();
362 * Initialize all singletons which were marked as eager-initialized
363 * (using `shouldEagerInit()`). No return value. Propagates exceptions
364 * from constructors / create functions, as is the usual case when calling
365 * for example `Singleton<Foo>::get_weak()`.
370 * Schedule eager singletons' initializations through the given executor.
371 * If baton ptr is not null, its `post` method is called after all
372 * early initialization has completed.
374 * If exceptions are thrown during initialization, this method will still
375 * `post` the baton to indicate completion. The exception will not propagate
376 * and future attempts to `try_get` or `get_weak` the failed singleton will
377 * retry initialization.
381 * wangle::IOThreadPoolExecutor executor(max_concurrency_level);
382 * folly::Baton<> done;
383 * doEagerInitVia(executor, &done);
384 * done.wait(); // or 'timed_wait', or spin with 'try_wait'
387 void doEagerInitVia(Executor& exe, folly::Baton<>* done = nullptr);
389 // Destroy all singletons; when complete, the vault can't create
390 // singletons once again until reenableInstances() is called.
391 void destroyInstances();
393 // Enable re-creating singletons after destroyInstances() was called.
394 void reenableInstances();
396 // For testing; how many registered and living singletons we have.
397 size_t registeredSingletonCount() const {
398 RWSpinLock::ReadHolder rh(&mutex_);
400 return singletons_.size();
404 * Flips to true if eager initialization was used, and has completed.
405 * Never set to true if "doEagerInit()" or "doEagerInitVia" never called.
407 bool eagerInitComplete() const;
409 size_t livingSingletonCount() const {
410 RWSpinLock::ReadHolder rh(&mutex_);
413 for (const auto& p : singletons_) {
414 if (p.second->hasLiveInstance()) {
422 // A well-known vault; you can actually have others, but this is the
424 static SingletonVault* singleton() {
425 return singleton<>();
428 // Gets singleton vault for any Tag. Non-default tag should be used in unit
430 template <typename VaultTag = detail::DefaultTag>
431 static SingletonVault* singleton() {
432 static SingletonVault* vault =
433 detail::createGlobal<SingletonVault, VaultTag>();
437 typedef std::string(*StackTraceGetterPtr)();
439 static std::atomic<StackTraceGetterPtr>& stackTraceGetter() {
440 static std::atomic<StackTraceGetterPtr>* stackTraceGetterPtr =
441 detail::createGlobal<std::atomic<StackTraceGetterPtr>,
443 return *stackTraceGetterPtr;
447 template <typename T>
448 friend struct detail::SingletonHolder;
450 // The two stages of life for a vault, as mentioned in the class comment.
451 enum class SingletonVaultState {
456 // Each singleton in the vault can be in two states: dead
457 // (registered but never created), living (CreateFunc returned an instance).
459 void stateCheck(SingletonVaultState expected,
460 const char* msg="Unexpected singleton state change") {
461 if (expected != state_) {
462 throw std::logic_error(msg);
466 // This method only matters if registrationComplete() is never called.
467 // Otherwise destroyInstances is scheduled to be executed atexit.
469 // Initializes static object, which calls destroyInstances on destruction.
470 // Used to have better deletion ordering with singleton not managed by
471 // folly::Singleton. The desruction will happen in the following order:
472 // 1. Singletons, not managed by folly::Singleton, which were created after
473 // any of the singletons managed by folly::Singleton was requested.
474 // 2. All singletons managed by folly::Singleton
475 // 3. Singletons, not managed by folly::Singleton, which were created before
476 // any of the singletons managed by folly::Singleton was requested.
477 static void scheduleDestroyInstances();
479 typedef std::unordered_map<detail::TypeDescriptor,
480 detail::SingletonHolderBase*,
481 detail::TypeDescriptorHasher> SingletonMap;
483 mutable folly::RWSpinLock mutex_;
484 SingletonMap singletons_;
485 std::unordered_set<detail::SingletonHolderBase*> eagerInitSingletons_;
486 std::vector<detail::TypeDescriptor> creation_order_;
487 SingletonVaultState state_{SingletonVaultState::Running};
488 bool registrationComplete_{false};
489 folly::RWSpinLock stateMutex_;
490 Type type_{Type::Relaxed};
493 // This is the wrapper class that most users actually interact with.
494 // It allows for simple access to registering and instantiating
495 // singletons. Create instances of this class in the global scope of
496 // type Singleton<T> to register your singleton for later access via
497 // Singleton<T>::try_get().
498 template <typename T,
499 typename Tag = detail::DefaultTag,
500 typename VaultTag = detail::DefaultTag /* for testing */>
503 typedef std::function<T*(void)> CreateFunc;
504 typedef std::function<void(T*)> TeardownFunc;
506 // Generally your program life cycle should be fine with calling
507 // get() repeatedly rather than saving the reference, and then not
508 // call get() during process shutdown.
509 FOLLY_DEPRECATED("Replaced by try_get")
510 static T* get() { return getEntry().get(); }
512 // If, however, you do need to hold a reference to the specific
513 // singleton, you can try to do so with a weak_ptr. Avoid this when
514 // possible but the inability to lock the weak pointer can be a
515 // signal that the vault has been destroyed.
516 FOLLY_DEPRECATED("Replaced by try_get")
517 static std::weak_ptr<T> get_weak() { return getEntry().get_weak(); }
519 // Preferred alternative to get_weak, it returns shared_ptr that can be
520 // stored; a singleton won't be destroyed unless shared_ptr is destroyed.
521 // Avoid holding these shared_ptrs beyond the scope of a function;
522 // don't put them in member variables, always use try_get() instead
524 // try_get() can return nullptr if the singleton was destroyed, caller is
525 // responsible for handling nullptr return
526 static std::shared_ptr<T> try_get() {
527 return getEntry().try_get();
530 static folly::ReadMostlySharedPtr<T> try_get_fast() {
531 return getEntry().try_get_fast();
534 explicit Singleton(std::nullptr_t /* _ */ = nullptr,
535 typename Singleton::TeardownFunc t = nullptr)
536 : Singleton([]() { return new T; }, std::move(t)) {}
538 explicit Singleton(typename Singleton::CreateFunc c,
539 typename Singleton::TeardownFunc t = nullptr) {
541 throw std::logic_error(
542 "nullptr_t should be passed if you want T to be default constructed");
545 auto vault = SingletonVault::singleton<VaultTag>();
546 getEntry().registerSingleton(std::move(c), getTeardownFunc(std::move(t)));
547 vault->registerSingleton(&getEntry());
551 * Should be instantiated as soon as "doEagerInit[Via]" is called.
552 * Singletons are usually lazy-loaded (built on-demand) but for those which
553 * are known to be needed, to avoid the potential lag for objects that take
554 * long to construct during runtime, there is an option to make sure these
555 * are built up-front.
558 * Singleton<Foo> gFooInstance = Singleton<Foo>(...).shouldEagerInit();
560 * Or alternately, define the singleton as usual, and say
561 * gFooInstance.shouldEagerInit();
563 * at some point prior to calling registrationComplete().
564 * Then doEagerInit() or doEagerInitVia(Executor*) can be called.
566 Singleton& shouldEagerInit() {
567 auto vault = SingletonVault::singleton<VaultTag>();
568 vault->addEagerInitSingleton(&getEntry());
573 * Construct and inject a mock singleton which should be used only from tests.
574 * Unlike regular singletons which are initialized once per process lifetime,
575 * mock singletons live for the duration of a test. This means that one process
576 * running multiple tests can initialize and register the same singleton
577 * multiple times. This functionality should be used only from tests
578 * since it relaxes validation and performance in order to be able to perform
579 * the injection. The returned mock singleton is functionality identical to
580 * regular singletons.
582 static void make_mock(std::nullptr_t /* c */ = nullptr,
583 typename Singleton<T>::TeardownFunc t = nullptr) {
584 make_mock([]() { return new T; }, t);
587 static void make_mock(CreateFunc c,
588 typename Singleton<T>::TeardownFunc t = nullptr) {
590 throw std::logic_error(
591 "nullptr_t should be passed if you want T to be default constructed");
594 auto& entry = getEntry();
596 entry.registerSingletonMock(c, getTeardownFunc(t));
600 inline static detail::SingletonHolder<T>& getEntry() {
601 return detail::SingletonHolder<T>::template singleton<Tag, VaultTag>();
604 // Construct TeardownFunc.
605 static typename detail::SingletonHolder<T>::TeardownFunc getTeardownFunc(
608 return [](T* v) { delete v; };
615 template <typename T, typename Tag = detail::DefaultTag>
616 class LeakySingleton {
618 using CreateFunc = std::function<T*()>;
620 LeakySingleton() : LeakySingleton([] { return new T(); }) {}
622 explicit LeakySingleton(CreateFunc createFunc) {
623 auto& entry = entryInstance();
624 if (entry.state != State::NotRegistered) {
625 LOG(FATAL) << "Double registration of singletons of the same "
626 << "underlying type; check for multiple definitions "
627 << "of type folly::LeakySingleton<" + entry.type_.name() + ">";
629 entry.createFunc = createFunc;
630 entry.state = State::Dead;
633 static T& get() { return instance(); }
636 enum class State { NotRegistered, Dead, Living };
640 Entry(const Entry&) = delete;
641 Entry& operator=(const Entry&) = delete;
643 std::atomic<State> state{State::NotRegistered};
645 CreateFunc createFunc;
647 detail::TypeDescriptor type_{typeid(T), typeid(Tag)};
650 static Entry& entryInstance() {
651 static auto entry = detail::createGlobal<Entry, Tag>();
655 static T& instance() {
656 auto& entry = entryInstance();
657 if (UNLIKELY(entry.state != State::Living)) {
664 static void createInstance() {
665 auto& entry = entryInstance();
667 std::lock_guard<std::mutex> lg(entry.mutex);
668 if (entry.state == State::Living) {
672 if (entry.state == State::NotRegistered) {
673 auto ptr = SingletonVault::stackTraceGetter().load();
674 LOG(FATAL) << "Creating instance for unregistered singleton: "
675 << entry.type_.name() << "\n"
677 << "\n" << (ptr ? (*ptr)() : "(not available)");
680 entry.ptr = entry.createFunc();
681 entry.state = State::Living;
686 #include <folly/Singleton-inl.h>