xref: /linux/fs/ocfs2/journal.h (revision d6a5c562214f26e442c8ec3ff1e28e16675d1bcf)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * journal.h
4  *
5  * Defines journalling api and structures.
6  *
7  * Copyright (C) 2003, 2005 Oracle.  All rights reserved.
8  */
9 
10 #ifndef OCFS2_JOURNAL_H
11 #define OCFS2_JOURNAL_H
12 
13 #include <linux/fs.h>
14 #include <linux/jbd2.h>
15 
16 enum ocfs2_journal_state {
17 	OCFS2_JOURNAL_FREE = 0,
18 	OCFS2_JOURNAL_LOADED,
19 	OCFS2_JOURNAL_IN_SHUTDOWN,
20 };
21 
22 struct ocfs2_super;
23 struct ocfs2_dinode;
24 
25 /*
26  * The recovery_list is a simple linked list of node numbers to recover.
27  * It is protected by the recovery_lock.
28  */
29 
30 struct ocfs2_recovery_map {
31 	unsigned int rm_used;
32 	unsigned int *rm_entries;
33 };
34 
35 
36 struct ocfs2_journal {
37 	enum ocfs2_journal_state   j_state;    /* Journals current state   */
38 
39 	journal_t                 *j_journal; /* The kernels journal type */
40 	struct inode              *j_inode;   /* Kernel inode pointing to
41 					       * this journal             */
42 	struct ocfs2_super        *j_osb;     /* pointer to the super
43 					       * block for the node
44 					       * we're currently
45 					       * running on -- not
46 					       * necessarily the super
47 					       * block from the node
48 					       * which we usually run
49 					       * from (recovery,
50 					       * etc)                     */
51 	struct buffer_head        *j_bh;      /* Journal disk inode block */
52 	atomic_t                  j_num_trans; /* Number of transactions
53 					        * currently in the system. */
54 	spinlock_t                j_lock;
55 	unsigned long             j_trans_id;
56 	struct rw_semaphore       j_trans_barrier;
57 	wait_queue_head_t         j_checkpointed;
58 
59 	/* both fields protected by j_lock*/
60 	struct list_head          j_la_cleanups;
61 	struct work_struct        j_recovery_work;
62 };
63 
64 extern spinlock_t trans_inc_lock;
65 
66 /* wrap j_trans_id so we never have it equal to zero. */
67 static inline unsigned long ocfs2_inc_trans_id(struct ocfs2_journal *j)
68 {
69 	unsigned long old_id;
70 	spin_lock(&trans_inc_lock);
71 	old_id = j->j_trans_id++;
72 	if (unlikely(!j->j_trans_id))
73 		j->j_trans_id = 1;
74 	spin_unlock(&trans_inc_lock);
75 	return old_id;
76 }
77 
78 static inline void ocfs2_set_ci_lock_trans(struct ocfs2_journal *journal,
79 					   struct ocfs2_caching_info *ci)
80 {
81 	spin_lock(&trans_inc_lock);
82 	ci->ci_last_trans = journal->j_trans_id;
83 	spin_unlock(&trans_inc_lock);
84 }
85 
86 /* Used to figure out whether it's safe to drop a metadata lock on an
87  * cached object. Returns true if all the object's changes have been
88  * checkpointed to disk. You should be holding the spinlock on the
89  * metadata lock while calling this to be sure that nobody can take
90  * the lock and put it on another transaction. */
91 static inline int ocfs2_ci_fully_checkpointed(struct ocfs2_caching_info *ci)
92 {
93 	int ret;
94 	struct ocfs2_journal *journal =
95 		OCFS2_SB(ocfs2_metadata_cache_get_super(ci))->journal;
96 
97 	spin_lock(&trans_inc_lock);
98 	ret = time_after(journal->j_trans_id, ci->ci_last_trans);
99 	spin_unlock(&trans_inc_lock);
100 	return ret;
101 }
102 
103 /* convenience function to check if an object backed by struct
104  * ocfs2_caching_info  is still new (has never hit disk) Will do you a
105  * favor and set created_trans = 0 when you've
106  * been checkpointed.  returns '1' if the ci is still new. */
107 static inline int ocfs2_ci_is_new(struct ocfs2_caching_info *ci)
108 {
109 	int ret;
110 	struct ocfs2_journal *journal =
111 		OCFS2_SB(ocfs2_metadata_cache_get_super(ci))->journal;
112 
113 	spin_lock(&trans_inc_lock);
114 	ret = !(time_after(journal->j_trans_id, ci->ci_created_trans));
115 	if (!ret)
116 		ci->ci_created_trans = 0;
117 	spin_unlock(&trans_inc_lock);
118 	return ret;
119 }
120 
121 /* Wrapper for inodes so we can check system files */
122 static inline int ocfs2_inode_is_new(struct inode *inode)
123 {
124 	/* System files are never "new" as they're written out by
125 	 * mkfs. This helps us early during mount, before we have the
126 	 * journal open and j_trans_id could be junk. */
127 	if (OCFS2_I(inode)->ip_flags & OCFS2_INODE_SYSTEM_FILE)
128 		return 0;
129 
130 	return ocfs2_ci_is_new(INODE_CACHE(inode));
131 }
132 
133 static inline void ocfs2_ci_set_new(struct ocfs2_super *osb,
134 				    struct ocfs2_caching_info *ci)
135 {
136 	spin_lock(&trans_inc_lock);
137 	ci->ci_created_trans = osb->journal->j_trans_id;
138 	spin_unlock(&trans_inc_lock);
139 }
140 
141 /* Exported only for the journal struct init code in super.c. Do not call. */
142 void ocfs2_orphan_scan_init(struct ocfs2_super *osb);
143 void ocfs2_orphan_scan_start(struct ocfs2_super *osb);
144 void ocfs2_orphan_scan_stop(struct ocfs2_super *osb);
145 
146 void ocfs2_complete_recovery(struct work_struct *work);
147 void ocfs2_wait_for_recovery(struct ocfs2_super *osb);
148 
149 int ocfs2_recovery_init(struct ocfs2_super *osb);
150 void ocfs2_recovery_exit(struct ocfs2_super *osb);
151 
152 int ocfs2_compute_replay_slots(struct ocfs2_super *osb);
153 /*
154  *  Journal Control:
155  *  Initialize, Load, Shutdown, Wipe a journal.
156  *
157  *  ocfs2_journal_alloc    - Initialize skeleton for journal structure.
158  *  ocfs2_journal_init     - Initialize journal structures in the OSB.
159  *  ocfs2_journal_load     - Load the given journal off disk. Replay it if
160  *                          there's transactions still in there.
161  *  ocfs2_journal_shutdown - Shutdown a journal, this will flush all
162  *                          uncommitted, uncheckpointed transactions.
163  *  ocfs2_journal_wipe     - Wipe transactions from a journal. Optionally
164  *                          zero out each block.
165  *  ocfs2_recovery_thread  - Perform recovery on a node. osb is our own osb.
166  *  ocfs2_mark_dead_nodes - Start recovery on nodes we won't get a heartbeat
167  *                          event on.
168  *  ocfs2_start_checkpoint - Kick the commit thread to do a checkpoint.
169  */
170 void   ocfs2_set_journal_params(struct ocfs2_super *osb);
171 int    ocfs2_journal_alloc(struct ocfs2_super *osb);
172 int    ocfs2_journal_init(struct ocfs2_super *osb, int *dirty);
173 void   ocfs2_journal_shutdown(struct ocfs2_super *osb);
174 int    ocfs2_journal_wipe(struct ocfs2_journal *journal,
175 			  int full);
176 int    ocfs2_journal_load(struct ocfs2_journal *journal, int local,
177 			  int replayed);
178 int    ocfs2_check_journals_nolocks(struct ocfs2_super *osb);
179 void   ocfs2_recovery_thread(struct ocfs2_super *osb,
180 			     int node_num);
181 int    ocfs2_mark_dead_nodes(struct ocfs2_super *osb);
182 void   ocfs2_complete_mount_recovery(struct ocfs2_super *osb);
183 void ocfs2_complete_quota_recovery(struct ocfs2_super *osb);
184 
185 static inline void ocfs2_start_checkpoint(struct ocfs2_super *osb)
186 {
187 	wake_up(&osb->checkpoint_event);
188 }
189 
190 static inline void ocfs2_checkpoint_inode(struct inode *inode)
191 {
192 	struct ocfs2_super *osb = OCFS2_SB(inode->i_sb);
193 
194 	if (ocfs2_mount_local(osb))
195 		return;
196 
197 	if (!ocfs2_ci_fully_checkpointed(INODE_CACHE(inode))) {
198 		/* WARNING: This only kicks off a single
199 		 * checkpoint. If someone races you and adds more
200 		 * metadata to the journal, you won't know, and will
201 		 * wind up waiting *a lot* longer than necessary. Right
202 		 * now we only use this in clear_inode so that's
203 		 * OK. */
204 		ocfs2_start_checkpoint(osb);
205 
206 		wait_event(osb->journal->j_checkpointed,
207 			   ocfs2_ci_fully_checkpointed(INODE_CACHE(inode)));
208 	}
209 }
210 
211 /*
212  *  Transaction Handling:
213  *  Manage the lifetime of a transaction handle.
214  *
215  *  ocfs2_start_trans      - Begin a transaction. Give it an upper estimate of
216  *                          the number of blocks that will be changed during
217  *                          this handle.
218  *  ocfs2_commit_trans - Complete a handle. It might return -EIO if
219  *                       the journal was aborted. The majority of paths don't
220  *                       check the return value as an error there comes too
221  *                       late to do anything (and will be picked up in a
222  *                       later transaction).
223  *  ocfs2_extend_trans     - Extend a handle by nblocks credits. This may
224  *                          commit the handle to disk in the process, but will
225  *                          not release any locks taken during the transaction.
226  *  ocfs2_journal_access* - Notify the handle that we want to journal this
227  *                          buffer. Will have to call ocfs2_journal_dirty once
228  *                          we've actually dirtied it. Type is one of . or .
229  *                          Always call the specific flavor of
230  *                          ocfs2_journal_access_*() unless you intend to
231  *                          manage the checksum by hand.
232  *  ocfs2_journal_dirty    - Mark a journalled buffer as having dirty data.
233  *  ocfs2_jbd2_inode_add_write  - Mark an inode with range so that its data goes
234  *                                out before the current handle commits.
235  */
236 
237 /* You must always start_trans with a number of buffs > 0, but it's
238  * perfectly legal to go through an entire transaction without having
239  * dirtied any buffers. */
240 handle_t		    *ocfs2_start_trans(struct ocfs2_super *osb,
241 					       int max_buffs);
242 int			     ocfs2_commit_trans(struct ocfs2_super *osb,
243 						handle_t *handle);
244 int			     ocfs2_extend_trans(handle_t *handle, int nblocks);
245 int			     ocfs2_allocate_extend_trans(handle_t *handle,
246 						int thresh);
247 
248 /*
249  * Define an arbitrary limit for the amount of data we will anticipate
250  * writing to any given transaction.  For unbounded transactions such as
251  * fallocate(2) we can write more than this, but we always
252  * start off at the maximum transaction size and grow the transaction
253  * optimistically as we go.
254  */
255 #define OCFS2_MAX_TRANS_DATA	64U
256 
257 /*
258  * Create access is for when we get a newly created buffer and we're
259  * not gonna read it off disk, but rather fill it ourselves.  Right
260  * now, we don't do anything special with this (it turns into a write
261  * request), but this is a good placeholder in case we do...
262  *
263  * Write access is for when we read a block off disk and are going to
264  * modify it. This way the journalling layer knows it may need to make
265  * a copy of that block (if it's part of another, uncommitted
266  * transaction) before we do so.
267  */
268 #define OCFS2_JOURNAL_ACCESS_CREATE 0
269 #define OCFS2_JOURNAL_ACCESS_WRITE  1
270 #define OCFS2_JOURNAL_ACCESS_UNDO   2
271 
272 
273 /* ocfs2_inode */
274 int ocfs2_journal_access_di(handle_t *handle, struct ocfs2_caching_info *ci,
275 			    struct buffer_head *bh, int type);
276 /* ocfs2_extent_block */
277 int ocfs2_journal_access_eb(handle_t *handle, struct ocfs2_caching_info *ci,
278 			    struct buffer_head *bh, int type);
279 /* ocfs2_refcount_block */
280 int ocfs2_journal_access_rb(handle_t *handle, struct ocfs2_caching_info *ci,
281 			    struct buffer_head *bh, int type);
282 /* ocfs2_group_desc */
283 int ocfs2_journal_access_gd(handle_t *handle, struct ocfs2_caching_info *ci,
284 			    struct buffer_head *bh, int type);
285 /* ocfs2_xattr_block */
286 int ocfs2_journal_access_xb(handle_t *handle, struct ocfs2_caching_info *ci,
287 			    struct buffer_head *bh, int type);
288 /* quota blocks */
289 int ocfs2_journal_access_dq(handle_t *handle, struct ocfs2_caching_info *ci,
290 			    struct buffer_head *bh, int type);
291 /* dirblock */
292 int ocfs2_journal_access_db(handle_t *handle, struct ocfs2_caching_info *ci,
293 			    struct buffer_head *bh, int type);
294 /* ocfs2_dx_root_block */
295 int ocfs2_journal_access_dr(handle_t *handle, struct ocfs2_caching_info *ci,
296 			    struct buffer_head *bh, int type);
297 /* ocfs2_dx_leaf */
298 int ocfs2_journal_access_dl(handle_t *handle, struct ocfs2_caching_info *ci,
299 			    struct buffer_head *bh, int type);
300 /* Anything that has no ecc */
301 int ocfs2_journal_access(handle_t *handle, struct ocfs2_caching_info *ci,
302 			 struct buffer_head *bh, int type);
303 
304 /*
305  * A word about the journal_access/journal_dirty "dance". It is
306  * entirely legal to journal_access a buffer more than once (as long
307  * as the access type is the same -- I'm not sure what will happen if
308  * access type is different but this should never happen anyway) It is
309  * also legal to journal_dirty a buffer more than once. In fact, you
310  * can even journal_access a buffer after you've done a
311  * journal_access/journal_dirty pair. The only thing you cannot do
312  * however, is journal_dirty a buffer which you haven't yet passed to
313  * journal_access at least once.
314  *
315  * That said, 99% of the time this doesn't matter and this is what the
316  * path looks like:
317  *
318  *	<read a bh>
319  *	ocfs2_journal_access(handle, bh,	OCFS2_JOURNAL_ACCESS_WRITE);
320  *	<modify the bh>
321  * 	ocfs2_journal_dirty(handle, bh);
322  */
323 void ocfs2_journal_dirty(handle_t *handle, struct buffer_head *bh);
324 
325 /*
326  *  Credit Macros:
327  *  Convenience macros to calculate number of credits needed.
328  *
329  *  For convenience sake, I have a set of macros here which calculate
330  *  the *maximum* number of sectors which will be changed for various
331  *  metadata updates.
332  */
333 
334 /* simple file updates like chmod, etc. */
335 #define OCFS2_INODE_UPDATE_CREDITS 1
336 
337 /* extended attribute block update */
338 #define OCFS2_XATTR_BLOCK_UPDATE_CREDITS 1
339 
340 /* Update of a single quota block */
341 #define OCFS2_QUOTA_BLOCK_UPDATE_CREDITS 1
342 
343 /* global quotafile inode update, data block */
344 #define OCFS2_QINFO_WRITE_CREDITS (OCFS2_INODE_UPDATE_CREDITS + \
345 				   OCFS2_QUOTA_BLOCK_UPDATE_CREDITS)
346 
347 #define OCFS2_LOCAL_QINFO_WRITE_CREDITS OCFS2_QUOTA_BLOCK_UPDATE_CREDITS
348 /*
349  * The two writes below can accidentally see global info dirty due
350  * to set_info() quotactl so make them prepared for the writes.
351  */
352 /* quota data block, global info */
353 /* Write to local quota file */
354 #define OCFS2_QWRITE_CREDITS (OCFS2_QINFO_WRITE_CREDITS + \
355 			      OCFS2_QUOTA_BLOCK_UPDATE_CREDITS)
356 
357 /* global quota data block, local quota data block, global quota inode,
358  * global quota info */
359 #define OCFS2_QSYNC_CREDITS (OCFS2_QINFO_WRITE_CREDITS + \
360 			     2 * OCFS2_QUOTA_BLOCK_UPDATE_CREDITS)
361 
362 static inline int ocfs2_quota_trans_credits(struct super_block *sb)
363 {
364 	int credits = 0;
365 
366 	if (OCFS2_HAS_RO_COMPAT_FEATURE(sb, OCFS2_FEATURE_RO_COMPAT_USRQUOTA))
367 		credits += OCFS2_QWRITE_CREDITS;
368 	if (OCFS2_HAS_RO_COMPAT_FEATURE(sb, OCFS2_FEATURE_RO_COMPAT_GRPQUOTA))
369 		credits += OCFS2_QWRITE_CREDITS;
370 	return credits;
371 }
372 
373 /* group extend. inode update and last group update. */
374 #define OCFS2_GROUP_EXTEND_CREDITS	(OCFS2_INODE_UPDATE_CREDITS + 1)
375 
376 /* group add. inode update and the new group update. */
377 #define OCFS2_GROUP_ADD_CREDITS	(OCFS2_INODE_UPDATE_CREDITS + 1)
378 
379 /* get one bit out of a suballocator: dinode + group descriptor +
380  * prev. group desc. if we relink. */
381 #define OCFS2_SUBALLOC_ALLOC (3)
382 
383 static inline int ocfs2_inline_to_extents_credits(struct super_block *sb)
384 {
385 	return OCFS2_SUBALLOC_ALLOC + OCFS2_INODE_UPDATE_CREDITS +
386 	       ocfs2_quota_trans_credits(sb);
387 }
388 
389 /* dinode + group descriptor update. We don't relink on free yet. */
390 #define OCFS2_SUBALLOC_FREE  (2)
391 
392 #define OCFS2_TRUNCATE_LOG_UPDATE OCFS2_INODE_UPDATE_CREDITS
393 #define OCFS2_TRUNCATE_LOG_FLUSH_ONE_REC (OCFS2_SUBALLOC_FREE 		      \
394 					 + OCFS2_TRUNCATE_LOG_UPDATE)
395 
396 static inline int ocfs2_remove_extent_credits(struct super_block *sb)
397 {
398 	return OCFS2_TRUNCATE_LOG_UPDATE + OCFS2_INODE_UPDATE_CREDITS +
399 	       ocfs2_quota_trans_credits(sb);
400 }
401 
402 /* data block for new dir/symlink, allocation of directory block, dx_root
403  * update for free list */
404 #define OCFS2_DIR_LINK_ADDITIONAL_CREDITS (1 + OCFS2_SUBALLOC_ALLOC + 1)
405 
406 static inline int ocfs2_add_dir_index_credits(struct super_block *sb)
407 {
408 	/* 1 block for index, 2 allocs (data, metadata), 1 clusters
409 	 * worth of blocks for initial extent. */
410 	return 1 + 2 * OCFS2_SUBALLOC_ALLOC +
411 		ocfs2_clusters_to_blocks(sb, 1);
412 }
413 
414 /* parent fe, parent block, new file entry, index leaf, inode alloc fe, inode
415  * alloc group descriptor + mkdir/symlink blocks + dir blocks + xattr
416  * blocks + quota update */
417 static inline int ocfs2_mknod_credits(struct super_block *sb, int is_dir,
418 				      int xattr_credits)
419 {
420 	int dir_credits = OCFS2_DIR_LINK_ADDITIONAL_CREDITS;
421 
422 	if (is_dir)
423 		dir_credits += ocfs2_add_dir_index_credits(sb);
424 
425 	return 4 + OCFS2_SUBALLOC_ALLOC + dir_credits + xattr_credits +
426 	       ocfs2_quota_trans_credits(sb);
427 }
428 
429 /* local alloc metadata change + main bitmap updates */
430 #define OCFS2_WINDOW_MOVE_CREDITS (OCFS2_INODE_UPDATE_CREDITS                 \
431 				  + OCFS2_SUBALLOC_ALLOC + OCFS2_SUBALLOC_FREE)
432 
433 /* used when we don't need an allocation change for a dir extend. One
434  * for the dinode, one for the new block. */
435 #define OCFS2_SIMPLE_DIR_EXTEND_CREDITS (2)
436 
437 /* file update (nlink, etc) + directory mtime/ctime + dir entry block + quota
438  * update on dir + index leaf + dx root update for free list +
439  * previous dirblock update in the free list */
440 static inline int ocfs2_link_credits(struct super_block *sb)
441 {
442 	return 2 * OCFS2_INODE_UPDATE_CREDITS + 4 +
443 	       ocfs2_quota_trans_credits(sb);
444 }
445 
446 /* inode + dir inode (if we unlink a dir), + dir entry block + orphan
447  * dir inode link + dir inode index leaf + dir index root */
448 static inline int ocfs2_unlink_credits(struct super_block *sb)
449 {
450 	/* The quota update from ocfs2_link_credits is unused here... */
451 	return 2 * OCFS2_INODE_UPDATE_CREDITS + 3 + ocfs2_link_credits(sb);
452 }
453 
454 /* dinode + orphan dir dinode + inode alloc dinode + orphan dir entry +
455  * inode alloc group descriptor + orphan dir index root +
456  * orphan dir index leaf */
457 #define OCFS2_DELETE_INODE_CREDITS (3 * OCFS2_INODE_UPDATE_CREDITS + 4)
458 
459 /* dinode + orphan dir dinode + extent tree leaf block + orphan dir entry +
460  * orphan dir index root + orphan dir index leaf */
461 #define OCFS2_INODE_ADD_TO_ORPHAN_CREDITS  (2 * OCFS2_INODE_UPDATE_CREDITS + 4)
462 #define OCFS2_INODE_DEL_FROM_ORPHAN_CREDITS  OCFS2_INODE_ADD_TO_ORPHAN_CREDITS
463 
464 /* dinode update, old dir dinode update, new dir dinode update, old
465  * dir dir entry, new dir dir entry, dir entry update for renaming
466  * directory + target unlink + 3 x dir index leaves */
467 static inline int ocfs2_rename_credits(struct super_block *sb)
468 {
469 	return 3 * OCFS2_INODE_UPDATE_CREDITS + 6 + ocfs2_unlink_credits(sb);
470 }
471 
472 /* global bitmap dinode, group desc., relinked group,
473  * suballocator dinode, group desc., relinked group,
474  * dinode, xattr block */
475 #define OCFS2_XATTR_BLOCK_CREATE_CREDITS (OCFS2_SUBALLOC_ALLOC * 2 + \
476 					  + OCFS2_INODE_UPDATE_CREDITS \
477 					  + OCFS2_XATTR_BLOCK_UPDATE_CREDITS)
478 
479 /* inode update, removal of dx root block from allocator */
480 #define OCFS2_DX_ROOT_REMOVE_CREDITS (OCFS2_INODE_UPDATE_CREDITS +	\
481 				      OCFS2_SUBALLOC_FREE)
482 
483 static inline int ocfs2_calc_dxi_expand_credits(struct super_block *sb)
484 {
485 	int credits = 1 + OCFS2_SUBALLOC_ALLOC;
486 
487 	credits += ocfs2_clusters_to_blocks(sb, 1);
488 	credits += ocfs2_quota_trans_credits(sb);
489 
490 	return credits;
491 }
492 
493 /* inode update, new refcount block and its allocation credits. */
494 #define OCFS2_REFCOUNT_TREE_CREATE_CREDITS (OCFS2_INODE_UPDATE_CREDITS + 1 \
495 					    + OCFS2_SUBALLOC_ALLOC)
496 
497 /* inode and the refcount block update. */
498 #define OCFS2_REFCOUNT_TREE_SET_CREDITS (OCFS2_INODE_UPDATE_CREDITS + 1)
499 
500 /*
501  * inode and the refcount block update.
502  * It doesn't include the credits for sub alloc change.
503  * So if we need to free the bit, OCFS2_SUBALLOC_FREE needs to be added.
504  */
505 #define OCFS2_REFCOUNT_TREE_REMOVE_CREDITS (OCFS2_INODE_UPDATE_CREDITS + 1)
506 
507 /* 2 metadata alloc, 2 new blocks and root refcount block */
508 #define OCFS2_EXPAND_REFCOUNT_TREE_CREDITS (OCFS2_SUBALLOC_ALLOC * 2 + 3)
509 
510 /*
511  * Please note that the caller must make sure that root_el is the root
512  * of extent tree. So for an inode, it should be &fe->id2.i_list. Otherwise
513  * the result may be wrong.
514  */
515 static inline int ocfs2_calc_extend_credits(struct super_block *sb,
516 					    struct ocfs2_extent_list *root_el)
517 {
518 	int bitmap_blocks, sysfile_bitmap_blocks, extent_blocks;
519 
520 	/* bitmap dinode, group desc. + relinked group. */
521 	bitmap_blocks = OCFS2_SUBALLOC_ALLOC;
522 
523 	/* we might need to shift tree depth so lets assume an
524 	 * absolute worst case of complete fragmentation.  Even with
525 	 * that, we only need one update for the dinode, and then
526 	 * however many metadata chunks needed * a remaining suballoc
527 	 * alloc. */
528 	sysfile_bitmap_blocks = 1 +
529 		(OCFS2_SUBALLOC_ALLOC - 1) * ocfs2_extend_meta_needed(root_el);
530 
531 	/* this does not include *new* metadata blocks, which are
532 	 * accounted for in sysfile_bitmap_blocks. root_el +
533 	 * prev. last_eb_blk + blocks along edge of tree.
534 	 * calc_symlink_credits passes because we just need 1
535 	 * credit for the dinode there. */
536 	extent_blocks = 1 + 1 + le16_to_cpu(root_el->l_tree_depth);
537 
538 	return bitmap_blocks + sysfile_bitmap_blocks + extent_blocks +
539 	       ocfs2_quota_trans_credits(sb);
540 }
541 
542 static inline int ocfs2_calc_symlink_credits(struct super_block *sb)
543 {
544 	int blocks = ocfs2_mknod_credits(sb, 0, 0);
545 
546 	/* links can be longer than one block so we may update many
547 	 * within our single allocated extent. */
548 	blocks += ocfs2_clusters_to_blocks(sb, 1);
549 
550 	return blocks + ocfs2_quota_trans_credits(sb);
551 }
552 
553 static inline int ocfs2_calc_group_alloc_credits(struct super_block *sb,
554 						 unsigned int cpg)
555 {
556 	int blocks;
557 	int bitmap_blocks = OCFS2_SUBALLOC_ALLOC + 1;
558 	/* parent inode update + new block group header + bitmap inode update
559 	   + bitmap blocks affected */
560 	blocks = 1 + 1 + 1 + bitmap_blocks;
561 	return blocks;
562 }
563 
564 /*
565  * Allocating a discontiguous block group requires the credits from
566  * ocfs2_calc_group_alloc_credits() as well as enough credits to fill
567  * the group descriptor's extent list.  The caller already has started
568  * the transaction with ocfs2_calc_group_alloc_credits().  They extend
569  * it with these credits.
570  */
571 static inline int ocfs2_calc_bg_discontig_credits(struct super_block *sb)
572 {
573 	return ocfs2_extent_recs_per_gd(sb);
574 }
575 
576 static inline int ocfs2_jbd2_inode_add_write(handle_t *handle, struct inode *inode,
577 					     loff_t start_byte, loff_t length)
578 {
579 	return jbd2_journal_inode_ranged_write(handle,
580 					       &OCFS2_I(inode)->ip_jinode,
581 					       start_byte, length);
582 }
583 
584 static inline int ocfs2_begin_ordered_truncate(struct inode *inode,
585 					       loff_t new_size)
586 {
587 	return jbd2_journal_begin_ordered_truncate(
588 				OCFS2_SB(inode->i_sb)->journal->j_journal,
589 				&OCFS2_I(inode)->ip_jinode,
590 				new_size);
591 }
592 
593 static inline void ocfs2_update_inode_fsync_trans(handle_t *handle,
594 						  struct inode *inode,
595 						  int datasync)
596 {
597 	struct ocfs2_inode_info *oi = OCFS2_I(inode);
598 
599 	if (!is_handle_aborted(handle)) {
600 		oi->i_sync_tid = handle->h_transaction->t_tid;
601 		if (datasync)
602 			oi->i_datasync_tid = handle->h_transaction->t_tid;
603 	}
604 }
605 
606 #endif /* OCFS2_JOURNAL_H */
607