[deliverable/linux.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,
	OCFS2_XATTR_VALUE_EXTENT,
	OCFS2_XATTR_TREE_EXTENT,
};

struct ocfs2_alloc_context;
int ocfs2_dinode_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);
int ocfs2_xattr_value_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,
				    void *private);
int ocfs2_xattr_tree_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_alloc_restarted {
	RESTART_NONE = 0,
	RESTART_TRANS,
	RESTART_META
};
int ocfs2_add_clusters_in_btree(struct ocfs2_super *osb,
				struct inode *inode,
				u32 *logical_offset,
				u32 clusters_to_add,
				int mark_unwritten,
				struct buffer_head *root_bh,
				struct ocfs2_extent_list *root_el,
				handle_t *handle,
				struct ocfs2_alloc_context *data_ac,
				struct ocfs2_alloc_context *meta_ac,
				enum ocfs2_alloc_restarted *reason_ret,
				enum ocfs2_extent_tree_type type,
				void *private);
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,
			      void *private);
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,
			void *private);
int ocfs2_num_free_extents(struct ocfs2_super *osb,
			   struct inode *inode,
			   struct buffer_head *root_bh,
			   enum ocfs2_extent_tree_type et_type,
			   void *private);

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