io_uring/io_uring.h

   1 #ifndef IOU_CORE_H
   2 #define IOU_CORE_H
   3
   4 #include <linux/errno.h>
   5 #include <linux/lockdep.h>
   6 #include <linux/resume_user_mode.h>
   7 #include <linux/kasan.h>
   8 #include <linux/io_uring_types.h>
   9 #include <uapi/linux/eventpoll.h>
  10 #include "io-wq.h"
  11 #include "slist.h"
  12 #include "filetable.h"
  13
  14 #ifndef CREATE_TRACE_POINTS
  15 #include <trace/events/io_uring.h>
  16 #endif
  17
  18 enum {
  19         /*
  20          * A hint to not wake right away but delay until there are enough of
  21          * tw's queued to match the number of CQEs the task is waiting for.
  22          *
  23          * Must not be used wirh requests generating more than one CQE.
  24          * It's also ignored unless IORING_SETUP_DEFER_TASKRUN is set.
  25          */
  26         IOU_F_TWQ_LAZY_WAKE                     = 1,
  27 };
  28
  29 enum {
  30         IOU_OK                  = 0,
  31         IOU_ISSUE_SKIP_COMPLETE = -EIOCBQUEUED,
  32
  33         /*
  34          * Intended only when both IO_URING_F_MULTISHOT is passed
  35          * to indicate to the poll runner that multishot should be
  36          * removed and the result is set on req->cqe.res.
  37          */
  38         IOU_STOP_MULTISHOT      = -ECANCELED,
  39 };
  40
  41 bool io_cqe_cache_refill(struct io_ring_ctx *ctx, bool overflow);
  42 void io_req_cqe_overflow(struct io_kiocb *req);
  43 int io_run_task_work_sig(struct io_ring_ctx *ctx);
  44 void io_req_defer_failed(struct io_kiocb *req, s32 res);
  45 void io_req_complete_post(struct io_kiocb *req, unsigned issue_flags);
  46 bool io_post_aux_cqe(struct io_ring_ctx *ctx, u64 user_data, s32 res, u32 cflags);
  47 bool io_fill_cqe_req_aux(struct io_kiocb *req, bool defer, s32 res, u32 cflags);
  48 void __io_commit_cqring_flush(struct io_ring_ctx *ctx);
  49
  50 struct page **io_pin_pages(unsigned long ubuf, unsigned long len, int *npages);
  51
  52 struct file *io_file_get_normal(struct io_kiocb *req, int fd);
  53 struct file *io_file_get_fixed(struct io_kiocb *req, int fd,
  54                                unsigned issue_flags);
  55
  56 void __io_req_task_work_add(struct io_kiocb *req, unsigned flags);
  57 bool io_is_uring_fops(struct file *file);
  58 bool io_alloc_async_data(struct io_kiocb *req);
  59 void io_req_task_queue(struct io_kiocb *req);
  60 void io_queue_iowq(struct io_kiocb *req, struct io_tw_state *ts_dont_use);
  61 void io_req_task_complete(struct io_kiocb *req, struct io_tw_state *ts);
  62 void io_req_task_queue_fail(struct io_kiocb *req, int ret);
  63 void io_req_task_submit(struct io_kiocb *req, struct io_tw_state *ts);
  64 void tctx_task_work(struct callback_head *cb);
  65 __cold void io_uring_cancel_generic(bool cancel_all, struct io_sq_data *sqd);
  66 int io_uring_alloc_task_context(struct task_struct *task,
  67                                 struct io_ring_ctx *ctx);
  68
  69 int io_ring_add_registered_file(struct io_uring_task *tctx, struct file *file,
  70                                      int start, int end);
  71
  72 int io_poll_issue(struct io_kiocb *req, struct io_tw_state *ts);
  73 int io_submit_sqes(struct io_ring_ctx *ctx, unsigned int nr);
  74 int io_do_iopoll(struct io_ring_ctx *ctx, bool force_nonspin);
  75 void __io_submit_flush_completions(struct io_ring_ctx *ctx);
  76 int io_req_prep_async(struct io_kiocb *req);
  77
  78 struct io_wq_work *io_wq_free_work(struct io_wq_work *work);
  79 void io_wq_submit_work(struct io_wq_work *work);
  80
  81 void io_free_req(struct io_kiocb *req);
  82 void io_queue_next(struct io_kiocb *req);
  83 void io_task_refs_refill(struct io_uring_task *tctx);
  84 bool __io_alloc_req_refill(struct io_ring_ctx *ctx);
  85
  86 bool io_match_task_safe(struct io_kiocb *head, struct task_struct *task,
  87                         bool cancel_all);
  88
  89 void *io_mem_alloc(size_t size);
  90 void io_mem_free(void *ptr);
  91
  92 #if defined(CONFIG_PROVE_LOCKING)
  93 static inline void io_lockdep_assert_cq_locked(struct io_ring_ctx *ctx)
  94 {
  95         lockdep_assert(in_task());
  96
  97         if (ctx->flags & IORING_SETUP_IOPOLL) {
  98                 lockdep_assert_held(&ctx->uring_lock);
  99         } else if (!ctx->task_complete) {
 100                 lockdep_assert_held(&ctx->completion_lock);
 101         } else if (ctx->submitter_task) {
 102                 /*
 103                  * ->submitter_task may be NULL and we can still post a CQE,
 104                  * if the ring has been setup with IORING_SETUP_R_DISABLED.
 105                  * Not from an SQE, as those cannot be submitted, but via
 106                  * updating tagged resources.
 107                  */
 108                 if (ctx->submitter_task->flags & PF_EXITING)
 109                         lockdep_assert(current_work());
 110                 else
 111                         lockdep_assert(current == ctx->submitter_task);
 112         }
 113 }
 114 #else
 115 static inline void io_lockdep_assert_cq_locked(struct io_ring_ctx *ctx)
 116 {
 117 }
 118 #endif
 119
 120 static inline void io_req_task_work_add(struct io_kiocb *req)
 121 {
 122         __io_req_task_work_add(req, 0);
 123 }
 124
 125 #define io_for_each_link(pos, head) \
 126         for (pos = (head); pos; pos = pos->link)
 127
 128 static inline bool io_get_cqe_overflow(struct io_ring_ctx *ctx,
 129                                         struct io_uring_cqe **ret,
 130                                         bool overflow)
 131 {
 132         io_lockdep_assert_cq_locked(ctx);
 133
 134         if (unlikely(ctx->cqe_cached >= ctx->cqe_sentinel)) {
 135                 if (unlikely(!io_cqe_cache_refill(ctx, overflow)))
 136                         return false;
 137         }
 138         *ret = ctx->cqe_cached;
 139         ctx->cached_cq_tail++;
 140         ctx->cqe_cached++;
 141         if (ctx->flags & IORING_SETUP_CQE32)
 142                 ctx->cqe_cached++;
 143         return true;
 144 }
 145
 146 static inline bool io_get_cqe(struct io_ring_ctx *ctx, struct io_uring_cqe **ret)
 147 {
 148         return io_get_cqe_overflow(ctx, ret, false);
 149 }
 150
 151 static __always_inline bool io_fill_cqe_req(struct io_ring_ctx *ctx,
 152                                             struct io_kiocb *req)
 153 {
 154         struct io_uring_cqe *cqe;
 155
 156         /*
 157          * If we can't get a cq entry, userspace overflowed the
 158          * submission (by quite a lot). Increment the overflow count in
 159          * the ring.
 160          */
 161         if (unlikely(!io_get_cqe(ctx, &cqe)))
 162                 return false;
 163
 164         if (trace_io_uring_complete_enabled())
 165                 trace_io_uring_complete(req->ctx, req, req->cqe.user_data,
 166                                         req->cqe.res, req->cqe.flags,
 167                                         req->big_cqe.extra1, req->big_cqe.extra2);
 168
 169         memcpy(cqe, &req->cqe, sizeof(*cqe));
 170         if (ctx->flags & IORING_SETUP_CQE32) {
 171                 memcpy(cqe->big_cqe, &req->big_cqe, sizeof(*cqe));
 172                 memset(&req->big_cqe, 0, sizeof(req->big_cqe));
 173         }
 174         return true;
 175 }
 176
 177 static inline void req_set_fail(struct io_kiocb *req)
 178 {
 179         req->flags |= REQ_F_FAIL;
 180         if (req->flags & REQ_F_CQE_SKIP) {
 181                 req->flags &= ~REQ_F_CQE_SKIP;
 182                 req->flags |= REQ_F_SKIP_LINK_CQES;
 183         }
 184 }
 185
 186 static inline void io_req_set_res(struct io_kiocb *req, s32 res, u32 cflags)
 187 {
 188         req->cqe.res = res;
 189         req->cqe.flags = cflags;
 190 }
 191
 192 static inline bool req_has_async_data(struct io_kiocb *req)
 193 {
 194         return req->flags & REQ_F_ASYNC_DATA;
 195 }
 196
 197 static inline void io_put_file(struct io_kiocb *req)
 198 {
 199         if (!(req->flags & REQ_F_FIXED_FILE) && req->file)
 200                 fput(req->file);
 201 }
 202
 203 static inline void io_ring_submit_unlock(struct io_ring_ctx *ctx,
 204                                          unsigned issue_flags)
 205 {
 206         lockdep_assert_held(&ctx->uring_lock);
 207         if (issue_flags & IO_URING_F_UNLOCKED)
 208                 mutex_unlock(&ctx->uring_lock);
 209 }
 210
 211 static inline void io_ring_submit_lock(struct io_ring_ctx *ctx,
 212                                        unsigned issue_flags)
 213 {
 214         /*
 215          * "Normal" inline submissions always hold the uring_lock, since we
 216          * grab it from the system call. Same is true for the SQPOLL offload.
 217          * The only exception is when we've detached the request and issue it
 218          * from an async worker thread, grab the lock for that case.
 219          */
 220         if (issue_flags & IO_URING_F_UNLOCKED)
 221                 mutex_lock(&ctx->uring_lock);
 222         lockdep_assert_held(&ctx->uring_lock);
 223 }
 224
 225 static inline void io_commit_cqring(struct io_ring_ctx *ctx)
 226 {
 227         /* order cqe stores with ring update */
 228         smp_store_release(&ctx->rings->cq.tail, ctx->cached_cq_tail);
 229 }
 230
 231 static inline void io_poll_wq_wake(struct io_ring_ctx *ctx)
 232 {
 233         if (wq_has_sleeper(&ctx->poll_wq))
 234                 __wake_up(&ctx->poll_wq, TASK_NORMAL, 0,
 235                                 poll_to_key(EPOLL_URING_WAKE | EPOLLIN));
 236 }
 237
 238 static inline void io_cqring_wake(struct io_ring_ctx *ctx)
 239 {
 240         /*
 241          * Trigger waitqueue handler on all waiters on our waitqueue. This
 242          * won't necessarily wake up all the tasks, io_should_wake() will make
 243          * that decision.
 244          *
 245          * Pass in EPOLLIN|EPOLL_URING_WAKE as the poll wakeup key. The latter
 246          * set in the mask so that if we recurse back into our own poll
 247          * waitqueue handlers, we know we have a dependency between eventfd or
 248          * epoll and should terminate multishot poll at that point.
 249          */
 250         if (wq_has_sleeper(&ctx->cq_wait))
 251                 __wake_up(&ctx->cq_wait, TASK_NORMAL, 0,
 252                                 poll_to_key(EPOLL_URING_WAKE | EPOLLIN));
 253 }
 254
 255 static inline bool io_sqring_full(struct io_ring_ctx *ctx)
 256 {
 257         struct io_rings *r = ctx->rings;
 258
 259         return READ_ONCE(r->sq.tail) - ctx->cached_sq_head == ctx->sq_entries;
 260 }
 261
 262 static inline unsigned int io_sqring_entries(struct io_ring_ctx *ctx)
 263 {
 264         struct io_rings *rings = ctx->rings;
 265         unsigned int entries;
 266
 267         /* make sure SQ entry isn't read before tail */
 268         entries = smp_load_acquire(&rings->sq.tail) - ctx->cached_sq_head;
 269         return min(entries, ctx->sq_entries);
 270 }
 271
 272 static inline int io_run_task_work(void)
 273 {
 274         /*
 275          * Always check-and-clear the task_work notification signal. With how
 276          * signaling works for task_work, we can find it set with nothing to
 277          * run. We need to clear it for that case, like get_signal() does.
 278          */
 279         if (test_thread_flag(TIF_NOTIFY_SIGNAL))
 280                 clear_notify_signal();
 281         /*
 282          * PF_IO_WORKER never returns to userspace, so check here if we have
 283          * notify work that needs processing.
 284          */
 285         if (current->flags & PF_IO_WORKER &&
 286             test_thread_flag(TIF_NOTIFY_RESUME)) {
 287                 __set_current_state(TASK_RUNNING);
 288                 resume_user_mode_work(NULL);
 289         }
 290         if (task_work_pending(current)) {
 291                 __set_current_state(TASK_RUNNING);
 292                 task_work_run();
 293                 return 1;
 294         }
 295
 296         return 0;
 297 }
 298
 299 static inline bool io_task_work_pending(struct io_ring_ctx *ctx)
 300 {
 301         return task_work_pending(current) || !wq_list_empty(&ctx->work_llist);
 302 }
 303
 304 static inline void io_tw_lock(struct io_ring_ctx *ctx, struct io_tw_state *ts)
 305 {
 306         if (!ts->locked) {
 307                 mutex_lock(&ctx->uring_lock);
 308                 ts->locked = true;
 309         }
 310 }
 311
 312 /*
 313  * Don't complete immediately but use deferred completion infrastructure.
 314  * Protected by ->uring_lock and can only be used either with
 315  * IO_URING_F_COMPLETE_DEFER or inside a tw handler holding the mutex.
 316  */
 317 static inline void io_req_complete_defer(struct io_kiocb *req)
 318         __must_hold(&req->ctx->uring_lock)
 319 {
 320         struct io_submit_state *state = &req->ctx->submit_state;
 321
 322         lockdep_assert_held(&req->ctx->uring_lock);
 323
 324         wq_list_add_tail(&req->comp_list, &state->compl_reqs);
 325 }
 326
 327 static inline void io_commit_cqring_flush(struct io_ring_ctx *ctx)
 328 {
 329         if (unlikely(ctx->off_timeout_used || ctx->drain_active ||
 330                      ctx->has_evfd || ctx->poll_activated))
 331                 __io_commit_cqring_flush(ctx);
 332 }
 333
 334 static inline void io_get_task_refs(int nr)
 335 {
 336         struct io_uring_task *tctx = current->io_uring;
 337
 338         tctx->cached_refs -= nr;
 339         if (unlikely(tctx->cached_refs < 0))
 340                 io_task_refs_refill(tctx);
 341 }
 342
 343 static inline bool io_req_cache_empty(struct io_ring_ctx *ctx)
 344 {
 345         return !ctx->submit_state.free_list.next;
 346 }
 347
 348 extern struct kmem_cache *req_cachep;
 349
 350 static inline struct io_kiocb *io_extract_req(struct io_ring_ctx *ctx)
 351 {
 352         struct io_kiocb *req;
 353
 354         req = container_of(ctx->submit_state.free_list.next, struct io_kiocb, comp_list);
 355         wq_stack_extract(&ctx->submit_state.free_list);
 356         return req;
 357 }
 358
 359 static inline bool io_alloc_req(struct io_ring_ctx *ctx, struct io_kiocb **req)
 360 {
 361         if (unlikely(io_req_cache_empty(ctx))) {
 362                 if (!__io_alloc_req_refill(ctx))
 363                         return false;
 364         }
 365         *req = io_extract_req(ctx);
 366         return true;
 367 }
 368
 369 static inline bool io_allowed_defer_tw_run(struct io_ring_ctx *ctx)
 370 {
 371         return likely(ctx->submitter_task == current);
 372 }
 373
 374 static inline bool io_allowed_run_tw(struct io_ring_ctx *ctx)
 375 {
 376         return likely(!(ctx->flags & IORING_SETUP_DEFER_TASKRUN) ||
 377                       ctx->submitter_task == current);
 378 }
 379
 380 static inline void io_req_queue_tw_complete(struct io_kiocb *req, s32 res)
 381 {
 382         io_req_set_res(req, res, 0);
 383         req->io_task_work.func = io_req_task_complete;
 384         io_req_task_work_add(req);
 385 }
 386
 387 /*
 388  * IORING_SETUP_SQE128 contexts allocate twice the normal SQE size for each
 389  * slot.
 390  */
 391 static inline size_t uring_sqe_size(struct io_ring_ctx *ctx)
 392 {
 393         if (ctx->flags & IORING_SETUP_SQE128)
 394                 return 2 * sizeof(struct io_uring_sqe);
 395         return sizeof(struct io_uring_sqe);
 396 }
 397 #endif