1// SPDX-License-Identifier: GPL-2.0
2#ifndef IOU_RSRC_H
3#define IOU_RSRC_H
4
5#include <net/af_unix.h>
6
7#include "alloc_cache.h"
8
9#define IO_NODE_ALLOC_CACHE_MAX 32
10
11#define IO_RSRC_TAG_TABLE_SHIFT (PAGE_SHIFT - 3)
12#define IO_RSRC_TAG_TABLE_MAX (1U << IO_RSRC_TAG_TABLE_SHIFT)
13#define IO_RSRC_TAG_TABLE_MASK (IO_RSRC_TAG_TABLE_MAX - 1)
14
15enum {
16 IORING_RSRC_FILE = 0,
17 IORING_RSRC_BUFFER = 1,
18};
19
20struct io_rsrc_put {
21 u64 tag;
22 union {
23 void *rsrc;
24 struct file *file;
25 struct io_mapped_ubuf *buf;
26 };
27};
28
29typedef void (rsrc_put_fn)(struct io_ring_ctx *ctx, struct io_rsrc_put *prsrc);
30
31struct io_rsrc_data {
32 struct io_ring_ctx *ctx;
33
34 u64 **tags;
35 unsigned int nr;
36 u16 rsrc_type;
37 bool quiesce;
38};
39
40struct io_rsrc_node {
41 union {
42 struct io_cache_entry cache;
43 struct io_ring_ctx *ctx;
44 };
45 int refs;
46 bool empty;
47 u16 type;
48 struct list_head node;
49 struct io_rsrc_put item;
50};
51
52struct io_mapped_ubuf {
53 u64 ubuf;
54 u64 ubuf_end;
55 unsigned int nr_bvecs;
56 unsigned long acct_pages;
57 struct bio_vec bvec[] __counted_by(nr_bvecs);
58};
59
60void io_rsrc_node_ref_zero(struct io_rsrc_node *node);
61void io_rsrc_node_destroy(struct io_ring_ctx *ctx, struct io_rsrc_node *ref_node);
62struct io_rsrc_node *io_rsrc_node_alloc(struct io_ring_ctx *ctx);
63int io_queue_rsrc_removal(struct io_rsrc_data *data, unsigned idx, void *rsrc);
64
65int io_import_fixed(int ddir, struct iov_iter *iter,
66 struct io_mapped_ubuf *imu,
67 u64 buf_addr, size_t len);
68
69void __io_sqe_buffers_unregister(struct io_ring_ctx *ctx);
70int io_sqe_buffers_unregister(struct io_ring_ctx *ctx);
71int io_sqe_buffers_register(struct io_ring_ctx *ctx, void __user *arg,
72 unsigned int nr_args, u64 __user *tags);
73void __io_sqe_files_unregister(struct io_ring_ctx *ctx);
74int io_sqe_files_unregister(struct io_ring_ctx *ctx);
75int io_sqe_files_register(struct io_ring_ctx *ctx, void __user *arg,
76 unsigned nr_args, u64 __user *tags);
77
78int __io_scm_file_account(struct io_ring_ctx *ctx, struct file *file);
79
80#if defined(CONFIG_UNIX)
81static inline bool io_file_need_scm(struct file *filp)
82{
83 return !!unix_get_socket(filp);
84}
85#else
86static inline bool io_file_need_scm(struct file *filp)
87{
88 return false;
89}
90#endif
91
92static inline int io_scm_file_account(struct io_ring_ctx *ctx,
93 struct file *file)
94{
95 if (likely(!io_file_need_scm(file)))
96 return 0;
97 return __io_scm_file_account(ctx, file);
98}
99
100int io_register_files_update(struct io_ring_ctx *ctx, void __user *arg,
101 unsigned nr_args);
102int io_register_rsrc_update(struct io_ring_ctx *ctx, void __user *arg,
103 unsigned size, unsigned type);
104int io_register_rsrc(struct io_ring_ctx *ctx, void __user *arg,
105 unsigned int size, unsigned int type);
106
107static inline void io_put_rsrc_node(struct io_ring_ctx *ctx, struct io_rsrc_node *node)
108{
109 lockdep_assert_held(&ctx->uring_lock);
110
111 if (node && !--node->refs)
112 io_rsrc_node_ref_zero(node);
113}
114
115static inline void io_req_put_rsrc_locked(struct io_kiocb *req,
116 struct io_ring_ctx *ctx)
117{
118 io_put_rsrc_node(ctx, node: req->rsrc_node);
119}
120
121static inline void io_charge_rsrc_node(struct io_ring_ctx *ctx,
122 struct io_rsrc_node *node)
123{
124 node->refs++;
125}
126
127static inline void io_req_set_rsrc_node(struct io_kiocb *req,
128 struct io_ring_ctx *ctx,
129 unsigned int issue_flags)
130{
131 if (!req->rsrc_node) {
132 io_ring_submit_lock(ctx, issue_flags);
133
134 lockdep_assert_held(&ctx->uring_lock);
135
136 req->rsrc_node = ctx->rsrc_node;
137 io_charge_rsrc_node(ctx, node: ctx->rsrc_node);
138 io_ring_submit_unlock(ctx, issue_flags);
139 }
140}
141
142static inline u64 *io_get_tag_slot(struct io_rsrc_data *data, unsigned int idx)
143{
144 unsigned int off = idx & IO_RSRC_TAG_TABLE_MASK;
145 unsigned int table_idx = idx >> IO_RSRC_TAG_TABLE_SHIFT;
146
147 return &data->tags[table_idx][off];
148}
149
150static inline int io_rsrc_init(struct io_ring_ctx *ctx)
151{
152 ctx->rsrc_node = io_rsrc_node_alloc(ctx);
153 return ctx->rsrc_node ? 0 : -ENOMEM;
154}
155
156int io_files_update(struct io_kiocb *req, unsigned int issue_flags);
157int io_files_update_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe);
158
159int __io_account_mem(struct user_struct *user, unsigned long nr_pages);
160
161static inline void __io_unaccount_mem(struct user_struct *user,
162 unsigned long nr_pages)
163{
164 atomic_long_sub(i: nr_pages, v: &user->locked_vm);
165}
166
167#endif
168

source code of linux/io_uring/rsrc.h