]> git.ipfire.org Git - thirdparty/xfsprogs-dev.git/blame - libxfs/xfs_alloc.h
xfs: clean up xfs_mount allocation and dynamic initializers
[thirdparty/xfsprogs-dev.git] / libxfs / xfs_alloc.h
CommitLineData
2bd0ea18 1/*
f302e9e4
NS
2 * Copyright (c) 2000-2002,2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
5000d01d 4 *
f302e9e4
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
2bd0ea18 7 * published by the Free Software Foundation.
5000d01d 8 *
f302e9e4
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.
5000d01d 13 *
f302e9e4
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
2bd0ea18
NS
17 */
18#ifndef __XFS_ALLOC_H__
dfc130f3 19#define __XFS_ALLOC_H__
2bd0ea18
NS
20
21struct xfs_buf;
a2ceac1f 22struct xfs_btree_cur;
2bd0ea18
NS
23struct xfs_mount;
24struct xfs_perag;
25struct xfs_trans;
a2ceac1f
DC
26
27extern struct workqueue_struct *xfs_alloc_wq;
2bd0ea18 28
b8165508
DC
29unsigned int xfs_agfl_size(struct xfs_mount *mp);
30
2bd0ea18 31/*
dfc130f3 32 * Freespace allocation types. Argument to xfs_alloc_[v]extent.
2bd0ea18 33 */
56b2de80 34#define XFS_ALLOCTYPE_FIRST_AG 0x02 /* ... start at ag 0 */
56b2de80
DC
35#define XFS_ALLOCTYPE_THIS_AG 0x08 /* anywhere in this a.g. */
36#define XFS_ALLOCTYPE_START_BNO 0x10 /* near this block else anywhere */
37#define XFS_ALLOCTYPE_NEAR_BNO 0x20 /* in this a.g. and near this block */
38#define XFS_ALLOCTYPE_THIS_BNO 0x40 /* at exactly this block */
39
40/* this should become an enum again when the tracing code is fixed */
41typedef unsigned int xfs_alloctype_t;
42
43#define XFS_ALLOC_TYPES \
56b2de80 44 { XFS_ALLOCTYPE_FIRST_AG, "FIRST_AG" }, \
56b2de80
DC
45 { XFS_ALLOCTYPE_THIS_AG, "THIS_AG" }, \
46 { XFS_ALLOCTYPE_START_BNO, "START_BNO" }, \
47 { XFS_ALLOCTYPE_NEAR_BNO, "NEAR_BNO" }, \
48 { XFS_ALLOCTYPE_THIS_BNO, "THIS_BNO" }
2bd0ea18
NS
49
50/*
51 * Flags for xfs_alloc_fix_freelist.
52 */
dfc130f3 53#define XFS_ALLOC_FLAG_TRYLOCK 0x00000001 /* use trylock for buffer locking */
5e656dbb 54#define XFS_ALLOC_FLAG_FREEING 0x00000002 /* indicate caller is freeing extents*/
e365af6f
DW
55#define XFS_ALLOC_FLAG_NORMAP 0x00000004 /* don't modify the rmapbt */
56#define XFS_ALLOC_FLAG_NOSHRINK 0x00000008 /* don't shrink the freelist */
2c003dc2 57#define XFS_ALLOC_FLAG_CHECK 0x00000010 /* test only, don't modify args */
5e656dbb 58
2bd0ea18
NS
59/*
60 * Argument structure for xfs_alloc routines.
61 * This is turned into a structure to avoid having 20 arguments passed
62 * down several levels of the stack.
63 */
64typedef struct xfs_alloc_arg {
65 struct xfs_trans *tp; /* transaction pointer */
66 struct xfs_mount *mp; /* file system mount point */
67 struct xfs_buf *agbp; /* buffer for a.g. freelist header */
68 struct xfs_perag *pag; /* per-ag struct for this agno */
9542ae13 69 struct xfs_inode *ip; /* for userdata zeroing method */
2bd0ea18
NS
70 xfs_fsblock_t fsbno; /* file system block number */
71 xfs_agnumber_t agno; /* allocation group number */
72 xfs_agblock_t agbno; /* allocation group-relative block # */
73 xfs_extlen_t minlen; /* minimum size of extent */
74 xfs_extlen_t maxlen; /* maximum size of extent */
75 xfs_extlen_t mod; /* mod value for extent size */
76 xfs_extlen_t prod; /* prod value for extent size */
77 xfs_extlen_t minleft; /* min blocks must be left after us */
78 xfs_extlen_t total; /* total blocks needed in xaction */
79 xfs_extlen_t alignment; /* align answer to multiple of this */
80 xfs_extlen_t minalignslop; /* slop for minlen+alignment calcs */
ff3263dd
BF
81 xfs_agblock_t min_agbno; /* set an agbno range for NEAR allocs */
82 xfs_agblock_t max_agbno; /* ... */
2bd0ea18 83 xfs_extlen_t len; /* output: actual size of extent */
dfc130f3
RC
84 xfs_alloctype_t type; /* allocation type XFS_ALLOCTYPE_... */
85 xfs_alloctype_t otype; /* original allocation type */
1fccd5c8 86 int datatype; /* mask defining data type treatment */
2bd0ea18
NS
87 char wasdel; /* set if allocation was prev delayed */
88 char wasfromfl; /* set if allocation is from freelist */
5e656dbb 89 xfs_fsblock_t firstblock; /* io first block allocated */
85aec44f 90 struct xfs_owner_info oinfo; /* owner of blocks being allocated */
cf8ce220 91 enum xfs_ag_resv_type resv; /* block reservation to use */
2bd0ea18
NS
92} xfs_alloc_arg_t;
93
34317449 94/*
1fccd5c8 95 * Defines for datatype
34317449 96 */
9542ae13
DC
97#define XFS_ALLOC_USERDATA (1 << 0)/* allocation is for user data*/
98#define XFS_ALLOC_INITIAL_USER_DATA (1 << 1)/* special case start of file */
99#define XFS_ALLOC_USERDATA_ZERO (1 << 2)/* zero extent on allocation */
1fccd5c8
DC
100#define XFS_ALLOC_NOBUSY (1 << 3)/* Busy extents not allowed */
101
102static inline bool
103xfs_alloc_is_userdata(int datatype)
104{
105 return (datatype & ~XFS_ALLOC_NOBUSY) != 0;
106}
107
108static inline bool
109xfs_alloc_allow_busy_reuse(int datatype)
110{
111 return (datatype & XFS_ALLOC_NOBUSY) == 0;
112}
34317449 113
b8a8d6e5
DW
114/* freespace limit calculations */
115#define XFS_ALLOC_AGFL_RESERVE 4
116unsigned int xfs_alloc_set_aside(struct xfs_mount *mp);
117unsigned int xfs_alloc_ag_max_usable(struct xfs_mount *mp);
118
72bda06d 119xfs_extlen_t xfs_alloc_longest_free_extent(struct xfs_mount *mp,
cf8ce220
DW
120 struct xfs_perag *pag, xfs_extlen_t need,
121 xfs_extlen_t reserved);
de046644
DC
122unsigned int xfs_alloc_min_freelist(struct xfs_mount *mp,
123 struct xfs_perag *pag);
23aab3f9 124
2bd0ea18
NS
125/*
126 * Compute and fill in value of m_ag_maxlevels.
127 */
128void
129xfs_alloc_compute_maxlevels(
130 struct xfs_mount *mp); /* file system mount structure */
131
2bd0ea18
NS
132/*
133 * Get a block from the freelist.
134 * Returns with the buffer for the block gotten.
135 */
136int /* error */
137xfs_alloc_get_freelist(
138 struct xfs_trans *tp, /* transaction pointer */
139 struct xfs_buf *agbp, /* buffer containing the agf structure */
cdded3d8
DC
140 xfs_agblock_t *bnop, /* block address retrieved from freelist */
141 int btreeblk); /* destination is a AGF btree */
2bd0ea18
NS
142
143/*
144 * Log the given fields from the agf structure.
145 */
146void
147xfs_alloc_log_agf(
148 struct xfs_trans *tp, /* transaction pointer */
149 struct xfs_buf *bp, /* buffer for a.g. freelist header */
150 int fields);/* mask of fields to be logged (XFS_AGF_...) */
151
152/*
153 * Interface for inode allocation to force the pag data to be initialized.
154 */
155int /* error */
156xfs_alloc_pagf_init(
157 struct xfs_mount *mp, /* file system mount structure */
158 struct xfs_trans *tp, /* transaction pointer */
159 xfs_agnumber_t agno, /* allocation group number */
dfc130f3 160 int flags); /* XFS_ALLOC_FLAGS_... */
2bd0ea18
NS
161
162/*
163 * Put the block on the freelist for the allocation group.
164 */
165int /* error */
166xfs_alloc_put_freelist(
167 struct xfs_trans *tp, /* transaction pointer */
168 struct xfs_buf *agbp, /* buffer for a.g. freelist header */
169 struct xfs_buf *agflbp,/* buffer for a.g. free block array */
cdded3d8
DC
170 xfs_agblock_t bno, /* block being freed */
171 int btreeblk); /* owner was a AGF btree */
2bd0ea18
NS
172
173/*
174 * Read in the allocation group header (free/alloc section).
175 */
176int /* error */
177xfs_alloc_read_agf(
178 struct xfs_mount *mp, /* mount point structure */
179 struct xfs_trans *tp, /* transaction pointer */
180 xfs_agnumber_t agno, /* allocation group number */
181 int flags, /* XFS_ALLOC_FLAG_... */
182 struct xfs_buf **bpp); /* buffer for the ag freelist header */
183
184/*
185 * Allocate an extent (variable-size).
186 */
187int /* error */
188xfs_alloc_vextent(
dfc130f3 189 xfs_alloc_arg_t *args); /* allocation argument structure */
2bd0ea18
NS
190
191/*
192 * Free an extent.
193 */
194int /* error */
195xfs_free_extent(
85aec44f
DW
196 struct xfs_trans *tp, /* transaction pointer */
197 xfs_fsblock_t bno, /* starting block number of extent */
198 xfs_extlen_t len, /* length of extent */
cf8ce220
DW
199 struct xfs_owner_info *oinfo, /* extent owner */
200 enum xfs_ag_resv_type type); /* block reservation type */
2bd0ea18 201
1fe41a73
DW
202int /* error */
203xfs_alloc_lookup_le(
204 struct xfs_btree_cur *cur, /* btree cursor */
205 xfs_agblock_t bno, /* starting block of extent */
206 xfs_extlen_t len, /* length of extent */
207 int *stat); /* success/failure */
208
a2ceac1f
DC
209int /* error */
210xfs_alloc_lookup_ge(
211 struct xfs_btree_cur *cur, /* btree cursor */
212 xfs_agblock_t bno, /* starting block of extent */
213 xfs_extlen_t len, /* length of extent */
214 int *stat); /* success/failure */
215
216int /* error */
217xfs_alloc_get_rec(
218 struct xfs_btree_cur *cur, /* btree cursor */
219 xfs_agblock_t *bno, /* output: starting block of extent */
220 xfs_extlen_t *len, /* output: length of extent */
221 int *stat); /* output: success/failure */
222
5a35bf2c
DC
223int xfs_read_agf(struct xfs_mount *mp, struct xfs_trans *tp,
224 xfs_agnumber_t agno, int flags, struct xfs_buf **bpp);
50bb67d6
DW
225int xfs_alloc_read_agfl(struct xfs_mount *mp, struct xfs_trans *tp,
226 xfs_agnumber_t agno, struct xfs_buf **bpp);
e515cca1 227int xfs_alloc_fix_freelist(struct xfs_alloc_arg *args, int flags);
2a6da3b8
DC
228int xfs_free_extent_fix_freelist(struct xfs_trans *tp, xfs_agnumber_t agno,
229 struct xfs_buf **agbp);
5a35bf2c 230
ef5340cd
DW
231xfs_extlen_t xfs_prealloc_blocks(struct xfs_mount *mp);
232
b3d83fa6
DW
233typedef int (*xfs_alloc_query_range_fn)(
234 struct xfs_btree_cur *cur,
235 struct xfs_alloc_rec_incore *rec,
236 void *priv);
237
238int xfs_alloc_query_range(struct xfs_btree_cur *cur,
239 struct xfs_alloc_rec_incore *low_rec,
240 struct xfs_alloc_rec_incore *high_rec,
241 xfs_alloc_query_range_fn fn, void *priv);
7e05e856
DW
242int xfs_alloc_query_all(struct xfs_btree_cur *cur, xfs_alloc_query_range_fn fn,
243 void *priv);
9bef6258
DW
244xfs_agblock_t xfs_ag_block_count(struct xfs_mount *mp, xfs_agnumber_t agno);
245bool xfs_verify_agbno(struct xfs_mount *mp, xfs_agnumber_t agno,
246 xfs_agblock_t agbno);
247bool xfs_verify_fsbno(struct xfs_mount *mp, xfs_fsblock_t fsbno);
b3d83fa6 248
1fe41a73
DW
249int xfs_alloc_has_record(struct xfs_btree_cur *cur, xfs_agblock_t bno,
250 xfs_extlen_t len, bool *exist);
251
2bd0ea18 252#endif /* __XFS_ALLOC_H__ */