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