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