xref: /netbsd-src/sys/compat/linux/common/linux_fcntl.h (revision 4b169a6ba595ae283ca507b26b15fdff40495b1c)
1 /*	$NetBSD: linux_fcntl.h,v 1.21 2023/07/10 02:31:55 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 /*
36  * The arguments in the flock structure have a different order from the
37  * BSD structure.
38  */
39 
40 /* read/write mode for open(2) */
41 #define	LINUX_O_RDONLY		0x0000
42 #define LINUX_O_WRONLY		0x0001
43 #define LINUX_O_RDWR		0x0002
44 #define LINUX_O_ACCMODE		0x0003
45 
46 #define LINUX_AT_FDCWD			-100
47 #define LINUX_AT_SYMLINK_NOFOLLOW	0x0100
48 #define LINUX_AT_REMOVEDIR		0x0200
49 #define LINUX_AT_SYMLINK_FOLLOW		0x0400
50 #define LINUX_AT_NO_AUTOMOUNT		0x0800
51 #define LINUX_AT_EMPTY_PATH		0x1000
52 
53 int linux_to_bsd_ioflags(int);
54 int linux_to_bsd_atflags(int);
55 int bsd_to_linux_statx(struct stat *, struct linux_statx *, unsigned int);
56 int linux_statat(struct lwp *, int, const char *, int, struct stat *);
57 
58 struct linux_flock {
59 	short       l_type;
60 	short       l_whence;
61 	linux_off_t l_start;
62 	linux_off_t l_len;
63 	linux_pid_t l_pid;
64 };
65 
66 struct linux_flock64 {
67 	short       l_type;
68 	short       l_whence;
69 	off_t	    l_start;
70 	off_t	    l_len;
71 	linux_pid_t l_pid;
72 };
73 
74 #if defined(__i386__)
75 #include <compat/linux/arch/i386/linux_fcntl.h>
76 #elif defined(__m68k__)
77 #include <compat/linux/arch/m68k/linux_fcntl.h>
78 #elif defined(__alpha__)
79 #include <compat/linux/arch/alpha/linux_fcntl.h>
80 #elif defined(__powerpc__)
81 #include <compat/linux/arch/powerpc/linux_fcntl.h>
82 #elif defined(__mips__)
83 #include <compat/linux/arch/mips/linux_fcntl.h>
84 #elif defined(__aarch64__)
85 #include <compat/linux/arch/aarch64/linux_fcntl.h>
86 #elif defined(__arm__)
87 #include <compat/linux/arch/arm/linux_fcntl.h>
88 #elif defined(__amd64__)
89 #include <compat/linux/arch/amd64/linux_fcntl.h>
90 #else
91 #error Undefined linux_fcntl.h machine type.
92 #endif
93 
94 /* Linux specific fcntl(2) commands */
95 #define	LINUX_F_SPECIFIC_BASE 	1024
96 #define	LINUX_F_SETLEASE 	(LINUX_F_SPECIFIC_BASE + 0)
97 #define	LINUX_F_GETLEASE 	(LINUX_F_SPECIFIC_BASE + 1)
98 #define	LINUX_F_NOTIFY 		(LINUX_F_SPECIFIC_BASE + 2)
99 #define	LINUX_F_CANCELLK 	(LINUX_F_SPECIFIC_BASE + 5)
100 #define	LINUX_F_DUPFD_CLOEXEC 	(LINUX_F_SPECIFIC_BASE + 6)
101 #define	LINUX_F_SETPIPE_SZ 	(LINUX_F_SPECIFIC_BASE + 7)
102 #define	LINUX_F_GETPIPE_SZ 	(LINUX_F_SPECIFIC_BASE + 8)
103 #define	LINUX_F_ADD_SEALS	(LINUX_F_SPECIFIC_BASE + 9)
104 #define	LINUX_F_GET_SEALS	(LINUX_F_SPECIFIC_BASE + 10)
105 
106 /*
107  * We have to have 4 copies of the code that converts linux fcntl() file
108  * locking to native form because there are 4 layouts for the structures.
109  * To avoid replicating code, these defines are used.
110  *
111  * The next two functions take care of converting the flock
112  * structure back and forth between Linux and NetBSD format.
113  * The only difference in the structures is the order and size of
114  * the fields, and the 'whence' value.
115  */
116 
117 #define conv_linux_flock(LINUX, FLOCK) \
118 static void \
119 bsd_to_##LINUX##_##FLOCK(struct LINUX##_##FLOCK *lfp, const struct flock *bfp) \
120 	copy_flock(lfp, LINUX_F, bfp, F) \
121 \
122 static void \
123 LINUX##_to_bsd_##FLOCK(struct flock *bfp, const struct LINUX##_##FLOCK *lfp) \
124 	copy_flock(bfp, F, lfp, LINUX_F)
125 
126 #define copy_flock(dst, dst_f, src, src_f) { \
127 	dst->l_start = src->l_start; \
128 	dst->l_len = src->l_len; \
129 	dst->l_pid = src->l_pid; \
130 	dst->l_whence = src->l_whence; \
131 	switch (src->l_type) { \
132 	case src_f##_RDLCK: \
133 		dst->l_type = dst_f##_RDLCK; \
134 		break; \
135 	case src_f##_UNLCK: \
136 		dst->l_type = dst_f##_UNLCK; \
137 		break; \
138 	case src_f##_WRLCK: \
139 		dst->l_type = dst_f##_WRLCK; \
140 		break; \
141 	default: \
142 		dst->l_type = -1; \
143 		break; \
144 	} \
145     }
146 
147 /*
148  * These two defines do the work within the sys_fcntl() switch statement.
149  */
150 
151 #define do_linux_getlk(fd, cmd, arg, LINUX, FLOCK) do { \
152 	struct LINUX##_##FLOCK lfl; \
153 	struct flock bfl; \
154 	int fl_error; \
155 	if ((fl_error = copyin(arg, &lfl, sizeof lfl))) \
156 		return fl_error; \
157 	LINUX##_to_bsd_##FLOCK(&bfl, &lfl); \
158 	fl_error = do_fcntl_lock(fd, F_GETLK, &bfl); \
159 	if (fl_error) \
160 		return fl_error; \
161 	bsd_to_##LINUX##_##FLOCK(&lfl, &bfl); \
162 	return copyout(&lfl, arg, sizeof lfl); \
163     } while (0)
164 
165 #define do_linux_setlk(fd, cmd, arg, LINUX, FLOCK, setlk) do { \
166 	struct LINUX##_##FLOCK lfl; \
167 	struct flock bfl; \
168 	int fl_error; \
169 	if ((fl_error = copyin(arg, &lfl, sizeof lfl))) \
170 		return fl_error; \
171 	LINUX##_to_bsd_##FLOCK(&bfl, &lfl); \
172 	return do_fcntl_lock(fd, cmd == setlk ? F_SETLK : F_SETLKW, &bfl); \
173     } while (0)
174 
175 
176 #endif /* !_LINUX_FCNTL_H */
177