Debug and Logging - Debug and Logging - UG1586

Onload supports various debug and logging options. Logging and debug information will be displayed on an attached console or will be sent to the syslog. To force all debug to the syslog set the Onload environment variable EF_LOG_VIA_IOCTL=1.

For more information about debug/logging environment variables refer to Parameter Reference.

To enable debug and logging using the options below, Onload must be installed with debug enabled:

• When Onload is installed from a source RPM, add the --define "debug true" option to the rpmbuild command line. For example:

  # rpmbuild --define "debug true" --rebuild onload-<version>.src.rpm

• When Onload is installed from a source DEB, add the --build-profiles=pkg.onload.debug option to the debuild command line. For example:

  # debuild -i -uc -us --build-profiles=pkg.onload.debug

• When Onload is installed from a source tarball, add the --debug option to the onload_install command line. For example:

  # ./onload_install --debug

If Onload is already installed but debug is not enabled, uninstall as described in Removing an Existing Installation. Then re-install as shown above.

Log options are as follows:

• EF_UNIX_LOG - A bitmask of the types of diagnostic messages to be logged.
• EF_LOG - A comma separated list options which can be logged, enabled, disabled.
• EF_LOG_FILE - When EF_LOG_VIA_IOCTL is unset, the user is able to redirect Onload output to a specified directory and file using the EF_LOG_FILE option. Timestamps can also be added to the logfile when EF_LOG_TIMESTAMPS is also enabled.

  EF_LOG_FILE=<path/file>

  Note: Kernel logging is still directed to the syslog.
• TP_LOG (bitmask) - useful for stack debugging. See Onload source code /src/include/ci/internal/ip_log.h for bit values.
• Control plane module option:
  • cplane_debug_bits=[bitmask] - useful for kernel logging and events involving the control plane. See src/include/cplane/debug.h for bit values.
• Onload module options:
  • ci_tp_log=[bitmask] - useful for kernel logging and events involving an onload stack. See Onload source code /src/include/ci/internal/ip_log.h for details.
  • oo_debug_bits=[bitmask] - useful for kernel logging and events not involving an onload stack or the control plane. See src/include/onload/debug.h for bit values.