log.c 10 KB

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