[linux-block.git] / fs / ocfs2 / inode.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/* -*- mode: c; c-basic-offset: 8; -*-
 * vim: noexpandtab sw=8 ts=8 sts=0:
 *
 * inode.h
 *
 * Function prototypes
 *
 * Copyright (C) 2002, 2004 Oracle.  All rights reserved.
 */

#ifndef OCFS2_INODE_H
#define OCFS2_INODE_H

#include "extent_map.h"

/* OCFS2 Inode Private Data */
struct ocfs2_inode_info
{
	u64			ip_blkno;

	struct ocfs2_lock_res		ip_rw_lockres;
	struct ocfs2_lock_res		ip_inode_lockres;
	struct ocfs2_lock_res		ip_open_lockres;

	/* protects allocation changes on this inode. */
	struct rw_semaphore		ip_alloc_sem;

	/* protects extended attribute changes on this inode */
	struct rw_semaphore		ip_xattr_sem;

	/* These fields are protected by ip_lock */
	spinlock_t			ip_lock;
	u32				ip_open_count;
	struct list_head		ip_io_markers;
	u32				ip_clusters;

	u16				ip_dyn_features;
	struct mutex			ip_io_mutex;
	u32				ip_flags; /* see below */
	u32				ip_attr; /* inode attributes */

	/* Record unwritten extents during direct io. */
	struct list_head		ip_unwritten_list;

	/* protected by recovery_lock. */
	struct inode			*ip_next_orphan;

	struct ocfs2_caching_info	ip_metadata_cache;
	struct ocfs2_extent_map		ip_extent_map;
	struct inode			vfs_inode;
	struct jbd2_inode		ip_jinode;

	u32				ip_dir_start_lookup;

	/* Only valid if the inode is the dir. */
	u32				ip_last_used_slot;
	u64				ip_last_used_group;
	u32				ip_dir_lock_gen;

	struct ocfs2_alloc_reservation	ip_la_data_resv;

	/*
	 * Transactions that contain inode's metadata needed to complete
	 * fsync and fdatasync, respectively.
	 */
	tid_t i_sync_tid;
	tid_t i_datasync_tid;

	struct dquot *i_dquot[MAXQUOTAS];
};

/*
 * Flags for the ip_flags field
 */
/* System file inodes  */
#define OCFS2_INODE_SYSTEM_FILE		0x00000001
#define OCFS2_INODE_JOURNAL		0x00000002
#define OCFS2_INODE_BITMAP		0x00000004
/* This inode has been wiped from disk */
#define OCFS2_INODE_DELETED		0x00000008
/* Has the inode been orphaned on another node?
 *
 * This hints to ocfs2_drop_inode that it should clear i_nlink before
 * continuing.
 *
 * We *only* set this on unlink vote from another node. If the inode
 * was locally orphaned, then we're sure of the state and don't need
 * to twiddle i_nlink later - it's either zero or not depending on
 * whether our unlink succeeded. Otherwise we got this from a node
 * whose intention was to orphan the inode, however he may have
 * crashed, failed etc, so we let ocfs2_drop_inode zero the value and
 * rely on ocfs2_delete_inode to sort things out under the proper
 * cluster locks.
 */
#define OCFS2_INODE_MAYBE_ORPHANED	0x00000010
/* Does someone have the file open O_DIRECT */
#define OCFS2_INODE_OPEN_DIRECT		0x00000020
/* Tell the inode wipe code it's not in orphan dir */
#define OCFS2_INODE_SKIP_ORPHAN_DIR     0x00000040
/* Entry in orphan dir with 'dio-' prefix */
#define OCFS2_INODE_DIO_ORPHAN_ENTRY	0x00000080

static inline struct ocfs2_inode_info *OCFS2_I(struct inode *inode)
{
	return container_of(inode, struct ocfs2_inode_info, vfs_inode);
}

#define INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags & OCFS2_INODE_JOURNAL)
#define SET_INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags |= OCFS2_INODE_JOURNAL)

extern const struct address_space_operations ocfs2_aops;
extern const struct ocfs2_caching_operations ocfs2_inode_caching_ops;

static inline struct ocfs2_caching_info *INODE_CACHE(struct inode *inode)
{
	return &OCFS2_I(inode)->ip_metadata_cache;
}

void ocfs2_evict_inode(struct inode *inode);
int ocfs2_drop_inode(struct inode *inode);

/* Flags for ocfs2_iget() */
#define OCFS2_FI_FLAG_SYSFILE		0x1
#define OCFS2_FI_FLAG_ORPHAN_RECOVERY	0x2
#define OCFS2_FI_FLAG_FILECHECK_CHK	0x4
#define OCFS2_FI_FLAG_FILECHECK_FIX	0x8

struct inode *ocfs2_ilookup(struct super_block *sb, u64 feoff);
struct inode *ocfs2_iget(struct ocfs2_super *osb, u64 feoff, unsigned flags,
			 int sysfile_type);
int ocfs2_inode_revalidate(struct dentry *dentry);
void ocfs2_populate_inode(struct inode *inode, struct ocfs2_dinode *fe,
			  int create_ino);
void ocfs2_sync_blockdev(struct super_block *sb);
void ocfs2_refresh_inode(struct inode *inode,
			 struct ocfs2_dinode *fe);
int ocfs2_mark_inode_dirty(handle_t *handle,
			   struct inode *inode,
			   struct buffer_head *bh);

void ocfs2_set_inode_flags(struct inode *inode);
void ocfs2_get_inode_flags(struct ocfs2_inode_info *oi);

static inline blkcnt_t ocfs2_inode_sector_count(struct inode *inode)
{
	int c_to_s_bits = OCFS2_SB(inode->i_sb)->s_clustersize_bits - 9;

	return (blkcnt_t)OCFS2_I(inode)->ip_clusters << c_to_s_bits;
}

/* Validate that a bh contains a valid inode */
int ocfs2_validate_inode_block(struct super_block *sb,
			       struct buffer_head *bh);
/*
 * Read an inode block into *bh.  If *bh is NULL, a bh will be allocated.
 * This is a cached read.  The inode will be validated with
 * ocfs2_validate_inode_block().
 */
int ocfs2_read_inode_block(struct inode *inode, struct buffer_head **bh);
/* The same, but can be passed OCFS2_BH_* flags */
int ocfs2_read_inode_block_full(struct inode *inode, struct buffer_head **bh,
				int flags);

static inline struct ocfs2_inode_info *cache_info_to_inode(struct ocfs2_caching_info *ci)
{
	return container_of(ci, struct ocfs2_inode_info, ip_metadata_cache);
}

/* Does this inode have the reflink flag set? */
static inline bool ocfs2_is_refcount_inode(struct inode *inode)
{
	return (OCFS2_I(inode)->ip_dyn_features & OCFS2_HAS_REFCOUNT_FL);
}

#endif /* OCFS2_INODE_H */
Commit	Line	Data
328970de	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
ccd979bd MF	2	/* -- mode: c; c-basic-offset: 8; --
	3	* vim: noexpandtab sw=8 ts=8 sts=0:
	4	*
	5	* inode.h
	6	*
	7	* Function prototypes
	8	*
	9	* Copyright (C) 2002, 2004 Oracle. All rights reserved.
ccd979bd MF	10	*/
	11
	12	#ifndef OCFS2_INODE_H
	13	#define OCFS2_INODE_H
	14
83418978 MF	15	#include "extent_map.h"
83418978 MF	16
ccd979bd MF	17	/* OCFS2 Inode Private Data */
	18	struct ocfs2_inode_info
	19	{
	20	u64 ip_blkno;
	21
	22	struct ocfs2_lock_res ip_rw_lockres;
e63aecb6	23	struct ocfs2_lock_res ip_inode_lockres;
50008630	24	struct ocfs2_lock_res ip_open_lockres;
ccd979bd MF	25
	26	/* protects allocation changes on this inode. */
	27	struct rw_semaphore ip_alloc_sem;
	28
cf1d6c76 TY	29	/* protects extended attribute changes on this inode */
	30	struct rw_semaphore ip_xattr_sem;
	31
ccd979bd MF	32	/* These fields are protected by ip_lock */
	33	spinlock_t ip_lock;
	34	u32 ip_open_count;
ccd979bd	35	struct list_head ip_io_markers;
83fd9c7f	36	u32 ip_clusters;
ccd979bd	37
83fd9c7f	38	u16 ip_dyn_features;
251b6ecc	39	struct mutex ip_io_mutex;
ccd979bd	40	u32 ip_flags; /* see below */
ca4d147e	41	u32 ip_attr; /* inode attributes */
ccd979bd	42
4506cfb6 RD	43	/* Record unwritten extents during direct io. */
	44	struct list_head ip_unwritten_list;
	45
ccd979bd MF	46	/* protected by recovery_lock. */
	47	struct inode *ip_next_orphan;
	48
ccd979bd	49	struct ocfs2_caching_info ip_metadata_cache;
83418978	50	struct ocfs2_extent_map ip_extent_map;
ccd979bd	51	struct inode vfs_inode;
2b4e30fb	52	struct jbd2_inode ip_jinode;
13821151	53
83fd9c7f GR	54	u32 ip_dir_start_lookup;
83fd9c7f GR	55
13821151 TM	56	/* Only valid if the inode is the dir. */
	57	u32 ip_last_used_slot;
	58	u64 ip_last_used_group;
5e98d492	59	u32 ip_dir_lock_gen;
4fe370af MF	60
4fe370af MF	61	struct ocfs2_alloc_reservation ip_la_data_resv;
2931cdcb DW	62
	63	/*
	64	* Transactions that contain inode's metadata needed to complete
	65	* fsync and fdatasync, respectively.
	66	*/
	67	tid_t i_sync_tid;
	68	tid_t i_datasync_tid;
1c92ec67 JK	69
1c92ec67 JK	70	struct dquot *i_dquot[MAXQUOTAS];
ccd979bd MF	71	};
	72
	73	/*
	74	* Flags for the ip_flags field
	75	*/
	76	/* System file inodes */
	77	#define OCFS2_INODE_SYSTEM_FILE 0x00000001
	78	#define OCFS2_INODE_JOURNAL 0x00000002
	79	#define OCFS2_INODE_BITMAP 0x00000004
	80	/* This inode has been wiped from disk */
	81	#define OCFS2_INODE_DELETED 0x00000008
ccd979bd MF	82	/* Has the inode been orphaned on another node?
	83	*
	84	* This hints to ocfs2_drop_inode that it should clear i_nlink before
	85	* continuing.
	86	*
	87	* We only set this on unlink vote from another node. If the inode
	88	* was locally orphaned, then we're sure of the state and don't need
	89	* to twiddle i_nlink later - it's either zero or not depending on
	90	* whether our unlink succeeded. Otherwise we got this from a node
	91	* whose intention was to orphan the inode, however he may have
	92	* crashed, failed etc, so we let ocfs2_drop_inode zero the value and
	93	* rely on ocfs2_delete_inode to sort things out under the proper
	94	* cluster locks.
	95	*/
7bf619c1	96	#define OCFS2_INODE_MAYBE_ORPHANED 0x00000010
ccd979bd	97	/* Does someone have the file open O_DIRECT */
7bf619c1	98	#define OCFS2_INODE_OPEN_DIRECT 0x00000020
d4cd1871	99	/* Tell the inode wipe code it's not in orphan dir */
7bf619c1	100	#define OCFS2_INODE_SKIP_ORPHAN_DIR 0x00000040
93d911fc JQ	101	/* Entry in orphan dir with 'dio-' prefix */
93d911fc JQ	102	#define OCFS2_INODE_DIO_ORPHAN_ENTRY 0x00000080
ccd979bd MF	103
	104	static inline struct ocfs2_inode_info OCFS2_I(struct inode inode)
	105	{
	106	return container_of(inode, struct ocfs2_inode_info, vfs_inode);
	107	}
	108
	109	#define INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags & OCFS2_INODE_JOURNAL)
	110	#define SET_INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags \|= OCFS2_INODE_JOURNAL)
	111
f5e54d6e	112	extern const struct address_space_operations ocfs2_aops;
6e5a3d75	113	extern const struct ocfs2_caching_operations ocfs2_inode_caching_ops;
ccd979bd	114
8cb471e8 JB	115	static inline struct ocfs2_caching_info INODE_CACHE(struct inode inode)
	116	{
	117	return &OCFS2_I(inode)->ip_metadata_cache;
	118	}
	119
066d92dc	120	void ocfs2_evict_inode(struct inode *inode);
45321ac5	121	int ocfs2_drop_inode(struct inode *inode);
24c19ef4 MF	122
24c19ef4 MF	123	/* Flags for ocfs2_iget() */
5fa0613e JK	124	#define OCFS2_FI_FLAG_SYSFILE 0x1
5fa0613e JK	125	#define OCFS2_FI_FLAG_ORPHAN_RECOVERY 0x2
a860f6eb GH	126	#define OCFS2_FI_FLAG_FILECHECK_CHK 0x4
	127	#define OCFS2_FI_FLAG_FILECHECK_FIX 0x8
	128
6ca497a8	129	struct inode ocfs2_ilookup(struct super_block sb, u64 feoff);
5fa0613e JK	130	struct inode ocfs2_iget(struct ocfs2_super osb, u64 feoff, unsigned flags,
5fa0613e JK	131	int sysfile_type);
ccd979bd	132	int ocfs2_inode_revalidate(struct dentry *dentry);
b657c95c JB	133	void ocfs2_populate_inode(struct inode inode, struct ocfs2_dinode fe,
b657c95c JB	134	int create_ino);
ccd979bd MF	135	void ocfs2_sync_blockdev(struct super_block *sb);
	136	void ocfs2_refresh_inode(struct inode *inode,
	137	struct ocfs2_dinode *fe);
1fabe148	138	int ocfs2_mark_inode_dirty(handle_t *handle,
ccd979bd MF	139	struct inode *inode,
ccd979bd MF	140	struct buffer_head *bh);
ccd979bd	141
ca4d147e	142	void ocfs2_set_inode_flags(struct inode *inode);
6e4b0d56	143	void ocfs2_get_inode_flags(struct ocfs2_inode_info *oi);
ca4d147e	144
8110b073 MF	145	static inline blkcnt_t ocfs2_inode_sector_count(struct inode *inode)
	146	{
	147	int c_to_s_bits = OCFS2_SB(inode->i_sb)->s_clustersize_bits - 9;
	148
7fa05c6e	149	return (blkcnt_t)OCFS2_I(inode)->ip_clusters << c_to_s_bits;
8110b073 MF	150	}
8110b073 MF	151
b657c95c JB	152	/* Validate that a bh contains a valid inode */
	153	int ocfs2_validate_inode_block(struct super_block *sb,
	154	struct buffer_head *bh);
	155	/*
	156	* Read an inode block into bh. If bh is NULL, a bh will be allocated.
	157	* This is a cached read. The inode will be validated with
	158	* ocfs2_validate_inode_block().
	159	*/
	160	int ocfs2_read_inode_block(struct inode inode, struct buffer_head *bh);
	161	/* The same, but can be passed OCFS2_BH_* flags */
	162	int ocfs2_read_inode_block_full(struct inode inode, struct buffer_head *bh,
	163	int flags);
6136ca5f JB	164
	165	static inline struct ocfs2_inode_info cache_info_to_inode(struct ocfs2_caching_info ci)
	166	{
	167	return container_of(ci, struct ocfs2_inode_info, ip_metadata_cache);
	168	}
	169
84e40080 DW	170	/* Does this inode have the reflink flag set? */
	171	static inline bool ocfs2_is_refcount_inode(struct inode *inode)
	172	{
	173	return (OCFS2_I(inode)->ip_dyn_features & OCFS2_HAS_REFCOUNT_FL);
	174	}
	175
ccd979bd	176	#endif /* OCFS2_INODE_H */