xref: /freebsd/sys/compat/linux/linux_file.h (revision a466cc55373fc3cf86837f09da729535b57e69a1)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2007 Roman Divacky
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _LINUX_FILE_H_
32 #define	_LINUX_FILE_H_
33 
34 #define	LINUX_AT_FDCWD			-100
35 #define	LINUX_AT_SYMLINK_NOFOLLOW	0x100
36 #define	LINUX_AT_EACCESS		0x200
37 #define	LINUX_AT_REMOVEDIR		0x200
38 #define	LINUX_AT_SYMLINK_FOLLOW		0x400
39 #define	LINUX_AT_NO_AUTOMOUNT		0x800
40 		/*
41 		 * Specific to Linux AT_NO_AUTOMOUNT flag tells the kernel to
42 		 * not automount the terminal component of pathname if it is a
43 		 * directory that is an automount point. As FreeBSD does not
44 		 * have such facility (automount), we can simply ignore this flag.
45 		 */
46 #define	LINUX_AT_EMPTY_PATH		0x1000
47 
48 /*
49  * posix_fadvise advice
50  */
51 #define	LINUX_POSIX_FADV_NORMAL		0
52 #define	LINUX_POSIX_FADV_RANDOM		1
53 #define	LINUX_POSIX_FADV_SEQUENTIAL	2
54 #define	LINUX_POSIX_FADV_WILLNEED	3
55 #define	LINUX_POSIX_FADV_DONTNEED	4
56 #define	LINUX_POSIX_FADV_NOREUSE	5
57 
58 /*
59  * mount flags
60  */
61 #define	LINUX_MS_RDONLY		0x0001
62 #define	LINUX_MS_NOSUID		0x0002
63 #define	LINUX_MS_NODEV		0x0004
64 #define	LINUX_MS_NOEXEC		0x0008
65 #define	LINUX_MS_REMOUNT	0x0020
66 
67 /*
68  * umount2 flags
69  */
70 #define	LINUX_MNT_FORCE		0x0001
71 
72 /*
73  * common open/fcntl flags
74  */
75 #define	LINUX_O_RDONLY		000000000
76 #define	LINUX_O_WRONLY		000000001
77 #define	LINUX_O_RDWR		000000002
78 #define	LINUX_O_ACCMODE		000000003
79 #define	LINUX_O_CREAT		000000100
80 #define	LINUX_O_EXCL		000000200
81 #define	LINUX_O_NOCTTY		000000400
82 #define	LINUX_O_TRUNC		000001000
83 #define	LINUX_O_APPEND		000002000
84 #define	LINUX_O_NONBLOCK	000004000
85 #define	LINUX_O_NDELAY		LINUX_O_NONBLOCK
86 #define	LINUX_O_SYNC		000010000
87 #define	LINUX_O_ASYNC		000020000
88 #ifndef LINUX_O_DIRECT
89 #define	LINUX_O_DIRECT		000040000	/* Direct disk access hint */
90 #endif
91 #ifndef LINUX_O_LARGEFILE
92 #define	LINUX_O_LARGEFILE	000100000
93 #endif
94 #ifndef LINUX_O_DIRECTORY
95 #define	LINUX_O_DIRECTORY	000200000	/* Must be a directory */
96 #endif
97 #ifndef LINUX_O_NOFOLLOW
98 #define	LINUX_O_NOFOLLOW	000400000	/* Do not follow links */
99 #endif
100 #define	LINUX_O_NOATIME		001000000
101 #define	LINUX_O_CLOEXEC		002000000
102 #define	LINUX_O_PATH		010000000
103 
104 #define	LINUX_F_DUPFD		0
105 #define	LINUX_F_GETFD		1
106 #define	LINUX_F_SETFD		2
107 #define	LINUX_F_GETFL		3
108 #define	LINUX_F_SETFL		4
109 #ifndef LINUX_F_GETLK
110 #define	LINUX_F_GETLK		5
111 #define	LINUX_F_SETLK		6
112 #define	LINUX_F_SETLKW		7
113 #endif
114 #ifndef LINUX_F_SETOWN
115 #define	LINUX_F_SETOWN		8
116 #define	LINUX_F_GETOWN		9
117 #endif
118 #ifndef LINUX_F_SETSIG
119 #define	LINUX_F_SETSIG		10
120 #define	LINUX_F_GETSIG		11
121 #endif
122 #ifndef LINUX_F_SETOWN_EX
123 #define	LINUX_F_SETOWN_EX	15
124 #define	LINUX_F_GETOWN_EX	16
125 #define	LINUX_F_GETOWNER_UIDS	17
126 #endif
127 
128 #define	LINUX_F_SPECIFIC_BASE	1024
129 
130 #define	LINUX_F_SETLEASE	(LINUX_F_SPECIFIC_BASE + 0)
131 #define	LINUX_F_GETLEASE	(LINUX_F_SPECIFIC_BASE + 1)
132 #define	LINUX_F_CANCELLK	(LINUX_F_SPECIFIC_BASE + 5)
133 #define	LINUX_F_DUPFD_CLOEXEC	(LINUX_F_SPECIFIC_BASE + 6)
134 #define	LINUX_F_NOTIFY		(LINUX_F_SPECIFIC_BASE + 2)
135 #define	LINUX_F_SETPIPE_SZ	(LINUX_F_SPECIFIC_BASE + 7)
136 #define	LINUX_F_GETPIPE_SZ	(LINUX_F_SPECIFIC_BASE + 8)
137 
138 #define	LINUX_F_ADD_SEALS	(LINUX_F_SPECIFIC_BASE + 9)
139 #define	LINUX_F_GET_SEALS	(LINUX_F_SPECIFIC_BASE + 10)
140 
141 #define	LINUX_F_GETLKP		36
142 #define	LINUX_F_SETLKP		37
143 #define	LINUX_F_SETLKPW		38
144 
145 #define	LINUX_F_OWNER_TID	0
146 #define	LINUX_F_OWNER_PID	1
147 #define	LINUX_F_OWNER_PGRP	2
148 
149 #ifndef LINUX_F_RDLCK
150 #define	LINUX_F_RDLCK		0
151 #define	LINUX_F_WRLCK		1
152 #define	LINUX_F_UNLCK		2
153 #endif
154 
155 /*
156  * renameat2 flags
157  */
158 #define	LINUX_RENAME_NOREPLACE	0x00000001
159 #define	LINUX_RENAME_EXCHANGE	0x00000002
160 #define	LINUX_RENAME_WHITEOUT	0x00000004
161 
162 /*
163  * sync_file_range flags
164  */
165 #define	LINUX_SYNC_FILE_RANGE_WAIT_BEFORE	1
166 #define	LINUX_SYNC_FILE_RANGE_WRITE		2
167 #define	LINUX_SYNC_FILE_RANGE_WAIT_AFTER	4
168 
169 #define	LINUX_F_SEAL_SEAL	0x0001
170 #define	LINUX_F_SEAL_SHRINK	0x0002
171 #define	LINUX_F_SEAL_GROW	0x0004
172 #define	LINUX_F_SEAL_WRITE	0x0008
173 
174 #define	LINUX_MFD_CLOEXEC	0x0001
175 #define	LINUX_MFD_ALLOW_SEALING	0x0002
176 #define	LINUX_MFD_HUGETLB	0x0004
177 
178 #define	LINUX_HUGETLB_FLAG_ENCODE_SHIFT	26
179 #define	LINUX_HUGETLB_FLAG_ENCODE_MASK	0x3f
180 
181 #define LINUX_HUGETLB_FLAG_ENCODE_64KB	(16 << LINUX_HUGETLB_FLAG_ENCODE_SHIFT)
182 #define LINUX_HUGETLB_FLAG_ENCODE_512KB	(19 << LINUX_HUGETLB_FLAG_ENCODE_SHIFT)
183 #define LINUX_HUGETLB_FLAG_ENCODE_1MB	(20 << LINUX_HUGETLB_FLAG_ENCODE_SHIFT)
184 #define LINUX_HUGETLB_FLAG_ENCODE_2MB	(21 << LINUX_HUGETLB_FLAG_ENCODE_SHIFT)
185 #define LINUX_HUGETLB_FLAG_ENCODE_8MB	(23 << LINUX_HUGETLB_FLAG_ENCODE_SHIFT)
186 #define LINUX_HUGETLB_FLAG_ENCODE_16MB	(24 << LINUX_HUGETLB_FLAG_ENCODE_SHIFT)
187 #define LINUX_HUGETLB_FLAG_ENCODE_32MB	(25 << LINUX_HUGETLB_FLAG_ENCODE_SHIFT)
188 #define LINUX_HUGETLB_FLAG_ENCODE_256MB	(28 << LINUX_HUGETLB_FLAG_ENCODE_SHIFT)
189 #define LINUX_HUGETLB_FLAG_ENCODE_512MB	(29 << LINUX_HUGETLB_FLAG_ENCODE_SHIFT)
190 #define LINUX_HUGETLB_FLAG_ENCODE_1GB	(30 << LINUX_HUGETLB_FLAG_ENCODE_SHIFT)
191 #define LINUX_HUGETLB_FLAG_ENCODE_2GB	(31 << LINUX_HUGETLB_FLAG_ENCODE_SHIFT)
192 #define LINUX_HUGETLB_FLAG_ENCODE_16GB	(34U << LINUX_HUGETLB_FLAG_ENCODE_SHIFT)
193 
194 struct l_file_handle {
195 	l_uint handle_bytes;
196 	l_int handle_type;
197 	unsigned char f_handle[0];
198 };
199 
200 /*
201  * Look at linux_close_range() for an explanation.
202  *
203  * #define	LINUX_CLOSE_RANGE_UNSHARE	(1U << 1)
204  */
205 #define	LINUX_CLOSE_RANGE_CLOEXEC	(1U << 2)
206 
207 #endif	/* !_LINUX_FILE_H_ */
208