xref: /freebsd/lib/libutil/mntopts.c (revision a123502ef781ea052e842af25c7aeb64fd9fe217)
1cda23fc3SBrooks Davis /*-
2cda23fc3SBrooks Davis  * SPDX-License-Identifier: BSD-3-Clause
3cda23fc3SBrooks Davis  *
4cda23fc3SBrooks Davis  * Copyright (c) 1994
5cda23fc3SBrooks Davis  *	The Regents of the University of California.  All rights reserved.
6cda23fc3SBrooks Davis  *
7cda23fc3SBrooks Davis  * Redistribution and use in source and binary forms, with or without
8cda23fc3SBrooks Davis  * modification, are permitted provided that the following conditions
9cda23fc3SBrooks Davis  * are met:
10cda23fc3SBrooks Davis  * 1. Redistributions of source code must retain the above copyright
11cda23fc3SBrooks Davis  *    notice, this list of conditions and the following disclaimer.
12cda23fc3SBrooks Davis  * 2. Redistributions in binary form must reproduce the above copyright
13cda23fc3SBrooks Davis  *    notice, this list of conditions and the following disclaimer in the
14cda23fc3SBrooks Davis  *    documentation and/or other materials provided with the distribution.
15cda23fc3SBrooks Davis  * 3. Neither the name of the University nor the names of its contributors
16cda23fc3SBrooks Davis  *    may be used to endorse or promote products derived from this software
17cda23fc3SBrooks Davis  *    without specific prior written permission.
18cda23fc3SBrooks Davis  *
19cda23fc3SBrooks Davis  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20cda23fc3SBrooks Davis  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21cda23fc3SBrooks Davis  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22cda23fc3SBrooks Davis  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23cda23fc3SBrooks Davis  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24cda23fc3SBrooks Davis  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25cda23fc3SBrooks Davis  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26cda23fc3SBrooks Davis  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27cda23fc3SBrooks Davis  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28cda23fc3SBrooks Davis  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29cda23fc3SBrooks Davis  * SUCH DAMAGE.
30cda23fc3SBrooks Davis  */
31cda23fc3SBrooks Davis 
32cda23fc3SBrooks Davis #include <sys/param.h>
33cda23fc3SBrooks Davis #include <sys/mount.h>
34cda23fc3SBrooks Davis #include <sys/stat.h>
35cda23fc3SBrooks Davis #include <sys/uio.h>
36cda23fc3SBrooks Davis 
37cda23fc3SBrooks Davis #include <err.h>
38cda23fc3SBrooks Davis #include <errno.h>
39*a123502eSBrooks Davis #include <mntopts.h>
40cda23fc3SBrooks Davis #include <paths.h>
41cda23fc3SBrooks Davis #include <stdarg.h>
42cda23fc3SBrooks Davis #include <stdio.h>
43cda23fc3SBrooks Davis #include <stdlib.h>
44cda23fc3SBrooks Davis #include <string.h>
45cda23fc3SBrooks Davis 
46cda23fc3SBrooks Davis int getmnt_silent = 0;
47cda23fc3SBrooks Davis 
48cda23fc3SBrooks Davis void
getmntopts(const char * options,const struct mntopt * m0,int * flagp,int * altflagp)49cda23fc3SBrooks Davis getmntopts(const char *options, const struct mntopt *m0, int *flagp,
50cda23fc3SBrooks Davis 	int *altflagp)
51cda23fc3SBrooks Davis {
52cda23fc3SBrooks Davis 	const struct mntopt *m;
53cda23fc3SBrooks Davis 	int negative, len;
54cda23fc3SBrooks Davis 	char *opt, *optbuf, *p;
55cda23fc3SBrooks Davis 	int *thisflagp;
56cda23fc3SBrooks Davis 
57cda23fc3SBrooks Davis 	/* Copy option string, since it is about to be torn asunder... */
58cda23fc3SBrooks Davis 	if ((optbuf = strdup(options)) == NULL)
59cda23fc3SBrooks Davis 		err(1, NULL);
60cda23fc3SBrooks Davis 
61cda23fc3SBrooks Davis 	for (opt = optbuf; (opt = strtok(opt, ",")) != NULL; opt = NULL) {
62cda23fc3SBrooks Davis 		/* Check for "no" prefix. */
63cda23fc3SBrooks Davis 		if (opt[0] == 'n' && opt[1] == 'o') {
64cda23fc3SBrooks Davis 			negative = 1;
65cda23fc3SBrooks Davis 			opt += 2;
66cda23fc3SBrooks Davis 		} else
67cda23fc3SBrooks Davis 			negative = 0;
68cda23fc3SBrooks Davis 
69cda23fc3SBrooks Davis 		/*
70cda23fc3SBrooks Davis 		 * for options with assignments in them (ie. quotas)
71cda23fc3SBrooks Davis 		 * ignore the assignment as it's handled elsewhere
72cda23fc3SBrooks Davis 		 */
73cda23fc3SBrooks Davis 		p = strchr(opt, '=');
74cda23fc3SBrooks Davis 		if (p != NULL)
75cda23fc3SBrooks Davis 			 *++p = '\0';
76cda23fc3SBrooks Davis 
77cda23fc3SBrooks Davis 		/* Scan option table. */
78cda23fc3SBrooks Davis 		for (m = m0; m->m_option != NULL; ++m) {
79cda23fc3SBrooks Davis 			len = strlen(m->m_option);
80cda23fc3SBrooks Davis 			if (strncasecmp(opt, m->m_option, len) == 0)
81cda23fc3SBrooks Davis 				if (opt[len] == '\0' || opt[len] == '=')
82cda23fc3SBrooks Davis 					break;
83cda23fc3SBrooks Davis 		}
84cda23fc3SBrooks Davis 
85cda23fc3SBrooks Davis 		/* Save flag, or fail if option is not recognized. */
86cda23fc3SBrooks Davis 		if (m->m_option) {
87cda23fc3SBrooks Davis 			thisflagp = m->m_altloc ? altflagp : flagp;
88cda23fc3SBrooks Davis 			if (negative == m->m_inverse)
89cda23fc3SBrooks Davis 				*thisflagp |= m->m_flag;
90cda23fc3SBrooks Davis 			else
91cda23fc3SBrooks Davis 				*thisflagp &= ~m->m_flag;
92cda23fc3SBrooks Davis 		} else if (!getmnt_silent) {
93cda23fc3SBrooks Davis 			errx(1, "-o %s: option not supported", opt);
94cda23fc3SBrooks Davis 		}
95cda23fc3SBrooks Davis 	}
96cda23fc3SBrooks Davis 
97cda23fc3SBrooks Davis 	free(optbuf);
98cda23fc3SBrooks Davis }
99cda23fc3SBrooks Davis 
100cda23fc3SBrooks Davis void
rmslashes(char * rrpin,char * rrpout)101cda23fc3SBrooks Davis rmslashes(char *rrpin, char *rrpout)
102cda23fc3SBrooks Davis {
103cda23fc3SBrooks Davis 	char *rrpoutstart;
104cda23fc3SBrooks Davis 
105cda23fc3SBrooks Davis 	*rrpout = *rrpin;
106cda23fc3SBrooks Davis 	for (rrpoutstart = rrpout; *rrpin != '\0'; *rrpout++ = *rrpin++) {
107cda23fc3SBrooks Davis 
108cda23fc3SBrooks Davis 		/* skip all double slashes */
109cda23fc3SBrooks Davis 		while (*rrpin == '/' && *(rrpin + 1) == '/')
110cda23fc3SBrooks Davis 			 rrpin++;
111cda23fc3SBrooks Davis 	}
112cda23fc3SBrooks Davis 
113cda23fc3SBrooks Davis 	/* remove trailing slash if necessary */
114cda23fc3SBrooks Davis 	if (rrpout - rrpoutstart > 1 && *(rrpout - 1) == '/')
115cda23fc3SBrooks Davis 		*(rrpout - 1) = '\0';
116cda23fc3SBrooks Davis 	else
117cda23fc3SBrooks Davis 		*rrpout = '\0';
118cda23fc3SBrooks Davis }
119cda23fc3SBrooks Davis 
120cda23fc3SBrooks Davis int
checkpath(const char * path,char * resolved)121cda23fc3SBrooks Davis checkpath(const char *path, char *resolved)
122cda23fc3SBrooks Davis {
123cda23fc3SBrooks Davis 	struct stat sb;
124cda23fc3SBrooks Davis 
125cda23fc3SBrooks Davis 	if (realpath(path, resolved) == NULL || stat(resolved, &sb) != 0)
126cda23fc3SBrooks Davis 		return (1);
127cda23fc3SBrooks Davis 	if (!S_ISDIR(sb.st_mode)) {
128cda23fc3SBrooks Davis 		errno = ENOTDIR;
129cda23fc3SBrooks Davis 		return (1);
130cda23fc3SBrooks Davis 	}
131cda23fc3SBrooks Davis 	return (0);
132cda23fc3SBrooks Davis }
133cda23fc3SBrooks Davis 
134cda23fc3SBrooks Davis int
checkpath_allow_file(const char * path,char * resolved)135cda23fc3SBrooks Davis checkpath_allow_file(const char *path, char *resolved)
136cda23fc3SBrooks Davis {
137cda23fc3SBrooks Davis 	struct stat sb;
138cda23fc3SBrooks Davis 
139cda23fc3SBrooks Davis 	if (realpath(path, resolved) == NULL || stat(resolved, &sb) != 0)
140cda23fc3SBrooks Davis 		return (1);
141cda23fc3SBrooks Davis 	if (!S_ISDIR(sb.st_mode) && !S_ISREG(sb.st_mode)) {
142cda23fc3SBrooks Davis 		errno = ENOTDIR;
143cda23fc3SBrooks Davis 		return (1);
144cda23fc3SBrooks Davis 	}
145cda23fc3SBrooks Davis 	return (0);
146cda23fc3SBrooks Davis }
147cda23fc3SBrooks Davis 
148cda23fc3SBrooks Davis /*
149cda23fc3SBrooks Davis  * Get the mount point information for name. Name may be mount point name
150cda23fc3SBrooks Davis  * or device name (with or without /dev/ preprended).
151cda23fc3SBrooks Davis  */
152cda23fc3SBrooks Davis struct statfs *
getmntpoint(const char * name)153cda23fc3SBrooks Davis getmntpoint(const char *name)
154cda23fc3SBrooks Davis {
155cda23fc3SBrooks Davis 	struct stat devstat, mntdevstat;
156cda23fc3SBrooks Davis 	char device[sizeof(_PATH_DEV) - 1 + MNAMELEN];
157cda23fc3SBrooks Davis 	char *ddevname;
158cda23fc3SBrooks Davis 	struct statfs *mntbuf, *statfsp;
159cda23fc3SBrooks Davis 	int i, mntsize, isdev;
160cda23fc3SBrooks Davis 	u_long len;
161cda23fc3SBrooks Davis 
162cda23fc3SBrooks Davis 	if (stat(name, &devstat) != 0)
163cda23fc3SBrooks Davis 		return (NULL);
164cda23fc3SBrooks Davis 	if (S_ISCHR(devstat.st_mode) || S_ISBLK(devstat.st_mode))
165cda23fc3SBrooks Davis 		isdev = 1;
166cda23fc3SBrooks Davis 	else
167cda23fc3SBrooks Davis 		isdev = 0;
168cda23fc3SBrooks Davis 	mntsize = getmntinfo(&mntbuf, MNT_NOWAIT);
169cda23fc3SBrooks Davis 	for (i = 0; i < mntsize; i++) {
170cda23fc3SBrooks Davis 		statfsp = &mntbuf[i];
171cda23fc3SBrooks Davis 		if (isdev == 0) {
172cda23fc3SBrooks Davis 			if (strcmp(name, statfsp->f_mntonname))
173cda23fc3SBrooks Davis 				continue;
174cda23fc3SBrooks Davis 			return (statfsp);
175cda23fc3SBrooks Davis 		}
176cda23fc3SBrooks Davis 		ddevname = statfsp->f_mntfromname;
177cda23fc3SBrooks Davis 		if (*ddevname != '/') {
178cda23fc3SBrooks Davis 			if ((len = strlen(_PATH_DEV) + strlen(ddevname) + 1) >
179cda23fc3SBrooks Davis 			    sizeof(statfsp->f_mntfromname) ||
180cda23fc3SBrooks Davis 			    len > sizeof(device))
181cda23fc3SBrooks Davis 				continue;
182cda23fc3SBrooks Davis 			strncpy(device, _PATH_DEV, len);
183cda23fc3SBrooks Davis 			strncat(device, ddevname, len);
184cda23fc3SBrooks Davis 			if (stat(device, &mntdevstat) == 0)
185cda23fc3SBrooks Davis 				strncpy(statfsp->f_mntfromname, device, len);
186cda23fc3SBrooks Davis 		}
187cda23fc3SBrooks Davis 		if (stat(ddevname, &mntdevstat) == 0 &&
188cda23fc3SBrooks Davis 		    mntdevstat.st_rdev == devstat.st_rdev)
189cda23fc3SBrooks Davis 			return (statfsp);
190cda23fc3SBrooks Davis 	}
191cda23fc3SBrooks Davis 	return (NULL);
192cda23fc3SBrooks Davis }
193cda23fc3SBrooks Davis 
194cda23fc3SBrooks Davis /*
195cda23fc3SBrooks Davis  * If possible reload a mounted filesystem.
196cda23fc3SBrooks Davis  * When prtmsg != NULL print a warning if a reload is attempted, but fails.
197cda23fc3SBrooks Davis  * Return 0 on success, 1 on failure.
198cda23fc3SBrooks Davis  */
199cda23fc3SBrooks Davis int
200cda23fc3SBrooks Davis chkdoreload(struct statfs *mntp,
201cda23fc3SBrooks Davis 	void (*prtmsg)(const char *, ...) __printflike(1,2))
202cda23fc3SBrooks Davis {
203cda23fc3SBrooks Davis 	struct iovec *iov;
204cda23fc3SBrooks Davis 	int iovlen, error;
205cda23fc3SBrooks Davis 	char errmsg[255];
206cda23fc3SBrooks Davis 
207cda23fc3SBrooks Davis 	/*
208cda23fc3SBrooks Davis 	 * If the filesystem is not mounted it does not need to be reloaded.
209cda23fc3SBrooks Davis 	 * If it is mounted for writing, then it could not have been opened
210cda23fc3SBrooks Davis 	 * for writing by a utility, so does not need to be reloaded.
211cda23fc3SBrooks Davis 	 */
212cda23fc3SBrooks Davis 	if (mntp == NULL || (mntp->f_flags & MNT_RDONLY) == 0)
213cda23fc3SBrooks Davis 		return (0);
214cda23fc3SBrooks Davis 
215cda23fc3SBrooks Davis 	/*
216cda23fc3SBrooks Davis 	 * We modified a mounted file system.  Do a mount update on
217cda23fc3SBrooks Davis 	 * it so we can continue using it as safely as possible.
218cda23fc3SBrooks Davis 	 */
219cda23fc3SBrooks Davis 	iov = NULL;
220cda23fc3SBrooks Davis 	iovlen = 0;
221cda23fc3SBrooks Davis 	errmsg[0] = '\0';
222cda23fc3SBrooks Davis 	build_iovec(&iov, &iovlen, "fstype", __DECONST(void *, "ffs"), 4);
223cda23fc3SBrooks Davis 	build_iovec(&iov, &iovlen, "from", mntp->f_mntfromname, (size_t)-1);
224cda23fc3SBrooks Davis 	build_iovec(&iov, &iovlen, "fspath", mntp->f_mntonname, (size_t)-1);
225cda23fc3SBrooks Davis 	build_iovec(&iov, &iovlen, "errmsg", errmsg, sizeof(errmsg));
226cda23fc3SBrooks Davis 	build_iovec(&iov, &iovlen, "update", NULL, 0);
227cda23fc3SBrooks Davis 	build_iovec(&iov, &iovlen, "reload", NULL, 0);
228cda23fc3SBrooks Davis 	/*
229cda23fc3SBrooks Davis 	 * XX: We need the following line until we clean up
230cda23fc3SBrooks Davis 	 * nmount parsing of root mounts and NFS root mounts.
231cda23fc3SBrooks Davis 	 */
232cda23fc3SBrooks Davis 	build_iovec(&iov, &iovlen, "ro", NULL, 0);
233cda23fc3SBrooks Davis 	error = nmount(iov, iovlen, mntp->f_flags);
234cda23fc3SBrooks Davis 	free_iovec(&iov, &iovlen);
235cda23fc3SBrooks Davis 	if (error == 0)
236cda23fc3SBrooks Davis 		return (0);
237cda23fc3SBrooks Davis 	if (prtmsg != NULL)
238cda23fc3SBrooks Davis 		prtmsg("mount reload of '%s' failed: %s %s\n\n",
239cda23fc3SBrooks Davis 		    mntp->f_mntonname, strerror(errno), errmsg);
240cda23fc3SBrooks Davis 	return (1);
241cda23fc3SBrooks Davis }
242cda23fc3SBrooks Davis 
243cda23fc3SBrooks Davis void
build_iovec(struct iovec ** iov,int * iovlen,const char * name,void * val,size_t len)244cda23fc3SBrooks Davis build_iovec(struct iovec **iov, int *iovlen, const char *name, void *val,
245cda23fc3SBrooks Davis 	    size_t len)
246cda23fc3SBrooks Davis {
247cda23fc3SBrooks Davis 	int i;
248cda23fc3SBrooks Davis 
249cda23fc3SBrooks Davis 	if (*iovlen < 0)
250cda23fc3SBrooks Davis 		return;
251cda23fc3SBrooks Davis 	i = *iovlen;
252cda23fc3SBrooks Davis 	*iov = realloc(*iov, sizeof **iov * (i + 2));
253cda23fc3SBrooks Davis 	if (*iov == NULL) {
254cda23fc3SBrooks Davis 		*iovlen = -1;
255cda23fc3SBrooks Davis 		return;
256cda23fc3SBrooks Davis 	}
257cda23fc3SBrooks Davis 	(*iov)[i].iov_base = strdup(name);
258cda23fc3SBrooks Davis 	(*iov)[i].iov_len = strlen(name) + 1;
259cda23fc3SBrooks Davis 	i++;
260cda23fc3SBrooks Davis 	(*iov)[i].iov_base = val;
261cda23fc3SBrooks Davis 	if (len == (size_t)-1) {
262cda23fc3SBrooks Davis 		if (val != NULL)
263cda23fc3SBrooks Davis 			len = strlen(val) + 1;
264cda23fc3SBrooks Davis 		else
265cda23fc3SBrooks Davis 			len = 0;
266cda23fc3SBrooks Davis 	}
267cda23fc3SBrooks Davis 	(*iov)[i].iov_len = (int)len;
268cda23fc3SBrooks Davis 	*iovlen = ++i;
269cda23fc3SBrooks Davis }
270cda23fc3SBrooks Davis 
271cda23fc3SBrooks Davis /*
272cda23fc3SBrooks Davis  * This function is needed for compatibility with parameters
273cda23fc3SBrooks Davis  * which used to use the mount_argf() command for the old mount() syscall.
274cda23fc3SBrooks Davis  */
275cda23fc3SBrooks Davis void
build_iovec_argf(struct iovec ** iov,int * iovlen,const char * name,const char * fmt,...)276cda23fc3SBrooks Davis build_iovec_argf(struct iovec **iov, int *iovlen, const char *name,
277cda23fc3SBrooks Davis     const char *fmt, ...)
278cda23fc3SBrooks Davis {
279cda23fc3SBrooks Davis 	va_list ap;
280cda23fc3SBrooks Davis 	char val[255] = { 0 };
281cda23fc3SBrooks Davis 
282cda23fc3SBrooks Davis 	va_start(ap, fmt);
283cda23fc3SBrooks Davis 	vsnprintf(val, sizeof(val), fmt, ap);
284cda23fc3SBrooks Davis 	va_end(ap);
285cda23fc3SBrooks Davis 	build_iovec(iov, iovlen, name, strdup(val), (size_t)-1);
286cda23fc3SBrooks Davis }
287cda23fc3SBrooks Davis 
288cda23fc3SBrooks Davis /*
289cda23fc3SBrooks Davis  * Free the iovec and reset to NULL with zero length.  Useful for calling
290cda23fc3SBrooks Davis  * nmount in a loop.
291cda23fc3SBrooks Davis  */
292cda23fc3SBrooks Davis void
free_iovec(struct iovec ** iov,int * iovlen)293cda23fc3SBrooks Davis free_iovec(struct iovec **iov, int *iovlen)
294cda23fc3SBrooks Davis {
295cda23fc3SBrooks Davis 	int i;
296cda23fc3SBrooks Davis 
297cda23fc3SBrooks Davis 	for (i = 0; i < *iovlen; i += 2)
298cda23fc3SBrooks Davis 		free((*iov)[i].iov_base);
299cda23fc3SBrooks Davis 	free(*iov);
300cda23fc3SBrooks Davis }
301