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 1
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();
51 extern void __dlog_init_android();
58 static int fatal_assert;
59 static int limiter_apply_to_all_buffers;
63 * @details Ignores a log
64 * @param[in] log_id ID of the buffer to log to. Belongs to (LOG_ID_INVALID, LOG_ID_MAX) non-inclusive
65 * @param[in] prio Priority of the message.
66 * @param[in] tag The message tag, identifies the sender.
67 * @param[in] msg The contents of the message.
68 * @return DLOG_ERROR_NOT_PERMITTED
70 static int __write_to_log_null(log_id_t log_id, log_priority prio, const char *tag, const char *msg)// LCOV_EXCL_LINE
72 return DLOG_ERROR_NOT_PERMITTED; // LCOV_EXCL_LINE
75 static void __configure_limiter(struct log_config *config)
82 limiter = __log_limiter_create(config);
85 static int __configure_backend(struct log_config *config)
89 const char *const backend = log_config_get(config, "backend");
93 if (!strcmp(backend, "pipe"))
95 else if (!strcmp(backend, "logger"))
96 __dlog_init_android();
103 static void __configure_parameters(struct log_config *config)
107 plog = log_config_get_int(config, "plog", DEFAULT_CONFIG_PLOG);
108 debugmode = log_config_get_int(config, "debugmode", DEFAULT_CONFIG_DEBUGMODE);
109 fatal_assert = access(DEBUGMODE_FILE, F_OK) != -1;
110 limiter = log_config_get_boolean(config, "limiter", DEFAULT_CONFIG_LIMITER);
111 limiter_apply_to_all_buffers = log_config_get_int(config,
112 "limiter_apply_to_all_buffers",
113 DEFAULT_CONFIG_LIMITER_APPLY_TO_ALL_BUFFERS);
117 * @brief Configure the library
118 * @details Reads relevant config values
120 static void __configure(void)
122 struct log_config config;
124 if (log_config_read(&config) < 0)
127 dynamic_config = __dynamic_config_create(&config);
129 __configure_parameters(&config);
131 if (!__configure_backend(&config))
134 __configure_limiter(&config);
136 log_config_free(&config);
140 log_config_free(&config); // LCOV_EXCL_LINE
146 * @details Initializes the library
148 static inline void __dlog_init(void)
150 static int is_initialized = 0;
155 pthread_mutex_lock(&log_init_lock);
157 if (!is_initialized) {
162 pthread_mutex_unlock(&log_init_lock);
166 * @brief Fatal assertion
167 * @details Conditionally crash the sucka who sent the log
168 * @param[in] prio Priority of the log
170 static void __dlog_fatal_assert(int prio)
172 assert(!fatal_assert || (prio != DLOG_FATAL));
176 * @brief Check log validity
177 * @details Checks whether the log is valid and eligible for printing
178 * @param[in] log_id The target buffer ID
179 * @param[in] prio The log's priority
180 * @param[in] tag The log's tag
181 * @return 0 on success, else an error code.
182 * @retval DLOG_ERROR_INVALID_PARAMETER Invalid parameter
183 * @retval DLOG_ERROR_NOT_PERMITTED Not permitted
185 static int dlog_should_log(log_id_t log_id, int prio, const char *tag)
187 if (!debugmode && prio <= DLOG_DEBUG)
188 return DLOG_ERROR_INVALID_PARAMETER;
191 return DLOG_ERROR_INVALID_PARAMETER;
193 if (log_id == LOG_ID_INVALID || LOG_ID_MAX <= log_id)
194 return DLOG_ERROR_INVALID_PARAMETER;
196 if (log_id != LOG_ID_APPS && !plog)
197 return DLOG_ERROR_NOT_PERMITTED;
199 if (dynamic_config) {
200 __dynamic_config_update();
202 // LCOV_EXCL_START : disabled feature (limiter)
204 pthread_mutex_lock(&log_init_lock);
205 int should_log = __log_limiter_pass_log(tag, prio);
206 pthread_mutex_unlock(&log_init_lock);
209 return DLOG_ERROR_NOT_PERMITTED;
210 } else if (should_log < 0) {
211 write_to_log(log_id, prio, tag,
212 "Your log has been blocked due to limit of log lines per minute.");
213 return DLOG_ERROR_NOT_PERMITTED;
219 return DLOG_ERROR_NONE;
222 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)
224 char buf[LOG_MAX_PAYLOAD_SIZE];
228 /* if limiter_apply_to_all_buffers config variable is set to 1,
229 * check_should_log value does not matter and the entry is always
230 * tested against all conditions, i.e. limiter rules
232 int ret = (limiter_apply_to_all_buffers ? true : check_should_log) ? dlog_should_log(log_id, prio, tag) : 0;
236 vsnprintf(buf, sizeof buf, fmt, ap);
238 return write_to_log(log_id, prio, tag, buf);
243 * @details Print a log line
244 * @param[in] log_id The target buffer ID
245 * @param[in] prio Priority
247 * @param[in] fmt Format (same as printf)
248 * @param[in] ap Argument list
249 * @return Bytes written, or negative error
251 int __dlog_vprint(log_id_t log_id, int prio, const char *tag, const char *fmt, va_list ap)
253 int ret = __write_to_log(log_id, prio, tag, fmt, ap, true);
254 __dlog_fatal_assert(prio);
261 * @details Print a log line
262 * @param[in] log_id The target buffer ID
263 * @param[in] prio Priority
265 * @param[in] fmt Format (same as printf)
266 * @return Bytes written, or negative error
268 int __dlog_print(log_id_t log_id, int prio, const char *tag, const char *fmt, ...)
273 int ret = __dlog_vprint(log_id, prio, tag, fmt, ap);
279 int dlog_vprint(log_priority prio, const char *tag, const char *fmt, va_list ap)
281 return __write_to_log(LOG_ID_APPS, prio, tag, fmt, ap, false);
284 int dlog_print(log_priority prio, const char *tag, const char *fmt, ...)
289 int ret = dlog_vprint(prio, tag, fmt, ap);
296 * @brief Finalize DLog
297 * @details Finalizes and deallocates the library
298 * @notes Assumes it has exclusive thread access,
299 * i.e. no other library function can run in parallel
301 void __attribute__((destructor)) __dlog_fini(void)
303 __log_limiter_destroy();
304 __dynamic_config_destroy();