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