OpenZFS on Linux and FreeBSD
Go to file
Turbo Fredriksson 30607d9b7b Document SPL module parameters.
This is a first draft of a spl-module-parameters(5) man page. I have
just extracted the parameter name and its description with modinfo,
then checked the source what type it is and its default value.

This will need more work, preferably someone that actually know these
values and what to use them for.  Similar to zfsonlinux/zfs#1856, but
for the spl.

Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov>
Closes zfsonlinux/zfs#1856
2013-11-21 12:32:41 -08:00
cmd Refresh links to web site 2013-03-04 19:09:34 -08:00
config Linux 3.12 compat: New shrinker API 2013-11-06 13:23:40 -08:00
include Linux 3.12 compat: New shrinker API 2013-11-06 13:23:40 -08:00
lib Remove autotools products 2012-08-27 11:46:23 -07:00
man Document SPL module parameters. 2013-11-21 12:32:41 -08:00
module Emulate illumos interface cv_timedwait_hires() 2013-11-04 09:49:24 -08:00
patches Reimplement rwlocks for Linux lock profiling/analysis. 2009-09-18 16:09:47 -07:00
rpm Document SPL module parameters. 2013-11-21 12:32:41 -08:00
scripts Add kmod repo integration 2013-08-01 10:27:34 -07:00
.gitignore Ignore *.{deb,rpm,tar.gz} files in the top directory. 2013-04-24 16:18:14 -07:00
AUTHORS Refresh AUTHORS 2012-12-19 09:40:18 -08:00
COPYING Public Release Prep 2010-05-17 15:18:00 -07:00
DISCLAIMER Public Release Prep 2010-05-17 15:18:00 -07:00
META Tag spl-0.6.2 2013-08-16 15:17:35 -07:00
Makefile.am build: do not call boilerplate ourself 2013-04-02 11:08:46 -07:00
README.markdown Document how to run SPLAT 2013-10-09 13:52:59 -07:00
autogen.sh build: do not call boilerplate ourself 2013-04-02 11:08:46 -07:00
configure.ac Document SPL module parameters. 2013-11-21 12:32:41 -08:00
copy-builtin Copy spl.release.in to kernel dir 2013-06-21 15:40:04 -07:00
spl.release.in Move spl.release generation to configure step 2012-07-12 12:13:47 -07:00

README.markdown

The Solaris Porting Layer (SPL) is a Linux kernel module which provides many of the Solaris kernel APIs. This shim layer makes it possible to run Solaris kernel code in the Linux kernel with relatively minimal modification. This can be particularly useful when you want to track upstream Solaris development closely and do not want the overhead of maintaining a large patch which converts Solaris primitives to Linux primitives.

To build packages for your distribution:

$ ./configure
$ make pkg

If you are building directly from the git tree and not an officially released tarball you will need to generate the configure script. This can be done by executing the autogen.sh script after installing the GNU autotools for your distribution.

To copy the kernel code inside your kernel source tree for builtin compilation:

$ ./configure --enable-linux-builtin --with-linux=/usr/src/linux-...
$ ./copy-builtin /usr/src/linux-...

The SPL comes with an automated test suite called SPLAT. The test suite is implemented in two parts. There is a kernel module which contains the tests and a user space utility which controls which tests are run. To run the full test suite:

$ sudo insmod ./module/splat/splat.ko
$ sudo ./cmd/splat --all

Full documentation for building, configuring, testing, and using the SPL can be found at: http://zfsonlinux.org