]> git.ipfire.org Git - thirdparty/linux.git/blame - fs/xfs/xfs_mount.h
Merge tag 'drm/tegra/for-5.7-fixes' of git://anongit.freedesktop.org/tegra/linux...
[thirdparty/linux.git] / fs / xfs / xfs_mount.h
CommitLineData
0b61f8a4 1// SPDX-License-Identifier: GPL-2.0
1da177e4 2/*
7b718769
NS
3 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
4 * All Rights Reserved.
1da177e4
LT
5 */
6#ifndef __XFS_MOUNT_H__
7#define __XFS_MOUNT_H__
8
ad223e60 9struct xlog;
1da177e4 10struct xfs_inode;
2a82b8be 11struct xfs_mru_cache;
82fa9012 12struct xfs_ail;
7d095257 13struct xfs_quotainfo;
0650b554 14struct xfs_da_geometry;
7d095257 15
055388a3
DC
16/* dynamic preallocation free space thresholds, 5% down to 1% */
17enum {
18 XFS_LOWSP_1_PCNT = 0,
19 XFS_LOWSP_2_PCNT,
20 XFS_LOWSP_3_PCNT,
21 XFS_LOWSP_4_PCNT,
22 XFS_LOWSP_5_PCNT,
23 XFS_LOWSP_MAX,
24};
25
192852be
CM
26/*
27 * Error Configuration
28 *
29 * Error classes define the subsystem the configuration belongs to.
30 * Error numbers define the errors that are configurable.
31 */
32enum {
ffd40ef6 33 XFS_ERR_METADATA,
192852be
CM
34 XFS_ERR_CLASS_MAX,
35};
36enum {
ffd40ef6 37 XFS_ERR_DEFAULT,
e0a431b3
CM
38 XFS_ERR_EIO,
39 XFS_ERR_ENOSPC,
40 XFS_ERR_ENODEV,
192852be
CM
41 XFS_ERR_ERRNO_MAX,
42};
43
a5ea70d2
CM
44#define XFS_ERR_RETRY_FOREVER -1
45
77169812
ES
46/*
47 * Although retry_timeout is in jiffies which is normally an unsigned long,
48 * we limit the retry timeout to 86400 seconds, or one day. So even a
49 * signed 32-bit long is sufficient for a HZ value up to 24855. Making it
50 * signed lets us store the special "-1" value, meaning retry forever.
51 */
192852be
CM
52struct xfs_error_cfg {
53 struct xfs_kobj kobj;
54 int max_retries;
77169812 55 long retry_timeout; /* in jiffies, -1 = infinite */
192852be
CM
56};
57
1da177e4 58typedef struct xfs_mount {
b267ce99 59 struct super_block *m_super;
6772c1f1
DW
60
61 /*
62 * Bitsets of per-fs metadata that have been checked and/or are sick.
63 * Callers must hold m_sb_lock to access these two fields.
64 */
65 uint8_t m_fs_checked;
66 uint8_t m_fs_sick;
67 /*
68 * Bitsets of rt metadata that have been checked and/or are sick.
69 * Callers must hold m_sb_lock to access this field.
70 */
71 uint8_t m_rt_checked;
72 uint8_t m_rt_sick;
73
82fa9012 74 struct xfs_ail *m_ail; /* fs active log item list */
501ab323
DC
75
76 struct xfs_sb m_sb; /* copy of fs superblock */
3685c2a1 77 spinlock_t m_sb_lock; /* sb counter lock */
501ab323 78 struct percpu_counter m_icount; /* allocated inodes counter */
e88b64ea 79 struct percpu_counter m_ifree; /* free inodes counter */
0d485ada 80 struct percpu_counter m_fdblocks; /* free block counter */
9fe82b8c
DW
81 /*
82 * Count of data device blocks reserved for delayed allocations,
83 * including indlen blocks. Does not include allocated CoW staging
84 * extents or anything related to the rt device.
85 */
86 struct percpu_counter m_delalloc_blks;
501ab323 87
1da177e4 88 struct xfs_buf *m_sb_bp; /* buffer for superblock */
fc1f8c1c
NS
89 char *m_rtname; /* realtime device name */
90 char *m_logname; /* external log device name */
1da177e4
LT
91 int m_bsize; /* fs logical block size */
92 xfs_agnumber_t m_agfrotor; /* last ag where space found */
93 xfs_agnumber_t m_agirotor; /* last ag dir inode alloced */
36e41eeb 94 spinlock_t m_agirotor_lock;/* .. and lock protecting it */
1da177e4 95 xfs_agnumber_t m_maxagi; /* highest inode alloc group */
5da8a07c
CH
96 uint m_allocsize_log;/* min write size log bytes */
97 uint m_allocsize_blocks; /* min write size blocks */
0650b554
DC
98 struct xfs_da_geometry *m_dir_geo; /* directory block geometry */
99 struct xfs_da_geometry *m_attr_geo; /* attribute block geometry */
ad223e60 100 struct xlog *m_log; /* log specific stuff */
ef325959 101 struct xfs_ino_geometry m_ino_geo; /* inode geometry */
1da177e4
LT
102 int m_logbufs; /* number of log buffers */
103 int m_logbsize; /* size of each log buffer */
104 uint m_rsumlevels; /* rt summary levels */
105 uint m_rsumsize; /* size of rt summary, bytes */
355e3532
OS
106 /*
107 * Optional cache of rt summary level per bitmap block with the
108 * invariant that m_rsum_cache[bbno] <= the minimum i for which
109 * rsum[i][bbno] != 0. Reads and writes are serialized by the rsumip
110 * inode lock.
111 */
112 uint8_t *m_rsum_cache;
1da177e4
LT
113 struct xfs_inode *m_rbmip; /* pointer to bitmap inode */
114 struct xfs_inode *m_rsumip; /* pointer to summary inode */
115 struct xfs_inode *m_rootip; /* pointer to root directory */
116 struct xfs_quotainfo *m_quotainfo; /* disk quota information */
117 xfs_buftarg_t *m_ddev_targp; /* saves taking the address */
118 xfs_buftarg_t *m_logdev_targp;/* ptr to log device */
119 xfs_buftarg_t *m_rtdev_targp; /* ptr to rt device */
c8ce540d
DW
120 uint8_t m_blkbit_log; /* blocklog + NBBY */
121 uint8_t m_blkbb_log; /* blocklog - BBSHIFT */
122 uint8_t m_agno_log; /* log #ag's */
1da177e4
LT
123 uint m_blockmask; /* sb_blocksize-1 */
124 uint m_blockwsize; /* sb_blocksize in words */
125 uint m_blockwmask; /* blockwsize-1 */
60197e8d
CH
126 uint m_alloc_mxr[2]; /* max alloc btree records */
127 uint m_alloc_mnr[2]; /* min alloc btree records */
128 uint m_bmap_dmxr[2]; /* max bmap btree records */
129 uint m_bmap_dmnr[2]; /* min bmap btree records */
035e00ac
DW
130 uint m_rmap_mxr[2]; /* max rmap btree records */
131 uint m_rmap_mnr[2]; /* min rmap btree records */
1946b91c
DW
132 uint m_refc_mxr[2]; /* max refc btree records */
133 uint m_refc_mnr[2]; /* min refc btree records */
1da177e4
LT
134 uint m_ag_maxlevels; /* XFS_AG_MAXLEVELS */
135 uint m_bm_maxlevels[2]; /* XFS_BM_MAXLEVELS */
035e00ac 136 uint m_rmap_maxlevels; /* max rmap btree levels */
1946b91c 137 uint m_refc_maxlevels; /* max refcount btree level */
8018026e 138 xfs_extlen_t m_ag_prealloc_blocks; /* reserved ag blocks */
52548852
DW
139 uint m_alloc_set_aside; /* space we can't use */
140 uint m_ag_max_usable; /* max space per AG */
1c1c6ebc
DC
141 struct radix_tree_root m_perag_tree; /* per-ag accounting info */
142 spinlock_t m_perag_lock; /* lock for m_perag_tree */
cc92e7ac 143 struct mutex m_growlock; /* growfs mutex */
1da177e4 144 int m_fixedfsid[2]; /* unchanged for life of FS */
c8ce540d 145 uint64_t m_flags; /* global mount flags */
e1f6ca11 146 bool m_finobt_nores; /* no per-AG finobt resv. */
1da177e4 147 uint m_qflags; /* quota status flags */
0eadd102 148 struct xfs_trans_resv m_resv; /* precomputed res values */
c8ce540d
DW
149 uint64_t m_resblks; /* total reserved blocks */
150 uint64_t m_resblks_avail;/* available reserved blocks */
151 uint64_t m_resblks_save; /* reserved blks @ remount,ro */
1da177e4
LT
152 int m_dalign; /* stripe unit */
153 int m_swidth; /* stripe width */
c8ce540d 154 uint8_t m_sectbb_log; /* sectlog - BBSHIFT */
1da177e4 155 atomic_t m_active_trans; /* number trans frozen */
2a82b8be 156 struct xfs_mru_cache *m_filestream; /* per-mount filestream data */
a7b339f1 157 struct delayed_work m_reclaim_work; /* background inode reclaim */
579b62fa
BF
158 struct delayed_work m_eofblocks_work; /* background eof blocks
159 trimming */
83104d44
DW
160 struct delayed_work m_cowblocks_work; /* background cow blocks
161 trimming */
61e63ecb 162 bool m_update_sb; /* sb needs update in mount */
055388a3
DC
163 int64_t m_low_space[XFS_LOWSP_MAX];
164 /* low free space thresholds */
a31b1d3d 165 struct xfs_kobj m_kobj;
192852be 166 struct xfs_kobj m_error_kobj;
ffd40ef6 167 struct xfs_kobj m_error_meta_kobj;
192852be 168 struct xfs_error_cfg m_error_cfg[XFS_ERR_CLASS_MAX][XFS_ERR_ERRNO_MAX];
225e4635 169 struct xstats m_stats; /* per-fs stats */
aa6bf01d 170
f0f7a674
DW
171 /*
172 * Workqueue item so that we can coalesce multiple inode flush attempts
173 * into a single flush.
174 */
175 struct work_struct m_flush_inodes_work;
78c931b8 176 struct workqueue_struct *m_buf_workqueue;
aa6bf01d 177 struct workqueue_struct *m_unwritten_workqueue;
4c2d542f 178 struct workqueue_struct *m_cil_workqueue;
5889608d 179 struct workqueue_struct *m_reclaim_workqueue;
579b62fa 180 struct workqueue_struct *m_eofblocks_workqueue;
696a5620 181 struct workqueue_struct *m_sync_workqueue;
52785112
CH
182
183 /*
184 * Generation of the filesysyem layout. This is incremented by each
185 * growfs, and used by the pNFS server to ensure the client updates
186 * its view of the block device once it gets a layout that might
187 * reference the newly added blocks. Does not need to be persistent
188 * as long as we only allow file system size increments, but if we
189 * ever support shrinks it would have to be persisted in addition
190 * to various other kinds of pain inflicted on the pNFS server.
191 */
c8ce540d 192 uint32_t m_generation;
801cc4e1 193
66ae56a5 194 bool m_always_cow;
e6b3bb78 195 bool m_fail_unmount;
801cc4e1 196#ifdef DEBUG
31965ef3
DW
197 /*
198 * Frequency with which errors are injected. Replaces xfs_etest; the
199 * value stored in here is the inverse of the frequency with which the
200 * error triggers. 1 = always, 2 = half the time, etc.
201 */
202 unsigned int *m_errortag;
c6840101 203 struct xfs_kobj m_errortag_kobj;
801cc4e1 204#endif
1da177e4
LT
205} xfs_mount_t;
206
ef325959
DW
207#define M_IGEO(mp) (&(mp)->m_ino_geo)
208
1da177e4
LT
209/*
210 * Flags for m_flags.
211 */
92821e2b 212#define XFS_MOUNT_WSYNC (1ULL << 0) /* for nfs - all metadata ops
1da177e4
LT
213 must be synchronous except
214 for space allocations */
e6b3bb78 215#define XFS_MOUNT_UNMOUNTING (1ULL << 1) /* filesystem is unmounting */
92821e2b 216#define XFS_MOUNT_WAS_CLEAN (1ULL << 3)
e718eeb4 217#define XFS_MOUNT_FS_SHUTDOWN (1ULL << 4) /* atomic stop of all filesystem
1da177e4
LT
218 operations, typically for
219 disk errors in metadata */
e84661aa 220#define XFS_MOUNT_DISCARD (1ULL << 5) /* discard unused blocks */
e718eeb4 221#define XFS_MOUNT_NOALIGN (1ULL << 7) /* turn off stripe alignment
1da177e4 222 allocations */
13059ff0 223#define XFS_MOUNT_ATTR2 (1ULL << 8) /* allow use of attr2 format */
bd186aa9 224#define XFS_MOUNT_GRPID (1ULL << 9) /* group-ID assigned from directory */
e718eeb4 225#define XFS_MOUNT_NORECOVERY (1ULL << 10) /* no recovery - dirty fs */
3274d008 226#define XFS_MOUNT_ALLOCSIZE (1ULL << 12) /* specified allocation size */
12c3f05c
ES
227#define XFS_MOUNT_SMALL_INUMS (1ULL << 14) /* user wants 32bit inodes */
228#define XFS_MOUNT_32BITINODES (1ULL << 15) /* inode32 allocator active */
e718eeb4 229#define XFS_MOUNT_NOUUID (1ULL << 16) /* ignore uuid during mount */
1bd960ee 230#define XFS_MOUNT_IKEEP (1ULL << 18) /* keep empty inode clusters*/
e718eeb4 231#define XFS_MOUNT_SWALLOC (1ULL << 19) /* turn on stripe width
1da177e4 232 * allocation */
bd186aa9 233#define XFS_MOUNT_RDONLY (1ULL << 20) /* read-only fs */
e718eeb4 234#define XFS_MOUNT_DIRSYNC (1ULL << 21) /* synchronous directory ops */
7c6b94b1 235#define XFS_MOUNT_LARGEIO (1ULL << 22) /* report large preferred
e8c8b3a7 236 * I/O size in stat() */
2a82b8be
DC
237#define XFS_MOUNT_FILESTREAMS (1ULL << 24) /* enable the filestreams
238 allocator */
7c12f296 239#define XFS_MOUNT_NOATTR2 (1ULL << 25) /* disable use of attr2 format */
e8c8b3a7 240
cbe4dab1
DC
241#define XFS_MOUNT_DAX (1ULL << 62) /* TEST ONLY! */
242
1da177e4 243/*
1f443ad7
NS
244 * Max and min values for mount-option defined I/O
245 * preallocation sizes.
1da177e4 246 */
1f443ad7 247#define XFS_MAX_IO_LOG 30 /* 1G */
1da177e4
LT
248#define XFS_MIN_IO_LOG PAGE_SHIFT
249
92821e2b
DC
250#define XFS_LAST_UNMOUNT_WAS_CLEAN(mp) \
251 ((mp)->m_flags & XFS_MOUNT_WAS_CLEAN)
1da177e4 252#define XFS_FORCED_SHUTDOWN(mp) ((mp)->m_flags & XFS_MOUNT_FS_SHUTDOWN)
745f6919
CH
253void xfs_do_force_shutdown(struct xfs_mount *mp, int flags, char *fname,
254 int lnnum);
1da177e4 255#define xfs_force_shutdown(m,f) \
745f6919 256 xfs_do_force_shutdown(m, f, __FILE__, __LINE__)
1da177e4 257
2b5decd0
CH
258#define SHUTDOWN_META_IO_ERROR 0x0001 /* write attempt to metadata failed */
259#define SHUTDOWN_LOG_IO_ERROR 0x0002 /* write attempt to the log failed */
260#define SHUTDOWN_FORCE_UMOUNT 0x0004 /* shutdown from a forced unmount */
261#define SHUTDOWN_CORRUPT_INCORE 0x0008 /* corrupt in-memory data structures */
262#define SHUTDOWN_REMOTE_REQ 0x0010 /* shutdown came from remote cell */
263#define SHUTDOWN_DEVICE_REQ 0x0020 /* failed all paths to the device */
264
1da177e4
LT
265/*
266 * Flags for xfs_mountfs
267 */
764d1f89 268#define XFS_MFSI_QUIET 0x40 /* Be silent if mount errors found */
1da177e4 269
a844f451
NS
270static inline xfs_agnumber_t
271xfs_daddr_to_agno(struct xfs_mount *mp, xfs_daddr_t d)
1da177e4 272{
4f1adf33 273 xfs_rfsblock_t ld = XFS_BB_TO_FSBT(mp, d);
a844f451
NS
274 do_div(ld, mp->m_sb.sb_agblocks);
275 return (xfs_agnumber_t) ld;
1da177e4
LT
276}
277
a844f451
NS
278static inline xfs_agblock_t
279xfs_daddr_to_agbno(struct xfs_mount *mp, xfs_daddr_t d)
1da177e4 280{
4f1adf33 281 xfs_rfsblock_t ld = XFS_BB_TO_FSBT(mp, d);
a844f451 282 return (xfs_agblock_t) do_div(ld, mp->m_sb.sb_agblocks);
1da177e4
LT
283}
284
3fd129b6 285/* per-AG block reservation data structures*/
3fd129b6
DW
286struct xfs_ag_resv {
287 /* number of blocks originally reserved here */
288 xfs_extlen_t ar_orig_reserved;
289 /* number of blocks reserved here */
290 xfs_extlen_t ar_reserved;
291 /* number of blocks originally asked for */
292 xfs_extlen_t ar_asked;
293};
294
9356fe22
DC
295/*
296 * Per-ag incore structure, copies of information in agf and agi, to improve the
4fb6e8ad 297 * performance of allocation group selection.
9356fe22
DC
298 */
299typedef struct xfs_perag {
300 struct xfs_mount *pag_mount; /* owner filesystem */
301 xfs_agnumber_t pag_agno; /* AG this structure belongs to */
302 atomic_t pag_ref; /* perag reference count */
303 char pagf_init; /* this agf's entry is initialized */
304 char pagi_init; /* this agi's entry is initialized */
305 char pagf_metadata; /* the agf is preferred to be metadata */
306 char pagi_inodeok; /* The agi is ok for inodes */
c8ce540d 307 uint8_t pagf_levels[XFS_BTNUM_AGF];
9356fe22 308 /* # of levels in bno & cnt btree */
a27ba260 309 bool pagf_agflreset; /* agfl requires reset before use */
c8ce540d 310 uint32_t pagf_flcount; /* count of blocks in freelist */
9356fe22
DC
311 xfs_extlen_t pagf_freeblks; /* total free blocks */
312 xfs_extlen_t pagf_longest; /* longest free space */
c8ce540d 313 uint32_t pagf_btreeblks; /* # of blocks held in AGF btrees */
9356fe22
DC
314 xfs_agino_t pagi_freecount; /* number of free inodes */
315 xfs_agino_t pagi_count; /* number of allocated inodes */
316
317 /*
318 * Inode allocation search lookup optimisation.
319 * If the pagino matches, the search for new inodes
320 * doesn't need to search the near ones again straight away
321 */
322 xfs_agino_t pagl_pagino;
323 xfs_agino_t pagl_leftrec;
324 xfs_agino_t pagl_rightrec;
6772c1f1
DW
325
326 /*
327 * Bitsets of per-ag metadata that have been checked and/or are sick.
328 * Callers should hold pag_state_lock before accessing this field.
329 */
330 uint16_t pag_checked;
331 uint16_t pag_sick;
332 spinlock_t pag_state_lock;
333
9356fe22
DC
334 spinlock_t pagb_lock; /* lock for pagb_tree */
335 struct rb_root pagb_tree; /* ordered tree of busy extents */
ebf55872
CH
336 unsigned int pagb_gen; /* generation count for pagb_tree */
337 wait_queue_head_t pagb_wait; /* woken when pagb_gen changes */
9356fe22
DC
338
339 atomic_t pagf_fstrms; /* # of filestreams active in this AG */
340
341 spinlock_t pag_ici_lock; /* incore inode cache lock */
342 struct radix_tree_root pag_ici_root; /* incore inode cache root */
343 int pag_ici_reclaimable; /* reclaimable inodes */
344 struct mutex pag_ici_reclaim_lock; /* serialisation point */
345 unsigned long pag_ici_reclaim_cursor; /* reclaim restart point */
346
347 /* buffer cache index */
6031e73a
LS
348 spinlock_t pag_buf_lock; /* lock for pag_buf_hash */
349 struct rhashtable pag_buf_hash;
9356fe22
DC
350
351 /* for rcu-safe freeing */
352 struct rcu_head rcu_head;
353 int pagb_count; /* pagb slots in use */
3fd129b6
DW
354
355 /* Blocks reserved for all kinds of metadata. */
356 struct xfs_ag_resv pag_meta_resv;
21592863
BF
357 /* Blocks reserved for the reverse mapping btree. */
358 struct xfs_ag_resv pag_rmapbt_resv;
46eeb521
DW
359
360 /* reference count */
c8ce540d 361 uint8_t pagf_refcount_level;
9b247179
DW
362
363 /*
364 * Unlinked inode information. This incore information reflects
365 * data stored in the AGI, so callers must hold the AGI buffer lock
366 * or have some other means to control concurrency.
367 */
368 struct rhashtable pagi_unlinked_hash;
9356fe22
DC
369} xfs_perag_t;
370
3fd129b6
DW
371static inline struct xfs_ag_resv *
372xfs_perag_resv(
373 struct xfs_perag *pag,
374 enum xfs_ag_resv_type type)
375{
376 switch (type) {
377 case XFS_AG_RESV_METADATA:
378 return &pag->pag_meta_resv;
21592863
BF
379 case XFS_AG_RESV_RMAPBT:
380 return &pag->pag_rmapbt_resv;
3fd129b6
DW
381 default:
382 return NULL;
383 }
384}
385
6031e73a
LS
386int xfs_buf_hash_init(xfs_perag_t *pag);
387void xfs_buf_hash_destroy(xfs_perag_t *pag);
388
af3b6382 389extern void xfs_uuid_table_free(void);
adab0f67 390extern int xfs_log_sbcount(xfs_mount_t *);
c8ce540d 391extern uint64_t xfs_default_resblks(xfs_mount_t *mp);
4249023a 392extern int xfs_mountfs(xfs_mount_t *mp);
ff55068c
DC
393extern int xfs_initialize_perag(xfs_mount_t *mp, xfs_agnumber_t agcount,
394 xfs_agnumber_t *maxagi);
41b5c2e7 395extern void xfs_unmountfs(xfs_mount_t *);
964aa8d9 396
501ab323 397extern int xfs_mod_icount(struct xfs_mount *mp, int64_t delta);
e88b64ea 398extern int xfs_mod_ifree(struct xfs_mount *mp, int64_t delta);
0d485ada
DC
399extern int xfs_mod_fdblocks(struct xfs_mount *mp, int64_t delta,
400 bool reserved);
bab98bbe
DC
401extern int xfs_mod_frextents(struct xfs_mount *mp, int64_t delta);
402
8c9ce2f7 403extern struct xfs_buf *xfs_getsb(xfs_mount_t *);
764d1f89 404extern int xfs_readsb(xfs_mount_t *, int);
1da177e4 405extern void xfs_freesb(xfs_mount_t *);
91ee575f 406extern bool xfs_fs_writable(struct xfs_mount *mp, int level);
c8ce540d 407extern int xfs_sb_validate_fsb_count(struct xfs_sb *, uint64_t);
1da177e4 408
d7658d48
CH
409extern int xfs_dev_is_read_only(struct xfs_mount *, char *);
410
055388a3
DC
411extern void xfs_set_low_space_thresholds(struct xfs_mount *);
412
3fbbbea3
DC
413int xfs_zero_extent(struct xfs_inode *ip, xfs_fsblock_t start_fsb,
414 xfs_off_t count_fsb);
415
df309390
CM
416struct xfs_error_cfg * xfs_error_get_cfg(struct xfs_mount *mp,
417 int error_class, int error);
f467cad9 418void xfs_force_summary_recalc(struct xfs_mount *mp);
9fe82b8c 419void xfs_mod_delalloc(struct xfs_mount *mp, int64_t delta);
df309390 420
1da177e4 421#endif /* __XFS_MOUNT_H__ */