Loading...
1/*
2 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
7 * published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope that it would be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write the Free Software Foundation,
16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17 */
18#ifndef __XFS_INODE_H__
19#define __XFS_INODE_H__
20
21#include "xfs_inode_buf.h"
22#include "xfs_inode_fork.h"
23#include "xfs_dinode.h"
24
25/*
26 * Kernel only inode definitions
27 */
28struct xfs_dinode;
29struct xfs_inode;
30struct xfs_buf;
31struct xfs_bmap_free;
32struct xfs_bmbt_irec;
33struct xfs_inode_log_item;
34struct xfs_mount;
35struct xfs_trans;
36struct xfs_dquot;
37
38typedef struct xfs_inode {
39 /* Inode linking and identification information. */
40 struct xfs_mount *i_mount; /* fs mount struct ptr */
41 struct xfs_dquot *i_udquot; /* user dquot */
42 struct xfs_dquot *i_gdquot; /* group dquot */
43 struct xfs_dquot *i_pdquot; /* project dquot */
44
45 /* Inode location stuff */
46 xfs_ino_t i_ino; /* inode number (agno/agino)*/
47 struct xfs_imap i_imap; /* location for xfs_imap() */
48
49 /* Extent information. */
50 xfs_ifork_t *i_afp; /* attribute fork pointer */
51 xfs_ifork_t i_df; /* data fork */
52
53 /* operations vectors */
54 const struct xfs_dir_ops *d_ops; /* directory ops vector */
55
56 /* Transaction and locking information. */
57 struct xfs_inode_log_item *i_itemp; /* logging information */
58 mrlock_t i_lock; /* inode lock */
59 mrlock_t i_iolock; /* inode IO lock */
60 atomic_t i_pincount; /* inode pin count */
61 spinlock_t i_flags_lock; /* inode i_flags lock */
62 /* Miscellaneous state. */
63 unsigned long i_flags; /* see defined flags below */
64 unsigned int i_delayed_blks; /* count of delay alloc blks */
65
66 xfs_icdinode_t i_d; /* most of ondisk inode */
67
68 /* VFS inode */
69 struct inode i_vnode; /* embedded VFS inode */
70} xfs_inode_t;
71
72/* Convert from vfs inode to xfs inode */
73static inline struct xfs_inode *XFS_I(struct inode *inode)
74{
75 return container_of(inode, struct xfs_inode, i_vnode);
76}
77
78/* convert from xfs inode to vfs inode */
79static inline struct inode *VFS_I(struct xfs_inode *ip)
80{
81 return &ip->i_vnode;
82}
83
84/*
85 * For regular files we only update the on-disk filesize when actually
86 * writing data back to disk. Until then only the copy in the VFS inode
87 * is uptodate.
88 */
89static inline xfs_fsize_t XFS_ISIZE(struct xfs_inode *ip)
90{
91 if (S_ISREG(ip->i_d.di_mode))
92 return i_size_read(VFS_I(ip));
93 return ip->i_d.di_size;
94}
95
96/*
97 * If this I/O goes past the on-disk inode size update it unless it would
98 * be past the current in-core inode size.
99 */
100static inline xfs_fsize_t
101xfs_new_eof(struct xfs_inode *ip, xfs_fsize_t new_size)
102{
103 xfs_fsize_t i_size = i_size_read(VFS_I(ip));
104
105 if (new_size > i_size)
106 new_size = i_size;
107 return new_size > ip->i_d.di_size ? new_size : 0;
108}
109
110/*
111 * i_flags helper functions
112 */
113static inline void
114__xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
115{
116 ip->i_flags |= flags;
117}
118
119static inline void
120xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
121{
122 spin_lock(&ip->i_flags_lock);
123 __xfs_iflags_set(ip, flags);
124 spin_unlock(&ip->i_flags_lock);
125}
126
127static inline void
128xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags)
129{
130 spin_lock(&ip->i_flags_lock);
131 ip->i_flags &= ~flags;
132 spin_unlock(&ip->i_flags_lock);
133}
134
135static inline int
136__xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
137{
138 return (ip->i_flags & flags);
139}
140
141static inline int
142xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
143{
144 int ret;
145 spin_lock(&ip->i_flags_lock);
146 ret = __xfs_iflags_test(ip, flags);
147 spin_unlock(&ip->i_flags_lock);
148 return ret;
149}
150
151static inline int
152xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags)
153{
154 int ret;
155
156 spin_lock(&ip->i_flags_lock);
157 ret = ip->i_flags & flags;
158 if (ret)
159 ip->i_flags &= ~flags;
160 spin_unlock(&ip->i_flags_lock);
161 return ret;
162}
163
164static inline int
165xfs_iflags_test_and_set(xfs_inode_t *ip, unsigned short flags)
166{
167 int ret;
168
169 spin_lock(&ip->i_flags_lock);
170 ret = ip->i_flags & flags;
171 if (!ret)
172 ip->i_flags |= flags;
173 spin_unlock(&ip->i_flags_lock);
174 return ret;
175}
176
177/*
178 * Project quota id helpers (previously projid was 16bit only
179 * and using two 16bit values to hold new 32bit projid was chosen
180 * to retain compatibility with "old" filesystems).
181 */
182static inline prid_t
183xfs_get_projid(struct xfs_inode *ip)
184{
185 return (prid_t)ip->i_d.di_projid_hi << 16 | ip->i_d.di_projid_lo;
186}
187
188static inline void
189xfs_set_projid(struct xfs_inode *ip,
190 prid_t projid)
191{
192 ip->i_d.di_projid_hi = (__uint16_t) (projid >> 16);
193 ip->i_d.di_projid_lo = (__uint16_t) (projid & 0xffff);
194}
195
196static inline prid_t
197xfs_get_initial_prid(struct xfs_inode *dp)
198{
199 if (dp->i_d.di_flags & XFS_DIFLAG_PROJINHERIT)
200 return xfs_get_projid(dp);
201
202 return XFS_PROJID_DEFAULT;
203}
204
205/*
206 * In-core inode flags.
207 */
208#define XFS_IRECLAIM (1 << 0) /* started reclaiming this inode */
209#define XFS_ISTALE (1 << 1) /* inode has been staled */
210#define XFS_IRECLAIMABLE (1 << 2) /* inode can be reclaimed */
211#define XFS_INEW (1 << 3) /* inode has just been allocated */
212#define XFS_IFILESTREAM (1 << 4) /* inode is in a filestream dir. */
213#define XFS_ITRUNCATED (1 << 5) /* truncated down so flush-on-close */
214#define XFS_IDIRTY_RELEASE (1 << 6) /* dirty release already seen */
215#define __XFS_IFLOCK_BIT 7 /* inode is being flushed right now */
216#define XFS_IFLOCK (1 << __XFS_IFLOCK_BIT)
217#define __XFS_IPINNED_BIT 8 /* wakeup key for zero pin count */
218#define XFS_IPINNED (1 << __XFS_IPINNED_BIT)
219#define XFS_IDONTCACHE (1 << 9) /* don't cache the inode long term */
220
221/*
222 * Per-lifetime flags need to be reset when re-using a reclaimable inode during
223 * inode lookup. This prevents unintended behaviour on the new inode from
224 * ocurring.
225 */
226#define XFS_IRECLAIM_RESET_FLAGS \
227 (XFS_IRECLAIMABLE | XFS_IRECLAIM | \
228 XFS_IDIRTY_RELEASE | XFS_ITRUNCATED | \
229 XFS_IFILESTREAM);
230
231/*
232 * Synchronize processes attempting to flush the in-core inode back to disk.
233 */
234
235extern void __xfs_iflock(struct xfs_inode *ip);
236
237static inline int xfs_iflock_nowait(struct xfs_inode *ip)
238{
239 return !xfs_iflags_test_and_set(ip, XFS_IFLOCK);
240}
241
242static inline void xfs_iflock(struct xfs_inode *ip)
243{
244 if (!xfs_iflock_nowait(ip))
245 __xfs_iflock(ip);
246}
247
248static inline void xfs_ifunlock(struct xfs_inode *ip)
249{
250 xfs_iflags_clear(ip, XFS_IFLOCK);
251 smp_mb();
252 wake_up_bit(&ip->i_flags, __XFS_IFLOCK_BIT);
253}
254
255static inline int xfs_isiflocked(struct xfs_inode *ip)
256{
257 return xfs_iflags_test(ip, XFS_IFLOCK);
258}
259
260/*
261 * Flags for inode locking.
262 * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield)
263 * 1<<16 - 1<<32-1 -- lockdep annotation (integers)
264 */
265#define XFS_IOLOCK_EXCL (1<<0)
266#define XFS_IOLOCK_SHARED (1<<1)
267#define XFS_ILOCK_EXCL (1<<2)
268#define XFS_ILOCK_SHARED (1<<3)
269
270#define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
271 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED)
272
273#define XFS_LOCK_FLAGS \
274 { XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \
275 { XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \
276 { XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \
277 { XFS_ILOCK_SHARED, "ILOCK_SHARED" }
278
279
280/*
281 * Flags for lockdep annotations.
282 *
283 * XFS_LOCK_PARENT - for directory operations that require locking a
284 * parent directory inode and a child entry inode. The parent gets locked
285 * with this flag so it gets a lockdep subclass of 1 and the child entry
286 * lock will have a lockdep subclass of 0.
287 *
288 * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
289 * inodes do not participate in the normal lock order, and thus have their
290 * own subclasses.
291 *
292 * XFS_LOCK_INUMORDER - for locking several inodes at the some time
293 * with xfs_lock_inodes(). This flag is used as the starting subclass
294 * and each subsequent lock acquired will increment the subclass by one.
295 * So the first lock acquired will have a lockdep subclass of 4, the
296 * second lock will have a lockdep subclass of 5, and so on. It is
297 * the responsibility of the class builder to shift this to the correct
298 * portion of the lock_mode lockdep mask.
299 */
300#define XFS_LOCK_PARENT 1
301#define XFS_LOCK_RTBITMAP 2
302#define XFS_LOCK_RTSUM 3
303#define XFS_LOCK_INUMORDER 4
304
305#define XFS_IOLOCK_SHIFT 16
306#define XFS_IOLOCK_PARENT (XFS_LOCK_PARENT << XFS_IOLOCK_SHIFT)
307
308#define XFS_ILOCK_SHIFT 24
309#define XFS_ILOCK_PARENT (XFS_LOCK_PARENT << XFS_ILOCK_SHIFT)
310#define XFS_ILOCK_RTBITMAP (XFS_LOCK_RTBITMAP << XFS_ILOCK_SHIFT)
311#define XFS_ILOCK_RTSUM (XFS_LOCK_RTSUM << XFS_ILOCK_SHIFT)
312
313#define XFS_IOLOCK_DEP_MASK 0x00ff0000
314#define XFS_ILOCK_DEP_MASK 0xff000000
315#define XFS_LOCK_DEP_MASK (XFS_IOLOCK_DEP_MASK | XFS_ILOCK_DEP_MASK)
316
317#define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) >> XFS_IOLOCK_SHIFT)
318#define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) >> XFS_ILOCK_SHIFT)
319
320/*
321 * For multiple groups support: if S_ISGID bit is set in the parent
322 * directory, group of new file is set to that of the parent, and
323 * new subdirectory gets S_ISGID bit from parent.
324 */
325#define XFS_INHERIT_GID(pip) \
326 (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \
327 ((pip)->i_d.di_mode & S_ISGID))
328
329
330int xfs_release(struct xfs_inode *ip);
331void xfs_inactive(struct xfs_inode *ip);
332int xfs_lookup(struct xfs_inode *dp, struct xfs_name *name,
333 struct xfs_inode **ipp, struct xfs_name *ci_name);
334int xfs_create(struct xfs_inode *dp, struct xfs_name *name,
335 umode_t mode, xfs_dev_t rdev, struct xfs_inode **ipp);
336int xfs_create_tmpfile(struct xfs_inode *dp, struct dentry *dentry,
337 umode_t mode, struct xfs_inode **ipp);
338int xfs_remove(struct xfs_inode *dp, struct xfs_name *name,
339 struct xfs_inode *ip);
340int xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip,
341 struct xfs_name *target_name);
342int xfs_rename(struct xfs_inode *src_dp, struct xfs_name *src_name,
343 struct xfs_inode *src_ip, struct xfs_inode *target_dp,
344 struct xfs_name *target_name,
345 struct xfs_inode *target_ip);
346
347void xfs_ilock(xfs_inode_t *, uint);
348int xfs_ilock_nowait(xfs_inode_t *, uint);
349void xfs_iunlock(xfs_inode_t *, uint);
350void xfs_ilock_demote(xfs_inode_t *, uint);
351int xfs_isilocked(xfs_inode_t *, uint);
352uint xfs_ilock_data_map_shared(struct xfs_inode *);
353uint xfs_ilock_attr_map_shared(struct xfs_inode *);
354int xfs_ialloc(struct xfs_trans *, xfs_inode_t *, umode_t,
355 xfs_nlink_t, xfs_dev_t, prid_t, int,
356 struct xfs_buf **, xfs_inode_t **);
357
358uint xfs_ip2xflags(struct xfs_inode *);
359uint xfs_dic2xflags(struct xfs_dinode *);
360int xfs_ifree(struct xfs_trans *, xfs_inode_t *,
361 struct xfs_bmap_free *);
362int xfs_itruncate_extents(struct xfs_trans **, struct xfs_inode *,
363 int, xfs_fsize_t);
364int xfs_iunlink(struct xfs_trans *, xfs_inode_t *);
365
366void xfs_iext_realloc(xfs_inode_t *, int, int);
367
368void xfs_iunpin_wait(xfs_inode_t *);
369#define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
370
371int xfs_iflush(struct xfs_inode *, struct xfs_buf **);
372void xfs_lock_inodes(xfs_inode_t **, int, uint);
373void xfs_lock_two_inodes(xfs_inode_t *, xfs_inode_t *, uint);
374
375xfs_extlen_t xfs_get_extsz_hint(struct xfs_inode *ip);
376
377int xfs_dir_ialloc(struct xfs_trans **, struct xfs_inode *, umode_t,
378 xfs_nlink_t, xfs_dev_t, prid_t, int,
379 struct xfs_inode **, int *);
380int xfs_droplink(struct xfs_trans *, struct xfs_inode *);
381int xfs_bumplink(struct xfs_trans *, struct xfs_inode *);
382void xfs_bump_ino_vers2(struct xfs_trans *, struct xfs_inode *);
383
384/* from xfs_file.c */
385int xfs_zero_eof(struct xfs_inode *, xfs_off_t, xfs_fsize_t);
386int xfs_iozero(struct xfs_inode *, loff_t, size_t);
387
388
389#define IHOLD(ip) \
390do { \
391 ASSERT(atomic_read(&VFS_I(ip)->i_count) > 0) ; \
392 ihold(VFS_I(ip)); \
393 trace_xfs_ihold(ip, _THIS_IP_); \
394} while (0)
395
396#define IRELE(ip) \
397do { \
398 trace_xfs_irele(ip, _THIS_IP_); \
399 iput(VFS_I(ip)); \
400} while (0)
401
402extern struct kmem_zone *xfs_inode_zone;
403
404#endif /* __XFS_INODE_H__ */
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
4 * All Rights Reserved.
5 */
6#ifndef __XFS_INODE_H__
7#define __XFS_INODE_H__
8
9#include "xfs_inode_buf.h"
10#include "xfs_inode_fork.h"
11
12/*
13 * Kernel only inode definitions
14 */
15struct xfs_dinode;
16struct xfs_inode;
17struct xfs_buf;
18struct xfs_bmbt_irec;
19struct xfs_inode_log_item;
20struct xfs_mount;
21struct xfs_trans;
22struct xfs_dquot;
23
24typedef struct xfs_inode {
25 /* Inode linking and identification information. */
26 struct xfs_mount *i_mount; /* fs mount struct ptr */
27 struct xfs_dquot *i_udquot; /* user dquot */
28 struct xfs_dquot *i_gdquot; /* group dquot */
29 struct xfs_dquot *i_pdquot; /* project dquot */
30
31 /* Inode location stuff */
32 xfs_ino_t i_ino; /* inode number (agno/agino)*/
33 struct xfs_imap i_imap; /* location for xfs_imap() */
34
35 /* Extent information. */
36 struct xfs_ifork *i_afp; /* attribute fork pointer */
37 struct xfs_ifork *i_cowfp; /* copy on write extents */
38 struct xfs_ifork i_df; /* data fork */
39
40 /* Transaction and locking information. */
41 struct xfs_inode_log_item *i_itemp; /* logging information */
42 mrlock_t i_lock; /* inode lock */
43 mrlock_t i_mmaplock; /* inode mmap IO lock */
44 atomic_t i_pincount; /* inode pin count */
45
46 /*
47 * Bitsets of inode metadata that have been checked and/or are sick.
48 * Callers must hold i_flags_lock before accessing this field.
49 */
50 uint16_t i_checked;
51 uint16_t i_sick;
52
53 spinlock_t i_flags_lock; /* inode i_flags lock */
54 /* Miscellaneous state. */
55 unsigned long i_flags; /* see defined flags below */
56 uint64_t i_delayed_blks; /* count of delay alloc blks */
57
58 struct xfs_icdinode i_d; /* most of ondisk inode */
59
60 /* VFS inode */
61 struct inode i_vnode; /* embedded VFS inode */
62
63 /* pending io completions */
64 spinlock_t i_ioend_lock;
65 struct work_struct i_ioend_work;
66 struct list_head i_ioend_list;
67} xfs_inode_t;
68
69/* Convert from vfs inode to xfs inode */
70static inline struct xfs_inode *XFS_I(struct inode *inode)
71{
72 return container_of(inode, struct xfs_inode, i_vnode);
73}
74
75/* convert from xfs inode to vfs inode */
76static inline struct inode *VFS_I(struct xfs_inode *ip)
77{
78 return &ip->i_vnode;
79}
80
81/*
82 * For regular files we only update the on-disk filesize when actually
83 * writing data back to disk. Until then only the copy in the VFS inode
84 * is uptodate.
85 */
86static inline xfs_fsize_t XFS_ISIZE(struct xfs_inode *ip)
87{
88 if (S_ISREG(VFS_I(ip)->i_mode))
89 return i_size_read(VFS_I(ip));
90 return ip->i_d.di_size;
91}
92
93/*
94 * If this I/O goes past the on-disk inode size update it unless it would
95 * be past the current in-core inode size.
96 */
97static inline xfs_fsize_t
98xfs_new_eof(struct xfs_inode *ip, xfs_fsize_t new_size)
99{
100 xfs_fsize_t i_size = i_size_read(VFS_I(ip));
101
102 if (new_size > i_size || new_size < 0)
103 new_size = i_size;
104 return new_size > ip->i_d.di_size ? new_size : 0;
105}
106
107/*
108 * i_flags helper functions
109 */
110static inline void
111__xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
112{
113 ip->i_flags |= flags;
114}
115
116static inline void
117xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
118{
119 spin_lock(&ip->i_flags_lock);
120 __xfs_iflags_set(ip, flags);
121 spin_unlock(&ip->i_flags_lock);
122}
123
124static inline void
125xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags)
126{
127 spin_lock(&ip->i_flags_lock);
128 ip->i_flags &= ~flags;
129 spin_unlock(&ip->i_flags_lock);
130}
131
132static inline int
133__xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
134{
135 return (ip->i_flags & flags);
136}
137
138static inline int
139xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
140{
141 int ret;
142 spin_lock(&ip->i_flags_lock);
143 ret = __xfs_iflags_test(ip, flags);
144 spin_unlock(&ip->i_flags_lock);
145 return ret;
146}
147
148static inline int
149xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags)
150{
151 int ret;
152
153 spin_lock(&ip->i_flags_lock);
154 ret = ip->i_flags & flags;
155 if (ret)
156 ip->i_flags &= ~flags;
157 spin_unlock(&ip->i_flags_lock);
158 return ret;
159}
160
161static inline int
162xfs_iflags_test_and_set(xfs_inode_t *ip, unsigned short flags)
163{
164 int ret;
165
166 spin_lock(&ip->i_flags_lock);
167 ret = ip->i_flags & flags;
168 if (!ret)
169 ip->i_flags |= flags;
170 spin_unlock(&ip->i_flags_lock);
171 return ret;
172}
173
174static inline prid_t
175xfs_get_initial_prid(struct xfs_inode *dp)
176{
177 if (dp->i_d.di_flags & XFS_DIFLAG_PROJINHERIT)
178 return dp->i_d.di_projid;
179
180 return XFS_PROJID_DEFAULT;
181}
182
183static inline bool xfs_is_reflink_inode(struct xfs_inode *ip)
184{
185 return ip->i_d.di_flags2 & XFS_DIFLAG2_REFLINK;
186}
187
188/*
189 * Check if an inode has any data in the COW fork. This might be often false
190 * even for inodes with the reflink flag when there is no pending COW operation.
191 */
192static inline bool xfs_inode_has_cow_data(struct xfs_inode *ip)
193{
194 return ip->i_cowfp && ip->i_cowfp->if_bytes;
195}
196
197/*
198 * Return the buftarg used for data allocations on a given inode.
199 */
200#define xfs_inode_buftarg(ip) \
201 (XFS_IS_REALTIME_INODE(ip) ? \
202 (ip)->i_mount->m_rtdev_targp : (ip)->i_mount->m_ddev_targp)
203
204/*
205 * In-core inode flags.
206 */
207#define XFS_IRECLAIM (1 << 0) /* started reclaiming this inode */
208#define XFS_ISTALE (1 << 1) /* inode has been staled */
209#define XFS_IRECLAIMABLE (1 << 2) /* inode can be reclaimed */
210#define __XFS_INEW_BIT 3 /* inode has just been allocated */
211#define XFS_INEW (1 << __XFS_INEW_BIT)
212#define XFS_ITRUNCATED (1 << 5) /* truncated down so flush-on-close */
213#define XFS_IDIRTY_RELEASE (1 << 6) /* dirty release already seen */
214#define __XFS_IFLOCK_BIT 7 /* inode is being flushed right now */
215#define XFS_IFLOCK (1 << __XFS_IFLOCK_BIT)
216#define __XFS_IPINNED_BIT 8 /* wakeup key for zero pin count */
217#define XFS_IPINNED (1 << __XFS_IPINNED_BIT)
218#define XFS_IEOFBLOCKS (1 << 9) /* has the preallocblocks tag set */
219/*
220 * If this unlinked inode is in the middle of recovery, don't let drop_inode
221 * truncate and free the inode. This can happen if we iget the inode during
222 * log recovery to replay a bmap operation on the inode.
223 */
224#define XFS_IRECOVERY (1 << 11)
225#define XFS_ICOWBLOCKS (1 << 12)/* has the cowblocks tag set */
226
227/*
228 * Per-lifetime flags need to be reset when re-using a reclaimable inode during
229 * inode lookup. This prevents unintended behaviour on the new inode from
230 * ocurring.
231 */
232#define XFS_IRECLAIM_RESET_FLAGS \
233 (XFS_IRECLAIMABLE | XFS_IRECLAIM | \
234 XFS_IDIRTY_RELEASE | XFS_ITRUNCATED)
235
236/*
237 * Synchronize processes attempting to flush the in-core inode back to disk.
238 */
239
240static inline int xfs_isiflocked(struct xfs_inode *ip)
241{
242 return xfs_iflags_test(ip, XFS_IFLOCK);
243}
244
245extern void __xfs_iflock(struct xfs_inode *ip);
246
247static inline int xfs_iflock_nowait(struct xfs_inode *ip)
248{
249 return !xfs_iflags_test_and_set(ip, XFS_IFLOCK);
250}
251
252static inline void xfs_iflock(struct xfs_inode *ip)
253{
254 if (!xfs_iflock_nowait(ip))
255 __xfs_iflock(ip);
256}
257
258static inline void xfs_ifunlock(struct xfs_inode *ip)
259{
260 ASSERT(xfs_isiflocked(ip));
261 xfs_iflags_clear(ip, XFS_IFLOCK);
262 smp_mb();
263 wake_up_bit(&ip->i_flags, __XFS_IFLOCK_BIT);
264}
265
266/*
267 * Flags for inode locking.
268 * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield)
269 * 1<<16 - 1<<32-1 -- lockdep annotation (integers)
270 */
271#define XFS_IOLOCK_EXCL (1<<0)
272#define XFS_IOLOCK_SHARED (1<<1)
273#define XFS_ILOCK_EXCL (1<<2)
274#define XFS_ILOCK_SHARED (1<<3)
275#define XFS_MMAPLOCK_EXCL (1<<4)
276#define XFS_MMAPLOCK_SHARED (1<<5)
277
278#define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
279 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED \
280 | XFS_MMAPLOCK_EXCL | XFS_MMAPLOCK_SHARED)
281
282#define XFS_LOCK_FLAGS \
283 { XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \
284 { XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \
285 { XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \
286 { XFS_ILOCK_SHARED, "ILOCK_SHARED" }, \
287 { XFS_MMAPLOCK_EXCL, "MMAPLOCK_EXCL" }, \
288 { XFS_MMAPLOCK_SHARED, "MMAPLOCK_SHARED" }
289
290
291/*
292 * Flags for lockdep annotations.
293 *
294 * XFS_LOCK_PARENT - for directory operations that require locking a
295 * parent directory inode and a child entry inode. IOLOCK requires nesting,
296 * MMAPLOCK does not support this class, ILOCK requires a single subclass
297 * to differentiate parent from child.
298 *
299 * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
300 * inodes do not participate in the normal lock order, and thus have their
301 * own subclasses.
302 *
303 * XFS_LOCK_INUMORDER - for locking several inodes at the some time
304 * with xfs_lock_inodes(). This flag is used as the starting subclass
305 * and each subsequent lock acquired will increment the subclass by one.
306 * However, MAX_LOCKDEP_SUBCLASSES == 8, which means we are greatly
307 * limited to the subclasses we can represent via nesting. We need at least
308 * 5 inodes nest depth for the ILOCK through rename, and we also have to support
309 * XFS_ILOCK_PARENT, which gives 6 subclasses. Then we have XFS_ILOCK_RTBITMAP
310 * and XFS_ILOCK_RTSUM, which are another 2 unique subclasses, so that's all
311 * 8 subclasses supported by lockdep.
312 *
313 * This also means we have to number the sub-classes in the lowest bits of
314 * the mask we keep, and we have to ensure we never exceed 3 bits of lockdep
315 * mask and we can't use bit-masking to build the subclasses. What a mess.
316 *
317 * Bit layout:
318 *
319 * Bit Lock Region
320 * 16-19 XFS_IOLOCK_SHIFT dependencies
321 * 20-23 XFS_MMAPLOCK_SHIFT dependencies
322 * 24-31 XFS_ILOCK_SHIFT dependencies
323 *
324 * IOLOCK values
325 *
326 * 0-3 subclass value
327 * 4-7 unused
328 *
329 * MMAPLOCK values
330 *
331 * 0-3 subclass value
332 * 4-7 unused
333 *
334 * ILOCK values
335 * 0-4 subclass values
336 * 5 PARENT subclass (not nestable)
337 * 6 RTBITMAP subclass (not nestable)
338 * 7 RTSUM subclass (not nestable)
339 *
340 */
341#define XFS_IOLOCK_SHIFT 16
342#define XFS_IOLOCK_MAX_SUBCLASS 3
343#define XFS_IOLOCK_DEP_MASK 0x000f0000
344
345#define XFS_MMAPLOCK_SHIFT 20
346#define XFS_MMAPLOCK_NUMORDER 0
347#define XFS_MMAPLOCK_MAX_SUBCLASS 3
348#define XFS_MMAPLOCK_DEP_MASK 0x00f00000
349
350#define XFS_ILOCK_SHIFT 24
351#define XFS_ILOCK_PARENT_VAL 5
352#define XFS_ILOCK_MAX_SUBCLASS (XFS_ILOCK_PARENT_VAL - 1)
353#define XFS_ILOCK_RTBITMAP_VAL 6
354#define XFS_ILOCK_RTSUM_VAL 7
355#define XFS_ILOCK_DEP_MASK 0xff000000
356#define XFS_ILOCK_PARENT (XFS_ILOCK_PARENT_VAL << XFS_ILOCK_SHIFT)
357#define XFS_ILOCK_RTBITMAP (XFS_ILOCK_RTBITMAP_VAL << XFS_ILOCK_SHIFT)
358#define XFS_ILOCK_RTSUM (XFS_ILOCK_RTSUM_VAL << XFS_ILOCK_SHIFT)
359
360#define XFS_LOCK_SUBCLASS_MASK (XFS_IOLOCK_DEP_MASK | \
361 XFS_MMAPLOCK_DEP_MASK | \
362 XFS_ILOCK_DEP_MASK)
363
364#define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) \
365 >> XFS_IOLOCK_SHIFT)
366#define XFS_MMAPLOCK_DEP(flags) (((flags) & XFS_MMAPLOCK_DEP_MASK) \
367 >> XFS_MMAPLOCK_SHIFT)
368#define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) \
369 >> XFS_ILOCK_SHIFT)
370
371/*
372 * Layouts are broken in the BREAK_WRITE case to ensure that
373 * layout-holders do not collide with local writes. Additionally,
374 * layouts are broken in the BREAK_UNMAP case to make sure the
375 * layout-holder has a consistent view of the file's extent map. While
376 * BREAK_WRITE breaks can be satisfied by recalling FL_LAYOUT leases,
377 * BREAK_UNMAP breaks additionally require waiting for busy dax-pages to
378 * go idle.
379 */
380enum layout_break_reason {
381 BREAK_WRITE,
382 BREAK_UNMAP,
383};
384
385/*
386 * For multiple groups support: if S_ISGID bit is set in the parent
387 * directory, group of new file is set to that of the parent, and
388 * new subdirectory gets S_ISGID bit from parent.
389 */
390#define XFS_INHERIT_GID(pip) \
391 (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \
392 (VFS_I(pip)->i_mode & S_ISGID))
393
394int xfs_release(struct xfs_inode *ip);
395void xfs_inactive(struct xfs_inode *ip);
396int xfs_lookup(struct xfs_inode *dp, struct xfs_name *name,
397 struct xfs_inode **ipp, struct xfs_name *ci_name);
398int xfs_create(struct xfs_inode *dp, struct xfs_name *name,
399 umode_t mode, dev_t rdev, struct xfs_inode **ipp);
400int xfs_create_tmpfile(struct xfs_inode *dp, umode_t mode,
401 struct xfs_inode **ipp);
402int xfs_remove(struct xfs_inode *dp, struct xfs_name *name,
403 struct xfs_inode *ip);
404int xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip,
405 struct xfs_name *target_name);
406int xfs_rename(struct xfs_inode *src_dp, struct xfs_name *src_name,
407 struct xfs_inode *src_ip, struct xfs_inode *target_dp,
408 struct xfs_name *target_name,
409 struct xfs_inode *target_ip, unsigned int flags);
410
411void xfs_ilock(xfs_inode_t *, uint);
412int xfs_ilock_nowait(xfs_inode_t *, uint);
413void xfs_iunlock(xfs_inode_t *, uint);
414void xfs_ilock_demote(xfs_inode_t *, uint);
415int xfs_isilocked(xfs_inode_t *, uint);
416uint xfs_ilock_data_map_shared(struct xfs_inode *);
417uint xfs_ilock_attr_map_shared(struct xfs_inode *);
418
419uint xfs_ip2xflags(struct xfs_inode *);
420int xfs_ifree(struct xfs_trans *, struct xfs_inode *);
421int xfs_itruncate_extents_flags(struct xfs_trans **,
422 struct xfs_inode *, int, xfs_fsize_t, int);
423void xfs_iext_realloc(xfs_inode_t *, int, int);
424
425int xfs_log_force_inode(struct xfs_inode *ip);
426void xfs_iunpin_wait(xfs_inode_t *);
427#define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
428
429int xfs_iflush_cluster(struct xfs_buf *);
430void xfs_lock_two_inodes(struct xfs_inode *ip0, uint ip0_mode,
431 struct xfs_inode *ip1, uint ip1_mode);
432
433xfs_extlen_t xfs_get_extsz_hint(struct xfs_inode *ip);
434xfs_extlen_t xfs_get_cowextsz_hint(struct xfs_inode *ip);
435
436int xfs_dir_ialloc(struct xfs_trans **, struct xfs_inode *, umode_t,
437 xfs_nlink_t, dev_t, prid_t,
438 struct xfs_inode **);
439
440static inline int
441xfs_itruncate_extents(
442 struct xfs_trans **tpp,
443 struct xfs_inode *ip,
444 int whichfork,
445 xfs_fsize_t new_size)
446{
447 return xfs_itruncate_extents_flags(tpp, ip, whichfork, new_size, 0);
448}
449
450/* from xfs_file.c */
451enum xfs_prealloc_flags {
452 XFS_PREALLOC_SET = (1 << 1),
453 XFS_PREALLOC_CLEAR = (1 << 2),
454 XFS_PREALLOC_SYNC = (1 << 3),
455 XFS_PREALLOC_INVISIBLE = (1 << 4),
456};
457
458int xfs_update_prealloc_flags(struct xfs_inode *ip,
459 enum xfs_prealloc_flags flags);
460int xfs_break_layouts(struct inode *inode, uint *iolock,
461 enum layout_break_reason reason);
462
463/* from xfs_iops.c */
464extern void xfs_setup_inode(struct xfs_inode *ip);
465extern void xfs_setup_iops(struct xfs_inode *ip);
466extern void xfs_diflags_to_iflags(struct xfs_inode *ip, bool init);
467
468/*
469 * When setting up a newly allocated inode, we need to call
470 * xfs_finish_inode_setup() once the inode is fully instantiated at
471 * the VFS level to prevent the rest of the world seeing the inode
472 * before we've completed instantiation. Otherwise we can do it
473 * the moment the inode lookup is complete.
474 */
475static inline void xfs_finish_inode_setup(struct xfs_inode *ip)
476{
477 xfs_iflags_clear(ip, XFS_INEW);
478 barrier();
479 unlock_new_inode(VFS_I(ip));
480 wake_up_bit(&ip->i_flags, __XFS_INEW_BIT);
481}
482
483static inline void xfs_setup_existing_inode(struct xfs_inode *ip)
484{
485 xfs_setup_inode(ip);
486 xfs_setup_iops(ip);
487 xfs_finish_inode_setup(ip);
488}
489
490void xfs_irele(struct xfs_inode *ip);
491
492extern struct kmem_zone *xfs_inode_zone;
493
494/* The default CoW extent size hint. */
495#define XFS_DEFAULT_COWEXTSZ_HINT 32
496
497int xfs_iunlink_init(struct xfs_perag *pag);
498void xfs_iunlink_destroy(struct xfs_perag *pag);
499
500void xfs_end_io(struct work_struct *work);
501
502int xfs_ilock2_io_mmap(struct xfs_inode *ip1, struct xfs_inode *ip2);
503void xfs_iunlock2_io_mmap(struct xfs_inode *ip1, struct xfs_inode *ip2);
504
505#endif /* __XFS_INODE_H__ */