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