5dd2fcb2806962304427fbccd455aac0959c041d
[platform/kernel/linux-starfive.git] / io_uring / rsrc.h
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
15 enum {
16         IORING_RSRC_FILE                = 0,
17         IORING_RSRC_BUFFER              = 1,
18 };
19
20 struct io_rsrc_put {
21         struct list_head list;
22         u64 tag;
23         union {
24                 void *rsrc;
25                 struct file *file;
26                 struct io_mapped_ubuf *buf;
27         };
28 };
29
30 typedef void (rsrc_put_fn)(struct io_ring_ctx *ctx, struct io_rsrc_put *prsrc);
31
32 struct io_rsrc_data {
33         struct io_ring_ctx              *ctx;
34
35         u64                             **tags;
36         unsigned int                    nr;
37         rsrc_put_fn                     *do_put;
38         bool                            quiesce;
39 };
40
41 struct io_rsrc_node {
42         union {
43                 struct io_cache_entry           cache;
44                 struct io_rsrc_data             *rsrc_data;
45         };
46         struct list_head                node;
47         struct llist_node               llist;
48         int                             refs;
49
50         /*
51          * Keeps a list of struct io_rsrc_put to be completed. Each entry
52          * represents one rsrc (e.g. file or buffer), but all of them should've
53          * came from the same table and so are of the same type.
54          */
55         struct list_head                item_list;
56         struct io_rsrc_put              item;
57         int                             inline_items;
58 };
59
60 struct io_mapped_ubuf {
61         u64             ubuf;
62         u64             ubuf_end;
63         unsigned int    nr_bvecs;
64         unsigned long   acct_pages;
65         struct bio_vec  bvec[];
66 };
67
68 void io_rsrc_put_tw(struct callback_head *cb);
69 void io_rsrc_node_ref_zero(struct io_rsrc_node *node);
70 void io_rsrc_put_work(struct work_struct *work);
71 void io_rsrc_node_destroy(struct io_ring_ctx *ctx, struct io_rsrc_node *ref_node);
72 int io_rsrc_node_switch_start(struct io_ring_ctx *ctx);
73 struct io_rsrc_node *io_rsrc_node_alloc(struct io_ring_ctx *ctx);
74 int io_queue_rsrc_removal(struct io_rsrc_data *data, unsigned idx,
75                           struct io_rsrc_node *node, void *rsrc);
76 void io_rsrc_node_switch(struct io_ring_ctx *ctx,
77                          struct io_rsrc_data *data_to_kill);
78
79 int io_import_fixed(int ddir, struct iov_iter *iter,
80                            struct io_mapped_ubuf *imu,
81                            u64 buf_addr, size_t len);
82
83 void __io_sqe_buffers_unregister(struct io_ring_ctx *ctx);
84 int io_sqe_buffers_unregister(struct io_ring_ctx *ctx);
85 int io_sqe_buffers_register(struct io_ring_ctx *ctx, void __user *arg,
86                             unsigned int nr_args, u64 __user *tags);
87 void __io_sqe_files_unregister(struct io_ring_ctx *ctx);
88 int io_sqe_files_unregister(struct io_ring_ctx *ctx);
89 int io_sqe_files_register(struct io_ring_ctx *ctx, void __user *arg,
90                           unsigned nr_args, u64 __user *tags);
91
92 int __io_scm_file_account(struct io_ring_ctx *ctx, struct file *file);
93
94 #if defined(CONFIG_UNIX)
95 static inline bool io_file_need_scm(struct file *filp)
96 {
97         return !!unix_get_socket(filp);
98 }
99 #else
100 static inline bool io_file_need_scm(struct file *filp)
101 {
102         return false;
103 }
104 #endif
105
106 static inline int io_scm_file_account(struct io_ring_ctx *ctx,
107                                       struct file *file)
108 {
109         if (likely(!io_file_need_scm(file)))
110                 return 0;
111         return __io_scm_file_account(ctx, file);
112 }
113
114 int io_register_files_update(struct io_ring_ctx *ctx, void __user *arg,
115                              unsigned nr_args);
116 int io_register_rsrc_update(struct io_ring_ctx *ctx, void __user *arg,
117                             unsigned size, unsigned type);
118 int io_register_rsrc(struct io_ring_ctx *ctx, void __user *arg,
119                         unsigned int size, unsigned int type);
120
121 static inline void io_put_rsrc_node(struct io_ring_ctx *ctx, struct io_rsrc_node *node)
122 {
123         lockdep_assert_held(&ctx->uring_lock);
124
125         if (node && !--node->refs)
126                 io_rsrc_node_ref_zero(node);
127 }
128
129 static inline void io_req_put_rsrc_locked(struct io_kiocb *req,
130                                           struct io_ring_ctx *ctx)
131 {
132         io_put_rsrc_node(ctx, req->rsrc_node);
133 }
134
135 static inline void io_charge_rsrc_node(struct io_ring_ctx *ctx,
136                                        struct io_rsrc_node *node)
137 {
138         node->refs++;
139 }
140
141 static inline void io_req_set_rsrc_node(struct io_kiocb *req,
142                                         struct io_ring_ctx *ctx,
143                                         unsigned int issue_flags)
144 {
145         if (!req->rsrc_node) {
146                 io_ring_submit_lock(ctx, issue_flags);
147
148                 lockdep_assert_held(&ctx->uring_lock);
149
150                 req->rsrc_node = ctx->rsrc_node;
151                 io_charge_rsrc_node(ctx, ctx->rsrc_node);
152                 io_ring_submit_unlock(ctx, issue_flags);
153         }
154 }
155
156 static inline u64 *io_get_tag_slot(struct io_rsrc_data *data, unsigned int idx)
157 {
158         unsigned int off = idx & IO_RSRC_TAG_TABLE_MASK;
159         unsigned int table_idx = idx >> IO_RSRC_TAG_TABLE_SHIFT;
160
161         return &data->tags[table_idx][off];
162 }
163
164 static inline int io_rsrc_init(struct io_ring_ctx *ctx)
165 {
166         ctx->rsrc_node = io_rsrc_node_alloc(ctx);
167         return ctx->rsrc_node ? 0 : -ENOMEM;
168 }
169
170 int io_files_update(struct io_kiocb *req, unsigned int issue_flags);
171 int io_files_update_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe);
172
173 int __io_account_mem(struct user_struct *user, unsigned long nr_pages);
174
175 static inline void __io_unaccount_mem(struct user_struct *user,
176                                       unsigned long nr_pages)
177 {
178         atomic_long_sub(nr_pages, &user->locked_vm);
179 }
180
181 #endif