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_afp; /* attribute fork pointer */
37 struct xfs_ifork *i_cowfp; /* copy on write extents */
38 struct xfs_ifork i_df; /* data fork */
39
40 /* Transaction and locking information. */
41 struct xfs_inode_log_item *i_itemp; /* logging information */
42 mrlock_t i_lock; /* inode lock */
43 mrlock_t i_mmaplock; /* inode mmap IO lock */
44 atomic_t i_pincount; /* inode pin count */
45
46 /*
47 * Bitsets of inode metadata that have been checked and/or are sick.
48 * Callers must hold i_flags_lock before accessing this field.
49 */
50 uint16_t i_checked;
51 uint16_t i_sick;
52
53 spinlock_t i_flags_lock; /* inode i_flags lock */
54 /* Miscellaneous state. */
55 unsigned long i_flags; /* see defined flags below */
56 uint64_t i_delayed_blks; /* count of delay alloc blks */
57 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 */
81static 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 */
87static 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 */
97static 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 */
108static inline xfs_fsize_t
109xfs_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 */
121static inline void
122__xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
123{
124 ip->i_flags |= flags;
125}
126
127static inline void
128xfs_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
135static inline void
136xfs_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
143static inline int
144__xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
145{
146 return (ip->i_flags & flags);
147}
148
149static inline int
150xfs_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
159static inline int
160xfs_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
172static inline int
173xfs_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
185static inline prid_t
186xfs_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
194static inline bool xfs_is_reflink_inode(struct xfs_inode *ip)
195{
196 return ip->i_diflags2 & XFS_DIFLAG2_REFLINK;
197}
198
199static 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 */
211static inline bool xfs_inode_has_cow_data(struct xfs_inode *ip)
212{
213 return ip->i_cowfp && ip->i_cowfp->if_bytes;
214}
215
216static 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/*
244 * If this unlinked inode is in the middle of recovery, don't let drop_inode
245 * truncate and free the inode. This can happen if we iget the inode during
246 * log recovery to replay a bmap operation on the inode.
247 */
248#define XFS_IRECOVERY (1 << 11)
249#define XFS_ICOWBLOCKS (1 << 12)/* has the cowblocks tag set */
250
251/*
252 * Per-lifetime flags need to be reset when re-using a reclaimable inode during
253 * inode lookup. This prevents unintended behaviour on the new inode from
254 * ocurring.
255 */
256#define XFS_IRECLAIM_RESET_FLAGS \
257 (XFS_IRECLAIMABLE | XFS_IRECLAIM | \
258 XFS_IDIRTY_RELEASE | XFS_ITRUNCATED)
259
260/*
261 * Flags for inode locking.
262 * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield)
263 * 1<<16 - 1<<32-1 -- lockdep annotation (integers)
264 */
265#define XFS_IOLOCK_EXCL (1<<0)
266#define XFS_IOLOCK_SHARED (1<<1)
267#define XFS_ILOCK_EXCL (1<<2)
268#define XFS_ILOCK_SHARED (1<<3)
269#define XFS_MMAPLOCK_EXCL (1<<4)
270#define XFS_MMAPLOCK_SHARED (1<<5)
271
272#define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
273 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED \
274 | XFS_MMAPLOCK_EXCL | XFS_MMAPLOCK_SHARED)
275
276#define XFS_LOCK_FLAGS \
277 { XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \
278 { XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \
279 { XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \
280 { XFS_ILOCK_SHARED, "ILOCK_SHARED" }, \
281 { XFS_MMAPLOCK_EXCL, "MMAPLOCK_EXCL" }, \
282 { XFS_MMAPLOCK_SHARED, "MMAPLOCK_SHARED" }
283
284
285/*
286 * Flags for lockdep annotations.
287 *
288 * XFS_LOCK_PARENT - for directory operations that require locking a
289 * parent directory inode and a child entry inode. IOLOCK requires nesting,
290 * MMAPLOCK does not support this class, ILOCK requires a single subclass
291 * to differentiate parent from child.
292 *
293 * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
294 * inodes do not participate in the normal lock order, and thus have their
295 * own subclasses.
296 *
297 * XFS_LOCK_INUMORDER - for locking several inodes at the some time
298 * with xfs_lock_inodes(). This flag is used as the starting subclass
299 * and each subsequent lock acquired will increment the subclass by one.
300 * However, MAX_LOCKDEP_SUBCLASSES == 8, which means we are greatly
301 * limited to the subclasses we can represent via nesting. We need at least
302 * 5 inodes nest depth for the ILOCK through rename, and we also have to support
303 * XFS_ILOCK_PARENT, which gives 6 subclasses. Then we have XFS_ILOCK_RTBITMAP
304 * and XFS_ILOCK_RTSUM, which are another 2 unique subclasses, so that's all
305 * 8 subclasses supported by lockdep.
306 *
307 * This also means we have to number the sub-classes in the lowest bits of
308 * the mask we keep, and we have to ensure we never exceed 3 bits of lockdep
309 * mask and we can't use bit-masking to build the subclasses. What a mess.
310 *
311 * Bit layout:
312 *
313 * Bit Lock Region
314 * 16-19 XFS_IOLOCK_SHIFT dependencies
315 * 20-23 XFS_MMAPLOCK_SHIFT dependencies
316 * 24-31 XFS_ILOCK_SHIFT dependencies
317 *
318 * IOLOCK values
319 *
320 * 0-3 subclass value
321 * 4-7 unused
322 *
323 * MMAPLOCK values
324 *
325 * 0-3 subclass value
326 * 4-7 unused
327 *
328 * ILOCK values
329 * 0-4 subclass values
330 * 5 PARENT subclass (not nestable)
331 * 6 RTBITMAP subclass (not nestable)
332 * 7 RTSUM subclass (not nestable)
333 *
334 */
335#define XFS_IOLOCK_SHIFT 16
336#define XFS_IOLOCK_MAX_SUBCLASS 3
337#define XFS_IOLOCK_DEP_MASK 0x000f0000
338
339#define XFS_MMAPLOCK_SHIFT 20
340#define XFS_MMAPLOCK_NUMORDER 0
341#define XFS_MMAPLOCK_MAX_SUBCLASS 3
342#define XFS_MMAPLOCK_DEP_MASK 0x00f00000
343
344#define XFS_ILOCK_SHIFT 24
345#define XFS_ILOCK_PARENT_VAL 5
346#define XFS_ILOCK_MAX_SUBCLASS (XFS_ILOCK_PARENT_VAL - 1)
347#define XFS_ILOCK_RTBITMAP_VAL 6
348#define XFS_ILOCK_RTSUM_VAL 7
349#define XFS_ILOCK_DEP_MASK 0xff000000
350#define XFS_ILOCK_PARENT (XFS_ILOCK_PARENT_VAL << XFS_ILOCK_SHIFT)
351#define XFS_ILOCK_RTBITMAP (XFS_ILOCK_RTBITMAP_VAL << XFS_ILOCK_SHIFT)
352#define XFS_ILOCK_RTSUM (XFS_ILOCK_RTSUM_VAL << XFS_ILOCK_SHIFT)
353
354#define XFS_LOCK_SUBCLASS_MASK (XFS_IOLOCK_DEP_MASK | \
355 XFS_MMAPLOCK_DEP_MASK | \
356 XFS_ILOCK_DEP_MASK)
357
358#define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) \
359 >> XFS_IOLOCK_SHIFT)
360#define XFS_MMAPLOCK_DEP(flags) (((flags) & XFS_MMAPLOCK_DEP_MASK) \
361 >> XFS_MMAPLOCK_SHIFT)
362#define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) \
363 >> XFS_ILOCK_SHIFT)
364
365/*
366 * Layouts are broken in the BREAK_WRITE case to ensure that
367 * layout-holders do not collide with local writes. Additionally,
368 * layouts are broken in the BREAK_UNMAP case to make sure the
369 * layout-holder has a consistent view of the file's extent map. While
370 * BREAK_WRITE breaks can be satisfied by recalling FL_LAYOUT leases,
371 * BREAK_UNMAP breaks additionally require waiting for busy dax-pages to
372 * go idle.
373 */
374enum layout_break_reason {
375 BREAK_WRITE,
376 BREAK_UNMAP,
377};
378
379/*
380 * For multiple groups support: if S_ISGID bit is set in the parent
381 * directory, group of new file is set to that of the parent, and
382 * new subdirectory gets S_ISGID bit from parent.
383 */
384#define XFS_INHERIT_GID(pip) \
385 (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \
386 (VFS_I(pip)->i_mode & S_ISGID))
387
388int xfs_release(struct xfs_inode *ip);
389void xfs_inactive(struct xfs_inode *ip);
390int xfs_lookup(struct xfs_inode *dp, struct xfs_name *name,
391 struct xfs_inode **ipp, struct xfs_name *ci_name);
392int xfs_create(struct user_namespace *mnt_userns,
393 struct xfs_inode *dp, struct xfs_name *name,
394 umode_t mode, dev_t rdev, bool need_xattr,
395 struct xfs_inode **ipp);
396int xfs_create_tmpfile(struct user_namespace *mnt_userns,
397 struct xfs_inode *dp, umode_t mode,
398 struct xfs_inode **ipp);
399int xfs_remove(struct xfs_inode *dp, struct xfs_name *name,
400 struct xfs_inode *ip);
401int xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip,
402 struct xfs_name *target_name);
403int xfs_rename(struct user_namespace *mnt_userns,
404 struct xfs_inode *src_dp, struct xfs_name *src_name,
405 struct xfs_inode *src_ip, struct xfs_inode *target_dp,
406 struct xfs_name *target_name,
407 struct xfs_inode *target_ip, unsigned int flags);
408
409void xfs_ilock(xfs_inode_t *, uint);
410int xfs_ilock_nowait(xfs_inode_t *, uint);
411void xfs_iunlock(xfs_inode_t *, uint);
412void xfs_ilock_demote(xfs_inode_t *, uint);
413int xfs_isilocked(xfs_inode_t *, uint);
414uint xfs_ilock_data_map_shared(struct xfs_inode *);
415uint xfs_ilock_attr_map_shared(struct xfs_inode *);
416
417uint xfs_ip2xflags(struct xfs_inode *);
418int xfs_ifree(struct xfs_trans *, struct xfs_inode *);
419int xfs_itruncate_extents_flags(struct xfs_trans **,
420 struct xfs_inode *, int, xfs_fsize_t, int);
421void xfs_iext_realloc(xfs_inode_t *, int, int);
422
423int xfs_log_force_inode(struct xfs_inode *ip);
424void xfs_iunpin_wait(xfs_inode_t *);
425#define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
426
427int xfs_iflush_cluster(struct xfs_buf *);
428void xfs_lock_two_inodes(struct xfs_inode *ip0, uint ip0_mode,
429 struct xfs_inode *ip1, uint ip1_mode);
430
431xfs_extlen_t xfs_get_extsz_hint(struct xfs_inode *ip);
432xfs_extlen_t xfs_get_cowextsz_hint(struct xfs_inode *ip);
433
434int xfs_init_new_inode(struct user_namespace *mnt_userns, struct xfs_trans *tp,
435 struct xfs_inode *pip, xfs_ino_t ino, umode_t mode,
436 xfs_nlink_t nlink, dev_t rdev, prid_t prid, bool init_xattrs,
437 struct xfs_inode **ipp);
438
439static inline int
440xfs_itruncate_extents(
441 struct xfs_trans **tpp,
442 struct xfs_inode *ip,
443 int whichfork,
444 xfs_fsize_t new_size)
445{
446 return xfs_itruncate_extents_flags(tpp, ip, whichfork, new_size, 0);
447}
448
449/* from xfs_file.c */
450enum xfs_prealloc_flags {
451 XFS_PREALLOC_SET = (1 << 1),
452 XFS_PREALLOC_CLEAR = (1 << 2),
453 XFS_PREALLOC_SYNC = (1 << 3),
454 XFS_PREALLOC_INVISIBLE = (1 << 4),
455};
456
457int xfs_update_prealloc_flags(struct xfs_inode *ip,
458 enum xfs_prealloc_flags flags);
459int xfs_break_layouts(struct inode *inode, uint *iolock,
460 enum layout_break_reason reason);
461
462/* from xfs_iops.c */
463extern void xfs_setup_inode(struct xfs_inode *ip);
464extern void xfs_setup_iops(struct xfs_inode *ip);
465extern void xfs_diflags_to_iflags(struct xfs_inode *ip, bool init);
466
467/*
468 * When setting up a newly allocated inode, we need to call
469 * xfs_finish_inode_setup() once the inode is fully instantiated at
470 * the VFS level to prevent the rest of the world seeing the inode
471 * before we've completed instantiation. Otherwise we can do it
472 * the moment the inode lookup is complete.
473 */
474static inline void xfs_finish_inode_setup(struct xfs_inode *ip)
475{
476 xfs_iflags_clear(ip, XFS_INEW);
477 barrier();
478 unlock_new_inode(VFS_I(ip));
479 wake_up_bit(&ip->i_flags, __XFS_INEW_BIT);
480}
481
482static inline void xfs_setup_existing_inode(struct xfs_inode *ip)
483{
484 xfs_setup_inode(ip);
485 xfs_setup_iops(ip);
486 xfs_finish_inode_setup(ip);
487}
488
489void xfs_irele(struct xfs_inode *ip);
490
491extern struct kmem_zone *xfs_inode_zone;
492
493/* The default CoW extent size hint. */
494#define XFS_DEFAULT_COWEXTSZ_HINT 32
495
496int xfs_iunlink_init(struct xfs_perag *pag);
497void xfs_iunlink_destroy(struct xfs_perag *pag);
498
499void xfs_end_io(struct work_struct *work);
500
501int xfs_ilock2_io_mmap(struct xfs_inode *ip1, struct xfs_inode *ip2);
502void xfs_iunlock2_io_mmap(struct xfs_inode *ip1, struct xfs_inode *ip2);
503
504#endif /* __XFS_INODE_H__ */
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 (1 << 3) /* inode has just been allocated */
220#define XFS_ITRUNCATED (1 << 5) /* truncated down so flush-on-close */
221#define XFS_IDIRTY_RELEASE (1 << 6) /* dirty release already seen */
222#define __XFS_IFLOCK_BIT 7 /* inode is being flushed right now */
223#define XFS_IFLOCK (1 << __XFS_IFLOCK_BIT)
224#define __XFS_IPINNED_BIT 8 /* wakeup key for zero pin count */
225#define XFS_IPINNED (1 << __XFS_IPINNED_BIT)
226#define XFS_IDONTCACHE (1 << 9) /* don't cache the inode long term */
227#define XFS_IEOFBLOCKS (1 << 10)/* has the preallocblocks tag set */
228/*
229 * If this unlinked inode is in the middle of recovery, don't let drop_inode
230 * truncate and free the inode. This can happen if we iget the inode during
231 * log recovery to replay a bmap operation on the inode.
232 */
233#define XFS_IRECOVERY (1 << 11)
234
235/*
236 * Per-lifetime flags need to be reset when re-using a reclaimable inode during
237 * inode lookup. This prevents unintended behaviour on the new inode from
238 * ocurring.
239 */
240#define XFS_IRECLAIM_RESET_FLAGS \
241 (XFS_IRECLAIMABLE | XFS_IRECLAIM | \
242 XFS_IDIRTY_RELEASE | XFS_ITRUNCATED)
243
244/*
245 * Synchronize processes attempting to flush the in-core inode back to disk.
246 */
247
248static inline int xfs_isiflocked(struct xfs_inode *ip)
249{
250 return xfs_iflags_test(ip, XFS_IFLOCK);
251}
252
253extern void __xfs_iflock(struct xfs_inode *ip);
254
255static inline int xfs_iflock_nowait(struct xfs_inode *ip)
256{
257 return !xfs_iflags_test_and_set(ip, XFS_IFLOCK);
258}
259
260static inline void xfs_iflock(struct xfs_inode *ip)
261{
262 if (!xfs_iflock_nowait(ip))
263 __xfs_iflock(ip);
264}
265
266static inline void xfs_ifunlock(struct xfs_inode *ip)
267{
268 ASSERT(xfs_isiflocked(ip));
269 xfs_iflags_clear(ip, XFS_IFLOCK);
270 smp_mb();
271 wake_up_bit(&ip->i_flags, __XFS_IFLOCK_BIT);
272}
273
274/*
275 * Flags for inode locking.
276 * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield)
277 * 1<<16 - 1<<32-1 -- lockdep annotation (integers)
278 */
279#define XFS_IOLOCK_EXCL (1<<0)
280#define XFS_IOLOCK_SHARED (1<<1)
281#define XFS_ILOCK_EXCL (1<<2)
282#define XFS_ILOCK_SHARED (1<<3)
283#define XFS_MMAPLOCK_EXCL (1<<4)
284#define XFS_MMAPLOCK_SHARED (1<<5)
285
286#define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
287 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED \
288 | XFS_MMAPLOCK_EXCL | XFS_MMAPLOCK_SHARED)
289
290#define XFS_LOCK_FLAGS \
291 { XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \
292 { XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \
293 { XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \
294 { XFS_ILOCK_SHARED, "ILOCK_SHARED" }, \
295 { XFS_MMAPLOCK_EXCL, "MMAPLOCK_EXCL" }, \
296 { XFS_MMAPLOCK_SHARED, "MMAPLOCK_SHARED" }
297
298
299/*
300 * Flags for lockdep annotations.
301 *
302 * XFS_LOCK_PARENT - for directory operations that require locking a
303 * parent directory inode and a child entry inode. IOLOCK requires nesting,
304 * MMAPLOCK does not support this class, ILOCK requires a single subclass
305 * to differentiate parent from child.
306 *
307 * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
308 * inodes do not participate in the normal lock order, and thus have their
309 * own subclasses.
310 *
311 * XFS_LOCK_INUMORDER - for locking several inodes at the some time
312 * with xfs_lock_inodes(). This flag is used as the starting subclass
313 * and each subsequent lock acquired will increment the subclass by one.
314 * However, MAX_LOCKDEP_SUBCLASSES == 8, which means we are greatly
315 * limited to the subclasses we can represent via nesting. We need at least
316 * 5 inodes nest depth for the ILOCK through rename, and we also have to support
317 * XFS_ILOCK_PARENT, which gives 6 subclasses. Then we have XFS_ILOCK_RTBITMAP
318 * and XFS_ILOCK_RTSUM, which are another 2 unique subclasses, so that's all
319 * 8 subclasses supported by lockdep.
320 *
321 * This also means we have to number the sub-classes in the lowest bits of
322 * the mask we keep, and we have to ensure we never exceed 3 bits of lockdep
323 * mask and we can't use bit-masking to build the subclasses. What a mess.
324 *
325 * Bit layout:
326 *
327 * Bit Lock Region
328 * 16-19 XFS_IOLOCK_SHIFT dependencies
329 * 20-23 XFS_MMAPLOCK_SHIFT dependencies
330 * 24-31 XFS_ILOCK_SHIFT dependencies
331 *
332 * IOLOCK values
333 *
334 * 0-3 subclass value
335 * 4-7 unused
336 *
337 * MMAPLOCK values
338 *
339 * 0-3 subclass value
340 * 4-7 unused
341 *
342 * ILOCK values
343 * 0-4 subclass values
344 * 5 PARENT subclass (not nestable)
345 * 6 RTBITMAP subclass (not nestable)
346 * 7 RTSUM subclass (not nestable)
347 *
348 */
349#define XFS_IOLOCK_SHIFT 16
350#define XFS_IOLOCK_MAX_SUBCLASS 3
351#define XFS_IOLOCK_DEP_MASK 0x000f0000
352
353#define XFS_MMAPLOCK_SHIFT 20
354#define XFS_MMAPLOCK_NUMORDER 0
355#define XFS_MMAPLOCK_MAX_SUBCLASS 3
356#define XFS_MMAPLOCK_DEP_MASK 0x00f00000
357
358#define XFS_ILOCK_SHIFT 24
359#define XFS_ILOCK_PARENT_VAL 5
360#define XFS_ILOCK_MAX_SUBCLASS (XFS_ILOCK_PARENT_VAL - 1)
361#define XFS_ILOCK_RTBITMAP_VAL 6
362#define XFS_ILOCK_RTSUM_VAL 7
363#define XFS_ILOCK_DEP_MASK 0xff000000
364#define XFS_ILOCK_PARENT (XFS_ILOCK_PARENT_VAL << XFS_ILOCK_SHIFT)
365#define XFS_ILOCK_RTBITMAP (XFS_ILOCK_RTBITMAP_VAL << XFS_ILOCK_SHIFT)
366#define XFS_ILOCK_RTSUM (XFS_ILOCK_RTSUM_VAL << XFS_ILOCK_SHIFT)
367
368#define XFS_LOCK_SUBCLASS_MASK (XFS_IOLOCK_DEP_MASK | \
369 XFS_MMAPLOCK_DEP_MASK | \
370 XFS_ILOCK_DEP_MASK)
371
372#define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) \
373 >> XFS_IOLOCK_SHIFT)
374#define XFS_MMAPLOCK_DEP(flags) (((flags) & XFS_MMAPLOCK_DEP_MASK) \
375 >> XFS_MMAPLOCK_SHIFT)
376#define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) \
377 >> XFS_ILOCK_SHIFT)
378
379/*
380 * For multiple groups support: if S_ISGID bit is set in the parent
381 * directory, group of new file is set to that of the parent, and
382 * new subdirectory gets S_ISGID bit from parent.
383 */
384#define XFS_INHERIT_GID(pip) \
385 (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \
386 (VFS_I(pip)->i_mode & S_ISGID))
387
388int xfs_release(struct xfs_inode *ip);
389void xfs_inactive(struct xfs_inode *ip);
390int xfs_lookup(struct xfs_inode *dp, struct xfs_name *name,
391 struct xfs_inode **ipp, struct xfs_name *ci_name);
392int xfs_create(struct xfs_inode *dp, struct xfs_name *name,
393 umode_t mode, xfs_dev_t rdev, struct xfs_inode **ipp);
394int xfs_create_tmpfile(struct xfs_inode *dp, struct dentry *dentry,
395 umode_t mode, struct xfs_inode **ipp);
396int xfs_remove(struct xfs_inode *dp, struct xfs_name *name,
397 struct xfs_inode *ip);
398int xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip,
399 struct xfs_name *target_name);
400int xfs_rename(struct xfs_inode *src_dp, struct xfs_name *src_name,
401 struct xfs_inode *src_ip, struct xfs_inode *target_dp,
402 struct xfs_name *target_name,
403 struct xfs_inode *target_ip, unsigned int flags);
404
405void xfs_ilock(xfs_inode_t *, uint);
406int xfs_ilock_nowait(xfs_inode_t *, uint);
407void xfs_iunlock(xfs_inode_t *, uint);
408void xfs_ilock_demote(xfs_inode_t *, uint);
409int xfs_isilocked(xfs_inode_t *, uint);
410uint xfs_ilock_data_map_shared(struct xfs_inode *);
411uint xfs_ilock_attr_map_shared(struct xfs_inode *);
412
413uint xfs_ip2xflags(struct xfs_inode *);
414int xfs_ifree(struct xfs_trans *, xfs_inode_t *,
415 struct xfs_defer_ops *);
416int xfs_itruncate_extents(struct xfs_trans **, struct xfs_inode *,
417 int, xfs_fsize_t);
418void xfs_iext_realloc(xfs_inode_t *, int, int);
419
420void xfs_iunpin_wait(xfs_inode_t *);
421#define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
422
423int xfs_iflush(struct xfs_inode *, struct xfs_buf **);
424void xfs_lock_two_inodes(xfs_inode_t *, xfs_inode_t *, uint);
425
426xfs_extlen_t xfs_get_extsz_hint(struct xfs_inode *ip);
427xfs_extlen_t xfs_get_cowextsz_hint(struct xfs_inode *ip);
428
429int xfs_dir_ialloc(struct xfs_trans **, struct xfs_inode *, umode_t,
430 xfs_nlink_t, xfs_dev_t, prid_t, int,
431 struct xfs_inode **, int *);
432
433/* from xfs_file.c */
434enum xfs_prealloc_flags {
435 XFS_PREALLOC_SET = (1 << 1),
436 XFS_PREALLOC_CLEAR = (1 << 2),
437 XFS_PREALLOC_SYNC = (1 << 3),
438 XFS_PREALLOC_INVISIBLE = (1 << 4),
439};
440
441int xfs_update_prealloc_flags(struct xfs_inode *ip,
442 enum xfs_prealloc_flags flags);
443int xfs_zero_eof(struct xfs_inode *ip, xfs_off_t offset,
444 xfs_fsize_t isize, bool *did_zeroing);
445int xfs_zero_range(struct xfs_inode *ip, xfs_off_t pos, xfs_off_t count,
446 bool *did_zero);
447loff_t __xfs_seek_hole_data(struct inode *inode, loff_t start,
448 loff_t eof, int whence);
449
450
451/* from xfs_iops.c */
452extern void xfs_setup_inode(struct xfs_inode *ip);
453extern void xfs_setup_iops(struct xfs_inode *ip);
454
455/*
456 * When setting up a newly allocated inode, we need to call
457 * xfs_finish_inode_setup() once the inode is fully instantiated at
458 * the VFS level to prevent the rest of the world seeing the inode
459 * before we've completed instantiation. Otherwise we can do it
460 * the moment the inode lookup is complete.
461 */
462static inline void xfs_finish_inode_setup(struct xfs_inode *ip)
463{
464 xfs_iflags_clear(ip, XFS_INEW);
465 barrier();
466 unlock_new_inode(VFS_I(ip));
467}
468
469static inline void xfs_setup_existing_inode(struct xfs_inode *ip)
470{
471 xfs_setup_inode(ip);
472 xfs_setup_iops(ip);
473 xfs_finish_inode_setup(ip);
474}
475
476#define IHOLD(ip) \
477do { \
478 ASSERT(atomic_read(&VFS_I(ip)->i_count) > 0) ; \
479 ihold(VFS_I(ip)); \
480 trace_xfs_ihold(ip, _THIS_IP_); \
481} while (0)
482
483#define IRELE(ip) \
484do { \
485 trace_xfs_irele(ip, _THIS_IP_); \
486 iput(VFS_I(ip)); \
487} while (0)
488
489extern struct kmem_zone *xfs_inode_zone;
490
491/* The default CoW extent size hint. */
492#define XFS_DEFAULT_COWEXTSZ_HINT 32
493
494#endif /* __XFS_INODE_H__ */