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