include/xfs_alloc.h

   1 /*
   2  * Copyright (c) 2000 Silicon Graphics, Inc.  All Rights Reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of version 2 of the GNU General Public License as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it would be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  11  *
  12  * Further, this software is distributed without any warranty that it is
  13  * free of the rightful claim of any third person regarding infringement
  14  * or the like.  Any license provided herein, whether implied or
  15  * otherwise, applies only to this software file.  Patent licenses, if
  16  * any, provided herein do not apply to combinations of this program with
  17  * other software, or any other product whatsoever.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write the Free Software Foundation, Inc., 59
  21  * Temple Place - Suite 330, Boston MA 02111-1307, USA.
  22  *
  23  * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
  24  * Mountain View, CA  94043, or:
  25  *
  26  * http://www.sgi.com
  27  *
  28  * For further information regarding this notice, see:
  29  *
  30  * http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
  31  */
  32 #ifndef __XFS_ALLOC_H__
  33 #define __XFS_ALLOC_H__
  34
  35 struct xfs_buf;
  36 struct xfs_mount;
  37 struct xfs_perag;
  38 struct xfs_trans;
  39
  40 /*
  41  * Freespace allocation types.  Argument to xfs_alloc_[v]extent.
  42  */
  43 typedef enum xfs_alloctype
  44 {
  45         XFS_ALLOCTYPE_ANY_AG,           /* allocate anywhere, use rotor */
  46         XFS_ALLOCTYPE_FIRST_AG,         /* ... start at ag 0 */
  47         XFS_ALLOCTYPE_START_AG,         /* anywhere, start in this a.g. */
  48         XFS_ALLOCTYPE_THIS_AG,          /* anywhere in this a.g. */
  49         XFS_ALLOCTYPE_START_BNO,        /* near this block else anywhere */
  50         XFS_ALLOCTYPE_NEAR_BNO,         /* in this a.g. and near this block */
  51         XFS_ALLOCTYPE_THIS_BNO          /* at exactly this block */
  52 } xfs_alloctype_t;
  53
  54 /*
  55  * Flags for xfs_alloc_fix_freelist.
  56  */
  57 #define XFS_ALLOC_FLAG_TRYLOCK  0x00000001  /* use trylock for buffer locking */
  58
  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  */
  64 typedef 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 */
  69         xfs_fsblock_t   fsbno;          /* file system block number */
  70         xfs_agnumber_t  agno;           /* allocation group number */
  71         xfs_agblock_t   agbno;          /* allocation group-relative block # */
  72         xfs_extlen_t    minlen;         /* minimum size of extent */
  73         xfs_extlen_t    maxlen;         /* maximum size of extent */
  74         xfs_extlen_t    mod;            /* mod value for extent size */
  75         xfs_extlen_t    prod;           /* prod value for extent size */
  76         xfs_extlen_t    minleft;        /* min blocks must be left after us */
  77         xfs_extlen_t    total;          /* total blocks needed in xaction */
  78         xfs_extlen_t    alignment;      /* align answer to multiple of this */
  79         xfs_extlen_t    minalignslop;   /* slop for minlen+alignment calcs */
  80         xfs_extlen_t    len;            /* output: actual size of extent */
  81         xfs_alloctype_t type;           /* allocation type XFS_ALLOCTYPE_... */
  82         xfs_alloctype_t otype;          /* original allocation type */
  83         char            wasdel;         /* set if allocation was prev delayed */
  84         char            wasfromfl;      /* set if allocation is from freelist */
  85         char            isfl;           /* set if is freelist blocks - !actg */
  86         char            userdata;       /* set if this is user data */
  87 } xfs_alloc_arg_t;
  88
  89 /*
  90  * Defines for userdata
  91  */
  92 #define XFS_ALLOC_USERDATA              1       /* allocation is for user data*/
  93 #define XFS_ALLOC_INITIAL_USER_DATA     2       /* special case start of file */
  94
  95
  96 #ifdef __KERNEL__
  97
  98 /*
  99  * Types for alloc tracing.
 100  */
 101 #define XFS_ALLOC_KTRACE_ALLOC  1
 102 #define XFS_ALLOC_KTRACE_FREE   2
 103 #define XFS_ALLOC_KTRACE_MODAGF 3
 104 #define XFS_ALLOC_KTRACE_BUSY   4
 105 #define XFS_ALLOC_KTRACE_UNBUSY 5
 106 #define XFS_ALLOC_KTRACE_BUSYSEARCH     6
 107
 108
 109 /*
 110  * Allocation tracing buffer size.
 111  */
 112 #define XFS_ALLOC_TRACE_SIZE    4096
 113
 114 #ifdef  XFS_ALL_TRACE
 115 #define XFS_ALLOC_TRACE
 116 #endif
 117
 118 #if !defined(DEBUG)
 119 #undef  XFS_ALLOC_TRACE
 120 #endif
 121
 122 /*
 123  * Prototypes for visible xfs_alloc.c routines
 124  */
 125
 126 /*
 127  * Compute and fill in value of m_ag_maxlevels.
 128  */
 129 void
 130 xfs_alloc_compute_maxlevels(
 131         struct xfs_mount        *mp);   /* file system mount structure */
 132
 133 /*
 134  * Decide whether to use this allocation group for this allocation.
 135  * If so, fix up the btree freelist's size.
 136  * This is external so mkfs can call it, too.
 137  */
 138 int                             /* error */
 139 xfs_alloc_fix_freelist(
 140         xfs_alloc_arg_t *args,  /* allocation argument structure */
 141         int             flags); /* XFS_ALLOC_FLAG_... */
 142
 143 /*
 144  * Get a block from the freelist.
 145  * Returns with the buffer for the block gotten.
 146  */
 147 int                             /* error */
 148 xfs_alloc_get_freelist(
 149         struct xfs_trans *tp,   /* transaction pointer */
 150         struct xfs_buf  *agbp,  /* buffer containing the agf structure */
 151         xfs_agblock_t   *bnop); /* block address retrieved from freelist */
 152
 153 /*
 154  * Log the given fields from the agf structure.
 155  */
 156 void
 157 xfs_alloc_log_agf(
 158         struct xfs_trans *tp,   /* transaction pointer */
 159         struct xfs_buf  *bp,    /* buffer for a.g. freelist header */
 160         int             fields);/* mask of fields to be logged (XFS_AGF_...) */
 161
 162 /*
 163  * Interface for inode allocation to force the pag data to be initialized.
 164  */
 165 int                             /* error */
 166 xfs_alloc_pagf_init(
 167         struct xfs_mount *mp,   /* file system mount structure */
 168         struct xfs_trans *tp,   /* transaction pointer */
 169         xfs_agnumber_t  agno,   /* allocation group number */
 170         int             flags); /* XFS_ALLOC_FLAGS_... */
 171
 172 /*
 173  * Put the block on the freelist for the allocation group.
 174  */
 175 int                             /* error */
 176 xfs_alloc_put_freelist(
 177         struct xfs_trans *tp,   /* transaction pointer */
 178         struct xfs_buf  *agbp,  /* buffer for a.g. freelist header */
 179         struct xfs_buf  *agflbp,/* buffer for a.g. free block array */
 180         xfs_agblock_t   bno);   /* block being freed */
 181
 182 /*
 183  * Read in the allocation group header (free/alloc section).
 184  */
 185 int                                     /* error  */
 186 xfs_alloc_read_agf(
 187         struct xfs_mount *mp,           /* mount point structure */
 188         struct xfs_trans *tp,           /* transaction pointer */
 189         xfs_agnumber_t  agno,           /* allocation group number */
 190         int             flags,          /* XFS_ALLOC_FLAG_... */
 191         struct xfs_buf  **bpp);         /* buffer for the ag freelist header */
 192
 193 /*
 194  * Allocate an extent (variable-size).
 195  */
 196 int                             /* error */
 197 xfs_alloc_vextent(
 198         xfs_alloc_arg_t *args); /* allocation argument structure */
 199
 200 /*
 201  * Free an extent.
 202  */
 203 int                             /* error */
 204 xfs_free_extent(
 205         struct xfs_trans *tp,   /* transaction pointer */
 206         xfs_fsblock_t   bno,    /* starting block number of extent */
 207         xfs_extlen_t    len);   /* length of extent */
 208
 209 void
 210 xfs_alloc_mark_busy(xfs_trans_t *tp,
 211                 xfs_agnumber_t agno,
 212                 xfs_agblock_t bno,
 213                 xfs_extlen_t len);
 214
 215 void
 216 xfs_alloc_clear_busy(xfs_trans_t *tp,
 217                 xfs_agnumber_t ag,
 218                 int idx);
 219
 220
 221 #endif  /* __KERNEL__ */
 222
 223 #endif  /* __XFS_ALLOC_H__ */