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