xref: /openbmc/linux/fs/xfs/xfs_mount.h (revision b6bec26c)
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 typedef struct xfs_trans_reservations {
22 	uint	tr_write;	/* extent alloc trans */
23 	uint	tr_itruncate;	/* truncate trans */
24 	uint	tr_rename;	/* rename trans */
25 	uint	tr_link;	/* link trans */
26 	uint	tr_remove;	/* unlink trans */
27 	uint	tr_symlink;	/* symlink trans */
28 	uint	tr_create;	/* create trans */
29 	uint	tr_mkdir;	/* mkdir trans */
30 	uint	tr_ifree;	/* inode free trans */
31 	uint	tr_ichange;	/* inode update trans */
32 	uint	tr_growdata;	/* fs data section grow trans */
33 	uint	tr_swrite;	/* sync write inode trans */
34 	uint	tr_addafork;	/* cvt inode to attributed trans */
35 	uint	tr_writeid;	/* write setuid/setgid file */
36 	uint	tr_attrinval;	/* attr fork buffer invalidation */
37 	uint	tr_attrset;	/* set/create an attribute */
38 	uint	tr_attrrm;	/* remove an attribute */
39 	uint	tr_clearagi;	/* clear bad agi unlinked ino bucket */
40 	uint	tr_growrtalloc;	/* grow realtime allocations */
41 	uint	tr_growrtzero;	/* grow realtime zeroing */
42 	uint	tr_growrtfree;	/* grow realtime freeing */
43 } xfs_trans_reservations_t;
44 
45 #ifndef __KERNEL__
46 
47 #define xfs_daddr_to_agno(mp,d) \
48 	((xfs_agnumber_t)(XFS_BB_TO_FSBT(mp, d) / (mp)->m_sb.sb_agblocks))
49 #define xfs_daddr_to_agbno(mp,d) \
50 	((xfs_agblock_t)(XFS_BB_TO_FSBT(mp, d) % (mp)->m_sb.sb_agblocks))
51 
52 #else /* __KERNEL__ */
53 
54 struct xlog;
55 struct xfs_inode;
56 struct xfs_mru_cache;
57 struct xfs_nameops;
58 struct xfs_ail;
59 struct xfs_quotainfo;
60 
61 #ifdef HAVE_PERCPU_SB
62 
63 /*
64  * Valid per-cpu incore superblock counters. Note that if you add new counters,
65  * you may need to define new counter disabled bit field descriptors as there
66  * are more possible fields in the superblock that can fit in a bitfield on a
67  * 32 bit platform. The XFS_SBS_* values for the current current counters just
68  * fit.
69  */
70 typedef struct xfs_icsb_cnts {
71 	uint64_t	icsb_fdblocks;
72 	uint64_t	icsb_ifree;
73 	uint64_t	icsb_icount;
74 	unsigned long	icsb_flags;
75 } xfs_icsb_cnts_t;
76 
77 #define XFS_ICSB_FLAG_LOCK	(1 << 0)	/* counter lock bit */
78 
79 #define XFS_ICSB_LAZY_COUNT	(1 << 1)	/* accuracy not needed */
80 
81 extern int	xfs_icsb_init_counters(struct xfs_mount *);
82 extern void	xfs_icsb_reinit_counters(struct xfs_mount *);
83 extern void	xfs_icsb_destroy_counters(struct xfs_mount *);
84 extern void	xfs_icsb_sync_counters(struct xfs_mount *, int);
85 extern void	xfs_icsb_sync_counters_locked(struct xfs_mount *, int);
86 extern int	xfs_icsb_modify_counters(struct xfs_mount *, xfs_sb_field_t,
87 						int64_t, int);
88 
89 #else
90 #define xfs_icsb_init_counters(mp)		(0)
91 #define xfs_icsb_destroy_counters(mp)		do { } while (0)
92 #define xfs_icsb_reinit_counters(mp)		do { } while (0)
93 #define xfs_icsb_sync_counters(mp, flags)	do { } while (0)
94 #define xfs_icsb_sync_counters_locked(mp, flags) do { } while (0)
95 #define xfs_icsb_modify_counters(mp, field, delta, rsvd) \
96 	xfs_mod_incore_sb(mp, field, delta, rsvd)
97 #endif
98 
99 /* dynamic preallocation free space thresholds, 5% down to 1% */
100 enum {
101 	XFS_LOWSP_1_PCNT = 0,
102 	XFS_LOWSP_2_PCNT,
103 	XFS_LOWSP_3_PCNT,
104 	XFS_LOWSP_4_PCNT,
105 	XFS_LOWSP_5_PCNT,
106 	XFS_LOWSP_MAX,
107 };
108 
109 typedef struct xfs_mount {
110 	struct super_block	*m_super;
111 	xfs_tid_t		m_tid;		/* next unused tid for fs */
112 	struct xfs_ail		*m_ail;		/* fs active log item list */
113 	xfs_sb_t		m_sb;		/* copy of fs superblock */
114 	spinlock_t		m_sb_lock;	/* sb counter lock */
115 	struct xfs_buf		*m_sb_bp;	/* buffer for superblock */
116 	char			*m_fsname;	/* filesystem name */
117 	int			m_fsname_len;	/* strlen of fs name */
118 	char			*m_rtname;	/* realtime device name */
119 	char			*m_logname;	/* external log device name */
120 	int			m_bsize;	/* fs logical block size */
121 	xfs_agnumber_t		m_agfrotor;	/* last ag where space found */
122 	xfs_agnumber_t		m_agirotor;	/* last ag dir inode alloced */
123 	spinlock_t		m_agirotor_lock;/* .. and lock protecting it */
124 	xfs_agnumber_t		m_maxagi;	/* highest inode alloc group */
125 	uint			m_readio_log;	/* min read size log bytes */
126 	uint			m_readio_blocks; /* min read size blocks */
127 	uint			m_writeio_log;	/* min write size log bytes */
128 	uint			m_writeio_blocks; /* min write size blocks */
129 	struct xlog		*m_log;		/* log specific stuff */
130 	int			m_logbufs;	/* number of log buffers */
131 	int			m_logbsize;	/* size of each log buffer */
132 	uint			m_rsumlevels;	/* rt summary levels */
133 	uint			m_rsumsize;	/* size of rt summary, bytes */
134 	struct xfs_inode	*m_rbmip;	/* pointer to bitmap inode */
135 	struct xfs_inode	*m_rsumip;	/* pointer to summary inode */
136 	struct xfs_inode	*m_rootip;	/* pointer to root directory */
137 	struct xfs_quotainfo	*m_quotainfo;	/* disk quota information */
138 	xfs_buftarg_t		*m_ddev_targp;	/* saves taking the address */
139 	xfs_buftarg_t		*m_logdev_targp;/* ptr to log device */
140 	xfs_buftarg_t		*m_rtdev_targp;	/* ptr to rt device */
141 	__uint8_t		m_blkbit_log;	/* blocklog + NBBY */
142 	__uint8_t		m_blkbb_log;	/* blocklog - BBSHIFT */
143 	__uint8_t		m_agno_log;	/* log #ag's */
144 	__uint8_t		m_agino_log;	/* #bits for agino in inum */
145 	__uint16_t		m_inode_cluster_size;/* min inode buf size */
146 	uint			m_blockmask;	/* sb_blocksize-1 */
147 	uint			m_blockwsize;	/* sb_blocksize in words */
148 	uint			m_blockwmask;	/* blockwsize-1 */
149 	uint			m_alloc_mxr[2];	/* max alloc btree records */
150 	uint			m_alloc_mnr[2];	/* min alloc btree records */
151 	uint			m_bmap_dmxr[2];	/* max bmap btree records */
152 	uint			m_bmap_dmnr[2];	/* min bmap btree records */
153 	uint			m_inobt_mxr[2];	/* max inobt btree records */
154 	uint			m_inobt_mnr[2];	/* min inobt btree records */
155 	uint			m_ag_maxlevels;	/* XFS_AG_MAXLEVELS */
156 	uint			m_bm_maxlevels[2]; /* XFS_BM_MAXLEVELS */
157 	uint			m_in_maxlevels;	/* max inobt btree levels. */
158 	struct radix_tree_root	m_perag_tree;	/* per-ag accounting info */
159 	spinlock_t		m_perag_lock;	/* lock for m_perag_tree */
160 	struct mutex		m_growlock;	/* growfs mutex */
161 	int			m_fixedfsid[2];	/* unchanged for life of FS */
162 	uint			m_dmevmask;	/* DMI events for this FS */
163 	__uint64_t		m_flags;	/* global mount flags */
164 	uint			m_dir_node_ents; /* #entries in a dir danode */
165 	uint			m_attr_node_ents; /* #entries in attr danode */
166 	int			m_ialloc_inos;	/* inodes in inode allocation */
167 	int			m_ialloc_blks;	/* blocks in inode allocation */
168 	int			m_inoalign_mask;/* mask sb_inoalignmt if used */
169 	uint			m_qflags;	/* quota status flags */
170 	xfs_trans_reservations_t m_reservations;/* precomputed res values */
171 	__uint64_t		m_maxicount;	/* maximum inode count */
172 	__uint64_t		m_resblks;	/* total reserved blocks */
173 	__uint64_t		m_resblks_avail;/* available reserved blocks */
174 	__uint64_t		m_resblks_save;	/* reserved blks @ remount,ro */
175 	int			m_dalign;	/* stripe unit */
176 	int			m_swidth;	/* stripe width */
177 	int			m_sinoalign;	/* stripe unit inode alignment */
178 	int			m_attr_magicpct;/* 37% of the blocksize */
179 	int			m_dir_magicpct;	/* 37% of the dir blocksize */
180 	__uint8_t		m_sectbb_log;	/* sectlog - BBSHIFT */
181 	const struct xfs_nameops *m_dirnameops;	/* vector of dir name ops */
182 	int			m_dirblksize;	/* directory block sz--bytes */
183 	int			m_dirblkfsbs;	/* directory block sz--fsbs */
184 	xfs_dablk_t		m_dirdatablk;	/* blockno of dir data v2 */
185 	xfs_dablk_t		m_dirleafblk;	/* blockno of dir non-data v2 */
186 	xfs_dablk_t		m_dirfreeblk;	/* blockno of dirfreeindex v2 */
187 	uint			m_chsize;	/* size of next field */
188 	struct xfs_chash	*m_chash;	/* fs private inode per-cluster
189 						 * hash table */
190 	atomic_t		m_active_trans;	/* number trans frozen */
191 #ifdef HAVE_PERCPU_SB
192 	xfs_icsb_cnts_t __percpu *m_sb_cnts;	/* per-cpu superblock counters */
193 	unsigned long		m_icsb_counters; /* disabled per-cpu counters */
194 	struct notifier_block	m_icsb_notifier; /* hotplug cpu notifier */
195 	struct mutex		m_icsb_mutex;	/* balancer sync lock */
196 #endif
197 	struct xfs_mru_cache	*m_filestream;  /* per-mount filestream data */
198 	struct delayed_work	m_reclaim_work;	/* background inode reclaim */
199 	struct delayed_work	m_eofblocks_work; /* background eof blocks
200 						     trimming */
201 	__int64_t		m_update_flags;	/* sb flags we need to update
202 						   on the next remount,rw */
203 	struct shrinker		m_inode_shrink;	/* inode reclaim shrinker */
204 	int64_t			m_low_space[XFS_LOWSP_MAX];
205 						/* low free space thresholds */
206 
207 	struct workqueue_struct	*m_data_workqueue;
208 	struct workqueue_struct	*m_unwritten_workqueue;
209 	struct workqueue_struct	*m_cil_workqueue;
210 	struct workqueue_struct	*m_reclaim_workqueue;
211 	struct workqueue_struct	*m_log_workqueue;
212 	struct workqueue_struct *m_eofblocks_workqueue;
213 } xfs_mount_t;
214 
215 /*
216  * Flags for m_flags.
217  */
218 #define XFS_MOUNT_WSYNC		(1ULL << 0)	/* for nfs - all metadata ops
219 						   must be synchronous except
220 						   for space allocations */
221 #define XFS_MOUNT_WAS_CLEAN	(1ULL << 3)
222 #define XFS_MOUNT_FS_SHUTDOWN	(1ULL << 4)	/* atomic stop of all filesystem
223 						   operations, typically for
224 						   disk errors in metadata */
225 #define XFS_MOUNT_DISCARD	(1ULL << 5)	/* discard unused blocks */
226 #define XFS_MOUNT_RETERR	(1ULL << 6)     /* return alignment errors to
227 						   user */
228 #define XFS_MOUNT_NOALIGN	(1ULL << 7)	/* turn off stripe alignment
229 						   allocations */
230 #define XFS_MOUNT_ATTR2		(1ULL << 8)	/* allow use of attr2 format */
231 #define XFS_MOUNT_GRPID		(1ULL << 9)	/* group-ID assigned from directory */
232 #define XFS_MOUNT_NORECOVERY	(1ULL << 10)	/* no recovery - dirty fs */
233 #define XFS_MOUNT_DFLT_IOSIZE	(1ULL << 12)	/* set default i/o size */
234 #define XFS_MOUNT_32BITINODES	(1ULL << 14)	/* do not create inodes above
235 						 * 32 bits in size */
236 #define XFS_MOUNT_SMALL_INUMS	(1ULL << 15)	/* users wants 32bit inodes */
237 #define XFS_MOUNT_NOUUID	(1ULL << 16)	/* ignore uuid during mount */
238 #define XFS_MOUNT_BARRIER	(1ULL << 17)
239 #define XFS_MOUNT_IKEEP		(1ULL << 18)	/* keep empty inode clusters*/
240 #define XFS_MOUNT_SWALLOC	(1ULL << 19)	/* turn on stripe width
241 						 * allocation */
242 #define XFS_MOUNT_RDONLY	(1ULL << 20)	/* read-only fs */
243 #define XFS_MOUNT_DIRSYNC	(1ULL << 21)	/* synchronous directory ops */
244 #define XFS_MOUNT_COMPAT_IOSIZE	(1ULL << 22)	/* don't report large preferred
245 						 * I/O size in stat() */
246 #define XFS_MOUNT_FILESTREAMS	(1ULL << 24)	/* enable the filestreams
247 						   allocator */
248 #define XFS_MOUNT_NOATTR2	(1ULL << 25)	/* disable use of attr2 format */
249 
250 
251 /*
252  * Default minimum read and write sizes.
253  */
254 #define XFS_READIO_LOG_LARGE	16
255 #define XFS_WRITEIO_LOG_LARGE	16
256 
257 /*
258  * Max and min values for mount-option defined I/O
259  * preallocation sizes.
260  */
261 #define XFS_MAX_IO_LOG		30	/* 1G */
262 #define XFS_MIN_IO_LOG		PAGE_SHIFT
263 
264 /*
265  * Synchronous read and write sizes.  This should be
266  * better for NFSv2 wsync filesystems.
267  */
268 #define	XFS_WSYNC_READIO_LOG	15	/* 32k */
269 #define	XFS_WSYNC_WRITEIO_LOG	14	/* 16k */
270 
271 /*
272  * Allow large block sizes to be reported to userspace programs if the
273  * "largeio" mount option is used.
274  *
275  * If compatibility mode is specified, simply return the basic unit of caching
276  * so that we don't get inefficient read/modify/write I/O from user apps.
277  * Otherwise....
278  *
279  * If the underlying volume is a stripe, then return the stripe width in bytes
280  * as the recommended I/O size. It is not a stripe and we've set a default
281  * buffered I/O size, return that, otherwise return the compat default.
282  */
283 static inline unsigned long
284 xfs_preferred_iosize(xfs_mount_t *mp)
285 {
286 	if (mp->m_flags & XFS_MOUNT_COMPAT_IOSIZE)
287 		return PAGE_CACHE_SIZE;
288 	return (mp->m_swidth ?
289 		(mp->m_swidth << mp->m_sb.sb_blocklog) :
290 		((mp->m_flags & XFS_MOUNT_DFLT_IOSIZE) ?
291 			(1 << (int)MAX(mp->m_readio_log, mp->m_writeio_log)) :
292 			PAGE_CACHE_SIZE));
293 }
294 
295 #define XFS_LAST_UNMOUNT_WAS_CLEAN(mp)	\
296 				((mp)->m_flags & XFS_MOUNT_WAS_CLEAN)
297 #define XFS_FORCED_SHUTDOWN(mp)	((mp)->m_flags & XFS_MOUNT_FS_SHUTDOWN)
298 void xfs_do_force_shutdown(struct xfs_mount *mp, int flags, char *fname,
299 		int lnnum);
300 #define xfs_force_shutdown(m,f)	\
301 	xfs_do_force_shutdown(m, f, __FILE__, __LINE__)
302 
303 #define SHUTDOWN_META_IO_ERROR	0x0001	/* write attempt to metadata failed */
304 #define SHUTDOWN_LOG_IO_ERROR	0x0002	/* write attempt to the log failed */
305 #define SHUTDOWN_FORCE_UMOUNT	0x0004	/* shutdown from a forced unmount */
306 #define SHUTDOWN_CORRUPT_INCORE	0x0008	/* corrupt in-memory data structures */
307 #define SHUTDOWN_REMOTE_REQ	0x0010	/* shutdown came from remote cell */
308 #define SHUTDOWN_DEVICE_REQ	0x0020	/* failed all paths to the device */
309 
310 /*
311  * Flags for xfs_mountfs
312  */
313 #define XFS_MFSI_QUIET		0x40	/* Be silent if mount errors found */
314 
315 static inline xfs_agnumber_t
316 xfs_daddr_to_agno(struct xfs_mount *mp, xfs_daddr_t d)
317 {
318 	xfs_daddr_t ld = XFS_BB_TO_FSBT(mp, d);
319 	do_div(ld, mp->m_sb.sb_agblocks);
320 	return (xfs_agnumber_t) ld;
321 }
322 
323 static inline xfs_agblock_t
324 xfs_daddr_to_agbno(struct xfs_mount *mp, xfs_daddr_t d)
325 {
326 	xfs_daddr_t ld = XFS_BB_TO_FSBT(mp, d);
327 	return (xfs_agblock_t) do_div(ld, mp->m_sb.sb_agblocks);
328 }
329 
330 /*
331  * perag get/put wrappers for ref counting
332  */
333 struct xfs_perag *xfs_perag_get(struct xfs_mount *mp, xfs_agnumber_t agno);
334 struct xfs_perag *xfs_perag_get_tag(struct xfs_mount *mp, xfs_agnumber_t agno,
335 					int tag);
336 void	xfs_perag_put(struct xfs_perag *pag);
337 
338 /*
339  * Per-cpu superblock locking functions
340  */
341 #ifdef HAVE_PERCPU_SB
342 static inline void
343 xfs_icsb_lock(xfs_mount_t *mp)
344 {
345 	mutex_lock(&mp->m_icsb_mutex);
346 }
347 
348 static inline void
349 xfs_icsb_unlock(xfs_mount_t *mp)
350 {
351 	mutex_unlock(&mp->m_icsb_mutex);
352 }
353 #else
354 #define xfs_icsb_lock(mp)
355 #define xfs_icsb_unlock(mp)
356 #endif
357 
358 /*
359  * This structure is for use by the xfs_mod_incore_sb_batch() routine.
360  * xfs_growfs can specify a few fields which are more than int limit
361  */
362 typedef struct xfs_mod_sb {
363 	xfs_sb_field_t	msb_field;	/* Field to modify, see below */
364 	int64_t		msb_delta;	/* Change to make to specified field */
365 } xfs_mod_sb_t;
366 
367 extern int	xfs_log_sbcount(xfs_mount_t *);
368 extern __uint64_t xfs_default_resblks(xfs_mount_t *mp);
369 extern int	xfs_mountfs(xfs_mount_t *mp);
370 
371 extern void	xfs_unmountfs(xfs_mount_t *);
372 extern int	xfs_mod_incore_sb(xfs_mount_t *, xfs_sb_field_t, int64_t, int);
373 extern int	xfs_mod_incore_sb_batch(xfs_mount_t *, xfs_mod_sb_t *,
374 			uint, int);
375 extern int	xfs_mount_log_sb(xfs_mount_t *, __int64_t);
376 extern struct xfs_buf *xfs_getsb(xfs_mount_t *, int);
377 extern int	xfs_readsb(xfs_mount_t *, int);
378 extern void	xfs_freesb(xfs_mount_t *);
379 extern int	xfs_fs_writable(xfs_mount_t *);
380 extern int	xfs_sb_validate_fsb_count(struct xfs_sb *, __uint64_t);
381 
382 extern int	xfs_dev_is_read_only(struct xfs_mount *, char *);
383 
384 extern void	xfs_set_low_space_thresholds(struct xfs_mount *);
385 
386 #endif	/* __KERNEL__ */
387 
388 extern void	xfs_mod_sb(struct xfs_trans *, __int64_t);
389 extern int	xfs_initialize_perag(struct xfs_mount *, xfs_agnumber_t,
390 					xfs_agnumber_t *);
391 extern void	xfs_sb_from_disk(struct xfs_sb *, struct xfs_dsb *);
392 extern void	xfs_sb_to_disk(struct xfs_dsb *, struct xfs_sb *, __int64_t);
393 
394 extern const struct xfs_buf_ops xfs_sb_buf_ops;
395 
396 #endif	/* __XFS_MOUNT_H__ */
397