libzfs_mount.c revision 260921a4509dd7666c6613f413be409b66181642
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER START
fa9e4066f08beec538e775443c5be79dd423fcabahrens * The contents of this file are subject to the terms of the
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Common Development and Distribution License, Version 1.0 only
fa9e4066f08beec538e775443c5be79dd423fcabahrens * (the "License"). You may not use this file except in compliance
fa9e4066f08beec538e775443c5be79dd423fcabahrens * with the License.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
fa9e4066f08beec538e775443c5be79dd423fcabahrens * See the License for the specific language governing permissions
fa9e4066f08beec538e775443c5be79dd423fcabahrens * and limitations under the License.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * When distributing Covered Code, include this CDDL HEADER in each
fa9e4066f08beec538e775443c5be79dd423fcabahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * If applicable, add the following below this CDDL HEADER, with the
fa9e4066f08beec538e775443c5be79dd423fcabahrens * fields enclosed by brackets "[]" replaced with your own identifying
fa9e4066f08beec538e775443c5be79dd423fcabahrens * information: Portions Copyright [yyyy] [name of copyright owner]
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER END
260921a4509dd7666c6613f413be409b66181642eschrock * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Use is subject to license terms.
fa9e4066f08beec538e775443c5be79dd423fcabahrens#pragma ident "%Z%%M% %I% %E% SMI"
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Routines to manage ZFS mounts. We separate all the nasty routines that have
fa9e4066f08beec538e775443c5be79dd423fcabahrens * to deal with the OS. The main entry points are:
fa9e4066f08beec538e775443c5be79dd423fcabahrens * zfs_is_mounted()
fa9e4066f08beec538e775443c5be79dd423fcabahrens * zfs_mount()
fa9e4066f08beec538e775443c5be79dd423fcabahrens * zfs_unmount()
fa9e4066f08beec538e775443c5be79dd423fcabahrens * zfs_unmountall()
fa9e4066f08beec538e775443c5be79dd423fcabahrens * These functions are used by mount and unmount, and when changing a
fa9e4066f08beec538e775443c5be79dd423fcabahrens * filesystem's mountpoint. This file also contains the functions used to
fa9e4066f08beec538e775443c5be79dd423fcabahrens * manage sharing filesystems via NFS:
fa9e4066f08beec538e775443c5be79dd423fcabahrens * zfs_is_shared()
fa9e4066f08beec538e775443c5be79dd423fcabahrens * zfs_share()
fa9e4066f08beec538e775443c5be79dd423fcabahrens * zfs_unshare()
fa9e4066f08beec538e775443c5be79dd423fcabahrens * zfs_unshareall()
fa9e4066f08beec538e775443c5be79dd423fcabahrens * The following two files are opened as part of zfs_init(). It's OK to for
fa9e4066f08beec538e775443c5be79dd423fcabahrens * the sharetab to be NULL, but mnttab must always be non-NULL;
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Search the sharetab for the given mountpoint, returning TRUE if it is found.
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
fa9e4066f08beec538e775443c5be79dd423fcabahrens while (fgets(buf, sizeof (buf), sharetab_file) != NULL) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* the mountpoint is the first entry on each line */
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Returns TRUE if the specified directory is empty. If we can't open the
fa9e4066f08beec538e775443c5be79dd423fcabahrens * directory at all, return TRUE so that the mount can fail with a more
fa9e4066f08beec538e775443c5be79dd423fcabahrens * informative error message.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Checks to see if the mount is active. If the filesystem is mounted, we fill
fa9e4066f08beec538e775443c5be79dd423fcabahrens * in 'where' with the current mountpoint, and return 1. Otherwise, we return
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Search for the entry in /etc/mnttab. We don't bother getting the
fa9e4066f08beec538e775443c5be79dd423fcabahrens * mountpoint, as we can just search for the special device. This will
fa9e4066f08beec538e775443c5be79dd423fcabahrens * also let us find mounts when the mountpoint is 'legacy'.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Mount the given filesystem.
fa9e4066f08beec538e775443c5be79dd423fcabahrenszfs_mount(zfs_handle_t *zhp, const char *options, int flags)
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* ignore non-filesystems */
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, mountpoint,
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* return success if there is no mountpoint set */
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * If the 'zoned' property is set, and we're in the global zone, simply
fa9e4066f08beec538e775443c5be79dd423fcabahrens * return success.
fa9e4066f08beec538e775443c5be79dd423fcabahrens sizeof (zonename)) < 0) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens "cannot determine current zone"));
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* Create the directory if it doesn't already exist */
fa9e4066f08beec538e775443c5be79dd423fcabahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot mount '%s': "
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Determine if the mountpoint is empty. If so, refuse to perform the
fa9e4066f08beec538e775443c5be79dd423fcabahrens * mount. We don't perform this check if MS_OVERLAY is specified, which
fa9e4066f08beec538e775443c5be79dd423fcabahrens * would defeat the point. We also avoid this check if 'remount' is
fa9e4066f08beec538e775443c5be79dd423fcabahrens * specified.
fa9e4066f08beec538e775443c5be79dd423fcabahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot mount '%s': "
fa9e4066f08beec538e775443c5be79dd423fcabahrens zfs_error(dgettext(TEXT_DOMAIN, "use legacy mountpoint to "
fa9e4066f08beec538e775443c5be79dd423fcabahrens "allow this behavior, or use the -O flag"));
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* perform the mount */
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (mount(zfs_get_name(zhp), mountpoint, MS_OPTIONSTR | flags,
fa9e4066f08beec538e775443c5be79dd423fcabahrens MNTTYPE_ZFS, NULL, 0, mntopts, sizeof (mntopts)) != 0) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Generic errors are nasty, but there are just way too many
fa9e4066f08beec538e775443c5be79dd423fcabahrens * from mount(), and they're well-understood. We pick a few
fa9e4066f08beec538e775443c5be79dd423fcabahrens * common ones to improve upon.
fa9e4066f08beec538e775443c5be79dd423fcabahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot mount '%s': "
fa9e4066f08beec538e775443c5be79dd423fcabahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot mount '%s': "
fa9e4066f08beec538e775443c5be79dd423fcabahrens "cannot mount '%s': %s"),
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Unmount the given filesystem.
fa9e4066f08beec538e775443c5be79dd423fcabahrenszfs_unmount(zfs_handle_t *zhp, const char *mountpoint, int flags)
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* check to see if need to unmount the filesystem */
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (mountpoint != NULL || ((zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) &&
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Always unshare the filesystem first.
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Try to unmount the filesystem. There is no reason to try a
fa9e4066f08beec538e775443c5be79dd423fcabahrens * forced unmount because the vnodes will still carry a
fa9e4066f08beec538e775443c5be79dd423fcabahrens * reference to the underlying dataset, so we can't destroy it
fa9e4066f08beec538e775443c5be79dd423fcabahrens * In the unmount case, we print out a slightly more informative
fa9e4066f08beec538e775443c5be79dd423fcabahrens * error message, though we'll be relying on the poor error
fa9e4066f08beec538e775443c5be79dd423fcabahrens * semantics from the kernel.
fa9e4066f08beec538e775443c5be79dd423fcabahrens "cannot unmount '%s': %s"),
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Don't actually destroy the underlying directory
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Unmount this filesystem and any children inheriting the mountpoint property.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * To do this, just act like we're changing the mountpoint property, but don't
fa9e4066f08beec538e775443c5be79dd423fcabahrens * remount the filesystems afterwards.
fa9e4066f08beec538e775443c5be79dd423fcabahrens clp = changelist_gather(zhp, ZFS_PROP_MOUNTPOINT, flags);
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Check to see if the filesystem is currently shared.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Share the given filesystem according to the options in 'sharenfs'. We rely
fa9e4066f08beec538e775443c5be79dd423fcabahrens * on share(1M) to the dirty work for us.
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* ignore non-filesystems */
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* return success if there is no mountpoint set */
fa9e4066f08beec538e775443c5be79dd423fcabahrens mountpoint, sizeof (mountpoint), NULL, NULL, 0, FALSE) != 0 ||
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* return success if there are no share options */
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (zfs_prop_get(zhp, ZFS_PROP_SHARENFS, shareopts, sizeof (shareopts),
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * If the 'zoned' property is set, simply return success since:
fa9e4066f08beec538e775443c5be79dd423fcabahrens * 1. in a global zone, a dataset should not be shared if it's
fa9e4066f08beec538e775443c5be79dd423fcabahrens * managed in a local zone.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * 2. in a local zone, NFS server is not available.
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Invoke the share(1M) command. We always do this, even if it's
fa9e4066f08beec538e775443c5be79dd423fcabahrens * currently shared, as the options may have changed.
fa9e4066f08beec538e775443c5be79dd423fcabahrens (void) snprintf(buf, sizeof (buf), "/usr/sbin/share "
fa9e4066f08beec538e775443c5be79dd423fcabahrens (void) snprintf(buf, sizeof (buf), "/usr/sbin/share "
fa9e4066f08beec538e775443c5be79dd423fcabahrens zfs_error(dgettext(TEXT_DOMAIN, "cannot share '%s': "
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * share(1M) should only produce output if there is some kind
fa9e4066f08beec538e775443c5be79dd423fcabahrens * of error. All output begins with "share_nfs: ", so we trim
fa9e4066f08beec538e775443c5be79dd423fcabahrens * this off to get to the real error.
fa9e4066f08beec538e775443c5be79dd423fcabahrens "'%s': share(1M) failed"),
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Unshare the given filesystem.
fa9e4066f08beec538e775443c5be79dd423fcabahrenszfs_unshare(zfs_handle_t *zhp, const char *mountpoint)
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* check to see if need to unmount the filesystem */
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (mountpoint != NULL || ((zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) &&
fa9e4066f08beec538e775443c5be79dd423fcabahrens "/usr/sbin/unshare \"%s\" 2>&1",
fa9e4066f08beec538e775443c5be79dd423fcabahrens "unshare '%s': unshare(1M) failed"),
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * unshare(1M) should only produce output if there is
fa9e4066f08beec538e775443c5be79dd423fcabahrens * some kind of error. All output begins with "unshare
fa9e4066f08beec538e775443c5be79dd423fcabahrens * nfs: ", so we trim this off to get to the real error.
fa9e4066f08beec538e775443c5be79dd423fcabahrens "cannot unshare '%s': unshare(1M) "
fa9e4066f08beec538e775443c5be79dd423fcabahrens "cannot unshare '%s': %s"),
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Same as zfs_unmountall(), but for unshares.
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Remove the mountpoint associated with the current dataset, if necessary.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * We only remove the underlying directory if:
fa9e4066f08beec538e775443c5be79dd423fcabahrens * - The mountpoint is not 'none' or 'legacy'
fa9e4066f08beec538e775443c5be79dd423fcabahrens * - The mountpoint is non-empty
fa9e4066f08beec538e775443c5be79dd423fcabahrens * - The mountpoint is the default or inherited
fa9e4066f08beec538e775443c5be79dd423fcabahrens * - The 'zoned' property is set, or we're in a local zone
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Any other directories we leave alone.
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* ignore non-filesystems */
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, mountpoint,
fa9e4066f08beec538e775443c5be79dd423fcabahrens sizeof (mountpoint), &sourcetype, source, sizeof (source),
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (getzonenamebyid(getzoneid(), zonename, sizeof (zonename)) < 0)
fa9e4066f08beec538e775443c5be79dd423fcabahrens "cannot determine current zone"));
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Try to remove the directory, silently ignoring any errors.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * The filesystem may have since been removed or moved around,
fa9e4066f08beec538e775443c5be79dd423fcabahrens * and this isn't really useful to the administrator in any