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];
56 bool plog_default_values[LOG_ID_MAX];
58 void __update_plog(const struct log_config *conf);
61 static int fatal_assert;
62 static int limiter_apply_to_all_buffers;
66 * @details Ignores a log
67 * @param[in] log_id ID of the buffer to log to. Belongs to (LOG_ID_INVALID, LOG_ID_MAX) non-inclusive
68 * @param[in] prio Priority of the message.
69 * @param[in] tag The message tag, identifies the sender.
70 * @param[in] msg The contents of the message.
71 * @return DLOG_ERROR_NOT_PERMITTED
73 static int __write_to_log_null(log_id_t log_id, log_priority prio, const char *tag, const char *msg)
75 return DLOG_ERROR_NOT_PERMITTED;
78 static void __configure_limiter(struct log_config *config)
85 limiter = __log_limiter_create(config);
88 static int __configure_backend(struct log_config *config)
92 const char *const backend = log_config_get(config, "backend");
96 if (!strcmp(backend, "pipe"))
97 __dlog_init_pipe(config);
98 else if (!strcmp(backend, "logger"))
99 __dlog_init_android(config);
106 static void __set_plog_default_values()
108 for (int i = 0; i < NELEMS(plog); ++i)
109 plog_default_values[i] = plog[i];
112 static void __initialize_plog(const struct log_config *config)
116 const bool plog_default = log_config_get_boolean(config, "plog", DEFAULT_CONFIG_PLOG);
117 for (int i = 0; i < NELEMS(plog); ++i)
118 plog[i] = plog_default;
119 plog[LOG_ID_APPS] = true; // the default does not apply here for backward compatibility reasons.
120 __set_plog_default_values();
123 static void __configure_parameters(struct log_config *config)
127 __initialize_plog(config);
128 __update_plog(config);
129 __set_plog_default_values();
131 debugmode = log_config_get_int(config, "debugmode", DEFAULT_CONFIG_DEBUGMODE);
132 fatal_assert = access(DEBUGMODE_FILE, F_OK) != -1;
133 limiter = log_config_get_boolean(config, "limiter", DEFAULT_CONFIG_LIMITER);
134 limiter_apply_to_all_buffers = log_config_get_int(config,
135 "limiter_apply_to_all_buffers",
136 DEFAULT_CONFIG_LIMITER_APPLY_TO_ALL_BUFFERS);
139 void __update_plog(const struct log_config *conf)
143 for (int i = 0; i < NELEMS(plog); ++i) {
144 char key[MAX_CONF_KEY_LEN];
145 const int r = snprintf(key, sizeof key, "enable_%s", log_name_by_id((log_id_t)i));
148 plog[i] = log_config_get_boolean(conf, key, plog_default_values[i]);
153 * @brief Configure the library
154 * @details Reads relevant config values
156 static void __configure(void)
158 struct log_config config;
160 if (log_config_read(&config) < 0)
163 dynamic_config = __dynamic_config_create(&config);
165 __configure_parameters(&config);
167 if (!__configure_backend(&config))
170 __configure_limiter(&config);
173 log_config_free(&config);
179 * @details Initializes the library
181 static bool is_initialized = false;
182 static inline void __dlog_init(void)
187 pthread_mutex_lock(&log_init_lock);
189 if (!is_initialized) {
191 is_initialized = true;
194 pthread_mutex_unlock(&log_init_lock);
198 * @brief Fatal assertion
199 * @details Conditionally crash the sucka who sent the log
200 * @param[in] prio Priority of the log
202 static void __dlog_fatal_assert(int prio)
204 assert(!fatal_assert || (prio != DLOG_FATAL));
208 * @brief Check log validity
209 * @details Checks whether the log is valid and eligible for printing
210 * @param[in] log_id The target buffer ID
211 * @param[in] prio The log's priority
212 * @param[in] tag The log's tag
213 * @return DLOG_ERROR_NONE on success, else an error code.
214 * @retval DLOG_ERROR_INVALID_PARAMETER Invalid parameter
216 static int dlog_check_validity(log_id_t log_id, int prio, const char *tag)
219 return DLOG_ERROR_INVALID_PARAMETER;
221 if (log_id <= LOG_ID_INVALID || LOG_ID_MAX <= log_id)
222 return DLOG_ERROR_INVALID_PARAMETER;
224 return DLOG_ERROR_NONE;
228 * @brief Check log against limiter rules
229 * @details Checks whether the log passes current limiter rules
230 * @param[in] log_id The target buffer ID
231 * @param[in] prio The log's priority
232 * @param[in] tag The log's tag
233 * @return DLOG_ERROR_NONE on success, else an error code.
234 * @retval DLOG_ERROR_NOT_PERMITTED Not permitted
236 static int dlog_check_limiter(log_id_t log_id, int prio, const char *tag)
238 if (!debugmode && prio <= DLOG_DEBUG)
239 return DLOG_ERROR_NOT_PERMITTED;
242 __dynamic_config_update();
245 pthread_mutex_lock(&log_init_lock);
246 int should_log = __log_limiter_pass_log(tag, prio);
247 pthread_mutex_unlock(&log_init_lock);
250 return DLOG_ERROR_NOT_PERMITTED;
251 } else if (should_log < 0) {
252 write_to_log(log_id, prio, tag,
253 "Your log has been blocked due to limit of log lines per minute.");
254 return DLOG_ERROR_NOT_PERMITTED;
259 return DLOG_ERROR_NOT_PERMITTED;
261 return DLOG_ERROR_NONE;
264 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)
266 char buf[LOG_MAX_PAYLOAD_SIZE];
268 int ret = dlog_check_validity(log_id, prio, tag);
274 /* if limiter_apply_to_all_buffers config variable is set to 1,
275 * check_should_log value does not matter and the entry is always
276 * tested against all conditions, i.e. limiter rules
278 ret = (check_should_log || limiter_apply_to_all_buffers) ? dlog_check_limiter(log_id, prio, tag) : 0;
281 return DLOG_ERROR_NONE;
283 vsnprintf(buf, sizeof buf, fmt, ap);
285 return write_to_log(log_id, prio, tag, buf);
290 * @details Print a log line
291 * @param[in] log_id The target buffer ID
292 * @param[in] prio Priority
294 * @param[in] fmt Format (same as printf)
295 * @param[in] ap Argument list
296 * @return Bytes written, or negative error
298 int __dlog_vprint(log_id_t log_id, int prio, const char *tag, const char *fmt, va_list ap)
300 int ret = __write_to_log(log_id, prio, tag, fmt, ap, true);
301 __dlog_fatal_assert(prio);
308 * @details Print a log line
309 * @param[in] log_id The target buffer ID
310 * @param[in] prio Priority
312 * @param[in] fmt Format (same as printf)
313 * @return Bytes written, or negative error
315 int __dlog_print(log_id_t log_id, int prio, const char *tag, const char *fmt, ...)
320 int ret = __dlog_vprint(log_id, prio, tag, fmt, ap);
326 int dlog_vprint(log_priority prio, const char *tag, const char *fmt, va_list ap)
328 return __write_to_log(LOG_ID_APPS, prio, tag, fmt, ap, false);
331 int dlog_print(log_priority prio, const char *tag, const char *fmt, ...)
336 int ret = dlog_vprint(prio, tag, fmt, ap);
343 * @brief Finalize DLog
344 * @details Finalizes and deallocates the library
345 * @notes Assumes it has exclusive thread access,
346 * i.e. no other library function can run in parallel
348 void __attribute__((destructor)) __dlog_fini(void)
350 __log_limiter_destroy();
351 __dynamic_config_destroy();
352 write_to_log = __write_to_log_null;
353 is_initialized = false;