xref: /openbmc/linux/fs/xfs/xfs_rtalloc.h (revision 643d1f7f)
1 /*
2  * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
3  * All Rights Reserved.
4  *
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
7  * published by the Free Software Foundation.
8  *
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.
13  *
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
17  */
18 #ifndef __XFS_RTALLOC_H__
19 #define	__XFS_RTALLOC_H__
20 
21 struct xfs_mount;
22 struct xfs_trans;
23 
24 #define XFS_IS_REALTIME_INODE(ip) ((ip)->i_d.di_flags & XFS_DIFLAG_REALTIME)
25 
26 /* Min and max rt extent sizes, specified in bytes */
27 #define	XFS_MAX_RTEXTSIZE	(1024 * 1024 * 1024)	/* 1GB */
28 #define	XFS_DFL_RTEXTSIZE	(64 * 1024)	        /* 64KB */
29 #define	XFS_MIN_RTEXTSIZE	(4 * 1024)		/* 4KB */
30 
31 /*
32  * Constants for bit manipulations.
33  */
34 #define	XFS_NBBYLOG	3		/* log2(NBBY) */
35 #define	XFS_WORDLOG	2		/* log2(sizeof(xfs_rtword_t)) */
36 #define	XFS_NBWORDLOG	(XFS_NBBYLOG + XFS_WORDLOG)
37 #define	XFS_NBWORD	(1 << XFS_NBWORDLOG)
38 #define	XFS_WORDMASK	((1 << XFS_WORDLOG) - 1)
39 
40 #define	XFS_BLOCKSIZE(mp)	((mp)->m_sb.sb_blocksize)
41 #define	XFS_BLOCKMASK(mp)	((mp)->m_blockmask)
42 #define	XFS_BLOCKWSIZE(mp)	((mp)->m_blockwsize)
43 #define	XFS_BLOCKWMASK(mp)	((mp)->m_blockwmask)
44 
45 /*
46  * Summary and bit manipulation macros.
47  */
48 #define	XFS_SUMOFFS(mp,ls,bb)	((int)((ls) * (mp)->m_sb.sb_rbmblocks + (bb)))
49 #define	XFS_SUMOFFSTOBLOCK(mp,s)	\
50 	(((s) * (uint)sizeof(xfs_suminfo_t)) >> (mp)->m_sb.sb_blocklog)
51 #define	XFS_SUMPTR(mp,bp,so)	\
52 	((xfs_suminfo_t *)((char *)XFS_BUF_PTR(bp) + \
53 		(((so) * (uint)sizeof(xfs_suminfo_t)) & XFS_BLOCKMASK(mp))))
54 
55 #define	XFS_BITTOBLOCK(mp,bi)	((bi) >> (mp)->m_blkbit_log)
56 #define	XFS_BLOCKTOBIT(mp,bb)	((bb) << (mp)->m_blkbit_log)
57 #define	XFS_BITTOWORD(mp,bi)	\
58 	((int)(((bi) >> XFS_NBWORDLOG) & XFS_BLOCKWMASK(mp)))
59 
60 #define	XFS_RTMIN(a,b)	((a) < (b) ? (a) : (b))
61 #define	XFS_RTMAX(a,b)	((a) > (b) ? (a) : (b))
62 
63 #define	XFS_RTLOBIT(w)	xfs_lowbit32(w)
64 #define	XFS_RTHIBIT(w)	xfs_highbit32(w)
65 
66 #if XFS_BIG_BLKNOS
67 #define	XFS_RTBLOCKLOG(b)	xfs_highbit64(b)
68 #else
69 #define	XFS_RTBLOCKLOG(b)	xfs_highbit32(b)
70 #endif
71 
72 
73 #ifdef __KERNEL__
74 
75 #ifdef CONFIG_XFS_RT
76 /*
77  * Function prototypes for exported functions.
78  */
79 
80 /*
81  * Allocate an extent in the realtime subvolume, with the usual allocation
82  * parameters.  The length units are all in realtime extents, as is the
83  * result block number.
84  */
85 int					/* error */
86 xfs_rtallocate_extent(
87 	struct xfs_trans	*tp,	/* transaction pointer */
88 	xfs_rtblock_t		bno,	/* starting block number to allocate */
89 	xfs_extlen_t		minlen,	/* minimum length to allocate */
90 	xfs_extlen_t		maxlen,	/* maximum length to allocate */
91 	xfs_extlen_t		*len,	/* out: actual length allocated */
92 	xfs_alloctype_t		type,	/* allocation type XFS_ALLOCTYPE... */
93 	int			wasdel,	/* was a delayed allocation extent */
94 	xfs_extlen_t		prod,	/* extent product factor */
95 	xfs_rtblock_t		*rtblock); /* out: start block allocated */
96 
97 /*
98  * Free an extent in the realtime subvolume.  Length is expressed in
99  * realtime extents, as is the block number.
100  */
101 int					/* error */
102 xfs_rtfree_extent(
103 	struct xfs_trans	*tp,	/* transaction pointer */
104 	xfs_rtblock_t		bno,	/* starting block number to free */
105 	xfs_extlen_t		len);	/* length of extent freed */
106 
107 /*
108  * Initialize realtime fields in the mount structure.
109  */
110 int					/* error */
111 xfs_rtmount_init(
112 	struct xfs_mount	*mp);	/* file system mount structure */
113 
114 /*
115  * Get the bitmap and summary inodes into the mount structure
116  * at mount time.
117  */
118 int					/* error */
119 xfs_rtmount_inodes(
120 	struct xfs_mount	*mp);	/* file system mount structure */
121 
122 /*
123  * Pick an extent for allocation at the start of a new realtime file.
124  * Use the sequence number stored in the atime field of the bitmap inode.
125  * Translate this to a fraction of the rtextents, and return the product
126  * of rtextents and the fraction.
127  * The fraction sequence is 0, 1/2, 1/4, 3/4, 1/8, ..., 7/8, 1/16, ...
128  */
129 int					/* error */
130 xfs_rtpick_extent(
131 	struct xfs_mount	*mp,	/* file system mount point */
132 	struct xfs_trans	*tp,	/* transaction pointer */
133 	xfs_extlen_t		len,	/* allocation length (rtextents) */
134 	xfs_rtblock_t		*pick);	/* result rt extent */
135 
136 /*
137  * Grow the realtime area of the filesystem.
138  */
139 int
140 xfs_growfs_rt(
141 	struct xfs_mount	*mp,	/* file system mount structure */
142 	xfs_growfs_rt_t		*in);	/* user supplied growfs struct */
143 
144 #else
145 # define xfs_rtallocate_extent(t,b,min,max,l,a,f,p,rb)  (ENOSYS)
146 # define xfs_rtfree_extent(t,b,l)                       (ENOSYS)
147 # define xfs_rtpick_extent(m,t,l,rb)                    (ENOSYS)
148 # define xfs_growfs_rt(mp,in)                           (ENOSYS)
149 # define xfs_rtmount_init(m)    (((mp)->m_sb.sb_rblocks == 0)? 0 : (ENOSYS))
150 # define xfs_rtmount_inodes(m)  (((mp)->m_sb.sb_rblocks == 0)? 0 : (ENOSYS))
151 #endif	/* CONFIG_XFS_RT */
152 
153 #endif	/* __KERNEL__ */
154 
155 #endif	/* __XFS_RTALLOC_H__ */
156