[linux.git] / io_uring / rsrc.h

// SPDX-License-Identifier: GPL-2.0
#ifndef IOU_RSRC_H
#define IOU_RSRC_H

#include <net/af_unix.h>

#include "alloc_cache.h"

#define IO_NODE_ALLOC_CACHE_MAX 32

#define IO_RSRC_TAG_TABLE_SHIFT	(PAGE_SHIFT - 3)
#define IO_RSRC_TAG_TABLE_MAX	(1U << IO_RSRC_TAG_TABLE_SHIFT)
#define IO_RSRC_TAG_TABLE_MASK	(IO_RSRC_TAG_TABLE_MAX - 1)

enum {
	IORING_RSRC_FILE		= 0,
	IORING_RSRC_BUFFER		= 1,
};

struct io_rsrc_put {
	u64 tag;
	union {
		void *rsrc;
		struct file *file;
		struct io_mapped_ubuf *buf;
	};
};

typedef void (rsrc_put_fn)(struct io_ring_ctx *ctx, struct io_rsrc_put *prsrc);

struct io_rsrc_data {
	struct io_ring_ctx		*ctx;

	u64				**tags;
	unsigned int			nr;
	u16				rsrc_type;
	bool				quiesce;
};

struct io_rsrc_node {
	union {
		struct io_cache_entry		cache;
		struct io_ring_ctx		*ctx;
	};
	int				refs;
	bool				empty;
	u16				type;
	struct list_head		node;
	struct io_rsrc_put		item;
};

struct io_mapped_ubuf {
	u64		ubuf;
	u64		ubuf_end;
	unsigned int	nr_bvecs;
	unsigned long	acct_pages;
	struct bio_vec	bvec[] __counted_by(nr_bvecs);
};

void io_rsrc_node_ref_zero(struct io_rsrc_node *node);
void io_rsrc_node_destroy(struct io_ring_ctx *ctx, struct io_rsrc_node *ref_node);
struct io_rsrc_node *io_rsrc_node_alloc(struct io_ring_ctx *ctx);
int io_queue_rsrc_removal(struct io_rsrc_data *data, unsigned idx, void *rsrc);

int io_import_fixed(int ddir, struct iov_iter *iter,
			   struct io_mapped_ubuf *imu,
			   u64 buf_addr, size_t len);

void __io_sqe_buffers_unregister(struct io_ring_ctx *ctx);
int io_sqe_buffers_unregister(struct io_ring_ctx *ctx);
int io_sqe_buffers_register(struct io_ring_ctx *ctx, void __user *arg,
			    unsigned int nr_args, u64 __user *tags);
void __io_sqe_files_unregister(struct io_ring_ctx *ctx);
int io_sqe_files_unregister(struct io_ring_ctx *ctx);
int io_sqe_files_register(struct io_ring_ctx *ctx, void __user *arg,
			  unsigned nr_args, u64 __user *tags);

int __io_scm_file_account(struct io_ring_ctx *ctx, struct file *file);

static inline bool io_file_need_scm(struct file *filp)
{
	return false;
}

static inline int io_scm_file_account(struct io_ring_ctx *ctx,
				      struct file *file)
{
	if (likely(!io_file_need_scm(file)))
		return 0;
	return __io_scm_file_account(ctx, file);
}

int io_register_files_update(struct io_ring_ctx *ctx, void __user *arg,
			     unsigned nr_args);
int io_register_rsrc_update(struct io_ring_ctx *ctx, void __user *arg,
			    unsigned size, unsigned type);
int io_register_rsrc(struct io_ring_ctx *ctx, void __user *arg,
			unsigned int size, unsigned int type);

static inline void io_put_rsrc_node(struct io_ring_ctx *ctx, struct io_rsrc_node *node)
{
	lockdep_assert_held(&ctx->uring_lock);

	if (node && !--node->refs)
		io_rsrc_node_ref_zero(node);
}

static inline void io_req_put_rsrc_locked(struct io_kiocb *req,
					  struct io_ring_ctx *ctx)
{
	io_put_rsrc_node(ctx, req->rsrc_node);
}

static inline void io_charge_rsrc_node(struct io_ring_ctx *ctx,
				       struct io_rsrc_node *node)
{
	node->refs++;
}

static inline void io_req_set_rsrc_node(struct io_kiocb *req,
					struct io_ring_ctx *ctx,
					unsigned int issue_flags)
{
	if (!req->rsrc_node) {
		io_ring_submit_lock(ctx, issue_flags);

		lockdep_assert_held(&ctx->uring_lock);

		req->rsrc_node = ctx->rsrc_node;
		io_charge_rsrc_node(ctx, ctx->rsrc_node);
		io_ring_submit_unlock(ctx, issue_flags);
	}
}

static inline u64 *io_get_tag_slot(struct io_rsrc_data *data, unsigned int idx)
{
	unsigned int off = idx & IO_RSRC_TAG_TABLE_MASK;
	unsigned int table_idx = idx >> IO_RSRC_TAG_TABLE_SHIFT;

	return &data->tags[table_idx][off];
}

static inline int io_rsrc_init(struct io_ring_ctx *ctx)
{
	ctx->rsrc_node = io_rsrc_node_alloc(ctx);
	return ctx->rsrc_node ? 0 : -ENOMEM;
}

int io_files_update(struct io_kiocb *req, unsigned int issue_flags);
int io_files_update_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe);

int __io_account_mem(struct user_struct *user, unsigned long nr_pages);

static inline void __io_unaccount_mem(struct user_struct *user,
				      unsigned long nr_pages)
{
	atomic_long_sub(nr_pages, &user->locked_vm);
}

#endif
Commit	Line	Data
73572984 JA	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
9eae8655 PB	7	#include "alloc_cache.h"
9eae8655 PB	8
69bbc6ad PB	9	#define IO_NODE_ALLOC_CACHE_MAX 32
69bbc6ad PB	10
73572984 JA	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 {
73572984 JA	21	u64 tag;
	22	union {
	23	void *rsrc;
	24	struct file *file;
	25	struct io_mapped_ubuf *buf;
	26	};
	27	};
	28
	29	typedef void (rsrc_put_fn)(struct io_ring_ctx ctx, struct io_rsrc_put prsrc);
	30
	31	struct io_rsrc_data {
	32	struct io_ring_ctx *ctx;
	33
	34	u64 **tags;
	35	unsigned int nr;
fc7f3a8d	36	u16 rsrc_type;
73572984 JA	37	bool quiesce;
	38	};
	39
	40	struct io_rsrc_node {
9eae8655 PB	41	union {
9eae8655 PB	42	struct io_cache_entry cache;
2236b390	43	struct io_ring_ctx *ctx;
9eae8655	44	};
ef8ae64f	45	int refs;
26147da3	46	bool empty;
2236b390	47	u16 type;
c376644f PB	48	struct list_head node;
c376644f PB	49	struct io_rsrc_put item;
73572984 JA	50	};
73572984 JA	51
ad163a7e JA	52	struct io_mapped_ubuf {
	53	u64 ubuf;
	54	u64 ubuf_end;
	55	unsigned int nr_bvecs;
	56	unsigned long acct_pages;
04d9244c	57	struct bio_vec bvec[] __counted_by(nr_bvecs);
ad163a7e JA	58	};
ad163a7e JA	59
b8fb5b4f	60	void io_rsrc_node_ref_zero(struct io_rsrc_node *node);
9eae8655	61	void io_rsrc_node_destroy(struct io_ring_ctx ctx, struct io_rsrc_node ref_node);
2933ae6e	62	struct io_rsrc_node io_rsrc_node_alloc(struct io_ring_ctx ctx);
63fea890	63	int io_queue_rsrc_removal(struct io_rsrc_data data, unsigned idx, void rsrc);
73572984	64
c059f785 PB	65	int io_import_fixed(int ddir, struct iov_iter *iter,
	66	struct io_mapped_ubuf *imu,
	67	u64 buf_addr, size_t len);
73572984 JA	68
	69	void __io_sqe_buffers_unregister(struct io_ring_ctx *ctx);
	70	int io_sqe_buffers_unregister(struct io_ring_ctx *ctx);
	71	int io_sqe_buffers_register(struct io_ring_ctx ctx, void __user arg,
	72	unsigned int nr_args, u64 __user *tags);
	73	void __io_sqe_files_unregister(struct io_ring_ctx *ctx);
	74	int io_sqe_files_unregister(struct io_ring_ctx *ctx);
	75	int io_sqe_files_register(struct io_ring_ctx ctx, void __user arg,
	76	unsigned nr_args, u64 __user *tags);
	77
	78	int __io_scm_file_account(struct io_ring_ctx ctx, struct file file);
	79
73572984 JA	80	static inline bool io_file_need_scm(struct file *filp)
	81	{
	82	return false;
	83	}
73572984 JA	84
	85	static inline int io_scm_file_account(struct io_ring_ctx *ctx,
	86	struct file *file)
	87	{
	88	if (likely(!io_file_need_scm(file)))
	89	return 0;
	90	return __io_scm_file_account(ctx, file);
	91	}
	92
	93	int io_register_files_update(struct io_ring_ctx ctx, void __user arg,
	94	unsigned nr_args);
	95	int io_register_rsrc_update(struct io_ring_ctx ctx, void __user arg,
	96	unsigned size, unsigned type);
	97	int io_register_rsrc(struct io_ring_ctx ctx, void __user arg,
	98	unsigned int size, unsigned int type);
	99
1f2c8f61	100	static inline void io_put_rsrc_node(struct io_ring_ctx ctx, struct io_rsrc_node node)
73572984	101	{
1f2c8f61 PB	102	lockdep_assert_held(&ctx->uring_lock);
1f2c8f61 PB	103
ef8ae64f PB	104	if (node && !--node->refs)
ef8ae64f PB	105	io_rsrc_node_ref_zero(node);
73572984 JA	106	}
	107
	108	static inline void io_req_put_rsrc_locked(struct io_kiocb *req,
	109	struct io_ring_ctx *ctx)
73572984	110	{
1f2c8f61	111	io_put_rsrc_node(ctx, req->rsrc_node);
73572984 JA	112	}
73572984 JA	113
8e15c0e7 PB	114	static inline void io_charge_rsrc_node(struct io_ring_ctx *ctx,
8e15c0e7 PB	115	struct io_rsrc_node *node)
68ef5578	116	{
ef8ae64f	117	node->refs++;
68ef5578 PB	118	}
68ef5578 PB	119
73572984 JA	120	static inline void io_req_set_rsrc_node(struct io_kiocb *req,
	121	struct io_ring_ctx *ctx,
	122	unsigned int issue_flags)
	123	{
	124	if (!req->rsrc_node) {
4ff0b50d	125	io_ring_submit_lock(ctx, issue_flags);
73572984	126
4ff0b50d	127	lockdep_assert_held(&ctx->uring_lock);
68ef5578	128
4ff0b50d	129	req->rsrc_node = ctx->rsrc_node;
8e15c0e7	130	io_charge_rsrc_node(ctx, ctx->rsrc_node);
4ff0b50d	131	io_ring_submit_unlock(ctx, issue_flags);
73572984 JA	132	}
	133	}
	134
	135	static inline u64 io_get_tag_slot(struct io_rsrc_data data, unsigned int idx)
	136	{
	137	unsigned int off = idx & IO_RSRC_TAG_TABLE_MASK;
	138	unsigned int table_idx = idx >> IO_RSRC_TAG_TABLE_SHIFT;
	139
	140	return &data->tags[table_idx][off];
	141	}
	142
2933ae6e PB	143	static inline int io_rsrc_init(struct io_ring_ctx *ctx)
	144	{
	145	ctx->rsrc_node = io_rsrc_node_alloc(ctx);
	146	return ctx->rsrc_node ? 0 : -ENOMEM;
	147	}
	148
d9808ceb PB	149	int io_files_update(struct io_kiocb *req, unsigned int issue_flags);
d9808ceb PB	150	int io_files_update_prep(struct io_kiocb req, const struct io_uring_sqe sqe);
6a9ce66f PB	151
	152	int __io_account_mem(struct user_struct *user, unsigned long nr_pages);
	153
	154	static inline void __io_unaccount_mem(struct user_struct *user,
	155	unsigned long nr_pages)
	156	{
	157	atomic_long_sub(nr_pages, &user->locked_vm);
	158	}
	159
73572984	160	#endif