usr.sbin/nfsd/pnfs.4

   1 .\" Copyright (c) 2017 Rick Macklem
   2 .\"
   3 .\" Redistribution and use in source and binary forms, with or without
   4 .\" modification, are permitted provided that the following conditions
   5 .\" are met:
   6 .\" 1. Redistributions of source code must retain the above copyright
   7 .\"    notice, this list of conditions and the following disclaimer.
   8 .\" 2. Redistributions in binary form must reproduce the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer in the
  10 .\"    documentation and/or other materials provided with the distribution.
  11 .\"
  12 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  13 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  14 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  15 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  16 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  17 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  18 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  19 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  20 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  21 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  22 .\" SUCH DAMAGE.
  23 .\"
  24 .\" $FreeBSD$
  25 .\"
  26 .Dd August 5, 2018
  27 .Dt PNFS 4
  28 .Os
  29 .Sh NAME
  30 .Nm pNFS
  31 .Nd NFS Version 4.1 Parallel NFS Protocol
  32 .Sh DESCRIPTION
  33 The NFSv4.1 client and server provides support for the
  34 .Tn pNFS
  35 specification; see
  36 .%T "Network File System (NFS) Version 4 Minor Version 1 Protocol RFC 5661" .
  37 A pNFS service separates Read/Write operations from all other NFSv4.1
  38 operations, which are referred to as Metadata operations.
  39 The Read/Write operations are performed directly on the Data Server (DS)
  40 where the file's data resides, bypassing the NFS server.
  41 All other file operations are performed on the NFS server, which is referred to
  42 as a Metadata Server (MDS).
  43 NFS clients that do not support
  44 .Tn pNFS
  45 perform Read/Write operations on the MDS, which acts as a proxy for the
  46 appropriate DS(s).
  47 .Pp
  48 The NFSv4.1 protocol provides two pieces of information to pNFS aware
  49 clients that allow them to perform Read/Write operations directly on
  50 the DS.
  51 .Pp
  52 The first is DeviceInfo, which is static information defining the DS
  53 server.
  54 The critical piece of information in DeviceInfo for the layout types
  55 supported by FreeBSD is the IP address that is used to perform RPCs on the DS.
  56 It also indicates which version of NFS the DS supports, I/O size and other
  57 layout specific information.
  58 In the DeviceInfo, there is a DeviceID which, for the FreeBSD server
  59 is unique to the DS configuration
  60 and changes whenever the
  61 .Xr nfsd
  62 daemon is restarted or the server is rebooted.
  63 .Pp
  64 The second is the layout, which is per file and references the DeviceInfo
  65 to use via the DeviceID.
  66 It is for a byte range of a file and is either Read or Read/Write.
  67 For the FreeBSD server, a layout covers all bytes of a file.
  68 A layout may be recalled by the MDS using a LayoutRecall callback.
  69 When a client returns a layout via the LayoutReturn operation it can
  70 indicate that error(s) were encountered while doing I/O on the DS,
  71 at least for certain layout types such as the Flexible File Layout.
  72 .Pp
  73 The FreeBSD client and server supports two layout types.
  74 .Pp
  75 The File Layout is described in RFC5661 and uses the NFSv4.1 protocol
  76 to perform I/O on the DS.
  77 It does not support client aware DS mirroring and, as such,
  78 the FreeBSD server only provides File Layout support for non-mirrored
  79 configurations.
  80 .Pp
  81 The Flexible File Layout allows the use of the NFSv3, NFSv4.0 or NFSv4.1
  82 protocol to perform I/O on the DS and does support client aware mirroring.
  83 As such, the FreeBSD server uses Flexible File Layout layouts for the
  84 mirrored DS configurations.
  85 The FreeBSD server supports the
  86 .Dq tightly coupled
  87 variant and all DSs use the
  88 NFSv4.1 protocol for I/O operations.
  89 Clients that support the Flexible File Layout will do writes and commits
  90 to all DS mirrors in the mirror set.
  91 .Pp
  92 A FreeBSD pNFS service consists of a single MDS server plus one or more
  93 DS servers, all of which are FreeBSD systems.
  94 For a non-mirrored configuration, the FreeBSD server will issue File Layout
  95 layouts by default.
  96 However that default can be set to the Flexible File Layout by setting the
  97 .Xr sysctl 1
  98 sysctl
  99 .Dq vfs.nfsd.default_flexfile
 100 to one.
 101 Mirrored server configurations will only issue Flexible File Layouts.
 102 .Tn pNFS
 103 clients mount the MDS as they would a single NFS server.
 104 .Pp
 105 A FreeBSD
 106 .Tn pNFS
 107 client must be running the
 108 .Xr nfscbd 8
 109 daemon and use the mount options
 110 .Dq nfsv4,minorversion=1,pnfs .
 111 .Pp
 112 When files are created, the MDS creates a file tree identical to what a
 113 single NFS server creates, except that all the regular (VREG) files will
 114 be empty.
 115 As such, if you look at the exported tree on the MDS directly
 116 on the MDS server (not via an NFS mount), the files will all be of size zero.
 117 Each of these files will also have two extended attributes in the system
 118 attribute name space:
 119 .Bd -literal -offset indent
 120 pnfsd.dsfile - This extended attrbute stores the information that the
 121     MDS needs to find the data file on a DS(s) for this file.
 122 pnfsd.dsattr - This extended attribute stores the Size, AccessTime,
 123     ModifyTime and Change attributes for the file.
 124 .Ed
 125 .Pp
 126 For each regular (VREG) file, the MDS creates a data file on one
 127 (or on N of them for the mirrored case, where N is the mirror_level)
 128 of the DS(s) where the file's data will be stored.
 129 The name of this file is
 130 the file handle of the file on the MDS in hexadecimal at time of file creation.
 131 The data file will have the same file ownership, mode and NFSv4 ACL
 132 (if ACLs are enabled for the file system) as the file on the MDS, so that
 133 permission checking can be done on the DS.
 134 This is referred to as
 135 .Dq tightly coupled
 136 for the Flexible File Layout.
 137 .Pp
 138 For
 139 .Tn pNFS
 140 aware clients, the service generates File Layout
 141 or Flexible File Layout
 142 layouts and associated DeviceInfo.
 143 For non-pNFS aware NFS clients, the pNFS service appears just like a normal
 144 NFS service.
 145 For the non-pNFS aware client, the MDS will perform I/O operations on the appropriate DS(s), acting as
 146 a proxy for the non-pNFS aware client.
 147 This is also true for NFSv3 and NFSv4.0 mounts, since these are always non-pNFS
 148 aware.
 149 .Pp
 150 It is possible to assign a DS to an MDS exported file system so that it will
 151 store data for files on the MDS exported file system.
 152 If a DS is not assigned to an MDS exported file system, it will store data
 153 for files on all exported file systems on the MDS.
 154 .Pp
 155 If mirroring is enabled, the pNFS service will continue to function when
 156 DS(s) have failed, so long is there is at least one DS still operational
 157 that stores data for files on all of the MDS exported file systems.
 158 After a disabled mirrored DS is repaired, it is possible to recover the DS
 159 as a mirror while the pNFS service continues to function.
 160 .Pp
 161 See
 162 .Xr pnfsserver 4
 163 for information on how to set up a FreeBSD pNFS service.
 164 .Sh SEE ALSO
 165 .Xr nfsv4 4 ,
 166 .Xr pnfsserver 4 ,
 167 .Xr exports 5 ,
 168 .Xr fstab 5 ,
 169 .Xr rc.conf 5 ,
 170 .Xr nfscbd 8 ,
 171 .Xr nfsd 8 ,
 172 .Xr nfsuserd 8 ,
 173 .Xr pnfsdscopymr 8 ,
 174 .Xr pnfsdsfile 8 ,
 175 .Xr pnfsdskill 8
 176 .Sh BUGS
 177 Linux kernel versions prior to 4.12 only supports NFSv3 DSs in its client
 178 and will do all I/O through the MDS.
 179 For Linux 4.12 kernels, support for NFSv4.1 DSs was added, but I have seen
 180 Linux client crashes when testing this client.
 181 For Linux 4.17-rc2 kernels, I have not seen client crashes during testing,
 182 but it only supports the
 183 .Dq loosely coupled
 184 variant.
 185 To make it work correctly when mounting the FreeBSD server, you must either
 186 patch the Flexible File Layout client driver with a patch like:
 187 .Bd -literal -offset indent
 188 http://people.freebsd.org/~rmacklem/flexfile.patch
 189 .Ed
 190 .sp
 191 or set the sysctl
 192 .Dq vfs.nfsd.flexlinuxhack
 193 to one so that it works around
 194 the Linux client driver's limitations.
 195 .Pp
 196 Since the MDS cannot be mirrored, it is a single point of failure just
 197 as a non
 198 .Tn pNFS
 199 server is.