blob: f8516430490da60cb49b65b88c4ef57afae132f6 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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>
Badari Pulavarty027445c2006-09-30 23:28:46 -07007#include <linux/uio.h>
Jens Axboeabf137d2008-12-09 08:11:22 +01008#include <linux/rcupdate.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
Arun Sharma600634972011-07-26 16:09:06 -070010#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
Linus Torvalds1da177e2005-04-16 15:20:36 -070012struct kioctx;
Kent Overstreet0460fef2013-05-07 16:18:49 -070013struct kiocb;
Linus Torvalds1da177e2005-04-16 15:20:36 -070014
Kent Overstreet8a660892013-05-07 16:19:10 -070015#define KIOCB_KEY 0
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
Kent Overstreet0460fef2013-05-07 16:18:49 -070017/*
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))
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
Kent Overstreetbec68faa2013-05-13 14:45:08 -070030typedef int (kiocb_cancel_fn)(struct kiocb *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Linus Torvalds1da177e2005-04-16 15:20:36 -070032struct kiocb {
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 struct file *ki_filp;
Kent Overstreet8a660892013-05-07 16:19:10 -070034 struct kioctx *ki_ctx; /* NULL for sync ops */
Kent Overstreet0460fef2013-05-07 16:18:49 -070035 kiocb_cancel_fn *ki_cancel;
Kent Overstreet8bc92af2013-02-25 16:36:27 -080036 void *private;
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 union {
39 void __user *user;
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 } ki_obj;
Benjamin LaHaise59d91362006-01-08 01:04:34 -080041
Linus Torvalds1da177e2005-04-16 15:20:36 -070042 __u64 ki_user_data; /* user's data for completion */
43 loff_t ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Benjamin LaHaise59d91362006-01-08 01:04:34 -080045 struct list_head ki_list; /* the aio core uses this
46 * for cancellation */
Davide Libenzi9c3060b2007-05-10 22:23:21 -070047
48 /*
49 * If the aio_resfd field of the userspace iocb is not zero,
Davide Libenzi13389012009-06-30 11:41:11 -070050 * this is the underlying eventfd context to deliver events to.
Davide Libenzi9c3060b2007-05-10 22:23:21 -070051 */
Davide Libenzi13389012009-06-30 11:41:11 -070052 struct eventfd_ctx *ki_eventfd;
Linus Torvalds1da177e2005-04-16 15:20:36 -070053};
54
Andrew Mortonf7e1bec2012-07-30 14:42:56 -070055static inline bool is_sync_kiocb(struct kiocb *kiocb)
56{
Kent Overstreet8a660892013-05-07 16:19:10 -070057 return kiocb->ki_ctx == NULL;
Andrew Mortonf7e1bec2012-07-30 14:42:56 -070058}
59
60static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
61{
62 *kiocb = (struct kiocb) {
Kent Overstreet8a660892013-05-07 16:19:10 -070063 .ki_ctx = NULL,
Andrew Mortonf7e1bec2012-07-30 14:42:56 -070064 .ki_filp = filp,
Andrew Mortonf7e1bec2012-07-30 14:42:56 -070065 };
66}
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
Linus Torvalds1da177e2005-04-16 15:20:36 -070068/* prototypes */
Thomas Petazzoniebf3f092008-10-15 22:05:12 -070069#ifdef CONFIG_AIO
Kent Overstreet2d684492013-05-07 16:18:29 -070070extern void aio_complete(struct kiocb *iocb, long res, long res2);
Linus Torvalds1da177e2005-04-16 15:20:36 -070071struct mm_struct;
Harvey Harrisonb3c97522008-02-13 15:03:15 -080072extern void exit_aio(struct mm_struct *mm);
Jeff Moyer9d85cba72010-05-26 14:44:26 -070073extern long do_io_submit(aio_context_t ctx_id, long nr,
74 struct iocb __user *__user *iocbpp, bool compat);
Kent Overstreet0460fef2013-05-07 16:18:49 -070075void kiocb_set_cancel_fn(struct kiocb *req, kiocb_cancel_fn *cancel);
Thomas Petazzoniebf3f092008-10-15 22:05:12 -070076#else
Kent Overstreet2d684492013-05-07 16:18:29 -070077static inline void aio_complete(struct kiocb *iocb, long res, long res2) { }
Thomas Petazzoniebf3f092008-10-15 22:05:12 -070078struct mm_struct;
79static inline void exit_aio(struct mm_struct *mm) { }
Jeff Moyer9d85cba72010-05-26 14:44:26 -070080static inline long do_io_submit(aio_context_t ctx_id, long nr,
81 struct iocb __user * __user *iocbpp,
82 bool compat) { return 0; }
Kent Overstreet0460fef2013-05-07 16:18:49 -070083static inline void kiocb_set_cancel_fn(struct kiocb *req,
84 kiocb_cancel_fn *cancel) { }
Thomas Petazzoniebf3f092008-10-15 22:05:12 -070085#endif /* CONFIG_AIO */
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
Linus Torvalds1da177e2005-04-16 15:20:36 -070087static inline struct kiocb *list_kiocb(struct list_head *h)
88{
89 return list_entry(h, struct kiocb, ki_list);
90}
91
92/* for sysctl: */
Zach Brownd55b5fd2005-11-07 00:59:31 -080093extern unsigned long aio_nr;
94extern unsigned long aio_max_nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
96#endif /* __LINUX__AIO_H */