Lustre Debugging Procedures

The procedures below may be useful to administrators or developers debugging a Lustre™ file system.

Understanding the Lustre debug messaging format
Lustre debug messages are categorized by originating subsystem, message type, and location in the source code. For a list of subsystems and message types, see |Section 23.1 Lustre Debug Messages in the Lustre Operations Manual.

Note: For a current list of subsystems and debug message types, see lnet/include/libcfs/libcfs.h Keep this note?

The elements of a Lustre debug message are described in |Section 23.1.1 Format of Lustre Debug Messages in the Lustre Operations Manual.

Using the lctl tool to view debug messages
The lctl tool allows debug messages to be filtered based on subsystems and message types to extract information useful for troubleshooting from a kernel debug log. 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.

A sample lctl run is shown in | Section 23.2.7 Sample lctl Run in the Lustre Operations Manual.

Using the lctl debug daemon option to dump the buffer to a file
The debug_daemon option is used by lctl to control the dumping of the debug_kernel buffer to a user-specified file. For more information about the debug daemon including a list of commands, see | Section 23.2.1 Debug Daemon Option to lctl in the Lustre Operations Manual.

Controlling the information written to the kernel debug log
Masks are provided in /proc/sys/lnet/subsystem_debug and /proc/sys/lnet/debug to be used with the systctl command to determine what information is to be written to the debug log. For more information and examples, see |Section 23.2.2 Controlling the Kernel Debug Log in the Lustre Operations Manual.

Using strace to trace system calls
The strace utility made available by the operating system ...provided with the Linux distribution?. ...enables a system call to be traced by intercepting all the systems calls made by a process and record the system call name, arguments, and return values. For more details and examples, see |Section 23.3 Troubleshooting with strace in the Lustre Operations Manual.

Looking at disk content
In Lustre, the inodes on the metadata server contain extended attributes (EAs) that store information about file striping. EAs contain a list of all object IDs and their locations (that is, the OST that stores them). The lfs tool can be used to obtain this information for a given file via the getstripe sub-command. For more information, see see |Section 23.4 Looking at Disk Content in the Lustre Operations Manual.

Finding the Lustre UUID of an OST
To determine the Lustre UUID of an obdfilter disk (for example, if you mix up the cables on your OST devices, or the SCSI bus numbering suddenly changes and the SCSI devices get new names), use debugfs to get the last_rcvd file.

Decoding Lustre message packets with tcpdump
Lustre provides a modified version of tcpdump that helps to decode the complete Lustre message packet. This tool has more support for reading packets from clients to OSTs than for decoding packets between clients and MDSs. The tcpdump module is available at www.sourceforge.net

It can be checked out as:

cvs co -d :ext: @cvs.lustre.org:/cvsroot/lustre tcpdump

http://sourceforge.net/projects/tcpdump/ can it be downloaded from here instead?

Printing debug messages to the console
To dump debug messages to the console (/var/log/messages), set the corresponding debug mask in the printk flag: sysctl -w lnet.printk=-1

This slows down the system dramatically, so it is also possible to selectively enable or disable this capability for particular flags: sysctl -w lnet.printk=+vfstrace sysctl -w lnet.printk=-vfstrace

Keep and add to manual? In newer versions of Lustre (1.4.12, 1.6.5) it is even possible to disable warning, error, and console messages, though it is strongly recommended to have something like lctl debug_daemon running to capture this data to a local filesystem for debugging purposes.

Tracing lock traffic
Lustre has a specific debug type category for tracing lock traffic. Use:

lctl> filter all_types lctl> show dlmtrace lctl> debug_kernel [filename]