xref: /freebsd/sys/fs/autofs/autofs_ioctl.h (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2013 The FreeBSD Foundation
5  * All rights reserved.
6  *
7  * This software was developed by Edward Tomasz Napierala under sponsorship
8  * from the FreeBSD Foundation.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  * $FreeBSD$
32  */
33 
34 #ifndef AUTOFS_IOCTL_H
35 #define	AUTOFS_IOCTL_H
36 
37 #define	AUTOFS_PATH		"/dev/autofs"
38 
39 struct autofs_daemon_request {
40 	/*
41 	 * Request identifier.
42 	 */
43 	int		adr_id;
44 
45 	/*
46 	 * The "from" field, containing map name.  For example,
47 	 * when accessing '/net/192.168.1.3/tank/vm/', that would
48 	 * be '-hosts'.
49 	 */
50 	char		adr_from[MAXPATHLEN];
51 
52 	/*
53 	 * Full path to the node being looked up; for requests that result
54 	 * in actual mount it is the full mount path.
55 	 */
56 	char		adr_path[MAXPATHLEN];
57 
58 	/*
59 	 * Prefix, which is basically the mountpoint from auto_master(5).
60 	 * In example above that would be "/net"; for direct maps it is "/".
61 	 */
62 	char		adr_prefix[MAXPATHLEN];
63 
64 	/*
65 	 * Map key, also used as command argument for dynamic maps; in example
66 	 * above that would be '192.168.1.3'.
67 	 */
68 	char		adr_key[MAXPATHLEN];
69 
70 	/*
71 	 * Mount options from auto_master(5).
72 	 */
73 	char		adr_options[MAXPATHLEN];
74 };
75 
76 /*
77  * Compatibility with 10.1-RELEASE automountd(8).
78  */
79 struct autofs_daemon_done_101 {
80 	/*
81 	 * Identifier, copied from adr_id.
82 	 */
83 	int		add_id;
84 
85 	/*
86 	 * Error number, possibly returned to userland.
87 	 */
88 	int		add_error;
89 };
90 
91 struct autofs_daemon_done {
92 	/*
93 	 * Identifier, copied from adr_id.
94 	 */
95 	int		add_id;
96 
97 	/*
98 	 * Set to 1 if the map may contain wildcard entries;
99 	 * otherwise autofs will do negative caching.
100 	 */
101 	int		add_wildcards;
102 
103 	/*
104 	 * Error number, possibly returned to userland.
105 	 */
106 	int		add_error;
107 
108 	/*
109 	 * Reserved for future use.
110 	 */
111 	int		add_spare[7];
112 };
113 
114 #define	AUTOFSREQUEST	_IOR('I', 0x01, struct autofs_daemon_request)
115 #define	AUTOFSDONE101	_IOW('I', 0x02, struct autofs_daemon_done_101)
116 #define	AUTOFSDONE	_IOW('I', 0x03, struct autofs_daemon_done)
117 
118 #endif /* !AUTOFS_IOCTL_H */
119