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