4 * Copyright (c) 2017 Google, Inc
5 * Written by Simon Glass <sjg@chromium.org>
7 * SPDX-License-Identifier: GPL-2.0+
13 #include <dm/uclass.h>
15 DECLARE_GLOBAL_DATA_PTR;
17 static const char *log_cat_name[LOGC_COUNT - LOGC_NONE] = {
27 static const char *log_level_name[LOGL_COUNT] = {
40 const char *log_get_cat_name(enum log_category_t cat)
45 return log_cat_name[cat - LOGC_NONE];
47 return uclass_get_name((enum uclass_id)cat);
50 enum log_category_t log_get_cat_by_name(const char *name)
55 for (i = LOGC_NONE; i < LOGC_COUNT; i++)
56 if (!strcmp(name, log_cat_name[i - LOGC_NONE]))
58 id = uclass_get_by_name(name);
59 if (id != UCLASS_INVALID)
60 return (enum log_category_t)id;
65 const char *log_get_level_name(enum log_level_t level)
67 if (level >= LOGL_COUNT)
69 return log_level_name[level];
72 enum log_level_t log_get_level_by_name(const char *name)
76 for (i = 0; i < LOGL_COUNT; i++) {
77 if (!strcasecmp(log_level_name[i], name))
84 static struct log_device *log_device_find_by_name(const char *drv_name)
86 struct log_device *ldev;
88 list_for_each_entry(ldev, &gd->log_head, sibling_node) {
89 if (!strcmp(drv_name, ldev->drv->name))
97 * log_has_cat() - check if a log category exists within a list
99 * @cat_list: List of categories to check, at most LOGF_MAX_CATEGORIES entries
100 * long, terminated by LC_END if fewer
101 * @cat: Category to search for
102 * @return true if @cat is in @cat_list, else false
104 static bool log_has_cat(enum log_category_t cat_list[], enum log_category_t cat)
108 for (i = 0; i < LOGF_MAX_CATEGORIES && cat_list[i] != LOGC_END; i++) {
109 if (cat_list[i] == cat)
117 * log_has_file() - check if a file is with a list
119 * @file_list: List of files to check, separated by comma
120 * @file: File to check for. This string is matched against the end of each
121 * file in the list, i.e. ignoring any preceding path. The list is
122 * intended to consist of relative pathnames, e.g. common/main.c,cmd/log.c
123 * @return true if @file is in @file_list, else false
125 static bool log_has_file(const char *file_list, const char *file)
127 int file_len = strlen(file);
131 for (s = file_list; *s; s = p + (*p != '\0')) {
132 p = strchrnul(s, ',');
134 if (file_len >= substr_len &&
135 !strncmp(file + file_len - substr_len, s, substr_len))
143 * log_passes_filters() - check if a log record passes the filters for a device
145 * @ldev: Log device to check
146 * @rec: Log record to check
147 * @return true if @rec is not blocked by the filters in @ldev, false if it is
149 static bool log_passes_filters(struct log_device *ldev, struct log_rec *rec)
151 struct log_filter *filt;
153 /* If there are no filters, filter on the default log level */
154 if (list_empty(&ldev->filter_head)) {
155 if (rec->level > gd->default_log_level)
160 list_for_each_entry(filt, &ldev->filter_head, sibling_node) {
161 if (rec->level > filt->max_level)
163 if ((filt->flags & LOGFF_HAS_CAT) &&
164 !log_has_cat(filt->cat_list, rec->cat))
166 if (filt->file_list &&
167 !log_has_file(filt->file_list, rec->file))
176 * log_dispatch() - Send a log record to all log devices for processing
178 * The log record is sent to each log device in turn, skipping those which have
179 * filters which block the record
181 * @rec: Log record to dispatch
182 * @return 0 (meaning success)
184 static int log_dispatch(struct log_rec *rec)
186 struct log_device *ldev;
188 list_for_each_entry(ldev, &gd->log_head, sibling_node) {
189 if (log_passes_filters(ldev, rec))
190 ldev->drv->emit(ldev, rec);
196 int _log(enum log_category_t cat, enum log_level_t level, const char *file,
197 int line, const char *func, const char *fmt, ...)
199 char buf[CONFIG_SYS_CBSIZE];
209 vsnprintf(buf, sizeof(buf), fmt, args);
212 if (!gd || !(gd->flags & GD_FLG_LOG_READY)) {
214 gd->log_drop_count++;
222 int log_add_filter(const char *drv_name, enum log_category_t cat_list[],
223 enum log_level_t max_level, const char *file_list)
225 struct log_filter *filt;
226 struct log_device *ldev;
229 ldev = log_device_find_by_name(drv_name);
232 filt = (struct log_filter *)calloc(1, sizeof(*filt));
237 filt->flags |= LOGFF_HAS_CAT;
239 if (i == ARRAY_SIZE(filt->cat_list))
241 filt->cat_list[i] = cat_list[i];
242 if (cat_list[i] == LOGC_END)
246 filt->max_level = max_level;
248 filt->file_list = strdup(file_list);
249 if (!filt->file_list)
252 filt->filter_num = ldev->next_filter_num++;
253 list_add_tail(&filt->sibling_node, &ldev->filter_head);
255 return filt->filter_num;
262 int log_remove_filter(const char *drv_name, int filter_num)
264 struct log_filter *filt;
265 struct log_device *ldev;
267 ldev = log_device_find_by_name(drv_name);
271 list_for_each_entry(filt, &ldev->filter_head, sibling_node) {
272 if (filt->filter_num == filter_num) {
273 list_del(&filt->sibling_node);
285 struct log_driver *drv = ll_entry_start(struct log_driver, log_driver);
286 const int count = ll_entry_count(struct log_driver, log_driver);
287 struct log_driver *end = drv + count;
290 * We cannot add runtime data to the driver since it is likely stored
291 * in rodata. Instead, set up a 'device' corresponding to each driver.
292 * We only support having a single device.
294 INIT_LIST_HEAD((struct list_head *)&gd->log_head);
296 struct log_device *ldev;
298 ldev = calloc(1, sizeof(*ldev));
300 debug("%s: Cannot allocate memory\n", __func__);
303 INIT_LIST_HEAD(&ldev->filter_head);
305 list_add_tail(&ldev->sibling_node,
306 (struct list_head *)&gd->log_head);
309 gd->flags |= GD_FLG_LOG_READY;
310 gd->default_log_level = LOGL_INFO;
311 gd->log_fmt = LOGF_DEFAULT;