log.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * Logging support
  4. *
  5. * Copyright (c) 2017 Google, Inc
  6. * Written by Simon Glass <sjg@chromium.org>
  7. */
  8. #ifndef __LOG_H
  9. #define __LOG_H
  10. #include <stdio.h>
  11. #include <linker_lists.h>
  12. #include <dm/uclass-id.h>
  13. #include <linux/list.h>
  14. struct cmd_tbl;
  15. /** Log levels supported, ranging from most to least important */
  16. enum log_level_t {
  17. LOGL_EMERG = 0, /* U-Boot is unstable */
  18. LOGL_ALERT, /* Action must be taken immediately */
  19. LOGL_CRIT, /* Critical conditions */
  20. LOGL_ERR, /* Error that prevents something from working */
  21. LOGL_WARNING, /* Warning may prevent optimial operation */
  22. LOGL_NOTICE, /* Normal but significant condition, printf() */
  23. LOGL_INFO, /* General information message */
  24. LOGL_DEBUG, /* Basic debug-level message */
  25. LOGL_DEBUG_CONTENT, /* Debug message showing full message content */
  26. LOGL_DEBUG_IO, /* Debug message showing hardware I/O access */
  27. LOGL_COUNT,
  28. LOGL_NONE,
  29. LOGL_FIRST = LOGL_EMERG,
  30. LOGL_MAX = LOGL_DEBUG_IO,
  31. };
  32. /**
  33. * Log categories supported. Most of these correspond to uclasses (i.e.
  34. * enum uclass_id) but there are also some more generic categories
  35. */
  36. enum log_category_t {
  37. LOGC_FIRST = 0, /* First part mirrors UCLASS_... */
  38. LOGC_NONE = UCLASS_COUNT, /* First number is after all uclasses */
  39. LOGC_ARCH, /* Related to arch-specific code */
  40. LOGC_BOARD, /* Related to board-specific code */
  41. LOGC_CORE, /* Related to core features (non-driver-model) */
  42. LOGC_DM, /* Core driver-model */
  43. LOGC_DT, /* Device-tree */
  44. LOGC_EFI, /* EFI implementation */
  45. LOGC_ALLOC, /* Memory allocation */
  46. LOGC_SANDBOX, /* Related to the sandbox board */
  47. LOGC_BLOBLIST, /* Bloblist */
  48. LOGC_DEVRES, /* Device resources (devres_... functions) */
  49. /* Advanced Configuration and Power Interface (ACPI) */
  50. LOGC_ACPI,
  51. LOGC_COUNT, /* Number of log categories */
  52. LOGC_END, /* Sentinel value for a list of log categories */
  53. };
  54. /* Helper to cast a uclass ID to a log category */
  55. static inline int log_uc_cat(enum uclass_id id)
  56. {
  57. return (enum log_category_t)id;
  58. }
  59. /**
  60. * _log() - Internal function to emit a new log record
  61. *
  62. * @cat: Category of log record (indicating which subsystem generated it)
  63. * @level: Level of log record (indicating its severity)
  64. * @file: File name of file where log record was generated
  65. * @line: Line number in file where log record was generated
  66. * @func: Function where log record was generated
  67. * @fmt: printf() format string for log record
  68. * @...: Optional parameters, according to the format string @fmt
  69. * @return 0 if log record was emitted, -ve on error
  70. */
  71. int _log(enum log_category_t cat, enum log_level_t level, const char *file,
  72. int line, const char *func, const char *fmt, ...)
  73. __attribute__ ((format (__printf__, 6, 7)));
  74. static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
  75. const char *file, int line, const char *func,
  76. const char *fmt, ...)
  77. __attribute__ ((format (__printf__, 6, 7)));
  78. static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
  79. const char *file, int line, const char *func,
  80. const char *fmt, ...)
  81. {
  82. return 0;
  83. }
  84. /* Define this at the top of a file to add a prefix to debug messages */
  85. #ifndef pr_fmt
  86. #define pr_fmt(fmt) fmt
  87. #endif
  88. /* Use a default category if this file does not supply one */
  89. #ifndef LOG_CATEGORY
  90. #define LOG_CATEGORY LOGC_NONE
  91. #endif
  92. /*
  93. * This header may be including when CONFIG_LOG is disabled, in which case
  94. * CONFIG_LOG_MAX_LEVEL is not defined. Add a check for this.
  95. */
  96. #if CONFIG_IS_ENABLED(LOG)
  97. #define _LOG_MAX_LEVEL CONFIG_VAL(LOG_MAX_LEVEL)
  98. #define log_err(_fmt...) log(LOG_CATEGORY, LOGL_ERR, ##_fmt)
  99. #define log_warning(_fmt...) log(LOG_CATEGORY, LOGL_WARNING, ##_fmt)
  100. #define log_notice(_fmt...) log(LOG_CATEGORY, LOGL_NOTICE, ##_fmt)
  101. #define log_info(_fmt...) log(LOG_CATEGORY, LOGL_INFO, ##_fmt)
  102. #define log_debug(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG, ##_fmt)
  103. #define log_content(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_CONTENT, ##_fmt)
  104. #define log_io(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
  105. #else
  106. #define _LOG_MAX_LEVEL LOGL_INFO
  107. #define log_err(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
  108. #define log_warning(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
  109. #define log_notice(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
  110. #define log_info(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
  111. #define log_debug(_fmt, ...) debug(_fmt, ##__VA_ARGS__)
  112. #define log_content(_fmt...) log_nop(LOG_CATEGORY, \
  113. LOGL_DEBUG_CONTENT, ##_fmt)
  114. #define log_io(_fmt...) log_nop(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
  115. #endif
  116. #if CONFIG_IS_ENABLED(LOG)
  117. #ifdef LOG_DEBUG
  118. #define _LOG_DEBUG 1
  119. #else
  120. #define _LOG_DEBUG 0
  121. #endif
  122. /* Emit a log record if the level is less that the maximum */
  123. #define log(_cat, _level, _fmt, _args...) ({ \
  124. int _l = _level; \
  125. if (CONFIG_IS_ENABLED(LOG) && (_l <= _LOG_MAX_LEVEL || _LOG_DEBUG)) \
  126. _log((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
  127. __func__, \
  128. pr_fmt(_fmt), ##_args); \
  129. })
  130. #else
  131. #define log(_cat, _level, _fmt, _args...)
  132. #endif
  133. #define log_nop(_cat, _level, _fmt, _args...) ({ \
  134. int _l = _level; \
  135. _log_nop((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
  136. __func__, pr_fmt(_fmt), ##_args); \
  137. })
  138. #ifdef DEBUG
  139. #define _DEBUG 1
  140. #else
  141. #define _DEBUG 0
  142. #endif
  143. #ifdef CONFIG_SPL_BUILD
  144. #define _SPL_BUILD 1
  145. #else
  146. #define _SPL_BUILD 0
  147. #endif
  148. #if !_DEBUG && CONFIG_IS_ENABLED(LOG)
  149. #define debug_cond(cond, fmt, args...) \
  150. do { \
  151. if (1) \
  152. log(LOG_CATEGORY, LOGL_DEBUG, fmt, ##args); \
  153. } while (0)
  154. #else /* _DEBUG */
  155. /*
  156. * Output a debug text when condition "cond" is met. The "cond" should be
  157. * computed by a preprocessor in the best case, allowing for the best
  158. * optimization.
  159. */
  160. #define debug_cond(cond, fmt, args...) \
  161. do { \
  162. if (cond) \
  163. printf(pr_fmt(fmt), ##args); \
  164. } while (0)
  165. #endif /* _DEBUG */
  166. /* Show a message if DEBUG is defined in a file */
  167. #define debug(fmt, args...) \
  168. debug_cond(_DEBUG, fmt, ##args)
  169. /* Show a message if not in SPL */
  170. #define warn_non_spl(fmt, args...) \
  171. debug_cond(!_SPL_BUILD, fmt, ##args)
  172. /*
  173. * An assertion is run-time check done in debug mode only. If DEBUG is not
  174. * defined then it is skipped. If DEBUG is defined and the assertion fails,
  175. * then it calls panic*( which may or may not reset/halt U-Boot (see
  176. * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
  177. * before release, and after release it is hoped that they don't matter. But
  178. * in any case these failing assertions cannot be fixed with a reset (which
  179. * may just do the same assertion again).
  180. */
  181. void __assert_fail(const char *assertion, const char *file, unsigned int line,
  182. const char *function);
  183. /**
  184. * assert() - assert expression is true
  185. *
  186. * If the expression x evaluates to false and _DEBUG evaluates to true, a panic
  187. * message is written and the system stalls. The value of _DEBUG is set to true
  188. * if DEBUG is defined before including common.h.
  189. *
  190. * The expression x is always executed irrespective of the value of _DEBUG.
  191. *
  192. * @x: expression to test
  193. */
  194. #define assert(x) \
  195. ({ if (!(x) && _DEBUG) \
  196. __assert_fail(#x, __FILE__, __LINE__, __func__); })
  197. /*
  198. * This one actually gets compiled in even without DEBUG. It doesn't include the
  199. * full pathname as it may be huge. Only use this when the user should be
  200. * warning, similar to BUG_ON() in linux.
  201. *
  202. * @return true if assertion succeeded (condition is true), else false
  203. */
  204. #define assert_noisy(x) \
  205. ({ bool _val = (x); \
  206. if (!_val) \
  207. __assert_fail(#x, "?", __LINE__, __func__); \
  208. _val; \
  209. })
  210. #if CONFIG_IS_ENABLED(LOG) && defined(CONFIG_LOG_ERROR_RETURN)
  211. /*
  212. * Log an error return value, possibly with a message. Usage:
  213. *
  214. * return log_ret(fred_call());
  215. *
  216. * or:
  217. *
  218. * return log_msg_ret("fred failed", fred_call());
  219. */
  220. #define log_ret(_ret) ({ \
  221. int __ret = (_ret); \
  222. if (__ret < 0) \
  223. log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
  224. __ret; \
  225. })
  226. #define log_msg_ret(_msg, _ret) ({ \
  227. int __ret = (_ret); \
  228. if (__ret < 0) \
  229. log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
  230. __ret); \
  231. __ret; \
  232. })
  233. #else
  234. /* Non-logging versions of the above which just return the error code */
  235. #define log_ret(_ret) (_ret)
  236. #define log_msg_ret(_msg, _ret) ((void)(_msg), _ret)
  237. #endif
  238. /**
  239. * struct log_rec - a single log record
  240. *
  241. * Holds information about a single record in the log
  242. *
  243. * Members marked as 'not allocated' are stored as pointers and the caller is
  244. * responsible for making sure that the data pointed to is not overwritten.
  245. * Memebers marked as 'allocated' are allocated (e.g. via strdup()) by the log
  246. * system.
  247. *
  248. * @cat: Category, representing a uclass or part of U-Boot
  249. * @level: Severity level, less severe is higher
  250. * @file: Name of file where the log record was generated (not allocated)
  251. * @line: Line number where the log record was generated
  252. * @func: Function where the log record was generated (not allocated)
  253. * @msg: Log message (allocated)
  254. */
  255. struct log_rec {
  256. enum log_category_t cat;
  257. enum log_level_t level;
  258. const char *file;
  259. int line;
  260. const char *func;
  261. const char *msg;
  262. };
  263. struct log_device;
  264. /**
  265. * struct log_driver - a driver which accepts and processes log records
  266. *
  267. * @name: Name of driver
  268. */
  269. struct log_driver {
  270. const char *name;
  271. /**
  272. * emit() - emit a log record
  273. *
  274. * Called by the log system to pass a log record to a particular driver
  275. * for processing. The filter is checked before calling this function.
  276. */
  277. int (*emit)(struct log_device *ldev, struct log_rec *rec);
  278. };
  279. /**
  280. * struct log_device - an instance of a log driver
  281. *
  282. * Since drivers are set up at build-time we need to have a separate device for
  283. * the run-time aspects of drivers (currently just a list of filters to apply
  284. * to records send to this device).
  285. *
  286. * @next_filter_num: Seqence number of next filter filter added (0=no filters
  287. * yet). This increments with each new filter on the device, but never
  288. * decrements
  289. * @drv: Pointer to driver for this device
  290. * @filter_head: List of filters for this device
  291. * @sibling_node: Next device in the list of all devices
  292. */
  293. struct log_device {
  294. int next_filter_num;
  295. struct log_driver *drv;
  296. struct list_head filter_head;
  297. struct list_head sibling_node;
  298. };
  299. enum {
  300. LOGF_MAX_CATEGORIES = 5, /* maximum categories per filter */
  301. };
  302. enum log_filter_flags {
  303. LOGFF_HAS_CAT = 1 << 0, /* Filter has a category list */
  304. };
  305. /**
  306. * struct log_filter - criterial to filter out log messages
  307. *
  308. * @filter_num: Sequence number of this filter. This is returned when adding a
  309. * new filter, and must be provided when removing a previously added
  310. * filter.
  311. * @flags: Flags for this filter (LOGFF_...)
  312. * @cat_list: List of categories to allow (terminated by LOGC_none). If empty
  313. * then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
  314. * can be provided
  315. * @max_level: Maximum log level to allow
  316. * @file_list: List of files to allow, separated by comma. If NULL then all
  317. * files are permitted
  318. * @sibling_node: Next filter in the list of filters for this log device
  319. */
  320. struct log_filter {
  321. int filter_num;
  322. int flags;
  323. enum log_category_t cat_list[LOGF_MAX_CATEGORIES];
  324. enum log_level_t max_level;
  325. const char *file_list;
  326. struct list_head sibling_node;
  327. };
  328. #define LOG_DRIVER(_name) \
  329. ll_entry_declare(struct log_driver, _name, log_driver)
  330. /**
  331. * log_get_cat_name() - Get the name of a category
  332. *
  333. * @cat: Category to look up
  334. * @return category name (which may be a uclass driver name) if found, or
  335. * "<invalid>" if invalid, or "<missing>" if not found
  336. */
  337. const char *log_get_cat_name(enum log_category_t cat);
  338. /**
  339. * log_get_cat_by_name() - Look up a category by name
  340. *
  341. * @name: Name to look up
  342. * @return category ID, or LOGC_NONE if not found
  343. */
  344. enum log_category_t log_get_cat_by_name(const char *name);
  345. /**
  346. * log_get_level_name() - Get the name of a log level
  347. *
  348. * @level: Log level to look up
  349. * @return log level name (in ALL CAPS)
  350. */
  351. const char *log_get_level_name(enum log_level_t level);
  352. /**
  353. * log_get_level_by_name() - Look up a log level by name
  354. *
  355. * @name: Name to look up
  356. * @return log level ID, or LOGL_NONE if not found
  357. */
  358. enum log_level_t log_get_level_by_name(const char *name);
  359. /* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */
  360. enum log_fmt {
  361. LOGF_CAT = 0,
  362. LOGF_LEVEL,
  363. LOGF_FILE,
  364. LOGF_LINE,
  365. LOGF_FUNC,
  366. LOGF_MSG,
  367. LOGF_COUNT,
  368. LOGF_DEFAULT = (1 << LOGF_FUNC) | (1 << LOGF_MSG),
  369. LOGF_ALL = 0x3f,
  370. };
  371. /* Handle the 'log test' command */
  372. int do_log_test(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
  373. /**
  374. * log_add_filter() - Add a new filter to a log device
  375. *
  376. * @drv_name: Driver name to add the filter to (since each driver only has a
  377. * single device)
  378. * @cat_list: List of categories to allow (terminated by LOGC_none). If empty
  379. * then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
  380. * can be provided
  381. * @max_level: Maximum log level to allow
  382. * @file_list: List of files to allow, separated by comma. If NULL then all
  383. * files are permitted
  384. * @return the sequence number of the new filter (>=0) if the filter was added,
  385. * or a -ve value on error
  386. */
  387. int log_add_filter(const char *drv_name, enum log_category_t cat_list[],
  388. enum log_level_t max_level, const char *file_list);
  389. /**
  390. * log_remove_filter() - Remove a filter from a log device
  391. *
  392. * @drv_name: Driver name to remove the filter from (since each driver only has
  393. * a single device)
  394. * @filter_num: Filter number to remove (as returned by log_add_filter())
  395. * @return 0 if the filter was removed, -ENOENT if either the driver or the
  396. * filter number was not found
  397. */
  398. int log_remove_filter(const char *drv_name, int filter_num);
  399. #if CONFIG_IS_ENABLED(LOG)
  400. /**
  401. * log_init() - Set up the log system ready for use
  402. *
  403. * @return 0 if OK, -ENOMEM if out of memory
  404. */
  405. int log_init(void);
  406. #else
  407. static inline int log_init(void)
  408. {
  409. return 0;
  410. }
  411. #endif
  412. #endif