xref: /netbsd-src/sys/compat/linux/common/linux_fcntl.h (revision 8e33eff89e26cf71871ead62f0d5063e1313c33a)
1 /*	$NetBSD: linux_fcntl.h,v 1.22 2023/08/19 17:57:54 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 1995, 1998 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Frank van der Linden and Eric Haszlakiewicz.
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 NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #ifndef _LINUX_FCNTL_H
33 #define _LINUX_FCNTL_H
34 
35 #ifdef _KERNEL
36 #include <compat/linux/common/linux_types.h> /* For linux_off_t */
37 struct stat;
38 #endif
39 
40 /*
41  * The arguments in the flock structure have a different order from the
42  * BSD structure.
43  */
44 
45 /* read/write mode for open(2) */
46 #define	LINUX_O_RDONLY		0x0000
47 #define LINUX_O_WRONLY		0x0001
48 #define LINUX_O_RDWR		0x0002
49 #define LINUX_O_ACCMODE		0x0003
50 
51 #define LINUX_AT_FDCWD			-100
52 #define LINUX_AT_SYMLINK_NOFOLLOW	0x0100
53 #define LINUX_AT_REMOVEDIR		0x0200
54 #define LINUX_AT_SYMLINK_FOLLOW		0x0400
55 #define LINUX_AT_NO_AUTOMOUNT		0x0800
56 #define LINUX_AT_EMPTY_PATH		0x1000
57 
58 #ifdef _KERNEL
59 int linux_to_bsd_ioflags(int);
60 int linux_to_bsd_atflags(int);
61 int bsd_to_linux_statx(struct stat *, struct linux_statx *, unsigned int);
62 int linux_statat(struct lwp *, int, const char *, int, struct stat *);
63 
64 struct linux_flock {
65 	short       l_type;
66 	short       l_whence;
67 	linux_off_t l_start;
68 	linux_off_t l_len;
69 	linux_pid_t l_pid;
70 };
71 
72 struct linux_flock64 {
73 	short       l_type;
74 	short       l_whence;
75 	off_t	    l_start;
76 	off_t	    l_len;
77 	linux_pid_t l_pid;
78 };
79 #endif /* _KERNEL */
80 
81 #if defined(__i386__)
82 #include <compat/linux/arch/i386/linux_fcntl.h>
83 #elif defined(__m68k__)
84 #include <compat/linux/arch/m68k/linux_fcntl.h>
85 #elif defined(__alpha__)
86 #include <compat/linux/arch/alpha/linux_fcntl.h>
87 #elif defined(__powerpc__)
88 #include <compat/linux/arch/powerpc/linux_fcntl.h>
89 #elif defined(__mips__)
90 #include <compat/linux/arch/mips/linux_fcntl.h>
91 #elif defined(__aarch64__)
92 #include <compat/linux/arch/aarch64/linux_fcntl.h>
93 #elif defined(__arm__)
94 #include <compat/linux/arch/arm/linux_fcntl.h>
95 #elif defined(__amd64__)
96 #include <compat/linux/arch/amd64/linux_fcntl.h>
97 #else
98 #error Undefined linux_fcntl.h machine type.
99 #endif
100 
101 /* Linux specific fcntl(2) commands */
102 #define	LINUX_F_SPECIFIC_BASE 	1024
103 #define	LINUX_F_SETLEASE 	(LINUX_F_SPECIFIC_BASE + 0)
104 #define	LINUX_F_GETLEASE 	(LINUX_F_SPECIFIC_BASE + 1)
105 #define	LINUX_F_NOTIFY 		(LINUX_F_SPECIFIC_BASE + 2)
106 #define	LINUX_F_CANCELLK 	(LINUX_F_SPECIFIC_BASE + 5)
107 #define	LINUX_F_DUPFD_CLOEXEC 	(LINUX_F_SPECIFIC_BASE + 6)
108 #define	LINUX_F_SETPIPE_SZ 	(LINUX_F_SPECIFIC_BASE + 7)
109 #define	LINUX_F_GETPIPE_SZ 	(LINUX_F_SPECIFIC_BASE + 8)
110 #define	LINUX_F_ADD_SEALS	(LINUX_F_SPECIFIC_BASE + 9)
111 #define	LINUX_F_GET_SEALS	(LINUX_F_SPECIFIC_BASE + 10)
112 
113 #ifdef _KERNEL
114 /*
115  * We have to have 4 copies of the code that converts linux fcntl() file
116  * locking to native form because there are 4 layouts for the structures.
117  * To avoid replicating code, these defines are used.
118  *
119  * The next two functions take care of converting the flock
120  * structure back and forth between Linux and NetBSD format.
121  * The only difference in the structures is the order and size of
122  * the fields, and the 'whence' value.
123  */
124 
125 #define conv_linux_flock(LINUX, FLOCK) \
126 static void \
127 bsd_to_##LINUX##_##FLOCK(struct LINUX##_##FLOCK *lfp, const struct flock *bfp) \
128 	copy_flock(lfp, LINUX_F, bfp, F) \
129 \
130 static void \
131 LINUX##_to_bsd_##FLOCK(struct flock *bfp, const struct LINUX##_##FLOCK *lfp) \
132 	copy_flock(bfp, F, lfp, LINUX_F)
133 
134 #define copy_flock(dst, dst_f, src, src_f) { \
135 	dst->l_start = src->l_start; \
136 	dst->l_len = src->l_len; \
137 	dst->l_pid = src->l_pid; \
138 	dst->l_whence = src->l_whence; \
139 	switch (src->l_type) { \
140 	case src_f##_RDLCK: \
141 		dst->l_type = dst_f##_RDLCK; \
142 		break; \
143 	case src_f##_UNLCK: \
144 		dst->l_type = dst_f##_UNLCK; \
145 		break; \
146 	case src_f##_WRLCK: \
147 		dst->l_type = dst_f##_WRLCK; \
148 		break; \
149 	default: \
150 		dst->l_type = -1; \
151 		break; \
152 	} \
153     }
154 
155 /*
156  * These two defines do the work within the sys_fcntl() switch statement.
157  */
158 
159 #define do_linux_getlk(fd, cmd, arg, LINUX, FLOCK) do { \
160 	struct LINUX##_##FLOCK lfl; \
161 	struct flock bfl; \
162 	int fl_error; \
163 	if ((fl_error = copyin(arg, &lfl, sizeof lfl))) \
164 		return fl_error; \
165 	LINUX##_to_bsd_##FLOCK(&bfl, &lfl); \
166 	fl_error = do_fcntl_lock(fd, F_GETLK, &bfl); \
167 	if (fl_error) \
168 		return fl_error; \
169 	bsd_to_##LINUX##_##FLOCK(&lfl, &bfl); \
170 	return copyout(&lfl, arg, sizeof lfl); \
171     } while (0)
172 
173 #define do_linux_setlk(fd, cmd, arg, LINUX, FLOCK, setlk) do { \
174 	struct LINUX##_##FLOCK lfl; \
175 	struct flock bfl; \
176 	int fl_error; \
177 	if ((fl_error = copyin(arg, &lfl, sizeof lfl))) \
178 		return fl_error; \
179 	LINUX##_to_bsd_##FLOCK(&bfl, &lfl); \
180 	return do_fcntl_lock(fd, cmd == setlk ? F_SETLK : F_SETLKW, &bfl); \
181     } while (0)
182 #endif /* _KERNEL */
183 
184 #endif /* !_LINUX_FCNTL_H */
185