io_uring.h 3.1 KB
Newer Older
J
Jens Axboe 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
/*
 * Header file for the io_uring interface.
 *
 * Copyright (C) 2019 Jens Axboe
 * Copyright (C) 2019 Christoph Hellwig
 */
#ifndef LINUX_IO_URING_H
#define LINUX_IO_URING_H

#include <linux/fs.h>
#include <linux/types.h>

/*
 * IO submission data structure (Submission Queue Entry)
 */
struct io_uring_sqe {
	__u8	opcode;		/* type of operation for this sqe */
J
Jens Axboe 已提交
19
	__u8	flags;		/* IOSQE_ flags */
J
Jens Axboe 已提交
20 21 22 23 24 25 26
	__u16	ioprio;		/* ioprio for the request */
	__s32	fd;		/* file descriptor to do IO on */
	__u64	off;		/* offset into file */
	__u64	addr;		/* pointer to buffer or iovecs */
	__u32	len;		/* buffer size or number of iovecs */
	union {
		__kernel_rwf_t	rw_flags;
C
Christoph Hellwig 已提交
27
		__u32		fsync_flags;
28
		__u16		poll_events;
29
		__u32		sync_range_flags;
J
Jens Axboe 已提交
30 31
	};
	__u64	user_data;	/* data to be passed back at completion time */
32 33 34 35
	union {
		__u16	buf_index;	/* index into fixed buffers, if used */
		__u64	__pad2[3];
	};
J
Jens Axboe 已提交
36 37
};

J
Jens Axboe 已提交
38 39 40 41
/*
 * sqe->flags
 */
#define IOSQE_FIXED_FILE	(1U << 0)	/* use fixed fileset */
42
#define IOSQE_IO_DRAIN		(1U << 1)	/* issue after inflight IO */
J
Jens Axboe 已提交
43

J
Jens Axboe 已提交
44 45 46 47
/*
 * io_uring_setup() flags
 */
#define IORING_SETUP_IOPOLL	(1U << 0)	/* io_context is polled */
J
Jens Axboe 已提交
48 49
#define IORING_SETUP_SQPOLL	(1U << 1)	/* SQ poll thread */
#define IORING_SETUP_SQ_AFF	(1U << 2)	/* sq_thread_cpu is valid */
J
Jens Axboe 已提交
50

J
Jens Axboe 已提交
51 52 53
#define IORING_OP_NOP		0
#define IORING_OP_READV		1
#define IORING_OP_WRITEV	2
C
Christoph Hellwig 已提交
54
#define IORING_OP_FSYNC		3
55 56
#define IORING_OP_READ_FIXED	4
#define IORING_OP_WRITE_FIXED	5
57 58
#define IORING_OP_POLL_ADD	6
#define IORING_OP_POLL_REMOVE	7
59
#define IORING_OP_SYNC_FILE_RANGE	8
C
Christoph Hellwig 已提交
60 61 62 63 64

/*
 * sqe->fsync_flags
 */
#define IORING_FSYNC_DATASYNC	(1U << 0)
J
Jens Axboe 已提交
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96

/*
 * IO completion data structure (Completion Queue Entry)
 */
struct io_uring_cqe {
	__u64	user_data;	/* sqe->data submission passed back */
	__s32	res;		/* result code for this event */
	__u32	flags;
};

/*
 * Magic offsets for the application to mmap the data it needs
 */
#define IORING_OFF_SQ_RING		0ULL
#define IORING_OFF_CQ_RING		0x8000000ULL
#define IORING_OFF_SQES			0x10000000ULL

/*
 * Filled with the offset for mmap(2)
 */
struct io_sqring_offsets {
	__u32 head;
	__u32 tail;
	__u32 ring_mask;
	__u32 ring_entries;
	__u32 flags;
	__u32 dropped;
	__u32 array;
	__u32 resv1;
	__u64 resv2;
};

J
Jens Axboe 已提交
97 98 99 100 101
/*
 * sq_ring->flags
 */
#define IORING_SQ_NEED_WAKEUP	(1U << 0) /* needs io_uring_enter wakeup */

J
Jens Axboe 已提交
102 103 104 105 106 107 108 109 110 111 112 113 114 115
struct io_cqring_offsets {
	__u32 head;
	__u32 tail;
	__u32 ring_mask;
	__u32 ring_entries;
	__u32 overflow;
	__u32 cqes;
	__u64 resv[2];
};

/*
 * io_uring_enter(2) flags
 */
#define IORING_ENTER_GETEVENTS	(1U << 0)
J
Jens Axboe 已提交
116
#define IORING_ENTER_SQ_WAKEUP	(1U << 1)
J
Jens Axboe 已提交
117 118 119 120 121 122 123 124

/*
 * Passed in for io_uring_setup(2). Copied back with updated info on success
 */
struct io_uring_params {
	__u32 sq_entries;
	__u32 cq_entries;
	__u32 flags;
J
Jens Axboe 已提交
125 126 127
	__u32 sq_thread_cpu;
	__u32 sq_thread_idle;
	__u32 resv[5];
J
Jens Axboe 已提交
128 129 130 131
	struct io_sqring_offsets sq_off;
	struct io_cqring_offsets cq_off;
};

132 133 134 135 136
/*
 * io_uring_register(2) opcodes and arguments
 */
#define IORING_REGISTER_BUFFERS		0
#define IORING_UNREGISTER_BUFFERS	1
J
Jens Axboe 已提交
137 138
#define IORING_REGISTER_FILES		2
#define IORING_UNREGISTER_FILES		3
139 140
#define IORING_REGISTER_EVENTFD		4
#define IORING_UNREGISTER_EVENTFD	5
141

J
Jens Axboe 已提交
142
#endif