[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

struct ocfs2_alloc_context;
int ocfs2_insert_extent(struct ocfs2_super *osb,
			handle_t *handle,
			struct inode *inode,
			struct buffer_head *fe_bh,
			u32 cpos,
			u64 start_blk,
			u32 new_clusters,
			u8 flags,
			struct ocfs2_alloc_context *meta_ac);
struct ocfs2_cached_dealloc_ctxt;
int ocfs2_mark_extent_written(struct inode *inode, struct buffer_head *di_bh,
			      handle_t *handle, u32 cpos, u32 len, u32 phys,
			      struct ocfs2_alloc_context *meta_ac,
			      struct ocfs2_cached_dealloc_ctxt *dealloc);
int ocfs2_remove_extent(struct inode *inode, struct buffer_head *di_bh,
			u32 cpos, u32 len, handle_t *handle,
			struct ocfs2_alloc_context *meta_ac,
			struct ocfs2_cached_dealloc_ctxt *dealloc);
int ocfs2_num_free_extents(struct ocfs2_super *osb,
			   struct inode *inode,
			   struct ocfs2_dinode *fe);
/* how many new metadata chunks would an allocation need at maximum? */
static inline int ocfs2_extend_meta_needed(struct ocfs2_dinode *fe)
{
	/*
	 * 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(fe->id2.i_list.l_tree_depth) + 2;
}

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_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);
}

#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
	29	struct ocfs2_alloc_context;
	30	int ocfs2_insert_extent(struct ocfs2_super *osb,
1fabe148	31	handle_t *handle,
ccd979bd MF	32	struct inode *inode,
ccd979bd MF	33	struct buffer_head *fe_bh,
dcd0538f MF	34	u32 cpos,
dcd0538f MF	35	u64 start_blk,
ccd979bd	36	u32 new_clusters,
2ae99a60	37	u8 flags,
ccd979bd	38	struct ocfs2_alloc_context *meta_ac);
328d5752 MF	39	struct ocfs2_cached_dealloc_ctxt;
	40	int ocfs2_mark_extent_written(struct inode inode, struct buffer_head di_bh,
	41	handle_t *handle, u32 cpos, u32 len, u32 phys,
	42	struct ocfs2_alloc_context *meta_ac,
	43	struct ocfs2_cached_dealloc_ctxt *dealloc);
063c4561 MF	44	int ocfs2_remove_extent(struct inode inode, struct buffer_head di_bh,
	45	u32 cpos, u32 len, handle_t *handle,
	46	struct ocfs2_alloc_context *meta_ac,
	47	struct ocfs2_cached_dealloc_ctxt *dealloc);
ccd979bd MF	48	int ocfs2_num_free_extents(struct ocfs2_super *osb,
	49	struct inode *inode,
	50	struct ocfs2_dinode *fe);
	51	/* how many new metadata chunks would an allocation need at maximum? */
	52	static inline int ocfs2_extend_meta_needed(struct ocfs2_dinode *fe)
	53	{
	54	/*
	55	* Rather than do all the work of determining how much we need
	56	* (involves a ton of reads and locks), just ask for the
	57	* maximal limit. That's a tree depth shift. So, one block for
	58	* level of the tree (current l_tree_depth), one block for the
	59	* new tree_depth==0 extent_block, and one block at the new
	60	* top-of-the tree.
	61	*/
	62	return le16_to_cpu(fe->id2.i_list.l_tree_depth) + 2;
	63	}
	64
	65	int ocfs2_truncate_log_init(struct ocfs2_super *osb);
	66	void ocfs2_truncate_log_shutdown(struct ocfs2_super *osb);
	67	void ocfs2_schedule_truncate_log_flush(struct ocfs2_super *osb,
	68	int cancel);
	69	int ocfs2_flush_truncate_log(struct ocfs2_super *osb);
	70	int ocfs2_begin_truncate_log_recovery(struct ocfs2_super *osb,
	71	int slot_num,
	72	struct ocfs2_dinode **tl_copy);
	73	int ocfs2_complete_truncate_log_recovery(struct ocfs2_super *osb,
	74	struct ocfs2_dinode *tl_copy);
063c4561 MF	75	int ocfs2_truncate_log_needs_flush(struct ocfs2_super *osb);
	76	int ocfs2_truncate_log_append(struct ocfs2_super *osb,
	77	handle_t *handle,
	78	u64 start_blk,
	79	unsigned int num_clusters);
	80	int __ocfs2_flush_truncate_log(struct ocfs2_super *osb);
ccd979bd	81
2b604351 MF	82	/*
	83	* Process local structure which describes the block unlinks done
	84	* during an operation. This is populated via
	85	* ocfs2_cache_block_dealloc().
	86	*
	87	* ocfs2_run_deallocs() should be called after the potentially
	88	* de-allocating routines. No journal handles should be open, and most
	89	* locks should have been dropped.
	90	*/
	91	struct ocfs2_cached_dealloc_ctxt {
	92	struct ocfs2_per_slot_free_list *c_first_suballocator;
	93	};
	94	static inline void ocfs2_init_dealloc_ctxt(struct ocfs2_cached_dealloc_ctxt *c)
	95	{
	96	c->c_first_suballocator = NULL;
	97	}
	98	int ocfs2_run_deallocs(struct ocfs2_super *osb,
	99	struct ocfs2_cached_dealloc_ctxt *ctxt);
	100
ccd979bd	101	struct ocfs2_truncate_context {
59a5e416	102	struct ocfs2_cached_dealloc_ctxt tc_dealloc;
ccd979bd MF	103	int tc_ext_alloc_locked; /* is it cluster locked? */
	104	/* these get destroyed once it's passed to ocfs2_commit_truncate. */
	105	struct buffer_head *tc_last_eb_bh;
	106	};
	107
35edec1d MF	108	int ocfs2_zero_range_for_truncate(struct inode inode, handle_t handle,
35edec1d MF	109	u64 range_start, u64 range_end);
ccd979bd MF	110	int ocfs2_prepare_truncate(struct ocfs2_super *osb,
	111	struct inode *inode,
	112	struct buffer_head *fe_bh,
	113	struct ocfs2_truncate_context **tc);
	114	int ocfs2_commit_truncate(struct ocfs2_super *osb,
	115	struct inode *inode,
	116	struct buffer_head *fe_bh,
	117	struct ocfs2_truncate_context *tc);
	118
363041a5 MF	119	int ocfs2_find_leaf(struct inode inode, struct ocfs2_extent_list root_el,
363041a5 MF	120	u32 cpos, struct buffer_head **leaf_bh);
328d5752	121	int ocfs2_search_extent_list(struct ocfs2_extent_list *el, u32 v_cluster);
363041a5	122
e48edee2 MF	123	/*
	124	* Helper function to look at the # of clusters in an extent record.
	125	*/
	126	static inline unsigned int ocfs2_rec_clusters(struct ocfs2_extent_list *el,
	127	struct ocfs2_extent_rec *rec)
	128	{
	129	/*
	130	* Cluster count in extent records is slightly different
	131	* between interior nodes and leaf nodes. This is to support
	132	* unwritten extents which need a flags field in leaf node
	133	* records, thus shrinking the available space for a clusters
	134	* field.
	135	*/
	136	if (el->l_tree_depth)
	137	return le32_to_cpu(rec->e_int_clusters);
	138	else
	139	return le16_to_cpu(rec->e_leaf_clusters);
	140	}
	141
ccd979bd	142	#endif /* OCFS2_ALLOC_H */