[thirdparty/xfsprogs-dev.git] / libxfs / xfs_ialloc.h

/*
 * Copyright (c) 2000,2005 Silicon Graphics, Inc.
 * All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it would be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write the Free Software Foundation,
 * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
#ifndef __XFS_IALLOC_H__
#define	__XFS_IALLOC_H__

struct xfs_buf;
struct xfs_dinode;
struct xfs_imap;
struct xfs_mount;
struct xfs_trans;
struct xfs_btree_cur;

/* Move inodes in clusters of this size */
#define	XFS_INODE_BIG_CLUSTER_SIZE	8192

struct xfs_icluster {
	bool		deleted;	/* record is deleted */
	xfs_ino_t	first_ino;	/* first inode number */
	uint64_t	alloc;		/* inode phys. allocation bitmap for
					 * sparse chunks */
};

/* Calculate and return the number of filesystem blocks per inode cluster */
static inline int
xfs_icluster_size_fsb(
	struct xfs_mount	*mp)
{
	if (mp->m_sb.sb_blocksize >= mp->m_inode_cluster_size)
		return 1;
	return mp->m_inode_cluster_size >> mp->m_sb.sb_blocklog;
}

/*
 * Make an inode pointer out of the buffer/offset.
 */
static inline struct xfs_dinode *
xfs_make_iptr(struct xfs_mount *mp, struct xfs_buf *b, int o)
{
	return xfs_buf_offset(b, o << (mp)->m_sb.sb_inodelog);
}

/*
 * Allocate an inode on disk.
 * Mode is used to tell whether the new inode will need space, and whether
 * it is a directory.
 *
 * To work within the constraint of one allocation per transaction,
 * xfs_dialloc() is designed to be called twice if it has to do an
 * allocation to make more free inodes.  If an inode is
 * available without an allocation, agbp would be set to the current
 * agbp and alloc_done set to false.
 * If an allocation needed to be done, agbp would be set to the
 * inode header of the allocation group and alloc_done set to true.
 * The caller should then commit the current transaction and allocate a new
 * transaction.  xfs_dialloc() should then be called again with
 * the agbp value returned from the previous call.
 *
 * Once we successfully pick an inode its number is returned and the
 * on-disk data structures are updated.  The inode itself is not read
 * in, since doing so would break ordering constraints with xfs_reclaim.
 *
 * *agbp should be set to NULL on the first call, *alloc_done set to FALSE.
 */
int					/* error */
xfs_dialloc(
	struct xfs_trans *tp,		/* transaction pointer */
	xfs_ino_t	parent,		/* parent inode (directory) */
	umode_t		mode,		/* mode bits for new inode */
	struct xfs_buf	**agbp,		/* buf for a.g. inode header */
	xfs_ino_t	*inop);		/* inode number allocated */

/*
 * Free disk inode.  Carefully avoids touching the incore inode, all
 * manipulations incore are the caller's responsibility.
 * The on-disk inode is not changed by this operation, only the
 * btree (free inode mask) is changed.
 */
int					/* error */
xfs_difree(
	struct xfs_trans *tp,		/* transaction pointer */
	xfs_ino_t	inode,		/* inode to be freed */
	struct xfs_defer_ops *dfops,	/* extents to free */
	struct xfs_icluster *ifree);	/* cluster info if deleted */

/*
 * Return the location of the inode in imap, for mapping it into a buffer.
 */
int
xfs_imap(
	struct xfs_mount *mp,		/* file system mount structure */
	struct xfs_trans *tp,		/* transaction pointer */
	xfs_ino_t	ino,		/* inode to locate */
	struct xfs_imap	*imap,		/* location map structure */
	uint		flags);		/* flags for inode btree lookup */

/*
 * Compute and fill in value of m_in_maxlevels.
 */
void
xfs_ialloc_compute_maxlevels(
	struct xfs_mount *mp);		/* file system mount structure */

/*
 * Log specified fields for the ag hdr (inode section)
 */
void
xfs_ialloc_log_agi(
	struct xfs_trans *tp,		/* transaction pointer */
	struct xfs_buf	*bp,		/* allocation group header buffer */
	int		fields);	/* bitmask of fields to log */

/*
 * Read in the allocation group header (inode allocation section)
 */
int					/* error */
xfs_ialloc_read_agi(
	struct xfs_mount *mp,		/* file system mount structure */
	struct xfs_trans *tp,		/* transaction pointer */
	xfs_agnumber_t	agno,		/* allocation group number */
	struct xfs_buf	**bpp);		/* allocation group hdr buf */

/*
 * Read in the allocation group header to initialise the per-ag data
 * in the mount structure
 */
int
xfs_ialloc_pagi_init(
	struct xfs_mount *mp,		/* file system mount structure */
	struct xfs_trans *tp,		/* transaction pointer */
        xfs_agnumber_t  agno);		/* allocation group number */

/*
 * Lookup a record by ino in the btree given by cur.
 */
int xfs_inobt_lookup(struct xfs_btree_cur *cur, xfs_agino_t ino,
		xfs_lookup_t dir, int *stat);

/*
 * Get the data from the pointed-to record.
 */
int xfs_inobt_get_rec(struct xfs_btree_cur *cur,
		xfs_inobt_rec_incore_t *rec, int *stat);

/*
 * Inode chunk initialisation routine
 */
int xfs_ialloc_inode_init(struct xfs_mount *mp, struct xfs_trans *tp,
			  struct list_head *buffer_list, int icount,
			  xfs_agnumber_t agno, xfs_agblock_t agbno,
			  xfs_agblock_t length, unsigned int gen);

int xfs_read_agi(struct xfs_mount *mp, struct xfs_trans *tp,
		xfs_agnumber_t agno, struct xfs_buf **bpp);

union xfs_btree_rec;
void xfs_inobt_btrec_to_irec(struct xfs_mount *mp, union xfs_btree_rec *rec,
		struct xfs_inobt_rec_incore *irec);
int xfs_ialloc_has_inodes_at_extent(struct xfs_btree_cur *cur,
		xfs_agblock_t bno, xfs_extlen_t len, bool *exists);
int xfs_ialloc_has_inode_record(struct xfs_btree_cur *cur, xfs_agino_t low,
		xfs_agino_t high, bool *exists);
int xfs_ialloc_count_inodes(struct xfs_btree_cur *cur, xfs_agino_t *count,
		xfs_agino_t *freecount);
int xfs_inobt_insert_rec(struct xfs_btree_cur *cur, uint16_t holemask,
		uint8_t count, int32_t freecount, xfs_inofree_t free,
		int *stat);

int xfs_ialloc_cluster_alignment(struct xfs_mount *mp);
void xfs_ialloc_agino_range(struct xfs_mount *mp, xfs_agnumber_t agno,
		xfs_agino_t *first, xfs_agino_t *last);
bool xfs_verify_agino(struct xfs_mount *mp, xfs_agnumber_t agno,
		xfs_agino_t agino);
bool xfs_verify_ino(struct xfs_mount *mp, xfs_ino_t ino);
bool xfs_internal_inum(struct xfs_mount *mp, xfs_ino_t ino);
bool xfs_verify_dir_ino(struct xfs_mount *mp, xfs_ino_t ino);

#endif	/* __XFS_IALLOC_H__ */
Commit	Line	Data
2bd0ea18	1	/*
f302e9e4 NS	2	* Copyright (c) 2000,2005 Silicon Graphics, Inc.
f302e9e4 NS	3	* All Rights Reserved.
5000d01d	4	*
f302e9e4 NS	5	* This program is free software; you can redistribute it and/or
f302e9e4 NS	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	*/
2bd0ea18 NS	18	#ifndef __XFS_IALLOC_H__
dfc130f3	19	#define __XFS_IALLOC_H__
2bd0ea18 NS	20
	21	struct xfs_buf;
	22	struct xfs_dinode;
56b2de80	23	struct xfs_imap;
2bd0ea18 NS	24	struct xfs_mount;
2bd0ea18 NS	25	struct xfs_trans;
34b8c759	26	struct xfs_btree_cur;
2bd0ea18	27
ff105f75	28	/* Move inodes in clusters of this size */
dfc130f3	29	#define XFS_INODE_BIG_CLUSTER_SIZE 8192
ff105f75	30
5a3b2e0a BF	31	struct xfs_icluster {
	32	bool deleted; /* record is deleted */
	33	xfs_ino_t first_ino; /* first inode number */
	34	uint64_t alloc; /* inode phys. allocation bitmap for
	35	* sparse chunks */
	36	};
	37
ff105f75 DC	38	/* Calculate and return the number of filesystem blocks per inode cluster */
	39	static inline int
	40	xfs_icluster_size_fsb(
	41	struct xfs_mount *mp)
	42	{
	43	if (mp->m_sb.sb_blocksize >= mp->m_inode_cluster_size)
	44	return 1;
	45	return mp->m_inode_cluster_size >> mp->m_sb.sb_blocklog;
	46	}
2bd0ea18 NS	47
	48	/*
	49	* Make an inode pointer out of the buffer/offset.
	50	*/
f302e9e4 NS	51	static inline struct xfs_dinode *
	52	xfs_make_iptr(struct xfs_mount mp, struct xfs_buf b, int o)
	53	{
92acb899	54	return xfs_buf_offset(b, o << (mp)->m_sb.sb_inodelog);
f302e9e4	55	}
2bd0ea18	56
2bd0ea18 NS	57	/*
	58	* Allocate an inode on disk.
	59	* Mode is used to tell whether the new inode will need space, and whether
	60	* it is a directory.
	61	*
	62	* To work within the constraint of one allocation per transaction,
	63	* xfs_dialloc() is designed to be called twice if it has to do an
dfc130f3	64	* allocation to make more free inodes. If an inode is
2bd0ea18 NS	65	* available without an allocation, agbp would be set to the current
	66	* agbp and alloc_done set to false.
	67	* If an allocation needed to be done, agbp would be set to the
	68	* inode header of the allocation group and alloc_done set to true.
	69	* The caller should then commit the current transaction and allocate a new
dfc130f3	70	* transaction. xfs_dialloc() should then be called again with
2bd0ea18 NS	71	* the agbp value returned from the previous call.
	72	*
	73	* Once we successfully pick an inode its number is returned and the
dfc130f3	74	* on-disk data structures are updated. The inode itself is not read
2bd0ea18 NS	75	* in, since doing so would break ordering constraints with xfs_reclaim.
	76	*
	77	* agbp should be set to NULL on the first call, alloc_done set to FALSE.
	78	*/
	79	int /* error */
	80	xfs_dialloc(
	81	struct xfs_trans tp, / transaction pointer */
	82	xfs_ino_t parent, /* parent inode (directory) */
a2ceac1f	83	umode_t mode, /* mode bits for new inode */
2bd0ea18	84	struct xfs_buf *agbp, / buf for a.g. inode header */
2bd0ea18 NS	85	xfs_ino_t inop); / inode number allocated */
	86
	87	/*
	88	* Free disk inode. Carefully avoids touching the incore inode, all
	89	* manipulations incore are the caller's responsibility.
	90	* The on-disk inode is not changed by this operation, only the
	91	* btree (free inode mask) is changed.
	92	*/
	93	int /* error */
	94	xfs_difree(
	95	struct xfs_trans tp, / transaction pointer */
23aab3f9	96	xfs_ino_t inode, /* inode to be freed */
f33cea1a	97	struct xfs_defer_ops dfops, / extents to free */
5a3b2e0a	98	struct xfs_icluster ifree); / cluster info if deleted */
2bd0ea18 NS	99
2bd0ea18 NS	100	/*
56b2de80	101	* Return the location of the inode in imap, for mapping it into a buffer.
2bd0ea18 NS	102	*/
2bd0ea18 NS	103	int
56b2de80	104	xfs_imap(
2bd0ea18 NS	105	struct xfs_mount mp, / file system mount structure */
	106	struct xfs_trans tp, / transaction pointer */
	107	xfs_ino_t ino, /* inode to locate */
56b2de80	108	struct xfs_imap imap, / location map structure */
2bd0ea18 NS	109	uint flags); /* flags for inode btree lookup */
	110
	111	/*
	112	* Compute and fill in value of m_in_maxlevels.
	113	*/
	114	void
	115	xfs_ialloc_compute_maxlevels(
	116	struct xfs_mount mp); / file system mount structure */
	117
	118	/*
	119	* Log specified fields for the ag hdr (inode section)
	120	*/
	121	void
	122	xfs_ialloc_log_agi(
	123	struct xfs_trans tp, / transaction pointer */
	124	struct xfs_buf bp, / allocation group header buffer */
	125	int fields); /* bitmask of fields to log */
	126
	127	/*
	128	* Read in the allocation group header (inode allocation section)
	129	*/
	130	int /* error */
	131	xfs_ialloc_read_agi(
	132	struct xfs_mount mp, / file system mount structure */
	133	struct xfs_trans tp, / transaction pointer */
	134	xfs_agnumber_t agno, /* allocation group number */
	135	struct xfs_buf *bpp); / allocation group hdr buf */
	136
cdded3d8 DC	137	/*
	138	* Read in the allocation group header to initialise the per-ag data
	139	* in the mount structure
	140	*/
	141	int
	142	xfs_ialloc_pagi_init(
	143	struct xfs_mount mp, / file system mount structure */
	144	struct xfs_trans tp, / transaction pointer */
	145	xfs_agnumber_t agno); /* allocation group number */
	146
b194c7d8	147	/*
56b2de80	148	* Lookup a record by ino in the btree given by cur.
b194c7d8	149	*/
56b2de80 DC	150	int xfs_inobt_lookup(struct xfs_btree_cur *cur, xfs_agino_t ino,
56b2de80 DC	151	xfs_lookup_t dir, int *stat);
b194c7d8 BN	152
	153	/*
	154	* Get the data from the pointed-to record.
	155	*/
a2ceac1f	156	int xfs_inobt_get_rec(struct xfs_btree_cur *cur,
56b2de80	157	xfs_inobt_rec_incore_t rec, int stat);
b194c7d8	158
e9d35108 DC	159	/*
	160	* Inode chunk initialisation routine
	161	*/
	162	int xfs_ialloc_inode_init(struct xfs_mount mp, struct xfs_trans tp,
fe8d48ac	163	struct list_head *buffer_list, int icount,
e9d35108 DC	164	xfs_agnumber_t agno, xfs_agblock_t agbno,
	165	xfs_agblock_t length, unsigned int gen);
	166
5a35bf2c DC	167	int xfs_read_agi(struct xfs_mount mp, struct xfs_trans tp,
	168	xfs_agnumber_t agno, struct xfs_buf **bpp);
	169
b5f6747c DW	170	union xfs_btree_rec;
	171	void xfs_inobt_btrec_to_irec(struct xfs_mount mp, union xfs_btree_rec rec,
	172	struct xfs_inobt_rec_incore *irec);
9deb7f65 DW	173	int xfs_ialloc_has_inodes_at_extent(struct xfs_btree_cur *cur,
	174	xfs_agblock_t bno, xfs_extlen_t len, bool *exists);
	175	int xfs_ialloc_has_inode_record(struct xfs_btree_cur *cur, xfs_agino_t low,
	176	xfs_agino_t high, bool *exists);
	177	int xfs_ialloc_count_inodes(struct xfs_btree_cur cur, xfs_agino_t count,
	178	xfs_agino_t *freecount);
aa465192 DW	179	int xfs_inobt_insert_rec(struct xfs_btree_cur *cur, uint16_t holemask,
	180	uint8_t count, int32_t freecount, xfs_inofree_t free,
	181	int *stat);
b5f6747c DW	182
b5f6747c DW	183	int xfs_ialloc_cluster_alignment(struct xfs_mount *mp);
be3bf25c DW	184	void xfs_ialloc_agino_range(struct xfs_mount *mp, xfs_agnumber_t agno,
	185	xfs_agino_t first, xfs_agino_t last);
	186	bool xfs_verify_agino(struct xfs_mount *mp, xfs_agnumber_t agno,
	187	xfs_agino_t agino);
	188	bool xfs_verify_ino(struct xfs_mount *mp, xfs_ino_t ino);
	189	bool xfs_internal_inum(struct xfs_mount *mp, xfs_ino_t ino);
	190	bool xfs_verify_dir_ino(struct xfs_mount *mp, xfs_ino_t ino);
5a35bf2c	191
2bd0ea18	192	#endif /* __XFS_IALLOC_H__ */