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.
30 #include <dynamic_config.h>
32 #include <logcommon.h>
33 #include "logconfig.h"
34 #include "loglimiter.h"
36 #define DEFAULT_CONFIG_LIMITER false
37 #define DEFAULT_CONFIG_PLOG true
38 #define DEFAULT_CONFIG_DEBUGMODE 0
39 #define DEFAULT_CONFIG_LIMITER_APPLY_TO_ALL_BUFFERS 0
42 * @brief Points to a function which writes a log message
43 * @details The function pointed to depends on the backend used
44 * @param[in] log_id ID of the buffer to log to. Belongs to (LOG_ID_INVALID, LOG_ID_MAX) non-inclusive
45 * @param[in] prio Priority of the message.
46 * @param[in] tag The message tag, identifies the sender.
47 * @param[in] msg The contents of the message.
48 * @return Returns the number of bytes written on success and a negative error value on error.
49 * @see __dlog_init_backend
51 int (*write_to_log)(log_id_t log_id, log_priority prio, const char *tag, const char *msg) = NULL;
52 pthread_mutex_t log_init_lock = PTHREAD_MUTEX_INITIALIZER;
53 extern void __dlog_init_pipe(const struct log_config *conf);
54 extern void __dlog_init_android(const struct log_config *conf);
58 bool plog[LOG_ID_MAX];
59 bool plog_default_values[LOG_ID_MAX];
62 static int fatal_assert;
63 static int limiter_apply_to_all_buffers;
65 static void __configure_limiter(struct log_config *config)
72 limiter = __log_limiter_create(config);
75 static int __configure_backend(struct log_config *config)
79 const char *const backend = log_config_get(config, "backend");
83 if (!strcmp(backend, "pipe"))
84 __dlog_init_pipe(config);
85 else if (!strcmp(backend, "logger"))
86 __dlog_init_android(config);
93 static void __set_plog_default_values()
95 for (int i = 0; i < NELEMS(plog); ++i)
96 plog_default_values[i] = plog[i];
99 static void __initialize_plog(const struct log_config *config)
103 const bool plog_default = log_config_get_boolean(config, "plog", DEFAULT_CONFIG_PLOG);
104 for (int i = 0; i < NELEMS(plog); ++i)
105 plog[i] = plog_default;
106 plog[LOG_ID_APPS] = true; // the default does not apply here for backward compatibility reasons.
107 __set_plog_default_values();
110 static void __configure_parameters(struct log_config *config)
114 __initialize_plog(config);
115 __update_plog(config);
116 __set_plog_default_values();
118 debugmode = log_config_get_int(config, "debugmode", DEFAULT_CONFIG_DEBUGMODE);
119 fatal_assert = access(DEBUGMODE_FILE, F_OK) != -1;
120 limiter = log_config_get_boolean(config, "limiter", DEFAULT_CONFIG_LIMITER);
121 limiter_apply_to_all_buffers = log_config_get_int(config,
122 "limiter_apply_to_all_buffers",
123 DEFAULT_CONFIG_LIMITER_APPLY_TO_ALL_BUFFERS);
126 void __update_plog(const struct log_config *conf)
130 for (int i = 0; i < NELEMS(plog); ++i) {
131 char key[MAX_CONF_KEY_LEN];
132 const int r = snprintf(key, sizeof key, "enable_%s", log_name_by_id((log_id_t)i));
135 plog[i] = log_config_get_boolean(conf, key, plog_default_values[i]);
140 * @brief Configure the library
141 * @details Reads relevant config values
144 void __configure(void)
146 static void __attribute__((constructor)) __configure(void)
149 struct log_config config;
151 if (log_config_read(&config) < 0)
154 dynamic_config = __dynamic_config_create(&config);
156 __configure_parameters(&config);
158 if (!__configure_backend(&config))
161 __configure_limiter(&config);
164 log_config_free(&config);
169 * @brief Fatal assertion
170 * @details Conditionally crash the sucka who sent the log
171 * @param[in] prio Priority of the log
173 static void __dlog_fatal_assert(int prio)
175 assert(!fatal_assert || (prio != DLOG_FATAL));
179 * @brief Check log validity
180 * @details Checks whether the log is valid and eligible for printing
181 * @param[in] log_id The target buffer ID
182 * @param[in] prio The log's priority
183 * @param[in] tag The log's tag
184 * @return DLOG_ERROR_NONE on success, else an error code.
185 * @retval DLOG_ERROR_INVALID_PARAMETER Invalid parameter
187 static int dlog_check_validity(log_id_t log_id, int prio, const char *tag)
190 return DLOG_ERROR_INVALID_PARAMETER;
192 if (log_id <= LOG_ID_INVALID || LOG_ID_MAX <= log_id)
193 return DLOG_ERROR_INVALID_PARAMETER;
195 return DLOG_ERROR_NONE;
199 * @brief Check log against limiter rules
200 * @details Checks whether the log passes current limiter rules
201 * @param[in] log_id The target buffer ID
202 * @param[in] prio The log's priority
203 * @param[in] tag The log's tag
204 * @return DLOG_ERROR_NONE on success, else an error code.
205 * @retval DLOG_ERROR_NOT_PERMITTED Not permitted
207 static int dlog_check_limiter(log_id_t log_id, int prio, const char *tag)
209 if (!debugmode && prio <= DLOG_DEBUG)
210 return DLOG_ERROR_NOT_PERMITTED;
213 __dynamic_config_update();
216 pthread_mutex_lock(&log_init_lock);
217 int should_log = __log_limiter_pass_log(tag, prio);
218 pthread_mutex_unlock(&log_init_lock);
221 return DLOG_ERROR_NOT_PERMITTED;
222 } else if (should_log < 0) {
223 write_to_log(log_id, prio, tag,
224 "Your log has been blocked due to limit of log lines per minute.");
225 return DLOG_ERROR_NOT_PERMITTED;
230 return DLOG_ERROR_NOT_PERMITTED;
232 return DLOG_ERROR_NONE;
235 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)
237 char buf[LOG_MAX_PAYLOAD_SIZE];
239 int ret = dlog_check_validity(log_id, prio, tag);
244 return DLOG_ERROR_NOT_PERMITTED;
246 /* if limiter_apply_to_all_buffers config variable is set to 1,
247 * check_should_log value does not matter and the entry is always
248 * tested against all conditions, i.e. limiter rules
250 ret = (check_should_log || limiter_apply_to_all_buffers) ? dlog_check_limiter(log_id, prio, tag) : 0;
253 return DLOG_ERROR_NONE;
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);
316 * @brief Finalize DLog
317 * @details Finalizes and deallocates the library
318 * @notes Used in tests only
320 void __dlog_fini(void)
322 __log_limiter_destroy();
323 __dynamic_config_destroy();