folly/Singleton-inl.h

   1 /*
   2  * Copyright 2016 Facebook, Inc.
   3  *
   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
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 namespace folly {
  18
  19 namespace detail {
  20
  21 template <typename T>
  22 template <typename Tag, typename VaultTag>
  23 SingletonHolder<T>& SingletonHolder<T>::singleton() {
  24   static auto entry =
  25       createGlobal<SingletonHolder<T>, std::pair<Tag, VaultTag>>([]() {
  26         return new SingletonHolder<T>({typeid(T), typeid(Tag)},
  27                                       *SingletonVault::singleton<VaultTag>());
  28       });
  29   return *entry;
  30 }
  31
  32 [[noreturn]] void singletonWarnDoubleRegistrationAndAbort(
  33     const TypeDescriptor& type);
  34
  35 template <typename T>
  36 void SingletonHolder<T>::registerSingleton(CreateFunc c, TeardownFunc t) {
  37   std::lock_guard<std::mutex> entry_lock(mutex_);
  38
  39   if (state_ != SingletonHolderState::NotRegistered) {
  40     /* Possible causes:
  41      *
  42      * You have two instances of the same
  43      * folly::Singleton<Class>. Probably because you define the
  44      * singleton in a header included in multiple places? In general,
  45      * folly::Singleton shouldn't be in the header, only off in some
  46      * anonymous namespace in a cpp file. Code needing the singleton
  47      * will find it when that code references folly::Singleton<Class>.
  48      *
  49      * Alternatively, you could have 2 singletons with the same type
  50      * defined with a different name in a .cpp (source) file. For
  51      * example:
  52      *
  53      * Singleton<int> a([] { return new int(3); });
  54      * Singleton<int> b([] { return new int(4); });
  55      *
  56      */
  57     singletonWarnDoubleRegistrationAndAbort(type_);
  58   }
  59
  60   create_ = std::move(c);
  61   teardown_ = std::move(t);
  62
  63   state_ = SingletonHolderState::Dead;
  64 }
  65
  66 template <typename T>
  67 void SingletonHolder<T>::registerSingletonMock(CreateFunc c, TeardownFunc t) {
  68   if (state_ == SingletonHolderState::NotRegistered) {
  69     LOG(FATAL)
  70         << "Registering mock before singleton was registered: " << type_.name();
  71   }
  72   destroyInstance();
  73
  74   std::lock_guard<std::mutex> entry_lock(mutex_);
  75
  76   create_ = std::move(c);
  77   teardown_ = std::move(t);
  78 }
  79
  80 template <typename T>
  81 T* SingletonHolder<T>::get() {
  82   if (LIKELY(state_.load(std::memory_order_acquire) ==
  83              SingletonHolderState::Living)) {
  84     return instance_ptr_;
  85   }
  86   createInstance();
  87
  88   if (instance_weak_.expired()) {
  89     throw std::runtime_error(
  90         "Raw pointer to a singleton requested after its destruction."
  91         " Singleton type is: " +
  92         type_.name());
  93   }
  94
  95   return instance_ptr_;
  96 }
  97
  98 template <typename T>
  99 std::weak_ptr<T> SingletonHolder<T>::get_weak() {
 100   if (UNLIKELY(state_.load(std::memory_order_acquire) !=
 101                SingletonHolderState::Living)) {
 102     createInstance();
 103   }
 104
 105   return instance_weak_;
 106 }
 107
 108 template <typename T>
 109 std::shared_ptr<T> SingletonHolder<T>::try_get() {
 110   if (UNLIKELY(state_.load(std::memory_order_acquire) !=
 111                SingletonHolderState::Living)) {
 112     createInstance();
 113   }
 114
 115   return instance_weak_.lock();
 116 }
 117
 118 template <typename T>
 119 folly::ReadMostlySharedPtr<T> SingletonHolder<T>::try_get_fast() {
 120   if (UNLIKELY(state_.load(std::memory_order_acquire) !=
 121                SingletonHolderState::Living)) {
 122     createInstance();
 123   }
 124
 125   return instance_weak_fast_.lock();
 126 }
 127
 128 template <typename T>
 129 TypeDescriptor SingletonHolder<T>::type() {
 130   return type_;
 131 }
 132
 133 template <typename T>
 134 bool SingletonHolder<T>::hasLiveInstance() {
 135   return !instance_weak_.expired();
 136 }
 137
 138 template <typename T>
 139 void SingletonHolder<T>::destroyInstance() {
 140   state_ = SingletonHolderState::Dead;
 141   instance_.reset();
 142   if (destroy_baton_) {
 143     auto wait_result = destroy_baton_->timed_wait(
 144       std::chrono::steady_clock::now() + kDestroyWaitTime);
 145     if (!wait_result) {
 146       print_destructor_stack_trace_->store(true);
 147       LOG(ERROR) << "Singleton of type " << type_.name() << " has a "
 148                  << "living reference at destroyInstances time; beware! Raw "
 149                  << "pointer is " << instance_ptr_ << ". It is very likely "
 150                  << "that some other singleton is holding a shared_ptr to it. "
 151                  << "Make sure dependencies between these singletons are "
 152                  << "properly defined.";
 153     }
 154   }
 155 }
 156
 157 template <typename T>
 158 SingletonHolder<T>::SingletonHolder(TypeDescriptor type__,
 159                                     SingletonVault& vault) :
 160     type_(type__), vault_(vault) {
 161 }
 162
 163 template <typename T>
 164 bool SingletonHolder<T>::creationStarted() {
 165   // If alive, then creation was of course started.
 166   // This is flipped after creating_thread_ was set, and before it was reset.
 167   if (state_.load(std::memory_order_acquire) == SingletonHolderState::Living) {
 168     return true;
 169   }
 170
 171   // Not yet built.  Is it currently in progress?
 172   if (creating_thread_.load(std::memory_order_acquire) != std::thread::id()) {
 173     return true;
 174   }
 175
 176   return false;
 177 }
 178
 179 template <typename T>
 180 void SingletonHolder<T>::createInstance() {
 181   if (creating_thread_.load(std::memory_order_acquire) ==
 182         std::this_thread::get_id()) {
 183     LOG(FATAL) << "circular singleton dependency: " << type_.name();
 184   }
 185
 186   std::lock_guard<std::mutex> entry_lock(mutex_);
 187   if (state_.load(std::memory_order_acquire) == SingletonHolderState::Living) {
 188     return;
 189   }
 190   if (state_.load(std::memory_order_acquire) ==
 191         SingletonHolderState::NotRegistered) {
 192     auto ptr = SingletonVault::stackTraceGetter().load();
 193     LOG(FATAL) << "Creating instance for unregistered singleton: "
 194                << type_.name() << "\n"
 195                << "Stacktrace:"
 196                << "\n" << (ptr ? (*ptr)() : "(not available)");
 197   }
 198
 199   if (state_.load(std::memory_order_acquire) == SingletonHolderState::Living) {
 200     return;
 201   }
 202
 203   SCOPE_EXIT {
 204     // Clean up creator thread when complete, and also, in case of errors here,
 205     // so that subsequent attempts don't think this is still in the process of
 206     // being built.
 207     creating_thread_.store(std::thread::id(), std::memory_order_release);
 208   };
 209
 210   creating_thread_.store(std::this_thread::get_id(), std::memory_order_release);
 211
 212   RWSpinLock::ReadHolder rh(&vault_.stateMutex_);
 213   if (vault_.state_ == SingletonVault::SingletonVaultState::Quiescing) {
 214     return;
 215   }
 216
 217   auto destroy_baton = std::make_shared<folly::Baton<>>();
 218   auto print_destructor_stack_trace =
 219     std::make_shared<std::atomic<bool>>(false);
 220   auto teardown = teardown_;
 221   auto type_name = type_.name();
 222
 223   // Can't use make_shared -- no support for a custom deleter, sadly.
 224   std::shared_ptr<T> instance(
 225     create_(),
 226     [destroy_baton, print_destructor_stack_trace, teardown, type_name]
 227     (T* instance_ptr) mutable {
 228       teardown(instance_ptr);
 229       destroy_baton->post();
 230       if (print_destructor_stack_trace->load()) {
 231         std::string output = "Singleton " + type_name + " was destroyed.\n";
 232
 233         auto stack_trace_getter = SingletonVault::stackTraceGetter().load();
 234         auto stack_trace = stack_trace_getter ? stack_trace_getter() : "";
 235         if (stack_trace.empty()) {
 236           output += "Failed to get destructor stack trace.";
 237         } else {
 238           output += "Destructor stack trace:\n";
 239           output += stack_trace;
 240         }
 241
 242         LOG(ERROR) << output;
 243       }
 244     });
 245
 246   // We should schedule destroyInstances() only after the singleton was
 247   // created. This will ensure it will be destroyed before singletons,
 248   // not managed by folly::Singleton, which were initialized in its
 249   // constructor
 250   SingletonVault::scheduleDestroyInstances();
 251
 252   instance_weak_ = instance;
 253   instance_ptr_ = instance.get();
 254   instance_.reset(std::move(instance));
 255   instance_weak_fast_ = instance_;
 256
 257   destroy_baton_ = std::move(destroy_baton);
 258   print_destructor_stack_trace_ = std::move(print_destructor_stack_trace);
 259
 260   // This has to be the last step, because once state is Living other threads
 261   // may access instance and instance_weak w/o synchronization.
 262   state_.store(SingletonHolderState::Living, std::memory_order_release);
 263
 264   {
 265     RWSpinLock::WriteHolder wh(&vault_.mutex_);
 266     vault_.creation_order_.push_back(type_);
 267   }
 268 }
 269
 270 }
 271
 272 }