]> git.ipfire.org Git - thirdparty/xfsprogs-dev.git/blame - include/xfs_mount.h
xfsprogs: Release v6.15.0
[thirdparty/xfsprogs-dev.git] / include / xfs_mount.h
CommitLineData
959ef981 1// SPDX-License-Identifier: GPL-2.0
b626fb59
DC
2/*
3 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
4 * All Rights Reserved.
b626fb59
DC
5 */
6
7#ifndef __XFS_MOUNT_H__
8#define __XFS_MOUNT_H__
9
10struct xfs_inode;
11struct xfs_buftarg;
b626fb59 12struct xfs_da_geometry;
ddd9942b 13struct libxfs_init;
0cf510a9 14struct xfs_group;
b626fb59 15
3b7667cb
DW
16typedef void (*buf_writeback_fn)(struct xfs_buf *bp);
17
33f3aac8
DC
18/* dynamic preallocation free space thresholds, 5% down to 1% */
19enum {
20 XFS_LOWSP_1_PCNT = 0,
21 XFS_LOWSP_2_PCNT,
22 XFS_LOWSP_3_PCNT,
23 XFS_LOWSP_4_PCNT,
24 XFS_LOWSP_5_PCNT,
25 XFS_LOWSP_MAX,
26};
27
6a271c73
CH
28struct xfs_groups {
29 struct xarray xa;
5214e3c4
CH
30
31 /*
32 * Maximum capacity of the group in FSBs.
33 *
34 * Each group is laid out densely in the daddr space. For the
35 * degenerate case of a pre-rtgroups filesystem, the incore rtgroup
36 * pretends to have a zero-block and zero-blklog rtgroup.
37 */
38 uint32_t blocks;
39
40 /*
41 * Log(2) of the logical size of each group.
42 *
43 * Compared to the blocks field above this is rounded up to the next
44 * power of two, and thus lays out the xfs_fsblock_t/xfs_rtblock_t
45 * space sparsely with a hole from blocks to (1 << blklog) at the end
46 * of each group.
47 */
48 uint8_t blklog;
49
584e4dcd
CH
50 /*
51 * Zoned devices can have gaps beyoned the usable capacity of a zone
52 * and the end in the LBA/daddr address space. In other words, the
53 * hardware equivalent to the RT groups already takes care of the power
54 * of 2 alignment for us. In this case the sparse FSB/RTB address space
55 * maps 1:1 to the device address space.
56 */
57 bool has_daddr_gaps;
58
5214e3c4
CH
59 /*
60 * Mask to extract the group-relative block number from a FSB.
61 * For a pre-rtgroups filesystem we pretend to have one very large
62 * rtgroup, so this mask must be 64-bit.
63 */
64 uint64_t blkmask;
9840f7e0
CH
65
66 /*
67 * Start of the first group in the device. This is used to support a
68 * RT device following the data device on the same block device for
69 * SMR hard drives.
70 */
71 xfs_fsblock_t start_fsb;
6a271c73
CH
72};
73
b626fb59
DC
74/*
75 * Define a user-level mount structure with all we need
76 * in order to make use of the numerous XFS_* macros.
77 */
78typedef struct xfs_mount {
79 xfs_sb_t m_sb; /* copy of fs superblock */
80#define m_icount m_sb.sb_icount
81#define m_ifree m_sb.sb_ifree
686bddf9 82 spinlock_t m_sb_lock;
f866934a
DW
83
84 /*
85 * Bitsets of per-fs metadata that have been checked and/or are sick.
86 * Callers must hold m_sb_lock to access these two fields.
87 */
88 uint8_t m_fs_checked;
89 uint8_t m_fs_sick;
90
b626fb59
DC
91 char *m_fsname; /* filesystem name */
92 int m_bsize; /* fs logical block size */
686bddf9 93 spinlock_t m_agirotor_lock;
b626fb59
DC
94 xfs_agnumber_t m_agfrotor; /* last ag where space found */
95 xfs_agnumber_t m_agirotor; /* last ag dir inode alloced */
96 xfs_agnumber_t m_maxagi; /* highest inode alloc group */
e7fd2b6f 97 struct xfs_ino_geometry m_ino_geo; /* inode geometry */
b626fb59 98 uint m_rsumlevels; /* rt summary levels */
84704ebf 99 xfs_filblks_t m_rsumblocks; /* size of rt summary, FSBs */
15402626 100 struct xfs_inode *m_metadirip; /* ptr to metadata directory */
15c6dada 101 struct xfs_inode *m_rtdirip; /* ptr to realtime metadir */
b626fb59
DC
102 struct xfs_buftarg *m_ddev_targp;
103 struct xfs_buftarg *m_logdev_targp;
104 struct xfs_buftarg *m_rtdev_targp;
105#define m_dev m_ddev_targp
106#define m_logdev m_logdev_targp
107#define m_rtdev m_rtdev_targp
14f8b681
DW
108 uint8_t m_dircook_elog; /* log d-cookie entry bits */
109 uint8_t m_blkbit_log; /* blocklog + NBBY */
110 uint8_t m_blkbb_log; /* blocklog - BBSHIFT */
111 uint8_t m_sectbb_log; /* sectorlog - BBSHIFT */
112 uint8_t m_agno_log; /* log #ag's */
5afaf820 113 int8_t m_rtxblklog; /* log2 of rextsize, if possible */
606a3744 114
b626fb59
DC
115 uint m_blockmask; /* sb_blocksize-1 */
116 uint m_blockwsize; /* sb_blocksize in words */
06fb4ab2
DW
117 /* number of rt extents per rt bitmap block if rtgroups enabled */
118 unsigned int m_rtx_per_rbmblock;
b626fb59
DC
119 uint m_alloc_mxr[2]; /* XFS_ALLOC_BLOCK_MAXRECS */
120 uint m_alloc_mnr[2]; /* XFS_ALLOC_BLOCK_MINRECS */
121 uint m_bmap_dmxr[2]; /* XFS_BMAP_BLOCK_DMAXRECS */
122 uint m_bmap_dmnr[2]; /* XFS_BMAP_BLOCK_DMINRECS */
b3a96b46
DW
123 uint m_rmap_mxr[2]; /* max rmap btree records */
124 uint m_rmap_mnr[2]; /* min rmap btree records */
17b28712
DW
125 uint m_rtrmap_mxr[2]; /* max rtrmap btree records */
126 uint m_rtrmap_mnr[2]; /* min rtrmap btree records */
d8079fe0
DW
127 uint m_refc_mxr[2]; /* max refc btree records */
128 uint m_refc_mnr[2]; /* min refc btree records */
4b7bd081
DW
129 unsigned int m_rtrefc_mxr[2]; /* max rtrefc btree records */
130 unsigned int m_rtrefc_mnr[2]; /* min rtrefc btree records */
4aa2259d
DW
131 uint m_alloc_maxlevels; /* max alloc btree levels */
132 uint m_bm_maxlevels[2]; /* max bmap btree levels */
b3a96b46 133 uint m_rmap_maxlevels; /* max rmap btree levels */
17b28712 134 uint m_rtrmap_maxlevels; /* max rtrmap btree level */
d8079fe0 135 uint m_refc_maxlevels; /* max refc btree levels */
4b7bd081 136 unsigned int m_rtrefc_maxlevels; /* max rtrefc btree level */
6afce48f 137 unsigned int m_agbtree_maxlevels; /* max level of all AG btrees */
2711590c 138 unsigned int m_rtbtree_maxlevels; /* max level of all rt btrees */
ef5340cd 139 xfs_extlen_t m_ag_prealloc_blocks; /* reserved ag blocks */
b8a8d6e5
DW
140 uint m_alloc_set_aside; /* space we can't use */
141 uint m_ag_max_usable; /* max space per AG */
6a271c73 142 struct xfs_groups m_groups[XG_TYPE_MAX];
3bc1fdd4 143 uint64_t m_features; /* active filesystem features */
33f3aac8 144 uint64_t m_low_space[XFS_LOWSP_MAX];
5afaf820 145 uint64_t m_rtxblkmask; /* rt extent block mask */
0ee9753e 146 unsigned long m_opstate; /* dynamic state flags */
4c7161ce 147 bool m_finobt_nores; /* no per-AG finobt resv. */
b626fb59
DC
148 uint m_qflags; /* quota status flags */
149 uint m_attroffset; /* inode attribute offset */
b626fb59 150 struct xfs_trans_resv m_resv; /* precomputed res values */
b626fb59
DC
151 int m_dalign; /* stripe unit */
152 int m_swidth; /* stripe width */
b626fb59
DC
153 const struct xfs_nameops *m_dirnameops; /* vector of dir name ops */
154
155 struct xfs_da_geometry *m_dir_geo; /* directory block geometry */
156 struct xfs_da_geometry *m_attr_geo; /* attribute block geometry */
b626fb59
DC
157
158 /*
159 * anonymous struct to allow xfs_dquot_buf.c to compile.
160 * Pointer is always null in userspace, so code does not use it at all
161 */
162 struct {
163 int qi_dqperchunk;
164 } *m_quotainfo;
165
3b7667cb
DW
166 buf_writeback_fn m_buf_writeback_fn;
167
1d6cb115
BF
168 /*
169 * xlog is defined in libxlog and thus is not intialized by libxfs. This
170 * allows an application to initialize and store a reference to the log
171 * if warranted.
172 */
e7fd2b6f 173 struct xlog *m_log; /* log specific stuff */
92c76be5
BF
174
175 /*
176 * Global count of allocation btree blocks in use across all AGs. Only
177 * used when perag reservation is enabled. Helps prevent block
178 * reservation from attempting to reserve allocation btree blocks.
179 */
180 atomic64_t m_allocbt_blks;
4bcd30f6 181 spinlock_t m_perag_lock; /* lock for m_perag_tree */
92c76be5 182
7e427bb1
CH
183 pthread_mutex_t m_metafile_resv_lock;
184 uint64_t m_metafile_resv_target;
185 uint64_t m_metafile_resv_used;
186 uint64_t m_metafile_resv_avail;
b626fb59
DC
187} xfs_mount_t;
188
e7fd2b6f
DW
189#define M_IGEO(mp) (&(mp)->m_ino_geo)
190
3bc1fdd4
DC
191/*
192 * Flags for m_features.
193 *
194 * These are all the active features in the filesystem, regardless of how
195 * they are configured.
196 */
197#define XFS_FEAT_ATTR (1ULL << 0) /* xattrs present in fs */
198#define XFS_FEAT_NLINK (1ULL << 1) /* 32 bit link counts */
199#define XFS_FEAT_QUOTA (1ULL << 2) /* quota active */
200#define XFS_FEAT_ALIGN (1ULL << 3) /* inode alignment */
201#define XFS_FEAT_DALIGN (1ULL << 4) /* data alignment */
202#define XFS_FEAT_LOGV2 (1ULL << 5) /* version 2 logs */
203#define XFS_FEAT_SECTOR (1ULL << 6) /* sector size > 512 bytes */
204#define XFS_FEAT_EXTFLG (1ULL << 7) /* unwritten extents */
205#define XFS_FEAT_ASCIICI (1ULL << 8) /* ASCII only case-insens. */
206#define XFS_FEAT_LAZYSBCOUNT (1ULL << 9) /* Superblk counters */
207#define XFS_FEAT_ATTR2 (1ULL << 10) /* dynamic attr fork */
208#define XFS_FEAT_PARENT (1ULL << 11) /* parent pointers */
209#define XFS_FEAT_PROJID32 (1ULL << 12) /* 32 bit project id */
210#define XFS_FEAT_CRC (1ULL << 13) /* metadata CRCs */
211#define XFS_FEAT_V3INODES (1ULL << 14) /* Version 3 inodes */
212#define XFS_FEAT_PQUOTINO (1ULL << 15) /* non-shared proj/grp quotas */
213#define XFS_FEAT_FTYPE (1ULL << 16) /* inode type in dir */
214#define XFS_FEAT_FINOBT (1ULL << 17) /* free inode btree */
215#define XFS_FEAT_RMAPBT (1ULL << 18) /* reverse map btree */
216#define XFS_FEAT_REFLINK (1ULL << 19) /* reflinked files */
217#define XFS_FEAT_SPINODES (1ULL << 20) /* sparse inode chunks */
218#define XFS_FEAT_META_UUID (1ULL << 21) /* metadata UUID */
219#define XFS_FEAT_REALTIME (1ULL << 22) /* realtime device present */
220#define XFS_FEAT_INOBTCNT (1ULL << 23) /* inobt block counts */
221#define XFS_FEAT_BIGTIME (1ULL << 24) /* large timestamps */
222#define XFS_FEAT_NEEDSREPAIR (1ULL << 25) /* needs xfs_repair */
d7eb8fbd 223#define XFS_FEAT_NREXT64 (1ULL << 26) /* large extent counters */
8f6bd3ba 224#define XFS_FEAT_EXCHANGE_RANGE (1ULL << 27) /* exchange range */
65713c2c 225#define XFS_FEAT_METADIR (1ULL << 28) /* metadata directory tree */
611ad47e 226#define XFS_FEAT_ZONED (1ULL << 29) /* zoned RT device */
3bc1fdd4
DC
227
228#define __XFS_HAS_FEAT(name, NAME) \
55a3eca0 229static inline bool xfs_has_ ## name (const struct xfs_mount *mp) \
3bc1fdd4
DC
230{ \
231 return mp->m_features & XFS_FEAT_ ## NAME; \
232}
233
234/* Some features can be added dynamically so they need a set wrapper, too. */
235#define __XFS_ADD_FEAT(name, NAME) \
236 __XFS_HAS_FEAT(name, NAME); \
237static inline void xfs_add_ ## name (struct xfs_mount *mp) \
238{ \
239 mp->m_features |= XFS_FEAT_ ## NAME; \
240 xfs_sb_version_add ## name(&mp->m_sb); \
241}
242
243/* Superblock features */
244__XFS_ADD_FEAT(attr, ATTR)
245__XFS_HAS_FEAT(nlink, NLINK)
246__XFS_ADD_FEAT(quota, QUOTA)
247__XFS_HAS_FEAT(align, ALIGN)
248__XFS_HAS_FEAT(dalign, DALIGN)
249__XFS_HAS_FEAT(logv2, LOGV2)
250__XFS_HAS_FEAT(sector, SECTOR)
251__XFS_HAS_FEAT(extflg, EXTFLG)
252__XFS_HAS_FEAT(asciici, ASCIICI)
253__XFS_HAS_FEAT(lazysbcount, LAZYSBCOUNT)
254__XFS_ADD_FEAT(attr2, ATTR2)
255__XFS_HAS_FEAT(parent, PARENT)
256__XFS_ADD_FEAT(projid32, PROJID32)
257__XFS_HAS_FEAT(crc, CRC)
258__XFS_HAS_FEAT(v3inodes, V3INODES)
259__XFS_HAS_FEAT(pquotino, PQUOTINO)
260__XFS_HAS_FEAT(ftype, FTYPE)
261__XFS_HAS_FEAT(finobt, FINOBT)
262__XFS_HAS_FEAT(rmapbt, RMAPBT)
263__XFS_HAS_FEAT(reflink, REFLINK)
264__XFS_HAS_FEAT(sparseinodes, SPINODES)
265__XFS_HAS_FEAT(metauuid, META_UUID)
266__XFS_HAS_FEAT(realtime, REALTIME)
267__XFS_HAS_FEAT(inobtcounts, INOBTCNT)
268__XFS_HAS_FEAT(bigtime, BIGTIME)
269__XFS_HAS_FEAT(needsrepair, NEEDSREPAIR)
d7eb8fbd 270__XFS_HAS_FEAT(large_extent_counts, NREXT64)
8f6bd3ba 271__XFS_HAS_FEAT(exchange_range, EXCHANGE_RANGE)
65713c2c 272__XFS_HAS_FEAT(metadir, METADIR)
611ad47e 273__XFS_HAS_FEAT(zoned, ZONED)
001b79f0 274
55a3eca0 275static inline bool xfs_has_rtgroups(const struct xfs_mount *mp)
001b79f0 276{
1278e817
DW
277 /* all metadir file systems also allow rtgroups */
278 return xfs_has_metadir(mp);
001b79f0
DW
279}
280
55a3eca0 281static inline bool xfs_has_rtsb(const struct xfs_mount *mp)
001b79f0 282{
1278e817 283 /* all rtgroups filesystems with an rt section have an rtsb */
611ad47e
CH
284 return xfs_has_rtgroups(mp) &&
285 xfs_has_realtime(mp) &&
286 !xfs_has_zoned(mp);
001b79f0
DW
287}
288
55a3eca0 289static inline bool xfs_has_rtrmapbt(const struct xfs_mount *mp)
17b28712
DW
290{
291 return xfs_has_rtgroups(mp) && xfs_has_realtime(mp) &&
292 xfs_has_rmapbt(mp);
293}
294
55a3eca0 295static inline bool xfs_has_rtreflink(const struct xfs_mount *mp)
4b7bd081
DW
296{
297 return xfs_has_metadir(mp) && xfs_has_realtime(mp) &&
298 xfs_has_reflink(mp);
299}
300
611ad47e
CH
301static inline bool xfs_has_nonzoned(const struct xfs_mount *mp)
302{
303 return !xfs_has_zoned(mp);
304}
305
914e2a04
DC
306/* Kernel mount features that we don't support */
307#define __XFS_UNSUPP_FEAT(name) \
55a3eca0 308static inline bool xfs_has_ ## name (const struct xfs_mount *mp) \
914e2a04
DC
309{ \
310 return false; \
311}
312__XFS_UNSUPP_FEAT(wsync)
313__XFS_UNSUPP_FEAT(noattr2)
314__XFS_UNSUPP_FEAT(ikeep)
315__XFS_UNSUPP_FEAT(swalloc)
316__XFS_UNSUPP_FEAT(small_inums)
0ee9753e 317__XFS_UNSUPP_FEAT(readonly)
fdf7f987 318__XFS_UNSUPP_FEAT(grpid)
0ee9753e
DC
319
320/* Operational mount state flags */
321#define XFS_OPSTATE_INODE32 0 /* inode32 allocator active */
2420d095
DW
322#define XFS_OPSTATE_DEBUGGER 1 /* is this the debugger? */
323#define XFS_OPSTATE_REPORT_CORRUPTION 2 /* report buffer corruption? */
324#define XFS_OPSTATE_PERAG_DATA_LOADED 3 /* per-AG data initialized? */
001b79f0 325#define XFS_OPSTATE_RTGROUP_DATA_LOADED 4 /* rtgroup data initialized? */
0ee9753e
DC
326
327#define __XFS_IS_OPSTATE(name, NAME) \
328static inline bool xfs_is_ ## name (struct xfs_mount *mp) \
329{ \
330 return (mp)->m_opstate & (1UL << XFS_OPSTATE_ ## NAME); \
331} \
332static inline bool xfs_clear_ ## name (struct xfs_mount *mp) \
333{ \
334 bool ret = xfs_is_ ## name(mp); \
335\
336 (mp)->m_opstate &= ~(1UL << XFS_OPSTATE_ ## NAME); \
337 return ret; \
338} \
339static inline bool xfs_set_ ## name (struct xfs_mount *mp) \
340{ \
341 bool ret = xfs_is_ ## name(mp); \
342\
343 (mp)->m_opstate |= (1UL << XFS_OPSTATE_ ## NAME); \
344 return ret; \
345}
346
347__XFS_IS_OPSTATE(inode32, INODE32)
2420d095
DW
348__XFS_IS_OPSTATE(debugger, DEBUGGER)
349__XFS_IS_OPSTATE(reporting_corruption, REPORT_CORRUPTION)
350__XFS_IS_OPSTATE(perag_data_loaded, PERAG_DATA_LOADED)
001b79f0 351__XFS_IS_OPSTATE(rtgroup_data_loaded, RTGROUP_DATA_LOADED)
0ee9753e
DC
352
353#define __XFS_UNSUPP_OPSTATE(name) \
354static inline bool xfs_is_ ## name (struct xfs_mount *mp) \
355{ \
356 return false; \
357}
358__XFS_UNSUPP_OPSTATE(readonly)
93adb06a 359__XFS_UNSUPP_OPSTATE(shutdown)
914e2a04 360
91643efd
CH
361static inline int64_t xfs_sum_freecounter(struct xfs_mount *mp,
362 enum xfs_free_counter ctr)
363{
364 if (ctr == XC_FREE_RTEXTENTS)
365 return mp->m_sb.sb_frextents;
366 return mp->m_sb.sb_fdblocks;
367}
368
369static inline int64_t xfs_estimate_freecounter(struct xfs_mount *mp,
370 enum xfs_free_counter ctr)
371{
372 return xfs_sum_freecounter(mp, ctr);
373}
374
375static inline int xfs_compare_freecounter(struct xfs_mount *mp,
376 enum xfs_free_counter ctr, int64_t rhs, int32_t batch)
377{
378 uint64_t count;
379
380 if (ctr == XC_FREE_RTEXTENTS)
381 count = mp->m_sb.sb_frextents;
382 else
383 count = mp->m_sb.sb_fdblocks;
384 if (count > rhs)
385 return 1;
386 else if (count < rhs)
387 return -1;
388 return 0;
389}
390
e42c53f3
DW
391/* don't fail on device size or AG count checks */
392#define LIBXFS_MOUNT_DEBUGGER (1U << 0)
393/* report metadata corruption to stdout */
394#define LIBXFS_MOUNT_REPORT_CORRUPTION (1U << 1)
b626fb59
DC
395
396#define LIBXFS_BHASHSIZE(sbp) (1<<10)
397
7aeffc87 398void libxfs_compute_all_maxlevels(struct xfs_mount *mp);
ed8f5980 399struct xfs_mount *libxfs_mount(struct xfs_mount *mp, struct xfs_sb *sb,
ddd9942b 400 struct libxfs_init *xi, unsigned int flags);
a7348c58 401int libxfs_flush_mount(struct xfs_mount *mp);
c335b673 402int libxfs_umount(struct xfs_mount *mp);
b626fb59
DC
403extern void libxfs_rtmount_destroy (xfs_mount_t *);
404
06963ef0
DW
405/* Dummy xfs_dquot so that libxfs compiles. */
406struct xfs_dquot {
407 int q_type;
408};
5363c39d 409
7ab29798
DC
410typedef struct wait_queue_head {
411} wait_queue_head_t;
412
413static inline void wake_up(wait_queue_head_t *wq) {}
414
7cb26322
DW
415struct xfs_defer_drain { /* empty */ };
416
417#define xfs_defer_drain_init(dr) ((void)0)
418#define xfs_defer_drain_free(dr) ((void)0)
419
0cf510a9
CH
420#define xfs_group_intent_get(mp, fsbno, type) \
421 xfs_group_get_by_fsb((mp), (fsbno), (type))
422#define xfs_group_intent_put(xg) xfs_group_put(xg)
7cb26322 423
0cf510a9
CH
424static inline void xfs_group_intent_hold(struct xfs_group *xg) {}
425static inline void xfs_group_intent_rele(struct xfs_group *xg) {}
7cb26322 426
d466c866
DW
427static inline void libxfs_buftarg_drain(struct xfs_buftarg *btp)
428{
429 cache_purge(btp->bcache);
430}
431
fdf7f987
DW
432struct mnt_idmap {
433 /* empty */
434};
435
436/* bogus idmapping so that mkfs can do directory inheritance correctly */
437#define libxfs_nop_idmap ((struct mnt_idmap *)1)
438
b626fb59 439#endif /* __XFS_MOUNT_H__ */