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