xref: /linux/fs/xfs/xfs_mount.h (revision b477ff98d903618a1ab8247861f2ea6e70c0f0f8)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (c) 2000-2005 Silicon Graphics, Inc.
4  * All Rights Reserved.
5  */
6 #ifndef __XFS_MOUNT_H__
7 #define	__XFS_MOUNT_H__
8 
9 struct xlog;
10 struct xfs_inode;
11 struct xfs_mru_cache;
12 struct xfs_ail;
13 struct xfs_quotainfo;
14 struct xfs_da_geometry;
15 struct xfs_perag;
16 
17 /* dynamic preallocation free space thresholds, 5% down to 1% */
18 enum {
19 	XFS_LOWSP_1_PCNT = 0,
20 	XFS_LOWSP_2_PCNT,
21 	XFS_LOWSP_3_PCNT,
22 	XFS_LOWSP_4_PCNT,
23 	XFS_LOWSP_5_PCNT,
24 	XFS_LOWSP_MAX,
25 };
26 
27 /*
28  * Error Configuration
29  *
30  * Error classes define the subsystem the configuration belongs to.
31  * Error numbers define the errors that are configurable.
32  */
33 enum {
34 	XFS_ERR_METADATA,
35 	XFS_ERR_CLASS_MAX,
36 };
37 enum {
38 	XFS_ERR_DEFAULT,
39 	XFS_ERR_EIO,
40 	XFS_ERR_ENOSPC,
41 	XFS_ERR_ENODEV,
42 	XFS_ERR_ERRNO_MAX,
43 };
44 
45 #define XFS_ERR_RETRY_FOREVER	-1
46 
47 /*
48  * Although retry_timeout is in jiffies which is normally an unsigned long,
49  * we limit the retry timeout to 86400 seconds, or one day.  So even a
50  * signed 32-bit long is sufficient for a HZ value up to 24855.  Making it
51  * signed lets us store the special "-1" value, meaning retry forever.
52  */
53 struct xfs_error_cfg {
54 	struct xfs_kobj	kobj;
55 	int		max_retries;
56 	long		retry_timeout;	/* in jiffies, -1 = infinite */
57 };
58 
59 /*
60  * Per-cpu deferred inode inactivation GC lists.
61  */
62 struct xfs_inodegc {
63 	struct xfs_mount	*mp;
64 	struct llist_head	list;
65 	struct delayed_work	work;
66 	int			error;
67 
68 	/* approximate count of inodes in the list */
69 	unsigned int		items;
70 	unsigned int		shrinker_hits;
71 	unsigned int		cpu;
72 };
73 
74 /*
75  * Container for each type of groups, used to look up individual groups and
76  * describes the geometry.
77  */
78 struct xfs_groups {
79 	struct xarray		xa;
80 
81 	/*
82 	 * Maximum capacity of the group in FSBs.
83 	 *
84 	 * Each group is laid out densely in the daddr space.  For the
85 	 * degenerate case of a pre-rtgroups filesystem, the incore rtgroup
86 	 * pretends to have a zero-block and zero-blklog rtgroup.
87 	 */
88 	uint32_t		blocks;
89 
90 	/*
91 	 * Log(2) of the logical size of each group.
92 	 *
93 	 * Compared to the blocks field above this is rounded up to the next
94 	 * power of two, and thus lays out the xfs_fsblock_t/xfs_rtblock_t
95 	 * space sparsely with a hole from blocks to (1 << blklog) at the end
96 	 * of each group.
97 	 */
98 	uint8_t			blklog;
99 
100 	/*
101 	 * Mask to extract the group-relative block number from a FSB.
102 	 * For a pre-rtgroups filesystem we pretend to have one very large
103 	 * rtgroup, so this mask must be 64-bit.
104 	 */
105 	uint64_t		blkmask;
106 };
107 
108 /*
109  * The struct xfsmount layout is optimised to separate read-mostly variables
110  * from variables that are frequently modified. We put the read-mostly variables
111  * first, then place all the other variables at the end.
112  *
113  * Typically, read-mostly variables are those that are set at mount time and
114  * never changed again, or only change rarely as a result of things like sysfs
115  * knobs being tweaked.
116  */
117 typedef struct xfs_mount {
118 	struct xfs_sb		m_sb;		/* copy of fs superblock */
119 	struct super_block	*m_super;
120 	struct xfs_ail		*m_ail;		/* fs active log item list */
121 	struct xfs_buf		*m_sb_bp;	/* buffer for superblock */
122 	struct xfs_buf		*m_rtsb_bp;	/* realtime superblock */
123 	char			*m_rtname;	/* realtime device name */
124 	char			*m_logname;	/* external log device name */
125 	struct xfs_da_geometry	*m_dir_geo;	/* directory block geometry */
126 	struct xfs_da_geometry	*m_attr_geo;	/* attribute block geometry */
127 	struct xlog		*m_log;		/* log specific stuff */
128 	struct xfs_inode	*m_rootip;	/* pointer to root directory */
129 	struct xfs_inode	*m_metadirip;	/* ptr to metadata directory */
130 	struct xfs_inode	*m_rtdirip;	/* ptr to realtime metadir */
131 	struct xfs_quotainfo	*m_quotainfo;	/* disk quota information */
132 	struct xfs_buftarg	*m_ddev_targp;	/* data device */
133 	struct xfs_buftarg	*m_logdev_targp;/* log device */
134 	struct xfs_buftarg	*m_rtdev_targp;	/* rt device */
135 	void __percpu		*m_inodegc;	/* percpu inodegc structures */
136 	struct xfs_mru_cache	*m_filestream;  /* per-mount filestream data */
137 	struct workqueue_struct *m_buf_workqueue;
138 	struct workqueue_struct	*m_unwritten_workqueue;
139 	struct workqueue_struct	*m_reclaim_workqueue;
140 	struct workqueue_struct	*m_sync_workqueue;
141 	struct workqueue_struct *m_blockgc_wq;
142 	struct workqueue_struct *m_inodegc_wq;
143 
144 	int			m_bsize;	/* fs logical block size */
145 	uint8_t			m_blkbit_log;	/* blocklog + NBBY */
146 	uint8_t			m_blkbb_log;	/* blocklog - BBSHIFT */
147 	uint8_t			m_agno_log;	/* log #ag's */
148 	uint8_t			m_sectbb_log;	/* sectlog - BBSHIFT */
149 	int8_t			m_rtxblklog;	/* log2 of rextsize, if possible */
150 
151 	uint			m_blockmask;	/* sb_blocksize-1 */
152 	uint			m_blockwsize;	/* sb_blocksize in words */
153 	/* number of rt extents per rt bitmap block if rtgroups enabled */
154 	unsigned int		m_rtx_per_rbmblock;
155 	uint			m_alloc_mxr[2];	/* max alloc btree records */
156 	uint			m_alloc_mnr[2];	/* min alloc btree records */
157 	uint			m_bmap_dmxr[2];	/* max bmap btree records */
158 	uint			m_bmap_dmnr[2];	/* min bmap btree records */
159 	uint			m_rmap_mxr[2];	/* max rmap btree records */
160 	uint			m_rmap_mnr[2];	/* min rmap btree records */
161 	uint			m_rtrmap_mxr[2]; /* max rtrmap btree records */
162 	uint			m_rtrmap_mnr[2]; /* min rtrmap btree records */
163 	uint			m_refc_mxr[2];	/* max refc btree records */
164 	uint			m_refc_mnr[2];	/* min refc btree records */
165 	uint			m_rtrefc_mxr[2]; /* max rtrefc btree records */
166 	uint			m_rtrefc_mnr[2]; /* min rtrefc btree records */
167 	uint			m_alloc_maxlevels; /* max alloc btree levels */
168 	uint			m_bm_maxlevels[2]; /* max bmap btree levels */
169 	uint			m_rmap_maxlevels; /* max rmap btree levels */
170 	uint			m_rtrmap_maxlevels; /* max rtrmap btree level */
171 	uint			m_refc_maxlevels; /* max refcount btree level */
172 	uint			m_rtrefc_maxlevels; /* max rtrefc btree level */
173 	unsigned int		m_agbtree_maxlevels; /* max level of all AG btrees */
174 	unsigned int		m_rtbtree_maxlevels; /* max level of all rt btrees */
175 	xfs_extlen_t		m_ag_prealloc_blocks; /* reserved ag blocks */
176 	uint			m_alloc_set_aside; /* space we can't use */
177 	uint			m_ag_max_usable; /* max space per AG */
178 	int			m_dalign;	/* stripe unit */
179 	int			m_swidth;	/* stripe width */
180 	xfs_agnumber_t		m_maxagi;	/* highest inode alloc group */
181 	uint			m_allocsize_log;/* min write size log bytes */
182 	uint			m_allocsize_blocks; /* min write size blocks */
183 	int			m_logbufs;	/* number of log buffers */
184 	int			m_logbsize;	/* size of each log buffer */
185 	unsigned int		m_rsumlevels;	/* rt summary levels */
186 	xfs_filblks_t		m_rsumblocks;	/* size of rt summary, FSBs */
187 	int			m_fixedfsid[2];	/* unchanged for life of FS */
188 	uint			m_qflags;	/* quota status flags */
189 	uint64_t		m_features;	/* active filesystem features */
190 	uint64_t		m_low_space[XFS_LOWSP_MAX];
191 	uint64_t		m_low_rtexts[XFS_LOWSP_MAX];
192 	uint64_t		m_rtxblkmask;	/* rt extent block mask */
193 	struct xfs_ino_geometry	m_ino_geo;	/* inode geometry */
194 	struct xfs_trans_resv	m_resv;		/* precomputed res values */
195 						/* low free space thresholds */
196 	unsigned long		m_opstate;	/* dynamic state flags */
197 	bool			m_always_cow;
198 	bool			m_fail_unmount;
199 	bool			m_finobt_nores; /* no per-AG finobt resv. */
200 	bool			m_update_sb;	/* sb needs update in mount */
201 
202 	/*
203 	 * Bitsets of per-fs metadata that have been checked and/or are sick.
204 	 * Callers must hold m_sb_lock to access these two fields.
205 	 */
206 	uint8_t			m_fs_checked;
207 	uint8_t			m_fs_sick;
208 	/*
209 	 * Bitsets of rt metadata that have been checked and/or are sick.
210 	 * Callers must hold m_sb_lock to access this field.
211 	 */
212 	uint8_t			m_rt_checked;
213 	uint8_t			m_rt_sick;
214 
215 	/*
216 	 * End of read-mostly variables. Frequently written variables and locks
217 	 * should be placed below this comment from now on. The first variable
218 	 * here is marked as cacheline aligned so they it is separated from
219 	 * the read-mostly variables.
220 	 */
221 
222 	spinlock_t ____cacheline_aligned m_sb_lock; /* sb counter lock */
223 	struct percpu_counter	m_icount;	/* allocated inodes counter */
224 	struct percpu_counter	m_ifree;	/* free inodes counter */
225 	struct percpu_counter	m_fdblocks;	/* free block counter */
226 	struct percpu_counter	m_frextents;	/* free rt extent counter */
227 
228 	/*
229 	 * Count of data device blocks reserved for delayed allocations,
230 	 * including indlen blocks.  Does not include allocated CoW staging
231 	 * extents or anything related to the rt device.
232 	 */
233 	struct percpu_counter	m_delalloc_blks;
234 
235 	/*
236 	 * RT version of the above.
237 	 */
238 	struct percpu_counter	m_delalloc_rtextents;
239 
240 	/*
241 	 * Global count of allocation btree blocks in use across all AGs. Only
242 	 * used when perag reservation is enabled. Helps prevent block
243 	 * reservation from attempting to reserve allocation btree blocks.
244 	 */
245 	atomic64_t		m_allocbt_blks;
246 
247 	struct xfs_groups	m_groups[XG_TYPE_MAX];
248 	uint64_t		m_resblks;	/* total reserved blocks */
249 	uint64_t		m_resblks_avail;/* available reserved blocks */
250 	uint64_t		m_resblks_save;	/* reserved blks @ remount,ro */
251 	struct delayed_work	m_reclaim_work;	/* background inode reclaim */
252 	struct dentry		*m_debugfs;	/* debugfs parent */
253 	struct xfs_kobj		m_kobj;
254 	struct xfs_kobj		m_error_kobj;
255 	struct xfs_kobj		m_error_meta_kobj;
256 	struct xfs_error_cfg	m_error_cfg[XFS_ERR_CLASS_MAX][XFS_ERR_ERRNO_MAX];
257 	struct xstats		m_stats;	/* per-fs stats */
258 #ifdef CONFIG_XFS_ONLINE_SCRUB_STATS
259 	struct xchk_stats	*m_scrub_stats;
260 #endif
261 	xfs_agnumber_t		m_agfrotor;	/* last ag where space found */
262 	atomic_t		m_agirotor;	/* last ag dir inode alloced */
263 	atomic_t		m_rtgrotor;	/* last rtgroup rtpicked */
264 
265 	/* Memory shrinker to throttle and reprioritize inodegc */
266 	struct shrinker		*m_inodegc_shrinker;
267 	/*
268 	 * Workqueue item so that we can coalesce multiple inode flush attempts
269 	 * into a single flush.
270 	 */
271 	struct work_struct	m_flush_inodes_work;
272 
273 	/*
274 	 * Generation of the filesysyem layout.  This is incremented by each
275 	 * growfs, and used by the pNFS server to ensure the client updates
276 	 * its view of the block device once it gets a layout that might
277 	 * reference the newly added blocks.  Does not need to be persistent
278 	 * as long as we only allow file system size increments, but if we
279 	 * ever support shrinks it would have to be persisted in addition
280 	 * to various other kinds of pain inflicted on the pNFS server.
281 	 */
282 	uint32_t		m_generation;
283 	struct mutex		m_growlock;	/* growfs mutex */
284 
285 #ifdef DEBUG
286 	/*
287 	 * Frequency with which errors are injected.  Replaces xfs_etest; the
288 	 * value stored in here is the inverse of the frequency with which the
289 	 * error triggers.  1 = always, 2 = half the time, etc.
290 	 */
291 	unsigned int		*m_errortag;
292 	struct xfs_kobj		m_errortag_kobj;
293 #endif
294 
295 	/* cpus that have inodes queued for inactivation */
296 	struct cpumask		m_inodegc_cpumask;
297 
298 	/* Hook to feed dirent updates to an active online repair. */
299 	struct xfs_hooks	m_dir_update_hooks;
300 } xfs_mount_t;
301 
302 #define M_IGEO(mp)		(&(mp)->m_ino_geo)
303 
304 /*
305  * Flags for m_features.
306  *
307  * These are all the active features in the filesystem, regardless of how
308  * they are configured.
309  */
310 #define XFS_FEAT_ATTR		(1ULL << 0)	/* xattrs present in fs */
311 #define XFS_FEAT_NLINK		(1ULL << 1)	/* 32 bit link counts */
312 #define XFS_FEAT_QUOTA		(1ULL << 2)	/* quota active */
313 #define XFS_FEAT_ALIGN		(1ULL << 3)	/* inode alignment */
314 #define XFS_FEAT_DALIGN		(1ULL << 4)	/* data alignment */
315 #define XFS_FEAT_LOGV2		(1ULL << 5)	/* version 2 logs */
316 #define XFS_FEAT_SECTOR		(1ULL << 6)	/* sector size > 512 bytes */
317 #define XFS_FEAT_EXTFLG		(1ULL << 7)	/* unwritten extents */
318 #define XFS_FEAT_ASCIICI	(1ULL << 8)	/* ASCII only case-insens. */
319 #define XFS_FEAT_LAZYSBCOUNT	(1ULL << 9)	/* Superblk counters */
320 #define XFS_FEAT_ATTR2		(1ULL << 10)	/* dynamic attr fork */
321 #define XFS_FEAT_PARENT		(1ULL << 11)	/* parent pointers */
322 #define XFS_FEAT_PROJID32	(1ULL << 12)	/* 32 bit project id */
323 #define XFS_FEAT_CRC		(1ULL << 13)	/* metadata CRCs */
324 #define XFS_FEAT_V3INODES	(1ULL << 14)	/* Version 3 inodes */
325 #define XFS_FEAT_PQUOTINO	(1ULL << 15)	/* non-shared proj/grp quotas */
326 #define XFS_FEAT_FTYPE		(1ULL << 16)	/* inode type in dir */
327 #define XFS_FEAT_FINOBT		(1ULL << 17)	/* free inode btree */
328 #define XFS_FEAT_RMAPBT		(1ULL << 18)	/* reverse map btree */
329 #define XFS_FEAT_REFLINK	(1ULL << 19)	/* reflinked files */
330 #define XFS_FEAT_SPINODES	(1ULL << 20)	/* sparse inode chunks */
331 #define XFS_FEAT_META_UUID	(1ULL << 21)	/* metadata UUID */
332 #define XFS_FEAT_REALTIME	(1ULL << 22)	/* realtime device present */
333 #define XFS_FEAT_INOBTCNT	(1ULL << 23)	/* inobt block counts */
334 #define XFS_FEAT_BIGTIME	(1ULL << 24)	/* large timestamps */
335 #define XFS_FEAT_NEEDSREPAIR	(1ULL << 25)	/* needs xfs_repair */
336 #define XFS_FEAT_NREXT64	(1ULL << 26)	/* large extent counters */
337 #define XFS_FEAT_EXCHANGE_RANGE	(1ULL << 27)	/* exchange range */
338 #define XFS_FEAT_METADIR	(1ULL << 28)	/* metadata directory tree */
339 
340 /* Mount features */
341 #define XFS_FEAT_NOATTR2	(1ULL << 48)	/* disable attr2 creation */
342 #define XFS_FEAT_NOALIGN	(1ULL << 49)	/* ignore alignment */
343 #define XFS_FEAT_ALLOCSIZE	(1ULL << 50)	/* user specified allocation size */
344 #define XFS_FEAT_LARGE_IOSIZE	(1ULL << 51)	/* report large preferred
345 						 * I/O size in stat() */
346 #define XFS_FEAT_WSYNC		(1ULL << 52)	/* synchronous metadata ops */
347 #define XFS_FEAT_DIRSYNC	(1ULL << 53)	/* synchronous directory ops */
348 #define XFS_FEAT_DISCARD	(1ULL << 54)	/* discard unused blocks */
349 #define XFS_FEAT_GRPID		(1ULL << 55)	/* group-ID assigned from directory */
350 #define XFS_FEAT_SMALL_INUMS	(1ULL << 56)	/* user wants 32bit inodes */
351 #define XFS_FEAT_IKEEP		(1ULL << 57)	/* keep empty inode clusters*/
352 #define XFS_FEAT_SWALLOC	(1ULL << 58)	/* stripe width allocation */
353 #define XFS_FEAT_FILESTREAMS	(1ULL << 59)	/* use filestreams allocator */
354 #define XFS_FEAT_DAX_ALWAYS	(1ULL << 60)	/* DAX always enabled */
355 #define XFS_FEAT_DAX_NEVER	(1ULL << 61)	/* DAX never enabled */
356 #define XFS_FEAT_NORECOVERY	(1ULL << 62)	/* no recovery - dirty fs */
357 #define XFS_FEAT_NOUUID		(1ULL << 63)	/* ignore uuid during mount */
358 
359 #define __XFS_HAS_FEAT(name, NAME) \
360 static inline bool xfs_has_ ## name (const struct xfs_mount *mp) \
361 { \
362 	return mp->m_features & XFS_FEAT_ ## NAME; \
363 }
364 
365 /* Some features can be added dynamically so they need a set wrapper, too. */
366 #define __XFS_ADD_FEAT(name, NAME) \
367 	__XFS_HAS_FEAT(name, NAME); \
368 static inline void xfs_add_ ## name (struct xfs_mount *mp) \
369 { \
370 	mp->m_features |= XFS_FEAT_ ## NAME; \
371 	xfs_sb_version_add ## name(&mp->m_sb); \
372 }
373 
374 /* Superblock features */
__XFS_ADD_FEAT(attr,ATTR)375 __XFS_ADD_FEAT(attr, ATTR)
376 __XFS_HAS_FEAT(nlink, NLINK)
377 __XFS_ADD_FEAT(quota, QUOTA)
378 __XFS_HAS_FEAT(dalign, DALIGN)
379 __XFS_HAS_FEAT(sector, SECTOR)
380 __XFS_HAS_FEAT(asciici, ASCIICI)
381 __XFS_HAS_FEAT(parent, PARENT)
382 __XFS_HAS_FEAT(ftype, FTYPE)
383 __XFS_HAS_FEAT(finobt, FINOBT)
384 __XFS_HAS_FEAT(rmapbt, RMAPBT)
385 __XFS_HAS_FEAT(reflink, REFLINK)
386 __XFS_HAS_FEAT(sparseinodes, SPINODES)
387 __XFS_HAS_FEAT(metauuid, META_UUID)
388 __XFS_HAS_FEAT(realtime, REALTIME)
389 __XFS_HAS_FEAT(inobtcounts, INOBTCNT)
390 __XFS_HAS_FEAT(bigtime, BIGTIME)
391 __XFS_HAS_FEAT(needsrepair, NEEDSREPAIR)
392 __XFS_HAS_FEAT(large_extent_counts, NREXT64)
393 __XFS_HAS_FEAT(exchange_range, EXCHANGE_RANGE)
394 __XFS_HAS_FEAT(metadir, METADIR)
395 
396 static inline bool xfs_has_rtgroups(const struct xfs_mount *mp)
397 {
398 	/* all metadir file systems also allow rtgroups */
399 	return xfs_has_metadir(mp);
400 }
401 
xfs_has_rtsb(const struct xfs_mount * mp)402 static inline bool xfs_has_rtsb(const struct xfs_mount *mp)
403 {
404 	/* all rtgroups filesystems with an rt section have an rtsb */
405 	return xfs_has_rtgroups(mp) && xfs_has_realtime(mp);
406 }
407 
xfs_has_rtrmapbt(const struct xfs_mount * mp)408 static inline bool xfs_has_rtrmapbt(const struct xfs_mount *mp)
409 {
410 	return xfs_has_rtgroups(mp) && xfs_has_realtime(mp) &&
411 	       xfs_has_rmapbt(mp);
412 }
413 
xfs_has_rtreflink(const struct xfs_mount * mp)414 static inline bool xfs_has_rtreflink(const struct xfs_mount *mp)
415 {
416 	return xfs_has_metadir(mp) && xfs_has_realtime(mp) &&
417 	       xfs_has_reflink(mp);
418 }
419 
420 /*
421  * Some features are always on for v5 file systems, allow the compiler to
422  * eliminiate dead code when building without v4 support.
423  */
424 #define __XFS_HAS_V4_FEAT(name, NAME) \
425 static inline bool xfs_has_ ## name (struct xfs_mount *mp) \
426 { \
427 	return !IS_ENABLED(CONFIG_XFS_SUPPORT_V4) || \
428 		(mp->m_features & XFS_FEAT_ ## NAME); \
429 }
430 
431 #define __XFS_ADD_V4_FEAT(name, NAME) \
432 	__XFS_HAS_V4_FEAT(name, NAME); \
433 static inline void xfs_add_ ## name (struct xfs_mount *mp) \
434 { \
435 	if (IS_ENABLED(CONFIG_XFS_SUPPORT_V4)) { \
436 		mp->m_features |= XFS_FEAT_ ## NAME; \
437 		xfs_sb_version_add ## name(&mp->m_sb); \
438 	} \
439 }
440 
__XFS_HAS_V4_FEAT(align,ALIGN)441 __XFS_HAS_V4_FEAT(align, ALIGN)
442 __XFS_HAS_V4_FEAT(logv2, LOGV2)
443 __XFS_HAS_V4_FEAT(extflg, EXTFLG)
444 __XFS_HAS_V4_FEAT(lazysbcount, LAZYSBCOUNT)
445 __XFS_ADD_V4_FEAT(attr2, ATTR2)
446 __XFS_ADD_V4_FEAT(projid32, PROJID32)
447 __XFS_HAS_V4_FEAT(v3inodes, V3INODES)
448 __XFS_HAS_V4_FEAT(crc, CRC)
449 __XFS_HAS_V4_FEAT(pquotino, PQUOTINO)
450 
451 /*
452  * Mount features
453  *
454  * These do not change dynamically - features that can come and go, such as 32
455  * bit inodes and read-only state, are kept as operational state rather than
456  * features.
457  */
458 __XFS_HAS_FEAT(noattr2, NOATTR2)
459 __XFS_HAS_FEAT(noalign, NOALIGN)
460 __XFS_HAS_FEAT(allocsize, ALLOCSIZE)
461 __XFS_HAS_FEAT(large_iosize, LARGE_IOSIZE)
462 __XFS_HAS_FEAT(wsync, WSYNC)
463 __XFS_HAS_FEAT(dirsync, DIRSYNC)
464 __XFS_HAS_FEAT(discard, DISCARD)
465 __XFS_HAS_FEAT(grpid, GRPID)
466 __XFS_HAS_FEAT(small_inums, SMALL_INUMS)
467 __XFS_HAS_FEAT(ikeep, IKEEP)
468 __XFS_HAS_FEAT(swalloc, SWALLOC)
469 __XFS_HAS_FEAT(filestreams, FILESTREAMS)
470 __XFS_HAS_FEAT(dax_always, DAX_ALWAYS)
471 __XFS_HAS_FEAT(dax_never, DAX_NEVER)
472 __XFS_HAS_FEAT(norecovery, NORECOVERY)
473 __XFS_HAS_FEAT(nouuid, NOUUID)
474 
475 /*
476  * Operational mount state flags
477  *
478  * Use these with atomic bit ops only!
479  */
480 #define XFS_OPSTATE_UNMOUNTING		0	/* filesystem is unmounting */
481 #define XFS_OPSTATE_CLEAN		1	/* mount was clean */
482 #define XFS_OPSTATE_SHUTDOWN		2	/* stop all fs operations */
483 #define XFS_OPSTATE_INODE32		3	/* inode32 allocator active */
484 #define XFS_OPSTATE_READONLY		4	/* read-only fs */
485 
486 /*
487  * If set, inactivation worker threads will be scheduled to process queued
488  * inodegc work.  If not, queued inodes remain in memory waiting to be
489  * processed.
490  */
491 #define XFS_OPSTATE_INODEGC_ENABLED	5
492 /*
493  * If set, background speculative prealloc gc worker threads will be scheduled
494  * to process queued blockgc work.  If not, inodes retain their preallocations
495  * until explicitly deleted.
496  */
497 #define XFS_OPSTATE_BLOCKGC_ENABLED	6
498 
499 /* Kernel has logged a warning about pNFS being used on this fs. */
500 #define XFS_OPSTATE_WARNED_PNFS		7
501 /* Kernel has logged a warning about online fsck being used on this fs. */
502 #define XFS_OPSTATE_WARNED_SCRUB	8
503 /* Kernel has logged a warning about shrink being used on this fs. */
504 #define XFS_OPSTATE_WARNED_SHRINK	9
505 /* Kernel has logged a warning about logged xattr updates being used. */
506 #define XFS_OPSTATE_WARNED_LARP		10
507 /* Mount time quotacheck is running */
508 #define XFS_OPSTATE_QUOTACHECK_RUNNING	11
509 /* Do we want to clear log incompat flags? */
510 #define XFS_OPSTATE_UNSET_LOG_INCOMPAT	12
511 /* Filesystem can use logged extended attributes */
512 #define XFS_OPSTATE_USE_LARP		13
513 /* Kernel has logged a warning about blocksize > pagesize on this fs. */
514 #define XFS_OPSTATE_WARNED_LBS		14
515 /* Kernel has logged a warning about exchange-range being used on this fs. */
516 #define XFS_OPSTATE_WARNED_EXCHRANGE	15
517 /* Kernel has logged a warning about parent pointers being used on this fs. */
518 #define XFS_OPSTATE_WARNED_PPTR		16
519 /* Kernel has logged a warning about metadata dirs being used on this fs. */
520 #define XFS_OPSTATE_WARNED_METADIR	17
521 /* Filesystem should use qflags to determine quotaon status */
522 #define XFS_OPSTATE_RESUMING_QUOTAON	18
523 
524 #define __XFS_IS_OPSTATE(name, NAME) \
525 static inline bool xfs_is_ ## name (struct xfs_mount *mp) \
526 { \
527 	return test_bit(XFS_OPSTATE_ ## NAME, &mp->m_opstate); \
528 } \
529 static inline bool xfs_clear_ ## name (struct xfs_mount *mp) \
530 { \
531 	return test_and_clear_bit(XFS_OPSTATE_ ## NAME, &mp->m_opstate); \
532 } \
533 static inline bool xfs_set_ ## name (struct xfs_mount *mp) \
534 { \
535 	return test_and_set_bit(XFS_OPSTATE_ ## NAME, &mp->m_opstate); \
536 }
537 
538 __XFS_IS_OPSTATE(unmounting, UNMOUNTING)
539 __XFS_IS_OPSTATE(clean, CLEAN)
540 __XFS_IS_OPSTATE(shutdown, SHUTDOWN)
541 __XFS_IS_OPSTATE(inode32, INODE32)
542 __XFS_IS_OPSTATE(readonly, READONLY)
543 __XFS_IS_OPSTATE(inodegc_enabled, INODEGC_ENABLED)
544 __XFS_IS_OPSTATE(blockgc_enabled, BLOCKGC_ENABLED)
545 #ifdef CONFIG_XFS_QUOTA
546 __XFS_IS_OPSTATE(quotacheck_running, QUOTACHECK_RUNNING)
547 __XFS_IS_OPSTATE(resuming_quotaon, RESUMING_QUOTAON)
548 #else
549 static inline bool xfs_is_quotacheck_running(struct xfs_mount *mp)
550 {
551 	return false;
552 }
553 static inline bool xfs_is_resuming_quotaon(struct xfs_mount *mp)
554 {
555 	return false;
556 }
557 static inline void xfs_set_resuming_quotaon(struct xfs_mount *m)
558 {
559 }
560 static inline bool xfs_clear_resuming_quotaon(struct xfs_mount *mp)
561 {
562 	return false;
563 }
564 #endif /* CONFIG_XFS_QUOTA */
565 __XFS_IS_OPSTATE(done_with_log_incompat, UNSET_LOG_INCOMPAT)
566 __XFS_IS_OPSTATE(using_logged_xattrs, USE_LARP)
567 
568 static inline bool
569 xfs_should_warn(struct xfs_mount *mp, long nr)
570 {
571 	return !test_and_set_bit(nr, &mp->m_opstate);
572 }
573 
574 #define XFS_OPSTATE_STRINGS \
575 	{ (1UL << XFS_OPSTATE_UNMOUNTING),		"unmounting" }, \
576 	{ (1UL << XFS_OPSTATE_CLEAN),			"clean" }, \
577 	{ (1UL << XFS_OPSTATE_SHUTDOWN),		"shutdown" }, \
578 	{ (1UL << XFS_OPSTATE_INODE32),			"inode32" }, \
579 	{ (1UL << XFS_OPSTATE_READONLY),		"read_only" }, \
580 	{ (1UL << XFS_OPSTATE_INODEGC_ENABLED),		"inodegc" }, \
581 	{ (1UL << XFS_OPSTATE_BLOCKGC_ENABLED),		"blockgc" }, \
582 	{ (1UL << XFS_OPSTATE_WARNED_SCRUB),		"wscrub" }, \
583 	{ (1UL << XFS_OPSTATE_WARNED_SHRINK),		"wshrink" }, \
584 	{ (1UL << XFS_OPSTATE_WARNED_LARP),		"wlarp" }, \
585 	{ (1UL << XFS_OPSTATE_QUOTACHECK_RUNNING),	"quotacheck" }, \
586 	{ (1UL << XFS_OPSTATE_UNSET_LOG_INCOMPAT),	"unset_log_incompat" }, \
587 	{ (1UL << XFS_OPSTATE_USE_LARP),		"logged_xattrs" }
588 
589 /*
590  * Max and min values for mount-option defined I/O
591  * preallocation sizes.
592  */
593 #define XFS_MAX_IO_LOG		30	/* 1G */
594 #define XFS_MIN_IO_LOG		PAGE_SHIFT
595 
596 void xfs_do_force_shutdown(struct xfs_mount *mp, uint32_t flags, char *fname,
597 		int lnnum);
598 #define xfs_force_shutdown(m,f)	\
599 	xfs_do_force_shutdown(m, f, __FILE__, __LINE__)
600 
601 #define SHUTDOWN_META_IO_ERROR	(1u << 0) /* write attempt to metadata failed */
602 #define SHUTDOWN_LOG_IO_ERROR	(1u << 1) /* write attempt to the log failed */
603 #define SHUTDOWN_FORCE_UMOUNT	(1u << 2) /* shutdown from a forced unmount */
604 #define SHUTDOWN_CORRUPT_INCORE	(1u << 3) /* corrupt in-memory structures */
605 #define SHUTDOWN_CORRUPT_ONDISK	(1u << 4)  /* corrupt metadata on device */
606 #define SHUTDOWN_DEVICE_REMOVED	(1u << 5) /* device removed underneath us */
607 
608 #define XFS_SHUTDOWN_STRINGS \
609 	{ SHUTDOWN_META_IO_ERROR,	"metadata_io" }, \
610 	{ SHUTDOWN_LOG_IO_ERROR,	"log_io" }, \
611 	{ SHUTDOWN_FORCE_UMOUNT,	"force_umount" }, \
612 	{ SHUTDOWN_CORRUPT_INCORE,	"corruption" }, \
613 	{ SHUTDOWN_DEVICE_REMOVED,	"device_removed" }
614 
615 /*
616  * Flags for xfs_mountfs
617  */
618 #define XFS_MFSI_QUIET		0x40	/* Be silent if mount errors found */
619 
620 static inline xfs_agnumber_t
xfs_daddr_to_agno(struct xfs_mount * mp,xfs_daddr_t d)621 xfs_daddr_to_agno(struct xfs_mount *mp, xfs_daddr_t d)
622 {
623 	xfs_rfsblock_t ld = XFS_BB_TO_FSBT(mp, d);
624 	do_div(ld, mp->m_sb.sb_agblocks);
625 	return (xfs_agnumber_t) ld;
626 }
627 
628 static inline xfs_agblock_t
xfs_daddr_to_agbno(struct xfs_mount * mp,xfs_daddr_t d)629 xfs_daddr_to_agbno(struct xfs_mount *mp, xfs_daddr_t d)
630 {
631 	xfs_rfsblock_t ld = XFS_BB_TO_FSBT(mp, d);
632 	return (xfs_agblock_t) do_div(ld, mp->m_sb.sb_agblocks);
633 }
634 
635 extern void	xfs_uuid_table_free(void);
636 extern uint64_t xfs_default_resblks(xfs_mount_t *mp);
637 extern int	xfs_mountfs(xfs_mount_t *mp);
638 extern void	xfs_unmountfs(xfs_mount_t *);
639 
640 /*
641  * Deltas for the block count can vary from 1 to very large, but lock contention
642  * only occurs on frequent small block count updates such as in the delayed
643  * allocation path for buffered writes (page a time updates). Hence we set
644  * a large batch count (1024) to minimise global counter updates except when
645  * we get near to ENOSPC and we have to be very accurate with our updates.
646  */
647 #define XFS_FDBLOCKS_BATCH	1024
648 
649 /*
650  * Estimate the amount of free space that is not available to userspace and is
651  * not explicitly reserved from the incore fdblocks.  This includes:
652  *
653  * - The minimum number of blocks needed to support splitting a bmap btree
654  * - The blocks currently in use by the freespace btrees because they record
655  *   the actual blocks that will fill per-AG metadata space reservations
656  */
657 static inline uint64_t
xfs_fdblocks_unavailable(struct xfs_mount * mp)658 xfs_fdblocks_unavailable(
659 	struct xfs_mount	*mp)
660 {
661 	return mp->m_alloc_set_aside + atomic64_read(&mp->m_allocbt_blks);
662 }
663 
664 int xfs_dec_freecounter(struct xfs_mount *mp, struct percpu_counter *counter,
665 		uint64_t delta, bool rsvd);
666 void xfs_add_freecounter(struct xfs_mount *mp, struct percpu_counter *counter,
667 		uint64_t delta);
668 
xfs_dec_fdblocks(struct xfs_mount * mp,uint64_t delta,bool reserved)669 static inline int xfs_dec_fdblocks(struct xfs_mount *mp, uint64_t delta,
670 		bool reserved)
671 {
672 	return xfs_dec_freecounter(mp, &mp->m_fdblocks, delta, reserved);
673 }
674 
xfs_add_fdblocks(struct xfs_mount * mp,uint64_t delta)675 static inline void xfs_add_fdblocks(struct xfs_mount *mp, uint64_t delta)
676 {
677 	xfs_add_freecounter(mp, &mp->m_fdblocks, delta);
678 }
679 
xfs_dec_frextents(struct xfs_mount * mp,uint64_t delta)680 static inline int xfs_dec_frextents(struct xfs_mount *mp, uint64_t delta)
681 {
682 	return xfs_dec_freecounter(mp, &mp->m_frextents, delta, false);
683 }
684 
xfs_add_frextents(struct xfs_mount * mp,uint64_t delta)685 static inline void xfs_add_frextents(struct xfs_mount *mp, uint64_t delta)
686 {
687 	xfs_add_freecounter(mp, &mp->m_frextents, delta);
688 }
689 
690 extern int	xfs_readsb(xfs_mount_t *, int);
691 extern void	xfs_freesb(xfs_mount_t *);
692 extern bool	xfs_fs_writable(struct xfs_mount *mp, int level);
693 extern int	xfs_sb_validate_fsb_count(struct xfs_sb *, uint64_t);
694 
695 extern int	xfs_dev_is_read_only(struct xfs_mount *, char *);
696 
697 extern void	xfs_set_low_space_thresholds(struct xfs_mount *);
698 
699 int	xfs_zero_extent(struct xfs_inode *ip, xfs_fsblock_t start_fsb,
700 			xfs_off_t count_fsb);
701 
702 struct xfs_error_cfg * xfs_error_get_cfg(struct xfs_mount *mp,
703 		int error_class, int error);
704 void xfs_force_summary_recalc(struct xfs_mount *mp);
705 int xfs_add_incompat_log_feature(struct xfs_mount *mp, uint32_t feature);
706 bool xfs_clear_incompat_log_features(struct xfs_mount *mp);
707 void xfs_mod_delalloc(struct xfs_inode *ip, int64_t data_delta,
708 		int64_t ind_delta);
709 
710 #endif	/* __XFS_MOUNT_H__ */
711