2 * Copyright (c) 2014 The FreeBSD Foundation
5 * This software was developed by Edward Tomasz Napierala under sponsorship
6 * from the FreeBSD Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * Copyright (c) 1989, 1991, 1993, 1995
32 * The Regents of the University of California. All rights reserved.
34 * This code is derived from software contributed to Berkeley by
35 * Rick Macklem at The University of Guelph.
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions
40 * 1. Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * 2. Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in the
44 * documentation and/or other materials provided with the distribution.
45 * 4. Neither the name of the University nor the names of its contributors
46 * may be used to endorse or promote products derived from this software
47 * without specific prior written permission.
49 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
63 #include <sys/cdefs.h>
64 __FBSDID("$FreeBSD$");
66 #include <sys/param.h>
67 #include <sys/systm.h>
70 #include <sys/dirent.h>
71 #include <sys/ioccom.h>
72 #include <sys/kernel.h>
73 #include <sys/module.h>
74 #include <sys/mount.h>
75 #include <sys/refcount.h>
77 #include <sys/sysctl.h>
78 #include <sys/syscallsubr.h>
79 #include <sys/vnode.h>
80 #include <machine/atomic.h>
83 #include <fs/autofs/autofs.h>
84 #include <fs/autofs/autofs_ioctl.h>
86 MALLOC_DEFINE(M_AUTOFS, "autofs", "Automounter filesystem");
88 uma_zone_t autofs_request_zone;
89 uma_zone_t autofs_node_zone;
91 static int autofs_open(struct cdev *dev, int flags, int fmt,
93 static int autofs_close(struct cdev *dev, int flag, int fmt,
95 static int autofs_ioctl(struct cdev *dev, u_long cmd, caddr_t arg,
96 int mode, struct thread *td);
98 static struct cdevsw autofs_cdevsw = {
99 .d_version = D_VERSION,
100 .d_open = autofs_open,
101 .d_close = autofs_close,
102 .d_ioctl = autofs_ioctl,
107 * List of signals that can interrupt an autofs trigger. Might be a good
108 * idea to keep it synchronised with list in sys/fs/nfs/nfs_commonkrpc.c.
110 int autofs_sig_set[] = {
118 struct autofs_softc *autofs_softc;
120 SYSCTL_NODE(_vfs, OID_AUTO, autofs, CTLFLAG_RD, 0, "Automounter filesystem");
121 int autofs_debug = 1;
122 TUNABLE_INT("vfs.autofs.debug", &autofs_debug);
123 SYSCTL_INT(_vfs_autofs, OID_AUTO, debug, CTLFLAG_RWTUN,
124 &autofs_debug, 1, "Enable debug messages");
125 int autofs_mount_on_stat = 0;
126 TUNABLE_INT("vfs.autofs.mount_on_stat", &autofs_mount_on_stat);
127 SYSCTL_INT(_vfs_autofs, OID_AUTO, mount_on_stat, CTLFLAG_RWTUN,
128 &autofs_mount_on_stat, 0, "Trigger mount on stat(2) on mountpoint");
129 int autofs_timeout = 30;
130 TUNABLE_INT("vfs.autofs.timeout", &autofs_timeout);
131 SYSCTL_INT(_vfs_autofs, OID_AUTO, timeout, CTLFLAG_RWTUN,
132 &autofs_timeout, 30, "Number of seconds to wait for automountd(8)");
133 int autofs_cache = 600;
134 TUNABLE_INT("vfs.autofs.cache", &autofs_cache);
135 SYSCTL_INT(_vfs_autofs, OID_AUTO, cache, CTLFLAG_RWTUN,
136 &autofs_cache, 600, "Number of seconds to wait before reinvoking "
137 "automountd(8) for any given file or directory");
138 int autofs_retry_attempts = 3;
139 TUNABLE_INT("vfs.autofs.retry_attempts", &autofs_retry_attempts);
140 SYSCTL_INT(_vfs_autofs, OID_AUTO, retry_attempts, CTLFLAG_RWTUN,
141 &autofs_retry_attempts, 3, "Number of attempts before failing mount");
142 int autofs_retry_delay = 1;
143 TUNABLE_INT("vfs.autofs.retry_delay", &autofs_retry_delay);
144 SYSCTL_INT(_vfs_autofs, OID_AUTO, retry_delay, CTLFLAG_RWTUN,
145 &autofs_retry_delay, 1, "Number of seconds before retrying");
146 int autofs_interruptible = 1;
147 TUNABLE_INT("vfs.autofs.interruptible", &autofs_interruptible);
148 SYSCTL_INT(_vfs_autofs, OID_AUTO, interruptible, CTLFLAG_RWTUN,
149 &autofs_interruptible, 1, "Allow requests to be interrupted by signal");
152 autofs_init(struct vfsconf *vfsp)
156 KASSERT(autofs_softc == NULL,
157 ("softc %p, should be NULL", autofs_softc));
159 autofs_softc = malloc(sizeof(*autofs_softc), M_AUTOFS,
162 autofs_request_zone = uma_zcreate("autofs_request",
163 sizeof(struct autofs_request), NULL, NULL, NULL, NULL,
165 autofs_node_zone = uma_zcreate("autofs_node",
166 sizeof(struct autofs_node), NULL, NULL, NULL, NULL,
169 TAILQ_INIT(&autofs_softc->sc_requests);
170 cv_init(&autofs_softc->sc_cv, "autofscv");
171 sx_init(&autofs_softc->sc_lock, "autofslk");
173 error = make_dev_p(MAKEDEV_CHECKNAME, &autofs_softc->sc_cdev,
174 &autofs_cdevsw, NULL, UID_ROOT, GID_WHEEL, 0600, "autofs");
176 AUTOFS_WARN("failed to create device node, error %d", error);
177 uma_zdestroy(autofs_request_zone);
178 uma_zdestroy(autofs_node_zone);
179 free(autofs_softc, M_AUTOFS);
183 autofs_softc->sc_cdev->si_drv1 = autofs_softc;
189 autofs_uninit(struct vfsconf *vfsp)
192 sx_xlock(&autofs_softc->sc_lock);
193 if (autofs_softc->sc_dev_opened) {
194 sx_xunlock(&autofs_softc->sc_lock);
197 if (autofs_softc->sc_cdev != NULL)
198 destroy_dev(autofs_softc->sc_cdev);
200 uma_zdestroy(autofs_request_zone);
201 uma_zdestroy(autofs_node_zone);
203 sx_xunlock(&autofs_softc->sc_lock);
205 * XXX: Race with open?
207 free(autofs_softc, M_AUTOFS);
213 autofs_ignore_thread(const struct thread *td)
219 if (autofs_softc->sc_dev_opened == false)
223 if (p->p_session->s_sid == autofs_softc->sc_dev_sid) {
233 autofs_path(struct autofs_node *anp)
235 struct autofs_mount *amp;
240 path = strdup("", M_AUTOFS);
241 for (; anp->an_parent != NULL; anp = anp->an_parent) {
242 tmp = malloc(strlen(anp->an_name) + strlen(path) + 2,
244 strcpy(tmp, anp->an_name);
247 free(path, M_AUTOFS);
251 tmp = malloc(strlen(amp->am_mountpoint) + strlen(path) + 2,
253 strcpy(tmp, amp->am_mountpoint);
256 free(path, M_AUTOFS);
263 autofs_callout(void *context)
265 struct autofs_request *ar;
269 sx_xlock(&autofs_softc->sc_lock);
270 AUTOFS_WARN("request %d for %s timed out after %d seconds",
271 ar->ar_id, ar->ar_path, autofs_timeout);
275 ar->ar_error = ETIMEDOUT;
277 ar->ar_in_progress = false;
278 cv_broadcast(&autofs_softc->sc_cv);
279 sx_xunlock(&autofs_softc->sc_lock);
283 autofs_cached(struct autofs_node *anp, const char *component, int componentlen)
286 struct autofs_mount *amp;
290 AUTOFS_ASSERT_UNLOCKED(amp);
293 * For top-level nodes we need to request automountd(8)
294 * assistance even if the node is marked as cached,
295 * but the requested subdirectory does not exist. This
296 * is necessary for wildcard indirect map keys to work.
298 if (anp->an_parent == NULL && componentlen != 0) {
300 error = autofs_node_find(anp, component, componentlen, NULL);
306 return (anp->an_cached);
310 autofs_cache_callout(void *context)
312 struct autofs_node *anp;
315 anp->an_cached = false;
319 * The set/restore sigmask functions are used to (temporarily) overwrite
320 * the thread td_sigmask during triggering.
323 autofs_set_sigmask(sigset_t *oldset)
329 /* Remove the autofs set of signals from newset */
331 mtx_lock(&curproc->p_sigacts->ps_mtx);
332 for (i = 0 ; i < sizeof(autofs_sig_set)/sizeof(int) ; i++) {
334 * But make sure we leave the ones already masked
335 * by the process, i.e. remove the signal from the
336 * temporary signalmask only if it wasn't already
339 if (!SIGISMEMBER(curthread->td_sigmask, autofs_sig_set[i]) &&
340 !SIGISMEMBER(curproc->p_sigacts->ps_sigignore,
341 autofs_sig_set[i])) {
342 SIGDELSET(newset, autofs_sig_set[i]);
345 mtx_unlock(&curproc->p_sigacts->ps_mtx);
346 kern_sigprocmask(curthread, SIG_SETMASK, &newset, oldset,
347 SIGPROCMASK_PROC_LOCKED);
348 PROC_UNLOCK(curproc);
352 autofs_restore_sigmask(sigset_t *set)
355 kern_sigprocmask(curthread, SIG_SETMASK, set, NULL, 0);
359 autofs_trigger_one(struct autofs_node *anp,
360 const char *component, int componentlen)
363 struct autofs_mount *amp;
364 struct autofs_node *firstanp;
365 struct autofs_request *ar;
367 int error = 0, request_error, last;
369 amp = VFSTOAUTOFS(anp->an_vnode->v_mount);
371 sx_assert(&autofs_softc->sc_lock, SA_XLOCKED);
373 if (anp->an_parent == NULL) {
374 key = strndup(component, componentlen, M_AUTOFS);
376 for (firstanp = anp; firstanp->an_parent->an_parent != NULL;
377 firstanp = firstanp->an_parent)
379 key = strdup(firstanp->an_name, M_AUTOFS);
382 path = autofs_path(anp);
384 TAILQ_FOREACH(ar, &autofs_softc->sc_requests, ar_next) {
385 if (strcmp(ar->ar_path, path) != 0)
387 if (strcmp(ar->ar_key, key) != 0)
390 KASSERT(strcmp(ar->ar_from, amp->am_from) == 0,
391 ("from changed; %s != %s", ar->ar_from, amp->am_from));
392 KASSERT(strcmp(ar->ar_prefix, amp->am_prefix) == 0,
393 ("prefix changed; %s != %s",
394 ar->ar_prefix, amp->am_prefix));
395 KASSERT(strcmp(ar->ar_options, amp->am_options) == 0,
396 ("options changed; %s != %s",
397 ar->ar_options, amp->am_options));
403 refcount_acquire(&ar->ar_refcount);
405 ar = uma_zalloc(autofs_request_zone, M_WAITOK | M_ZERO);
409 atomic_fetchadd_int(&autofs_softc->sc_last_request_id, 1);
410 strlcpy(ar->ar_from, amp->am_from, sizeof(ar->ar_from));
411 strlcpy(ar->ar_path, path, sizeof(ar->ar_path));
412 strlcpy(ar->ar_prefix, amp->am_prefix, sizeof(ar->ar_prefix));
413 strlcpy(ar->ar_key, key, sizeof(ar->ar_key));
414 strlcpy(ar->ar_options,
415 amp->am_options, sizeof(ar->ar_options));
417 callout_init(&ar->ar_callout, 1);
418 callout_reset(&ar->ar_callout,
419 autofs_timeout * hz, autofs_callout, ar);
420 refcount_init(&ar->ar_refcount, 1);
421 TAILQ_INSERT_TAIL(&autofs_softc->sc_requests, ar, ar_next);
424 cv_broadcast(&autofs_softc->sc_cv);
425 while (ar->ar_done == false) {
426 if (autofs_interruptible != 0) {
427 autofs_set_sigmask(&oldset);
428 error = cv_wait_sig(&autofs_softc->sc_cv,
429 &autofs_softc->sc_lock);
430 autofs_restore_sigmask(&oldset);
433 * XXX: For some reson this returns -1
434 * instead of EINTR, wtf?!
437 AUTOFS_WARN("cv_wait_sig for %s failed "
438 "with error %d", ar->ar_path, error);
442 cv_wait(&autofs_softc->sc_cv, &autofs_softc->sc_lock);
446 request_error = ar->ar_error;
447 if (request_error != 0) {
448 AUTOFS_WARN("request for %s completed with error %d",
449 ar->ar_path, request_error);
452 last = refcount_release(&ar->ar_refcount);
454 TAILQ_REMOVE(&autofs_softc->sc_requests, ar, ar_next);
458 sx_xunlock(&autofs_softc->sc_lock);
459 callout_drain(&ar->ar_callout);
460 sx_xlock(&autofs_softc->sc_lock);
461 uma_zfree(autofs_request_zone, ar);
465 * Note that we do not do negative caching on purpose. This
466 * way the user can retry access at any time, e.g. after fixing
467 * the failure reason, without waiting for cache timer to expire.
469 if (error == 0 && request_error == 0 && autofs_cache > 0) {
470 anp->an_cached = true;
471 callout_reset(&anp->an_callout, autofs_cache * hz,
472 autofs_cache_callout, anp);
476 free(path, M_AUTOFS);
480 return (request_error);
484 * Send request to automountd(8) and wait for completion.
487 autofs_trigger(struct autofs_node *anp,
488 const char *component, int componentlen)
493 error = autofs_trigger_one(anp, component, componentlen);
498 if (error == EINTR) {
499 AUTOFS_DEBUG("trigger interrupted by signal, "
505 if (anp->an_retries >= autofs_retry_attempts) {
506 AUTOFS_DEBUG("trigger failed %d times; returning "
507 "error %d", anp->an_retries, error);
512 AUTOFS_DEBUG("trigger failed with error %d; will retry in "
513 "%d seconds, %d attempts left", error, autofs_retry_delay,
514 autofs_retry_attempts - anp->an_retries);
515 sx_xunlock(&autofs_softc->sc_lock);
516 pause("autofs_retry", autofs_retry_delay * hz);
517 sx_xlock(&autofs_softc->sc_lock);
522 autofs_ioctl_request(struct autofs_daemon_request *adr)
524 struct autofs_request *ar;
527 sx_xlock(&autofs_softc->sc_lock);
529 TAILQ_FOREACH(ar, &autofs_softc->sc_requests, ar_next) {
532 if (ar->ar_in_progress)
541 error = cv_wait_sig(&autofs_softc->sc_cv,
542 &autofs_softc->sc_lock);
545 * XXX: For some reson this returns -1 instead
549 sx_xunlock(&autofs_softc->sc_lock);
550 AUTOFS_DEBUG("failed with error %d", error);
555 ar->ar_in_progress = true;
556 sx_xunlock(&autofs_softc->sc_lock);
558 adr->adr_id = ar->ar_id;
559 strlcpy(adr->adr_from, ar->ar_from, sizeof(adr->adr_from));
560 strlcpy(adr->adr_path, ar->ar_path, sizeof(adr->adr_path));
561 strlcpy(adr->adr_prefix, ar->ar_prefix, sizeof(adr->adr_prefix));
562 strlcpy(adr->adr_key, ar->ar_key, sizeof(adr->adr_key));
563 strlcpy(adr->adr_options, ar->ar_options, sizeof(adr->adr_options));
566 autofs_softc->sc_dev_sid = curproc->p_session->s_sid;
567 PROC_UNLOCK(curproc);
573 autofs_ioctl_done(struct autofs_daemon_done *add)
575 struct autofs_request *ar;
577 sx_xlock(&autofs_softc->sc_lock);
578 TAILQ_FOREACH(ar, &autofs_softc->sc_requests, ar_next) {
579 if (ar->ar_id == add->add_id)
584 sx_xunlock(&autofs_softc->sc_lock);
585 AUTOFS_DEBUG("id %d not found", add->add_id);
589 ar->ar_error = add->add_error;
591 ar->ar_in_progress = false;
592 cv_broadcast(&autofs_softc->sc_cv);
594 sx_xunlock(&autofs_softc->sc_lock);
600 autofs_open(struct cdev *dev, int flags, int fmt, struct thread *td)
603 sx_xlock(&autofs_softc->sc_lock);
605 * We must never block automountd(8) and its descendants, and we use
606 * session ID to determine that: we store session id of the process
607 * that opened the device, and then compare it with session ids
608 * of triggering processes. This means running a second automountd(8)
609 * instance would break the previous one. The check below prevents
612 if (autofs_softc->sc_dev_opened) {
613 sx_xunlock(&autofs_softc->sc_lock);
617 autofs_softc->sc_dev_opened = true;
618 sx_xunlock(&autofs_softc->sc_lock);
624 autofs_close(struct cdev *dev, int flag, int fmt, struct thread *td)
627 sx_xlock(&autofs_softc->sc_lock);
628 KASSERT(autofs_softc->sc_dev_opened, ("not opened?"));
629 autofs_softc->sc_dev_opened = false;
630 sx_xunlock(&autofs_softc->sc_lock);
636 autofs_ioctl(struct cdev *dev, u_long cmd, caddr_t arg, int mode,
640 KASSERT(autofs_softc->sc_dev_opened, ("not opened?"));
644 return (autofs_ioctl_request(
645 (struct autofs_daemon_request *)arg));
647 return (autofs_ioctl_done(
648 (struct autofs_daemon_done *)arg));
650 AUTOFS_DEBUG("invalid cmd %lx", cmd);