autofs.h revision 274234 
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: stable/10/sys/fs/autofs/autofs.h 274234 2014-11-07 15:44:03Z trasz $
30 */
31
32#ifndef AUTOFS_H
33#define	AUTOFS_H
34
35#define VFSTOAUTOFS(mp)    ((struct autofs_mount *)((mp)->mnt_data))
36
37MALLOC_DECLARE(M_AUTOFS);
38
39extern uma_zone_t autofs_request_zone;
40extern uma_zone_t autofs_node_zone;
41
42extern int autofs_debug;
43extern 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_SLOCK(X)		sx_slock(&X->am_lock)
57#define AUTOFS_XLOCK(X)		sx_xlock(&X->am_lock)
58#define AUTOFS_SUNLOCK(X)	sx_sunlock(&X->am_lock)
59#define AUTOFS_XUNLOCK(X)	sx_xunlock(&X->am_lock)
60#define AUTOFS_ASSERT_LOCKED(X)		sx_assert(&X->am_lock, SA_LOCKED)
61#define AUTOFS_ASSERT_XLOCKED(X)	sx_assert(&X->am_lock, SA_XLOCKED)
62#define AUTOFS_ASSERT_UNLOCKED(X)	sx_assert(&X->am_lock, SA_UNLOCKED)
63
64struct 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
79struct autofs_mount {
80	TAILQ_ENTRY(autofs_mount)	am_next;
81	struct autofs_node		*am_root;
82	struct mount			*am_mp;
83	struct sx			am_lock;
84	char				am_from[MAXPATHLEN];
85	char				am_mountpoint[MAXPATHLEN];
86	char				am_options[MAXPATHLEN];
87	char				am_prefix[MAXPATHLEN];
88	int				am_last_fileno;
89};
90
91struct autofs_request {
92	TAILQ_ENTRY(autofs_request)	ar_next;
93	struct autofs_mount		*ar_mount;
94	int				ar_id;
95	bool				ar_done;
96	int				ar_error;
97	bool				ar_in_progress;
98	char				ar_from[MAXPATHLEN];
99	char				ar_path[MAXPATHLEN];
100	char				ar_prefix[MAXPATHLEN];
101	char				ar_key[MAXPATHLEN];
102	char				ar_options[MAXPATHLEN];
103	struct timeout_task		ar_task;
104	volatile u_int			ar_refcount;
105};
106
107struct autofs_softc {
108	device_t			sc_dev;
109	struct cdev			*sc_cdev;
110	struct cv			sc_cv;
111	struct sx			sc_lock;
112	TAILQ_HEAD(, autofs_request)	sc_requests;
113	bool				sc_dev_opened;
114	pid_t				sc_dev_sid;
115	int				sc_last_request_id;
116};
117
118/*
119 * Limits and constants
120 */
121#define AUTOFS_NAMELEN		24
122#define AUTOFS_FSNAMELEN	16	/* equal to MFSNAMELEN */
123#define AUTOFS_DELEN		(8 + AUTOFS_NAMELEN)
124
125int	autofs_init(struct vfsconf *vfsp);
126int	autofs_uninit(struct vfsconf *vfsp);
127int	autofs_trigger(struct autofs_node *anp, const char *component,
128	    int componentlen);
129bool	autofs_cached(struct autofs_node *anp, const char *component,
130	    int componentlen);
131bool	autofs_ignore_thread(const struct thread *td);
132int	autofs_node_new(struct autofs_node *parent, struct autofs_mount *amp,
133	    const char *name, int namelen, struct autofs_node **anpp);
134int	autofs_node_find(struct autofs_node *parent,
135	    const char *name, int namelen, struct autofs_node **anpp);
136void	autofs_node_delete(struct autofs_node *anp);
137int	autofs_node_vn(struct autofs_node *anp, struct mount *mp,
138	    struct vnode **vpp);
139
140#endif /* !AUTOFS_H */
141