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