Blame view

common/log.c 6.87 KB
83d290c56   Tom Rini   SPDX: Convert all...
1
  // SPDX-License-Identifier: GPL-2.0+
e9c8d49d5   Simon Glass   log: Add an imple...
2
3
4
5
6
  /*
   * Logging support
   *
   * Copyright (c) 2017 Google, Inc
   * Written by Simon Glass <sjg@chromium.org>
e9c8d49d5   Simon Glass   log: Add an imple...
7
8
9
10
11
   */
  
  #include <common.h>
  #include <log.h>
  #include <malloc.h>
f941c8d76   Simon Glass   log: Add function...
12
  #include <dm/uclass.h>
e9c8d49d5   Simon Glass   log: Add an imple...
13
14
  
  DECLARE_GLOBAL_DATA_PTR;
f941c8d76   Simon Glass   log: Add function...
15
16
17
18
19
20
21
  static const char *log_cat_name[LOGC_COUNT - LOGC_NONE] = {
  	"none",
  	"arch",
  	"board",
  	"core",
  	"driver-model",
  	"device-tree",
1973b381a   Heinrich Schuchardt   log: add category...
22
  	"efi",
f941c8d76   Simon Glass   log: Add function...
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
  };
  
  static const char *log_level_name[LOGL_COUNT] = {
  	"EMERG",
  	"ALERT",
  	"CRIT",
  	"ERR",
  	"WARNING",
  	"NOTICE",
  	"INFO",
  	"DEBUG",
  	"CONTENT",
  	"IO",
  };
  
  const char *log_get_cat_name(enum log_category_t cat)
  {
c2e4e7e63   Simon Glass   log: Fix incorect...
40
41
42
43
  	const char *name;
  
  	if (cat < 0 || cat >= LOGC_COUNT)
  		return "<invalid>";
f941c8d76   Simon Glass   log: Add function...
44
45
  	if (cat >= LOGC_NONE)
  		return log_cat_name[cat - LOGC_NONE];
c2e4e7e63   Simon Glass   log: Fix incorect...
46
47
48
  	name = uclass_get_name((enum uclass_id)cat);
  
  	return name ? name : "<missing>";
f941c8d76   Simon Glass   log: Add function...
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
  }
  
  enum log_category_t log_get_cat_by_name(const char *name)
  {
  	enum uclass_id id;
  	int i;
  
  	for (i = LOGC_NONE; i < LOGC_COUNT; i++)
  		if (!strcmp(name, log_cat_name[i - LOGC_NONE]))
  			return i;
  	id = uclass_get_by_name(name);
  	if (id != UCLASS_INVALID)
  		return (enum log_category_t)id;
  
  	return LOGC_NONE;
  }
  
  const char *log_get_level_name(enum log_level_t level)
  {
  	if (level >= LOGL_COUNT)
  		return "INVALID";
  	return log_level_name[level];
  }
  
  enum log_level_t log_get_level_by_name(const char *name)
  {
  	int i;
  
  	for (i = 0; i < LOGL_COUNT; i++) {
  		if (!strcasecmp(log_level_name[i], name))
  			return i;
  	}
  
  	return LOGL_NONE;
  }
e9c8d49d5   Simon Glass   log: Add an imple...
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
  static struct log_device *log_device_find_by_name(const char *drv_name)
  {
  	struct log_device *ldev;
  
  	list_for_each_entry(ldev, &gd->log_head, sibling_node) {
  		if (!strcmp(drv_name, ldev->drv->name))
  			return ldev;
  	}
  
  	return NULL;
  }
  
  /**
   * log_has_cat() - check if a log category exists within a list
   *
   * @cat_list: List of categories to check, at most LOGF_MAX_CATEGORIES entries
   *	long, terminated by LC_END if fewer
   * @cat: Category to search for
   * @return true if @cat is in @cat_list, else false
   */
  static bool log_has_cat(enum log_category_t cat_list[], enum log_category_t cat)
  {
  	int i;
  
  	for (i = 0; i < LOGF_MAX_CATEGORIES && cat_list[i] != LOGC_END; i++) {
  		if (cat_list[i] == cat)
  			return true;
  	}
  
  	return false;
  }
  
  /**
   * log_has_file() - check if a file is with a list
   *
   * @file_list: List of files to check, separated by comma
   * @file: File to check for. This string is matched against the end of each
   *	file in the list, i.e. ignoring any preceding path. The list is
   *	intended to consist of relative pathnames, e.g. common/main.c,cmd/log.c
   * @return true if @file is in @file_list, else false
   */
  static bool log_has_file(const char *file_list, const char *file)
  {
  	int file_len = strlen(file);
  	const char *s, *p;
  	int substr_len;
  
  	for (s = file_list; *s; s = p + (*p != '\0')) {
  		p = strchrnul(s, ',');
  		substr_len = p - s;
  		if (file_len >= substr_len &&
  		    !strncmp(file + file_len - substr_len, s, substr_len))
  			return true;
  	}
  
  	return false;
  }
  
  /**
   * log_passes_filters() - check if a log record passes the filters for a device
   *
   * @ldev: Log device to check
   * @rec: Log record to check
   * @return true if @rec is not blocked by the filters in @ldev, false if it is
   */
  static bool log_passes_filters(struct log_device *ldev, struct log_rec *rec)
  {
  	struct log_filter *filt;
  
  	/* If there are no filters, filter on the default log level */
  	if (list_empty(&ldev->filter_head)) {
  		if (rec->level > gd->default_log_level)
  			return false;
  		return true;
  	}
  
  	list_for_each_entry(filt, &ldev->filter_head, sibling_node) {
  		if (rec->level > filt->max_level)
  			continue;
  		if ((filt->flags & LOGFF_HAS_CAT) &&
  		    !log_has_cat(filt->cat_list, rec->cat))
  			continue;
  		if (filt->file_list &&
  		    !log_has_file(filt->file_list, rec->file))
  			continue;
  		return true;
  	}
  
  	return false;
  }
  
  /**
   * log_dispatch() - Send a log record to all log devices for processing
   *
   * The log record is sent to each log device in turn, skipping those which have
   * filters which block the record
   *
   * @rec: Log record to dispatch
   * @return 0 (meaning success)
   */
  static int log_dispatch(struct log_rec *rec)
  {
  	struct log_device *ldev;
  
  	list_for_each_entry(ldev, &gd->log_head, sibling_node) {
  		if (log_passes_filters(ldev, rec))
  			ldev->drv->emit(ldev, rec);
  	}
  
  	return 0;
  }
  
  int _log(enum log_category_t cat, enum log_level_t level, const char *file,
  	 int line, const char *func, const char *fmt, ...)
  {
  	char buf[CONFIG_SYS_CBSIZE];
  	struct log_rec rec;
  	va_list args;
  
  	rec.cat = cat;
  	rec.level = level;
  	rec.file = file;
  	rec.line = line;
  	rec.func = func;
  	va_start(args, fmt);
  	vsnprintf(buf, sizeof(buf), fmt, args);
  	va_end(args);
  	rec.msg = buf;
  	if (!gd || !(gd->flags & GD_FLG_LOG_READY)) {
  		if (gd)
  			gd->log_drop_count++;
  		return -ENOSYS;
  	}
  	log_dispatch(&rec);
  
  	return 0;
  }
  
  int log_add_filter(const char *drv_name, enum log_category_t cat_list[],
  		   enum log_level_t max_level, const char *file_list)
  {
  	struct log_filter *filt;
  	struct log_device *ldev;
45fac9fc1   Simon Glass   log: Correct miss...
227
  	int ret;
e9c8d49d5   Simon Glass   log: Add an imple...
228
229
230
231
232
233
234
235
236
237
238
239
  	int i;
  
  	ldev = log_device_find_by_name(drv_name);
  	if (!ldev)
  		return -ENOENT;
  	filt = (struct log_filter *)calloc(1, sizeof(*filt));
  	if (!filt)
  		return -ENOMEM;
  
  	if (cat_list) {
  		filt->flags |= LOGFF_HAS_CAT;
  		for (i = 0; ; i++) {
45fac9fc1   Simon Glass   log: Correct miss...
240
241
242
243
  			if (i == ARRAY_SIZE(filt->cat_list)) {
  				ret = -ENOSPC;
  				goto err;
  			}
e9c8d49d5   Simon Glass   log: Add an imple...
244
245
246
247
248
249
250
251
  			filt->cat_list[i] = cat_list[i];
  			if (cat_list[i] == LOGC_END)
  				break;
  		}
  	}
  	filt->max_level = max_level;
  	if (file_list) {
  		filt->file_list = strdup(file_list);
45fac9fc1   Simon Glass   log: Correct miss...
252
253
254
255
  		if (!filt->file_list) {
  			ret = ENOMEM;
  			goto err;
  		}
e9c8d49d5   Simon Glass   log: Add an imple...
256
257
258
259
260
  	}
  	filt->filter_num = ldev->next_filter_num++;
  	list_add_tail(&filt->sibling_node, &ldev->filter_head);
  
  	return filt->filter_num;
45fac9fc1   Simon Glass   log: Correct miss...
261
  err:
e9c8d49d5   Simon Glass   log: Add an imple...
262
  	free(filt);
45fac9fc1   Simon Glass   log: Correct miss...
263
  	return ret;
e9c8d49d5   Simon Glass   log: Add an imple...
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
  }
  
  int log_remove_filter(const char *drv_name, int filter_num)
  {
  	struct log_filter *filt;
  	struct log_device *ldev;
  
  	ldev = log_device_find_by_name(drv_name);
  	if (!ldev)
  		return -ENOENT;
  
  	list_for_each_entry(filt, &ldev->filter_head, sibling_node) {
  		if (filt->filter_num == filter_num) {
  			list_del(&filt->sibling_node);
  			free(filt);
  
  			return 0;
  		}
  	}
  
  	return -ENOENT;
  }
  
  int log_init(void)
  {
  	struct log_driver *drv = ll_entry_start(struct log_driver, log_driver);
  	const int count = ll_entry_count(struct log_driver, log_driver);
  	struct log_driver *end = drv + count;
  
  	/*
  	 * We cannot add runtime data to the driver since it is likely stored
  	 * in rodata. Instead, set up a 'device' corresponding to each driver.
  	 * We only support having a single device.
  	 */
  	INIT_LIST_HEAD((struct list_head *)&gd->log_head);
  	while (drv < end) {
  		struct log_device *ldev;
  
  		ldev = calloc(1, sizeof(*ldev));
  		if (!ldev) {
  			debug("%s: Cannot allocate memory
  ", __func__);
  			return -ENOMEM;
  		}
  		INIT_LIST_HEAD(&ldev->filter_head);
  		ldev->drv = drv;
  		list_add_tail(&ldev->sibling_node,
  			      (struct list_head *)&gd->log_head);
  		drv++;
  	}
af1bc0cf4   Simon Glass   log: Plumb loggin...
314
  	gd->flags |= GD_FLG_LOG_READY;
2b1dc29a1   Simon Glass   sandbox: Add a fl...
315
  	if (!gd->default_log_level)
f0b05c95e   Simon Glass   log: Add a Kconfi...
316
  		gd->default_log_level = CONFIG_LOG_DEFAULT_LEVEL;
3b73e8d06   Simon Glass   log: Add control ...
317
  	gd->log_fmt = LOGF_DEFAULT;
e9c8d49d5   Simon Glass   log: Add an imple...
318
319
320
  
  	return 0;
  }