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
24/*
25 * Kernel only inode definitions
26 */
27struct xfs_dinode;
28struct xfs_inode;
29struct xfs_buf;
30struct xfs_defer_ops;
31struct xfs_bmbt_irec;
32struct xfs_inode_log_item;
33struct xfs_mount;
34struct xfs_trans;
35struct xfs_dquot;
36
37typedef struct xfs_inode {
38 /* Inode linking and identification information. */
39 struct xfs_mount *i_mount; /* fs mount struct ptr */
40 struct xfs_dquot *i_udquot; /* user dquot */
41 struct xfs_dquot *i_gdquot; /* group dquot */
42 struct xfs_dquot *i_pdquot; /* project dquot */
43
44 /* Inode location stuff */
45 xfs_ino_t i_ino; /* inode number (agno/agino)*/
46 struct xfs_imap i_imap; /* location for xfs_imap() */
47
48 /* Extent information. */
49 xfs_ifork_t *i_afp; /* attribute fork pointer */
50 xfs_ifork_t *i_cowfp; /* copy on write extents */
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_mmaplock; /* inode mmap 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 struct xfs_icdinode i_d; /* most of ondisk inode */
67
68 xfs_extnum_t i_cnextents; /* # of extents in cow fork */
69 unsigned int i_cformat; /* format of cow fork */
70
71 /* VFS inode */
72 struct inode i_vnode; /* embedded VFS inode */
73} xfs_inode_t;
74
75/* Convert from vfs inode to xfs inode */
76static inline struct xfs_inode *XFS_I(struct inode *inode)
77{
78 return container_of(inode, struct xfs_inode, i_vnode);
79}
80
81/* convert from xfs inode to vfs inode */
82static inline struct inode *VFS_I(struct xfs_inode *ip)
83{
84 return &ip->i_vnode;
85}
86
87/*
88 * For regular files we only update the on-disk filesize when actually
89 * writing data back to disk. Until then only the copy in the VFS inode
90 * is uptodate.
91 */
92static inline xfs_fsize_t XFS_ISIZE(struct xfs_inode *ip)
93{
94 if (S_ISREG(VFS_I(ip)->i_mode))
95 return i_size_read(VFS_I(ip));
96 return ip->i_d.di_size;
97}
98
99/*
100 * If this I/O goes past the on-disk inode size update it unless it would
101 * be past the current in-core inode size.
102 */
103static inline xfs_fsize_t
104xfs_new_eof(struct xfs_inode *ip, xfs_fsize_t new_size)
105{
106 xfs_fsize_t i_size = i_size_read(VFS_I(ip));
107
108 if (new_size > i_size || new_size < 0)
109 new_size = i_size;
110 return new_size > ip->i_d.di_size ? new_size : 0;
111}
112
113/*
114 * i_flags helper functions
115 */
116static inline void
117__xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
118{
119 ip->i_flags |= flags;
120}
121
122static inline void
123xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
124{
125 spin_lock(&ip->i_flags_lock);
126 __xfs_iflags_set(ip, flags);
127 spin_unlock(&ip->i_flags_lock);
128}
129
130static inline void
131xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags)
132{
133 spin_lock(&ip->i_flags_lock);
134 ip->i_flags &= ~flags;
135 spin_unlock(&ip->i_flags_lock);
136}
137
138static inline int
139__xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
140{
141 return (ip->i_flags & flags);
142}
143
144static inline int
145xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
146{
147 int ret;
148 spin_lock(&ip->i_flags_lock);
149 ret = __xfs_iflags_test(ip, flags);
150 spin_unlock(&ip->i_flags_lock);
151 return ret;
152}
153
154static inline int
155xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags)
156{
157 int ret;
158
159 spin_lock(&ip->i_flags_lock);
160 ret = ip->i_flags & flags;
161 if (ret)
162 ip->i_flags &= ~flags;
163 spin_unlock(&ip->i_flags_lock);
164 return ret;
165}
166
167static inline int
168xfs_iflags_test_and_set(xfs_inode_t *ip, unsigned short flags)
169{
170 int ret;
171
172 spin_lock(&ip->i_flags_lock);
173 ret = ip->i_flags & flags;
174 if (!ret)
175 ip->i_flags |= flags;
176 spin_unlock(&ip->i_flags_lock);
177 return ret;
178}
179
180/*
181 * Project quota id helpers (previously projid was 16bit only
182 * and using two 16bit values to hold new 32bit projid was chosen
183 * to retain compatibility with "old" filesystems).
184 */
185static inline prid_t
186xfs_get_projid(struct xfs_inode *ip)
187{
188 return (prid_t)ip->i_d.di_projid_hi << 16 | ip->i_d.di_projid_lo;
189}
190
191static inline void
192xfs_set_projid(struct xfs_inode *ip,
193 prid_t projid)
194{
195 ip->i_d.di_projid_hi = (uint16_t) (projid >> 16);
196 ip->i_d.di_projid_lo = (uint16_t) (projid & 0xffff);
197}
198
199static inline prid_t
200xfs_get_initial_prid(struct xfs_inode *dp)
201{
202 if (dp->i_d.di_flags & XFS_DIFLAG_PROJINHERIT)
203 return xfs_get_projid(dp);
204
205 return XFS_PROJID_DEFAULT;
206}
207
208static inline bool xfs_is_reflink_inode(struct xfs_inode *ip)
209{
210 return ip->i_d.di_flags2 & XFS_DIFLAG2_REFLINK;
211}
212
213/*
214 * In-core inode flags.
215 */
216#define XFS_IRECLAIM (1 << 0) /* started reclaiming this inode */
217#define XFS_ISTALE (1 << 1) /* inode has been staled */
218#define XFS_IRECLAIMABLE (1 << 2) /* inode can be reclaimed */
219#define __XFS_INEW_BIT 3 /* inode has just been allocated */
220#define XFS_INEW (1 << __XFS_INEW_BIT)
221#define XFS_ITRUNCATED (1 << 5) /* truncated down so flush-on-close */
222#define XFS_IDIRTY_RELEASE (1 << 6) /* dirty release already seen */
223#define __XFS_IFLOCK_BIT 7 /* inode is being flushed right now */
224#define XFS_IFLOCK (1 << __XFS_IFLOCK_BIT)
225#define __XFS_IPINNED_BIT 8 /* wakeup key for zero pin count */
226#define XFS_IPINNED (1 << __XFS_IPINNED_BIT)
227#define XFS_IDONTCACHE (1 << 9) /* don't cache the inode long term */
228#define XFS_IEOFBLOCKS (1 << 10)/* has the preallocblocks tag set */
229/*
230 * If this unlinked inode is in the middle of recovery, don't let drop_inode
231 * truncate and free the inode. This can happen if we iget the inode during
232 * log recovery to replay a bmap operation on the inode.
233 */
234#define XFS_IRECOVERY (1 << 11)
235#define XFS_ICOWBLOCKS (1 << 12)/* has the cowblocks tag set */
236
237/*
238 * Per-lifetime flags need to be reset when re-using a reclaimable inode during
239 * inode lookup. This prevents unintended behaviour on the new inode from
240 * ocurring.
241 */
242#define XFS_IRECLAIM_RESET_FLAGS \
243 (XFS_IRECLAIMABLE | XFS_IRECLAIM | \
244 XFS_IDIRTY_RELEASE | XFS_ITRUNCATED)
245
246/*
247 * Synchronize processes attempting to flush the in-core inode back to disk.
248 */
249
250static inline int xfs_isiflocked(struct xfs_inode *ip)
251{
252 return xfs_iflags_test(ip, XFS_IFLOCK);
253}
254
255extern void __xfs_iflock(struct xfs_inode *ip);
256
257static inline int xfs_iflock_nowait(struct xfs_inode *ip)
258{
259 return !xfs_iflags_test_and_set(ip, XFS_IFLOCK);
260}
261
262static inline void xfs_iflock(struct xfs_inode *ip)
263{
264 if (!xfs_iflock_nowait(ip))
265 __xfs_iflock(ip);
266}
267
268static inline void xfs_ifunlock(struct xfs_inode *ip)
269{
270 ASSERT(xfs_isiflocked(ip));
271 xfs_iflags_clear(ip, XFS_IFLOCK);
272 smp_mb();
273 wake_up_bit(&ip->i_flags, __XFS_IFLOCK_BIT);
274}
275
276/*
277 * Flags for inode locking.
278 * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield)
279 * 1<<16 - 1<<32-1 -- lockdep annotation (integers)
280 */
281#define XFS_IOLOCK_EXCL (1<<0)
282#define XFS_IOLOCK_SHARED (1<<1)
283#define XFS_ILOCK_EXCL (1<<2)
284#define XFS_ILOCK_SHARED (1<<3)
285#define XFS_MMAPLOCK_EXCL (1<<4)
286#define XFS_MMAPLOCK_SHARED (1<<5)
287
288#define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
289 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED \
290 | XFS_MMAPLOCK_EXCL | XFS_MMAPLOCK_SHARED)
291
292#define XFS_LOCK_FLAGS \
293 { XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \
294 { XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \
295 { XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \
296 { XFS_ILOCK_SHARED, "ILOCK_SHARED" }, \
297 { XFS_MMAPLOCK_EXCL, "MMAPLOCK_EXCL" }, \
298 { XFS_MMAPLOCK_SHARED, "MMAPLOCK_SHARED" }
299
300
301/*
302 * Flags for lockdep annotations.
303 *
304 * XFS_LOCK_PARENT - for directory operations that require locking a
305 * parent directory inode and a child entry inode. IOLOCK requires nesting,
306 * MMAPLOCK does not support this class, ILOCK requires a single subclass
307 * to differentiate parent from child.
308 *
309 * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
310 * inodes do not participate in the normal lock order, and thus have their
311 * own subclasses.
312 *
313 * XFS_LOCK_INUMORDER - for locking several inodes at the some time
314 * with xfs_lock_inodes(). This flag is used as the starting subclass
315 * and each subsequent lock acquired will increment the subclass by one.
316 * However, MAX_LOCKDEP_SUBCLASSES == 8, which means we are greatly
317 * limited to the subclasses we can represent via nesting. We need at least
318 * 5 inodes nest depth for the ILOCK through rename, and we also have to support
319 * XFS_ILOCK_PARENT, which gives 6 subclasses. Then we have XFS_ILOCK_RTBITMAP
320 * and XFS_ILOCK_RTSUM, which are another 2 unique subclasses, so that's all
321 * 8 subclasses supported by lockdep.
322 *
323 * This also means we have to number the sub-classes in the lowest bits of
324 * the mask we keep, and we have to ensure we never exceed 3 bits of lockdep
325 * mask and we can't use bit-masking to build the subclasses. What a mess.
326 *
327 * Bit layout:
328 *
329 * Bit Lock Region
330 * 16-19 XFS_IOLOCK_SHIFT dependencies
331 * 20-23 XFS_MMAPLOCK_SHIFT dependencies
332 * 24-31 XFS_ILOCK_SHIFT dependencies
333 *
334 * IOLOCK values
335 *
336 * 0-3 subclass value
337 * 4-7 unused
338 *
339 * MMAPLOCK values
340 *
341 * 0-3 subclass value
342 * 4-7 unused
343 *
344 * ILOCK values
345 * 0-4 subclass values
346 * 5 PARENT subclass (not nestable)
347 * 6 RTBITMAP subclass (not nestable)
348 * 7 RTSUM subclass (not nestable)
349 *
350 */
351#define XFS_IOLOCK_SHIFT 16
352#define XFS_IOLOCK_MAX_SUBCLASS 3
353#define XFS_IOLOCK_DEP_MASK 0x000f0000
354
355#define XFS_MMAPLOCK_SHIFT 20
356#define XFS_MMAPLOCK_NUMORDER 0
357#define XFS_MMAPLOCK_MAX_SUBCLASS 3
358#define XFS_MMAPLOCK_DEP_MASK 0x00f00000
359
360#define XFS_ILOCK_SHIFT 24
361#define XFS_ILOCK_PARENT_VAL 5
362#define XFS_ILOCK_MAX_SUBCLASS (XFS_ILOCK_PARENT_VAL - 1)
363#define XFS_ILOCK_RTBITMAP_VAL 6
364#define XFS_ILOCK_RTSUM_VAL 7
365#define XFS_ILOCK_DEP_MASK 0xff000000
366#define XFS_ILOCK_PARENT (XFS_ILOCK_PARENT_VAL << XFS_ILOCK_SHIFT)
367#define XFS_ILOCK_RTBITMAP (XFS_ILOCK_RTBITMAP_VAL << XFS_ILOCK_SHIFT)
368#define XFS_ILOCK_RTSUM (XFS_ILOCK_RTSUM_VAL << XFS_ILOCK_SHIFT)
369
370#define XFS_LOCK_SUBCLASS_MASK (XFS_IOLOCK_DEP_MASK | \
371 XFS_MMAPLOCK_DEP_MASK | \
372 XFS_ILOCK_DEP_MASK)
373
374#define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) \
375 >> XFS_IOLOCK_SHIFT)
376#define XFS_MMAPLOCK_DEP(flags) (((flags) & XFS_MMAPLOCK_DEP_MASK) \
377 >> XFS_MMAPLOCK_SHIFT)
378#define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) \
379 >> XFS_ILOCK_SHIFT)
380
381/*
382 * For multiple groups support: if S_ISGID bit is set in the parent
383 * directory, group of new file is set to that of the parent, and
384 * new subdirectory gets S_ISGID bit from parent.
385 */
386#define XFS_INHERIT_GID(pip) \
387 (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \
388 (VFS_I(pip)->i_mode & S_ISGID))
389
390int xfs_release(struct xfs_inode *ip);
391void xfs_inactive(struct xfs_inode *ip);
392int xfs_lookup(struct xfs_inode *dp, struct xfs_name *name,
393 struct xfs_inode **ipp, struct xfs_name *ci_name);
394int xfs_create(struct xfs_inode *dp, struct xfs_name *name,
395 umode_t mode, dev_t rdev, struct xfs_inode **ipp);
396int xfs_create_tmpfile(struct xfs_inode *dp, umode_t mode,
397 struct xfs_inode **ipp);
398int xfs_remove(struct xfs_inode *dp, struct xfs_name *name,
399 struct xfs_inode *ip);
400int xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip,
401 struct xfs_name *target_name);
402int xfs_rename(struct xfs_inode *src_dp, struct xfs_name *src_name,
403 struct xfs_inode *src_ip, struct xfs_inode *target_dp,
404 struct xfs_name *target_name,
405 struct xfs_inode *target_ip, unsigned int flags);
406
407void xfs_ilock(xfs_inode_t *, uint);
408int xfs_ilock_nowait(xfs_inode_t *, uint);
409void xfs_iunlock(xfs_inode_t *, uint);
410void xfs_ilock_demote(xfs_inode_t *, uint);
411int xfs_isilocked(xfs_inode_t *, uint);
412uint xfs_ilock_data_map_shared(struct xfs_inode *);
413uint xfs_ilock_attr_map_shared(struct xfs_inode *);
414
415uint xfs_ip2xflags(struct xfs_inode *);
416int xfs_ifree(struct xfs_trans *, xfs_inode_t *,
417 struct xfs_defer_ops *);
418int xfs_itruncate_extents(struct xfs_trans **, struct xfs_inode *,
419 int, xfs_fsize_t);
420void xfs_iext_realloc(xfs_inode_t *, int, int);
421
422void xfs_iunpin_wait(xfs_inode_t *);
423#define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
424
425int xfs_iflush(struct xfs_inode *, struct xfs_buf **);
426void xfs_lock_two_inodes(struct xfs_inode *ip0, uint ip0_mode,
427 struct xfs_inode *ip1, uint ip1_mode);
428
429xfs_extlen_t xfs_get_extsz_hint(struct xfs_inode *ip);
430xfs_extlen_t xfs_get_cowextsz_hint(struct xfs_inode *ip);
431
432int xfs_dir_ialloc(struct xfs_trans **, struct xfs_inode *, umode_t,
433 xfs_nlink_t, dev_t, prid_t,
434 struct xfs_inode **);
435
436/* from xfs_file.c */
437enum xfs_prealloc_flags {
438 XFS_PREALLOC_SET = (1 << 1),
439 XFS_PREALLOC_CLEAR = (1 << 2),
440 XFS_PREALLOC_SYNC = (1 << 3),
441 XFS_PREALLOC_INVISIBLE = (1 << 4),
442};
443
444int xfs_update_prealloc_flags(struct xfs_inode *ip,
445 enum xfs_prealloc_flags flags);
446
447/* from xfs_iops.c */
448extern void xfs_setup_inode(struct xfs_inode *ip);
449extern void xfs_setup_iops(struct xfs_inode *ip);
450
451/*
452 * When setting up a newly allocated inode, we need to call
453 * xfs_finish_inode_setup() once the inode is fully instantiated at
454 * the VFS level to prevent the rest of the world seeing the inode
455 * before we've completed instantiation. Otherwise we can do it
456 * the moment the inode lookup is complete.
457 */
458static inline void xfs_finish_inode_setup(struct xfs_inode *ip)
459{
460 xfs_iflags_clear(ip, XFS_INEW);
461 barrier();
462 unlock_new_inode(VFS_I(ip));
463 wake_up_bit(&ip->i_flags, __XFS_INEW_BIT);
464}
465
466static inline void xfs_setup_existing_inode(struct xfs_inode *ip)
467{
468 xfs_setup_inode(ip);
469 xfs_setup_iops(ip);
470 xfs_finish_inode_setup(ip);
471}
472
473#define IHOLD(ip) \
474do { \
475 ASSERT(atomic_read(&VFS_I(ip)->i_count) > 0) ; \
476 ihold(VFS_I(ip)); \
477 trace_xfs_ihold(ip, _THIS_IP_); \
478} while (0)
479
480#define IRELE(ip) \
481do { \
482 trace_xfs_irele(ip, _THIS_IP_); \
483 iput(VFS_I(ip)); \
484} while (0)
485
486extern struct kmem_zone *xfs_inode_zone;
487
488/* The default CoW extent size hint. */
489#define XFS_DEFAULT_COWEXTSZ_HINT 32
490
491bool xfs_inode_verify_forks(struct xfs_inode *ip);
492
493#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_cowfp; /* copy on write extents */
37 struct xfs_ifork i_df; /* data fork */
38 struct xfs_ifork i_af; /* attribute fork */
39
40 /* Transaction and locking information. */
41 struct xfs_inode_log_item *i_itemp; /* logging information */
42 struct rw_semaphore i_lock; /* inode lock */
43 atomic_t i_pincount; /* inode pin count */
44 struct llist_node i_gclist; /* deferred inactivation list */
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 xfs_fsize_t i_disk_size; /* number of bytes in file */
58 xfs_rfsblock_t i_nblocks; /* # of direct & btree blocks */
59 prid_t i_projid; /* owner's project id */
60 xfs_extlen_t i_extsize; /* basic/minimum extent size */
61 /* cowextsize is only used for v3 inodes, flushiter for v1/2 */
62 union {
63 xfs_extlen_t i_cowextsize; /* basic cow extent size */
64 uint16_t i_flushiter; /* incremented on flush */
65 };
66 uint8_t i_forkoff; /* attr fork offset >> 3 */
67 uint16_t i_diflags; /* XFS_DIFLAG_... */
68 uint64_t i_diflags2; /* XFS_DIFLAG2_... */
69 struct timespec64 i_crtime; /* time created */
70
71 /*
72 * Unlinked list pointers. These point to the next and previous inodes
73 * in the AGI unlinked bucket list, respectively. These fields can
74 * only be updated with the AGI locked.
75 *
76 * i_next_unlinked caches di_next_unlinked.
77 */
78 xfs_agino_t i_next_unlinked;
79
80 /*
81 * If the inode is not on an unlinked list, this field is zero. If the
82 * inode is the first element in an unlinked list, this field is
83 * NULLAGINO. Otherwise, i_prev_unlinked points to the previous inode
84 * in the unlinked list.
85 */
86 xfs_agino_t i_prev_unlinked;
87
88 /* VFS inode */
89 struct inode i_vnode; /* embedded VFS inode */
90
91 /* pending io completions */
92 spinlock_t i_ioend_lock;
93 struct work_struct i_ioend_work;
94 struct list_head i_ioend_list;
95} xfs_inode_t;
96
97static inline bool xfs_inode_on_unlinked_list(const struct xfs_inode *ip)
98{
99 return ip->i_prev_unlinked != 0;
100}
101
102static inline bool xfs_inode_has_attr_fork(struct xfs_inode *ip)
103{
104 return ip->i_forkoff > 0;
105}
106
107static inline struct xfs_ifork *
108xfs_ifork_ptr(
109 struct xfs_inode *ip,
110 int whichfork)
111{
112 switch (whichfork) {
113 case XFS_DATA_FORK:
114 return &ip->i_df;
115 case XFS_ATTR_FORK:
116 if (!xfs_inode_has_attr_fork(ip))
117 return NULL;
118 return &ip->i_af;
119 case XFS_COW_FORK:
120 return ip->i_cowfp;
121 default:
122 ASSERT(0);
123 return NULL;
124 }
125}
126
127static inline unsigned int xfs_inode_fork_boff(struct xfs_inode *ip)
128{
129 return ip->i_forkoff << 3;
130}
131
132static inline unsigned int xfs_inode_data_fork_size(struct xfs_inode *ip)
133{
134 if (xfs_inode_has_attr_fork(ip))
135 return xfs_inode_fork_boff(ip);
136
137 return XFS_LITINO(ip->i_mount);
138}
139
140static inline unsigned int xfs_inode_attr_fork_size(struct xfs_inode *ip)
141{
142 if (xfs_inode_has_attr_fork(ip))
143 return XFS_LITINO(ip->i_mount) - xfs_inode_fork_boff(ip);
144 return 0;
145}
146
147static inline unsigned int
148xfs_inode_fork_size(
149 struct xfs_inode *ip,
150 int whichfork)
151{
152 switch (whichfork) {
153 case XFS_DATA_FORK:
154 return xfs_inode_data_fork_size(ip);
155 case XFS_ATTR_FORK:
156 return xfs_inode_attr_fork_size(ip);
157 default:
158 return 0;
159 }
160}
161
162/* Convert from vfs inode to xfs inode */
163static inline struct xfs_inode *XFS_I(struct inode *inode)
164{
165 return container_of(inode, struct xfs_inode, i_vnode);
166}
167
168/* convert from xfs inode to vfs inode */
169static inline struct inode *VFS_I(struct xfs_inode *ip)
170{
171 return &ip->i_vnode;
172}
173
174/* convert from const xfs inode to const vfs inode */
175static inline const struct inode *VFS_IC(const struct xfs_inode *ip)
176{
177 return &ip->i_vnode;
178}
179
180/*
181 * For regular files we only update the on-disk filesize when actually
182 * writing data back to disk. Until then only the copy in the VFS inode
183 * is uptodate.
184 */
185static inline xfs_fsize_t XFS_ISIZE(struct xfs_inode *ip)
186{
187 if (S_ISREG(VFS_I(ip)->i_mode))
188 return i_size_read(VFS_I(ip));
189 return ip->i_disk_size;
190}
191
192/*
193 * If this I/O goes past the on-disk inode size update it unless it would
194 * be past the current in-core inode size.
195 */
196static inline xfs_fsize_t
197xfs_new_eof(struct xfs_inode *ip, xfs_fsize_t new_size)
198{
199 xfs_fsize_t i_size = i_size_read(VFS_I(ip));
200
201 if (new_size > i_size || new_size < 0)
202 new_size = i_size;
203 return new_size > ip->i_disk_size ? new_size : 0;
204}
205
206/*
207 * i_flags helper functions
208 */
209static inline void
210__xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
211{
212 ip->i_flags |= flags;
213}
214
215static inline void
216xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
217{
218 spin_lock(&ip->i_flags_lock);
219 __xfs_iflags_set(ip, flags);
220 spin_unlock(&ip->i_flags_lock);
221}
222
223static inline void
224xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags)
225{
226 spin_lock(&ip->i_flags_lock);
227 ip->i_flags &= ~flags;
228 spin_unlock(&ip->i_flags_lock);
229}
230
231static inline int
232__xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
233{
234 return (ip->i_flags & flags);
235}
236
237static inline int
238xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
239{
240 int ret;
241 spin_lock(&ip->i_flags_lock);
242 ret = __xfs_iflags_test(ip, flags);
243 spin_unlock(&ip->i_flags_lock);
244 return ret;
245}
246
247static inline int
248xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags)
249{
250 int ret;
251
252 spin_lock(&ip->i_flags_lock);
253 ret = ip->i_flags & flags;
254 if (ret)
255 ip->i_flags &= ~flags;
256 spin_unlock(&ip->i_flags_lock);
257 return ret;
258}
259
260static inline int
261xfs_iflags_test_and_set(xfs_inode_t *ip, unsigned short flags)
262{
263 int ret;
264
265 spin_lock(&ip->i_flags_lock);
266 ret = ip->i_flags & flags;
267 if (!ret)
268 ip->i_flags |= flags;
269 spin_unlock(&ip->i_flags_lock);
270 return ret;
271}
272
273static inline prid_t
274xfs_get_initial_prid(struct xfs_inode *dp)
275{
276 if (dp->i_diflags & XFS_DIFLAG_PROJINHERIT)
277 return dp->i_projid;
278
279 return XFS_PROJID_DEFAULT;
280}
281
282static inline bool xfs_is_reflink_inode(struct xfs_inode *ip)
283{
284 return ip->i_diflags2 & XFS_DIFLAG2_REFLINK;
285}
286
287static inline bool xfs_is_metadata_inode(struct xfs_inode *ip)
288{
289 struct xfs_mount *mp = ip->i_mount;
290
291 return ip == mp->m_rbmip || ip == mp->m_rsumip ||
292 xfs_is_quota_inode(&mp->m_sb, ip->i_ino);
293}
294
295/*
296 * Check if an inode has any data in the COW fork. This might be often false
297 * even for inodes with the reflink flag when there is no pending COW operation.
298 */
299static inline bool xfs_inode_has_cow_data(struct xfs_inode *ip)
300{
301 return ip->i_cowfp && ip->i_cowfp->if_bytes;
302}
303
304static inline bool xfs_inode_has_bigtime(struct xfs_inode *ip)
305{
306 return ip->i_diflags2 & XFS_DIFLAG2_BIGTIME;
307}
308
309static inline bool xfs_inode_has_large_extent_counts(struct xfs_inode *ip)
310{
311 return ip->i_diflags2 & XFS_DIFLAG2_NREXT64;
312}
313
314/*
315 * Return the buftarg used for data allocations on a given inode.
316 */
317#define xfs_inode_buftarg(ip) \
318 (XFS_IS_REALTIME_INODE(ip) ? \
319 (ip)->i_mount->m_rtdev_targp : (ip)->i_mount->m_ddev_targp)
320
321/*
322 * In-core inode flags.
323 */
324#define XFS_IRECLAIM (1 << 0) /* started reclaiming this inode */
325#define XFS_ISTALE (1 << 1) /* inode has been staled */
326#define XFS_IRECLAIMABLE (1 << 2) /* inode can be reclaimed */
327#define XFS_INEW (1 << 3) /* inode has just been allocated */
328#define XFS_IPRESERVE_DM_FIELDS (1 << 4) /* has legacy DMAPI fields set */
329#define XFS_ITRUNCATED (1 << 5) /* truncated down so flush-on-close */
330#define XFS_IDIRTY_RELEASE (1 << 6) /* dirty release already seen */
331#define XFS_IFLUSHING (1 << 7) /* inode is being flushed */
332#define __XFS_IPINNED_BIT 8 /* wakeup key for zero pin count */
333#define XFS_IPINNED (1 << __XFS_IPINNED_BIT)
334#define XFS_IEOFBLOCKS (1 << 9) /* has the preallocblocks tag set */
335#define XFS_NEED_INACTIVE (1 << 10) /* see XFS_INACTIVATING below */
336/*
337 * If this unlinked inode is in the middle of recovery, don't let drop_inode
338 * truncate and free the inode. This can happen if we iget the inode during
339 * log recovery to replay a bmap operation on the inode.
340 */
341#define XFS_IRECOVERY (1 << 11)
342#define XFS_ICOWBLOCKS (1 << 12)/* has the cowblocks tag set */
343
344/*
345 * If we need to update on-disk metadata before this IRECLAIMABLE inode can be
346 * freed, then NEED_INACTIVE will be set. Once we start the updates, the
347 * INACTIVATING bit will be set to keep iget away from this inode. After the
348 * inactivation completes, both flags will be cleared and the inode is a
349 * plain old IRECLAIMABLE inode.
350 */
351#define XFS_INACTIVATING (1 << 13)
352
353/* Quotacheck is running but inode has not been added to quota counts. */
354#define XFS_IQUOTAUNCHECKED (1 << 14)
355
356/*
357 * Remap in progress. Callers that wish to update file data while
358 * holding a shared IOLOCK or MMAPLOCK must drop the lock and retake
359 * the lock in exclusive mode. Relocking the file will block until
360 * IREMAPPING is cleared.
361 */
362#define XFS_IREMAPPING (1U << 15)
363
364/* All inode state flags related to inode reclaim. */
365#define XFS_ALL_IRECLAIM_FLAGS (XFS_IRECLAIMABLE | \
366 XFS_IRECLAIM | \
367 XFS_NEED_INACTIVE | \
368 XFS_INACTIVATING)
369
370/*
371 * Per-lifetime flags need to be reset when re-using a reclaimable inode during
372 * inode lookup. This prevents unintended behaviour on the new inode from
373 * ocurring.
374 */
375#define XFS_IRECLAIM_RESET_FLAGS \
376 (XFS_IRECLAIMABLE | XFS_IRECLAIM | \
377 XFS_IDIRTY_RELEASE | XFS_ITRUNCATED | XFS_NEED_INACTIVE | \
378 XFS_INACTIVATING | XFS_IQUOTAUNCHECKED)
379
380/*
381 * Flags for inode locking.
382 * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield)
383 * 1<<16 - 1<<32-1 -- lockdep annotation (integers)
384 */
385#define XFS_IOLOCK_EXCL (1u << 0)
386#define XFS_IOLOCK_SHARED (1u << 1)
387#define XFS_ILOCK_EXCL (1u << 2)
388#define XFS_ILOCK_SHARED (1u << 3)
389#define XFS_MMAPLOCK_EXCL (1u << 4)
390#define XFS_MMAPLOCK_SHARED (1u << 5)
391
392#define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
393 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED \
394 | XFS_MMAPLOCK_EXCL | XFS_MMAPLOCK_SHARED)
395
396#define XFS_LOCK_FLAGS \
397 { XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \
398 { XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \
399 { XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \
400 { XFS_ILOCK_SHARED, "ILOCK_SHARED" }, \
401 { XFS_MMAPLOCK_EXCL, "MMAPLOCK_EXCL" }, \
402 { XFS_MMAPLOCK_SHARED, "MMAPLOCK_SHARED" }
403
404
405/*
406 * Flags for lockdep annotations.
407 *
408 * XFS_LOCK_PARENT - for directory operations that require locking a
409 * parent directory inode and a child entry inode. IOLOCK requires nesting,
410 * MMAPLOCK does not support this class, ILOCK requires a single subclass
411 * to differentiate parent from child.
412 *
413 * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
414 * inodes do not participate in the normal lock order, and thus have their
415 * own subclasses.
416 *
417 * XFS_LOCK_INUMORDER - for locking several inodes at the some time
418 * with xfs_lock_inodes(). This flag is used as the starting subclass
419 * and each subsequent lock acquired will increment the subclass by one.
420 * However, MAX_LOCKDEP_SUBCLASSES == 8, which means we are greatly
421 * limited to the subclasses we can represent via nesting. We need at least
422 * 5 inodes nest depth for the ILOCK through rename, and we also have to support
423 * XFS_ILOCK_PARENT, which gives 6 subclasses. Then we have XFS_ILOCK_RTBITMAP
424 * and XFS_ILOCK_RTSUM, which are another 2 unique subclasses, so that's all
425 * 8 subclasses supported by lockdep.
426 *
427 * This also means we have to number the sub-classes in the lowest bits of
428 * the mask we keep, and we have to ensure we never exceed 3 bits of lockdep
429 * mask and we can't use bit-masking to build the subclasses. What a mess.
430 *
431 * Bit layout:
432 *
433 * Bit Lock Region
434 * 16-19 XFS_IOLOCK_SHIFT dependencies
435 * 20-23 XFS_MMAPLOCK_SHIFT dependencies
436 * 24-31 XFS_ILOCK_SHIFT dependencies
437 *
438 * IOLOCK values
439 *
440 * 0-3 subclass value
441 * 4-7 unused
442 *
443 * MMAPLOCK values
444 *
445 * 0-3 subclass value
446 * 4-7 unused
447 *
448 * ILOCK values
449 * 0-4 subclass values
450 * 5 PARENT subclass (not nestable)
451 * 6 RTBITMAP subclass (not nestable)
452 * 7 RTSUM subclass (not nestable)
453 *
454 */
455#define XFS_IOLOCK_SHIFT 16
456#define XFS_IOLOCK_MAX_SUBCLASS 3
457#define XFS_IOLOCK_DEP_MASK 0x000f0000u
458
459#define XFS_MMAPLOCK_SHIFT 20
460#define XFS_MMAPLOCK_NUMORDER 0
461#define XFS_MMAPLOCK_MAX_SUBCLASS 3
462#define XFS_MMAPLOCK_DEP_MASK 0x00f00000u
463
464#define XFS_ILOCK_SHIFT 24
465#define XFS_ILOCK_PARENT_VAL 5u
466#define XFS_ILOCK_MAX_SUBCLASS (XFS_ILOCK_PARENT_VAL - 1)
467#define XFS_ILOCK_RTBITMAP_VAL 6u
468#define XFS_ILOCK_RTSUM_VAL 7u
469#define XFS_ILOCK_DEP_MASK 0xff000000u
470#define XFS_ILOCK_PARENT (XFS_ILOCK_PARENT_VAL << XFS_ILOCK_SHIFT)
471#define XFS_ILOCK_RTBITMAP (XFS_ILOCK_RTBITMAP_VAL << XFS_ILOCK_SHIFT)
472#define XFS_ILOCK_RTSUM (XFS_ILOCK_RTSUM_VAL << XFS_ILOCK_SHIFT)
473
474#define XFS_LOCK_SUBCLASS_MASK (XFS_IOLOCK_DEP_MASK | \
475 XFS_MMAPLOCK_DEP_MASK | \
476 XFS_ILOCK_DEP_MASK)
477
478#define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) \
479 >> XFS_IOLOCK_SHIFT)
480#define XFS_MMAPLOCK_DEP(flags) (((flags) & XFS_MMAPLOCK_DEP_MASK) \
481 >> XFS_MMAPLOCK_SHIFT)
482#define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) \
483 >> XFS_ILOCK_SHIFT)
484
485/*
486 * Layouts are broken in the BREAK_WRITE case to ensure that
487 * layout-holders do not collide with local writes. Additionally,
488 * layouts are broken in the BREAK_UNMAP case to make sure the
489 * layout-holder has a consistent view of the file's extent map. While
490 * BREAK_WRITE breaks can be satisfied by recalling FL_LAYOUT leases,
491 * BREAK_UNMAP breaks additionally require waiting for busy dax-pages to
492 * go idle.
493 */
494enum layout_break_reason {
495 BREAK_WRITE,
496 BREAK_UNMAP,
497};
498
499/*
500 * For multiple groups support: if S_ISGID bit is set in the parent
501 * directory, group of new file is set to that of the parent, and
502 * new subdirectory gets S_ISGID bit from parent.
503 */
504#define XFS_INHERIT_GID(pip) \
505 (xfs_has_grpid((pip)->i_mount) || (VFS_I(pip)->i_mode & S_ISGID))
506
507int xfs_release(struct xfs_inode *ip);
508int xfs_inactive(struct xfs_inode *ip);
509int xfs_lookup(struct xfs_inode *dp, const struct xfs_name *name,
510 struct xfs_inode **ipp, struct xfs_name *ci_name);
511int xfs_create(struct mnt_idmap *idmap,
512 struct xfs_inode *dp, struct xfs_name *name,
513 umode_t mode, dev_t rdev, bool need_xattr,
514 struct xfs_inode **ipp);
515int xfs_create_tmpfile(struct mnt_idmap *idmap,
516 struct xfs_inode *dp, umode_t mode,
517 struct xfs_inode **ipp);
518int xfs_remove(struct xfs_inode *dp, struct xfs_name *name,
519 struct xfs_inode *ip);
520int xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip,
521 struct xfs_name *target_name);
522int xfs_rename(struct mnt_idmap *idmap,
523 struct xfs_inode *src_dp, struct xfs_name *src_name,
524 struct xfs_inode *src_ip, struct xfs_inode *target_dp,
525 struct xfs_name *target_name,
526 struct xfs_inode *target_ip, unsigned int flags);
527
528void xfs_ilock(xfs_inode_t *, uint);
529int xfs_ilock_nowait(xfs_inode_t *, uint);
530void xfs_iunlock(xfs_inode_t *, uint);
531void xfs_ilock_demote(xfs_inode_t *, uint);
532void xfs_assert_ilocked(struct xfs_inode *, uint);
533uint xfs_ilock_data_map_shared(struct xfs_inode *);
534uint xfs_ilock_attr_map_shared(struct xfs_inode *);
535
536uint xfs_ip2xflags(struct xfs_inode *);
537int xfs_ifree(struct xfs_trans *, struct xfs_inode *);
538int xfs_itruncate_extents_flags(struct xfs_trans **,
539 struct xfs_inode *, int, xfs_fsize_t, int);
540void xfs_iext_realloc(xfs_inode_t *, int, int);
541
542int xfs_log_force_inode(struct xfs_inode *ip);
543void xfs_iunpin_wait(xfs_inode_t *);
544#define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
545
546int xfs_iflush_cluster(struct xfs_buf *);
547void xfs_lock_two_inodes(struct xfs_inode *ip0, uint ip0_mode,
548 struct xfs_inode *ip1, uint ip1_mode);
549
550xfs_extlen_t xfs_get_extsz_hint(struct xfs_inode *ip);
551xfs_extlen_t xfs_get_cowextsz_hint(struct xfs_inode *ip);
552
553int xfs_init_new_inode(struct mnt_idmap *idmap, struct xfs_trans *tp,
554 struct xfs_inode *pip, xfs_ino_t ino, umode_t mode,
555 xfs_nlink_t nlink, dev_t rdev, prid_t prid, bool init_xattrs,
556 struct xfs_inode **ipp);
557
558static inline int
559xfs_itruncate_extents(
560 struct xfs_trans **tpp,
561 struct xfs_inode *ip,
562 int whichfork,
563 xfs_fsize_t new_size)
564{
565 return xfs_itruncate_extents_flags(tpp, ip, whichfork, new_size, 0);
566}
567
568/* from xfs_file.c */
569int xfs_break_dax_layouts(struct inode *inode, bool *retry);
570int xfs_break_layouts(struct inode *inode, uint *iolock,
571 enum layout_break_reason reason);
572
573/* from xfs_iops.c */
574extern void xfs_setup_inode(struct xfs_inode *ip);
575extern void xfs_setup_iops(struct xfs_inode *ip);
576extern void xfs_diflags_to_iflags(struct xfs_inode *ip, bool init);
577
578static inline void xfs_update_stable_writes(struct xfs_inode *ip)
579{
580 if (bdev_stable_writes(xfs_inode_buftarg(ip)->bt_bdev))
581 mapping_set_stable_writes(VFS_I(ip)->i_mapping);
582 else
583 mapping_clear_stable_writes(VFS_I(ip)->i_mapping);
584}
585
586/*
587 * When setting up a newly allocated inode, we need to call
588 * xfs_finish_inode_setup() once the inode is fully instantiated at
589 * the VFS level to prevent the rest of the world seeing the inode
590 * before we've completed instantiation. Otherwise we can do it
591 * the moment the inode lookup is complete.
592 */
593static inline void xfs_finish_inode_setup(struct xfs_inode *ip)
594{
595 xfs_iflags_clear(ip, XFS_INEW);
596 barrier();
597 unlock_new_inode(VFS_I(ip));
598}
599
600static inline void xfs_setup_existing_inode(struct xfs_inode *ip)
601{
602 xfs_setup_inode(ip);
603 xfs_setup_iops(ip);
604 xfs_finish_inode_setup(ip);
605}
606
607void xfs_irele(struct xfs_inode *ip);
608
609extern struct kmem_cache *xfs_inode_cache;
610
611/* The default CoW extent size hint. */
612#define XFS_DEFAULT_COWEXTSZ_HINT 32
613
614bool xfs_inode_needs_inactive(struct xfs_inode *ip);
615
616void xfs_end_io(struct work_struct *work);
617
618int xfs_ilock2_io_mmap(struct xfs_inode *ip1, struct xfs_inode *ip2);
619void xfs_iunlock2_io_mmap(struct xfs_inode *ip1, struct xfs_inode *ip2);
620void xfs_iunlock2_remapping(struct xfs_inode *ip1, struct xfs_inode *ip2);
621
622static inline bool
623xfs_inode_unlinked_incomplete(
624 struct xfs_inode *ip)
625{
626 return VFS_I(ip)->i_nlink == 0 && !xfs_inode_on_unlinked_list(ip);
627}
628int xfs_inode_reload_unlinked_bucket(struct xfs_trans *tp, struct xfs_inode *ip);
629int xfs_inode_reload_unlinked(struct xfs_inode *ip);
630
631bool xfs_ifork_zapped(const struct xfs_inode *ip, int whichfork);
632void xfs_inode_count_blocks(struct xfs_trans *tp, struct xfs_inode *ip,
633 xfs_filblks_t *dblocks, xfs_filblks_t *rblocks);
634
635struct xfs_dir_update_params {
636 const struct xfs_inode *dp;
637 const struct xfs_inode *ip;
638 const struct xfs_name *name;
639 int delta;
640};
641
642#ifdef CONFIG_XFS_LIVE_HOOKS
643void xfs_dir_update_hook(struct xfs_inode *dp, struct xfs_inode *ip,
644 int delta, const struct xfs_name *name);
645
646struct xfs_dir_hook {
647 struct xfs_hook dirent_hook;
648};
649
650void xfs_dir_hook_disable(void);
651void xfs_dir_hook_enable(void);
652
653int xfs_dir_hook_add(struct xfs_mount *mp, struct xfs_dir_hook *hook);
654void xfs_dir_hook_del(struct xfs_mount *mp, struct xfs_dir_hook *hook);
655void xfs_dir_hook_setup(struct xfs_dir_hook *hook, notifier_fn_t mod_fn);
656#else
657# define xfs_dir_update_hook(dp, ip, delta, name) ((void)0)
658#endif /* CONFIG_XFS_LIVE_HOOKS */
659
660#endif /* __XFS_INODE_H__ */