2 * Copyright 2015 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/futures/Future.h>
113 #include <folly/io/async/Request.h>
119 #include <condition_variable>
121 #include <unordered_map>
122 #include <unordered_set>
123 #include <functional>
127 #include <glog/logging.h>
129 // use this guard to handleSingleton breaking change in 3rd party code
130 #ifndef FOLLY_SINGLETON_TRY_GET
131 #define FOLLY_SINGLETON_TRY_GET
136 // For actual usage, please see the Singleton<T> class at the bottom
137 // of this file; that is what you will actually interact with.
139 // SingletonVault is the class that manages singleton instances. It
140 // is unaware of the underlying types of singletons, and simply
141 // manages lifecycles and invokes CreateFunc and TeardownFunc when
142 // appropriate. In general, you won't need to interact with the
143 // SingletonVault itself.
145 // A vault goes through a few stages of life:
147 // 1. Registration phase; singletons can be registered:
148 // a) Strict: no singleton can be created in this stage.
149 // b) Relaxed: singleton can be created (the default vault is Relaxed).
150 // 2. registrationComplete() has been called; singletons can no
151 // longer be registered, but they can be created.
152 // 3. A vault can return to stage 1 when destroyInstances is called.
154 // In general, you don't need to worry about any of the above; just
155 // ensure registrationComplete() is called near the top of your main()
156 // function, otherwise no singletons can be instantiated.
158 class SingletonVault;
162 struct DefaultTag {};
164 // A TypeDescriptor is the unique handle for a given singleton. It is
165 // a combinaiton of the type and of the optional name, and is used as
166 // a key in unordered_maps.
167 class TypeDescriptor {
169 TypeDescriptor(const std::type_info& ti,
170 const std::type_info& tag_ti)
171 : ti_(ti), tag_ti_(tag_ti) {
174 TypeDescriptor(const TypeDescriptor& other)
175 : ti_(other.ti_), tag_ti_(other.tag_ti_) {
178 TypeDescriptor& operator=(const TypeDescriptor& other) {
179 if (this != &other) {
181 tag_ti_ = other.tag_ti_;
187 std::string name() const {
188 auto ret = demangle(ti_.name());
189 if (tag_ti_ != std::type_index(typeid(DefaultTag))) {
191 ret += demangle(tag_ti_.name());
193 return ret.toStdString();
196 friend class TypeDescriptorHasher;
198 bool operator==(const TypeDescriptor& other) const {
199 return ti_ == other.ti_ && tag_ti_ == other.tag_ti_;
204 std::type_index tag_ti_;
207 class TypeDescriptorHasher {
209 size_t operator()(const TypeDescriptor& ti) const {
210 return folly::hash::hash_combine(ti.ti_, ti.tag_ti_);
214 // This interface is used by SingletonVault to interact with SingletonHolders.
215 // Having a non-template interface allows SingletonVault to keep a list of all
217 class SingletonHolderBase {
219 virtual ~SingletonHolderBase() = default;
221 virtual TypeDescriptor type() = 0;
222 virtual bool hasLiveInstance() = 0;
223 virtual void createInstance() = 0;
224 virtual bool creationStarted() = 0;
225 virtual void destroyInstance() = 0;
228 static constexpr std::chrono::seconds kDestroyWaitTime{5};
231 // An actual instance of a singleton, tracking the instance itself,
232 // its state as described above, and the create and teardown
234 template <typename T>
235 struct SingletonHolder : public SingletonHolderBase {
237 typedef std::function<void(T*)> TeardownFunc;
238 typedef std::function<T*(void)> CreateFunc;
240 template <typename Tag, typename VaultTag>
241 inline static SingletonHolder<T>& singleton();
244 inline std::weak_ptr<T> get_weak();
246 void registerSingleton(CreateFunc c, TeardownFunc t);
247 void registerSingletonMock(CreateFunc c, TeardownFunc t);
248 virtual TypeDescriptor type() override;
249 virtual bool hasLiveInstance() override;
250 virtual void createInstance() override;
251 virtual bool creationStarted() override;
252 virtual void destroyInstance() override;
255 SingletonHolder(TypeDescriptor type, SingletonVault& vault);
257 enum class SingletonHolderState {
263 TypeDescriptor type_;
264 SingletonVault& vault_;
266 // mutex protects the entire entry during construction/destruction
269 // State of the singleton entry. If state is Living, instance_ptr and
270 // instance_weak can be safely accessed w/o synchronization.
271 std::atomic<SingletonHolderState> state_{SingletonHolderState::NotRegistered};
273 // the thread creating the singleton (only valid while creating an object)
274 std::atomic<std::thread::id> creating_thread_;
276 // The singleton itself and related functions.
278 // holds a shared_ptr to singleton instance, set when state is changed from
279 // Dead to Living. Reset when state is changed from Living to Dead.
280 std::shared_ptr<T> instance_;
281 // weak_ptr to the singleton instance, set when state is changed from Dead
282 // to Living. We never write to this object after initialization, so it is
283 // safe to read it from different threads w/o synchronization if we know
284 // that state is set to Living
285 std::weak_ptr<T> instance_weak_;
286 // Time we wait on destroy_baton after releasing Singleton shared_ptr.
287 std::shared_ptr<folly::Baton<>> destroy_baton_;
288 T* instance_ptr_ = nullptr;
289 CreateFunc create_ = nullptr;
290 TeardownFunc teardown_ = nullptr;
292 std::shared_ptr<std::atomic<bool>> print_destructor_stack_trace_;
294 SingletonHolder(const SingletonHolder&) = delete;
295 SingletonHolder& operator=(const SingletonHolder&) = delete;
296 SingletonHolder& operator=(SingletonHolder&&) = delete;
297 SingletonHolder(SingletonHolder&&) = delete;
302 class SingletonVault {
305 Strict, // Singletons can't be created before registrationComplete()
306 Relaxed, // Singletons can be created before registrationComplete()
309 explicit SingletonVault(Type type = Type::Relaxed) : type_(type) {}
311 // Destructor is only called by unit tests to check destroyInstances.
314 typedef std::function<void(void*)> TeardownFunc;
315 typedef std::function<void*(void)> CreateFunc;
317 // Ensure that Singleton has not been registered previously and that
318 // registration is not complete. If validations succeeds,
319 // register a singleton of a given type with the create and teardown
321 void registerSingleton(detail::SingletonHolderBase* entry) {
322 RWSpinLock::ReadHolder rh(&stateMutex_);
324 stateCheck(SingletonVaultState::Running);
326 if (UNLIKELY(registrationComplete_)) {
327 throw std::logic_error(
328 "Registering singleton after registrationComplete().");
331 RWSpinLock::ReadHolder rhMutex(&mutex_);
332 CHECK_THROW(singletons_.find(entry->type()) == singletons_.end(),
335 RWSpinLock::UpgradedHolder wh(&mutex_);
336 singletons_[entry->type()] = entry;
340 * Called by `Singleton<T>.shouldEagerInit()` to ensure the instance
341 * is built when `doEagerInit[Via]` is called; see those methods
344 void addEagerInitSingleton(detail::SingletonHolderBase* entry) {
345 RWSpinLock::ReadHolder rh(&stateMutex_);
347 stateCheck(SingletonVaultState::Running);
349 if (UNLIKELY(registrationComplete_)) {
350 throw std::logic_error(
351 "Registering for eager-load after registrationComplete().");
354 RWSpinLock::ReadHolder rhMutex(&mutex_);
355 CHECK_THROW(singletons_.find(entry->type()) != singletons_.end(),
358 RWSpinLock::UpgradedHolder wh(&mutex_);
359 eagerInitSingletons_.insert(entry);
362 // Mark registration is complete; no more singletons can be
363 // registered at this point.
364 void registrationComplete() {
365 RequestContext::saveContext();
366 std::atexit([](){ SingletonVault::singleton()->destroyInstances(); });
368 RWSpinLock::WriteHolder wh(&stateMutex_);
370 stateCheck(SingletonVaultState::Running);
372 if (type_ == Type::Strict) {
373 for (const auto& p : singletons_) {
374 if (p.second->hasLiveInstance()) {
375 throw std::runtime_error(
376 "Singleton created before registration was complete.");
381 registrationComplete_ = true;
385 * Initialize all singletons which were marked as eager-initialized
386 * (using `shouldEagerInit()`). No return value. Propagates exceptions
387 * from constructors / create functions, as is the usual case when calling
388 * for example `Singleton<Foo>::get_weak()`.
391 std::unordered_set<detail::SingletonHolderBase*> singletonSet;
393 RWSpinLock::ReadHolder rh(&stateMutex_);
394 stateCheck(SingletonVaultState::Running);
395 if (UNLIKELY(!registrationComplete_)) {
396 throw std::logic_error("registrationComplete() not yet called");
398 singletonSet = eagerInitSingletons_; // copy set of pointers
401 for (auto *single : singletonSet) {
402 single->createInstance();
407 * Schedule eager singletons' initializations through the given executor.
408 * Return a future which is fulfilled after all the initialization functions
411 Future<Unit> doEagerInitVia(Executor* exe) {
412 std::unordered_set<detail::SingletonHolderBase*> singletonSet;
414 RWSpinLock::ReadHolder rh(&stateMutex_);
415 stateCheck(SingletonVaultState::Running);
416 if (UNLIKELY(!registrationComplete_)) {
417 throw std::logic_error("registrationComplete() not yet called");
419 singletonSet = eagerInitSingletons_; // copy set of pointers
422 std::vector<Future<Unit>> resultFutures;
423 for (auto* single : singletonSet) {
424 resultFutures.emplace_back(via(exe).then([single] {
425 if (!single->creationStarted()) {
426 single->createInstance();
431 return collectAll(resultFutures).via(exe).then();
434 // Destroy all singletons; when complete, the vault can't create
435 // singletons once again until reenableInstances() is called.
436 void destroyInstances();
438 // Enable re-creating singletons after destroyInstances() was called.
439 void reenableInstances();
441 // For testing; how many registered and living singletons we have.
442 size_t registeredSingletonCount() const {
443 RWSpinLock::ReadHolder rh(&mutex_);
445 return singletons_.size();
448 size_t livingSingletonCount() const {
449 RWSpinLock::ReadHolder rh(&mutex_);
452 for (const auto& p : singletons_) {
453 if (p.second->hasLiveInstance()) {
461 // A well-known vault; you can actually have others, but this is the
463 static SingletonVault* singleton() {
464 return singleton<>();
467 // Gets singleton vault for any Tag. Non-default tag should be used in unit
469 template <typename VaultTag = detail::DefaultTag>
470 static SingletonVault* singleton() {
471 static SingletonVault* vault = new SingletonVault();
475 typedef std::string(*StackTraceGetterPtr)();
477 static std::atomic<StackTraceGetterPtr>& stackTraceGetter() {
478 static std::atomic<StackTraceGetterPtr> stackTraceGetterPtr;
479 return stackTraceGetterPtr;
483 template <typename T>
484 friend struct detail::SingletonHolder;
486 // The two stages of life for a vault, as mentioned in the class comment.
487 enum class SingletonVaultState {
492 // Each singleton in the vault can be in two states: dead
493 // (registered but never created), living (CreateFunc returned an instance).
495 void stateCheck(SingletonVaultState expected,
496 const char* msg="Unexpected singleton state change") {
497 if (expected != state_) {
498 throw std::logic_error(msg);
502 // This method only matters if registrationComplete() is never called.
503 // Otherwise destroyInstances is scheduled to be executed atexit.
505 // Initializes static object, which calls destroyInstances on destruction.
506 // Used to have better deletion ordering with singleton not managed by
507 // folly::Singleton. The desruction will happen in the following order:
508 // 1. Singletons, not managed by folly::Singleton, which were created after
509 // any of the singletons managed by folly::Singleton was requested.
510 // 2. All singletons managed by folly::Singleton
511 // 3. Singletons, not managed by folly::Singleton, which were created before
512 // any of the singletons managed by folly::Singleton was requested.
513 static void scheduleDestroyInstances();
515 typedef std::unordered_map<detail::TypeDescriptor,
516 detail::SingletonHolderBase*,
517 detail::TypeDescriptorHasher> SingletonMap;
519 mutable folly::RWSpinLock mutex_;
520 SingletonMap singletons_;
521 std::unordered_set<detail::SingletonHolderBase*> eagerInitSingletons_;
522 std::vector<detail::TypeDescriptor> creation_order_;
523 SingletonVaultState state_{SingletonVaultState::Running};
524 bool registrationComplete_{false};
525 folly::RWSpinLock stateMutex_;
526 Type type_{Type::Relaxed};
529 // This is the wrapper class that most users actually interact with.
530 // It allows for simple access to registering and instantiating
531 // singletons. Create instances of this class in the global scope of
532 // type Singleton<T> to register your singleton for later access via
533 // Singleton<T>::try_get().
534 template <typename T,
535 typename Tag = detail::DefaultTag,
536 typename VaultTag = detail::DefaultTag /* for testing */>
539 typedef std::function<T*(void)> CreateFunc;
540 typedef std::function<void(T*)> TeardownFunc;
542 // Generally your program life cycle should be fine with calling
543 // get() repeatedly rather than saving the reference, and then not
544 // call get() during process shutdown.
545 static T* get() __attribute__ ((__deprecated__("Replaced by try_get"))) {
546 return getEntry().get();
549 // If, however, you do need to hold a reference to the specific
550 // singleton, you can try to do so with a weak_ptr. Avoid this when
551 // possible but the inability to lock the weak pointer can be a
552 // signal that the vault has been destroyed.
553 static std::weak_ptr<T> get_weak() {
554 return getEntry().get_weak();
557 // Preferred alternative to get_weak, it returns shared_ptr that can be
558 // stored; a singleton won't be destroyed unless shared_ptr is destroyed.
559 // Avoid holding these shared_ptrs beyond the scope of a function;
560 // don't put them in member variables, always use try_get() instead
561 static std::shared_ptr<T> try_get() {
562 auto ret = get_weak().lock();
565 "folly::Singleton<" << getEntry().type().name() <<
566 ">::get_weak() called on destructed singleton; "
567 "returning nullptr, possible segfault coming";
572 explicit Singleton(std::nullptr_t _ = nullptr,
573 typename Singleton::TeardownFunc t = nullptr) :
574 Singleton ([]() { return new T; }, std::move(t)) {
577 explicit Singleton(typename Singleton::CreateFunc c,
578 typename Singleton::TeardownFunc t = nullptr) {
580 throw std::logic_error(
581 "nullptr_t should be passed if you want T to be default constructed");
584 auto vault = SingletonVault::singleton<VaultTag>();
585 getEntry().registerSingleton(std::move(c), getTeardownFunc(std::move(t)));
586 vault->registerSingleton(&getEntry());
590 * Should be instantiated as soon as "doEagerInit[Via]" is called.
591 * Singletons are usually lazy-loaded (built on-demand) but for those which
592 * are known to be needed, to avoid the potential lag for objects that take
593 * long to construct during runtime, there is an option to make sure these
594 * are built up-front.
597 * Singleton<Foo> gFooInstance = Singleton<Foo>(...).shouldEagerInit();
599 * Or alternately, define the singleton as usual, and say
600 * gFooInstance.shouldEagerInit();
602 * at some point prior to calling registrationComplete().
603 * Then doEagerInit() or doEagerInitVia(Executor*) can be called.
605 Singleton& shouldEagerInit() {
606 auto vault = SingletonVault::singleton<VaultTag>();
607 vault->addEagerInitSingleton(&getEntry());
612 * Construct and inject a mock singleton which should be used only from tests.
613 * Unlike regular singletons which are initialized once per process lifetime,
614 * mock singletons live for the duration of a test. This means that one process
615 * running multiple tests can initialize and register the same singleton
616 * multiple times. This functionality should be used only from tests
617 * since it relaxes validation and performance in order to be able to perform
618 * the injection. The returned mock singleton is functionality identical to
619 * regular singletons.
621 static void make_mock(std::nullptr_t c = nullptr,
622 typename Singleton<T>::TeardownFunc t = nullptr) {
623 make_mock([]() { return new T; }, t);
626 static void make_mock(CreateFunc c,
627 typename Singleton<T>::TeardownFunc t = nullptr) {
629 throw std::logic_error(
630 "nullptr_t should be passed if you want T to be default constructed");
633 auto& entry = getEntry();
635 entry.registerSingletonMock(c, getTeardownFunc(t));
639 inline static detail::SingletonHolder<T>& getEntry() {
640 return detail::SingletonHolder<T>::template singleton<Tag, VaultTag>();
643 // Construct TeardownFunc.
644 static typename detail::SingletonHolder<T>::TeardownFunc getTeardownFunc(
647 return [](T* v) { delete v; };
656 #include <folly/Singleton-inl.h>