[linux-2.6-block.git] / fs / ocfs2 / alloc.h

/* -*- mode: c; c-basic-offset: 8; -*-
 * vim: noexpandtab sw=8 ts=8 sts=0:
 *
 * alloc.h
 *
 * Function prototypes
 *
 * Copyright (C) 2002, 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 OCFS2_ALLOC_H
#define OCFS2_ALLOC_H

enum ocfs2_extent_tree_type {
	OCFS2_DINODE_EXTENT = 0,
};

struct ocfs2_alloc_context;
int ocfs2_insert_extent(struct ocfs2_super *osb,
			handle_t *handle,
			struct inode *inode,
			struct buffer_head *root_bh,
			u32 cpos,
			u64 start_blk,
			u32 new_clusters,
			u8 flags,
			struct ocfs2_alloc_context *meta_ac,
			enum ocfs2_extent_tree_type et_type);
struct ocfs2_cached_dealloc_ctxt;
int ocfs2_mark_extent_written(struct inode *inode, struct buffer_head *root_bh,
			      handle_t *handle, u32 cpos, u32 len, u32 phys,
			      struct ocfs2_alloc_context *meta_ac,
			      struct ocfs2_cached_dealloc_ctxt *dealloc,
			      enum ocfs2_extent_tree_type et_type);
int ocfs2_remove_extent(struct inode *inode, struct buffer_head *root_bh,
			u32 cpos, u32 len, handle_t *handle,
			struct ocfs2_alloc_context *meta_ac,
			struct ocfs2_cached_dealloc_ctxt *dealloc,
			enum ocfs2_extent_tree_type et_type);
int ocfs2_num_free_extents(struct ocfs2_super *osb,
			   struct inode *inode,
			   struct buffer_head *root_bh,
			   enum ocfs2_extent_tree_type et_type);

/*
 * how many new metadata chunks would an allocation need at maximum?
 *
 * 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.
 */
static inline int ocfs2_extend_meta_needed(struct ocfs2_extent_list *root_el)
{
	/*
	 * Rather than do all the work of determining how much we need
	 * (involves a ton of reads and locks), just ask for the
	 * maximal limit.  That's a tree depth shift.  So, one block for
	 * level of the tree (current l_tree_depth), one block for the
	 * new tree_depth==0 extent_block, and one block at the new
	 * top-of-the tree.
	 */
	return le16_to_cpu(root_el->l_tree_depth) + 2;
}

void ocfs2_dinode_new_extent_list(struct inode *inode, struct ocfs2_dinode *di);
void ocfs2_set_inode_data_inline(struct inode *inode, struct ocfs2_dinode *di);
int ocfs2_convert_inline_data_to_extents(struct inode *inode,
					 struct buffer_head *di_bh);

int ocfs2_truncate_log_init(struct ocfs2_super *osb);
void ocfs2_truncate_log_shutdown(struct ocfs2_super *osb);
void ocfs2_schedule_truncate_log_flush(struct ocfs2_super *osb,
				       int cancel);
int ocfs2_flush_truncate_log(struct ocfs2_super *osb);
int ocfs2_begin_truncate_log_recovery(struct ocfs2_super *osb,
				      int slot_num,
				      struct ocfs2_dinode **tl_copy);
int ocfs2_complete_truncate_log_recovery(struct ocfs2_super *osb,
					 struct ocfs2_dinode *tl_copy);
int ocfs2_truncate_log_needs_flush(struct ocfs2_super *osb);
int ocfs2_truncate_log_append(struct ocfs2_super *osb,
			      handle_t *handle,
			      u64 start_blk,
			      unsigned int num_clusters);
int __ocfs2_flush_truncate_log(struct ocfs2_super *osb);

/*
 * Process local structure which describes the block unlinks done
 * during an operation. This is populated via
 * ocfs2_cache_block_dealloc().
 *
 * ocfs2_run_deallocs() should be called after the potentially
 * de-allocating routines. No journal handles should be open, and most
 * locks should have been dropped.
 */
struct ocfs2_cached_dealloc_ctxt {
	struct ocfs2_per_slot_free_list		*c_first_suballocator;
};
static inline void ocfs2_init_dealloc_ctxt(struct ocfs2_cached_dealloc_ctxt *c)
{
	c->c_first_suballocator = NULL;
}
int ocfs2_run_deallocs(struct ocfs2_super *osb,
		       struct ocfs2_cached_dealloc_ctxt *ctxt);

struct ocfs2_truncate_context {
	struct ocfs2_cached_dealloc_ctxt tc_dealloc;
	int tc_ext_alloc_locked; /* is it cluster locked? */
	/* these get destroyed once it's passed to ocfs2_commit_truncate. */
	struct buffer_head *tc_last_eb_bh;
};

int ocfs2_zero_range_for_truncate(struct inode *inode, handle_t *handle,
				  u64 range_start, u64 range_end);
int ocfs2_prepare_truncate(struct ocfs2_super *osb,
			   struct inode *inode,
			   struct buffer_head *fe_bh,
			   struct ocfs2_truncate_context **tc);
int ocfs2_commit_truncate(struct ocfs2_super *osb,
			  struct inode *inode,
			  struct buffer_head *fe_bh,
			  struct ocfs2_truncate_context *tc);
int ocfs2_truncate_inline(struct inode *inode, struct buffer_head *di_bh,
			  unsigned int start, unsigned int end, int trunc);

int ocfs2_find_leaf(struct inode *inode, struct ocfs2_extent_list *root_el,
		    u32 cpos, struct buffer_head **leaf_bh);
int ocfs2_search_extent_list(struct ocfs2_extent_list *el, u32 v_cluster);

/*
 * Helper function to look at the # of clusters in an extent record.
 */
static inline unsigned int ocfs2_rec_clusters(struct ocfs2_extent_list *el,
					      struct ocfs2_extent_rec *rec)
{
	/*
	 * Cluster count in extent records is slightly different
	 * between interior nodes and leaf nodes. This is to support
	 * unwritten extents which need a flags field in leaf node
	 * records, thus shrinking the available space for a clusters
	 * field.
	 */
	if (el->l_tree_depth)
		return le32_to_cpu(rec->e_int_clusters);
	else
		return le16_to_cpu(rec->e_leaf_clusters);
}

/*
 * This is only valid for leaf nodes, which are the only ones that can
 * have empty extents anyway.
 */
static inline int ocfs2_is_empty_extent(struct ocfs2_extent_rec *rec)
{
	return !rec->e_leaf_clusters;
}

#endif /* OCFS2_ALLOC_H */
Commit	Line	Data
ccd979bd MF	1	/* -- mode: c; c-basic-offset: 8; --
	2	* vim: noexpandtab sw=8 ts=8 sts=0:
	3	*
	4	* alloc.h
	5	*
	6	* Function prototypes
	7	*
	8	* Copyright (C) 2002, 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 OCFS2_ALLOC_H
	27	#define OCFS2_ALLOC_H
	28
e7d4cb6b TM	29	enum ocfs2_extent_tree_type {
	30	OCFS2_DINODE_EXTENT = 0,
	31	};
	32
ccd979bd MF	33	struct ocfs2_alloc_context;
ccd979bd MF	34	int ocfs2_insert_extent(struct ocfs2_super *osb,
1fabe148	35	handle_t *handle,
ccd979bd	36	struct inode *inode,
e7d4cb6b	37	struct buffer_head *root_bh,
dcd0538f MF	38	u32 cpos,
dcd0538f MF	39	u64 start_blk,
ccd979bd	40	u32 new_clusters,
2ae99a60	41	u8 flags,
e7d4cb6b TM	42	struct ocfs2_alloc_context *meta_ac,
e7d4cb6b TM	43	enum ocfs2_extent_tree_type et_type);
328d5752	44	struct ocfs2_cached_dealloc_ctxt;
e7d4cb6b	45	int ocfs2_mark_extent_written(struct inode inode, struct buffer_head root_bh,
328d5752 MF	46	handle_t *handle, u32 cpos, u32 len, u32 phys,
328d5752 MF	47	struct ocfs2_alloc_context *meta_ac,
e7d4cb6b TM	48	struct ocfs2_cached_dealloc_ctxt *dealloc,
	49	enum ocfs2_extent_tree_type et_type);
	50	int ocfs2_remove_extent(struct inode inode, struct buffer_head root_bh,
063c4561 MF	51	u32 cpos, u32 len, handle_t *handle,
063c4561 MF	52	struct ocfs2_alloc_context *meta_ac,
e7d4cb6b TM	53	struct ocfs2_cached_dealloc_ctxt *dealloc,
e7d4cb6b TM	54	enum ocfs2_extent_tree_type et_type);
ccd979bd MF	55	int ocfs2_num_free_extents(struct ocfs2_super *osb,
ccd979bd MF	56	struct inode *inode,
e7d4cb6b TM	57	struct buffer_head *root_bh,
	58	enum ocfs2_extent_tree_type et_type);
	59
811f933d TM	60	/*
	61	* how many new metadata chunks would an allocation need at maximum?
	62	*
	63	* Please note that the caller must make sure that root_el is the root
	64	* of extent tree. So for an inode, it should be &fe->id2.i_list. Otherwise
	65	* the result may be wrong.
	66	*/
	67	static inline int ocfs2_extend_meta_needed(struct ocfs2_extent_list *root_el)
ccd979bd MF	68	{
	69	/*
	70	* Rather than do all the work of determining how much we need
	71	* (involves a ton of reads and locks), just ask for the
	72	* maximal limit. That's a tree depth shift. So, one block for
	73	* level of the tree (current l_tree_depth), one block for the
	74	* new tree_depth==0 extent_block, and one block at the new
	75	* top-of-the tree.
	76	*/
811f933d	77	return le16_to_cpu(root_el->l_tree_depth) + 2;
ccd979bd MF	78	}
ccd979bd MF	79
5b6a3a2b	80	void ocfs2_dinode_new_extent_list(struct inode inode, struct ocfs2_dinode di);
1afc32b9 MF	81	void ocfs2_set_inode_data_inline(struct inode inode, struct ocfs2_dinode di);
	82	int ocfs2_convert_inline_data_to_extents(struct inode *inode,
	83	struct buffer_head *di_bh);
	84
ccd979bd MF	85	int ocfs2_truncate_log_init(struct ocfs2_super *osb);
	86	void ocfs2_truncate_log_shutdown(struct ocfs2_super *osb);
	87	void ocfs2_schedule_truncate_log_flush(struct ocfs2_super *osb,
	88	int cancel);
	89	int ocfs2_flush_truncate_log(struct ocfs2_super *osb);
	90	int ocfs2_begin_truncate_log_recovery(struct ocfs2_super *osb,
	91	int slot_num,
	92	struct ocfs2_dinode **tl_copy);
	93	int ocfs2_complete_truncate_log_recovery(struct ocfs2_super *osb,
	94	struct ocfs2_dinode *tl_copy);
063c4561 MF	95	int ocfs2_truncate_log_needs_flush(struct ocfs2_super *osb);
	96	int ocfs2_truncate_log_append(struct ocfs2_super *osb,
	97	handle_t *handle,
	98	u64 start_blk,
	99	unsigned int num_clusters);
	100	int __ocfs2_flush_truncate_log(struct ocfs2_super *osb);
ccd979bd	101
2b604351 MF	102	/*
	103	* Process local structure which describes the block unlinks done
	104	* during an operation. This is populated via
	105	* ocfs2_cache_block_dealloc().
	106	*
	107	* ocfs2_run_deallocs() should be called after the potentially
	108	* de-allocating routines. No journal handles should be open, and most
	109	* locks should have been dropped.
	110	*/
	111	struct ocfs2_cached_dealloc_ctxt {
	112	struct ocfs2_per_slot_free_list *c_first_suballocator;
	113	};
	114	static inline void ocfs2_init_dealloc_ctxt(struct ocfs2_cached_dealloc_ctxt *c)
	115	{
	116	c->c_first_suballocator = NULL;
	117	}
	118	int ocfs2_run_deallocs(struct ocfs2_super *osb,
	119	struct ocfs2_cached_dealloc_ctxt *ctxt);
	120
ccd979bd	121	struct ocfs2_truncate_context {
59a5e416	122	struct ocfs2_cached_dealloc_ctxt tc_dealloc;
ccd979bd MF	123	int tc_ext_alloc_locked; /* is it cluster locked? */
	124	/* these get destroyed once it's passed to ocfs2_commit_truncate. */
	125	struct buffer_head *tc_last_eb_bh;
	126	};
	127
35edec1d MF	128	int ocfs2_zero_range_for_truncate(struct inode inode, handle_t handle,
35edec1d MF	129	u64 range_start, u64 range_end);
ccd979bd MF	130	int ocfs2_prepare_truncate(struct ocfs2_super *osb,
	131	struct inode *inode,
	132	struct buffer_head *fe_bh,
	133	struct ocfs2_truncate_context **tc);
	134	int ocfs2_commit_truncate(struct ocfs2_super *osb,
	135	struct inode *inode,
	136	struct buffer_head *fe_bh,
	137	struct ocfs2_truncate_context *tc);
1afc32b9 MF	138	int ocfs2_truncate_inline(struct inode inode, struct buffer_head di_bh,
1afc32b9 MF	139	unsigned int start, unsigned int end, int trunc);
ccd979bd	140
363041a5 MF	141	int ocfs2_find_leaf(struct inode inode, struct ocfs2_extent_list root_el,
363041a5 MF	142	u32 cpos, struct buffer_head **leaf_bh);
328d5752	143	int ocfs2_search_extent_list(struct ocfs2_extent_list *el, u32 v_cluster);
363041a5	144
e48edee2 MF	145	/*
	146	* Helper function to look at the # of clusters in an extent record.
	147	*/
	148	static inline unsigned int ocfs2_rec_clusters(struct ocfs2_extent_list *el,
	149	struct ocfs2_extent_rec *rec)
	150	{
	151	/*
	152	* Cluster count in extent records is slightly different
	153	* between interior nodes and leaf nodes. This is to support
	154	* unwritten extents which need a flags field in leaf node
	155	* records, thus shrinking the available space for a clusters
	156	* field.
	157	*/
	158	if (el->l_tree_depth)
	159	return le32_to_cpu(rec->e_int_clusters);
	160	else
	161	return le16_to_cpu(rec->e_leaf_clusters);
	162	}
	163
00dc417f MF	164	/*
	165	* This is only valid for leaf nodes, which are the only ones that can
	166	* have empty extents anyway.
	167	*/
	168	static inline int ocfs2_is_empty_extent(struct ocfs2_extent_rec *rec)
	169	{
	170	return !rec->e_leaf_clusters;
	171	}
	172
ccd979bd	173	#endif /* OCFS2_ALLOC_H */