[linux.git] / fs / xfs / xfs_icache.h

// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (c) 2000-2006 Silicon Graphics, Inc.
 * All Rights Reserved.
 */
#ifndef XFS_SYNC_H
#define XFS_SYNC_H 1

struct xfs_mount;
struct xfs_perag;

struct xfs_eofblocks {
	__u32		eof_flags;
	kuid_t		eof_uid;
	kgid_t		eof_gid;
	prid_t		eof_prid;
	__u64		eof_min_file_size;
};

#define SYNC_WAIT		0x0001	/* wait for i/o to complete */
#define SYNC_TRYLOCK		0x0002  /* only try to lock inodes */

/*
 * tags for inode radix tree
 */
#define XFS_ICI_NO_TAG		(-1)	/* special flag for an untagged lookup
					   in xfs_inode_ag_iterator */
#define XFS_ICI_RECLAIM_TAG	0	/* inode is to be reclaimed */
#define XFS_ICI_EOFBLOCKS_TAG	1	/* inode has blocks beyond EOF */
#define XFS_ICI_COWBLOCKS_TAG	2	/* inode can have cow blocks to gc */

/*
 * Flags for xfs_iget()
 */
#define XFS_IGET_CREATE		0x1
#define XFS_IGET_UNTRUSTED	0x2
#define XFS_IGET_DONTCACHE	0x4
#define XFS_IGET_INCORE		0x8	/* don't read from disk or reinit */

/*
 * flags for AG inode iterator
 */
#define XFS_AGITER_INEW_WAIT	0x1	/* wait on new inodes */

int xfs_iget(struct xfs_mount *mp, struct xfs_trans *tp, xfs_ino_t ino,
	     uint flags, uint lock_flags, xfs_inode_t **ipp);

/* recovery needs direct inode allocation capability */
struct xfs_inode * xfs_inode_alloc(struct xfs_mount *mp, xfs_ino_t ino);
void xfs_inode_free(struct xfs_inode *ip);

void xfs_reclaim_worker(struct work_struct *work);

int xfs_reclaim_inodes(struct xfs_mount *mp, int mode);
int xfs_reclaim_inodes_count(struct xfs_mount *mp);
long xfs_reclaim_inodes_nr(struct xfs_mount *mp, int nr_to_scan);

void xfs_inode_set_reclaim_tag(struct xfs_inode *ip);

void xfs_inode_set_eofblocks_tag(struct xfs_inode *ip);
void xfs_inode_clear_eofblocks_tag(struct xfs_inode *ip);
int xfs_icache_free_eofblocks(struct xfs_mount *, struct xfs_eofblocks *);
int xfs_inode_free_quota_eofblocks(struct xfs_inode *ip);
void xfs_eofblocks_worker(struct work_struct *);
void xfs_queue_eofblocks(struct xfs_mount *);

void xfs_inode_set_cowblocks_tag(struct xfs_inode *ip);
void xfs_inode_clear_cowblocks_tag(struct xfs_inode *ip);
int xfs_icache_free_cowblocks(struct xfs_mount *, struct xfs_eofblocks *);
int xfs_inode_free_quota_cowblocks(struct xfs_inode *ip);
void xfs_cowblocks_worker(struct work_struct *);
void xfs_queue_cowblocks(struct xfs_mount *);

int xfs_inode_ag_iterator(struct xfs_mount *mp,
	int (*execute)(struct xfs_inode *ip, int flags, void *args),
	int flags, void *args);
int xfs_inode_ag_iterator_flags(struct xfs_mount *mp,
	int (*execute)(struct xfs_inode *ip, int flags, void *args),
	int flags, void *args, int iter_flags);
int xfs_inode_ag_iterator_tag(struct xfs_mount *mp,
	int (*execute)(struct xfs_inode *ip, int flags, void *args),
	int flags, void *args, int tag);

static inline int
xfs_fs_eofblocks_from_user(
	struct xfs_fs_eofblocks		*src,
	struct xfs_eofblocks		*dst)
{
	if (src->eof_version != XFS_EOFBLOCKS_VERSION)
		return -EINVAL;

	if (src->eof_flags & ~XFS_EOF_FLAGS_VALID)
		return -EINVAL;

	if (memchr_inv(&src->pad32, 0, sizeof(src->pad32)) ||
	    memchr_inv(src->pad64, 0, sizeof(src->pad64)))
		return -EINVAL;

	dst->eof_flags = src->eof_flags;
	dst->eof_prid = src->eof_prid;
	dst->eof_min_file_size = src->eof_min_file_size;

	dst->eof_uid = INVALID_UID;
	if (src->eof_flags & XFS_EOF_FLAGS_UID) {
		dst->eof_uid = make_kuid(current_user_ns(), src->eof_uid);
		if (!uid_valid(dst->eof_uid))
			return -EINVAL;
	}

	dst->eof_gid = INVALID_GID;
	if (src->eof_flags & XFS_EOF_FLAGS_GID) {
		dst->eof_gid = make_kgid(current_user_ns(), src->eof_gid);
		if (!gid_valid(dst->eof_gid))
			return -EINVAL;
	}
	return 0;
}

int xfs_icache_inode_is_allocated(struct xfs_mount *mp, struct xfs_trans *tp,
				  xfs_ino_t ino, bool *inuse);

void xfs_icache_disable_reclaim(struct xfs_mount *mp);
void xfs_icache_enable_reclaim(struct xfs_mount *mp);

#endif
Commit	Line	Data
0b61f8a4	1	// SPDX-License-Identifier: GPL-2.0
a167b17e DC	2	/*
	3	* Copyright (c) 2000-2006 Silicon Graphics, Inc.
	4	* All Rights Reserved.
a167b17e	5	*/
fe4fa4b8 DC	6	#ifndef XFS_SYNC_H
	7	#define XFS_SYNC_H 1
	8
a167b17e	9	struct xfs_mount;
fcafb71b	10	struct xfs_perag;
a167b17e	11
b9fe5052 DE	12	struct xfs_eofblocks {
	13	__u32 eof_flags;
	14	kuid_t eof_uid;
	15	kgid_t eof_gid;
	16	prid_t eof_prid;
	17	__u64 eof_min_file_size;
	18	};
	19
8b5403a6 CH	20	#define SYNC_WAIT 0x0001 /* wait for i/o to complete */
8b5403a6 CH	21	#define SYNC_TRYLOCK 0x0002 /* only try to lock inodes */
a167b17e	22
4fb6e8ad CH	23	/*
	24	* tags for inode radix tree
	25	*/
	26	#define XFS_ICI_NO_TAG (-1) /* special flag for an untagged lookup
	27	in xfs_inode_ag_iterator */
	28	#define XFS_ICI_RECLAIM_TAG 0 /* inode is to be reclaimed */
	29	#define XFS_ICI_EOFBLOCKS_TAG 1 /* inode has blocks beyond EOF */
83104d44	30	#define XFS_ICI_COWBLOCKS_TAG 2 /* inode can have cow blocks to gc */
4fb6e8ad	31
7bb85ef3 DC	32	/*
	33	* Flags for xfs_iget()
	34	*/
	35	#define XFS_IGET_CREATE 0x1
	36	#define XFS_IGET_UNTRUSTED 0x2
	37	#define XFS_IGET_DONTCACHE 0x4
378f681c	38	#define XFS_IGET_INCORE 0x8 /* don't read from disk or reinit */
7bb85ef3	39
ae2c4ac2 BF	40	/*
	41	* flags for AG inode iterator
	42	*/
	43	#define XFS_AGITER_INEW_WAIT 0x1 /* wait on new inodes */
	44
33479e05 DC	45	int xfs_iget(struct xfs_mount mp, struct xfs_trans tp, xfs_ino_t ino,
	46	uint flags, uint lock_flags, xfs_inode_t **ipp);
	47
638f4416 DC	48	/* recovery needs direct inode allocation capability */
	49	struct xfs_inode * xfs_inode_alloc(struct xfs_mount *mp, xfs_ino_t ino);
	50	void xfs_inode_free(struct xfs_inode *ip);
	51
33c7a2bc	52	void xfs_reclaim_worker(struct work_struct *work);
a167b17e	53
abc10647	54	int xfs_reclaim_inodes(struct xfs_mount *mp, int mode);
8daaa831	55	int xfs_reclaim_inodes_count(struct xfs_mount *mp);
0a234c6d	56	long xfs_reclaim_inodes_nr(struct xfs_mount *mp, int nr_to_scan);
fce08f2f	57
396beb85	58	void xfs_inode_set_reclaim_tag(struct xfs_inode *ip);
fe588ed3	59
27b52867 BF	60	void xfs_inode_set_eofblocks_tag(struct xfs_inode *ip);
27b52867 BF	61	void xfs_inode_clear_eofblocks_tag(struct xfs_inode *ip);
8ca149de	62	int xfs_icache_free_eofblocks(struct xfs_mount , struct xfs_eofblocks );
dc06f398	63	int xfs_inode_free_quota_eofblocks(struct xfs_inode *ip);
579b62fa	64	void xfs_eofblocks_worker(struct work_struct *);
fa5a4f57	65	void xfs_queue_eofblocks(struct xfs_mount *);
27b52867	66
83104d44 DW	67	void xfs_inode_set_cowblocks_tag(struct xfs_inode *ip);
	68	void xfs_inode_clear_cowblocks_tag(struct xfs_inode *ip);
	69	int xfs_icache_free_cowblocks(struct xfs_mount , struct xfs_eofblocks );
	70	int xfs_inode_free_quota_cowblocks(struct xfs_inode *ip);
	71	void xfs_cowblocks_worker(struct work_struct *);
10ddf64e	72	void xfs_queue_cowblocks(struct xfs_mount *);
83104d44	73
fe588ed3	74	int xfs_inode_ag_iterator(struct xfs_mount *mp,
e0094008	75	int (execute)(struct xfs_inode ip, int flags, void *args),
a454f742	76	int flags, void *args);
ae2c4ac2 BF	77	int xfs_inode_ag_iterator_flags(struct xfs_mount *mp,
	78	int (execute)(struct xfs_inode ip, int flags, void *args),
	79	int flags, void *args, int iter_flags);
a454f742	80	int xfs_inode_ag_iterator_tag(struct xfs_mount *mp,
e0094008	81	int (execute)(struct xfs_inode ip, int flags, void *args),
a454f742	82	int flags, void *args, int tag);
9bf729c0	83
b9fe5052 DE	84	static inline int
	85	xfs_fs_eofblocks_from_user(
	86	struct xfs_fs_eofblocks *src,
	87	struct xfs_eofblocks *dst)
	88	{
	89	if (src->eof_version != XFS_EOFBLOCKS_VERSION)
2451337d	90	return -EINVAL;
b9fe5052 DE	91
b9fe5052 DE	92	if (src->eof_flags & ~XFS_EOF_FLAGS_VALID)
2451337d	93	return -EINVAL;
b9fe5052 DE	94
	95	if (memchr_inv(&src->pad32, 0, sizeof(src->pad32)) \|\|
	96	memchr_inv(src->pad64, 0, sizeof(src->pad64)))
2451337d	97	return -EINVAL;
b9fe5052 DE	98
	99	dst->eof_flags = src->eof_flags;
	100	dst->eof_prid = src->eof_prid;
	101	dst->eof_min_file_size = src->eof_min_file_size;
	102
	103	dst->eof_uid = INVALID_UID;
	104	if (src->eof_flags & XFS_EOF_FLAGS_UID) {
	105	dst->eof_uid = make_kuid(current_user_ns(), src->eof_uid);
	106	if (!uid_valid(dst->eof_uid))
2451337d	107	return -EINVAL;
b9fe5052 DE	108	}
	109
	110	dst->eof_gid = INVALID_GID;
	111	if (src->eof_flags & XFS_EOF_FLAGS_GID) {
	112	dst->eof_gid = make_kgid(current_user_ns(), src->eof_gid);
	113	if (!gid_valid(dst->eof_gid))
2451337d	114	return -EINVAL;
b9fe5052 DE	115	}
	116	return 0;
	117	}
	118
378f681c DW	119	int xfs_icache_inode_is_allocated(struct xfs_mount mp, struct xfs_trans tp,
	120	xfs_ino_t ino, bool *inuse);
	121
d6b636eb DW	122	void xfs_icache_disable_reclaim(struct xfs_mount *mp);
	123	void xfs_icache_enable_reclaim(struct xfs_mount *mp);
	124
fe4fa4b8	125	#endif