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