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