OpenZFS on Linux and FreeBSD
Go to file
Brian Behlendorf 6557748feb Merge branch 'linux-libspl' into refs/top-bases/linux-zfs-branch 2009-07-29 21:31:04 -07:00
cmd Merge branch 'linux-zpios' into refs/top-bases/linux-zfs-branch 2009-07-21 14:52:46 -07:00
config Merge branch 'linux-arc' into refs/top-bases/linux-zfs-branch 2009-07-29 17:49:26 -07:00
doc Refresh linux-docs 2008-12-05 10:20:45 -08:00
lib Merge branch 'linux-arc' into refs/top-bases/linux-zfs-branch 2009-07-29 21:27:17 -07:00
module Merge branch 'linux-arc' into refs/top-bases/linux-zfs-branch 2009-07-29 21:27:17 -07:00
scripts Merge branch 'linux-arc' into refs/top-bases/linux-zfs-branch 2009-07-27 10:47:31 -07:00
.topdeps Refresh linux-have-uio-rw 2008-12-05 12:23:10 -08:00
.topmsg Add TODO 2009-01-21 11:26:19 -08:00
AUTHORS Refresh zfs-branch 2008-12-05 09:46:11 -08:00
COPYING Refresh for consistency with COPYRIGHT 2009-06-08 11:59:13 -07:00
COPYRIGHT Readd accidentally dropped COPYRIGHT, it just references the 2009-06-08 11:01:13 -07:00
ChangeLog Merge branch 'linux-arc' into refs/top-bases/linux-zfs-branch 2009-07-02 14:00:22 -07: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 Distro friendly build system / packaging improvements. 2009-07-01 10:53:05 -07:00
Makefile.am Install zfs_config, zfs_unconfig, symbols in to correct location. 2009-07-01 12:51:06 -07: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 by removing out of date failure modes. 2009-07-14 16:36:28 -07:00
ZFS.RELEASE Rebase master to b117 2009-07-02 15:44:48 -07:00
autogen.sh Core target arch support for conditional compilation of SUBDIRs 2009-06-08 16:07:43 -07:00
configure.ac Merge branch 'linux-libspl' into refs/top-bases/linux-zfs-branch 2009-07-16 10:28:14 -07:00
zfs-modules.spec.in Update zfs-module rependencies to require spl-modules 2009-07-02 13:29:33 -07:00
zfs.spec.in Drop --with-linux and --with-spl options from user build. 2009-07-01 14:35:38 -07:00
zfs_unconfig.h Distro friendly build system / packaging improvements. 2009-07-01 10:53:05 -07: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>