xref: /freebsd/sys/fs/autofs/autofs.h (revision 40a8ac8f62b535d30349faf28cf47106b7041b83)
1 /*-
2  * Copyright (c) 2014 The FreeBSD Foundation
3  * All rights reserved.
4  *
5  * This software was developed by Edward Tomasz Napierala under sponsorship
6  * from the FreeBSD Foundation.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
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.
16  *
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
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 
32 #ifndef AUTOFS_H
33 #define	AUTOFS_H
34 
35 #define VFSTOAUTOFS(mp)    ((struct autofs_mount *)((mp)->mnt_data))
36 
37 MALLOC_DECLARE(M_AUTOFS);
38 
39 extern uma_zone_t autofs_request_zone;
40 extern uma_zone_t autofs_node_zone;
41 
42 extern int autofs_debug;
43 extern int autofs_mount_on_stat;
44 
45 #define	AUTOFS_DEBUG(X, ...)					\
46 	if (autofs_debug > 1) {					\
47 		printf("%s: " X "\n", __func__, ## __VA_ARGS__);\
48 	} while (0)
49 
50 #define	AUTOFS_WARN(X, ...)					\
51 	if (autofs_debug > 0) {					\
52 		printf("WARNING: %s: " X "\n",			\
53 		    __func__, ## __VA_ARGS__);			\
54 	} while (0)
55 
56 #define AUTOFS_LOCK(X)		sx_xlock(&X->am_lock)
57 #define AUTOFS_UNLOCK(X)	sx_xunlock(&X->am_lock)
58 #define AUTOFS_ASSERT_LOCKED(X)	sx_assert(&X->am_lock, SA_XLOCKED)
59 #define AUTOFS_ASSERT_UNLOCKED(X)	sx_assert(&X->am_lock, SA_UNLOCKED)
60 
61 struct autofs_node {
62 	TAILQ_ENTRY(autofs_node)	an_next;
63 	char				*an_name;
64 	int				an_fileno;
65 	struct autofs_node		*an_parent;
66 	TAILQ_HEAD(, autofs_node)	an_children;
67 	struct autofs_mount		*an_mount;
68 	struct vnode			*an_vnode;
69 	struct sx			an_vnode_lock;
70 	bool				an_cached;
71 	struct callout			an_callout;
72 	int				an_retries;
73 	struct timespec			an_ctime;
74 };
75 
76 struct autofs_mount {
77 	TAILQ_ENTRY(autofs_mount)	am_next;
78 	struct autofs_node		*am_root;
79 	struct mount			*am_mp;
80 	struct sx			am_lock;
81 	char				am_from[MAXPATHLEN];
82 	char				am_mountpoint[MAXPATHLEN];
83 	char				am_options[MAXPATHLEN];
84 	char				am_prefix[MAXPATHLEN];
85 	int				am_last_fileno;
86 };
87 
88 struct autofs_request {
89 	TAILQ_ENTRY(autofs_request)	ar_next;
90 	struct autofs_mount		*ar_mount;
91 	int				ar_id;
92 	bool				ar_done;
93 	int				ar_error;
94 	bool				ar_in_progress;
95 	char				ar_from[MAXPATHLEN];
96 	char				ar_path[MAXPATHLEN];
97 	char				ar_prefix[MAXPATHLEN];
98 	char				ar_key[MAXPATHLEN];
99 	char				ar_options[MAXPATHLEN];
100 	struct callout			ar_callout;
101 	volatile u_int			ar_refcount;
102 };
103 
104 struct autofs_softc {
105 	device_t			sc_dev;
106 	struct cdev			*sc_cdev;
107 	struct cv			sc_cv;
108 	struct sx			sc_lock;
109 	TAILQ_HEAD(, autofs_request)	sc_requests;
110 	bool				sc_dev_opened;
111 	pid_t				sc_dev_sid;
112 	int				sc_last_request_id;
113 };
114 
115 /*
116  * Limits and constants
117  */
118 #define AUTOFS_NAMELEN		24
119 #define AUTOFS_FSNAMELEN	16	/* equal to MFSNAMELEN */
120 #define AUTOFS_DELEN		(8 + AUTOFS_NAMELEN)
121 
122 int	autofs_init(struct vfsconf *vfsp);
123 int	autofs_uninit(struct vfsconf *vfsp);
124 int	autofs_trigger(struct autofs_node *anp, const char *component,
125 	    int componentlen);
126 bool	autofs_cached(struct autofs_node *anp, const char *component,
127 	    int componentlen);
128 bool	autofs_ignore_thread(const struct thread *td);
129 int	autofs_node_new(struct autofs_node *parent, struct autofs_mount *amp,
130 	    const char *name, int namelen, struct autofs_node **anpp);
131 int	autofs_node_find(struct autofs_node *parent,
132 	    const char *name, int namelen, struct autofs_node **anpp);
133 void	autofs_node_delete(struct autofs_node *anp);
134 int	autofs_node_vn(struct autofs_node *anp, struct mount *mp,
135 	    struct vnode **vpp);
136 
137 #endif /* !AUTOFS_H */
138