OpenZFS on Linux and FreeBSD
Go to file
Brian Behlendorf 868e5de066 Add linux-user-util topic branch.
This topic branch contains required changes to the user space
utilities to allow them to integrate cleanly with Linux.
2010-05-21 10:47:59 -07:00
cmd Add linux-user-util topic branch. 2010-05-21 10:47:59 -07:00
config Fix error message to reference the new libuuid package. 2010-05-20 10:00:03 -07:00
etc Remove promise example config replace with a supermicro config 2010-03-11 14:04:12 -08:00
lib Add linux-user-util topic branch. 2010-05-21 10:47:59 -07:00
man Add man pages to the build system and packages. 2009-12-11 16:49:25 -08:00
module Merge commit 'refs/top-bases/zfs-branch' into zfs-branch 2010-04-29 12:32:01 -07:00
patches Add e2fsprogs patch for detecting ZFS uberblocks until it appears upstream. 2009-11-02 15:04:43 -08:00
scripts Remove explicit import from zconfig test 1. 2010-05-18 16:15:57 -07:00
.gitignore Ignore unsigned module build products 2010-03-09 14:14:09 -08:00
.topdeps Add linux-user-util topic branch. 2010-05-21 10:47:59 -07:00
.topmsg Add linux-user-util topic branch. 2010-05-21 10:47:59 -07:00
AUTHORS Add AUTHORS to master branch 2010-05-18 14:55:01 -07:00
COPYING Revert accidental change to COPYING, move authors to master branch. 2010-05-18 14:41:47 -07:00
COPYRIGHT Update COPYRIGHT to reference zpios CDDL exceptions. 2010-05-18 14:25:28 -07:00
ChangeLog Prep for 0.4.8 tag, updated META and ChangeLog 2010-03-11 16:25:03 -08:00
DISCLAIMER Resolve conflict 2010-05-18 10:42:54 -07:00
GIT Refresh type in topgit git://* reference 2009-01-26 21:58:32 -08:00
META Prep for 0.4.8 tag, updated META and ChangeLog 2010-03-11 16:25:03 -08:00
Makefile.am Allow zfs_config.h to be included by dependant packages (updated) 2010-03-22 16:42:18 -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 Prep for 0.4.6 tag, updated META, ChangeLog, and TODO. 2009-11-02 13:03:59 -08:00
ZFS.RELEASE Rebase master to b121 2009-08-18 11:43:27 -07:00
autogen.sh Core target arch support for conditional compilation of SUBDIRs 2009-06-08 16:07:43 -07:00
configure.ac Add support for 'make -s' silent builds 2010-03-26 15:41:41 -07:00
zfs-modules.spec.in Minor spec file cleanup for srpm case. 2010-05-18 10:08:29 -07:00
zfs.spec.in Split the udev rule from a specific configuration 2010-03-01 16:51:21 -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>