doc/README.log

   1 Logging in U-Boot
   2 =================
   3
   4 Introduction
   5 ------------
   6
   7 U-Boot's internal operation involves many different steps and actions. From
   8 setting up the board to displaying a start-up screen to loading an Operating
   9 System, there are many component parts each with many actions.
  10
  11 Most of the time this internal detail is not useful. Displaying it on the
  12 console would delay booting (U-Boot's primary purpose) and confuse users.
  13
  14 But for digging into what is happening in a particular area, or for debugging
  15 a problem it is often useful to see what U-Boot is doing in more detail than
  16 is visible from the basic console output.
  17
  18 U-Boot's logging feature aims to satisfy this goal for both users and
  19 developers.
  20
  21
  22 Logging levels
  23 --------------
  24
  25 There are a number logging levels available, in increasing order of verbosity:
  26
  27    LOGL_EMERG   - Printed before U-Boot halts
  28    LOGL_ALERT   - Indicates action must be taken immediate or U-Boot will crash
  29    LOGL_CRIT    - Indicates a critical error that will cause boot failure
  30    LOGL_ERR     - Indicates an error that may cause boot failure
  31    LOGL_WARNING - Warning about an unexpected condition
  32    LOGL_NOTE    - Important information about progress
  33    LOGL_INFO    - Information about normal boot progress
  34    LOGL_DEBUG   - Debug information (useful for debugging a driver or subsystem)
  35    LOGL_DEBUG_CONTENT   - Debug message showing full message content
  36    LOGL_DEBUG_IO        - Debug message showing hardware I/O access
  37
  38
  39 Logging category
  40 ----------------
  41
  42 Logging can come from a wide variety of places within U-Boot. Each log message
  43 has a category which is intended to allow messages to be filtered according to
  44 their source.
  45
  46 The following main categories are defined:
  47
  48    LOGC_NONE    - Unknown category (e.g. a debug() statement)
  49    UCLASS_...   - Related to a particular uclass (e.g. UCLASS_USB)
  50    LOGC_ARCH    - Related to architecture-specific code
  51    LOGC_BOARD   - Related to board-specific code
  52    LOGC_CORE    - Related to core driver-model support
  53    LOGC_DT      - Related to device tree control
  54    LOGC_EFI     - Related to EFI implementation
  55
  56
  57 Enabling logging
  58 ----------------
  59
  60 The following options are used to enable logging at compile time:
  61
  62    CONFIG_LOG           - Enables the logging system
  63    CONFIG_MAX_LOG_LEVEL - Max log level to build (anything higher is compiled
  64                                 out)
  65    CONFIG_LOG_CONSOLE   - Enable writing log records to the console
  66
  67 If CONFIG_LOG is not set, then no logging will be available.
  68
  69 The above have SPL versions also, e.g. CONFIG_SPL_MAX_LOG_LEVEL.
  70
  71
  72 Convenience functions
  73 ---------------------
  74
  75 A number of convenience functions are available to shorten the code needed
  76 for logging:
  77
  78         log_err(_fmt...)
  79         log_warning(_fmt...)
  80         log_notice(_fmt...)
  81         log_info(_fmt...)
  82         log_debug(_fmt...)
  83         log_content(_fmt...)
  84         log_io(_fmt...)
  85
  86 With these the log level is implicit in the name. The category is set by
  87 LOG_CATEGORY, which you can only define once per file, above all #includes:
  88
  89         #define LOG_CATEGORY LOGC_ALLOC
  90
  91 or
  92
  93         #define LOG_CATEGORY UCLASS_SPI
  94
  95 Remember that all uclasses IDs are log categories too.
  96
  97
  98 Log commands
  99 ------------
 100
 101 The 'log' command provides access to several features:
 102
 103    level - access the default log level
 104    format - access the console log format
 105    rec - output a log record
 106    test - run tests
 107
 108 Type 'help log' for details.
 109
 110
 111 Using DEBUG
 112 -----------
 113
 114 U-Boot has traditionally used a #define called DEBUG to enable debugging on a
 115 file-by-file basis. The debug() macro compiles to a printf() statement if
 116 DEBUG is enabled, and an empty statement if not.
 117
 118 With logging enabled, debug() statements are interpreted as logging output
 119 with a level of LOGL_DEBUG and a category of LOGC_NONE.
 120
 121 The logging facilities are intended to replace DEBUG, but if DEBUG is defined
 122 at the top of a file, then it takes precedence. This means that debug()
 123 statements will result in output to the console and this output will not be
 124 logged.
 125
 126
 127 Logging destinations
 128 --------------------
 129
 130 If logging information goes nowhere then it serves no purpose. U-Boot provides
 131 several possible determinations for logging information, all of which can be
 132 enabled or disabled independently:
 133
 134    console - goes to stdout
 135
 136
 137 Log format
 138 ----------
 139
 140 You can control the log format using the 'log format' command. The basic
 141 format is:
 142
 143    LEVEL.category,file.c:123-func() message
 144
 145 In the above, file.c:123 is the filename where the log record was generated and
 146 func() is the function name. By default ('log format default') only the
 147 function name and message are displayed on the console. You can control which
 148 fields are present, but not the field order.
 149
 150
 151 Filters
 152 -------
 153
 154 Filters are attached to log drivers to control what those drivers emit. Only
 155 records that pass through the filter make it to the driver.
 156
 157 Filters can be based on several criteria:
 158
 159    - maximum log level
 160    - in a set of categories
 161    - in a set of files
 162
 163 If no filters are attached to a driver then a default filter is used, which
 164 limits output to records with a level less than CONFIG_LOG_MAX_LEVEL.
 165
 166
 167 Logging statements
 168 ------------------
 169
 170 The main logging function is:
 171
 172    log(category, level, format_string, ...)
 173
 174 Also debug() and error() will generate log records  - these use LOG_CATEGORY
 175 as the category, so you should #define this right at the top of the source
 176 file to ensure the category is correct.
 177
 178 You can also define CONFIG_LOG_ERROR_RETURN to enable the log_ret() macro. This
 179 can be used whenever your function returns an error value:
 180
 181    return log_ret(uclass_first_device(UCLASS_MMC, &dev));
 182
 183 This will write a log record when an error code is detected (a value < 0). This
 184 can make it easier to trace errors that are generated deep in the call stack.
 185
 186
 187 Code size
 188 ---------
 189
 190 Code size impact depends largely on what is enabled. The following numbers are
 191 generated by 'buildman -S' for snow, which is a Thumb-2 board (all units in
 192 bytes):
 193
 194 This series: adds bss +20.0 data +4.0 rodata +4.0 text +44.0
 195 CONFIG_LOG: bss -52.0 data +92.0 rodata -635.0 text +1048.0
 196 CONFIG_LOG_MAX_LEVEL=7: bss +188.0 data +4.0 rodata +49183.0 text +98124.0
 197
 198 The last option turns every debug() statement into a logging call, which
 199 bloats the code hugely. The advantage is that it is then possible to enable
 200 all logging within U-Boot.
 201
 202
 203 To Do
 204 -----
 205
 206 There are lots of useful additions that could be made. None of the below is
 207 implemented! If you do one, please add a test in test/py/tests/test_log.py
 208
 209 Convenience functions to support setting the category:
 210
 211    log_arch(level, format_string, ...) - category LOGC_ARCH
 212    log_board(level, format_string, ...) - category LOGC_BOARD
 213    log_core(level, format_string, ...) - category LOGC_CORE
 214    log_dt(level, format_string, ...) - category LOGC_DT
 215
 216 More logging destinations:
 217
 218    device - goes to a device (e.g. serial)
 219    buffer - recorded in a memory buffer
 220
 221 Convert debug() statements in the code to log() statements
 222
 223 Support making printf() emit log statements a L_INFO level
 224
 225 Convert error() statements in the code to log() statements
 226
 227 Figure out what to do with BUG(), BUG_ON() and warn_non_spl()
 228
 229 Figure out what to do with assert()
 230
 231 Add a way to browse log records
 232
 233 Add a way to record log records for browsing using an external tool
 234
 235 Add commands to add and remove filters
 236
 237 Add commands to add and remove log devices
 238
 239 Allow sharing of printf format strings in log records to reduce storage size
 240 for large numbers of log records
 241
 242 Add a command-line option to sandbox to set the default logging level
 243
 244 Convert core driver model code to use logging
 245
 246 Convert uclasses to use logging with the correct category
 247
 248 Consider making log() calls emit an automatic newline, perhaps with a logn()
 249    function to avoid that
 250
 251 Passing log records through to linux (e.g. via device tree /chosen)
 252
 253 Provide a command to access the number of log records generated, and the
 254 number dropped due to them being generated before the log system was ready.
 255
 256 Add a printf() format string pragma so that log statements are checked properly
 257
 258 Enhance the log console driver to show level / category / file / line
 259 information
 260
 261 Add a command to add new log records and delete existing records.
 262
 263 Provide additional log() functions - e.g. logc() to specify the category
 264
 265 --
 266 Simon Glass <sjg@chromium.org>
 267 15-Sep-17