xref: /openbmc/linux/io_uring/filetable.c (revision 6fc19b3d)
1453b329bSJens Axboe // SPDX-License-Identifier: GPL-2.0
2453b329bSJens Axboe #include <linux/kernel.h>
3453b329bSJens Axboe #include <linux/errno.h>
4453b329bSJens Axboe #include <linux/file.h>
5453b329bSJens Axboe #include <linux/mm.h>
6453b329bSJens Axboe #include <linux/slab.h>
7c98817e6SJens Axboe #include <linux/nospec.h>
8453b329bSJens Axboe #include <linux/io_uring.h>
9453b329bSJens Axboe 
10453b329bSJens Axboe #include <uapi/linux/io_uring.h>
11453b329bSJens Axboe 
12453b329bSJens Axboe #include "io_uring.h"
13c98817e6SJens Axboe #include "rsrc.h"
14c98817e6SJens Axboe #include "filetable.h"
15453b329bSJens Axboe 
io_file_bitmap_get(struct io_ring_ctx * ctx)16c98817e6SJens Axboe static int io_file_bitmap_get(struct io_ring_ctx *ctx)
17453b329bSJens Axboe {
18453b329bSJens Axboe 	struct io_file_table *table = &ctx->file_table;
196e73dffbSPavel Begunkov 	unsigned long nr = ctx->file_alloc_end;
20453b329bSJens Axboe 	int ret;
21453b329bSJens Axboe 
2202a4d923SSavino Dicanosa 	if (!table->bitmap)
2302a4d923SSavino Dicanosa 		return -ENFILE;
2402a4d923SSavino Dicanosa 
25453b329bSJens Axboe 	do {
26453b329bSJens Axboe 		ret = find_next_zero_bit(table->bitmap, nr, table->alloc_hint);
27453b329bSJens Axboe 		if (ret != nr)
28453b329bSJens Axboe 			return ret;
29453b329bSJens Axboe 
306e73dffbSPavel Begunkov 		if (table->alloc_hint == ctx->file_alloc_start)
31453b329bSJens Axboe 			break;
32453b329bSJens Axboe 		nr = table->alloc_hint;
336e73dffbSPavel Begunkov 		table->alloc_hint = ctx->file_alloc_start;
34453b329bSJens Axboe 	} while (1);
35453b329bSJens Axboe 
36453b329bSJens Axboe 	return -ENFILE;
37453b329bSJens Axboe }
38453b329bSJens Axboe 
io_alloc_file_tables(struct io_file_table * table,unsigned nr_files)39453b329bSJens Axboe bool io_alloc_file_tables(struct io_file_table *table, unsigned nr_files)
40453b329bSJens Axboe {
41453b329bSJens Axboe 	table->files = kvcalloc(nr_files, sizeof(table->files[0]),
42453b329bSJens Axboe 				GFP_KERNEL_ACCOUNT);
43453b329bSJens Axboe 	if (unlikely(!table->files))
44453b329bSJens Axboe 		return false;
45453b329bSJens Axboe 
46453b329bSJens Axboe 	table->bitmap = bitmap_zalloc(nr_files, GFP_KERNEL_ACCOUNT);
47453b329bSJens Axboe 	if (unlikely(!table->bitmap)) {
48453b329bSJens Axboe 		kvfree(table->files);
49453b329bSJens Axboe 		return false;
50453b329bSJens Axboe 	}
51453b329bSJens Axboe 
52453b329bSJens Axboe 	return true;
53453b329bSJens Axboe }
54453b329bSJens Axboe 
io_free_file_tables(struct io_file_table * table)55453b329bSJens Axboe void io_free_file_tables(struct io_file_table *table)
56453b329bSJens Axboe {
57453b329bSJens Axboe 	kvfree(table->files);
58453b329bSJens Axboe 	bitmap_free(table->bitmap);
59453b329bSJens Axboe 	table->files = NULL;
60453b329bSJens Axboe 	table->bitmap = NULL;
61453b329bSJens Axboe }
62c98817e6SJens Axboe 
io_install_fixed_file(struct io_ring_ctx * ctx,struct file * file,u32 slot_index)63f110ed84SJens Axboe static int io_install_fixed_file(struct io_ring_ctx *ctx, struct file *file,
64f110ed84SJens Axboe 				 u32 slot_index)
65c98817e6SJens Axboe 	__must_hold(&req->ctx->uring_lock)
66c98817e6SJens Axboe {
67c98817e6SJens Axboe 	struct io_fixed_file *file_slot;
68c98817e6SJens Axboe 	int ret;
69c98817e6SJens Axboe 
70c98817e6SJens Axboe 	if (io_is_uring_fops(file))
71c98817e6SJens Axboe 		return -EBADF;
72c98817e6SJens Axboe 	if (!ctx->file_data)
73c98817e6SJens Axboe 		return -ENXIO;
74c98817e6SJens Axboe 	if (slot_index >= ctx->nr_user_files)
75c98817e6SJens Axboe 		return -EINVAL;
76c98817e6SJens Axboe 
77c98817e6SJens Axboe 	slot_index = array_index_nospec(slot_index, ctx->nr_user_files);
78c98817e6SJens Axboe 	file_slot = io_fixed_file_slot(&ctx->file_table, slot_index);
79c98817e6SJens Axboe 
80c98817e6SJens Axboe 	if (file_slot->file_ptr) {
814bfb0c9aSChristoph Hellwig 		ret = io_queue_rsrc_removal(ctx->file_data, slot_index,
824bfb0c9aSChristoph Hellwig 					    io_slot_file(file_slot));
83c98817e6SJens Axboe 		if (ret)
84c87fd583SPavel Begunkov 			return ret;
85c87fd583SPavel Begunkov 
86c98817e6SJens Axboe 		file_slot->file_ptr = 0;
87c98817e6SJens Axboe 		io_file_bitmap_clear(&ctx->file_table, slot_index);
88c98817e6SJens Axboe 	}
89c98817e6SJens Axboe 
90c98817e6SJens Axboe 	*io_get_tag_slot(ctx->file_data, slot_index) = 0;
91c98817e6SJens Axboe 	io_fixed_file_set(file_slot, file);
92c98817e6SJens Axboe 	io_file_bitmap_set(&ctx->file_table, slot_index);
93*6fc19b3dSJens Axboe 	return 0;
94c98817e6SJens Axboe }
95c98817e6SJens Axboe 
__io_fixed_fd_install(struct io_ring_ctx * ctx,struct file * file,unsigned int file_slot)96f110ed84SJens Axboe int __io_fixed_fd_install(struct io_ring_ctx *ctx, struct file *file,
97f110ed84SJens Axboe 			  unsigned int file_slot)
98f110ed84SJens Axboe {
99f110ed84SJens Axboe 	bool alloc_slot = file_slot == IORING_FILE_INDEX_ALLOC;
100f110ed84SJens Axboe 	int ret;
101f110ed84SJens Axboe 
102f110ed84SJens Axboe 	if (alloc_slot) {
103f110ed84SJens Axboe 		ret = io_file_bitmap_get(ctx);
104f110ed84SJens Axboe 		if (unlikely(ret < 0))
105f110ed84SJens Axboe 			return ret;
106f110ed84SJens Axboe 		file_slot = ret;
107f110ed84SJens Axboe 	} else {
108f110ed84SJens Axboe 		file_slot--;
109f110ed84SJens Axboe 	}
110f110ed84SJens Axboe 
111f110ed84SJens Axboe 	ret = io_install_fixed_file(ctx, file, file_slot);
112f110ed84SJens Axboe 	if (!ret && alloc_slot)
113f110ed84SJens Axboe 		ret = file_slot;
114f110ed84SJens Axboe 	return ret;
115f110ed84SJens Axboe }
116c98817e6SJens Axboe /*
117c98817e6SJens Axboe  * Note when io_fixed_fd_install() returns error value, it will ensure
118c98817e6SJens Axboe  * fput() is called correspondingly.
119c98817e6SJens Axboe  */
io_fixed_fd_install(struct io_kiocb * req,unsigned int issue_flags,struct file * file,unsigned int file_slot)120c98817e6SJens Axboe int io_fixed_fd_install(struct io_kiocb *req, unsigned int issue_flags,
121c98817e6SJens Axboe 			struct file *file, unsigned int file_slot)
122c98817e6SJens Axboe {
123c98817e6SJens Axboe 	struct io_ring_ctx *ctx = req->ctx;
124c98817e6SJens Axboe 	int ret;
125c98817e6SJens Axboe 
126c98817e6SJens Axboe 	io_ring_submit_lock(ctx, issue_flags);
127f110ed84SJens Axboe 	ret = __io_fixed_fd_install(ctx, file, file_slot);
128c98817e6SJens Axboe 	io_ring_submit_unlock(ctx, issue_flags);
129f110ed84SJens Axboe 
130c98817e6SJens Axboe 	if (unlikely(ret < 0))
131c98817e6SJens Axboe 		fput(file);
132c98817e6SJens Axboe 	return ret;
133c98817e6SJens Axboe }
134f110ed84SJens Axboe 
io_fixed_fd_remove(struct io_ring_ctx * ctx,unsigned int offset)135f110ed84SJens Axboe int io_fixed_fd_remove(struct io_ring_ctx *ctx, unsigned int offset)
136f110ed84SJens Axboe {
137f110ed84SJens Axboe 	struct io_fixed_file *file_slot;
138f110ed84SJens Axboe 	int ret;
139f110ed84SJens Axboe 
140f110ed84SJens Axboe 	if (unlikely(!ctx->file_data))
141f110ed84SJens Axboe 		return -ENXIO;
142f110ed84SJens Axboe 	if (offset >= ctx->nr_user_files)
143f110ed84SJens Axboe 		return -EINVAL;
144f110ed84SJens Axboe 
145f110ed84SJens Axboe 	offset = array_index_nospec(offset, ctx->nr_user_files);
146f110ed84SJens Axboe 	file_slot = io_fixed_file_slot(&ctx->file_table, offset);
147f110ed84SJens Axboe 	if (!file_slot->file_ptr)
148f110ed84SJens Axboe 		return -EBADF;
149f110ed84SJens Axboe 
1504bfb0c9aSChristoph Hellwig 	ret = io_queue_rsrc_removal(ctx->file_data, offset,
1514bfb0c9aSChristoph Hellwig 				    io_slot_file(file_slot));
152f110ed84SJens Axboe 	if (ret)
153f110ed84SJens Axboe 		return ret;
154f110ed84SJens Axboe 
155f110ed84SJens Axboe 	file_slot->file_ptr = 0;
156f110ed84SJens Axboe 	io_file_bitmap_clear(&ctx->file_table, offset);
157f110ed84SJens Axboe 	return 0;
158f110ed84SJens Axboe }
1596e73dffbSPavel Begunkov 
io_register_file_alloc_range(struct io_ring_ctx * ctx,struct io_uring_file_index_range __user * arg)1606e73dffbSPavel Begunkov int io_register_file_alloc_range(struct io_ring_ctx *ctx,
1616e73dffbSPavel Begunkov 				 struct io_uring_file_index_range __user *arg)
1626e73dffbSPavel Begunkov {
1636e73dffbSPavel Begunkov 	struct io_uring_file_index_range range;
1646e73dffbSPavel Begunkov 	u32 end;
1656e73dffbSPavel Begunkov 
1666e73dffbSPavel Begunkov 	if (copy_from_user(&range, arg, sizeof(range)))
1676e73dffbSPavel Begunkov 		return -EFAULT;
1686e73dffbSPavel Begunkov 	if (check_add_overflow(range.off, range.len, &end))
1696e73dffbSPavel Begunkov 		return -EOVERFLOW;
1706e73dffbSPavel Begunkov 	if (range.resv || end > ctx->nr_user_files)
1716e73dffbSPavel Begunkov 		return -EINVAL;
1726e73dffbSPavel Begunkov 
1736e73dffbSPavel Begunkov 	io_file_table_set_alloc_range(ctx, range.off, range.len);
1746e73dffbSPavel Begunkov 	return 0;
1756e73dffbSPavel Begunkov }
176