xref: /openbmc/linux/fs/ocfs2/inode.h (revision b627b4ed)
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 	u32				ip_clusters;
50 	struct list_head		ip_io_markers;
51 
52 	struct mutex			ip_io_mutex;
53 
54 	u32				ip_flags; /* see below */
55 	u32				ip_attr; /* inode attributes */
56 	u16				ip_dyn_features;
57 
58 	/* protected by recovery_lock. */
59 	struct inode			*ip_next_orphan;
60 
61 	u32				ip_dir_start_lookup;
62 
63 	/* next two are protected by trans_inc_lock */
64 	/* which transaction were we created on? Zero if none. */
65 	unsigned long			ip_created_trans;
66 	/* last transaction we were a part of. */
67 	unsigned long			ip_last_trans;
68 
69 	struct ocfs2_caching_info	ip_metadata_cache;
70 
71 	struct ocfs2_extent_map		ip_extent_map;
72 
73 	struct inode			vfs_inode;
74 	struct jbd2_inode		ip_jinode;
75 
76 	/* Only valid if the inode is the dir. */
77 	u32				ip_last_used_slot;
78 	u64				ip_last_used_group;
79 };
80 
81 /*
82  * Flags for the ip_flags field
83  */
84 /* System file inodes  */
85 #define OCFS2_INODE_SYSTEM_FILE		0x00000001
86 #define OCFS2_INODE_JOURNAL		0x00000002
87 #define OCFS2_INODE_BITMAP		0x00000004
88 /* This inode has been wiped from disk */
89 #define OCFS2_INODE_DELETED		0x00000008
90 /* Another node is deleting, so our delete is a nop */
91 #define OCFS2_INODE_SKIP_DELETE		0x00000010
92 /* Has the inode been orphaned on another node?
93  *
94  * This hints to ocfs2_drop_inode that it should clear i_nlink before
95  * continuing.
96  *
97  * We *only* set this on unlink vote from another node. If the inode
98  * was locally orphaned, then we're sure of the state and don't need
99  * to twiddle i_nlink later - it's either zero or not depending on
100  * whether our unlink succeeded. Otherwise we got this from a node
101  * whose intention was to orphan the inode, however he may have
102  * crashed, failed etc, so we let ocfs2_drop_inode zero the value and
103  * rely on ocfs2_delete_inode to sort things out under the proper
104  * cluster locks.
105  */
106 #define OCFS2_INODE_MAYBE_ORPHANED	0x00000020
107 /* Does someone have the file open O_DIRECT */
108 #define OCFS2_INODE_OPEN_DIRECT		0x00000040
109 /* Indicates that the metadata cache should be used as an array. */
110 #define OCFS2_INODE_CACHE_INLINE	0x00000080
111 
112 static inline struct ocfs2_inode_info *OCFS2_I(struct inode *inode)
113 {
114 	return container_of(inode, struct ocfs2_inode_info, vfs_inode);
115 }
116 
117 #define INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags & OCFS2_INODE_JOURNAL)
118 #define SET_INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags |= OCFS2_INODE_JOURNAL)
119 
120 extern struct kmem_cache *ocfs2_inode_cache;
121 
122 extern const struct address_space_operations ocfs2_aops;
123 
124 void ocfs2_clear_inode(struct inode *inode);
125 void ocfs2_delete_inode(struct inode *inode);
126 void ocfs2_drop_inode(struct inode *inode);
127 
128 /* Flags for ocfs2_iget() */
129 #define OCFS2_FI_FLAG_SYSFILE		0x1
130 #define OCFS2_FI_FLAG_ORPHAN_RECOVERY	0x2
131 struct inode *ocfs2_ilookup(struct super_block *sb, u64 feoff);
132 struct inode *ocfs2_iget(struct ocfs2_super *osb, u64 feoff, unsigned flags,
133 			 int sysfile_type);
134 int ocfs2_inode_init_private(struct inode *inode);
135 int ocfs2_inode_revalidate(struct dentry *dentry);
136 void ocfs2_populate_inode(struct inode *inode, struct ocfs2_dinode *fe,
137 			  int create_ino);
138 void ocfs2_read_inode(struct inode *inode);
139 void ocfs2_read_inode2(struct inode *inode, void *opaque);
140 ssize_t ocfs2_rw_direct(int rw, struct file *filp, char *buf,
141 			size_t size, loff_t *offp);
142 void ocfs2_sync_blockdev(struct super_block *sb);
143 void ocfs2_refresh_inode(struct inode *inode,
144 			 struct ocfs2_dinode *fe);
145 int ocfs2_mark_inode_dirty(handle_t *handle,
146 			   struct inode *inode,
147 			   struct buffer_head *bh);
148 int ocfs2_aio_read(struct file *file, struct kiocb *req, struct iocb *iocb);
149 int ocfs2_aio_write(struct file *file, struct kiocb *req, struct iocb *iocb);
150 struct buffer_head *ocfs2_bread(struct inode *inode,
151 				int block, int *err, int reada);
152 
153 void ocfs2_set_inode_flags(struct inode *inode);
154 void ocfs2_get_inode_flags(struct ocfs2_inode_info *oi);
155 
156 static inline blkcnt_t ocfs2_inode_sector_count(struct inode *inode)
157 {
158 	int c_to_s_bits = OCFS2_SB(inode->i_sb)->s_clustersize_bits - 9;
159 
160 	return (blkcnt_t)(OCFS2_I(inode)->ip_clusters << c_to_s_bits);
161 }
162 
163 /* Validate that a bh contains a valid inode */
164 int ocfs2_validate_inode_block(struct super_block *sb,
165 			       struct buffer_head *bh);
166 /*
167  * Read an inode block into *bh.  If *bh is NULL, a bh will be allocated.
168  * This is a cached read.  The inode will be validated with
169  * ocfs2_validate_inode_block().
170  */
171 int ocfs2_read_inode_block(struct inode *inode, struct buffer_head **bh);
172 /* The same, but can be passed OCFS2_BH_* flags */
173 int ocfs2_read_inode_block_full(struct inode *inode, struct buffer_head **bh,
174 				int flags);
175 #endif /* OCFS2_INODE_H */
176