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