1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
|
#include <stdio.h> // 控制台输入输出函数
#include <stdlib.h> // 内存分配函数（malloc/free等）
#include <sys/stat.h> // 文件状态相关（fstat等）
#include <sys/ioctl.h> // 设备控制（ioctl）
#include <sys/syscall.h> // 系统调用封装（syscall）
#include <sys/mman.h> // 内存映射（mmap）
#include <sys/uio.h> // 向量I/O（iovec、readv等）
#include <linux/fs.h> // 文件系统相关定义
#include <fcntl.h> // 文件操作（open、O_RDONLY等）
#include <unistd.h> // 系统调用（close等）
#include <string.h> // 字符串操作（memset等）
// 引入io_uring相关结构定义（内核头文件）
#include <linux/io_uring.h>
// 提交队列（SQ）深度：同时处理的最大请求数
#define QUEUE_DEPTH 1
// 文件读取块大小（1024字节）
#define BLOCK_SZ 1024
// x86架构的内存屏障（确保读写操作顺序，避免编译器优化导致的乱序）
#define read_barrier() __asm__ __volatile__("":::"memory") // 读屏障：确保读操作按顺序可见
#define write_barrier() __asm__ __volatile__("":::"memory") // 写屏障：确保写操作按顺序可见
// 提交队列（SQ）封装结构：存储SQ的关键指针（头、尾、数组等）
struct app_io_sq_ring {
unsigned *head; // SQ头指针（内核更新，指示已处理的条目）
unsigned *tail; // SQ尾指针（用户更新，指示待处理的条目）
unsigned *ring_mask; // SQ掩码（用于计算索引，值为entries-1）
unsigned *ring_entries; // SQ实际条目数
unsigned *flags; // SQ状态标志（如是否需要唤醒内核线程）
unsigned *array; // SQ索引数组（关联SQE与队列位置）
};
// 完成队列（CQ）封装结构：存储CQ的关键指针（头、尾、完成条目等）
struct app_io_cq_ring {
unsigned *head; // CQ头指针（用户更新，指示已处理的完成条目）
unsigned *tail; // CQ尾指针（内核更新，指示新的完成条目）
unsigned *ring_mask; // CQ掩码（用于计算索引）
unsigned *ring_entries; // CQ实际条目数
struct io_uring_cqe *cqes; // 完成队列条目数组（存储每个I/O的结果）
};
// io_uring提交器结构：管理整个io_uring实例的资源
struct submitter {
int ring_fd; // io_uring实例的文件描述符（io_uring_setup返回）
struct app_io_sq_ring sq_ring; // 提交队列（SQ）相关指针
struct io_uring_sqe *sqes; // 提交队列条目数组（SQE）
struct app_io_cq_ring cq_ring; // 完成队列（CQ）相关指针
};
// 文件信息结构：存储文件大小和读取块的iovec数组（柔性数组）
struct file_info {
off_t file_sz; // 文件总大小（字节）
struct iovec iovecs[]; // 柔性数组：每个元素描述一个读取块的缓冲区（地址+长度）
};
/*
* 封装io_uring_setup系统调用（标准库可能未包含）
* 功能：创建io_uring实例，返回文件描述符
* 参数：entries（队列最小条目数）、p（配置参数与内核返回信息）
*/
int io_uring_setup(unsigned entries, struct io_uring_params *p)
{
return (int) syscall(__NR_io_uring_setup, entries, p);
}
/*
* 封装io_uring_enter系统调用
* 功能：提交SQ中的请求并/或等待CQ中的完成事件
* 参数：ring_fd（io_uring实例FD）、to_submit（提交数）、min_complete（最小完成数）、flags（操作标志）
*/
int io_uring_enter(int ring_fd, unsigned int to_submit,
unsigned int min_complete, unsigned int flags)
{
return (int) syscall(__NR_io_uring_enter, ring_fd, to_submit, min_complete,
flags, NULL, 0);
}
/*
* 获取文件大小（支持普通文件和块设备）
* 参数：fd（已打开的文件描述符）
* 返回：文件大小（字节），失败返回-1
*/
off_t get_file_size(int fd) {
struct stat st;
// 先通过fstat获取文件基本信息
if(fstat(fd, &st) < 0) {
perror("fstat failed");
return -1;
}
// 处理块设备（如硬盘分区）：通过ioctl获取大小
if (S_ISBLK(st.st_mode)) {
unsigned long long bytes;
if (ioctl(fd, BLKGETSIZE64, &bytes) != 0) {
perror("ioctl failed");
return -1;
}
return bytes;
}
// 处理普通文件：直接使用st_size
else if (S_ISREG(st.st_mode)) {
return st.st_size;
}
// 不支持的文件类型
return -1;
}
/*
* 初始化io_uring：映射SQ和CQ队列到用户空间，填充submitter结构
* 参数：s（submitter指针，用于存储初始化结果）
* 返回：0成功，1失败
*/
int app_setup_uring(struct submitter *s) {
struct app_io_sq_ring *sring = &s->sq_ring; // 指向SQ结构
struct app_io_cq_ring *cring = &s->cq_ring; // 指向CQ结构
struct io_uring_params p; // io_uring配置参数
void *sq_ptr, *cq_ptr; // 映射SQ和CQ的内存指针
// 初始化参数结构（必须清零）
memset(&p, 0, sizeof(p));
// 调用io_uring_setup创建实例，获取ring_fd
s->ring_fd = io_uring_setup(QUEUE_DEPTH, &p);
if (s->ring_fd < 0) {
perror("io_uring_setup failed");
return 1;
}
// 计算SQ和CQ的映射大小（根据内核返回的偏移量）
// SQ大小：array偏移 + 条目数*每个条目的大小（unsigned）
int sring_sz = p.sq_off.array + p.sq_entries * sizeof(unsigned);
// CQ大小：cqes偏移 + 条目数*每个CQE的大小（struct io_uring_cqe）
int cring_sz = p.cq_off.cqes + p.cq_entries * sizeof(struct io_uring_cqe);
// 检查内核是否支持单映射（IORING_FEAT_SINGLE_MMAP）：5.4+内核支持一次mmap映射SQ和CQ
if (p.features & IORING_FEAT_SINGLE_MMAP) {
// 取较大的大小作为映射大小（确保覆盖SQ和CQ）
if (cring_sz > sring_sz) {
sring_sz = cring_sz;
}
cring_sz = sring_sz; // 单映射时CQ与SQ共享同一内存区域
}
// 映射SQ队列到用户空间（共享内存，可读可写）
sq_ptr = mmap(0, sring_sz, PROT_READ | PROT_WRITE,
MAP_SHARED | MAP_POPULATE, // MAP_POPULATE预加载页，避免后续缺页中断
s->ring_fd, IORING_OFF_SQ_RING); // 偏移量：SQ队列
if (sq_ptr == MAP_FAILED) {
perror("mmap SQ failed");
return 1;
}
// 映射CQ队列：单映射模式下直接使用SQ的映射地址，否则单独映射
if (p.features & IORING_FEAT_SINGLE_MMAP) {
cq_ptr = sq_ptr;
} else {
cq_ptr = mmap(0, cring_sz, PROT_READ | PROT_WRITE,
MAP_SHARED | MAP_POPULATE,
s->ring_fd, IORING_OFF_CQ_RING); // 偏移量：CQ队列
if (cq_ptr == MAP_FAILED) {
perror("mmap CQ failed");
return 1;
}
}
// 填充SQ相关指针（通过内核返回的偏移量计算）
sring->head = sq_ptr + p.sq_off.head; // SQ头指针地址
sring->tail = sq_ptr + p.sq_off.tail; // SQ尾指针地址
sring->ring_mask = sq_ptr + p.sq_off.ring_mask; // SQ掩码地址
sring->ring_entries = sq_ptr + p.sq_off.ring_entries; // SQ条目数地址
sring->flags = sq_ptr + p.sq_off.flags; // SQ标志地址
sring->array = sq_ptr + p.sq_off.array; // SQ索引数组地址
// 映射SQE数组（提交队列条目，每个条目描述一个I/O请求）
s->sqes = mmap(0, p.sq_entries * sizeof(struct io_uring_sqe),
PROT_READ | PROT_WRITE, MAP_SHARED | MAP_POPULATE,
s->ring_fd, IORING_OFF_SQES); // 偏移量：SQE数组
if (s->sqes == MAP_FAILED) {
perror("mmap SQEs failed");
return 1;
}
// 填充CQ相关指针（通过内核返回的偏移量计算）
cring->head = cq_ptr + p.cq_off.head; // CQ头指针地址
cring->tail = cq_ptr + p.cq_off.tail; // CQ尾指针地址
cring->ring_mask = cq_ptr + p.cq_off.ring_mask; // CQ掩码地址
cring->ring_entries = cq_ptr + p.cq_off.ring_entries; // CQ条目数地址
cring->cqes = cq_ptr + p.cq_off.cqes; // CQE数组地址
return 0;
}
/*
* 输出缓冲区内容到控制台（逐个字符）
* 参数：buf（缓冲区地址）、len（长度）
*/
void output_to_console(char *buf, int len) {
while (len--) {
fputc(*buf++, stdout); // 输出当前字符并移动指针
}
}
/*
* 从完成队列（CQ）读取结果并处理
* 功能：检查CQ中是否有完成事件，获取文件数据并输出，更新CQ头指针
* 参数：s（submitter实例，包含CQ信息）
*/
void read_from_cq(struct submitter *s) {
struct file_info *fi; // 指向文件信息（用户数据）
struct app_io_cq_ring *cring = &s->cq_ring; // 指向CQ结构
struct io_uring_cqe *cqe; // 完成队列条目（CQE）
unsigned head, reaped = 0; // CQ头指针当前值
head = *cring->head; // 读取当前CQ头指针（用户已处理到的位置）
do {
read_barrier(); // 读屏障：确保读取头指针后再读取尾指针（避免内核更新未可见）
// 若头指针等于尾指针，说明CQ为空，退出循环
if (head == *cring->tail) {
break;
}
// 获取当前CQE（通过头指针与掩码计算索引）
cqe = &cring->cqes[head & *cring->ring_mask];
// 从CQE中获取用户数据（file_info指针）
fi = (struct file_info*) cqe->user_data;
// 检查I/O是否失败（res为负表示错误）
if (cqe->res < 0) {
fprintf(stderr, "I/O error: %s\n", strerror(abs(cqe->res)));
} else {
// 计算总块数（与提交时一致）
int blocks = (int) fi->file_sz / BLOCK_SZ;
if (fi->file_sz % BLOCK_SZ != 0) {
blocks++;
}
// 输出每个块的内容
for (int i = 0; i < blocks; i++) {
output_to_console(fi->iovecs[i].iov_base, fi->iovecs[i].iov_len);
}
}
// 释放资源（避免内存泄漏）
for (int i = 0; i < blocks; i++) {
free(fi->iovecs[i].iov_base); // 释放每个块的对齐缓冲区
}
free(fi); // 释放file_info（包含iovec数组）
head++; // 移动头指针（标记为已处理）
} while (1); // 循环处理所有可用CQE
// 更新CQ头指针（内核可见）
*cring->head = head;
write_barrier(); // 写屏障：确保头指针更新后再进行其他操作（内核可见）
}
/*
* 提交读取请求到提交队列（SQ）
* 功能：打开文件，分配缓冲区，填充SQE，更新SQ尾指针，触发内核处理
* 参数：file_path（文件路径）、s（submitter实例，包含SQ信息）
* 返回：0成功，1失败
*/
int submit_to_sq(char *file_path, struct submitter *s) {
struct file_info *fi; // 文件信息结构
// 打开文件（只读模式）
int file_fd = open(file_path, O_RDONLY);
if (file_fd < 0 ) {
perror("open failed");
return 1;
}
struct app_io_sq_ring *sring = &s->sq_ring; // 指向SQ结构
unsigned index = 0, current_block = 0, tail = 0, next_tail = 0; // SQ相关索引
// 获取文件大小
off_t file_sz = get_file_size(file_fd);
if (file_sz < 0) {
close(file_fd);
return 1;
}
// 计算总块数（文件大小/BLOCK_SZ，有余数则+1）
off_t bytes_remaining = file_sz;
int blocks = (int) file_sz / BLOCK_SZ;
if (file_sz % BLOCK_SZ != 0) {
blocks++;
}
// 分配file_info结构（包含柔性数组iovecs）
fi = malloc(sizeof(*fi) + sizeof(struct iovec) * blocks);
if (!fi) {
fprintf(stderr, "malloc failed for file_info\n");
close(file_fd);
return 1;
}
fi->file_sz = file_sz; // 记录文件大小
// 为每个块分配对齐的缓冲区，并初始化iovec
while (bytes_remaining > 0) {
off_t bytes_to_read = bytes_remaining;
if (bytes_to_read > BLOCK_SZ) {
bytes_to_read = BLOCK_SZ; // 不超过块大小
}
// 分配对齐的缓冲区（地址对齐到BLOCK_SZ，大小BLOCK_SZ）
void *buf;
if (posix_memalign(&buf, BLOCK_SZ, BLOCK_SZ) != 0) {
perror("posix_memalign failed");
close(file_fd);
return 1;
}
// 初始化当前块的iovec（缓冲区地址和长度）
fi->iovecs[current_block].iov_base = buf;
fi->iovecs[current_block].iov_len = bytes_to_read;
current_block++;
bytes_remaining -= bytes_to_read; // 减少剩余字节数
}
// 计算SQ尾指针的下一个位置（准备添加新请求）
next_tail = tail = *sring->tail; // 读取当前尾指针
next_tail++; // 尾指针+1（新请求的位置）
read_barrier(); // 读屏障：确保尾指针读取后再计算索引
// 计算SQE索引（通过尾指针与掩码取模）
index = tail & *sring->ring_mask;
// 获取当前SQE（提交队列条目）
struct io_uring_sqe *sqe = &s->sqes[index];
// 填充SQE（描述读操作）
sqe->fd = file_fd; // 文件描述符
sqe->flags = 0; // 无特殊标志
sqe->opcode = IORING_OP_READV; // 操作类型：向量读（类似readv）
sqe->addr = (unsigned long) fi->iovecs; // iovec数组地址
sqe->len = blocks; // iovec数组长度（块数）
sqe->off = 0; // 读取偏移量（文件开头）
sqe->user_data = (unsigned long long) fi; // 关联用户数据（file_info）
sring->array[index] = index; // SQ索引数组：关联索引与SQE
tail = next_tail; // 更新尾指针
// 更新SQ尾指针（内核可见）
if (*sring->tail != tail) {
*sring->tail = tail;
write_barrier(); // 写屏障：确保SQE填充后再更新尾指针（内核可见）
}
// 调用io_uring_enter：提交1个请求，等待至少1个完成，标志为等待事件
int ret = io_uring_enter(s->ring_fd, 1, 1, IORING_ENTER_GETEVENTS);
if (ret < 0) {
perror("io_uring_enter failed");
close(file_fd);
return 1;
}
return 0;
}
/*
* 主函数：初始化io_uring，处理输入文件，提交请求并处理结果
*/
int main(int argc, char *argv[]) {
struct submitter *s; // io_uring提交器
// 检查参数（至少需要一个文件名）
if (argc < 2) {
fprintf(stderr, "Usage: %s <filename>\n", argv[0]);
return 1;
}
// 分配并初始化submitter
s = malloc(sizeof(*s));
if (!s) {
perror("malloc failed for submitter");
return 1;
}
memset(s, 0, sizeof(*s)); // 清零初始化
// 初始化io_uring（映射SQ和CQ）
if (app_setup_uring(s)) {
fprintf(stderr, "Failed to setup io_uring!\n");
free(s);
return 1;
}
// 循环处理每个输入文件
for (int i = 1; i < argc; i++) {
// 提交读取请求到SQ
if (submit_to_sq(argv[i], s)) {
fprintf(stderr, "Error reading file: %s\n", argv[i]);
io_uring_queue_exit(s->ring_fd); // 简化处理：实际需关闭FD并释放映射
free(s);
return 1;
}
// 从CQ读取结果并输出
read_from_cq(s);
}
// 清理资源（关闭ring_fd，释放mmap映射等）
close(s->ring_fd);
free(s);
return 0;
}
|