OpenZFS on Linux and FreeBSD
Go to file
Brian Behlendorf cb9c044bf6 Add SPL prefix to META_* #defines 2008-11-26 13:11:33 -08:00
build Initial Linux ZFS GIT Repo 2008-11-20 12:01:55 -08:00
config Add SPL prefix to META_* #defines 2008-11-26 13:11:33 -08:00
doc Initial Linux ZFS GIT Repo 2008-11-20 12:01:55 -08:00
lib Initial Linux ZFS GIT Repo 2008-11-20 12:01:55 -08:00
scripts Initial Linux ZFS GIT Repo 2008-11-20 12:01:55 -08:00
zfs Initial Linux ZFS GIT Repo 2008-11-20 12:01:55 -08:00
AUTHORS Initial Linux ZFS GIT Repo 2008-11-20 12:01:55 -08:00
ChangeLog Initial Linux ZFS GIT Repo 2008-11-20 12:01:55 -08:00
DISCLAIMER Initial Linux ZFS GIT Repo 2008-11-20 12:01:55 -08:00
GIT Update GIT docs, removing remaining patches. They will soon me applies as topic branches 2008-11-21 10:55:10 -08:00
META First step of META build system cleanup 2008-11-26 12:53:24 -08:00
Makefile.am Initial Linux ZFS GIT Repo 2008-11-20 12:01:55 -08:00
README Initial Linux ZFS GIT Repo 2008-11-20 12:01:55 -08:00
TODO Initial Linux ZFS GIT Repo 2008-11-20 12:01:55 -08:00
autogen.sh Restructure autoconf around ./config directory 2008-11-24 11:16:19 -08:00
configure.ac Add SPL prefix to META_* #defines 2008-11-26 13:11:33 -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 89 of ZFS from OpenSolaris.
   You will need to have both the kernel and SPL source available.
   To build ZFS for use as a Linux kernel module (default):

        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>

========================= ZFS USER LIBRARY BUILD =========================

1) Build ZFS, this port is based on build 89 of ZFS from OpenSolaris.
   To build ZFS as a userspace library:

        tar -xzf zfs-x.y.z.tgz
        cd zfs-x.y.z
        ./configure --zfsconfig=user
        make
        make check <as root>

============================ ZFS LUSTRE 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 89 of ZFS from OpenSolaris.
   To build ZFS as a userspace library for use by a Lustre filesystem:

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

3) Provided is an in-kernel test application called kpios which can be
   used to simulate a Lustre IO load.  It may be used as a stress test
   or as a performance to measure your configuration.  To simplify testing
   there are scripts provided in the scripts/ directory.  A single test
   can be run as follows:

        WARNING: You MUST update DEVICES in the create-zpool.sh script
                 to reference the devices you wish to use.

       cd scripts
       ./load-zfs.sh		# Load the ZFS/SPL module stack
       ./create-zpool.sh	# Modify DEVICES to list your zpool devices
       ./zpios.sh		# Modify for your particular kpios test
       ./unload-zfs.sh		# Unload the ZFS/SPL module stack

Enjoy,
Brian Behlendorf <behlendorf1@llnl.gov>