OpenZFS on Linux and FreeBSD
Go to file
Brian Behlendorf eafcafe72f Merge commit 'refs/top-bases/linux-zfs-branch' into linux-zfs-branch 2009-02-06 10:12:35 -08:00
build Refresh zfs-branch 2008-12-05 09:46:11 -08:00
cmd Merge branch 'linux-arc' into refs/top-bases/linux-zfs-branch 2009-01-15 15:54:39 -08:00
config Properly detect and set HAVE_GPL_ONLY_SYMBOLS based on license 2009-02-03 09:59:54 -08:00
doc Refresh linux-docs 2008-12-05 10:20:45 -08:00
lib Merge branch 'linux-have-sysevent' into refs/top-bases/linux-zfs-branch 2009-02-03 09:46:36 -08:00
module Merge branch 'linux-arc' into refs/top-bases/linux-zfs-branch 2009-02-06 10:12:34 -08:00
scripts Updated script to actually make name 2009-02-03 09:28:19 -08:00
.topdeps New TopGit dependency: linux-ztest 2009-01-14 13:38:26 -08:00
.topmsg Moving GIT to master for easier reference 2009-01-20 15:35:40 -08:00
AUTHORS Refresh zfs-branch 2008-12-05 09:46:11 -08:00
COPYING Relocate COPYING+COPYRIGHT, remove README cruft 2008-12-01 15:34:53 -08:00
COPYRIGHT Relocate COPYING+COPYRIGHT, remove README cruft 2008-12-01 15:34:53 -08:00
ChangeLog Merge branch 'linux-arc' into refs/top-bases/linux-zfs-branch 2009-02-05 15:21:35 -08:00
DISCLAIMER Initial Linux ZFS GIT Repo 2008-11-20 12:01:55 -08:00
GIT Refresh type in topgit git://* reference 2009-01-26 21:58:32 -08:00
META Prep for zfs-0.4.2 tag 2009-02-05 15:19:27 -08:00
Makefile.am Update avl, nvpair, spl to unique build dirs 2008-12-11 13:54:57 -08:00
OPENSOLARIS.LICENSE Add CDDL license file 2008-12-01 14:49:34 -08:00
README Refresh README 2009-01-20 16:16:57 -08:00
TODO Update TODO 2009-02-04 16:25:09 -08:00
ZFS.RELEASE Rebase master to b105 2009-01-15 13:59:39 -08:00
autogen.sh Update EXTRA_DIST 2008-12-05 14:56:15 -08:00
configure.ac Merge branch 'linux-arc' into refs/top-bases/linux-zfs-branch 2009-02-03 10:02:02 -08:00

README

============================ ZFS KERNEL BUILD ============================

1) Build the SPL (Solaris Porting Layer) module which is designed to
   provide many Solaris APIs in the Linux kernel which are needed
   by ZFS.  To build the SPL:

        tar -xzf spl-x.y.z.tgz
        cd spl-x.y.z
        ./configure --with-linux=<kernel src>
        make
        make check <as root>

2) Build ZFS, this port is based on build specified by the ZFS.RELEASE
   file.  You will need to have both the kernel and SPL source available.
   To build ZFS for use as a Linux kernel module.

        tar -xzf zfs-x.y.z.tgz
        cd zfs-x.y.z
        ./configure --with-linux=<kernel src> \
                    --with-spl=<spl src>
        make
        make check <as root>

============================ ZPIOS TEST SUITE ============================

3) Provided is an in-kernel test application called zpios which can be
   used to simulate a parallel IO load.  It may be used as a stress 
   or performance test for your configuration.  To simplify testing
   scripts provided in the scripts/ directory which provide a few
   pre-built zpool configurations and zpios test cases.  By default
   'make check' as root will run a simple test against several small
   loopback devices created in /tmp/.

       cd scripts
       ./zfs.sh					# Load the ZFS/SPL modules
       ./zpios.sh -c lo-raid0.sh -t tiny -v 	# Tiny zpios loopback test
       ./zfs.sh -u				# Unload the ZFS/SPL modules

Enjoy,
Brian Behlendorf <behlendorf1@llnl.gov>