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