xref: /dragonfly/sys/vfs/autofs/autofs.h (revision ce650ac4)
1e2950f41STomohiro Kusumi /*-
263bc4984STomohiro Kusumi  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
363bc4984STomohiro Kusumi  *
449837aefSTomohiro Kusumi  * Copyright (c) 2016 Tomohiro Kusumi <tkusumi@netbsd.org>
5e2950f41STomohiro Kusumi  * Copyright (c) 2016 The DragonFly Project
6e2950f41STomohiro Kusumi  * Copyright (c) 2014 The FreeBSD Foundation
7e2950f41STomohiro Kusumi  * All rights reserved.
8e2950f41STomohiro Kusumi  *
9e2950f41STomohiro Kusumi  * This software was developed by Edward Tomasz Napierala under sponsorship
10e2950f41STomohiro Kusumi  * from the FreeBSD Foundation.
11e2950f41STomohiro Kusumi  *
12e2950f41STomohiro Kusumi  * Redistribution and use in source and binary forms, with or without
13e2950f41STomohiro Kusumi  * modification, are permitted provided that the following conditions
14e2950f41STomohiro Kusumi  * are met:
15e2950f41STomohiro Kusumi  * 1. Redistributions of source code must retain the above copyright
16e2950f41STomohiro Kusumi  *    notice, this list of conditions and the following disclaimer.
17e2950f41STomohiro Kusumi  * 2. Redistributions in binary form must reproduce the above copyright
18e2950f41STomohiro Kusumi  *    notice, this list of conditions and the following disclaimer in the
19e2950f41STomohiro Kusumi  *    documentation and/or other materials provided with the distribution.
20e2950f41STomohiro Kusumi  *
21e2950f41STomohiro Kusumi  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22e2950f41STomohiro Kusumi  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23e2950f41STomohiro Kusumi  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24e2950f41STomohiro Kusumi  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25e2950f41STomohiro Kusumi  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26e2950f41STomohiro Kusumi  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27e2950f41STomohiro Kusumi  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28e2950f41STomohiro Kusumi  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29e2950f41STomohiro Kusumi  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30e2950f41STomohiro Kusumi  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31e2950f41STomohiro Kusumi  * SUCH DAMAGE.
32e2950f41STomohiro Kusumi  *
33e2950f41STomohiro Kusumi  * $FreeBSD$
34e2950f41STomohiro Kusumi  */
35e2950f41STomohiro Kusumi 
36e2950f41STomohiro Kusumi #ifndef AUTOFS_H
37e2950f41STomohiro Kusumi #define AUTOFS_H
38e2950f41STomohiro Kusumi 
39e2950f41STomohiro Kusumi #include <sys/kernel.h>
40e2950f41STomohiro Kusumi #include <sys/module.h>
41e2950f41STomohiro Kusumi #include <sys/types.h>
42e2950f41STomohiro Kusumi #include <sys/systm.h>
43e2950f41STomohiro Kusumi #include <sys/malloc.h>
44e2950f41STomohiro Kusumi #include <sys/objcache.h>
45e2950f41STomohiro Kusumi #include <sys/tree.h>
46bfccbb76STomohiro Kusumi #include <sys/mutex2.h>
47e2950f41STomohiro Kusumi #include <sys/condvar.h>
48e2950f41STomohiro Kusumi #include <sys/mount.h>
49e2950f41STomohiro Kusumi #include <sys/vnode.h>
50e2950f41STomohiro Kusumi #include <sys/timespec.h>
51e2950f41STomohiro Kusumi #include <sys/callout.h>
52e2950f41STomohiro Kusumi #include <sys/taskqueue.h>
53e2950f41STomohiro Kusumi #include <sys/conf.h>
54*ce650ac4STomohiro Kusumi #include <sys/proc.h>
55e2950f41STomohiro Kusumi 
56e2950f41STomohiro Kusumi #define AUTOFS_ROOTINO	((ino_t)1)
57e2950f41STomohiro Kusumi #define VFSTOAUTOFS(mp)	((struct autofs_mount *)((mp)->mnt_data))
58e2950f41STomohiro Kusumi #define VTOI(vp)	((struct autofs_node *)((vp)->v_data))
59e2950f41STomohiro Kusumi 
607ea34faaSzrj #ifdef MALLOC_DECLARE
61e2950f41STomohiro Kusumi MALLOC_DECLARE(M_AUTOFS);
627ea34faaSzrj #endif
63e2950f41STomohiro Kusumi 
64e2950f41STomohiro Kusumi extern struct objcache *autofs_request_objcache;
65e2950f41STomohiro Kusumi extern struct objcache *autofs_node_objcache;
66add630f0STomohiro Kusumi extern struct autofs_softc *autofs_softc;
67add630f0STomohiro Kusumi extern struct dev_ops autofs_ops;
68e2950f41STomohiro Kusumi 
69e2950f41STomohiro Kusumi extern struct vop_ops autofs_vnode_vops;
70e2950f41STomohiro Kusumi 
71e2950f41STomohiro Kusumi extern int autofs_debug;
72888acc39STomohiro Kusumi //extern int autofs_mount_on_stat;
73e2950f41STomohiro Kusumi 
74e2950f41STomohiro Kusumi #define AUTOFS_DEBUG(X, ...)				\
75e2950f41STomohiro Kusumi 	do {						\
76e2950f41STomohiro Kusumi 		if (autofs_debug > 1)			\
77e2950f41STomohiro Kusumi 			kprintf("%s: " X "\n",		\
78e2950f41STomohiro Kusumi 			    __func__, ## __VA_ARGS__);	\
79e2950f41STomohiro Kusumi 	} while (0)
80e2950f41STomohiro Kusumi 
81e2950f41STomohiro Kusumi #define AUTOFS_WARN(X, ...)				\
82e2950f41STomohiro Kusumi 	do {						\
83e2950f41STomohiro Kusumi 		if (autofs_debug > 0) {			\
84e2950f41STomohiro Kusumi 			kprintf("WARNING: %s: " X "\n",	\
85e2950f41STomohiro Kusumi 			    __func__, ## __VA_ARGS__);	\
86e2950f41STomohiro Kusumi 		}					\
87e2950f41STomohiro Kusumi 	} while (0)
88e2950f41STomohiro Kusumi 
89caaec4e3STomohiro Kusumi /*
90caaec4e3STomohiro Kusumi  * APRINTF is only for debugging.
91caaec4e3STomohiro Kusumi  */
92caaec4e3STomohiro Kusumi #define APRINTF(X, ...)					\
93caaec4e3STomohiro Kusumi 	kprintf("### %s(%s): " X,			\
94b5e90fe9STomohiro Kusumi 	    __func__, curproc ? curproc->p_comm : "-", ## __VA_ARGS__)
95caaec4e3STomohiro Kusumi 
96e2950f41STomohiro Kusumi struct autofs_node {
97e2950f41STomohiro Kusumi 	RB_ENTRY(autofs_node)		an_link;
98e2950f41STomohiro Kusumi 	char				*an_name;
99e2950f41STomohiro Kusumi 	ino_t				an_ino;
100e2950f41STomohiro Kusumi 	struct autofs_node		*an_parent;
101e2950f41STomohiro Kusumi 	RB_HEAD(autofs_node_tree,
102e2950f41STomohiro Kusumi 	    autofs_node)		an_children;
103e2950f41STomohiro Kusumi 	struct autofs_mount		*an_mount;
104e2950f41STomohiro Kusumi 	struct vnode			*an_vnode;
105bfccbb76STomohiro Kusumi 	mtx_t				an_vnode_lock;
106e2950f41STomohiro Kusumi 	bool				an_cached;
107e2950f41STomohiro Kusumi 	bool				an_wildcards;
108e2950f41STomohiro Kusumi 	struct callout			an_callout;
109e2950f41STomohiro Kusumi 	int				an_retries;
110e2950f41STomohiro Kusumi 	struct timespec			an_ctime;
111e2950f41STomohiro Kusumi };
112e2950f41STomohiro Kusumi 
113e2950f41STomohiro Kusumi struct autofs_mount {
114e2950f41STomohiro Kusumi 	struct autofs_node		*am_root;
115bc6139d4STomohiro Kusumi 	mtx_t				am_lock;
116e2950f41STomohiro Kusumi 	char				am_from[MAXPATHLEN];
117e2950f41STomohiro Kusumi 	char				am_on[MAXPATHLEN];
118e2950f41STomohiro Kusumi 	char				am_options[MAXPATHLEN];
119e2950f41STomohiro Kusumi 	char				am_prefix[MAXPATHLEN];
120e2950f41STomohiro Kusumi 	ino_t				am_last_ino;
121e2950f41STomohiro Kusumi };
122e2950f41STomohiro Kusumi 
123e2950f41STomohiro Kusumi struct autofs_request {
124e2950f41STomohiro Kusumi 	TAILQ_ENTRY(autofs_request)	ar_next;
125e2950f41STomohiro Kusumi 	struct autofs_mount		*ar_mount;
126e2950f41STomohiro Kusumi 	int				ar_id;
127e2950f41STomohiro Kusumi 	bool				ar_done;
128e2950f41STomohiro Kusumi 	int				ar_error;
129e2950f41STomohiro Kusumi 	bool				ar_wildcards;
130e2950f41STomohiro Kusumi 	bool				ar_in_progress;
131e2950f41STomohiro Kusumi 	char				ar_from[MAXPATHLEN];
132e2950f41STomohiro Kusumi 	char				ar_path[MAXPATHLEN];
133e2950f41STomohiro Kusumi 	char				ar_prefix[MAXPATHLEN];
134e2950f41STomohiro Kusumi 	char				ar_key[MAXPATHLEN];
135e2950f41STomohiro Kusumi 	char				ar_options[MAXPATHLEN];
136e2950f41STomohiro Kusumi 	struct timeout_task		ar_task;
1370b1d8a0dSTomohiro Kusumi 	volatile unsigned int		ar_refcount;
138e2950f41STomohiro Kusumi };
139e2950f41STomohiro Kusumi 
140e2950f41STomohiro Kusumi struct autofs_softc {
141e2950f41STomohiro Kusumi 	struct cdev			*sc_cdev;
142e2950f41STomohiro Kusumi 	struct cv			sc_cv;
1432137724aSTomohiro Kusumi 	struct mtx			sc_lock;
144e2950f41STomohiro Kusumi 	TAILQ_HEAD(, autofs_request)	sc_requests;
145e2950f41STomohiro Kusumi 	bool				sc_dev_opened;
146e2950f41STomohiro Kusumi 	pid_t				sc_dev_sid;
147e2950f41STomohiro Kusumi 	int				sc_last_request_id;
148e2950f41STomohiro Kusumi };
149e2950f41STomohiro Kusumi 
150e2950f41STomohiro Kusumi int	autofs_trigger(struct autofs_node *anp, const char *component,
151e2950f41STomohiro Kusumi 	    int componentlen);
152e2950f41STomohiro Kusumi bool	autofs_cached(struct autofs_node *anp, const char *component,
153e2950f41STomohiro Kusumi 	    int componentlen);
154e2950f41STomohiro Kusumi char*	autofs_path(struct autofs_node *anp);
155e2950f41STomohiro Kusumi void	autofs_flush(struct autofs_mount *amp);
156e2950f41STomohiro Kusumi bool	autofs_ignore_thread(void);
157e2950f41STomohiro Kusumi int	autofs_node_new(struct autofs_node *parent, struct autofs_mount *amp,
158e2950f41STomohiro Kusumi 	    const char *name, int namelen, struct autofs_node **anpp);
159e2950f41STomohiro Kusumi int	autofs_node_find(struct autofs_node *parent,
160e2950f41STomohiro Kusumi 	    const char *name, int namelen, struct autofs_node **anpp);
161e2950f41STomohiro Kusumi void	autofs_node_delete(struct autofs_node *anp);
162e2950f41STomohiro Kusumi int	autofs_node_vn(struct autofs_node *anp, struct mount *mp,
163e2950f41STomohiro Kusumi 	    int flags, struct vnode **vpp);
164e2950f41STomohiro Kusumi 
165e2950f41STomohiro Kusumi static __inline void
autofs_node_cache(struct autofs_node * anp)166e2950f41STomohiro Kusumi autofs_node_cache(struct autofs_node *anp)
167e2950f41STomohiro Kusumi {
168e2950f41STomohiro Kusumi 	anp->an_cached = true;
169e2950f41STomohiro Kusumi }
170e2950f41STomohiro Kusumi 
171e2950f41STomohiro Kusumi static __inline void
autofs_node_uncache(struct autofs_node * anp)172e2950f41STomohiro Kusumi autofs_node_uncache(struct autofs_node *anp)
173e2950f41STomohiro Kusumi {
174e2950f41STomohiro Kusumi 	anp->an_cached = false;
175e2950f41STomohiro Kusumi }
176e2950f41STomohiro Kusumi 
177e2950f41STomohiro Kusumi RB_PROTOTYPE(autofs_node_tree, autofs_node, an_link, autofs_node_cmp);
178e2950f41STomohiro Kusumi 
179e2950f41STomohiro Kusumi #endif /* !AUTOFS_H */
180