Home | History | Annotate | Line # | Download | only in common
      1 /*	$NetBSD: linux_fcntl.h,v 1.23 2024/09/28 19:35:56 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 
     59 /*
     60  * sync_file_range flags
     61  */
     62 #define	LINUX_SYNC_FILE_RANGE_WAIT_BEFORE	1
     63 #define	LINUX_SYNC_FILE_RANGE_WRITE		2
     64 #define	LINUX_SYNC_FILE_RANGE_WAIT_AFTER	4
     65 #define	LINUX_SYNC_FILE_RANGE_ALL	\
     66     (LINUX_SYNC_FILE_RANGE_WAIT_BEFORE | \
     67     LINUX_SYNC_FILE_RANGE_WRITE	| \
     68     LINUX_SYNC_FILE_RANGE_WAIT_AFTER)
     69 
     70 /*
     71  * renameat2 flags
     72  */
     73 #define	LINUX_RENAME_NOREPLACE	1
     74 #define	LINUX_RENAME_EXCHANGE	2
     75 #define	LINUX_RENAME_WHITEOUT	4
     76 #define	LINUX_RENAME_ALL \
     77     (LINUX_RENAME_NOREPLACE | \
     78     LINUX_RENAME_EXCHANGE | \
     79     LINUX_RENAME_WHITEOUT)
     80 
     81 #ifdef _KERNEL
     82 int linux_to_bsd_ioflags(int);
     83 int linux_to_bsd_atflags(int);
     84 int bsd_to_linux_statx(struct stat *, struct linux_statx *, unsigned int);
     85 int linux_statat(struct lwp *, int, const char *, int, struct stat *);
     86 
     87 struct linux_flock {
     88 	short       l_type;
     89 	short       l_whence;
     90 	linux_off_t l_start;
     91 	linux_off_t l_len;
     92 	linux_pid_t l_pid;
     93 };
     94 
     95 struct linux_flock64 {
     96 	short       l_type;
     97 	short       l_whence;
     98 	off_t	    l_start;
     99 	off_t	    l_len;
    100 	linux_pid_t l_pid;
    101 };
    102 #endif /* _KERNEL */
    103 
    104 #if defined(__i386__)
    105 #include <compat/linux/arch/i386/linux_fcntl.h>
    106 #elif defined(__m68k__)
    107 #include <compat/linux/arch/m68k/linux_fcntl.h>
    108 #elif defined(__alpha__)
    109 #include <compat/linux/arch/alpha/linux_fcntl.h>
    110 #elif defined(__powerpc__)
    111 #include <compat/linux/arch/powerpc/linux_fcntl.h>
    112 #elif defined(__mips__)
    113 #include <compat/linux/arch/mips/linux_fcntl.h>
    114 #elif defined(__aarch64__)
    115 #include <compat/linux/arch/aarch64/linux_fcntl.h>
    116 #elif defined(__arm__)
    117 #include <compat/linux/arch/arm/linux_fcntl.h>
    118 #elif defined(__amd64__)
    119 #include <compat/linux/arch/amd64/linux_fcntl.h>
    120 #else
    121 #error Undefined linux_fcntl.h machine type.
    122 #endif
    123 
    124 /* Linux specific fcntl(2) commands */
    125 #define	LINUX_F_SPECIFIC_BASE 	1024
    126 #define	LINUX_F_SETLEASE 	(LINUX_F_SPECIFIC_BASE + 0)
    127 #define	LINUX_F_GETLEASE 	(LINUX_F_SPECIFIC_BASE + 1)
    128 #define	LINUX_F_NOTIFY 		(LINUX_F_SPECIFIC_BASE + 2)
    129 #define	LINUX_F_CANCELLK 	(LINUX_F_SPECIFIC_BASE + 5)
    130 #define	LINUX_F_DUPFD_CLOEXEC 	(LINUX_F_SPECIFIC_BASE + 6)
    131 #define	LINUX_F_SETPIPE_SZ 	(LINUX_F_SPECIFIC_BASE + 7)
    132 #define	LINUX_F_GETPIPE_SZ 	(LINUX_F_SPECIFIC_BASE + 8)
    133 #define	LINUX_F_ADD_SEALS	(LINUX_F_SPECIFIC_BASE + 9)
    134 #define	LINUX_F_GET_SEALS	(LINUX_F_SPECIFIC_BASE + 10)
    135 
    136 #ifdef _KERNEL
    137 /*
    138  * We have to have 4 copies of the code that converts linux fcntl() file
    139  * locking to native form because there are 4 layouts for the structures.
    140  * To avoid replicating code, these defines are used.
    141  *
    142  * The next two functions take care of converting the flock
    143  * structure back and forth between Linux and NetBSD format.
    144  * The only difference in the structures is the order and size of
    145  * the fields, and the 'whence' value.
    146  */
    147 
    148 #define conv_linux_flock(LINUX, FLOCK) \
    149 static void \
    150 bsd_to_##LINUX##_##FLOCK(struct LINUX##_##FLOCK *lfp, const struct flock *bfp) \
    151 	copy_flock(lfp, LINUX_F, bfp, F) \
    152 \
    153 static void \
    154 LINUX##_to_bsd_##FLOCK(struct flock *bfp, const struct LINUX##_##FLOCK *lfp) \
    155 	copy_flock(bfp, F, lfp, LINUX_F)
    156 
    157 #define copy_flock(dst, dst_f, src, src_f) { \
    158 	dst->l_start = src->l_start; \
    159 	dst->l_len = src->l_len; \
    160 	dst->l_pid = src->l_pid; \
    161 	dst->l_whence = src->l_whence; \
    162 	switch (src->l_type) { \
    163 	case src_f##_RDLCK: \
    164 		dst->l_type = dst_f##_RDLCK; \
    165 		break; \
    166 	case src_f##_UNLCK: \
    167 		dst->l_type = dst_f##_UNLCK; \
    168 		break; \
    169 	case src_f##_WRLCK: \
    170 		dst->l_type = dst_f##_WRLCK; \
    171 		break; \
    172 	default: \
    173 		dst->l_type = -1; \
    174 		break; \
    175 	} \
    176     }
    177 
    178 /*
    179  * These two defines do the work within the sys_fcntl() switch statement.
    180  */
    181 
    182 #define do_linux_getlk(fd, cmd, arg, LINUX, FLOCK) do { \
    183 	struct LINUX##_##FLOCK lfl; \
    184 	struct flock bfl; \
    185 	int fl_error; \
    186 	if ((fl_error = copyin(arg, &lfl, sizeof lfl))) \
    187 		return fl_error; \
    188 	LINUX##_to_bsd_##FLOCK(&bfl, &lfl); \
    189 	fl_error = do_fcntl_lock(fd, F_GETLK, &bfl); \
    190 	if (fl_error) \
    191 		return fl_error; \
    192 	bsd_to_##LINUX##_##FLOCK(&lfl, &bfl); \
    193 	return copyout(&lfl, arg, sizeof lfl); \
    194     } while (0)
    195 
    196 #define do_linux_setlk(fd, cmd, arg, LINUX, FLOCK, setlk) do { \
    197 	struct LINUX##_##FLOCK lfl; \
    198 	struct flock bfl; \
    199 	int fl_error; \
    200 	if ((fl_error = copyin(arg, &lfl, sizeof lfl))) \
    201 		return fl_error; \
    202 	LINUX##_to_bsd_##FLOCK(&bfl, &lfl); \
    203 	return do_fcntl_lock(fd, cmd == setlk ? F_SETLK : F_SETLKW, &bfl); \
    204     } while (0)
    205 #endif /* _KERNEL */
    206 
    207 #endif /* !_LINUX_FCNTL_H */
    208