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