registry-inl.h 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314
  1. // Copyright(c) 2015-present, Gabi Melman & spdlog contributors.
  2. // Distributed under the MIT License (http://opensource.org/licenses/MIT)
  3. #pragma once
  4. #ifndef SPDLOG_HEADER_ONLY
  5. # include <spdlog/details/registry.h>
  6. #endif
  7. #include <spdlog/common.h>
  8. #include <spdlog/details/periodic_worker.h>
  9. #include <spdlog/logger.h>
  10. #include <spdlog/pattern_formatter.h>
  11. #ifndef SPDLOG_DISABLE_DEFAULT_LOGGER
  12. // support for the default stdout color logger
  13. # ifdef _WIN32
  14. # include <spdlog/sinks/wincolor_sink.h>
  15. # else
  16. # include <spdlog/sinks/ansicolor_sink.h>
  17. # endif
  18. #endif // SPDLOG_DISABLE_DEFAULT_LOGGER
  19. #include <chrono>
  20. #include <functional>
  21. #include <memory>
  22. #include <string>
  23. #include <unordered_map>
  24. namespace spdlog {
  25. namespace details {
  26. SPDLOG_INLINE registry::registry()
  27. : formatter_(new pattern_formatter())
  28. {
  29. #ifndef SPDLOG_DISABLE_DEFAULT_LOGGER
  30. // create default logger (ansicolor_stdout_sink_mt or wincolor_stdout_sink_mt in windows).
  31. # ifdef _WIN32
  32. auto color_sink = std::make_shared<sinks::wincolor_stdout_sink_mt>();
  33. # else
  34. auto color_sink = std::make_shared<sinks::ansicolor_stdout_sink_mt>();
  35. # endif
  36. const char *default_logger_name = "";
  37. default_logger_ = std::make_shared<spdlog::logger>(default_logger_name, std::move(color_sink));
  38. loggers_[default_logger_name] = default_logger_;
  39. #endif // SPDLOG_DISABLE_DEFAULT_LOGGER
  40. }
  41. SPDLOG_INLINE registry::~registry() = default;
  42. SPDLOG_INLINE void registry::register_logger(std::shared_ptr<logger> new_logger)
  43. {
  44. std::lock_guard<std::mutex> lock(logger_map_mutex_);
  45. register_logger_(std::move(new_logger));
  46. }
  47. SPDLOG_INLINE void registry::initialize_logger(std::shared_ptr<logger> new_logger)
  48. {
  49. std::lock_guard<std::mutex> lock(logger_map_mutex_);
  50. new_logger->set_formatter(formatter_->clone());
  51. if (err_handler_)
  52. {
  53. new_logger->set_error_handler(err_handler_);
  54. }
  55. // set new level according to previously configured level or default level
  56. auto it = log_levels_.find(new_logger->name());
  57. auto new_level = it != log_levels_.end() ? it->second : global_log_level_;
  58. new_logger->set_level(new_level);
  59. new_logger->flush_on(flush_level_);
  60. if (backtrace_n_messages_ > 0)
  61. {
  62. new_logger->enable_backtrace(backtrace_n_messages_);
  63. }
  64. if (automatic_registration_)
  65. {
  66. register_logger_(std::move(new_logger));
  67. }
  68. }
  69. SPDLOG_INLINE std::shared_ptr<logger> registry::get(const std::string &logger_name)
  70. {
  71. std::lock_guard<std::mutex> lock(logger_map_mutex_);
  72. auto found = loggers_.find(logger_name);
  73. return found == loggers_.end() ? nullptr : found->second;
  74. }
  75. SPDLOG_INLINE std::shared_ptr<logger> registry::default_logger()
  76. {
  77. std::lock_guard<std::mutex> lock(logger_map_mutex_);
  78. return default_logger_;
  79. }
  80. // Return raw ptr to the default logger.
  81. // To be used directly by the spdlog default api (e.g. spdlog::info)
  82. // This make the default API faster, but cannot be used concurrently with set_default_logger().
  83. // e.g do not call set_default_logger() from one thread while calling spdlog::info() from another.
  84. SPDLOG_INLINE logger *registry::get_default_raw()
  85. {
  86. return default_logger_.get();
  87. }
  88. // set default logger.
  89. // default logger is stored in default_logger_ (for faster retrieval) and in the loggers_ map.
  90. SPDLOG_INLINE void registry::set_default_logger(std::shared_ptr<logger> new_default_logger)
  91. {
  92. std::lock_guard<std::mutex> lock(logger_map_mutex_);
  93. // remove previous default logger from the map
  94. if (default_logger_ != nullptr)
  95. {
  96. loggers_.erase(default_logger_->name());
  97. }
  98. if (new_default_logger != nullptr)
  99. {
  100. loggers_[new_default_logger->name()] = new_default_logger;
  101. }
  102. default_logger_ = std::move(new_default_logger);
  103. }
  104. SPDLOG_INLINE void registry::set_tp(std::shared_ptr<thread_pool> tp)
  105. {
  106. std::lock_guard<std::recursive_mutex> lock(tp_mutex_);
  107. tp_ = std::move(tp);
  108. }
  109. SPDLOG_INLINE std::shared_ptr<thread_pool> registry::get_tp()
  110. {
  111. std::lock_guard<std::recursive_mutex> lock(tp_mutex_);
  112. return tp_;
  113. }
  114. // Set global formatter. Each sink in each logger will get a clone of this object
  115. SPDLOG_INLINE void registry::set_formatter(std::unique_ptr<formatter> formatter)
  116. {
  117. std::lock_guard<std::mutex> lock(logger_map_mutex_);
  118. formatter_ = std::move(formatter);
  119. for (auto &l : loggers_)
  120. {
  121. l.second->set_formatter(formatter_->clone());
  122. }
  123. }
  124. SPDLOG_INLINE void registry::enable_backtrace(size_t n_messages)
  125. {
  126. std::lock_guard<std::mutex> lock(logger_map_mutex_);
  127. backtrace_n_messages_ = n_messages;
  128. for (auto &l : loggers_)
  129. {
  130. l.second->enable_backtrace(n_messages);
  131. }
  132. }
  133. SPDLOG_INLINE void registry::disable_backtrace()
  134. {
  135. std::lock_guard<std::mutex> lock(logger_map_mutex_);
  136. backtrace_n_messages_ = 0;
  137. for (auto &l : loggers_)
  138. {
  139. l.second->disable_backtrace();
  140. }
  141. }
  142. SPDLOG_INLINE void registry::set_level(level::level_enum log_level)
  143. {
  144. std::lock_guard<std::mutex> lock(logger_map_mutex_);
  145. for (auto &l : loggers_)
  146. {
  147. l.second->set_level(log_level);
  148. }
  149. global_log_level_ = log_level;
  150. }
  151. SPDLOG_INLINE void registry::flush_on(level::level_enum log_level)
  152. {
  153. std::lock_guard<std::mutex> lock(logger_map_mutex_);
  154. for (auto &l : loggers_)
  155. {
  156. l.second->flush_on(log_level);
  157. }
  158. flush_level_ = log_level;
  159. }
  160. SPDLOG_INLINE void registry::flush_every(std::chrono::seconds interval)
  161. {
  162. std::lock_guard<std::mutex> lock(flusher_mutex_);
  163. auto clbk = [this]() { this->flush_all(); };
  164. periodic_flusher_ = details::make_unique<periodic_worker>(clbk, interval);
  165. }
  166. SPDLOG_INLINE void registry::set_error_handler(err_handler handler)
  167. {
  168. std::lock_guard<std::mutex> lock(logger_map_mutex_);
  169. for (auto &l : loggers_)
  170. {
  171. l.second->set_error_handler(handler);
  172. }
  173. err_handler_ = std::move(handler);
  174. }
  175. SPDLOG_INLINE void registry::apply_all(const std::function<void(const std::shared_ptr<logger>)> &fun)
  176. {
  177. std::lock_guard<std::mutex> lock(logger_map_mutex_);
  178. for (auto &l : loggers_)
  179. {
  180. fun(l.second);
  181. }
  182. }
  183. SPDLOG_INLINE void registry::flush_all()
  184. {
  185. std::lock_guard<std::mutex> lock(logger_map_mutex_);
  186. for (auto &l : loggers_)
  187. {
  188. l.second->flush();
  189. }
  190. }
  191. SPDLOG_INLINE void registry::drop(const std::string &logger_name)
  192. {
  193. std::lock_guard<std::mutex> lock(logger_map_mutex_);
  194. loggers_.erase(logger_name);
  195. if (default_logger_ && default_logger_->name() == logger_name)
  196. {
  197. default_logger_.reset();
  198. }
  199. }
  200. SPDLOG_INLINE void registry::drop_all()
  201. {
  202. std::lock_guard<std::mutex> lock(logger_map_mutex_);
  203. loggers_.clear();
  204. default_logger_.reset();
  205. }
  206. // clean all resources and threads started by the registry
  207. SPDLOG_INLINE void registry::shutdown()
  208. {
  209. {
  210. std::lock_guard<std::mutex> lock(flusher_mutex_);
  211. periodic_flusher_.reset();
  212. }
  213. drop_all();
  214. {
  215. std::lock_guard<std::recursive_mutex> lock(tp_mutex_);
  216. tp_.reset();
  217. }
  218. }
  219. SPDLOG_INLINE std::recursive_mutex &registry::tp_mutex()
  220. {
  221. return tp_mutex_;
  222. }
  223. SPDLOG_INLINE void registry::set_automatic_registration(bool automatic_registration)
  224. {
  225. std::lock_guard<std::mutex> lock(logger_map_mutex_);
  226. automatic_registration_ = automatic_registration;
  227. }
  228. SPDLOG_INLINE void registry::set_levels(log_levels levels, level::level_enum *global_level)
  229. {
  230. std::lock_guard<std::mutex> lock(logger_map_mutex_);
  231. log_levels_ = std::move(levels);
  232. auto global_level_requested = global_level != nullptr;
  233. global_log_level_ = global_level_requested ? *global_level : global_log_level_;
  234. for (auto &logger : loggers_)
  235. {
  236. auto logger_entry = log_levels_.find(logger.first);
  237. if (logger_entry != log_levels_.end())
  238. {
  239. logger.second->set_level(logger_entry->second);
  240. }
  241. else if (global_level_requested)
  242. {
  243. logger.second->set_level(*global_level);
  244. }
  245. }
  246. }
  247. SPDLOG_INLINE registry &registry::instance()
  248. {
  249. static registry s_instance;
  250. return s_instance;
  251. }
  252. SPDLOG_INLINE void registry::throw_if_exists_(const std::string &logger_name)
  253. {
  254. if (loggers_.find(logger_name) != loggers_.end())
  255. {
  256. throw_spdlog_ex("logger with name '" + logger_name + "' already exists");
  257. }
  258. }
  259. SPDLOG_INLINE void registry::register_logger_(std::shared_ptr<logger> new_logger)
  260. {
  261. auto logger_name = new_logger->name();
  262. throw_if_exists_(logger_name);
  263. loggers_[logger_name] = std::move(new_logger);
  264. }
  265. } // namespace details
  266. } // namespace spdlog