1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: t -*-
3 * Copyright (c) 2005-2008, The Android Open Source Project
4 * Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
6 * Licensed under the Apache License, Version 2.0 (the License);
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
24 #include <dynamic_config.h>
25 #include <logcommon.h>
26 #include "loglimiter.h"
27 #include "logconfig.h"
31 #define DEFAULT_CONFIG_LIMITER false
32 #define DEFAULT_CONFIG_PLOG true
33 #define DEFAULT_CONFIG_DEBUGMODE 0
34 #define DEFAULT_CONFIG_LIMITER_APPLY_TO_ALL_BUFFERS 0
36 static int __write_to_log_null(log_id_t, log_priority, const char *, const char *);
39 * @brief Points to a function which writes a log message
40 * @details The function pointed to depends on the backend used
41 * @param[in] log_id ID of the buffer to log to. Belongs to (LOG_ID_INVALID, LOG_ID_MAX) non-inclusive
42 * @param[in] prio Priority of the message.
43 * @param[in] tag The message tag, identifies the sender.
44 * @param[in] msg The contents of the message.
45 * @return Returns the number of bytes written on success and a negative error value on error.
46 * @see __dlog_init_backend
48 int (*write_to_log)(log_id_t log_id, log_priority prio, const char *tag, const char *msg) = __write_to_log_null;
49 pthread_mutex_t log_init_lock = PTHREAD_MUTEX_INITIALIZER;
50 extern void __dlog_init_pipe(const struct log_config *conf);
51 extern void __dlog_init_android(const struct log_config *conf);
55 bool plog[LOG_ID_MAX];
57 void __update_plog(const struct log_config *conf);
60 static int fatal_assert;
61 static int limiter_apply_to_all_buffers;
65 * @details Ignores a log
66 * @param[in] log_id ID of the buffer to log to. Belongs to (LOG_ID_INVALID, LOG_ID_MAX) non-inclusive
67 * @param[in] prio Priority of the message.
68 * @param[in] tag The message tag, identifies the sender.
69 * @param[in] msg The contents of the message.
70 * @return DLOG_ERROR_NOT_PERMITTED
72 static int __write_to_log_null(log_id_t log_id, log_priority prio, const char *tag, const char *msg)// LCOV_EXCL_LINE
74 return DLOG_ERROR_NOT_PERMITTED; // LCOV_EXCL_LINE
77 static void __configure_limiter(struct log_config *config)
84 limiter = __log_limiter_create(config);
87 static int __configure_backend(struct log_config *config)
91 const char *const backend = log_config_get(config, "backend");
95 if (!strcmp(backend, "pipe"))
96 __dlog_init_pipe(config);
97 else if (!strcmp(backend, "logger"))
98 __dlog_init_android(config);
105 static void __configure_parameters(struct log_config *config)
109 const bool plog_default = log_config_get_boolean(config, "plog", DEFAULT_CONFIG_PLOG);
110 for (int i = 0; i < NELEMS(plog); ++i)
111 plog[i] = plog_default;
112 plog[LOG_ID_APPS] = true; // the default does not apply here for backward compatibility reasons.
113 __update_plog(config);
115 debugmode = log_config_get_int(config, "debugmode", DEFAULT_CONFIG_DEBUGMODE);
116 fatal_assert = access(DEBUGMODE_FILE, F_OK) != -1;
117 limiter = log_config_get_boolean(config, "limiter", DEFAULT_CONFIG_LIMITER);
118 limiter_apply_to_all_buffers = log_config_get_int(config,
119 "limiter_apply_to_all_buffers",
120 DEFAULT_CONFIG_LIMITER_APPLY_TO_ALL_BUFFERS);
123 void __update_plog(const struct log_config *conf)
127 for (int i = 0; i < NELEMS(plog); ++i) {
128 char key[MAX_CONF_KEY_LEN];
129 const int r = snprintf(key, sizeof key, "enable_%s", log_name_by_id((log_id_t)i));
132 plog[i] = log_config_get_boolean(conf, key, plog[i]);
137 * @brief Configure the library
138 * @details Reads relevant config values
140 static void __configure(void)
142 struct log_config config;
144 if (log_config_read(&config) < 0)
147 dynamic_config = __dynamic_config_create(&config);
149 __configure_parameters(&config);
151 if (!__configure_backend(&config))
154 __configure_limiter(&config);
156 log_config_free(&config);
160 log_config_free(&config); // LCOV_EXCL_LINE
166 * @details Initializes the library
168 static inline void __dlog_init(void)
170 static int is_initialized = 0;
175 pthread_mutex_lock(&log_init_lock);
177 if (!is_initialized) {
182 pthread_mutex_unlock(&log_init_lock);
186 * @brief Fatal assertion
187 * @details Conditionally crash the sucka who sent the log
188 * @param[in] prio Priority of the log
190 static void __dlog_fatal_assert(int prio)
192 assert(!fatal_assert || (prio != DLOG_FATAL));
196 * @brief Check log validity
197 * @details Checks whether the log is valid and eligible for printing
198 * @param[in] log_id The target buffer ID
199 * @param[in] prio The log's priority
200 * @param[in] tag The log's tag
201 * @return 0 on success, else an error code.
202 * @retval DLOG_ERROR_INVALID_PARAMETER Invalid parameter
203 * @retval DLOG_ERROR_NOT_PERMITTED Not permitted
205 static int dlog_should_log(log_id_t log_id, int prio, const char *tag)
207 if (!debugmode && prio <= DLOG_DEBUG)
208 return DLOG_ERROR_INVALID_PARAMETER;
211 return DLOG_ERROR_INVALID_PARAMETER;
213 if (log_id <= LOG_ID_INVALID || LOG_ID_MAX <= log_id)
214 return DLOG_ERROR_INVALID_PARAMETER;
217 __dynamic_config_update();
219 // LCOV_EXCL_START : disabled feature (limiter)
221 pthread_mutex_lock(&log_init_lock);
222 int should_log = __log_limiter_pass_log(tag, prio);
223 pthread_mutex_unlock(&log_init_lock);
226 return DLOG_ERROR_NOT_PERMITTED;
227 } else if (should_log < 0) {
228 write_to_log(log_id, prio, tag,
229 "Your log has been blocked due to limit of log lines per minute.");
230 return DLOG_ERROR_NOT_PERMITTED;
236 return DLOG_ERROR_NOT_PERMITTED;
238 return DLOG_ERROR_NONE;
241 static int __write_to_log(log_id_t log_id, int prio, const char *tag, const char *fmt, va_list ap, bool check_should_log)
243 char buf[LOG_MAX_PAYLOAD_SIZE];
247 /* if limiter_apply_to_all_buffers config variable is set to 1,
248 * check_should_log value does not matter and the entry is always
249 * tested against all conditions, i.e. limiter rules
251 int ret = (limiter_apply_to_all_buffers ? true : check_should_log) ? dlog_should_log(log_id, prio, tag) : 0;
255 vsnprintf(buf, sizeof buf, fmt, ap);
257 return write_to_log(log_id, prio, tag, buf);
262 * @details Print a log line
263 * @param[in] log_id The target buffer ID
264 * @param[in] prio Priority
266 * @param[in] fmt Format (same as printf)
267 * @param[in] ap Argument list
268 * @return Bytes written, or negative error
270 int __dlog_vprint(log_id_t log_id, int prio, const char *tag, const char *fmt, va_list ap)
272 int ret = __write_to_log(log_id, prio, tag, fmt, ap, true);
273 __dlog_fatal_assert(prio);
280 * @details Print a log line
281 * @param[in] log_id The target buffer ID
282 * @param[in] prio Priority
284 * @param[in] fmt Format (same as printf)
285 * @return Bytes written, or negative error
287 int __dlog_print(log_id_t log_id, int prio, const char *tag, const char *fmt, ...)
292 int ret = __dlog_vprint(log_id, prio, tag, fmt, ap);
298 int dlog_vprint(log_priority prio, const char *tag, const char *fmt, va_list ap)
300 return __write_to_log(LOG_ID_APPS, prio, tag, fmt, ap, false);
303 int dlog_print(log_priority prio, const char *tag, const char *fmt, ...)
308 int ret = dlog_vprint(prio, tag, fmt, ap);
315 * @brief Finalize DLog
316 * @details Finalizes and deallocates the library
317 * @notes Assumes it has exclusive thread access,
318 * i.e. no other library function can run in parallel
320 void __attribute__((destructor)) __dlog_fini(void)
322 __log_limiter_destroy();
323 __dynamic_config_destroy();