[mirror_ubuntu-zesty-kernel.git] / fs / ocfs2 / suballoc.h

/* -*- mode: c; c-basic-offset: 8; -*-
 * vim: noexpandtab sw=8 ts=8 sts=0:
 *
 * suballoc.h
 *
 * Defines sub allocator api
 *
 * Copyright (C) 2003, 2004 Oracle.  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; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will 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 to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 021110-1307, USA.
 */

#ifndef _CHAINALLOC_H_
#define _CHAINALLOC_H_

typedef int (group_search_t)(struct inode *,
			     struct buffer_head *,
			     u32,			/* bits_wanted */
			     u32,			/* min_bits */
			     u64,			/* max_block */
			     u16 *,			/* *bit_off */
			     u16 *);			/* *bits_found */

struct ocfs2_alloc_context {
	struct inode *ac_inode;    /* which bitmap are we allocating from? */
	struct buffer_head *ac_bh; /* file entry bh */
	u32    ac_alloc_slot;   /* which slot are we allocating from? */
	u32    ac_bits_wanted;
	u32    ac_bits_given;
#define OCFS2_AC_USE_LOCAL 1
#define OCFS2_AC_USE_MAIN  2
#define OCFS2_AC_USE_INODE 3
#define OCFS2_AC_USE_META  4
	u32    ac_which;

	/* these are used by the chain search */
	u16    ac_chain;
	int    ac_allow_chain_relink;
	group_search_t *ac_group_search;

	u64    ac_last_group;
	u64    ac_max_block;  /* Highest block number to allocate. 0 is
				 is the same as ~0 - unlimited */
};

void ocfs2_init_steal_slots(struct ocfs2_super *osb);
void ocfs2_free_alloc_context(struct ocfs2_alloc_context *ac);
static inline int ocfs2_alloc_context_bits_left(struct ocfs2_alloc_context *ac)
{
	return ac->ac_bits_wanted - ac->ac_bits_given;
}

/*
 * Please note that the caller must make sure that root_el is the root
 * of extent tree. So for an inode, it should be &fe->id2.i_list. Otherwise
 * the result may be wrong.
 */
int ocfs2_reserve_new_metadata(struct ocfs2_super *osb,
			       struct ocfs2_extent_list *root_el,
			       struct ocfs2_alloc_context **ac);
int ocfs2_reserve_new_metadata_blocks(struct ocfs2_super *osb,
				      int blocks,
				      struct ocfs2_alloc_context **ac);
int ocfs2_reserve_new_inode(struct ocfs2_super *osb,
			    struct ocfs2_alloc_context **ac);
int ocfs2_reserve_clusters(struct ocfs2_super *osb,
			   u32 bits_wanted,
			   struct ocfs2_alloc_context **ac);

int ocfs2_claim_metadata(struct ocfs2_super *osb,
			 handle_t *handle,
			 struct ocfs2_alloc_context *ac,
			 u32 bits_wanted,
			 u16 *suballoc_bit_start,
			 u32 *num_bits,
			 u64 *blkno_start);
int ocfs2_claim_new_inode(struct ocfs2_super *osb,
			  handle_t *handle,
			  struct inode *dir,
			  struct buffer_head *parent_fe_bh,
			  struct ocfs2_alloc_context *ac,
			  u16 *suballoc_bit,
			  u64 *fe_blkno);
int ocfs2_claim_clusters(struct ocfs2_super *osb,
			 handle_t *handle,
			 struct ocfs2_alloc_context *ac,
			 u32 min_clusters,
			 u32 *cluster_start,
			 u32 *num_clusters);
/*
 * Use this variant of ocfs2_claim_clusters to specify a maxiumum
 * number of clusters smaller than the allocation reserved.
 */
int __ocfs2_claim_clusters(struct ocfs2_super *osb,
			   handle_t *handle,
			   struct ocfs2_alloc_context *ac,
			   u32 min_clusters,
			   u32 max_clusters,
			   u32 *cluster_start,
			   u32 *num_clusters);

int ocfs2_free_suballoc_bits(handle_t *handle,
			     struct inode *alloc_inode,
			     struct buffer_head *alloc_bh,
			     unsigned int start_bit,
			     u64 bg_blkno,
			     unsigned int count);
int ocfs2_free_dinode(handle_t *handle,
		      struct inode *inode_alloc_inode,
		      struct buffer_head *inode_alloc_bh,
		      struct ocfs2_dinode *di);
int ocfs2_free_clusters(handle_t *handle,
			struct inode *bitmap_inode,
			struct buffer_head *bitmap_bh,
			u64 start_blk,
			unsigned int num_clusters);

static inline u64 ocfs2_which_suballoc_group(u64 block, unsigned int bit)
{
	u64 group = block - (u64) bit;

	return group;
}

static inline u32 ocfs2_cluster_from_desc(struct ocfs2_super *osb,
					  u64 bg_blkno)
{
	/* This should work for all block group descriptors as only
	 * the 1st group descriptor of the cluster bitmap is
	 * different. */

	if (bg_blkno == osb->first_cluster_group_blkno)
		return 0;

	/* the rest of the block groups are located at the beginning
	 * of their 1st cluster, so a direct translation just
	 * works. */
	return ocfs2_blocks_to_clusters(osb->sb, bg_blkno);
}

static inline int ocfs2_is_cluster_bitmap(struct inode *inode)
{
	struct ocfs2_super *osb = OCFS2_SB(inode->i_sb);
	return osb->bitmap_blkno == OCFS2_I(inode)->ip_blkno;
}

/* This is for local alloc ONLY. Others should use the task-specific
 * apis above. */
int ocfs2_reserve_cluster_bitmap_bits(struct ocfs2_super *osb,
				      struct ocfs2_alloc_context *ac);
void ocfs2_free_ac_resource(struct ocfs2_alloc_context *ac);

/* given a cluster offset, calculate which block group it belongs to
 * and return that block offset. */
u64 ocfs2_which_cluster_group(struct inode *inode, u32 cluster);

/*
 * By default, ocfs2_read_group_descriptor() calls ocfs2_error() when it
 * finds a problem.  A caller that wants to check a group descriptor
 * without going readonly should read the block with ocfs2_read_block[s]()
 * and then checking it with this function.  This is only resize, really.
 * Everyone else should be using ocfs2_read_group_descriptor().
 */
int ocfs2_check_group_descriptor(struct super_block *sb,
				 struct ocfs2_dinode *di,
				 struct buffer_head *bh);
/*
 * Read a group descriptor block into *bh.  If *bh is NULL, a bh will be
 * allocated.  This is a cached read.  The descriptor will be validated with
 * ocfs2_validate_group_descriptor().
 */
int ocfs2_read_group_descriptor(struct inode *inode, struct ocfs2_dinode *di,
				u64 gd_blkno, struct buffer_head **bh);

int ocfs2_lock_allocators(struct inode *inode, struct ocfs2_extent_tree *et,
			  u32 clusters_to_add, u32 extents_to_split,
			  struct ocfs2_alloc_context **data_ac,
			  struct ocfs2_alloc_context **meta_ac);

int ocfs2_test_inode_bit(struct ocfs2_super *osb, u64 blkno, int *res);
#endif /* _CHAINALLOC_H_ */
Commit	Line	Data
ccd979bd MF	1	/* -- mode: c; c-basic-offset: 8; --
	2	* vim: noexpandtab sw=8 ts=8 sts=0:
	3	*
	4	* suballoc.h
	5	*
	6	* Defines sub allocator api
	7	*
	8	* Copyright (C) 2003, 2004 Oracle. All rights reserved.
	9	*
	10	* This program is free software; you can redistribute it and/or
	11	* modify it under the terms of the GNU General Public
	12	* License as published by the Free Software Foundation; either
	13	* version 2 of the License, or (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	18	* General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public
	21	* License along with this program; if not, write to the
	22	* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
	23	* Boston, MA 021110-1307, USA.
	24	*/
	25
	26	#ifndef _CHAINALLOC_H_
	27	#define _CHAINALLOC_H_
	28
	29	typedef int (group_search_t)(struct inode *,
	30	struct buffer_head *,
1187c968 JB	31	u32, /* bits_wanted */
	32	u32, /* min_bits */
	33	u64, /* max_block */
	34	u16 , / bit_off /
	35	u16 ); / bits_found /
ccd979bd MF	36
	37	struct ocfs2_alloc_context {
	38	struct inode ac_inode; / which bitmap are we allocating from? */
	39	struct buffer_head ac_bh; / file entry bh */
a4a48911	40	u32 ac_alloc_slot; /* which slot are we allocating from? */
ccd979bd MF	41	u32 ac_bits_wanted;
	42	u32 ac_bits_given;
	43	#define OCFS2_AC_USE_LOCAL 1
	44	#define OCFS2_AC_USE_MAIN 2
	45	#define OCFS2_AC_USE_INODE 3
	46	#define OCFS2_AC_USE_META 4
	47	u32 ac_which;
ccd979bd MF	48
	49	/* these are used by the chain search */
	50	u16 ac_chain;
	51	int ac_allow_chain_relink;
	52	group_search_t *ac_group_search;
883d4cae MF	53
883d4cae MF	54	u64 ac_last_group;
1187c968 JB	55	u64 ac_max_block; /* Highest block number to allocate. 0 is
1187c968 JB	56	is the same as ~0 - unlimited */
ccd979bd MF	57	};
ccd979bd MF	58
b89c5428	59	void ocfs2_init_steal_slots(struct ocfs2_super *osb);
ccd979bd MF	60	void ocfs2_free_alloc_context(struct ocfs2_alloc_context *ac);
	61	static inline int ocfs2_alloc_context_bits_left(struct ocfs2_alloc_context *ac)
	62	{
	63	return ac->ac_bits_wanted - ac->ac_bits_given;
	64	}
	65
811f933d TM	66	/*
	67	* Please note that the caller must make sure that root_el is the root
	68	* of extent tree. So for an inode, it should be &fe->id2.i_list. Otherwise
	69	* the result may be wrong.
	70	*/
ccd979bd	71	int ocfs2_reserve_new_metadata(struct ocfs2_super *osb,
811f933d	72	struct ocfs2_extent_list *root_el,
ccd979bd	73	struct ocfs2_alloc_context **ac);
cf1d6c76 TY	74	int ocfs2_reserve_new_metadata_blocks(struct ocfs2_super *osb,
	75	int blocks,
	76	struct ocfs2_alloc_context **ac);
ccd979bd	77	int ocfs2_reserve_new_inode(struct ocfs2_super *osb,
ccd979bd MF	78	struct ocfs2_alloc_context **ac);
ccd979bd MF	79	int ocfs2_reserve_clusters(struct ocfs2_super *osb,
ccd979bd MF	80	u32 bits_wanted,
	81	struct ocfs2_alloc_context **ac);
	82
	83	int ocfs2_claim_metadata(struct ocfs2_super *osb,
1fabe148	84	handle_t *handle,
ccd979bd MF	85	struct ocfs2_alloc_context *ac,
	86	u32 bits_wanted,
	87	u16 *suballoc_bit_start,
	88	u32 *num_bits,
	89	u64 *blkno_start);
	90	int ocfs2_claim_new_inode(struct ocfs2_super *osb,
1fabe148	91	handle_t *handle,
13821151 TM	92	struct inode *dir,
13821151 TM	93	struct buffer_head *parent_fe_bh,
ccd979bd MF	94	struct ocfs2_alloc_context *ac,
	95	u16 *suballoc_bit,
	96	u64 *fe_blkno);
	97	int ocfs2_claim_clusters(struct ocfs2_super *osb,
1fabe148	98	handle_t *handle,
ccd979bd MF	99	struct ocfs2_alloc_context *ac,
	100	u32 min_clusters,
	101	u32 *cluster_start,
	102	u32 *num_clusters);
415cb800 MF	103	/*
	104	* Use this variant of ocfs2_claim_clusters to specify a maxiumum
	105	* number of clusters smaller than the allocation reserved.
	106	*/
	107	int __ocfs2_claim_clusters(struct ocfs2_super *osb,
	108	handle_t *handle,
	109	struct ocfs2_alloc_context *ac,
	110	u32 min_clusters,
	111	u32 max_clusters,
	112	u32 *cluster_start,
	113	u32 *num_clusters);
ccd979bd	114
2b604351 MF	115	int ocfs2_free_suballoc_bits(handle_t *handle,
	116	struct inode *alloc_inode,
	117	struct buffer_head *alloc_bh,
	118	unsigned int start_bit,
	119	u64 bg_blkno,
	120	unsigned int count);
1fabe148	121	int ocfs2_free_dinode(handle_t *handle,
ccd979bd MF	122	struct inode *inode_alloc_inode,
	123	struct buffer_head *inode_alloc_bh,
	124	struct ocfs2_dinode *di);
1fabe148	125	int ocfs2_free_clusters(handle_t *handle,
ccd979bd MF	126	struct inode *bitmap_inode,
	127	struct buffer_head *bitmap_bh,
	128	u64 start_blk,
	129	unsigned int num_clusters);
	130
2b604351 MF	131	static inline u64 ocfs2_which_suballoc_group(u64 block, unsigned int bit)
	132	{
	133	u64 group = block - (u64) bit;
	134
	135	return group;
	136	}
	137
ccd979bd MF	138	static inline u32 ocfs2_cluster_from_desc(struct ocfs2_super *osb,
	139	u64 bg_blkno)
	140	{
	141	/* This should work for all block group descriptors as only
	142	* the 1st group descriptor of the cluster bitmap is
	143	* different. */
	144
	145	if (bg_blkno == osb->first_cluster_group_blkno)
	146	return 0;
	147
	148	/* the rest of the block groups are located at the beginning
	149	* of their 1st cluster, so a direct translation just
	150	* works. */
	151	return ocfs2_blocks_to_clusters(osb->sb, bg_blkno);
	152	}
	153
	154	static inline int ocfs2_is_cluster_bitmap(struct inode *inode)
	155	{
	156	struct ocfs2_super *osb = OCFS2_SB(inode->i_sb);
	157	return osb->bitmap_blkno == OCFS2_I(inode)->ip_blkno;
	158	}
	159
	160	/* This is for local alloc ONLY. Others should use the task-specific
	161	* apis above. */
	162	int ocfs2_reserve_cluster_bitmap_bits(struct ocfs2_super *osb,
	163	struct ocfs2_alloc_context *ac);
9c7af40b	164	void ocfs2_free_ac_resource(struct ocfs2_alloc_context *ac);
ccd979bd	165
d659072f TM	166	/* given a cluster offset, calculate which block group it belongs to
	167	* and return that block offset. */
	168	u64 ocfs2_which_cluster_group(struct inode *inode, u32 cluster);
	169
57e3e797	170	/*
970e4936	171	* By default, ocfs2_read_group_descriptor() calls ocfs2_error() when it
57e3e797	172	* finds a problem. A caller that wants to check a group descriptor
970e4936 JB	173	* without going readonly should read the block with ocfs2_read_block[s]()
	174	* and then checking it with this function. This is only resize, really.
	175	* Everyone else should be using ocfs2_read_group_descriptor().
57e3e797	176	*/
970e4936 JB	177	int ocfs2_check_group_descriptor(struct super_block *sb,
	178	struct ocfs2_dinode *di,
	179	struct buffer_head *bh);
68f64d47 JB	180	/*
	181	* Read a group descriptor block into bh. If bh is NULL, a bh will be
	182	* allocated. This is a cached read. The descriptor will be validated with
	183	* ocfs2_validate_group_descriptor().
	184	*/
	185	int ocfs2_read_group_descriptor(struct inode inode, struct ocfs2_dinode di,
	186	u64 gd_blkno, struct buffer_head **bh);
57e3e797	187
f99b9b7c	188	int ocfs2_lock_allocators(struct inode inode, struct ocfs2_extent_tree et,
e7d4cb6b TM	189	u32 clusters_to_add, u32 extents_to_split,
e7d4cb6b TM	190	struct ocfs2_alloc_context **data_ac,
f99b9b7c	191	struct ocfs2_alloc_context **meta_ac);
6ca497a8	192
6ca497a8	193	int ocfs2_test_inode_bit(struct ocfs2_super osb, u64 blkno, int res);
ccd979bd	194	#endif /* _CHAINALLOC_H_ */