xref: /freebsd/sys/fs/autofs/autofs.h (revision 6bb132ba1e4e28cf1e713c8dcd77f2e8af7bde88)
13914ddf8SEdward Tomasz Napierala /*-
24d846d26SWarner Losh  * SPDX-License-Identifier: BSD-2-Clause
318dffafaSEdward Tomasz Napierala  *
43914ddf8SEdward Tomasz Napierala  * Copyright (c) 2014 The FreeBSD Foundation
53914ddf8SEdward Tomasz Napierala  *
63914ddf8SEdward Tomasz Napierala  * This software was developed by Edward Tomasz Napierala under sponsorship
73914ddf8SEdward Tomasz Napierala  * from the FreeBSD Foundation.
83914ddf8SEdward Tomasz Napierala  *
93914ddf8SEdward Tomasz Napierala  * Redistribution and use in source and binary forms, with or without
103914ddf8SEdward Tomasz Napierala  * modification, are permitted provided that the following conditions
113914ddf8SEdward Tomasz Napierala  * are met:
123914ddf8SEdward Tomasz Napierala  * 1. Redistributions of source code must retain the above copyright
133914ddf8SEdward Tomasz Napierala  *    notice, this list of conditions and the following disclaimer.
143914ddf8SEdward Tomasz Napierala  * 2. Redistributions in binary form must reproduce the above copyright
153914ddf8SEdward Tomasz Napierala  *    notice, this list of conditions and the following disclaimer in the
163914ddf8SEdward Tomasz Napierala  *    documentation and/or other materials provided with the distribution.
173914ddf8SEdward Tomasz Napierala  *
183914ddf8SEdward Tomasz Napierala  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
193914ddf8SEdward Tomasz Napierala  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
203914ddf8SEdward Tomasz Napierala  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
213914ddf8SEdward Tomasz Napierala  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
223914ddf8SEdward Tomasz Napierala  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
233914ddf8SEdward Tomasz Napierala  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
243914ddf8SEdward Tomasz Napierala  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
253914ddf8SEdward Tomasz Napierala  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
263914ddf8SEdward Tomasz Napierala  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
273914ddf8SEdward Tomasz Napierala  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
283914ddf8SEdward Tomasz Napierala  * SUCH DAMAGE.
293914ddf8SEdward Tomasz Napierala  */
303914ddf8SEdward Tomasz Napierala 
313914ddf8SEdward Tomasz Napierala #ifndef AUTOFS_H
323914ddf8SEdward Tomasz Napierala #define	AUTOFS_H
333914ddf8SEdward Tomasz Napierala 
34*6bb132baSBrooks Davis #include <vm/uma.h>
35*6bb132baSBrooks Davis 
363914ddf8SEdward Tomasz Napierala #define VFSTOAUTOFS(mp)    ((struct autofs_mount *)((mp)->mnt_data))
373914ddf8SEdward Tomasz Napierala 
383914ddf8SEdward Tomasz Napierala MALLOC_DECLARE(M_AUTOFS);
393914ddf8SEdward Tomasz Napierala 
403914ddf8SEdward Tomasz Napierala extern uma_zone_t autofs_request_zone;
413914ddf8SEdward Tomasz Napierala extern uma_zone_t autofs_node_zone;
423914ddf8SEdward Tomasz Napierala 
433914ddf8SEdward Tomasz Napierala extern int autofs_debug;
443914ddf8SEdward Tomasz Napierala extern int autofs_mount_on_stat;
453914ddf8SEdward Tomasz Napierala 
463914ddf8SEdward Tomasz Napierala #define	AUTOFS_DEBUG(X, ...)						\
47baf9297eSEdward Tomasz Napierala 	do {								\
48baf9297eSEdward Tomasz Napierala 		if (autofs_debug > 1)					\
493914ddf8SEdward Tomasz Napierala 			printf("%s: " X "\n", __func__, ## __VA_ARGS__);\
503914ddf8SEdward Tomasz Napierala 	} while (0)
513914ddf8SEdward Tomasz Napierala 
523914ddf8SEdward Tomasz Napierala #define	AUTOFS_WARN(X, ...)						\
53baf9297eSEdward Tomasz Napierala 	do {								\
543914ddf8SEdward Tomasz Napierala 		if (autofs_debug > 0) {					\
553914ddf8SEdward Tomasz Napierala 			printf("WARNING: %s: " X "\n",			\
563914ddf8SEdward Tomasz Napierala 		    	    __func__, ## __VA_ARGS__);			\
57baf9297eSEdward Tomasz Napierala 		}							\
583914ddf8SEdward Tomasz Napierala 	} while (0)
593914ddf8SEdward Tomasz Napierala 
602eaebf35SEdward Tomasz Napierala #define AUTOFS_SLOCK(X)		sx_slock(&X->am_lock)
612eaebf35SEdward Tomasz Napierala #define AUTOFS_XLOCK(X)		sx_xlock(&X->am_lock)
622eaebf35SEdward Tomasz Napierala #define AUTOFS_SUNLOCK(X)	sx_sunlock(&X->am_lock)
632eaebf35SEdward Tomasz Napierala #define AUTOFS_XUNLOCK(X)	sx_xunlock(&X->am_lock)
642eaebf35SEdward Tomasz Napierala #define AUTOFS_ASSERT_LOCKED(X)		sx_assert(&X->am_lock, SA_LOCKED)
652eaebf35SEdward Tomasz Napierala #define AUTOFS_ASSERT_XLOCKED(X)	sx_assert(&X->am_lock, SA_XLOCKED)
663914ddf8SEdward Tomasz Napierala #define AUTOFS_ASSERT_UNLOCKED(X)	sx_assert(&X->am_lock, SA_UNLOCKED)
673914ddf8SEdward Tomasz Napierala 
683914ddf8SEdward Tomasz Napierala struct autofs_node {
6942ed64e3SEdward Tomasz Napierala 	RB_ENTRY(autofs_node)		an_link;
703914ddf8SEdward Tomasz Napierala 	char				*an_name;
713914ddf8SEdward Tomasz Napierala 	int				an_fileno;
723914ddf8SEdward Tomasz Napierala 	struct autofs_node		*an_parent;
7342ed64e3SEdward Tomasz Napierala 	RB_HEAD(autofs_node_tree,
7442ed64e3SEdward Tomasz Napierala 	    autofs_node)		an_children;
753914ddf8SEdward Tomasz Napierala 	struct autofs_mount		*an_mount;
763914ddf8SEdward Tomasz Napierala 	struct vnode			*an_vnode;
773914ddf8SEdward Tomasz Napierala 	struct sx			an_vnode_lock;
783914ddf8SEdward Tomasz Napierala 	bool				an_cached;
794cdc52bdSEdward Tomasz Napierala 	bool				an_wildcards;
803914ddf8SEdward Tomasz Napierala 	struct callout			an_callout;
813914ddf8SEdward Tomasz Napierala 	int				an_retries;
823914ddf8SEdward Tomasz Napierala 	struct timespec			an_ctime;
833914ddf8SEdward Tomasz Napierala };
843914ddf8SEdward Tomasz Napierala 
853914ddf8SEdward Tomasz Napierala struct autofs_mount {
863914ddf8SEdward Tomasz Napierala 	TAILQ_ENTRY(autofs_mount)	am_next;
873914ddf8SEdward Tomasz Napierala 	struct autofs_node		*am_root;
883914ddf8SEdward Tomasz Napierala 	struct mount			*am_mp;
893914ddf8SEdward Tomasz Napierala 	struct sx			am_lock;
903914ddf8SEdward Tomasz Napierala 	char				am_from[MAXPATHLEN];
913914ddf8SEdward Tomasz Napierala 	char				am_mountpoint[MAXPATHLEN];
923914ddf8SEdward Tomasz Napierala 	char				am_options[MAXPATHLEN];
933914ddf8SEdward Tomasz Napierala 	char				am_prefix[MAXPATHLEN];
943914ddf8SEdward Tomasz Napierala 	int				am_last_fileno;
953914ddf8SEdward Tomasz Napierala };
963914ddf8SEdward Tomasz Napierala 
973914ddf8SEdward Tomasz Napierala struct autofs_request {
983914ddf8SEdward Tomasz Napierala 	TAILQ_ENTRY(autofs_request)	ar_next;
993914ddf8SEdward Tomasz Napierala 	struct autofs_mount		*ar_mount;
1003914ddf8SEdward Tomasz Napierala 	int				ar_id;
1013914ddf8SEdward Tomasz Napierala 	bool				ar_done;
1023914ddf8SEdward Tomasz Napierala 	int				ar_error;
1034cdc52bdSEdward Tomasz Napierala 	bool				ar_wildcards;
1043914ddf8SEdward Tomasz Napierala 	bool				ar_in_progress;
1053914ddf8SEdward Tomasz Napierala 	char				ar_from[MAXPATHLEN];
1063914ddf8SEdward Tomasz Napierala 	char				ar_path[MAXPATHLEN];
1073914ddf8SEdward Tomasz Napierala 	char				ar_prefix[MAXPATHLEN];
1083914ddf8SEdward Tomasz Napierala 	char				ar_key[MAXPATHLEN];
1093914ddf8SEdward Tomasz Napierala 	char				ar_options[MAXPATHLEN];
110759489f9SEdward Tomasz Napierala 	struct timeout_task		ar_task;
1113914ddf8SEdward Tomasz Napierala 	volatile u_int			ar_refcount;
1123914ddf8SEdward Tomasz Napierala };
1133914ddf8SEdward Tomasz Napierala 
1143914ddf8SEdward Tomasz Napierala struct autofs_softc {
1153914ddf8SEdward Tomasz Napierala 	device_t			sc_dev;
1163914ddf8SEdward Tomasz Napierala 	struct cdev			*sc_cdev;
1173914ddf8SEdward Tomasz Napierala 	struct cv			sc_cv;
1183914ddf8SEdward Tomasz Napierala 	struct sx			sc_lock;
1193914ddf8SEdward Tomasz Napierala 	TAILQ_HEAD(, autofs_request)	sc_requests;
1203914ddf8SEdward Tomasz Napierala 	bool				sc_dev_opened;
1213914ddf8SEdward Tomasz Napierala 	pid_t				sc_dev_sid;
1223914ddf8SEdward Tomasz Napierala 	int				sc_last_request_id;
1233914ddf8SEdward Tomasz Napierala };
1243914ddf8SEdward Tomasz Napierala 
1253914ddf8SEdward Tomasz Napierala int	autofs_init(struct vfsconf *vfsp);
1263914ddf8SEdward Tomasz Napierala int	autofs_uninit(struct vfsconf *vfsp);
1273914ddf8SEdward Tomasz Napierala int	autofs_trigger(struct autofs_node *anp, const char *component,
1283914ddf8SEdward Tomasz Napierala 	    int componentlen);
1293914ddf8SEdward Tomasz Napierala bool	autofs_cached(struct autofs_node *anp, const char *component,
1303914ddf8SEdward Tomasz Napierala 	    int componentlen);
131e3d5f1feSEdward Tomasz Napierala void	autofs_flush(struct autofs_mount *amp);
1323914ddf8SEdward Tomasz Napierala bool	autofs_ignore_thread(const struct thread *td);
1333914ddf8SEdward Tomasz Napierala int	autofs_node_new(struct autofs_node *parent, struct autofs_mount *amp,
1343914ddf8SEdward Tomasz Napierala 	    const char *name, int namelen, struct autofs_node **anpp);
1353914ddf8SEdward Tomasz Napierala int	autofs_node_find(struct autofs_node *parent,
1363914ddf8SEdward Tomasz Napierala 	    const char *name, int namelen, struct autofs_node **anpp);
1373914ddf8SEdward Tomasz Napierala void	autofs_node_delete(struct autofs_node *anp);
1383914ddf8SEdward Tomasz Napierala int	autofs_node_vn(struct autofs_node *anp, struct mount *mp,
139d19c297eSEdward Tomasz Napierala 	    int flags, struct vnode **vpp);
1403914ddf8SEdward Tomasz Napierala 
14142ed64e3SEdward Tomasz Napierala RB_PROTOTYPE(autofs_node_tree, autofs_node, an_link, autofs_node_cmp);
14242ed64e3SEdward Tomasz Napierala 
1433914ddf8SEdward Tomasz Napierala #endif /* !AUTOFS_H */
144