Diagnostic and Debugging Tools

A variety of diagnostic and analysis tools are available to debug issues with the Lustre™ software. Some of these are provided in Linux distributions, while others have been developed and are made available by the Lustre project.

Lustre Debugging Tools
The following in-kernel debug mechanisms are incorporated into the Lustre software:


 * Debug logs. A circular debug buffer to which Lustre internal debug messages are written (in contrast to error messages, which are printed to the syslog or console). Entries to the Lustre debug log are controlled by the mask set by /proc/sys/lnet/debug. The log size defaults to 5 MB per CPU but can be increased as a busy system will quickly overwrite 5 MB. When the buffer fills, the oldest information is discarded.


 * Debug daemon. The debug daemon controls logging of debug messages.


 * /proc/sys/lnet/debug. This utility? tool? function? contains? a mask that can be used to delimit the debugging information written out to the kernel debug logs.

These tools are also provided with the Lustre software:


 * lctl. This tool is used with the debug_kernel option to dump the Lustre debugging log ...to manually dump the log and post-process logs that are dumped automatically. For more information about the lctl tool, see | Section 23.2.3 The lctl Tool and | Section 31.3 lctl in the Lustre Operations Manual.


 * Lustre subsystem asserts. In case of asserts, a log writes at /tmp/lustre_log. .


 * lfs. This utility provides access to the extended attributes of a Lustre file (among other information).

Tools for administrators and developers
The tools described in this section are provided in the Linux kernel or are available at an external website.

Some general debugging tools are:


 * strace. This tool allows a system call to be traced.


 * /var/log/messages. syslogd prints fatal or serious messages at this log.


 * Crash dumps. On crash-dump enabled kernels, sysrq c produces a crash dump. Lustre enhances this crash dump with a log dump (the last 64 KB of the log) to the console.


 * debugfs. Interactive file system debugger.

The following logging and data collection tools can be used to collect information for debugging Lustre kernel issues:


 * kdump. A Linux kernel crash utility useful for debugging a system running Red Hat Enterprise Linux. For more information about kdump, see the Red Hat knowledge base article How do I configure kexec/kdump on Red Hat Enterprise Linux 5?. To download kdump, go to the Fedora Project Download site.


 * netdump. A crash dump utility from Red Hat that allows memory images to be dumped over a network to a central server for analysis. It is now obsolete and has been replaced by kdump. Check this with brian murrell - send email 1/28.


 * netconsole. Supports kernel-level network logging over UDP. A system requires (SysRq) allows users to collect relevant data through netconsole. For more information, see Netconsole. Content is still relevant - check that it is accurate

Tools for developers
The tools described in this section may be useful for debugging Lustre™ in a development environment.

Of general interest is:


 * leak_finder.pl. This program is useful for finding memory leaks in the code.

A virtual machine is often used to create an isolated development and test environment. Some popular virtual machines are:


 * VirtualBox Open Source Edition. Provides enterprise-class virtualization capability for all major platforms and is available free from Sun Microsystems at Get Sun Virtual Box.


 * VMware Server. Virtualization platform available as free introductory software at Download VMware Server.


 * Xen. A para-virtualized environment with virtualization capabilities similar to VMware Server and Virtual Box. However, Xen allows the use of modified kernels to provide near-native performance and the ability to emulate shared storage. For more information, see Using Xen with Lustre or go to xen.org]


 * Parinay is planning to "include KVM here and how lustre can be deployed on it". See BZ 21381

A variety of debuggers and analysis tools are available including:


 * kgdb. A source-level kernel debugger that allows remote debugging using conman. kgdb provides a special set of hooks for a Linux kernel to attach gdb from another machine over a serial console. We provide kgdb patches for some kernels like rhel4 with the Lustre patches (these are not patched in by default). Update needed?

For more information, see KGDB and Using kgdb with UDP.

Also see [http://www.linuxtopia.org/online_books/redhat_linux_debugging_with_gdb/running.html ''Chapter 6. Running Programs Under gdb] in the Red Hat Linux 4 Debugging with GDB'' guide.

NOTES - KGDB topic - ask Alex BZZZ or Robert Reid - instructions are old and not specific to Lustre - do we want to keep these around or find link to eternal site - sourceforge site has a ton of information.

1. Get patches from ftp://ftp.kernel.org/pub/linux/kernel/people/akpm/patches/2.5/

- VmWare instructions on this page are specific to using cdb with VmWare - but are OLD!

- For other external tools - provide pointer rather than maintain documentation on wiki. See IX4


 * lcrash. A utility that generates detailed kernel information and provides the ability to generate reports about system crash dumps. For more information, see | man page. Is this a good link?


 * crash. Red Hat Crash Utility?? is used to analyze saved crash dump data when a system had panicked or locked up or appears unresponsive.

Enter: crash vmlinux crash_dump keep this?


 * For more information about using crash to analyze crash dump output, see:


 * - Red Hat Magazine article A quick overview of Linux kernel crash dump analysis.
 * - Crash Usage: A Case Study from the white paper Red Hat Crash Utility by David Anderson.
 * - Kernel Trap forum entry Linux: Kernel Crash Dumps.
 * - White paper A Quick Overview of Linux Kernel Crash Dump Analysis.

NOTES See Tien's suggestion BZ 21334 []