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