blob: 5aec15d0651e836191d794edecddebc797cdf32c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Nathan Scott7b718762005-11-02 14:58:39 +11002 * Copyright (c) 2000-2002,2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
Nathan Scott7b718762005-11-02 14:58:39 +11005 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * published by the Free Software Foundation.
8 *
Nathan Scott7b718762005-11-02 14:58:39 +11009 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 *
Nathan Scott7b718762005-11-02 14:58:39 +110014 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 */
18#ifndef __XFS_ALLOC_H__
19#define __XFS_ALLOC_H__
20
21struct xfs_buf;
22struct xfs_mount;
23struct xfs_perag;
24struct xfs_trans;
25
26/*
27 * Freespace allocation types. Argument to xfs_alloc_[v]extent.
28 */
29typedef enum xfs_alloctype
30{
31 XFS_ALLOCTYPE_ANY_AG, /* allocate anywhere, use rotor */
32 XFS_ALLOCTYPE_FIRST_AG, /* ... start at ag 0 */
33 XFS_ALLOCTYPE_START_AG, /* anywhere, start in this a.g. */
34 XFS_ALLOCTYPE_THIS_AG, /* anywhere in this a.g. */
35 XFS_ALLOCTYPE_START_BNO, /* near this block else anywhere */
36 XFS_ALLOCTYPE_NEAR_BNO, /* in this a.g. and near this block */
37 XFS_ALLOCTYPE_THIS_BNO /* at exactly this block */
38} xfs_alloctype_t;
39
40/*
41 * Flags for xfs_alloc_fix_freelist.
42 */
43#define XFS_ALLOC_FLAG_TRYLOCK 0x00000001 /* use trylock for buffer locking */
Yingping Lud210a282006-06-09 14:55:18 +100044#define XFS_ALLOC_FLAG_FREEING 0x00000002 /* indicate caller is freeing extents*/
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
46/*
David Chinner4be536d2006-09-07 14:26:50 +100047 * In order to avoid ENOSPC-related deadlock caused by
48 * out-of-order locking of AGF buffer (PV 947395), we place
49 * constraints on the relationship among actual allocations for
50 * data blocks, freelist blocks, and potential file data bmap
51 * btree blocks. However, these restrictions may result in no
52 * actual space allocated for a delayed extent, for example, a data
53 * block in a certain AG is allocated but there is no additional
54 * block for the additional bmap btree block due to a split of the
55 * bmap btree of the file. The result of this may lead to an
56 * infinite loop in xfssyncd when the file gets flushed to disk and
57 * all delayed extents need to be actually allocated. To get around
58 * this, we explicitly set aside a few blocks which will not be
59 * reserved in delayed allocation. Considering the minimum number of
60 * needed freelist blocks is 4 fsbs _per AG_, a potential split of file's bmap
61 * btree requires 1 fsb, so we set the number of set-aside blocks
62 * to 4 + 4*agcount.
63 */
64#define XFS_ALLOC_SET_ASIDE(mp) (4 + ((mp)->m_sb.sb_agcount * 4))
65
66/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 * Argument structure for xfs_alloc routines.
68 * This is turned into a structure to avoid having 20 arguments passed
69 * down several levels of the stack.
70 */
71typedef struct xfs_alloc_arg {
72 struct xfs_trans *tp; /* transaction pointer */
73 struct xfs_mount *mp; /* file system mount point */
74 struct xfs_buf *agbp; /* buffer for a.g. freelist header */
75 struct xfs_perag *pag; /* per-ag struct for this agno */
76 xfs_fsblock_t fsbno; /* file system block number */
77 xfs_agnumber_t agno; /* allocation group number */
78 xfs_agblock_t agbno; /* allocation group-relative block # */
79 xfs_extlen_t minlen; /* minimum size of extent */
80 xfs_extlen_t maxlen; /* maximum size of extent */
81 xfs_extlen_t mod; /* mod value for extent size */
82 xfs_extlen_t prod; /* prod value for extent size */
83 xfs_extlen_t minleft; /* min blocks must be left after us */
84 xfs_extlen_t total; /* total blocks needed in xaction */
85 xfs_extlen_t alignment; /* align answer to multiple of this */
86 xfs_extlen_t minalignslop; /* slop for minlen+alignment calcs */
87 xfs_extlen_t len; /* output: actual size of extent */
88 xfs_alloctype_t type; /* allocation type XFS_ALLOCTYPE_... */
89 xfs_alloctype_t otype; /* original allocation type */
90 char wasdel; /* set if allocation was prev delayed */
91 char wasfromfl; /* set if allocation is from freelist */
Nathan Scottc41564b2006-03-29 08:55:14 +100092 char isfl; /* set if is freelist blocks - !acctg */
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 char userdata; /* set if this is user data */
Yingping Lud210a282006-06-09 14:55:18 +100094 xfs_fsblock_t firstblock; /* io first block allocated */
Linus Torvalds1da177e2005-04-16 15:20:36 -070095} xfs_alloc_arg_t;
96
97/*
98 * Defines for userdata
99 */
100#define XFS_ALLOC_USERDATA 1 /* allocation is for user data*/
101#define XFS_ALLOC_INITIAL_USER_DATA 2 /* special case start of file */
102
103
104#ifdef __KERNEL__
105
106#if defined(XFS_ALLOC_TRACE)
107/*
108 * Allocation tracing buffer size.
109 */
110#define XFS_ALLOC_TRACE_SIZE 4096
111extern ktrace_t *xfs_alloc_trace_buf;
112
113/*
114 * Types for alloc tracing.
115 */
116#define XFS_ALLOC_KTRACE_ALLOC 1
117#define XFS_ALLOC_KTRACE_FREE 2
118#define XFS_ALLOC_KTRACE_MODAGF 3
119#define XFS_ALLOC_KTRACE_BUSY 4
120#define XFS_ALLOC_KTRACE_UNBUSY 5
121#define XFS_ALLOC_KTRACE_BUSYSEARCH 6
122#endif
123
124/*
125 * Compute and fill in value of m_ag_maxlevels.
126 */
127void
128xfs_alloc_compute_maxlevels(
129 struct xfs_mount *mp); /* file system mount structure */
130
131/*
132 * Get a block from the freelist.
133 * Returns with the buffer for the block gotten.
134 */
135int /* error */
136xfs_alloc_get_freelist(
137 struct xfs_trans *tp, /* transaction pointer */
138 struct xfs_buf *agbp, /* buffer containing the agf structure */
David Chinner92821e22007-05-24 15:26:31 +1000139 xfs_agblock_t *bnop, /* block address retrieved from freelist */
140 int btreeblk); /* destination is a AGF btree */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
142/*
143 * Log the given fields from the agf structure.
144 */
145void
146xfs_alloc_log_agf(
147 struct xfs_trans *tp, /* transaction pointer */
148 struct xfs_buf *bp, /* buffer for a.g. freelist header */
149 int fields);/* mask of fields to be logged (XFS_AGF_...) */
150
151/*
152 * Interface for inode allocation to force the pag data to be initialized.
153 */
154int /* error */
155xfs_alloc_pagf_init(
156 struct xfs_mount *mp, /* file system mount structure */
157 struct xfs_trans *tp, /* transaction pointer */
158 xfs_agnumber_t agno, /* allocation group number */
159 int flags); /* XFS_ALLOC_FLAGS_... */
160
161/*
162 * Put the block on the freelist for the allocation group.
163 */
164int /* error */
165xfs_alloc_put_freelist(
166 struct xfs_trans *tp, /* transaction pointer */
167 struct xfs_buf *agbp, /* buffer for a.g. freelist header */
168 struct xfs_buf *agflbp,/* buffer for a.g. free block array */
David Chinner92821e22007-05-24 15:26:31 +1000169 xfs_agblock_t bno, /* block being freed */
170 int btreeblk); /* owner was a AGF btree */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
172/*
173 * Read in the allocation group header (free/alloc section).
174 */
175int /* error */
176xfs_alloc_read_agf(
177 struct xfs_mount *mp, /* mount point structure */
178 struct xfs_trans *tp, /* transaction pointer */
179 xfs_agnumber_t agno, /* allocation group number */
180 int flags, /* XFS_ALLOC_FLAG_... */
181 struct xfs_buf **bpp); /* buffer for the ag freelist header */
182
183/*
184 * Allocate an extent (variable-size).
185 */
186int /* error */
187xfs_alloc_vextent(
188 xfs_alloc_arg_t *args); /* allocation argument structure */
189
190/*
191 * Free an extent.
192 */
193int /* error */
194xfs_free_extent(
195 struct xfs_trans *tp, /* transaction pointer */
196 xfs_fsblock_t bno, /* starting block number of extent */
197 xfs_extlen_t len); /* length of extent */
198
199void
200xfs_alloc_mark_busy(xfs_trans_t *tp,
201 xfs_agnumber_t agno,
202 xfs_agblock_t bno,
203 xfs_extlen_t len);
204
205void
206xfs_alloc_clear_busy(xfs_trans_t *tp,
207 xfs_agnumber_t ag,
208 int idx);
209
210
211#endif /* __KERNEL__ */
212
213#endif /* __XFS_ALLOC_H__ */