3 .\" Copyright 2013 Darik Horn <dajhorn@vanadac.com>. All rights reserved.
5 .TH splat 1 "2013 MAR 16" "ZFS on Linux" "User Commands"
8 splat \- Solaris Porting LAyer Tests
11 .BI "splat [\-chvx] < \-\-all | \-\-list | \-\-test " "subsystem" ":" "test" " [...] >"
14 This utility uses the splat.ko kernel module to test the spl.ko kernel
15 module. Run "modprobe splat" before invoking \fBsplat\fR.
19 .BI "\-a" "" ", \-\-all" ""
21 Run all available tests on all subsystems.
23 .BI "\-c" "" ", \-\-nocolor" ""
25 Disable output highlighting. By default, "Fail" is printed in red text
26 and "Pass" is printed in green text.
28 .BI "\-h" "" ", \-\-help" ""
30 Print the usage message.
32 .BI "\-l" "" ", \-\-list" ""
34 For each spl.ko subsystem, print all available test names and
35 hexidecimal identifiers with a short description.
37 .BI "\-t" " subsystem" ":" "test" ", \-\-test" " subsystem" ":" "test"
39 .BI "\-t" " subsystem" ":all" "" ", \-\-test" " subsystem" ":all" ""
41 Run the \fItest\fR diagnostic routine for the spl.ko \fIsubsystem\fR.
42 Specify this option more than once to run multiple tests.
44 The \fItest\fR and \fIsubsystem\fR parameters are the names or
45 hexidecimal identifiers returned by the \fBsplat --list\fR command.
47 If \fIsubsystem\fR is a name and not a hexidecimal identifier, then the
48 \fBall\fR keyword can be used to run all available \fIsubsystem\fR
52 .BI "\-v" "" ", \-\-verbose" ""
57 .BI "\-x" "" ", \-\-exit" ""
59 Stop running tests after the first failure.
63 Test everything in the spl.ko kernel module:
65 # splat --all --verbose
67 Test the entire kernel memory subsystem:
69 # splat --test kmem:all
71 Test the kernel compression and queue waiting facilities:
73 # splat --test zlib:compress/uncompress --test taskq:wait
75 This is the same as the previous command, except that the subsystems
76 and tests are referenced by hexidecimal identifier instead of by name:
78 # splat -t 0x0f00:0x0f01 -t 0x0200:0x0204
81 All tests always return a green "Pass" result on a healthy system. Any
82 red "Fail" result should be investigated or reported.
85 Some tests can deadlock the kernel if an X11 desktop is running,
86 especially if a proprietary blob driver is loaded for the video
90 This man page was written by Darik Horn <dajhorn@vanadac.com>.