]>
git.ipfire.org Git - thirdparty/u-boot.git/blob - common/log.c
1 // SPDX-License-Identifier: GPL-2.0+
5 * Copyright (c) 2017 Google, Inc
6 * Written by Simon Glass <sjg@chromium.org>
12 #include <dm/uclass.h>
14 DECLARE_GLOBAL_DATA_PTR
;
16 static const char *log_cat_name
[LOGC_COUNT
- LOGC_NONE
] = {
26 static const char *log_level_name
[LOGL_COUNT
] = {
39 const char *log_get_cat_name(enum log_category_t cat
)
44 return log_cat_name
[cat
- LOGC_NONE
];
46 return uclass_get_name((enum uclass_id
)cat
);
49 enum log_category_t
log_get_cat_by_name(const char *name
)
54 for (i
= LOGC_NONE
; i
< LOGC_COUNT
; i
++)
55 if (!strcmp(name
, log_cat_name
[i
- LOGC_NONE
]))
57 id
= uclass_get_by_name(name
);
58 if (id
!= UCLASS_INVALID
)
59 return (enum log_category_t
)id
;
64 const char *log_get_level_name(enum log_level_t level
)
66 if (level
>= LOGL_COUNT
)
68 return log_level_name
[level
];
71 enum log_level_t
log_get_level_by_name(const char *name
)
75 for (i
= 0; i
< LOGL_COUNT
; i
++) {
76 if (!strcasecmp(log_level_name
[i
], name
))
83 static struct log_device
*log_device_find_by_name(const char *drv_name
)
85 struct log_device
*ldev
;
87 list_for_each_entry(ldev
, &gd
->log_head
, sibling_node
) {
88 if (!strcmp(drv_name
, ldev
->drv
->name
))
96 * log_has_cat() - check if a log category exists within a list
98 * @cat_list: List of categories to check, at most LOGF_MAX_CATEGORIES entries
99 * long, terminated by LC_END if fewer
100 * @cat: Category to search for
101 * @return true if @cat is in @cat_list, else false
103 static bool log_has_cat(enum log_category_t cat_list
[], enum log_category_t cat
)
107 for (i
= 0; i
< LOGF_MAX_CATEGORIES
&& cat_list
[i
] != LOGC_END
; i
++) {
108 if (cat_list
[i
] == cat
)
116 * log_has_file() - check if a file is with a list
118 * @file_list: List of files to check, separated by comma
119 * @file: File to check for. This string is matched against the end of each
120 * file in the list, i.e. ignoring any preceding path. The list is
121 * intended to consist of relative pathnames, e.g. common/main.c,cmd/log.c
122 * @return true if @file is in @file_list, else false
124 static bool log_has_file(const char *file_list
, const char *file
)
126 int file_len
= strlen(file
);
130 for (s
= file_list
; *s
; s
= p
+ (*p
!= '\0')) {
131 p
= strchrnul(s
, ',');
133 if (file_len
>= substr_len
&&
134 !strncmp(file
+ file_len
- substr_len
, s
, substr_len
))
142 * log_passes_filters() - check if a log record passes the filters for a device
144 * @ldev: Log device to check
145 * @rec: Log record to check
146 * @return true if @rec is not blocked by the filters in @ldev, false if it is
148 static bool log_passes_filters(struct log_device
*ldev
, struct log_rec
*rec
)
150 struct log_filter
*filt
;
152 /* If there are no filters, filter on the default log level */
153 if (list_empty(&ldev
->filter_head
)) {
154 if (rec
->level
> gd
->default_log_level
)
159 list_for_each_entry(filt
, &ldev
->filter_head
, sibling_node
) {
160 if (rec
->level
> filt
->max_level
)
162 if ((filt
->flags
& LOGFF_HAS_CAT
) &&
163 !log_has_cat(filt
->cat_list
, rec
->cat
))
165 if (filt
->file_list
&&
166 !log_has_file(filt
->file_list
, rec
->file
))
175 * log_dispatch() - Send a log record to all log devices for processing
177 * The log record is sent to each log device in turn, skipping those which have
178 * filters which block the record
180 * @rec: Log record to dispatch
181 * @return 0 (meaning success)
183 static int log_dispatch(struct log_rec
*rec
)
185 struct log_device
*ldev
;
187 list_for_each_entry(ldev
, &gd
->log_head
, sibling_node
) {
188 if (log_passes_filters(ldev
, rec
))
189 ldev
->drv
->emit(ldev
, rec
);
195 int _log(enum log_category_t cat
, enum log_level_t level
, const char *file
,
196 int line
, const char *func
, const char *fmt
, ...)
198 char buf
[CONFIG_SYS_CBSIZE
];
208 vsnprintf(buf
, sizeof(buf
), fmt
, args
);
211 if (!gd
|| !(gd
->flags
& GD_FLG_LOG_READY
)) {
213 gd
->log_drop_count
++;
221 int log_add_filter(const char *drv_name
, enum log_category_t cat_list
[],
222 enum log_level_t max_level
, const char *file_list
)
224 struct log_filter
*filt
;
225 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
)) {
243 filt
->cat_list
[i
] = cat_list
[i
];
244 if (cat_list
[i
] == LOGC_END
)
248 filt
->max_level
= max_level
;
250 filt
->file_list
= strdup(file_list
);
251 if (!filt
->file_list
) {
256 filt
->filter_num
= ldev
->next_filter_num
++;
257 list_add_tail(&filt
->sibling_node
, &ldev
->filter_head
);
259 return filt
->filter_num
;
266 int log_remove_filter(const char *drv_name
, int filter_num
)
268 struct log_filter
*filt
;
269 struct log_device
*ldev
;
271 ldev
= log_device_find_by_name(drv_name
);
275 list_for_each_entry(filt
, &ldev
->filter_head
, sibling_node
) {
276 if (filt
->filter_num
== filter_num
) {
277 list_del(&filt
->sibling_node
);
289 struct log_driver
*drv
= ll_entry_start(struct log_driver
, log_driver
);
290 const int count
= ll_entry_count(struct log_driver
, log_driver
);
291 struct log_driver
*end
= drv
+ count
;
294 * We cannot add runtime data to the driver since it is likely stored
295 * in rodata. Instead, set up a 'device' corresponding to each driver.
296 * We only support having a single device.
298 INIT_LIST_HEAD((struct list_head
*)&gd
->log_head
);
300 struct log_device
*ldev
;
302 ldev
= calloc(1, sizeof(*ldev
));
304 debug("%s: Cannot allocate memory\n", __func__
);
307 INIT_LIST_HEAD(&ldev
->filter_head
);
309 list_add_tail(&ldev
->sibling_node
,
310 (struct list_head
*)&gd
->log_head
);
313 gd
->flags
|= GD_FLG_LOG_READY
;
314 gd
->default_log_level
= LOGL_INFO
;
315 gd
->log_fmt
= LOGF_DEFAULT
;