xref: /linux-6.15/include/uapi/linux/aio_abi.h (revision ec0c464c)
1 /* include/linux/aio_abi.h
2  *
3  * Copyright 2000,2001,2002 Red Hat.
4  *
5  * Written by Benjamin LaHaise <[email protected]>
6  *
7  * Distribute under the terms of the GPLv2 (see ../../COPYING) or under
8  * the following terms.
9  *
10  * Permission to use, copy, modify, and distribute this software and its
11  * documentation is hereby granted, provided that the above copyright
12  * notice appears in all copies.  This software is provided without any
13  * warranty, express or implied.  Red Hat makes no representations about
14  * the suitability of this software for any purpose.
15  *
16  * IN NO EVENT SHALL RED HAT BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
17  * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF
18  * THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RED HAT HAS BEEN ADVISED
19  * OF THE POSSIBILITY OF SUCH DAMAGE.
20  *
21  * RED HAT DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND
24  * RED HAT HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
25  * ENHANCEMENTS, OR MODIFICATIONS.
26  */
27 #ifndef __LINUX__AIO_ABI_H
28 #define __LINUX__AIO_ABI_H
29 
30 #include <linux/types.h>
31 #include <linux/fs.h>
32 #include <linux/signal.h>
33 #include <asm/byteorder.h>
34 
35 typedef __kernel_ulong_t aio_context_t;
36 
37 enum {
38 	IOCB_CMD_PREAD = 0,
39 	IOCB_CMD_PWRITE = 1,
40 	IOCB_CMD_FSYNC = 2,
41 	IOCB_CMD_FDSYNC = 3,
42 	/* These two are experimental.
43 	 * IOCB_CMD_PREADX = 4,
44 	 * IOCB_CMD_POLL = 5,
45 	 */
46 	IOCB_CMD_NOOP = 6,
47 	IOCB_CMD_PREADV = 7,
48 	IOCB_CMD_PWRITEV = 8,
49 };
50 
51 /*
52  * Valid flags for the "aio_flags" member of the "struct iocb".
53  *
54  * IOCB_FLAG_RESFD - Set if the "aio_resfd" member of the "struct iocb"
55  *                   is valid.
56  */
57 #define IOCB_FLAG_RESFD		(1 << 0)
58 #define IOCB_FLAG_IOPRIO	(1 << 1)
59 
60 /* read() from /dev/aio returns these structures. */
61 struct io_event {
62 	__u64		data;		/* the data field from the iocb */
63 	__u64		obj;		/* what iocb this event came from */
64 	__s64		res;		/* result code for this event */
65 	__s64		res2;		/* secondary result */
66 };
67 
68 /*
69  * we always use a 64bit off_t when communicating
70  * with userland.  its up to libraries to do the
71  * proper padding and aio_error abstraction
72  */
73 
74 struct iocb {
75 	/* these are internal to the kernel/libc. */
76 	__u64	aio_data;	/* data to be returned in event's data */
77 
78 #if defined(__BYTE_ORDER) ? __BYTE_ORDER == __LITTLE_ENDIAN : defined(__LITTLE_ENDIAN)
79 	__u32	aio_key;	/* the kernel sets aio_key to the req # */
80 	__kernel_rwf_t aio_rw_flags;	/* RWF_* flags */
81 #elif defined(__BYTE_ORDER) ? __BYTE_ORDER == __BIG_ENDIAN : defined(__BIG_ENDIAN)
82 	__kernel_rwf_t aio_rw_flags;	/* RWF_* flags */
83 	__u32	aio_key;	/* the kernel sets aio_key to the req # */
84 #else
85 #error edit for your odd byteorder.
86 #endif
87 
88 	/* common fields */
89 	__u16	aio_lio_opcode;	/* see IOCB_CMD_ above */
90 	__s16	aio_reqprio;
91 	__u32	aio_fildes;
92 
93 	__u64	aio_buf;
94 	__u64	aio_nbytes;
95 	__s64	aio_offset;
96 
97 	/* extra parameters */
98 	__u64	aio_reserved2;	/* TODO: use this for a (struct sigevent *) */
99 
100 	/* flags for the "struct iocb" */
101 	__u32	aio_flags;
102 
103 	/*
104 	 * if the IOCB_FLAG_RESFD flag of "aio_flags" is set, this is an
105 	 * eventfd to signal AIO readiness to
106 	 */
107 	__u32	aio_resfd;
108 }; /* 64 bytes */
109 
110 #undef IFBIG
111 #undef IFLITTLE
112 
113 struct __aio_sigset {
114 	const sigset_t __user	*sigmask;
115 	size_t		sigsetsize;
116 };
117 
118 #endif /* __LINUX__AIO_ABI_H */
119 
120