log.h 12 KB

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