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