[mirror_ubuntu-bionic-kernel.git] / fs / ocfs2 / inode.h

/* -*- 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.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 021110-1307, USA.
 */

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