xref: /openbmc/linux/fs/xfs/xfs_mount.h (revision 82003e04)
1 /*
2  * Copyright (c) 2000-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_MOUNT_H__
19 #define	__XFS_MOUNT_H__
20 
21 struct xlog;
22 struct xfs_inode;
23 struct xfs_mru_cache;
24 struct xfs_nameops;
25 struct xfs_ail;
26 struct xfs_quotainfo;
27 struct xfs_dir_ops;
28 struct xfs_da_geometry;
29 
30 /* dynamic preallocation free space thresholds, 5% down to 1% */
31 enum {
32 	XFS_LOWSP_1_PCNT = 0,
33 	XFS_LOWSP_2_PCNT,
34 	XFS_LOWSP_3_PCNT,
35 	XFS_LOWSP_4_PCNT,
36 	XFS_LOWSP_5_PCNT,
37 	XFS_LOWSP_MAX,
38 };
39 
40 /*
41  * Error Configuration
42  *
43  * Error classes define the subsystem the configuration belongs to.
44  * Error numbers define the errors that are configurable.
45  */
46 enum {
47 	XFS_ERR_METADATA,
48 	XFS_ERR_CLASS_MAX,
49 };
50 enum {
51 	XFS_ERR_DEFAULT,
52 	XFS_ERR_EIO,
53 	XFS_ERR_ENOSPC,
54 	XFS_ERR_ENODEV,
55 	XFS_ERR_ERRNO_MAX,
56 };
57 
58 #define XFS_ERR_RETRY_FOREVER	-1
59 
60 /*
61  * Although retry_timeout is in jiffies which is normally an unsigned long,
62  * we limit the retry timeout to 86400 seconds, or one day.  So even a
63  * signed 32-bit long is sufficient for a HZ value up to 24855.  Making it
64  * signed lets us store the special "-1" value, meaning retry forever.
65  */
66 struct xfs_error_cfg {
67 	struct xfs_kobj	kobj;
68 	int		max_retries;
69 	long		retry_timeout;	/* in jiffies, -1 = infinite */
70 };
71 
72 typedef struct xfs_mount {
73 	struct super_block	*m_super;
74 	xfs_tid_t		m_tid;		/* next unused tid for fs */
75 	struct xfs_ail		*m_ail;		/* fs active log item list */
76 
77 	struct xfs_sb		m_sb;		/* copy of fs superblock */
78 	spinlock_t		m_sb_lock;	/* sb counter lock */
79 	struct percpu_counter	m_icount;	/* allocated inodes counter */
80 	struct percpu_counter	m_ifree;	/* free inodes counter */
81 	struct percpu_counter	m_fdblocks;	/* free block counter */
82 
83 	struct xfs_buf		*m_sb_bp;	/* buffer for superblock */
84 	char			*m_fsname;	/* filesystem name */
85 	int			m_fsname_len;	/* strlen of fs name */
86 	char			*m_rtname;	/* realtime device name */
87 	char			*m_logname;	/* external log device name */
88 	int			m_bsize;	/* fs logical block size */
89 	xfs_agnumber_t		m_agfrotor;	/* last ag where space found */
90 	xfs_agnumber_t		m_agirotor;	/* last ag dir inode alloced */
91 	spinlock_t		m_agirotor_lock;/* .. and lock protecting it */
92 	xfs_agnumber_t		m_maxagi;	/* highest inode alloc group */
93 	uint			m_readio_log;	/* min read size log bytes */
94 	uint			m_readio_blocks; /* min read size blocks */
95 	uint			m_writeio_log;	/* min write size log bytes */
96 	uint			m_writeio_blocks; /* min write size blocks */
97 	struct xfs_da_geometry	*m_dir_geo;	/* directory block geometry */
98 	struct xfs_da_geometry	*m_attr_geo;	/* attribute block geometry */
99 	struct xlog		*m_log;		/* log specific stuff */
100 	int			m_logbufs;	/* number of log buffers */
101 	int			m_logbsize;	/* size of each log buffer */
102 	uint			m_rsumlevels;	/* rt summary levels */
103 	uint			m_rsumsize;	/* size of rt summary, bytes */
104 	struct xfs_inode	*m_rbmip;	/* pointer to bitmap inode */
105 	struct xfs_inode	*m_rsumip;	/* pointer to summary inode */
106 	struct xfs_inode	*m_rootip;	/* pointer to root directory */
107 	struct xfs_quotainfo	*m_quotainfo;	/* disk quota information */
108 	xfs_buftarg_t		*m_ddev_targp;	/* saves taking the address */
109 	xfs_buftarg_t		*m_logdev_targp;/* ptr to log device */
110 	xfs_buftarg_t		*m_rtdev_targp;	/* ptr to rt device */
111 	__uint8_t		m_blkbit_log;	/* blocklog + NBBY */
112 	__uint8_t		m_blkbb_log;	/* blocklog - BBSHIFT */
113 	__uint8_t		m_agno_log;	/* log #ag's */
114 	__uint8_t		m_agino_log;	/* #bits for agino in inum */
115 	uint			m_inode_cluster_size;/* min inode buf size */
116 	uint			m_blockmask;	/* sb_blocksize-1 */
117 	uint			m_blockwsize;	/* sb_blocksize in words */
118 	uint			m_blockwmask;	/* blockwsize-1 */
119 	uint			m_alloc_mxr[2];	/* max alloc btree records */
120 	uint			m_alloc_mnr[2];	/* min alloc btree records */
121 	uint			m_bmap_dmxr[2];	/* max bmap btree records */
122 	uint			m_bmap_dmnr[2];	/* min bmap btree records */
123 	uint			m_inobt_mxr[2];	/* max inobt btree records */
124 	uint			m_inobt_mnr[2];	/* min inobt btree records */
125 	uint			m_rmap_mxr[2];	/* max rmap btree records */
126 	uint			m_rmap_mnr[2];	/* min rmap btree records */
127 	uint			m_refc_mxr[2];	/* max refc btree records */
128 	uint			m_refc_mnr[2];	/* min refc btree records */
129 	uint			m_ag_maxlevels;	/* XFS_AG_MAXLEVELS */
130 	uint			m_bm_maxlevels[2]; /* XFS_BM_MAXLEVELS */
131 	uint			m_in_maxlevels;	/* max inobt btree levels. */
132 	uint			m_rmap_maxlevels; /* max rmap btree levels */
133 	uint			m_refc_maxlevels; /* max refcount btree level */
134 	xfs_extlen_t		m_ag_prealloc_blocks; /* reserved ag blocks */
135 	uint			m_alloc_set_aside; /* space we can't use */
136 	uint			m_ag_max_usable; /* max space per AG */
137 	struct radix_tree_root	m_perag_tree;	/* per-ag accounting info */
138 	spinlock_t		m_perag_lock;	/* lock for m_perag_tree */
139 	struct mutex		m_growlock;	/* growfs mutex */
140 	int			m_fixedfsid[2];	/* unchanged for life of FS */
141 	uint			m_dmevmask;	/* DMI events for this FS */
142 	__uint64_t		m_flags;	/* global mount flags */
143 	int			m_ialloc_inos;	/* inodes in inode allocation */
144 	int			m_ialloc_blks;	/* blocks in inode allocation */
145 	int			m_ialloc_min_blks;/* min blocks in sparse inode
146 						   * allocation */
147 	int			m_inoalign_mask;/* mask sb_inoalignmt if used */
148 	uint			m_qflags;	/* quota status flags */
149 	struct xfs_trans_resv	m_resv;		/* precomputed res values */
150 	__uint64_t		m_maxicount;	/* maximum inode count */
151 	__uint64_t		m_resblks;	/* total reserved blocks */
152 	__uint64_t		m_resblks_avail;/* available reserved blocks */
153 	__uint64_t		m_resblks_save;	/* reserved blks @ remount,ro */
154 	int			m_dalign;	/* stripe unit */
155 	int			m_swidth;	/* stripe width */
156 	int			m_sinoalign;	/* stripe unit inode alignment */
157 	__uint8_t		m_sectbb_log;	/* sectlog - BBSHIFT */
158 	const struct xfs_nameops *m_dirnameops;	/* vector of dir name ops */
159 	const struct xfs_dir_ops *m_dir_inode_ops; /* vector of dir inode ops */
160 	const struct xfs_dir_ops *m_nondir_inode_ops; /* !dir inode ops */
161 	uint			m_chsize;	/* size of next field */
162 	atomic_t		m_active_trans;	/* number trans frozen */
163 	struct xfs_mru_cache	*m_filestream;  /* per-mount filestream data */
164 	struct delayed_work	m_reclaim_work;	/* background inode reclaim */
165 	struct delayed_work	m_eofblocks_work; /* background eof blocks
166 						     trimming */
167 	struct delayed_work	m_cowblocks_work; /* background cow blocks
168 						     trimming */
169 	bool			m_update_sb;	/* sb needs update in mount */
170 	int64_t			m_low_space[XFS_LOWSP_MAX];
171 						/* low free space thresholds */
172 	struct xfs_kobj		m_kobj;
173 	struct xfs_kobj		m_error_kobj;
174 	struct xfs_kobj		m_error_meta_kobj;
175 	struct xfs_error_cfg	m_error_cfg[XFS_ERR_CLASS_MAX][XFS_ERR_ERRNO_MAX];
176 	struct xstats		m_stats;	/* per-fs stats */
177 
178 	struct workqueue_struct *m_buf_workqueue;
179 	struct workqueue_struct	*m_data_workqueue;
180 	struct workqueue_struct	*m_unwritten_workqueue;
181 	struct workqueue_struct	*m_cil_workqueue;
182 	struct workqueue_struct	*m_reclaim_workqueue;
183 	struct workqueue_struct	*m_log_workqueue;
184 	struct workqueue_struct *m_eofblocks_workqueue;
185 
186 	/*
187 	 * Generation of the filesysyem layout.  This is incremented by each
188 	 * growfs, and used by the pNFS server to ensure the client updates
189 	 * its view of the block device once it gets a layout that might
190 	 * reference the newly added blocks.  Does not need to be persistent
191 	 * as long as we only allow file system size increments, but if we
192 	 * ever support shrinks it would have to be persisted in addition
193 	 * to various other kinds of pain inflicted on the pNFS server.
194 	 */
195 	__uint32_t		m_generation;
196 
197 	bool			m_fail_unmount;
198 #ifdef DEBUG
199 	/*
200 	 * DEBUG mode instrumentation to test and/or trigger delayed allocation
201 	 * block killing in the event of failed writes. When enabled, all
202 	 * buffered writes are forced to fail. All delalloc blocks in the range
203 	 * of the write (including pre-existing delalloc blocks!) are tossed as
204 	 * part of the write failure error handling sequence.
205 	 */
206 	bool			m_fail_writes;
207 #endif
208 } xfs_mount_t;
209 
210 /*
211  * Flags for m_flags.
212  */
213 #define XFS_MOUNT_WSYNC		(1ULL << 0)	/* for nfs - all metadata ops
214 						   must be synchronous except
215 						   for space allocations */
216 #define XFS_MOUNT_UNMOUNTING	(1ULL << 1)	/* filesystem is unmounting */
217 #define XFS_MOUNT_WAS_CLEAN	(1ULL << 3)
218 #define XFS_MOUNT_FS_SHUTDOWN	(1ULL << 4)	/* atomic stop of all filesystem
219 						   operations, typically for
220 						   disk errors in metadata */
221 #define XFS_MOUNT_DISCARD	(1ULL << 5)	/* discard unused blocks */
222 #define XFS_MOUNT_NOALIGN	(1ULL << 7)	/* turn off stripe alignment
223 						   allocations */
224 #define XFS_MOUNT_ATTR2		(1ULL << 8)	/* allow use of attr2 format */
225 #define XFS_MOUNT_GRPID		(1ULL << 9)	/* group-ID assigned from directory */
226 #define XFS_MOUNT_NORECOVERY	(1ULL << 10)	/* no recovery - dirty fs */
227 #define XFS_MOUNT_DFLT_IOSIZE	(1ULL << 12)	/* set default i/o size */
228 #define XFS_MOUNT_SMALL_INUMS	(1ULL << 14)	/* user wants 32bit inodes */
229 #define XFS_MOUNT_32BITINODES	(1ULL << 15)	/* inode32 allocator active */
230 #define XFS_MOUNT_NOUUID	(1ULL << 16)	/* ignore uuid during mount */
231 #define XFS_MOUNT_BARRIER	(1ULL << 17)
232 #define XFS_MOUNT_IKEEP		(1ULL << 18)	/* keep empty inode clusters*/
233 #define XFS_MOUNT_SWALLOC	(1ULL << 19)	/* turn on stripe width
234 						 * allocation */
235 #define XFS_MOUNT_RDONLY	(1ULL << 20)	/* read-only fs */
236 #define XFS_MOUNT_DIRSYNC	(1ULL << 21)	/* synchronous directory ops */
237 #define XFS_MOUNT_COMPAT_IOSIZE	(1ULL << 22)	/* don't report large preferred
238 						 * I/O size in stat() */
239 #define XFS_MOUNT_FILESTREAMS	(1ULL << 24)	/* enable the filestreams
240 						   allocator */
241 #define XFS_MOUNT_NOATTR2	(1ULL << 25)	/* disable use of attr2 format */
242 
243 #define XFS_MOUNT_DAX		(1ULL << 62)	/* TEST ONLY! */
244 
245 
246 /*
247  * Default minimum read and write sizes.
248  */
249 #define XFS_READIO_LOG_LARGE	16
250 #define XFS_WRITEIO_LOG_LARGE	16
251 
252 /*
253  * Max and min values for mount-option defined I/O
254  * preallocation sizes.
255  */
256 #define XFS_MAX_IO_LOG		30	/* 1G */
257 #define XFS_MIN_IO_LOG		PAGE_SHIFT
258 
259 /*
260  * Synchronous read and write sizes.  This should be
261  * better for NFSv2 wsync filesystems.
262  */
263 #define	XFS_WSYNC_READIO_LOG	15	/* 32k */
264 #define	XFS_WSYNC_WRITEIO_LOG	14	/* 16k */
265 
266 /*
267  * Allow large block sizes to be reported to userspace programs if the
268  * "largeio" mount option is used.
269  *
270  * If compatibility mode is specified, simply return the basic unit of caching
271  * so that we don't get inefficient read/modify/write I/O from user apps.
272  * Otherwise....
273  *
274  * If the underlying volume is a stripe, then return the stripe width in bytes
275  * as the recommended I/O size. It is not a stripe and we've set a default
276  * buffered I/O size, return that, otherwise return the compat default.
277  */
278 static inline unsigned long
279 xfs_preferred_iosize(xfs_mount_t *mp)
280 {
281 	if (mp->m_flags & XFS_MOUNT_COMPAT_IOSIZE)
282 		return PAGE_SIZE;
283 	return (mp->m_swidth ?
284 		(mp->m_swidth << mp->m_sb.sb_blocklog) :
285 		((mp->m_flags & XFS_MOUNT_DFLT_IOSIZE) ?
286 			(1 << (int)MAX(mp->m_readio_log, mp->m_writeio_log)) :
287 			PAGE_SIZE));
288 }
289 
290 #define XFS_LAST_UNMOUNT_WAS_CLEAN(mp)	\
291 				((mp)->m_flags & XFS_MOUNT_WAS_CLEAN)
292 #define XFS_FORCED_SHUTDOWN(mp)	((mp)->m_flags & XFS_MOUNT_FS_SHUTDOWN)
293 void xfs_do_force_shutdown(struct xfs_mount *mp, int flags, char *fname,
294 		int lnnum);
295 #define xfs_force_shutdown(m,f)	\
296 	xfs_do_force_shutdown(m, f, __FILE__, __LINE__)
297 
298 #define SHUTDOWN_META_IO_ERROR	0x0001	/* write attempt to metadata failed */
299 #define SHUTDOWN_LOG_IO_ERROR	0x0002	/* write attempt to the log failed */
300 #define SHUTDOWN_FORCE_UMOUNT	0x0004	/* shutdown from a forced unmount */
301 #define SHUTDOWN_CORRUPT_INCORE	0x0008	/* corrupt in-memory data structures */
302 #define SHUTDOWN_REMOTE_REQ	0x0010	/* shutdown came from remote cell */
303 #define SHUTDOWN_DEVICE_REQ	0x0020	/* failed all paths to the device */
304 
305 /*
306  * Flags for xfs_mountfs
307  */
308 #define XFS_MFSI_QUIET		0x40	/* Be silent if mount errors found */
309 
310 static inline xfs_agnumber_t
311 xfs_daddr_to_agno(struct xfs_mount *mp, xfs_daddr_t d)
312 {
313 	xfs_daddr_t ld = XFS_BB_TO_FSBT(mp, d);
314 	do_div(ld, mp->m_sb.sb_agblocks);
315 	return (xfs_agnumber_t) ld;
316 }
317 
318 static inline xfs_agblock_t
319 xfs_daddr_to_agbno(struct xfs_mount *mp, xfs_daddr_t d)
320 {
321 	xfs_daddr_t ld = XFS_BB_TO_FSBT(mp, d);
322 	return (xfs_agblock_t) do_div(ld, mp->m_sb.sb_agblocks);
323 }
324 
325 #ifdef DEBUG
326 static inline bool
327 xfs_mp_fail_writes(struct xfs_mount *mp)
328 {
329 	return mp->m_fail_writes;
330 }
331 #else
332 static inline bool
333 xfs_mp_fail_writes(struct xfs_mount *mp)
334 {
335 	return 0;
336 }
337 #endif
338 
339 /* per-AG block reservation data structures*/
340 enum xfs_ag_resv_type {
341 	XFS_AG_RESV_NONE = 0,
342 	XFS_AG_RESV_METADATA,
343 	XFS_AG_RESV_AGFL,
344 };
345 
346 struct xfs_ag_resv {
347 	/* number of blocks originally reserved here */
348 	xfs_extlen_t			ar_orig_reserved;
349 	/* number of blocks reserved here */
350 	xfs_extlen_t			ar_reserved;
351 	/* number of blocks originally asked for */
352 	xfs_extlen_t			ar_asked;
353 };
354 
355 /*
356  * Per-ag incore structure, copies of information in agf and agi, to improve the
357  * performance of allocation group selection.
358  */
359 typedef struct xfs_perag {
360 	struct xfs_mount *pag_mount;	/* owner filesystem */
361 	xfs_agnumber_t	pag_agno;	/* AG this structure belongs to */
362 	atomic_t	pag_ref;	/* perag reference count */
363 	char		pagf_init;	/* this agf's entry is initialized */
364 	char		pagi_init;	/* this agi's entry is initialized */
365 	char		pagf_metadata;	/* the agf is preferred to be metadata */
366 	char		pagi_inodeok;	/* The agi is ok for inodes */
367 	__uint8_t	pagf_levels[XFS_BTNUM_AGF];
368 					/* # of levels in bno & cnt btree */
369 	__uint32_t	pagf_flcount;	/* count of blocks in freelist */
370 	xfs_extlen_t	pagf_freeblks;	/* total free blocks */
371 	xfs_extlen_t	pagf_longest;	/* longest free space */
372 	__uint32_t	pagf_btreeblks;	/* # of blocks held in AGF btrees */
373 	xfs_agino_t	pagi_freecount;	/* number of free inodes */
374 	xfs_agino_t	pagi_count;	/* number of allocated inodes */
375 
376 	/*
377 	 * Inode allocation search lookup optimisation.
378 	 * If the pagino matches, the search for new inodes
379 	 * doesn't need to search the near ones again straight away
380 	 */
381 	xfs_agino_t	pagl_pagino;
382 	xfs_agino_t	pagl_leftrec;
383 	xfs_agino_t	pagl_rightrec;
384 	spinlock_t	pagb_lock;	/* lock for pagb_tree */
385 	struct rb_root	pagb_tree;	/* ordered tree of busy extents */
386 
387 	atomic_t        pagf_fstrms;    /* # of filestreams active in this AG */
388 
389 	spinlock_t	pag_ici_lock;	/* incore inode cache lock */
390 	struct radix_tree_root pag_ici_root;	/* incore inode cache root */
391 	int		pag_ici_reclaimable;	/* reclaimable inodes */
392 	struct mutex	pag_ici_reclaim_lock;	/* serialisation point */
393 	unsigned long	pag_ici_reclaim_cursor;	/* reclaim restart point */
394 
395 	/* buffer cache index */
396 	spinlock_t	pag_buf_lock;	/* lock for pag_buf_tree */
397 	struct rb_root	pag_buf_tree;	/* ordered tree of active buffers */
398 
399 	/* for rcu-safe freeing */
400 	struct rcu_head	rcu_head;
401 	int		pagb_count;	/* pagb slots in use */
402 
403 	/* Blocks reserved for all kinds of metadata. */
404 	struct xfs_ag_resv	pag_meta_resv;
405 	/* Blocks reserved for just AGFL-based metadata. */
406 	struct xfs_ag_resv	pag_agfl_resv;
407 
408 	/* reference count */
409 	__uint8_t		pagf_refcount_level;
410 } xfs_perag_t;
411 
412 static inline struct xfs_ag_resv *
413 xfs_perag_resv(
414 	struct xfs_perag	*pag,
415 	enum xfs_ag_resv_type	type)
416 {
417 	switch (type) {
418 	case XFS_AG_RESV_METADATA:
419 		return &pag->pag_meta_resv;
420 	case XFS_AG_RESV_AGFL:
421 		return &pag->pag_agfl_resv;
422 	default:
423 		return NULL;
424 	}
425 }
426 
427 extern void	xfs_uuid_table_free(void);
428 extern int	xfs_log_sbcount(xfs_mount_t *);
429 extern __uint64_t xfs_default_resblks(xfs_mount_t *mp);
430 extern int	xfs_mountfs(xfs_mount_t *mp);
431 extern int	xfs_initialize_perag(xfs_mount_t *mp, xfs_agnumber_t agcount,
432 				     xfs_agnumber_t *maxagi);
433 extern void	xfs_unmountfs(xfs_mount_t *);
434 
435 extern int	xfs_mod_icount(struct xfs_mount *mp, int64_t delta);
436 extern int	xfs_mod_ifree(struct xfs_mount *mp, int64_t delta);
437 extern int	xfs_mod_fdblocks(struct xfs_mount *mp, int64_t delta,
438 				 bool reserved);
439 extern int	xfs_mod_frextents(struct xfs_mount *mp, int64_t delta);
440 
441 extern struct xfs_buf *xfs_getsb(xfs_mount_t *, int);
442 extern int	xfs_readsb(xfs_mount_t *, int);
443 extern void	xfs_freesb(xfs_mount_t *);
444 extern bool	xfs_fs_writable(struct xfs_mount *mp, int level);
445 extern int	xfs_sb_validate_fsb_count(struct xfs_sb *, __uint64_t);
446 
447 extern int	xfs_dev_is_read_only(struct xfs_mount *, char *);
448 
449 extern void	xfs_set_low_space_thresholds(struct xfs_mount *);
450 
451 int	xfs_zero_extent(struct xfs_inode *ip, xfs_fsblock_t start_fsb,
452 			xfs_off_t count_fsb);
453 
454 struct xfs_error_cfg * xfs_error_get_cfg(struct xfs_mount *mp,
455 		int error_class, int error);
456 
457 #endif	/* __XFS_MOUNT_H__ */
458