[mirror_zfs.git] / lib / libshare / os / freebsd / nfs.c

/*
 * Copyright (c) 2007 Pawel Jakub Dawidek <pjd@FreeBSD.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * Copyright (c) 2020 by Delphix. All rights reserved.
 */

#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");

#include <sys/param.h>
#include <sys/vfs.h>

#include <assert.h>
#include <errno.h>
#include <fcntl.h>
#include <libutil.h>
#include <signal.h>
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <libintl.h>

#include <libshare.h>
#include "libshare_impl.h"
#include "nfs.h"

#define	_PATH_MOUNTDPID	"/var/run/mountd.pid"
#define	OPTSSIZE	1024
#define	MAXLINESIZE	(PATH_MAX + OPTSSIZE)
#define	ZFS_EXPORTS_FILE	"/etc/zfs/exports"
#define	ZFS_EXPORTS_LOCK	ZFS_EXPORTS_FILE".lock"

/*
 * This function translates options to a format acceptable by exports(5), eg.
 *
 *	-ro -network=192.168.0.0 -mask=255.255.255.0 -maproot=0 \
 *	zfs.freebsd.org 69.147.83.54
 *
 * Accepted input formats:
 *
 *	ro,network=192.168.0.0,mask=255.255.255.0,maproot=0,zfs.freebsd.org
 *	ro network=192.168.0.0 mask=255.255.255.0 maproot=0 zfs.freebsd.org
 *	-ro,-network=192.168.0.0,-mask=255.255.255.0,-maproot=0,zfs.freebsd.org
 *	-ro -network=192.168.0.0 -mask=255.255.255.0 -maproot=0 \
 *	zfs.freebsd.org
 *
 * Recognized keywords:
 *
 *	ro, maproot, mapall, mask, network, sec, alldirs, public, webnfs,
 *	index, quiet
 */
static int
translate_opts(const char *shareopts, FILE *out)
{
	static const char *const known_opts[] = { "ro", "maproot", "mapall",
	    "mask", "network", "sec", "alldirs", "public", "webnfs", "index",
	    "quiet" };
	char oldopts[OPTSSIZE], newopts[OPTSSIZE];
	char *o, *s = NULL;
	unsigned int i;
	size_t len;

	strlcpy(oldopts, shareopts, sizeof (oldopts));
	newopts[0] = '\0';
	s = oldopts;
	while ((o = strsep(&s, "-, ")) != NULL) {
		if (o[0] == '\0')
			continue;
		for (i = 0; i < ARRAY_SIZE(known_opts); ++i) {
			len = strlen(known_opts[i]);
			if (strncmp(known_opts[i], o, len) == 0 &&
			    (o[len] == '\0' || o[len] == '=')) {
				strlcat(newopts, "-", sizeof (newopts));
				break;
			}
		}
		strlcat(newopts, o, sizeof (newopts));
		strlcat(newopts, " ", sizeof (newopts));
	}
	return (fputs(newopts, out));
}

static int
nfs_enable_share_impl(sa_share_impl_t impl_share, FILE *tmpfile)
{
	const char *shareopts = impl_share->sa_shareopts;
	if (strcmp(shareopts, "on") == 0)
		shareopts = "";

	if (fputs(impl_share->sa_mountpoint, tmpfile) == EOF ||
	    fputc('\t', tmpfile) == EOF ||
	    translate_opts(shareopts, tmpfile) == EOF ||
	    fputc('\n', tmpfile) == EOF) {
		fprintf(stderr, "failed to write to temporary file\n");
		return (SA_SYSTEM_ERR);
	}

	return (SA_OK);
}

static int
nfs_enable_share(sa_share_impl_t impl_share)
{
	return (nfs_toggle_share(
	    ZFS_EXPORTS_LOCK, ZFS_EXPORTS_FILE, NULL, impl_share,
	    nfs_enable_share_impl));
}

static int
nfs_disable_share_impl(sa_share_impl_t impl_share, FILE *tmpfile)
{
	(void) impl_share, (void) tmpfile;
	return (SA_OK);
}

static int
nfs_disable_share(sa_share_impl_t impl_share)
{
	return (nfs_toggle_share(
	    ZFS_EXPORTS_LOCK, ZFS_EXPORTS_FILE, NULL, impl_share,
	    nfs_disable_share_impl));
}

static boolean_t
nfs_is_shared(sa_share_impl_t impl_share)
{
	return (nfs_is_shared_impl(ZFS_EXPORTS_FILE, impl_share));
}

static int
nfs_validate_shareopts(const char *shareopts)
{
	(void) shareopts;
	return (SA_OK);
}

/*
 * Commit the shares by restarting mountd.
 */
static int
nfs_commit_shares(void)
{
	struct pidfh *pfh;
	pid_t mountdpid;

start:
	pfh = pidfile_open(_PATH_MOUNTDPID, 0600, &mountdpid);
	if (pfh != NULL) {
		/* mountd(8) is not running. */
		pidfile_remove(pfh);
		return (SA_OK);
	}
	if (errno != EEXIST) {
		/* Cannot open pidfile for some reason. */
		return (SA_SYSTEM_ERR);
	}
	if (mountdpid == -1) {
		/* mountd(8) exists, but didn't write the PID yet */
		usleep(500);
		goto start;
	}
	/* We have mountd(8) PID in mountdpid variable. */
	kill(mountdpid, SIGHUP);
	return (SA_OK);
}

const sa_fstype_t libshare_nfs_type = {
	.enable_share = nfs_enable_share,
	.disable_share = nfs_disable_share,
	.is_shared = nfs_is_shared,

	.validate_shareopts = nfs_validate_shareopts,
	.commit_shares = nfs_commit_shares,
};
Commit	Line	Data
c15d36c6 GW	1	/*
	2	* Copyright (c) 2007 Pawel Jakub Dawidek <pjd@FreeBSD.org>
	3	* All rights reserved.
	4	*
	5	* Redistribution and use in source and binary forms, with or without
	6	* modification, are permitted provided that the following conditions
	7	* are met:
	8	* 1. Redistributions of source code must retain the above copyright
	9	* notice, this list of conditions and the following disclaimer.
	10	* 2. Redistributions in binary form must reproduce the above copyright
	11	* notice, this list of conditions and the following disclaimer in the
	12	* documentation and/or other materials provided with the distribution.
	13	*
	14	* THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
	15	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	16	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	17	* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
	18	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	19	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	20	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	21	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	22	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	23	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	24	* SUCH DAMAGE.
	25	*
	26	* Copyright (c) 2020 by Delphix. All rights reserved.
	27	*/
	28
	29	#include <sys/cdefs.h>
	30	__FBSDID("$FreeBSD$");
	31
	32	#include <sys/param.h>
	33	#include <sys/vfs.h>
	34
	35	#include <assert.h>
	36	#include <errno.h>
	37	#include <fcntl.h>
	38	#include <libutil.h>
	39	#include <signal.h>
	40	#include <stdio.h>
	41	#include <string.h>
	42	#include <unistd.h>
	43	#include <libintl.h>
	44
eefaa55f	45	#include <libshare.h>
c15d36c6 GW	46	#include "libshare_impl.h"
	47	#include "nfs.h"
	48
	49	#define _PATH_MOUNTDPID "/var/run/mountd.pid"
c15d36c6 GW	50	#define OPTSSIZE 1024
	51	#define MAXLINESIZE (PATH_MAX + OPTSSIZE)
	52	#define ZFS_EXPORTS_FILE "/etc/zfs/exports"
	53	#define ZFS_EXPORTS_LOCK ZFS_EXPORTS_FILE".lock"
	54
c15d36c6	55	/*
ee668b83	56	* This function translates options to a format acceptable by exports(5), eg.
c15d36c6 GW	57	*
	58	* -ro -network=192.168.0.0 -mask=255.255.255.0 -maproot=0 \
	59	* zfs.freebsd.org 69.147.83.54
	60	*
	61	* Accepted input formats:
	62	*
	63	* ro,network=192.168.0.0,mask=255.255.255.0,maproot=0,zfs.freebsd.org
	64	* ro network=192.168.0.0 mask=255.255.255.0 maproot=0 zfs.freebsd.org
	65	* -ro,-network=192.168.0.0,-mask=255.255.255.0,-maproot=0,zfs.freebsd.org
	66	* -ro -network=192.168.0.0 -mask=255.255.255.0 -maproot=0 \
	67	* zfs.freebsd.org
	68	*
	69	* Recognized keywords:
	70	*
	71	* ro, maproot, mapall, mask, network, sec, alldirs, public, webnfs,
	72	* index, quiet
c15d36c6	73	*/
ee668b83 AZ	74	static int
ee668b83 AZ	75	translate_opts(const char shareopts, FILE out)
c15d36c6	76	{
5f0c1c4e AZ	77	static const char *const known_opts[] = { "ro", "maproot", "mapall",
	78	"mask", "network", "sec", "alldirs", "public", "webnfs", "index",
	79	"quiet" };
ee668b83	80	char oldopts[OPTSSIZE], newopts[OPTSSIZE];
c15d36c6 GW	81	char o, s = NULL;
	82	unsigned int i;
	83	size_t len;
	84
	85	strlcpy(oldopts, shareopts, sizeof (oldopts));
	86	newopts[0] = '\0';
	87	s = oldopts;
	88	while ((o = strsep(&s, "-, ")) != NULL) {
	89	if (o[0] == '\0')
	90	continue;
5f0c1c4e	91	for (i = 0; i < ARRAY_SIZE(known_opts); ++i) {
c15d36c6 GW	92	len = strlen(known_opts[i]);
	93	if (strncmp(known_opts[i], o, len) == 0 &&
	94	(o[len] == '\0' \|\| o[len] == '=')) {
	95	strlcat(newopts, "-", sizeof (newopts));
	96	break;
	97	}
	98	}
	99	strlcat(newopts, o, sizeof (newopts));
	100	strlcat(newopts, " ", sizeof (newopts));
	101	}
ee668b83	102	return (fputs(newopts, out));
c15d36c6 GW	103	}
c15d36c6 GW	104
c15d36c6	105	static int
c53f2e9b	106	nfs_enable_share_impl(sa_share_impl_t impl_share, FILE *tmpfile)
c15d36c6	107	{
63ce6dd9	108	const char *shareopts = impl_share->sa_shareopts;
c15d36c6 GW	109	if (strcmp(shareopts, "on") == 0)
	110	shareopts = "";
	111
ee668b83 AZ	112	if (fputs(impl_share->sa_mountpoint, tmpfile) == EOF \|\|
	113	fputc('\t', tmpfile) == EOF \|\|
	114	translate_opts(shareopts, tmpfile) == EOF \|\|
	115	fputc('\n', tmpfile) == EOF) {
c53f2e9b	116	fprintf(stderr, "failed to write to temporary file\n");
c15d36c6 GW	117	return (SA_SYSTEM_ERR);
c15d36c6 GW	118	}
dc3a56d3 AZ	119
	120	return (SA_OK);
	121	}
	122
	123	static int
	124	nfs_enable_share(sa_share_impl_t impl_share)
	125	{
	126	return (nfs_toggle_share(
	127	ZFS_EXPORTS_LOCK, ZFS_EXPORTS_FILE, NULL, impl_share,
	128	nfs_enable_share_impl));
	129	}
	130
	131	static int
c53f2e9b	132	nfs_disable_share_impl(sa_share_impl_t impl_share, FILE *tmpfile)
dc3a56d3	133	{
57bff80e	134	(void) impl_share, (void) tmpfile;
dc3a56d3	135	return (SA_OK);
c15d36c6 GW	136	}
	137
	138	static int
	139	nfs_disable_share(sa_share_impl_t impl_share)
	140	{
dc3a56d3 AZ	141	return (nfs_toggle_share(
	142	ZFS_EXPORTS_LOCK, ZFS_EXPORTS_FILE, NULL, impl_share,
	143	nfs_disable_share_impl));
c15d36c6 GW	144	}
c15d36c6 GW	145
c15d36c6 GW	146	static boolean_t
	147	nfs_is_shared(sa_share_impl_t impl_share)
	148	{
605e03e5	149	return (nfs_is_shared_impl(ZFS_EXPORTS_FILE, impl_share));
c15d36c6 GW	150	}
	151
	152	static int
	153	nfs_validate_shareopts(const char *shareopts)
	154	{
46c7a802	155	(void) shareopts;
c15d36c6 GW	156	return (SA_OK);
	157	}
	158
c15d36c6 GW	159	/*
	160	* Commit the shares by restarting mountd.
	161	*/
	162	static int
	163	nfs_commit_shares(void)
	164	{
	165	struct pidfh *pfh;
	166	pid_t mountdpid;
	167
bdf6464c	168	start:
c15d36c6 GW	169	pfh = pidfile_open(_PATH_MOUNTDPID, 0600, &mountdpid);
c15d36c6 GW	170	if (pfh != NULL) {
bdf6464c	171	/* mountd(8) is not running. */
c15d36c6 GW	172	pidfile_remove(pfh);
	173	return (SA_OK);
	174	}
	175	if (errno != EEXIST) {
	176	/* Cannot open pidfile for some reason. */
	177	return (SA_SYSTEM_ERR);
	178	}
bdf6464c AZ	179	if (mountdpid == -1) {
	180	/* mountd(8) exists, but didn't write the PID yet */
	181	usleep(500);
	182	goto start;
	183	}
c15d36c6 GW	184	/* We have mountd(8) PID in mountdpid variable. */
	185	kill(mountdpid, SIGHUP);
	186	return (SA_OK);
	187	}
	188
471e9a10	189	const sa_fstype_t libshare_nfs_type = {
c15d36c6 GW	190	.enable_share = nfs_enable_share,
	191	.disable_share = nfs_disable_share,
	192	.is_shared = nfs_is_shared,
	193
	194	.validate_shareopts = nfs_validate_shareopts,
c15d36c6 GW	195	.commit_shares = nfs_commit_shares,
c15d36c6 GW	196	};