log.c 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * Copyright (c) 2017 Google, Inc
  4. * Written by Simon Glass <sjg@chromium.org>
  5. */
  6. #include <common.h>
  7. #include <command.h>
  8. #include <dm.h>
  9. #include <getopt.h>
  10. #include <log.h>
  11. #include <malloc.h>
  12. static char log_fmt_chars[LOGF_COUNT] = "clFLfm";
  13. static enum log_level_t parse_log_level(char *const arg)
  14. {
  15. enum log_level_t ret;
  16. ulong level;
  17. if (!strict_strtoul(arg, 10, &level)) {
  18. if (level > _LOG_MAX_LEVEL) {
  19. printf("Only log levels <= %d are supported\n",
  20. _LOG_MAX_LEVEL);
  21. return LOGL_NONE;
  22. }
  23. return level;
  24. }
  25. ret = log_get_level_by_name(arg);
  26. if (ret == LOGL_NONE)
  27. printf("Unknown log level \"%s\"\n", arg);
  28. return ret;
  29. }
  30. static int do_log_level(struct cmd_tbl *cmdtp, int flag, int argc,
  31. char *const argv[])
  32. {
  33. enum log_level_t log_level;
  34. if (argc > 1) {
  35. log_level = parse_log_level(argv[1]);
  36. if (log_level == LOGL_NONE)
  37. return CMD_RET_FAILURE;
  38. gd->default_log_level = log_level;
  39. } else {
  40. for (log_level = LOGL_FIRST; log_level <= _LOG_MAX_LEVEL;
  41. log_level++)
  42. printf("%s%s\n", log_get_level_name(log_level),
  43. log_level == gd->default_log_level ?
  44. " (default)" : "");
  45. }
  46. return CMD_RET_SUCCESS;
  47. }
  48. static int do_log_categories(struct cmd_tbl *cmdtp, int flag, int argc,
  49. char *const argv[])
  50. {
  51. enum log_category_t cat;
  52. const char *name;
  53. for (cat = LOGC_FIRST; cat < LOGC_COUNT; cat++) {
  54. name = log_get_cat_name(cat);
  55. /*
  56. * Invalid category names (e.g. <invalid> or <missing>) begin
  57. * with '<'.
  58. */
  59. if (name[0] == '<')
  60. continue;
  61. printf("%s\n", name);
  62. }
  63. return CMD_RET_SUCCESS;
  64. }
  65. static int do_log_drivers(struct cmd_tbl *cmdtp, int flag, int argc,
  66. char *const argv[])
  67. {
  68. struct log_device *ldev;
  69. list_for_each_entry(ldev, &gd->log_head, sibling_node)
  70. printf("%s\n", ldev->drv->name);
  71. return CMD_RET_SUCCESS;
  72. }
  73. static int do_log_filter_list(struct cmd_tbl *cmdtp, int flag, int argc,
  74. char *const argv[])
  75. {
  76. int opt;
  77. const char *drv_name = "console";
  78. struct getopt_state gs;
  79. struct log_filter *filt;
  80. struct log_device *ldev;
  81. getopt_init_state(&gs);
  82. while ((opt = getopt(&gs, argc, argv, "d:")) > 0) {
  83. switch (opt) {
  84. case 'd':
  85. drv_name = gs.arg;
  86. break;
  87. default:
  88. return CMD_RET_USAGE;
  89. }
  90. }
  91. if (gs.index != argc)
  92. return CMD_RET_USAGE;
  93. ldev = log_device_find_by_name(drv_name);
  94. if (!ldev) {
  95. printf("Could not find log device for \"%s\"\n", drv_name);
  96. return CMD_RET_FAILURE;
  97. }
  98. /* <3> < 6 > <2+1 + 7 > < 16 > < unbounded... */
  99. printf("num policy level categories files\n");
  100. list_for_each_entry(filt, &ldev->filter_head, sibling_node) {
  101. printf("%3d %6.6s %s %-7.7s ", filt->filter_num,
  102. filt->flags & LOGFF_DENY ? "deny" : "allow",
  103. filt->flags & LOGFF_LEVEL_MIN ? ">=" : "<=",
  104. log_get_level_name(filt->level));
  105. if (filt->flags & LOGFF_HAS_CAT) {
  106. int i;
  107. if (filt->cat_list[0] != LOGC_END)
  108. printf("%16.16s %s\n",
  109. log_get_cat_name(filt->cat_list[0]),
  110. filt->file_list ? filt->file_list : "");
  111. for (i = 1; i < LOGF_MAX_CATEGORIES &&
  112. filt->cat_list[i] != LOGC_END; i++)
  113. printf("%21c %16.16s\n", ' ',
  114. log_get_cat_name(filt->cat_list[i]));
  115. } else {
  116. printf("%16c %s\n", ' ',
  117. filt->file_list ? filt->file_list : "");
  118. }
  119. }
  120. return CMD_RET_SUCCESS;
  121. }
  122. static int do_log_filter_add(struct cmd_tbl *cmdtp, int flag, int argc,
  123. char *const argv[])
  124. {
  125. bool level_set = false;
  126. bool print_num = false;
  127. bool type_set = false;
  128. char *file_list = NULL;
  129. const char *drv_name = "console";
  130. int opt, err;
  131. int cat_count = 0;
  132. int flags = 0;
  133. enum log_category_t cat_list[LOGF_MAX_CATEGORIES + 1];
  134. enum log_level_t level = LOGL_MAX;
  135. struct getopt_state gs;
  136. getopt_init_state(&gs);
  137. while ((opt = getopt(&gs, argc, argv, "Ac:d:Df:l:L:p")) > 0) {
  138. switch (opt) {
  139. case 'A':
  140. #define do_type() do { \
  141. if (type_set) { \
  142. printf("Allow or deny set twice\n"); \
  143. return CMD_RET_USAGE; \
  144. } \
  145. type_set = true; \
  146. } while (0)
  147. do_type();
  148. break;
  149. case 'c': {
  150. enum log_category_t cat;
  151. if (cat_count >= LOGF_MAX_CATEGORIES) {
  152. printf("Too many categories\n");
  153. return CMD_RET_FAILURE;
  154. }
  155. cat = log_get_cat_by_name(gs.arg);
  156. if (cat == LOGC_NONE) {
  157. printf("Unknown category \"%s\"\n", gs.arg);
  158. return CMD_RET_FAILURE;
  159. }
  160. cat_list[cat_count++] = cat;
  161. break;
  162. }
  163. case 'd':
  164. drv_name = gs.arg;
  165. break;
  166. case 'D':
  167. do_type();
  168. flags |= LOGFF_DENY;
  169. break;
  170. case 'f':
  171. file_list = gs.arg;
  172. break;
  173. case 'l':
  174. #define do_level() do { \
  175. if (level_set) { \
  176. printf("Log level set twice\n"); \
  177. return CMD_RET_USAGE; \
  178. } \
  179. level = parse_log_level(gs.arg); \
  180. if (level == LOGL_NONE) \
  181. return CMD_RET_FAILURE; \
  182. level_set = true; \
  183. } while (0)
  184. do_level();
  185. break;
  186. case 'L':
  187. do_level();
  188. flags |= LOGFF_LEVEL_MIN;
  189. break;
  190. case 'p':
  191. print_num = true;
  192. break;
  193. default:
  194. return CMD_RET_USAGE;
  195. }
  196. }
  197. if (gs.index != argc)
  198. return CMD_RET_USAGE;
  199. cat_list[cat_count] = LOGC_END;
  200. err = log_add_filter_flags(drv_name, cat_count ? cat_list : NULL, level,
  201. file_list, flags);
  202. if (err < 0) {
  203. printf("Could not add filter (err = %d)\n", err);
  204. return CMD_RET_FAILURE;
  205. } else if (print_num) {
  206. printf("%d\n", err);
  207. }
  208. return CMD_RET_SUCCESS;
  209. }
  210. static int do_log_filter_remove(struct cmd_tbl *cmdtp, int flag, int argc,
  211. char *const argv[])
  212. {
  213. bool all = false;
  214. int opt, err;
  215. ulong filter_num;
  216. const char *drv_name = "console";
  217. struct getopt_state gs;
  218. getopt_init_state(&gs);
  219. while ((opt = getopt(&gs, argc, argv, "ad:")) > 0) {
  220. switch (opt) {
  221. case 'a':
  222. all = true;
  223. break;
  224. case 'd':
  225. drv_name = gs.arg;
  226. break;
  227. default:
  228. return CMD_RET_USAGE;
  229. }
  230. }
  231. if (all) {
  232. struct log_filter *filt, *tmp_filt;
  233. struct log_device *ldev;
  234. if (gs.index != argc)
  235. return CMD_RET_USAGE;
  236. ldev = log_device_find_by_name(drv_name);
  237. if (!ldev) {
  238. printf("Could not find log device for \"%s\"\n",
  239. drv_name);
  240. return CMD_RET_FAILURE;
  241. }
  242. list_for_each_entry_safe(filt, tmp_filt, &ldev->filter_head,
  243. sibling_node) {
  244. list_del(&filt->sibling_node);
  245. free(filt);
  246. }
  247. } else {
  248. if (gs.index + 1 != argc)
  249. return CMD_RET_USAGE;
  250. if (strict_strtoul(argv[gs.index], 10, &filter_num)) {
  251. printf("Invalid filter number \"%s\"\n", argv[gs.index]);
  252. return CMD_RET_FAILURE;
  253. }
  254. err = log_remove_filter(drv_name, filter_num);
  255. if (err) {
  256. printf("Could not remove filter (err = %d)\n", err);
  257. return CMD_RET_FAILURE;
  258. }
  259. }
  260. return CMD_RET_SUCCESS;
  261. }
  262. static int do_log_format(struct cmd_tbl *cmdtp, int flag, int argc,
  263. char *const argv[])
  264. {
  265. int i;
  266. if (argc > 1) {
  267. const char *str = argv[1];
  268. if (!strcmp(str, "default")) {
  269. gd->log_fmt = log_get_default_format();
  270. } else if (!strcmp(str, "all")) {
  271. gd->log_fmt = LOGF_ALL;
  272. } else {
  273. gd->log_fmt = 0;
  274. for (; *str; str++) {
  275. char *ptr = strchr(log_fmt_chars, *str);
  276. if (!ptr) {
  277. printf("Invalid log char '%c'\n", *str);
  278. return CMD_RET_FAILURE;
  279. }
  280. gd->log_fmt |= 1 << (ptr - log_fmt_chars);
  281. }
  282. }
  283. } else {
  284. printf("Log format: ");
  285. for (i = 0; i < LOGF_COUNT; i++) {
  286. if (gd->log_fmt & (1 << i))
  287. printf("%c", log_fmt_chars[i]);
  288. }
  289. printf("\n");
  290. }
  291. return 0;
  292. }
  293. static int do_log_rec(struct cmd_tbl *cmdtp, int flag, int argc,
  294. char *const argv[])
  295. {
  296. enum log_category_t cat;
  297. enum log_level_t level;
  298. const char *file;
  299. uint line;
  300. const char *func;
  301. const char *msg;
  302. char *end;
  303. if (argc < 7)
  304. return CMD_RET_USAGE;
  305. cat = log_get_cat_by_name(argv[1]);
  306. level = simple_strtoul(argv[2], &end, 10);
  307. if (end == argv[2]) {
  308. level = log_get_level_by_name(argv[2]);
  309. if (level == LOGL_NONE) {
  310. printf("Invalid log level '%s'\n", argv[2]);
  311. return CMD_RET_USAGE;
  312. }
  313. }
  314. if (level >= LOGL_MAX) {
  315. printf("Invalid log level %u\n", level);
  316. return CMD_RET_USAGE;
  317. }
  318. file = argv[3];
  319. line = simple_strtoul(argv[4], NULL, 10);
  320. func = argv[5];
  321. msg = argv[6];
  322. if (_log(cat, level, file, line, func, "%s\n", msg))
  323. return CMD_RET_FAILURE;
  324. return 0;
  325. }
  326. #ifdef CONFIG_SYS_LONGHELP
  327. static char log_help_text[] =
  328. "level [<level>] - get/set log level\n"
  329. "categories - list log categories\n"
  330. "drivers - list log drivers\n"
  331. "log filter-list [OPTIONS] - list all filters for a log driver\n"
  332. "\t-d <driver> - Specify the log driver to list filters from; defaults\n"
  333. "\t to console\n"
  334. "log filter-add [OPTIONS] - add a new filter to a driver\n"
  335. "\t-A - Allow messages matching this filter; mutually exclusive with -D\n"
  336. "\t This is the default.\n"
  337. "\t-c <category> - Category to match; may be specified multiple times\n"
  338. "\t-d <driver> - Specify the log driver to add the filter to; defaults\n"
  339. "\t to console\n"
  340. "\t-D - Deny messages matching this filter; mutually exclusive with -A\n"
  341. "\t-f <files_list> - A comma-separated list of files to match\n"
  342. "\t-l <level> - Match log levels less than or equal to <level>;\n"
  343. "\t mutually-exclusive with -L\n"
  344. "\t-L <level> - Match log levels greather than or equal to <level>;\n"
  345. "\t mutually-exclusive with -l\n"
  346. "\t-p - Print the filter number on success\n"
  347. "log filter-remove [OPTIONS] [<num>] - Remove filter number <num>\n"
  348. "\t-a - Remove ALL filters\n"
  349. "\t-d <driver> - Specify the log driver to remove the filter from;\n"
  350. "\t defaults to console\n"
  351. "log format <fmt> - set log output format. <fmt> is a string where\n"
  352. "\teach letter indicates something that should be displayed:\n"
  353. "\tc=category, l=level, F=file, L=line number, f=function, m=msg\n"
  354. "\tor 'default', or 'all' for all\n"
  355. "log rec <category> <level> <file> <line> <func> <message> - "
  356. "output a log record"
  357. ;
  358. #endif
  359. U_BOOT_CMD_WITH_SUBCMDS(log, "log system", log_help_text,
  360. U_BOOT_SUBCMD_MKENT(level, 2, 1, do_log_level),
  361. U_BOOT_SUBCMD_MKENT(categories, 1, 1, do_log_categories),
  362. U_BOOT_SUBCMD_MKENT(drivers, 1, 1, do_log_drivers),
  363. U_BOOT_SUBCMD_MKENT(filter-list, 3, 1, do_log_filter_list),
  364. U_BOOT_SUBCMD_MKENT(filter-add, CONFIG_SYS_MAXARGS, 1,
  365. do_log_filter_add),
  366. U_BOOT_SUBCMD_MKENT(filter-remove, 4, 1, do_log_filter_remove),
  367. U_BOOT_SUBCMD_MKENT(format, 2, 1, do_log_format),
  368. U_BOOT_SUBCMD_MKENT(rec, 7, 1, do_log_rec),
  369. );