log_test.c 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * Logging support test program
  4. *
  5. * Copyright (c) 2017 Google, Inc
  6. * Written by Simon Glass <sjg@chromium.org>
  7. */
  8. #include <common.h>
  9. #include <command.h>
  10. #include <log.h>
  11. #include <asm/global_data.h>
  12. #include <test/log.h>
  13. #include <test/ut.h>
  14. DECLARE_GLOBAL_DATA_PTR;
  15. /* emit some sample log records in different ways, for testing */
  16. static int do_log_run(struct unit_test_state *uts, int cat, const char *file)
  17. {
  18. int i;
  19. int ret, expected_ret;
  20. if (gd->flags & GD_FLG_LOG_READY)
  21. expected_ret = 0;
  22. else
  23. expected_ret = -ENOSYS;
  24. gd->log_fmt = LOGF_TEST;
  25. debug("debug\n");
  26. for (i = LOGL_FIRST; i < LOGL_COUNT; i++) {
  27. log(cat, i, "log %d\n", i);
  28. ret = _log(log_uc_cat(cat), i, file, 100 + i,
  29. "func", "_log %d\n", i);
  30. ut_asserteq(ret, expected_ret);
  31. }
  32. /* test with LOGL_COUNT flag */
  33. for (i = LOGL_FIRST; i < LOGL_COUNT; i++) {
  34. ret = _log(log_uc_cat(cat), i | LOGL_FORCE_DEBUG, file, 100 + i,
  35. "func", "_log force %d\n", i);
  36. ut_asserteq(ret, expected_ret);
  37. }
  38. gd->log_fmt = log_get_default_format();
  39. return 0;
  40. }
  41. #define log_run_cat(cat) do_log_run(uts, cat, "file")
  42. #define log_run_file(file) do_log_run(uts, UCLASS_SPI, file)
  43. #define log_run() do_log_run(uts, UCLASS_SPI, "file")
  44. #define EXPECT_LOG BIT(0)
  45. #define EXPECT_DIRECT BIT(1)
  46. #define EXPECT_EXTRA BIT(2)
  47. #define EXPECT_FORCE BIT(3)
  48. #define EXPECT_DEBUG BIT(4)
  49. static int do_check_log_entries(struct unit_test_state *uts, int flags, int min,
  50. int max)
  51. {
  52. int i;
  53. for (i = min; i <= max; i++) {
  54. if (flags & EXPECT_LOG)
  55. ut_assert_nextline("do_log_run() log %d", i);
  56. if (flags & EXPECT_DIRECT)
  57. ut_assert_nextline("func() _log %d", i);
  58. if (flags & EXPECT_DEBUG) {
  59. ut_assert_nextline("log %d", i);
  60. ut_assert_nextline("_log %d", i);
  61. }
  62. }
  63. if (flags & EXPECT_EXTRA)
  64. for (; i <= LOGL_MAX ; i++)
  65. ut_assert_nextline("func() _log %d", i);
  66. for (i = LOGL_FIRST; i < LOGL_COUNT; i++) {
  67. if (flags & EXPECT_FORCE)
  68. ut_assert_nextline("func() _log force %d", i);
  69. if (flags & EXPECT_DEBUG)
  70. ut_assert_nextline("_log force %d", i);
  71. }
  72. ut_assert_console_end();
  73. return 0;
  74. }
  75. #define check_log_entries_flags_levels(flags, min, max) do {\
  76. int ret = do_check_log_entries(uts, flags, min, max); \
  77. if (ret) \
  78. return ret; \
  79. } while (0)
  80. #define check_log_entries_flags(flags) \
  81. check_log_entries_flags_levels(flags, LOGL_FIRST, _LOG_MAX_LEVEL)
  82. #define check_log_entries() check_log_entries_flags(EXPECT_LOG | EXPECT_DIRECT | EXPECT_FORCE)
  83. #define check_log_entries_extra() \
  84. check_log_entries_flags(EXPECT_LOG | EXPECT_DIRECT | EXPECT_EXTRA | EXPECT_FORCE)
  85. #define check_log_entries_none() check_log_entries_flags(EXPECT_FORCE)
  86. /* Check a category filter using the first category */
  87. int log_test_cat_allow(struct unit_test_state *uts)
  88. {
  89. enum log_category_t cat_list[] = {
  90. log_uc_cat(UCLASS_MMC), log_uc_cat(UCLASS_SPI),
  91. LOGC_NONE, LOGC_END
  92. };
  93. int filt;
  94. filt = log_add_filter("console", cat_list, LOGL_MAX, NULL);
  95. ut_assert(filt >= 0);
  96. ut_assertok(console_record_reset_enable());
  97. log_run_cat(UCLASS_MMC);
  98. check_log_entries_extra();
  99. ut_assertok(console_record_reset_enable());
  100. log_run_cat(UCLASS_SPI);
  101. check_log_entries_extra();
  102. ut_assertok(log_remove_filter("console", filt));
  103. return 0;
  104. }
  105. LOG_TEST_FLAGS(log_test_cat_allow, UT_TESTF_CONSOLE_REC);
  106. /* Check a category filter that should block log entries */
  107. int log_test_cat_deny_implicit(struct unit_test_state *uts)
  108. {
  109. enum log_category_t cat_list[] = {
  110. log_uc_cat(UCLASS_MMC), LOGC_NONE, LOGC_END
  111. };
  112. int filt;
  113. filt = log_add_filter("console", cat_list, LOGL_MAX, NULL);
  114. ut_assert(filt >= 0);
  115. ut_assertok(console_record_reset_enable());
  116. log_run_cat(UCLASS_SPI);
  117. check_log_entries_none();
  118. ut_assertok(log_remove_filter("console", filt));
  119. return 0;
  120. }
  121. LOG_TEST_FLAGS(log_test_cat_deny_implicit, UT_TESTF_CONSOLE_REC);
  122. /* Check passing and failing file filters */
  123. int log_test_file(struct unit_test_state *uts)
  124. {
  125. int filt;
  126. filt = log_add_filter("console", NULL, LOGL_MAX, "file");
  127. ut_assert(filt >= 0);
  128. ut_assertok(console_record_reset_enable());
  129. log_run_file("file");
  130. check_log_entries_flags(EXPECT_DIRECT | EXPECT_EXTRA | EXPECT_FORCE);
  131. ut_assertok(console_record_reset_enable());
  132. log_run_file("file2");
  133. check_log_entries_none();
  134. ut_assertok(log_remove_filter("console", filt));
  135. return 0;
  136. }
  137. LOG_TEST_FLAGS(log_test_file, UT_TESTF_CONSOLE_REC);
  138. /* Check a passing file filter (second in list) */
  139. int log_test_file_second(struct unit_test_state *uts)
  140. {
  141. int filt;
  142. filt = log_add_filter("console", NULL, LOGL_MAX, "file,file2");
  143. ut_assert(filt >= 0);
  144. ut_assertok(console_record_reset_enable());
  145. log_run_file("file2");
  146. check_log_entries_flags(EXPECT_DIRECT | EXPECT_EXTRA | EXPECT_FORCE);
  147. ut_assertok(log_remove_filter("console", filt));
  148. return 0;
  149. }
  150. LOG_TEST_FLAGS(log_test_file_second, UT_TESTF_CONSOLE_REC);
  151. /* Check a passing file filter (middle of list) */
  152. int log_test_file_mid(struct unit_test_state *uts)
  153. {
  154. int filt;
  155. filt = log_add_filter("console", NULL, LOGL_MAX,
  156. "file,file2,log/log_test.c");
  157. ut_assert(filt >= 0);
  158. ut_assertok(console_record_reset_enable());
  159. log_run_file("file2");
  160. check_log_entries_extra();
  161. ut_assertok(log_remove_filter("console", filt));
  162. return 0;
  163. }
  164. LOG_TEST_FLAGS(log_test_file_mid, UT_TESTF_CONSOLE_REC);
  165. /* Check a log level filter */
  166. int log_test_level(struct unit_test_state *uts)
  167. {
  168. int filt;
  169. filt = log_add_filter("console", NULL, LOGL_WARNING, NULL);
  170. ut_assert(filt >= 0);
  171. ut_assertok(console_record_reset_enable());
  172. log_run();
  173. check_log_entries_flags_levels(EXPECT_LOG | EXPECT_DIRECT | EXPECT_FORCE,
  174. LOGL_FIRST, LOGL_WARNING);
  175. ut_assertok(log_remove_filter("console", filt));
  176. return 0;
  177. }
  178. LOG_TEST_FLAGS(log_test_level, UT_TESTF_CONSOLE_REC);
  179. /* Check two filters, one of which passes everything */
  180. int log_test_double(struct unit_test_state *uts)
  181. {
  182. int filt1, filt2;
  183. filt1 = log_add_filter("console", NULL, LOGL_WARNING, NULL);
  184. ut_assert(filt1 >= 0);
  185. filt2 = log_add_filter("console", NULL, LOGL_MAX, NULL);
  186. ut_assert(filt2 >= 0);
  187. ut_assertok(console_record_reset_enable());
  188. log_run();
  189. check_log_entries_extra();
  190. ut_assertok(log_remove_filter("console", filt1));
  191. ut_assertok(log_remove_filter("console", filt2));
  192. return 0;
  193. }
  194. LOG_TEST_FLAGS(log_test_double, UT_TESTF_CONSOLE_REC);
  195. /* Check three filters, which together pass everything */
  196. int log_test_triple(struct unit_test_state *uts)
  197. {
  198. int filt1, filt2, filt3;
  199. filt1 = log_add_filter("console", NULL, LOGL_MAX, "file)");
  200. ut_assert(filt1 >= 0);
  201. filt2 = log_add_filter("console", NULL, LOGL_MAX, "file2");
  202. ut_assert(filt2 >= 0);
  203. filt3 = log_add_filter("console", NULL, LOGL_MAX, "log/log_test.c");
  204. ut_assert(filt3 >= 0);
  205. ut_assertok(console_record_reset_enable());
  206. log_run_file("file2");
  207. check_log_entries_extra();
  208. ut_assertok(log_remove_filter("console", filt1));
  209. ut_assertok(log_remove_filter("console", filt2));
  210. ut_assertok(log_remove_filter("console", filt3));
  211. return 0;
  212. }
  213. LOG_TEST_FLAGS(log_test_triple, UT_TESTF_CONSOLE_REC);
  214. int do_log_test_helpers(struct unit_test_state *uts)
  215. {
  216. int i;
  217. ut_assertok(console_record_reset_enable());
  218. log_err("level %d\n", LOGL_EMERG);
  219. log_err("level %d\n", LOGL_ALERT);
  220. log_err("level %d\n", LOGL_CRIT);
  221. log_err("level %d\n", LOGL_ERR);
  222. log_warning("level %d\n", LOGL_WARNING);
  223. log_notice("level %d\n", LOGL_NOTICE);
  224. log_info("level %d\n", LOGL_INFO);
  225. log_debug("level %d\n", LOGL_DEBUG);
  226. log_content("level %d\n", LOGL_DEBUG_CONTENT);
  227. log_io("level %d\n", LOGL_DEBUG_IO);
  228. for (i = LOGL_EMERG; i <= _LOG_MAX_LEVEL; i++)
  229. ut_assert_nextline("%s() level %d", __func__, i);
  230. ut_assert_console_end();
  231. return 0;
  232. }
  233. int log_test_helpers(struct unit_test_state *uts)
  234. {
  235. int ret;
  236. gd->log_fmt = LOGF_TEST;
  237. ret = do_log_test_helpers(uts);
  238. gd->log_fmt = log_get_default_format();
  239. return ret;
  240. }
  241. LOG_TEST_FLAGS(log_test_helpers, UT_TESTF_CONSOLE_REC);
  242. int do_log_test_disable(struct unit_test_state *uts)
  243. {
  244. ut_assertok(console_record_reset_enable());
  245. log_err("default\n");
  246. ut_assert_nextline("%s() default", __func__);
  247. ut_assertok(log_device_set_enable(LOG_GET_DRIVER(console), false));
  248. log_err("disabled\n");
  249. ut_assertok(log_device_set_enable(LOG_GET_DRIVER(console), true));
  250. log_err("enabled\n");
  251. ut_assert_nextline("%s() enabled", __func__);
  252. ut_assert_console_end();
  253. return 0;
  254. }
  255. int log_test_disable(struct unit_test_state *uts)
  256. {
  257. int ret;
  258. gd->log_fmt = LOGF_TEST;
  259. ret = do_log_test_disable(uts);
  260. gd->log_fmt = log_get_default_format();
  261. return ret;
  262. }
  263. LOG_TEST_FLAGS(log_test_disable, UT_TESTF_CONSOLE_REC);
  264. /* Check denying based on category */
  265. int log_test_cat_deny(struct unit_test_state *uts)
  266. {
  267. int filt1, filt2;
  268. enum log_category_t cat_list[] = {
  269. log_uc_cat(UCLASS_SPI), LOGC_END
  270. };
  271. filt1 = log_add_filter("console", cat_list, LOGL_MAX, NULL);
  272. ut_assert(filt1 >= 0);
  273. filt2 = log_add_filter_flags("console", cat_list, LOGL_MAX, NULL,
  274. LOGFF_DENY);
  275. ut_assert(filt2 >= 0);
  276. ut_assertok(console_record_reset_enable());
  277. log_run_cat(UCLASS_SPI);
  278. check_log_entries_none();
  279. ut_assertok(log_remove_filter("console", filt1));
  280. ut_assertok(log_remove_filter("console", filt2));
  281. return 0;
  282. }
  283. LOG_TEST_FLAGS(log_test_cat_deny, UT_TESTF_CONSOLE_REC);
  284. /* Check denying based on file */
  285. int log_test_file_deny(struct unit_test_state *uts)
  286. {
  287. int filt1, filt2;
  288. filt1 = log_add_filter("console", NULL, LOGL_MAX, "file");
  289. ut_assert(filt1 >= 0);
  290. filt2 = log_add_filter_flags("console", NULL, LOGL_MAX, "file",
  291. LOGFF_DENY);
  292. ut_assert(filt2 >= 0);
  293. ut_assertok(console_record_reset_enable());
  294. log_run_file("file");
  295. check_log_entries_none();
  296. ut_assertok(log_remove_filter("console", filt1));
  297. ut_assertok(log_remove_filter("console", filt2));
  298. return 0;
  299. }
  300. LOG_TEST_FLAGS(log_test_file_deny, UT_TESTF_CONSOLE_REC);
  301. /* Check denying based on level */
  302. int log_test_level_deny(struct unit_test_state *uts)
  303. {
  304. int filt1, filt2;
  305. filt1 = log_add_filter("console", NULL, LOGL_INFO, NULL);
  306. ut_assert(filt1 >= 0);
  307. filt2 = log_add_filter_flags("console", NULL, LOGL_WARNING, NULL,
  308. LOGFF_DENY);
  309. ut_assert(filt2 >= 0);
  310. ut_assertok(console_record_reset_enable());
  311. log_run();
  312. check_log_entries_flags_levels(EXPECT_LOG | EXPECT_DIRECT | EXPECT_FORCE,
  313. LOGL_WARNING + 1, _LOG_MAX_LEVEL);
  314. ut_assertok(log_remove_filter("console", filt1));
  315. ut_assertok(log_remove_filter("console", filt2));
  316. return 0;
  317. }
  318. LOG_TEST_FLAGS(log_test_level_deny, UT_TESTF_CONSOLE_REC);
  319. /* Check matching based on minimum level */
  320. int log_test_min(struct unit_test_state *uts)
  321. {
  322. int filt1, filt2;
  323. filt1 = log_add_filter_flags("console", NULL, LOGL_WARNING, NULL,
  324. LOGFF_LEVEL_MIN);
  325. ut_assert(filt1 >= 0);
  326. filt2 = log_add_filter_flags("console", NULL, LOGL_INFO, NULL,
  327. LOGFF_DENY | LOGFF_LEVEL_MIN);
  328. ut_assert(filt2 >= 0);
  329. ut_assertok(console_record_reset_enable());
  330. log_run();
  331. check_log_entries_flags_levels(EXPECT_LOG | EXPECT_DIRECT | EXPECT_FORCE,
  332. LOGL_WARNING, LOGL_INFO - 1);
  333. ut_assertok(log_remove_filter("console", filt1));
  334. ut_assertok(log_remove_filter("console", filt2));
  335. return 0;
  336. }
  337. LOG_TEST_FLAGS(log_test_min, UT_TESTF_CONSOLE_REC);
  338. /* Check dropped traces */
  339. int log_test_dropped(struct unit_test_state *uts)
  340. {
  341. /* force LOG not ready */
  342. gd->flags &= ~(GD_FLG_LOG_READY);
  343. gd->log_drop_count = 0;
  344. ut_assertok(console_record_reset_enable());
  345. log_run();
  346. ut_asserteq(gd->log_drop_count, 3 * (LOGL_COUNT - LOGL_FIRST - 1));
  347. check_log_entries_flags_levels(EXPECT_DEBUG, LOGL_FIRST, CONFIG_LOG_DEFAULT_LEVEL);
  348. gd->flags |= GD_FLG_LOG_READY;
  349. gd->log_drop_count = 0;
  350. return 0;
  351. }
  352. LOG_TEST_FLAGS(log_test_dropped, UT_TESTF_CONSOLE_REC);
  353. /* Check log_buffer() */
  354. int log_test_buffer(struct unit_test_state *uts)
  355. {
  356. u8 *buf;
  357. int i;
  358. buf = malloc(0x20);
  359. ut_assertnonnull(buf);
  360. memset(buf, '\0', 0x20);
  361. for (i = 0; i < 0x11; i++)
  362. buf[i] = i * 0x11;
  363. ut_assertok(console_record_reset_enable());
  364. log_buffer(LOGC_BOOT, LOGL_INFO, 0, buf, 1, 0x12, 0);
  365. /* This one should product no output due to the debug level */
  366. log_buffer(LOGC_BOOT, LOGL_DEBUG, 0, buf, 1, 0x12, 0);
  367. ut_assert_nextline("00000000: 00 11 22 33 44 55 66 77 88 99 aa bb cc dd ee ff ..\"3DUfw........");
  368. ut_assert_nextline("00000010: 10 00 ..");
  369. ut_assert_console_end();
  370. free(buf);
  371. return 0;
  372. }
  373. LOG_TEST_FLAGS(log_test_buffer, UT_TESTF_CONSOLE_REC);