Honor xattr=sa dataset property

ZFS incorrectly uses directory-based extended attributes even when
xattr=sa is specified as a dataset property or mount option. Support to
honor temporary mount options including "xattr" was added in commit
0282c41. There are two issues with the
mount option handling:

* Libzfs has historically included "xattr" in its list of default mount
  options. This overrides the dataset property, so the dataset is always
  configured to use directory-based xattrs even when the xattr dataset
  property is set to off or sa. Address this by removing "xattr" from
  the set of default mount options in libzfs.

* There was no way to enable system attribute-based extended attributes
  using temporary mount options. Add the mount options "saxattr" and
  "dirxattr" which enable the xattr behavior their names suggest.  This
  approach has the advantages of mirroring the valid xattr dataset
  property values and following existing conventions for mount option
  names.

Issue openzfs#3787

Signed-off-by: Ned Bass <[email protected]>

cmd/mount_zfs/mount_zfs.c

@@ -101,6 +101,8 @@ static const option_map_t option_map[] = {
 	{ MNTOPT_QUIET,		MS_SILENT,	ZS_COMMENT	},
 #endif
 	/* Custom zfs options */
+	{ MNTOPT_DIRXATTR,	MS_COMMENT,	ZS_COMMENT	},
+	{ MNTOPT_SAXATTR,	MS_COMMENT,	ZS_COMMENT	},
 	{ MNTOPT_XATTR,		MS_COMMENT,	ZS_COMMENT	},
 	{ MNTOPT_NOXATTR,	MS_COMMENT,	ZS_COMMENT	},
 	{ MNTOPT_ZFSUTIL,	MS_COMMENT,	ZS_ZFSUTIL	},

include/sys/mntent.h

@@ -88,6 +88,8 @@
 #define	MNTOPT_LOUD	"loud"		/* verbose mount */
 #define	MNTOPT_BIND	"bind"		/* remount part of a tree */
 #define	MNTOPT_RBIND	"rbind"		/* include subtrees */
+#define	MNTOPT_DIRXATTR	"dirxattr"	/* enable directory xattrs */
+#define	MNTOPT_SAXATTR	"saxattr"	/* enable system-attribute xattrs */
 #define	MNTOPT_XATTR	"xattr"		/* enable extended attributes */
 #define	MNTOPT_NOXATTR	"noxattr"	/* disable extended attributes */
 #define	MNTOPT_COMMENT	"comment"	/* comment */

include/sys/zfs_vfsops.h

@@ -44,6 +44,7 @@ struct znode;
 typedef struct zfs_mntopts {
 	char		*z_osname;	/* Objset name */
 	char		*z_mntpoint;	/* Primary mount point */
+	uint64_t	z_xattr;
 	boolean_t	z_readonly;
 	boolean_t	z_do_readonly;
 	boolean_t	z_setuid;
@@ -52,7 +53,6 @@ typedef struct zfs_mntopts {
 	boolean_t	z_do_exec;
 	boolean_t	z_devices;
 	boolean_t	z_do_devices;
-	boolean_t	z_xattr;
 	boolean_t	z_do_xattr;
 	boolean_t	z_atime;
 	boolean_t	z_do_atime;

lib/libzfs/libzfs_mount.c

@@ -371,8 +371,6 @@ zfs_add_options(zfs_handle_t *zhp, char *options, int len)
 	    ZFS_PROP_READONLY, MNTOPT_RO, MNTOPT_RW);
 	error = error ? error : zfs_add_option(zhp, options, len,
 	    ZFS_PROP_SETUID, MNTOPT_SETUID, MNTOPT_NOSETUID);
-	error = error ? error : zfs_add_option(zhp, options, len,
-	    ZFS_PROP_XATTR, MNTOPT_XATTR, MNTOPT_NOXATTR);
 	error = error ? error : zfs_add_option(zhp, options, len,
 	    ZFS_PROP_NBMAND, MNTOPT_NBMAND, MNTOPT_NONBMAND);
 

man/man8/mount.zfs.8

@@ -83,7 +83,7 @@ under that mountpoint.
 This flag sets the SELinux context for the filesytem being mounted.
 .TP
 .BI "\-o defcontext"
-This flag sets the SELinux context for unlabled files.
+This flag sets the SELinux context for unlabeled files.
 .TP
 .BI "\-o rootcontext"
 This flag sets the SELinux context for the root inode of the filesystem.
@@ -97,8 +97,16 @@ has an entry in the /etc/fstab file.
 This private flag disables extended attributes.
 .TP
 .BI "\-o xattr
-This private flag enables extended attributes and, if appropriate,
-adds a ZFS context to the selinux system policy.
+This private flag enables directory-based extended attributes and, if
+appropriate, adds a ZFS context to the selinux system policy.
+.TP
+.BI "\-o saxattr
+This private flag enables system attributed-based extended attributes and, if
+appropriate, adds a ZFS context to the selinux system policy.
+.TP
+.BI "\-o dirxattr
+Equivalent to
+.BR xattr .
 .TP
 .BI "\-o zfsutil"
 This private flag indicates that

module/zfs/zpl_super.c

@@ -193,6 +193,8 @@ enum {
 	TOKEN_NOEXEC,
 	TOKEN_DEVICES,
 	TOKEN_NODEVICES,
+	TOKEN_DIRXATTR,
+	TOKEN_SAXATTR,
 	TOKEN_XATTR,
 	TOKEN_NOXATTR,
 	TOKEN_ATIME,
@@ -214,6 +216,8 @@ static const match_table_t zpl_tokens = {
 	{ TOKEN_NOEXEC,		MNTOPT_NOEXEC },
 	{ TOKEN_DEVICES,	MNTOPT_DEVICES },
 	{ TOKEN_NODEVICES,	MNTOPT_NODEVICES },
+	{ TOKEN_DIRXATTR,	MNTOPT_DIRXATTR },
+	{ TOKEN_SAXATTR,	MNTOPT_SAXATTR },
 	{ TOKEN_XATTR,		MNTOPT_XATTR },
 	{ TOKEN_NOXATTR,	MNTOPT_NOXATTR },
 	{ TOKEN_ATIME,		MNTOPT_ATIME },
@@ -263,12 +267,20 @@ zpl_parse_option(char *option, int token, substring_t *args,
 		zmo->z_devices = B_FALSE;
 		zmo->z_do_devices = B_TRUE;
 		break;
+	case TOKEN_DIRXATTR:
+		zmo->z_xattr = ZFS_XATTR_DIR;
+		zmo->z_do_xattr = B_TRUE;
+		break;
+	case TOKEN_SAXATTR:
+		zmo->z_xattr = ZFS_XATTR_SA;
+		zmo->z_do_xattr = B_TRUE;
+		break;
 	case TOKEN_XATTR:
-		zmo->z_xattr = B_TRUE;
+		zmo->z_xattr = ZFS_XATTR_DIR;
 		zmo->z_do_xattr = B_TRUE;
 		break;
 	case TOKEN_NOXATTR:
-		zmo->z_xattr = B_FALSE;
+		zmo->z_xattr = ZFS_XATTR_OFF;
 		zmo->z_do_xattr = B_TRUE;
 		break;
 	case TOKEN_ATIME: