include/linux/aio.h

   1 #ifndef __LINUX__AIO_H
   2 #define __LINUX__AIO_H
   3
   4 #include <linux/list.h>
   5 #include <linux/workqueue.h>
   6 #include <linux/aio_abi.h>
   7 #include <linux/uio.h>
   8 #include <linux/rcupdate.h>
   9
  10 #include <linux/atomic.h>
  11
  12 struct kioctx;
  13 struct kiocb;
  14
  15 #define KIOCB_KEY               0
  16
  17 /*
  18  * We use ki_cancel == KIOCB_CANCELLED to indicate that a kiocb has been either
  19  * cancelled or completed (this makes a certain amount of sense because
  20  * successful cancellation - io_cancel() - does deliver the completion to
  21  * userspace).
  22  *
  23  * And since most things don't implement kiocb cancellation and we'd really like
  24  * kiocb completion to be lockless when possible, we use ki_cancel to
  25  * synchronize cancellation and completion - we only set it to KIOCB_CANCELLED
  26  * with xchg() or cmpxchg(), see batch_complete_aio() and kiocb_cancel().
  27  */
  28 #define KIOCB_CANCELLED         ((void *) (~0ULL))
  29
  30 typedef int (kiocb_cancel_fn)(struct kiocb *);
  31
  32 struct kiocb {
  33         struct file             *ki_filp;
  34         struct kioctx           *ki_ctx;        /* NULL for sync ops */
  35         kiocb_cancel_fn         *ki_cancel;
  36         void                    *private;
  37
  38         union {
  39                 void __user             *user;
  40         } ki_obj;
  41
  42         __u64                   ki_user_data;   /* user's data for completion */
  43         loff_t                  ki_pos;
  44
  45         struct list_head        ki_list;        /* the aio core uses this
  46                                                  * for cancellation */
  47
  48         /*
  49          * If the aio_resfd field of the userspace iocb is not zero,
  50          * this is the underlying eventfd context to deliver events to.
  51          */
  52         struct eventfd_ctx      *ki_eventfd;
  53 };
  54
  55 static inline bool is_sync_kiocb(struct kiocb *kiocb)
  56 {
  57         return kiocb->ki_ctx == NULL;
  58 }
  59
  60 static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
  61 {
  62         *kiocb = (struct kiocb) {
  63                         .ki_ctx = NULL,
  64                         .ki_filp = filp,
  65                 };
  66 }
  67
  68 /* prototypes */
  69 #ifdef CONFIG_AIO
  70 extern void aio_complete(struct kiocb *iocb, long res, long res2);
  71 struct mm_struct;
  72 extern void exit_aio(struct mm_struct *mm);
  73 extern long do_io_submit(aio_context_t ctx_id, long nr,
  74                          struct iocb __user *__user *iocbpp, bool compat);
  75 void kiocb_set_cancel_fn(struct kiocb *req, kiocb_cancel_fn *cancel);
  76 #else
  77 static inline void aio_complete(struct kiocb *iocb, long res, long res2) { }
  78 struct mm_struct;
  79 static inline void exit_aio(struct mm_struct *mm) { }
  80 static inline long do_io_submit(aio_context_t ctx_id, long nr,
  81                                 struct iocb __user * __user *iocbpp,
  82                                 bool compat) { return 0; }
  83 static inline void kiocb_set_cancel_fn(struct kiocb *req,
  84                                        kiocb_cancel_fn *cancel) { }
  85 #endif /* CONFIG_AIO */
  86
  87 static inline struct kiocb *list_kiocb(struct list_head *h)
  88 {
  89         return list_entry(h, struct kiocb, ki_list);
  90 }
  91
  92 /* for sysctl: */
  93 extern unsigned long aio_nr;
  94 extern unsigned long aio_max_nr;
  95
  96 #endif /* __LINUX__AIO_H */