[linux-2.6-block.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

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

	struct ocfs2_lock_res		ip_rw_lockres;
	struct ocfs2_lock_res		ip_meta_lockres;
	struct ocfs2_lock_res		ip_data_lockres;
	struct ocfs2_lock_res		ip_open_lockres;

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

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

	struct mutex			ip_io_mutex;

	u32				ip_flags; /* see below */
	u32				ip_attr; /* inode attributes */

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

	u32				ip_dir_start_lookup;

	/* next two are protected by trans_inc_lock */
	/* which transaction were we created on? Zero if none. */
	unsigned long			ip_created_trans;
	/* last transaction we were a part of. */
	unsigned long			ip_last_trans;

	struct ocfs2_caching_info	ip_metadata_cache;

	struct inode			vfs_inode;
};

/*
 * 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
/* Another node is deleting, so our delete is a nop */
#define OCFS2_INODE_SKIP_DELETE		0x00000010
/* 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	0x00000020
/* Does someone have the file open O_DIRECT */
#define OCFS2_INODE_OPEN_DIRECT		0x00000040
/* Indicates that the metadata cache should be used as an array. */
#define OCFS2_INODE_CACHE_INLINE	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 struct kmem_cache *ocfs2_inode_cache;

extern const struct address_space_operations ocfs2_aops;

struct buffer_head *ocfs2_bread(struct inode *inode, int block,
				int *err, int reada);
void ocfs2_clear_inode(struct inode *inode);
void ocfs2_delete_inode(struct inode *inode);
void ocfs2_drop_inode(struct inode *inode);

/* Flags for ocfs2_iget() */
#define OCFS2_FI_FLAG_SYSFILE		0x4
#define OCFS2_FI_FLAG_ORPHAN_RECOVERY	0x8
struct inode *ocfs2_iget(struct ocfs2_super *osb, u64 feoff, int flags);
int ocfs2_inode_init_private(struct inode *inode);
int ocfs2_inode_revalidate(struct dentry *dentry);
int ocfs2_populate_inode(struct inode *inode, struct ocfs2_dinode *fe,
			 int create_ino);
void ocfs2_read_inode(struct inode *inode);
void ocfs2_read_inode2(struct inode *inode, void *opaque);
ssize_t ocfs2_rw_direct(int rw, struct file *filp, char *buf,
			size_t size, loff_t *offp);
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);
int ocfs2_aio_read(struct file *file, struct kiocb *req, struct iocb *iocb);
int ocfs2_aio_write(struct file *file, struct kiocb *req, struct iocb *iocb);

void ocfs2_set_inode_flags(struct inode *inode);

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);
}

#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
	29	/* OCFS2 Inode Private Data */
	30	struct ocfs2_inode_info
	31	{
	32	u64 ip_blkno;
	33
	34	struct ocfs2_lock_res ip_rw_lockres;
	35	struct ocfs2_lock_res ip_meta_lockres;
	36	struct ocfs2_lock_res ip_data_lockres;
50008630	37	struct ocfs2_lock_res ip_open_lockres;
ccd979bd MF	38
	39	/* protects allocation changes on this inode. */
	40	struct rw_semaphore ip_alloc_sem;
	41
	42	/* These fields are protected by ip_lock */
	43	spinlock_t ip_lock;
	44	u32 ip_open_count;
	45	u32 ip_clusters;
ccd979bd	46	struct list_head ip_io_markers;
ccd979bd	47
251b6ecc	48	struct mutex ip_io_mutex;
ccd979bd	49
ccd979bd	50	u32 ip_flags; /* see below */
ca4d147e	51	u32 ip_attr; /* inode attributes */
ccd979bd MF	52
	53	/* protected by recovery_lock. */
	54	struct inode *ip_next_orphan;
	55
	56	u32 ip_dir_start_lookup;
	57
	58	/* next two are protected by trans_inc_lock */
	59	/* which transaction were we created on? Zero if none. */
	60	unsigned long ip_created_trans;
	61	/* last transaction we were a part of. */
	62	unsigned long ip_last_trans;
	63
	64	struct ocfs2_caching_info ip_metadata_cache;
	65
	66	struct inode vfs_inode;
	67	};
	68
	69	/*
	70	* Flags for the ip_flags field
	71	*/
	72	/* System file inodes */
	73	#define OCFS2_INODE_SYSTEM_FILE 0x00000001
	74	#define OCFS2_INODE_JOURNAL 0x00000002
	75	#define OCFS2_INODE_BITMAP 0x00000004
	76	/* This inode has been wiped from disk */
	77	#define OCFS2_INODE_DELETED 0x00000008
	78	/* Another node is deleting, so our delete is a nop */
	79	#define OCFS2_INODE_SKIP_DELETE 0x00000010
	80	/* Has the inode been orphaned on another node?
	81	*
	82	* This hints to ocfs2_drop_inode that it should clear i_nlink before
	83	* continuing.
	84	*
	85	* We only set this on unlink vote from another node. If the inode
	86	* was locally orphaned, then we're sure of the state and don't need
	87	* to twiddle i_nlink later - it's either zero or not depending on
	88	* whether our unlink succeeded. Otherwise we got this from a node
	89	* whose intention was to orphan the inode, however he may have
	90	* crashed, failed etc, so we let ocfs2_drop_inode zero the value and
	91	* rely on ocfs2_delete_inode to sort things out under the proper
	92	* cluster locks.
	93	*/
	94	#define OCFS2_INODE_MAYBE_ORPHANED 0x00000020
	95	/* Does someone have the file open O_DIRECT */
	96	#define OCFS2_INODE_OPEN_DIRECT 0x00000040
	97	/* Indicates that the metadata cache should be used as an array. */
	98	#define OCFS2_INODE_CACHE_INLINE 0x00000080
	99
	100	static inline struct ocfs2_inode_info OCFS2_I(struct inode inode)
	101	{
	102	return container_of(inode, struct ocfs2_inode_info, vfs_inode);
	103	}
	104
	105	#define INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags & OCFS2_INODE_JOURNAL)
	106	#define SET_INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags \|= OCFS2_INODE_JOURNAL)
	107
e18b890b	108	extern struct kmem_cache *ocfs2_inode_cache;
ccd979bd	109
f5e54d6e	110	extern const struct address_space_operations ocfs2_aops;
ccd979bd MF	111
	112	struct buffer_head ocfs2_bread(struct inode inode, int block,
	113	int *err, int reada);
	114	void ocfs2_clear_inode(struct inode *inode);
	115	void ocfs2_delete_inode(struct inode *inode);
	116	void ocfs2_drop_inode(struct inode *inode);
24c19ef4 MF	117
24c19ef4 MF	118	/* Flags for ocfs2_iget() */
50008630 TY	119	#define OCFS2_FI_FLAG_SYSFILE 0x4
50008630 TY	120	#define OCFS2_FI_FLAG_ORPHAN_RECOVERY 0x8
24c19ef4	121	struct inode ocfs2_iget(struct ocfs2_super osb, u64 feoff, int flags);
ccd979bd MF	122	int ocfs2_inode_init_private(struct inode *inode);
	123	int ocfs2_inode_revalidate(struct dentry *dentry);
	124	int ocfs2_populate_inode(struct inode inode, struct ocfs2_dinode fe,
	125	int create_ino);
	126	void ocfs2_read_inode(struct inode *inode);
	127	void ocfs2_read_inode2(struct inode inode, void opaque);
	128	ssize_t ocfs2_rw_direct(int rw, struct file filp, char buf,
	129	size_t size, loff_t *offp);
	130	void ocfs2_sync_blockdev(struct super_block *sb);
	131	void ocfs2_refresh_inode(struct inode *inode,
	132	struct ocfs2_dinode *fe);
1fabe148	133	int ocfs2_mark_inode_dirty(handle_t *handle,
ccd979bd MF	134	struct inode *inode,
	135	struct buffer_head *bh);
	136	int ocfs2_aio_read(struct file file, struct kiocb req, struct iocb *iocb);
	137	int ocfs2_aio_write(struct file file, struct kiocb req, struct iocb *iocb);
	138
ca4d147e HP	139	void ocfs2_set_inode_flags(struct inode *inode);
ca4d147e HP	140
8110b073 MF	141	static inline blkcnt_t ocfs2_inode_sector_count(struct inode *inode)
	142	{
	143	int c_to_s_bits = OCFS2_SB(inode->i_sb)->s_clustersize_bits - 9;
	144
	145	return (blkcnt_t)(OCFS2_I(inode)->ip_clusters << c_to_s_bits);
	146	}
	147
ccd979bd	148	#endif /* OCFS2_INODE_H */