Merge tag 'configfs-for-4.7' of git://git.infradead.org/users/hch/configfs
[linux-2.6-block.git] / fs / xfs / xfs_mount.h
CommitLineData
1da177e4 1/*
7b718769
NS
2 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
1da177e4 4 *
7b718769
NS
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
1da177e4
LT
7 * published by the Free Software Foundation.
8 *
7b718769
NS
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.
1da177e4 13 *
7b718769
NS
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
1da177e4
LT
17 */
18#ifndef __XFS_MOUNT_H__
19#define __XFS_MOUNT_H__
20
ad223e60 21struct xlog;
1da177e4 22struct xfs_inode;
2a82b8be 23struct xfs_mru_cache;
5163f95a 24struct xfs_nameops;
82fa9012 25struct xfs_ail;
7d095257 26struct xfs_quotainfo;
32c5483a 27struct xfs_dir_ops;
0650b554 28struct xfs_da_geometry;
7d095257 29
055388a3
DC
30/* dynamic preallocation free space thresholds, 5% down to 1% */
31enum {
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
192852be
CM
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 */
46enum {
ffd40ef6 47 XFS_ERR_METADATA,
192852be
CM
48 XFS_ERR_CLASS_MAX,
49};
50enum {
ffd40ef6 51 XFS_ERR_DEFAULT,
e0a431b3
CM
52 XFS_ERR_EIO,
53 XFS_ERR_ENOSPC,
54 XFS_ERR_ENODEV,
192852be
CM
55 XFS_ERR_ERRNO_MAX,
56};
57
a5ea70d2
CM
58#define XFS_ERR_RETRY_FOREVER -1
59
192852be
CM
60struct xfs_error_cfg {
61 struct xfs_kobj kobj;
62 int max_retries;
a5ea70d2 63 unsigned long retry_timeout; /* in jiffies, 0 = no timeout */
192852be
CM
64};
65
1da177e4 66typedef struct xfs_mount {
b267ce99 67 struct super_block *m_super;
1da177e4 68 xfs_tid_t m_tid; /* next unused tid for fs */
82fa9012 69 struct xfs_ail *m_ail; /* fs active log item list */
501ab323
DC
70
71 struct xfs_sb m_sb; /* copy of fs superblock */
3685c2a1 72 spinlock_t m_sb_lock; /* sb counter lock */
501ab323 73 struct percpu_counter m_icount; /* allocated inodes counter */
e88b64ea 74 struct percpu_counter m_ifree; /* free inodes counter */
0d485ada 75 struct percpu_counter m_fdblocks; /* free block counter */
501ab323 76
1da177e4
LT
77 struct xfs_buf *m_sb_bp; /* buffer for superblock */
78 char *m_fsname; /* filesystem name */
79 int m_fsname_len; /* strlen of fs name */
fc1f8c1c
NS
80 char *m_rtname; /* realtime device name */
81 char *m_logname; /* external log device name */
1da177e4
LT
82 int m_bsize; /* fs logical block size */
83 xfs_agnumber_t m_agfrotor; /* last ag where space found */
84 xfs_agnumber_t m_agirotor; /* last ag dir inode alloced */
36e41eeb 85 spinlock_t m_agirotor_lock;/* .. and lock protecting it */
1da177e4 86 xfs_agnumber_t m_maxagi; /* highest inode alloc group */
1da177e4
LT
87 uint m_readio_log; /* min read size log bytes */
88 uint m_readio_blocks; /* min read size blocks */
89 uint m_writeio_log; /* min write size log bytes */
90 uint m_writeio_blocks; /* min write size blocks */
0650b554
DC
91 struct xfs_da_geometry *m_dir_geo; /* directory block geometry */
92 struct xfs_da_geometry *m_attr_geo; /* attribute block geometry */
ad223e60 93 struct xlog *m_log; /* log specific stuff */
1da177e4
LT
94 int m_logbufs; /* number of log buffers */
95 int m_logbsize; /* size of each log buffer */
96 uint m_rsumlevels; /* rt summary levels */
97 uint m_rsumsize; /* size of rt summary, bytes */
98 struct xfs_inode *m_rbmip; /* pointer to bitmap inode */
99 struct xfs_inode *m_rsumip; /* pointer to summary inode */
100 struct xfs_inode *m_rootip; /* pointer to root directory */
101 struct xfs_quotainfo *m_quotainfo; /* disk quota information */
102 xfs_buftarg_t *m_ddev_targp; /* saves taking the address */
103 xfs_buftarg_t *m_logdev_targp;/* ptr to log device */
104 xfs_buftarg_t *m_rtdev_targp; /* ptr to rt device */
1da177e4
LT
105 __uint8_t m_blkbit_log; /* blocklog + NBBY */
106 __uint8_t m_blkbb_log; /* blocklog - BBSHIFT */
107 __uint8_t m_agno_log; /* log #ag's */
108 __uint8_t m_agino_log; /* #bits for agino in inum */
8f80587b 109 uint m_inode_cluster_size;/* min inode buf size */
1da177e4
LT
110 uint m_blockmask; /* sb_blocksize-1 */
111 uint m_blockwsize; /* sb_blocksize in words */
112 uint m_blockwmask; /* blockwsize-1 */
60197e8d
CH
113 uint m_alloc_mxr[2]; /* max alloc btree records */
114 uint m_alloc_mnr[2]; /* min alloc btree records */
115 uint m_bmap_dmxr[2]; /* max bmap btree records */
116 uint m_bmap_dmnr[2]; /* min bmap btree records */
117 uint m_inobt_mxr[2]; /* max inobt btree records */
118 uint m_inobt_mnr[2]; /* min inobt btree records */
1da177e4
LT
119 uint m_ag_maxlevels; /* XFS_AG_MAXLEVELS */
120 uint m_bm_maxlevels[2]; /* XFS_BM_MAXLEVELS */
0d87e656 121 uint m_in_maxlevels; /* max inobt btree levels. */
1c1c6ebc
DC
122 struct radix_tree_root m_perag_tree; /* per-ag accounting info */
123 spinlock_t m_perag_lock; /* lock for m_perag_tree */
cc92e7ac 124 struct mutex m_growlock; /* growfs mutex */
1da177e4
LT
125 int m_fixedfsid[2]; /* unchanged for life of FS */
126 uint m_dmevmask; /* DMI events for this FS */
e718eeb4 127 __uint64_t m_flags; /* global mount flags */
1da177e4
LT
128 int m_ialloc_inos; /* inodes in inode allocation */
129 int m_ialloc_blks; /* blocks in inode allocation */
066a1884
BF
130 int m_ialloc_min_blks;/* min blocks in sparse inode
131 * allocation */
1da177e4
LT
132 int m_inoalign_mask;/* mask sb_inoalignmt if used */
133 uint m_qflags; /* quota status flags */
0eadd102 134 struct xfs_trans_resv m_resv; /* precomputed res values */
1da177e4 135 __uint64_t m_maxicount; /* maximum inode count */
1da177e4
LT
136 __uint64_t m_resblks; /* total reserved blocks */
137 __uint64_t m_resblks_avail;/* available reserved blocks */
cbe132a8 138 __uint64_t m_resblks_save; /* reserved blks @ remount,ro */
1da177e4
LT
139 int m_dalign; /* stripe unit */
140 int m_swidth; /* stripe width */
c41564b5 141 int m_sinoalign; /* stripe unit inode alignment */
1da177e4 142 __uint8_t m_sectbb_log; /* sectlog - BBSHIFT */
5163f95a 143 const struct xfs_nameops *m_dirnameops; /* vector of dir name ops */
32c5483a 144 const struct xfs_dir_ops *m_dir_inode_ops; /* vector of dir inode ops */
4bceb18f 145 const struct xfs_dir_ops *m_nondir_inode_ops; /* !dir inode ops */
1da177e4 146 uint m_chsize; /* size of next field */
1da177e4 147 atomic_t m_active_trans; /* number trans frozen */
2a82b8be 148 struct xfs_mru_cache *m_filestream; /* per-mount filestream data */
a7b339f1 149 struct delayed_work m_reclaim_work; /* background inode reclaim */
579b62fa
BF
150 struct delayed_work m_eofblocks_work; /* background eof blocks
151 trimming */
61e63ecb 152 bool m_update_sb; /* sb needs update in mount */
055388a3
DC
153 int64_t m_low_space[XFS_LOWSP_MAX];
154 /* low free space thresholds */
a31b1d3d 155 struct xfs_kobj m_kobj;
192852be 156 struct xfs_kobj m_error_kobj;
ffd40ef6 157 struct xfs_kobj m_error_meta_kobj;
192852be 158 struct xfs_error_cfg m_error_cfg[XFS_ERR_CLASS_MAX][XFS_ERR_ERRNO_MAX];
225e4635 159 struct xstats m_stats; /* per-fs stats */
aa6bf01d 160
78c931b8 161 struct workqueue_struct *m_buf_workqueue;
aa6bf01d
CH
162 struct workqueue_struct *m_data_workqueue;
163 struct workqueue_struct *m_unwritten_workqueue;
4c2d542f 164 struct workqueue_struct *m_cil_workqueue;
5889608d
DC
165 struct workqueue_struct *m_reclaim_workqueue;
166 struct workqueue_struct *m_log_workqueue;
579b62fa 167 struct workqueue_struct *m_eofblocks_workqueue;
52785112
CH
168
169 /*
170 * Generation of the filesysyem layout. This is incremented by each
171 * growfs, and used by the pNFS server to ensure the client updates
172 * its view of the block device once it gets a layout that might
173 * reference the newly added blocks. Does not need to be persistent
174 * as long as we only allow file system size increments, but if we
175 * ever support shrinks it would have to be persisted in addition
176 * to various other kinds of pain inflicted on the pNFS server.
177 */
178 __uint32_t m_generation;
801cc4e1 179
e6b3bb78 180 bool m_fail_unmount;
801cc4e1
BF
181#ifdef DEBUG
182 /*
183 * DEBUG mode instrumentation to test and/or trigger delayed allocation
184 * block killing in the event of failed writes. When enabled, all
185 * buffered writes are forced to fail. All delalloc blocks in the range
186 * of the write (including pre-existing delalloc blocks!) are tossed as
187 * part of the write failure error handling sequence.
188 */
189 bool m_fail_writes;
190#endif
1da177e4
LT
191} xfs_mount_t;
192
193/*
194 * Flags for m_flags.
195 */
92821e2b 196#define XFS_MOUNT_WSYNC (1ULL << 0) /* for nfs - all metadata ops
1da177e4
LT
197 must be synchronous except
198 for space allocations */
e6b3bb78 199#define XFS_MOUNT_UNMOUNTING (1ULL << 1) /* filesystem is unmounting */
92821e2b 200#define XFS_MOUNT_WAS_CLEAN (1ULL << 3)
e718eeb4 201#define XFS_MOUNT_FS_SHUTDOWN (1ULL << 4) /* atomic stop of all filesystem
1da177e4
LT
202 operations, typically for
203 disk errors in metadata */
e84661aa 204#define XFS_MOUNT_DISCARD (1ULL << 5) /* discard unused blocks */
e718eeb4 205#define XFS_MOUNT_NOALIGN (1ULL << 7) /* turn off stripe alignment
1da177e4 206 allocations */
13059ff0 207#define XFS_MOUNT_ATTR2 (1ULL << 8) /* allow use of attr2 format */
bd186aa9 208#define XFS_MOUNT_GRPID (1ULL << 9) /* group-ID assigned from directory */
e718eeb4 209#define XFS_MOUNT_NORECOVERY (1ULL << 10) /* no recovery - dirty fs */
e718eeb4 210#define XFS_MOUNT_DFLT_IOSIZE (1ULL << 12) /* set default i/o size */
12c3f05c
ES
211#define XFS_MOUNT_SMALL_INUMS (1ULL << 14) /* user wants 32bit inodes */
212#define XFS_MOUNT_32BITINODES (1ULL << 15) /* inode32 allocator active */
e718eeb4
NS
213#define XFS_MOUNT_NOUUID (1ULL << 16) /* ignore uuid during mount */
214#define XFS_MOUNT_BARRIER (1ULL << 17)
1bd960ee 215#define XFS_MOUNT_IKEEP (1ULL << 18) /* keep empty inode clusters*/
e718eeb4 216#define XFS_MOUNT_SWALLOC (1ULL << 19) /* turn on stripe width
1da177e4 217 * allocation */
bd186aa9 218#define XFS_MOUNT_RDONLY (1ULL << 20) /* read-only fs */
e718eeb4
NS
219#define XFS_MOUNT_DIRSYNC (1ULL << 21) /* synchronous directory ops */
220#define XFS_MOUNT_COMPAT_IOSIZE (1ULL << 22) /* don't report large preferred
e8c8b3a7 221 * I/O size in stat() */
2a82b8be
DC
222#define XFS_MOUNT_FILESTREAMS (1ULL << 24) /* enable the filestreams
223 allocator */
7c12f296 224#define XFS_MOUNT_NOATTR2 (1ULL << 25) /* disable use of attr2 format */
e8c8b3a7 225
cbe4dab1
DC
226#define XFS_MOUNT_DAX (1ULL << 62) /* TEST ONLY! */
227
1da177e4
LT
228
229/*
230 * Default minimum read and write sizes.
231 */
232#define XFS_READIO_LOG_LARGE 16
233#define XFS_WRITEIO_LOG_LARGE 16
234
235/*
1f443ad7
NS
236 * Max and min values for mount-option defined I/O
237 * preallocation sizes.
1da177e4 238 */
1f443ad7 239#define XFS_MAX_IO_LOG 30 /* 1G */
1da177e4
LT
240#define XFS_MIN_IO_LOG PAGE_SHIFT
241
242/*
243 * Synchronous read and write sizes. This should be
244 * better for NFSv2 wsync filesystems.
245 */
9da096fd
MP
246#define XFS_WSYNC_READIO_LOG 15 /* 32k */
247#define XFS_WSYNC_WRITEIO_LOG 14 /* 16k */
1da177e4 248
e8c8b3a7
DC
249/*
250 * Allow large block sizes to be reported to userspace programs if the
556b8b16 251 * "largeio" mount option is used.
e8c8b3a7
DC
252 *
253 * If compatibility mode is specified, simply return the basic unit of caching
254 * so that we don't get inefficient read/modify/write I/O from user apps.
255 * Otherwise....
256 *
257 * If the underlying volume is a stripe, then return the stripe width in bytes
258 * as the recommended I/O size. It is not a stripe and we've set a default
259 * buffered I/O size, return that, otherwise return the compat default.
260 */
261static inline unsigned long
262xfs_preferred_iosize(xfs_mount_t *mp)
263{
264 if (mp->m_flags & XFS_MOUNT_COMPAT_IOSIZE)
09cbfeaf 265 return PAGE_SIZE;
e8c8b3a7
DC
266 return (mp->m_swidth ?
267 (mp->m_swidth << mp->m_sb.sb_blocklog) :
268 ((mp->m_flags & XFS_MOUNT_DFLT_IOSIZE) ?
269 (1 << (int)MAX(mp->m_readio_log, mp->m_writeio_log)) :
09cbfeaf 270 PAGE_SIZE));
e8c8b3a7
DC
271}
272
92821e2b
DC
273#define XFS_LAST_UNMOUNT_WAS_CLEAN(mp) \
274 ((mp)->m_flags & XFS_MOUNT_WAS_CLEAN)
1da177e4 275#define XFS_FORCED_SHUTDOWN(mp) ((mp)->m_flags & XFS_MOUNT_FS_SHUTDOWN)
745f6919
CH
276void xfs_do_force_shutdown(struct xfs_mount *mp, int flags, char *fname,
277 int lnnum);
1da177e4 278#define xfs_force_shutdown(m,f) \
745f6919 279 xfs_do_force_shutdown(m, f, __FILE__, __LINE__)
1da177e4 280
2b5decd0
CH
281#define SHUTDOWN_META_IO_ERROR 0x0001 /* write attempt to metadata failed */
282#define SHUTDOWN_LOG_IO_ERROR 0x0002 /* write attempt to the log failed */
283#define SHUTDOWN_FORCE_UMOUNT 0x0004 /* shutdown from a forced unmount */
284#define SHUTDOWN_CORRUPT_INCORE 0x0008 /* corrupt in-memory data structures */
285#define SHUTDOWN_REMOTE_REQ 0x0010 /* shutdown came from remote cell */
286#define SHUTDOWN_DEVICE_REQ 0x0020 /* failed all paths to the device */
287
1da177e4
LT
288/*
289 * Flags for xfs_mountfs
290 */
764d1f89 291#define XFS_MFSI_QUIET 0x40 /* Be silent if mount errors found */
1da177e4 292
a844f451
NS
293static inline xfs_agnumber_t
294xfs_daddr_to_agno(struct xfs_mount *mp, xfs_daddr_t d)
1da177e4 295{
a844f451
NS
296 xfs_daddr_t ld = XFS_BB_TO_FSBT(mp, d);
297 do_div(ld, mp->m_sb.sb_agblocks);
298 return (xfs_agnumber_t) ld;
1da177e4
LT
299}
300
a844f451
NS
301static inline xfs_agblock_t
302xfs_daddr_to_agbno(struct xfs_mount *mp, xfs_daddr_t d)
1da177e4 303{
a844f451
NS
304 xfs_daddr_t ld = XFS_BB_TO_FSBT(mp, d);
305 return (xfs_agblock_t) do_div(ld, mp->m_sb.sb_agblocks);
1da177e4
LT
306}
307
801cc4e1
BF
308#ifdef DEBUG
309static inline bool
310xfs_mp_fail_writes(struct xfs_mount *mp)
311{
312 return mp->m_fail_writes;
313}
314#else
315static inline bool
316xfs_mp_fail_writes(struct xfs_mount *mp)
317{
318 return 0;
319}
320#endif
321
9356fe22
DC
322/*
323 * Per-ag incore structure, copies of information in agf and agi, to improve the
4fb6e8ad 324 * performance of allocation group selection.
9356fe22
DC
325 */
326typedef struct xfs_perag {
327 struct xfs_mount *pag_mount; /* owner filesystem */
328 xfs_agnumber_t pag_agno; /* AG this structure belongs to */
329 atomic_t pag_ref; /* perag reference count */
330 char pagf_init; /* this agf's entry is initialized */
331 char pagi_init; /* this agi's entry is initialized */
332 char pagf_metadata; /* the agf is preferred to be metadata */
333 char pagi_inodeok; /* The agi is ok for inodes */
334 __uint8_t pagf_levels[XFS_BTNUM_AGF];
335 /* # of levels in bno & cnt btree */
336 __uint32_t pagf_flcount; /* count of blocks in freelist */
337 xfs_extlen_t pagf_freeblks; /* total free blocks */
338 xfs_extlen_t pagf_longest; /* longest free space */
339 __uint32_t pagf_btreeblks; /* # of blocks held in AGF btrees */
340 xfs_agino_t pagi_freecount; /* number of free inodes */
341 xfs_agino_t pagi_count; /* number of allocated inodes */
342
343 /*
344 * Inode allocation search lookup optimisation.
345 * If the pagino matches, the search for new inodes
346 * doesn't need to search the near ones again straight away
347 */
348 xfs_agino_t pagl_pagino;
349 xfs_agino_t pagl_leftrec;
350 xfs_agino_t pagl_rightrec;
351 spinlock_t pagb_lock; /* lock for pagb_tree */
352 struct rb_root pagb_tree; /* ordered tree of busy extents */
353
354 atomic_t pagf_fstrms; /* # of filestreams active in this AG */
355
356 spinlock_t pag_ici_lock; /* incore inode cache lock */
357 struct radix_tree_root pag_ici_root; /* incore inode cache root */
358 int pag_ici_reclaimable; /* reclaimable inodes */
359 struct mutex pag_ici_reclaim_lock; /* serialisation point */
360 unsigned long pag_ici_reclaim_cursor; /* reclaim restart point */
361
362 /* buffer cache index */
363 spinlock_t pag_buf_lock; /* lock for pag_buf_tree */
364 struct rb_root pag_buf_tree; /* ordered tree of active buffers */
365
366 /* for rcu-safe freeing */
367 struct rcu_head rcu_head;
368 int pagb_count; /* pagb slots in use */
369} xfs_perag_t;
370
af3b6382 371extern void xfs_uuid_table_free(void);
adab0f67 372extern int xfs_log_sbcount(xfs_mount_t *);
d5db0f97 373extern __uint64_t xfs_default_resblks(xfs_mount_t *mp);
4249023a 374extern int xfs_mountfs(xfs_mount_t *mp);
ff55068c
DC
375extern int xfs_initialize_perag(xfs_mount_t *mp, xfs_agnumber_t agcount,
376 xfs_agnumber_t *maxagi);
41b5c2e7 377extern void xfs_unmountfs(xfs_mount_t *);
964aa8d9 378
501ab323 379extern int xfs_mod_icount(struct xfs_mount *mp, int64_t delta);
e88b64ea 380extern int xfs_mod_ifree(struct xfs_mount *mp, int64_t delta);
0d485ada
DC
381extern int xfs_mod_fdblocks(struct xfs_mount *mp, int64_t delta,
382 bool reserved);
bab98bbe
DC
383extern int xfs_mod_frextents(struct xfs_mount *mp, int64_t delta);
384
1da177e4 385extern struct xfs_buf *xfs_getsb(xfs_mount_t *, int);
764d1f89 386extern int xfs_readsb(xfs_mount_t *, int);
1da177e4 387extern void xfs_freesb(xfs_mount_t *);
91ee575f 388extern bool xfs_fs_writable(struct xfs_mount *mp, int level);
4cc929ee 389extern int xfs_sb_validate_fsb_count(struct xfs_sb *, __uint64_t);
1da177e4 390
d7658d48
CH
391extern int xfs_dev_is_read_only(struct xfs_mount *, char *);
392
055388a3
DC
393extern void xfs_set_low_space_thresholds(struct xfs_mount *);
394
3fbbbea3
DC
395int xfs_zero_extent(struct xfs_inode *ip, xfs_fsblock_t start_fsb,
396 xfs_off_t count_fsb);
397
df309390
CM
398struct xfs_error_cfg * xfs_error_get_cfg(struct xfs_mount *mp,
399 int error_class, int error);
400
1da177e4 401#endif /* __XFS_MOUNT_H__ */