man/man1/splat.1

   1 '\" t
   2 .\"
   3 .\" Copyright 2013 Darik Horn <dajhorn@vanadac.com>. All rights reserved.
   4 .\"
   5 .TH splat 1 "2013 MAR 16" "ZFS on Linux" "User Commands"
   6
   7 .SH NAME
   8 splat \- Solaris Porting LAyer Tests
   9 .SH SYNOPSIS
  10 .LP
  11 .BI "splat [\-chvx] < \-\-all | \-\-list | \-\-test " "subsystem" ":" "test" " [...] >"
  12
  13 .SH DESCRIPTION
  14 This utility uses the splat.ko kernel module to test the spl.ko kernel
  15 module. Run "modprobe splat" before invoking \fBsplat\fR.
  16
  17 .SH OPTIONS
  18 .HP
  19 .BI "\-a" "" ", \-\-all" ""
  20 .IP
  21 Run all available tests on all subsystems.
  22 .HP
  23 .BI "\-c" "" ", \-\-nocolor" ""
  24 .IP
  25 Disable output highlighting. By default, "Fail" is printed in red text
  26 and "Pass" is printed in green text.
  27 .HP
  28 .BI "\-h" "" ", \-\-help" ""
  29 .IP
  30 Print the usage message.
  31 .HP
  32 .BI "\-l" "" ", \-\-list" ""
  33 .IP
  34 For each spl.ko subsystem, print all available test names and
  35 hexadecimal identifiers with a short description.
  36 .HP
  37 .BI "\-t" " subsystem" ":" "test" ", \-\-test" " subsystem" ":" "test"
  38 .HP
  39 .BI "\-t" " subsystem" ":all" "" ", \-\-test" " subsystem" ":all" ""
  40 .IP
  41 Run the \fItest\fR diagnostic routine for the spl.ko \fIsubsystem\fR.
  42 Specify this option more than once to run multiple tests.
  43
  44 The \fItest\fR and \fIsubsystem\fR parameters are the names or
  45 hexadecimal identifiers returned by the \fBsplat --list\fR command.
  46
  47 If \fIsubsystem\fR is a name and not a hexadecimal identifier, then the
  48 \fBall\fR keyword can be used to run all available \fIsubsystem\fR
  49 tests.
  50
  51 .HP
  52 .BI "\-v" "" ", \-\-verbose" ""
  53 .HP
  54 .IP
  55 Increase verbosity.
  56 .HP
  57 .BI "\-x" "" ", \-\-exit" ""
  58 .IP
  59 Stop running tests after the first failure.
  60
  61 .SH "EXAMPLES"
  62 .LP
  63 Test everything in the spl.ko kernel module:
  64 .IP
  65 # splat --all --verbose
  66 .LP
  67 Test the entire kernel memory subsystem:
  68 .IP
  69 # splat --test kmem:all
  70 .LP
  71 Test the kernel compression and queue waiting facilities:
  72 .IP
  73 # splat --test zlib:compress/uncompress --test taskq:wait
  74 .LP
  75 This is the same as the previous command, except that the subsystems
  76 and tests are referenced by hexadecimal identifier instead of by name:
  77 .IP
  78 # splat -t 0x0f00:0x0f01 -t 0x0200:0x0204
  79
  80 .SH "NOTES"
  81 All tests always return a green "Pass" result on a healthy system. Any
  82 red "Fail" result should be investigated or reported.
  83
  84 .SH "BUGS"
  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
  87 hardware.
  88
  89 .SH "AUTHORS"
  90 This man page was written by Darik Horn <dajhorn@vanadac.com>.
  91
  92 .SH "SEE ALSO"
  93 .BR zpios (1),
  94 .BR ztest (1)