xref: /openbmc/linux/fs/ocfs2/inode.h (revision 0edbfea5)
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 #include "extent_map.h"
30 
31 /* OCFS2 Inode Private Data */
32 struct ocfs2_inode_info
33 {
34 	u64			ip_blkno;
35 
36 	struct ocfs2_lock_res		ip_rw_lockres;
37 	struct ocfs2_lock_res		ip_inode_lockres;
38 	struct ocfs2_lock_res		ip_open_lockres;
39 
40 	/* protects allocation changes on this inode. */
41 	struct rw_semaphore		ip_alloc_sem;
42 
43 	/* protects extended attribute changes on this inode */
44 	struct rw_semaphore		ip_xattr_sem;
45 
46 	/* These fields are protected by ip_lock */
47 	spinlock_t			ip_lock;
48 	u32				ip_open_count;
49 	struct list_head		ip_io_markers;
50 	u32				ip_clusters;
51 
52 	u16				ip_dyn_features;
53 	struct mutex			ip_io_mutex;
54 	u32				ip_flags; /* see below */
55 	u32				ip_attr; /* inode attributes */
56 
57 	/* Record unwritten extents during direct io. */
58 	struct list_head		ip_unwritten_list;
59 
60 	/* protected by recovery_lock. */
61 	struct inode			*ip_next_orphan;
62 
63 	struct ocfs2_caching_info	ip_metadata_cache;
64 	struct ocfs2_extent_map		ip_extent_map;
65 	struct inode			vfs_inode;
66 	struct jbd2_inode		ip_jinode;
67 
68 	u32				ip_dir_start_lookup;
69 
70 	/* Only valid if the inode is the dir. */
71 	u32				ip_last_used_slot;
72 	u64				ip_last_used_group;
73 	u32				ip_dir_lock_gen;
74 
75 	struct ocfs2_alloc_reservation	ip_la_data_resv;
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;
83 
84 	struct dquot *i_dquot[MAXQUOTAS];
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
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  */
110 #define OCFS2_INODE_MAYBE_ORPHANED	0x00000010
111 /* Does someone have the file open O_DIRECT */
112 #define OCFS2_INODE_OPEN_DIRECT		0x00000020
113 /* Tell the inode wipe code it's not in orphan dir */
114 #define OCFS2_INODE_SKIP_ORPHAN_DIR     0x00000040
115 /* Entry in orphan dir with 'dio-' prefix */
116 #define OCFS2_INODE_DIO_ORPHAN_ENTRY	0x00000080
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 
126 extern struct kmem_cache *ocfs2_inode_cache;
127 
128 extern const struct address_space_operations ocfs2_aops;
129 extern const struct ocfs2_caching_operations ocfs2_inode_caching_ops;
130 
131 static inline struct ocfs2_caching_info *INODE_CACHE(struct inode *inode)
132 {
133 	return &OCFS2_I(inode)->ip_metadata_cache;
134 }
135 
136 void ocfs2_evict_inode(struct inode *inode);
137 int ocfs2_drop_inode(struct inode *inode);
138 
139 /* Flags for ocfs2_iget() */
140 #define OCFS2_FI_FLAG_SYSFILE		0x1
141 #define OCFS2_FI_FLAG_ORPHAN_RECOVERY	0x2
142 #define OCFS2_FI_FLAG_FILECHECK_CHK	0x4
143 #define OCFS2_FI_FLAG_FILECHECK_FIX	0x8
144 
145 struct inode *ocfs2_ilookup(struct super_block *sb, u64 feoff);
146 struct inode *ocfs2_iget(struct ocfs2_super *osb, u64 feoff, unsigned flags,
147 			 int sysfile_type);
148 int ocfs2_inode_init_private(struct inode *inode);
149 int ocfs2_inode_revalidate(struct dentry *dentry);
150 void ocfs2_populate_inode(struct inode *inode, struct ocfs2_dinode *fe,
151 			  int create_ino);
152 void ocfs2_read_inode(struct inode *inode);
153 void ocfs2_read_inode2(struct inode *inode, void *opaque);
154 ssize_t ocfs2_rw_direct(int rw, struct file *filp, char *buf,
155 			size_t size, loff_t *offp);
156 void ocfs2_sync_blockdev(struct super_block *sb);
157 void ocfs2_refresh_inode(struct inode *inode,
158 			 struct ocfs2_dinode *fe);
159 int ocfs2_mark_inode_dirty(handle_t *handle,
160 			   struct inode *inode,
161 			   struct buffer_head *bh);
162 struct buffer_head *ocfs2_bread(struct inode *inode,
163 				int block, int *err, int reada);
164 
165 void ocfs2_set_inode_flags(struct inode *inode);
166 void ocfs2_get_inode_flags(struct ocfs2_inode_info *oi);
167 
168 static inline blkcnt_t ocfs2_inode_sector_count(struct inode *inode)
169 {
170 	int c_to_s_bits = OCFS2_SB(inode->i_sb)->s_clustersize_bits - 9;
171 
172 	return (blkcnt_t)OCFS2_I(inode)->ip_clusters << c_to_s_bits;
173 }
174 
175 /* Validate that a bh contains a valid inode */
176 int ocfs2_validate_inode_block(struct super_block *sb,
177 			       struct buffer_head *bh);
178 /*
179  * Read an inode block into *bh.  If *bh is NULL, a bh will be allocated.
180  * This is a cached read.  The inode will be validated with
181  * ocfs2_validate_inode_block().
182  */
183 int ocfs2_read_inode_block(struct inode *inode, struct buffer_head **bh);
184 /* The same, but can be passed OCFS2_BH_* flags */
185 int ocfs2_read_inode_block_full(struct inode *inode, struct buffer_head **bh,
186 				int flags);
187 
188 static inline struct ocfs2_inode_info *cache_info_to_inode(struct ocfs2_caching_info *ci)
189 {
190 	return container_of(ci, struct ocfs2_inode_info, ip_metadata_cache);
191 }
192 
193 #endif /* OCFS2_INODE_H */
194