xref: /linux/fs/ocfs2/journal.h (revision 3ce9925823c7d6bb0e6eb951bf2db0e9e182582d)
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. */
ocfs2_inc_trans_id(struct ocfs2_journal * j)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 
ocfs2_set_ci_lock_trans(struct ocfs2_journal * journal,struct ocfs2_caching_info * ci)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. */
ocfs2_ci_fully_checkpointed(struct ocfs2_caching_info * ci)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. */
ocfs2_ci_is_new(struct ocfs2_caching_info * ci)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 */
ocfs2_inode_is_new(struct inode * inode)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 
ocfs2_ci_set_new(struct ocfs2_super * osb,struct ocfs2_caching_info * ci)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 void ocfs2_recovery_disable_quota(struct ocfs2_super *osb);
152 
153 int ocfs2_compute_replay_slots(struct ocfs2_super *osb);
154 void ocfs2_free_replay_slots(struct ocfs2_super *osb);
155 /*
156  *  Journal Control:
157  *  Initialize, Load, Shutdown, Wipe a journal.
158  *
159  *  ocfs2_journal_alloc    - Initialize skeleton for journal structure.
160  *  ocfs2_journal_init     - Initialize journal structures in the OSB.
161  *  ocfs2_journal_load     - Load the given journal off disk. Replay it if
162  *                          there's transactions still in there.
163  *  ocfs2_journal_shutdown - Shutdown a journal, this will flush all
164  *                          uncommitted, uncheckpointed transactions.
165  *  ocfs2_journal_wipe     - Wipe transactions from a journal. Optionally
166  *                          zero out each block.
167  *  ocfs2_recovery_thread  - Perform recovery on a node. osb is our own osb.
168  *  ocfs2_mark_dead_nodes - Start recovery on nodes we won't get a heartbeat
169  *                          event on.
170  *  ocfs2_start_checkpoint - Kick the commit thread to do a checkpoint.
171  */
172 void   ocfs2_set_journal_params(struct ocfs2_super *osb);
173 int    ocfs2_journal_alloc(struct ocfs2_super *osb);
174 int    ocfs2_journal_init(struct ocfs2_super *osb, int *dirty);
175 void   ocfs2_journal_shutdown(struct ocfs2_super *osb);
176 int    ocfs2_journal_wipe(struct ocfs2_journal *journal,
177 			  int full);
178 int    ocfs2_journal_load(struct ocfs2_journal *journal, int local,
179 			  int replayed);
180 int    ocfs2_check_journals_nolocks(struct ocfs2_super *osb);
181 void   ocfs2_recovery_thread(struct ocfs2_super *osb,
182 			     int node_num);
183 int    ocfs2_mark_dead_nodes(struct ocfs2_super *osb);
184 void   ocfs2_complete_mount_recovery(struct ocfs2_super *osb);
185 void ocfs2_complete_quota_recovery(struct ocfs2_super *osb);
186 
ocfs2_start_checkpoint(struct ocfs2_super * osb)187 static inline void ocfs2_start_checkpoint(struct ocfs2_super *osb)
188 {
189 	wake_up(&osb->checkpoint_event);
190 }
191 
ocfs2_checkpoint_inode(struct inode * inode)192 static inline void ocfs2_checkpoint_inode(struct inode *inode)
193 {
194 	struct ocfs2_super *osb = OCFS2_SB(inode->i_sb);
195 
196 	if (ocfs2_mount_local(osb))
197 		return;
198 
199 	if (!ocfs2_ci_fully_checkpointed(INODE_CACHE(inode))) {
200 		/* WARNING: This only kicks off a single
201 		 * checkpoint. If someone races you and adds more
202 		 * metadata to the journal, you won't know, and will
203 		 * wind up waiting *a lot* longer than necessary. Right
204 		 * now we only use this in clear_inode so that's
205 		 * OK. */
206 		ocfs2_start_checkpoint(osb);
207 
208 		wait_event(osb->journal->j_checkpointed,
209 			   ocfs2_ci_fully_checkpointed(INODE_CACHE(inode)));
210 	}
211 }
212 
213 /*
214  *  Transaction Handling:
215  *  Manage the lifetime of a transaction handle.
216  *
217  *  ocfs2_start_trans      - Begin a transaction. Give it an upper estimate of
218  *                          the number of blocks that will be changed during
219  *                          this handle.
220  *  ocfs2_commit_trans - Complete a handle. It might return -EIO if
221  *                       the journal was aborted. The majority of paths don't
222  *                       check the return value as an error there comes too
223  *                       late to do anything (and will be picked up in a
224  *                       later transaction).
225  *  ocfs2_extend_trans     - Extend a handle by nblocks credits. This may
226  *                          commit the handle to disk in the process, but will
227  *                          not release any locks taken during the transaction.
228  *  ocfs2_journal_access* - Notify the handle that we want to journal this
229  *                          buffer. Will have to call ocfs2_journal_dirty once
230  *                          we've actually dirtied it. Type is one of . or .
231  *                          Always call the specific flavor of
232  *                          ocfs2_journal_access_*() unless you intend to
233  *                          manage the checksum by hand.
234  *  ocfs2_journal_dirty    - Mark a journalled buffer as having dirty data.
235  *  ocfs2_jbd2_inode_add_write  - Mark an inode with range so that its data goes
236  *                                out before the current handle commits.
237  */
238 
239 /* You must always start_trans with a number of buffs > 0, but it's
240  * perfectly legal to go through an entire transaction without having
241  * dirtied any buffers. */
242 handle_t		    *ocfs2_start_trans(struct ocfs2_super *osb,
243 					       int max_buffs);
244 int			     ocfs2_commit_trans(struct ocfs2_super *osb,
245 						handle_t *handle);
246 int			     ocfs2_extend_trans(handle_t *handle, int nblocks);
247 int			     ocfs2_assure_trans_credits(handle_t *handle,
248 						int nblocks);
249 int			     ocfs2_allocate_extend_trans(handle_t *handle,
250 						int thresh);
251 
252 /*
253  * Define an arbitrary limit for the amount of data we will anticipate
254  * writing to any given transaction.  For unbounded transactions such as
255  * fallocate(2) we can write more than this, but we always
256  * start off at the maximum transaction size and grow the transaction
257  * optimistically as we go.
258  */
259 #define OCFS2_MAX_TRANS_DATA	64U
260 
261 /*
262  * Create access is for when we get a newly created buffer and we're
263  * not gonna read it off disk, but rather fill it ourselves.  Right
264  * now, we don't do anything special with this (it turns into a write
265  * request), but this is a good placeholder in case we do...
266  *
267  * Write access is for when we read a block off disk and are going to
268  * modify it. This way the journalling layer knows it may need to make
269  * a copy of that block (if it's part of another, uncommitted
270  * transaction) before we do so.
271  */
272 #define OCFS2_JOURNAL_ACCESS_CREATE 0
273 #define OCFS2_JOURNAL_ACCESS_WRITE  1
274 #define OCFS2_JOURNAL_ACCESS_UNDO   2
275 
276 
277 /* ocfs2_inode */
278 int ocfs2_journal_access_di(handle_t *handle, struct ocfs2_caching_info *ci,
279 			    struct buffer_head *bh, int type);
280 /* ocfs2_extent_block */
281 int ocfs2_journal_access_eb(handle_t *handle, struct ocfs2_caching_info *ci,
282 			    struct buffer_head *bh, int type);
283 /* ocfs2_refcount_block */
284 int ocfs2_journal_access_rb(handle_t *handle, struct ocfs2_caching_info *ci,
285 			    struct buffer_head *bh, int type);
286 /* ocfs2_group_desc */
287 int ocfs2_journal_access_gd(handle_t *handle, struct ocfs2_caching_info *ci,
288 			    struct buffer_head *bh, int type);
289 /* ocfs2_xattr_block */
290 int ocfs2_journal_access_xb(handle_t *handle, struct ocfs2_caching_info *ci,
291 			    struct buffer_head *bh, int type);
292 /* quota blocks */
293 int ocfs2_journal_access_dq(handle_t *handle, struct ocfs2_caching_info *ci,
294 			    struct buffer_head *bh, int type);
295 /* dirblock */
296 int ocfs2_journal_access_db(handle_t *handle, struct ocfs2_caching_info *ci,
297 			    struct buffer_head *bh, int type);
298 /* ocfs2_dx_root_block */
299 int ocfs2_journal_access_dr(handle_t *handle, struct ocfs2_caching_info *ci,
300 			    struct buffer_head *bh, int type);
301 /* ocfs2_dx_leaf */
302 int ocfs2_journal_access_dl(handle_t *handle, struct ocfs2_caching_info *ci,
303 			    struct buffer_head *bh, int type);
304 /* Anything that has no ecc */
305 int ocfs2_journal_access(handle_t *handle, struct ocfs2_caching_info *ci,
306 			 struct buffer_head *bh, int type);
307 
308 /*
309  * A word about the journal_access/journal_dirty "dance". It is
310  * entirely legal to journal_access a buffer more than once (as long
311  * as the access type is the same -- I'm not sure what will happen if
312  * access type is different but this should never happen anyway) It is
313  * also legal to journal_dirty a buffer more than once. In fact, you
314  * can even journal_access a buffer after you've done a
315  * journal_access/journal_dirty pair. The only thing you cannot do
316  * however, is journal_dirty a buffer which you haven't yet passed to
317  * journal_access at least once.
318  *
319  * That said, 99% of the time this doesn't matter and this is what the
320  * path looks like:
321  *
322  *	<read a bh>
323  *	ocfs2_journal_access(handle, bh,	OCFS2_JOURNAL_ACCESS_WRITE);
324  *	<modify the bh>
325  * 	ocfs2_journal_dirty(handle, bh);
326  */
327 void ocfs2_journal_dirty(handle_t *handle, struct buffer_head *bh);
328 
329 /*
330  *  Credit Macros:
331  *  Convenience macros to calculate number of credits needed.
332  *
333  *  For convenience sake, I have a set of macros here which calculate
334  *  the *maximum* number of sectors which will be changed for various
335  *  metadata updates.
336  */
337 
338 /* simple file updates like chmod, etc. */
339 #define OCFS2_INODE_UPDATE_CREDITS 1
340 
341 /* extended attribute block update */
342 #define OCFS2_XATTR_BLOCK_UPDATE_CREDITS 1
343 
344 /* Update of a single quota block */
345 #define OCFS2_QUOTA_BLOCK_UPDATE_CREDITS 1
346 
347 /* global quotafile inode update, data block */
348 #define OCFS2_QINFO_WRITE_CREDITS (OCFS2_INODE_UPDATE_CREDITS + \
349 				   OCFS2_QUOTA_BLOCK_UPDATE_CREDITS)
350 
351 #define OCFS2_LOCAL_QINFO_WRITE_CREDITS OCFS2_QUOTA_BLOCK_UPDATE_CREDITS
352 /*
353  * The two writes below can accidentally see global info dirty due
354  * to set_info() quotactl so make them prepared for the writes.
355  */
356 /* quota data block, global info */
357 /* Write to local quota file */
358 #define OCFS2_QWRITE_CREDITS (OCFS2_QINFO_WRITE_CREDITS + \
359 			      OCFS2_QUOTA_BLOCK_UPDATE_CREDITS)
360 
361 /* global quota data block, local quota data block, global quota inode,
362  * global quota info */
363 #define OCFS2_QSYNC_CREDITS (OCFS2_QINFO_WRITE_CREDITS + \
364 			     2 * OCFS2_QUOTA_BLOCK_UPDATE_CREDITS)
365 
ocfs2_quota_trans_credits(struct super_block * sb)366 static inline int ocfs2_quota_trans_credits(struct super_block *sb)
367 {
368 	int credits = 0;
369 
370 	if (OCFS2_HAS_RO_COMPAT_FEATURE(sb, OCFS2_FEATURE_RO_COMPAT_USRQUOTA))
371 		credits += OCFS2_QWRITE_CREDITS;
372 	if (OCFS2_HAS_RO_COMPAT_FEATURE(sb, OCFS2_FEATURE_RO_COMPAT_GRPQUOTA))
373 		credits += OCFS2_QWRITE_CREDITS;
374 	return credits;
375 }
376 
377 /* group extend. inode update and last group update. */
378 #define OCFS2_GROUP_EXTEND_CREDITS	(OCFS2_INODE_UPDATE_CREDITS + 1)
379 
380 /* group add. inode update and the new group update. */
381 #define OCFS2_GROUP_ADD_CREDITS	(OCFS2_INODE_UPDATE_CREDITS + 1)
382 
383 /* get one bit out of a suballocator: dinode + group descriptor +
384  * prev. group desc. if we relink. */
385 #define OCFS2_SUBALLOC_ALLOC (3)
386 
ocfs2_inline_to_extents_credits(struct super_block * sb)387 static inline int ocfs2_inline_to_extents_credits(struct super_block *sb)
388 {
389 	return OCFS2_SUBALLOC_ALLOC + OCFS2_INODE_UPDATE_CREDITS +
390 	       ocfs2_quota_trans_credits(sb);
391 }
392 
393 /* dinode + group descriptor update. We don't relink on free yet. */
394 #define OCFS2_SUBALLOC_FREE  (2)
395 
396 #define OCFS2_TRUNCATE_LOG_UPDATE OCFS2_INODE_UPDATE_CREDITS
397 #define OCFS2_TRUNCATE_LOG_FLUSH_ONE_REC (OCFS2_SUBALLOC_FREE 		      \
398 					 + OCFS2_TRUNCATE_LOG_UPDATE)
399 
ocfs2_remove_extent_credits(struct super_block * sb)400 static inline int ocfs2_remove_extent_credits(struct super_block *sb)
401 {
402 	return OCFS2_TRUNCATE_LOG_UPDATE + OCFS2_INODE_UPDATE_CREDITS +
403 	       ocfs2_quota_trans_credits(sb);
404 }
405 
406 /* data block for new dir/symlink, allocation of directory block, dx_root
407  * update for free list */
408 #define OCFS2_DIR_LINK_ADDITIONAL_CREDITS (1 + OCFS2_SUBALLOC_ALLOC + 1)
409 
ocfs2_add_dir_index_credits(struct super_block * sb)410 static inline int ocfs2_add_dir_index_credits(struct super_block *sb)
411 {
412 	/* 1 block for index, 2 allocs (data, metadata), 1 clusters
413 	 * worth of blocks for initial extent. */
414 	return 1 + 2 * OCFS2_SUBALLOC_ALLOC +
415 		ocfs2_clusters_to_blocks(sb, 1);
416 }
417 
418 /* parent fe, parent block, new file entry, index leaf, inode alloc fe, inode
419  * alloc group descriptor + mkdir/symlink blocks + dir blocks + xattr
420  * blocks + quota update */
ocfs2_mknod_credits(struct super_block * sb,int is_dir,int xattr_credits)421 static inline int ocfs2_mknod_credits(struct super_block *sb, int is_dir,
422 				      int xattr_credits)
423 {
424 	int dir_credits = OCFS2_DIR_LINK_ADDITIONAL_CREDITS;
425 
426 	if (is_dir)
427 		dir_credits += ocfs2_add_dir_index_credits(sb);
428 
429 	return 4 + OCFS2_SUBALLOC_ALLOC + dir_credits + xattr_credits +
430 	       ocfs2_quota_trans_credits(sb);
431 }
432 
433 /* local alloc metadata change + main bitmap updates */
434 #define OCFS2_WINDOW_MOVE_CREDITS (OCFS2_INODE_UPDATE_CREDITS                 \
435 				  + OCFS2_SUBALLOC_ALLOC + OCFS2_SUBALLOC_FREE)
436 
437 /* used when we don't need an allocation change for a dir extend. One
438  * for the dinode, one for the new block. */
439 #define OCFS2_SIMPLE_DIR_EXTEND_CREDITS (2)
440 
441 /* file update (nlink, etc) + directory mtime/ctime + dir entry block + quota
442  * update on dir + index leaf + dx root update for free list +
443  * previous dirblock update in the free list */
ocfs2_link_credits(struct super_block * sb)444 static inline int ocfs2_link_credits(struct super_block *sb)
445 {
446 	return 2 * OCFS2_INODE_UPDATE_CREDITS + 4 +
447 	       ocfs2_quota_trans_credits(sb);
448 }
449 
450 /* inode + dir inode (if we unlink a dir), + dir entry block + orphan
451  * dir inode link + dir inode index leaf + dir index root */
ocfs2_unlink_credits(struct super_block * sb)452 static inline int ocfs2_unlink_credits(struct super_block *sb)
453 {
454 	/* The quota update from ocfs2_link_credits is unused here... */
455 	return 2 * OCFS2_INODE_UPDATE_CREDITS + 3 + ocfs2_link_credits(sb);
456 }
457 
458 /* dinode + orphan dir dinode + inode alloc dinode + orphan dir entry +
459  * inode alloc group descriptor + orphan dir index root +
460  * orphan dir index leaf */
461 #define OCFS2_DELETE_INODE_CREDITS (3 * OCFS2_INODE_UPDATE_CREDITS + 4)
462 
463 /* dinode + orphan dir dinode + extent tree leaf block + orphan dir entry +
464  * orphan dir index root + orphan dir index leaf */
465 #define OCFS2_INODE_ADD_TO_ORPHAN_CREDITS  (2 * OCFS2_INODE_UPDATE_CREDITS + 4)
466 #define OCFS2_INODE_DEL_FROM_ORPHAN_CREDITS  OCFS2_INODE_ADD_TO_ORPHAN_CREDITS
467 
468 /* dinode update, old dir dinode update, new dir dinode update, old
469  * dir dir entry, new dir dir entry, dir entry update for renaming
470  * directory + target unlink + 3 x dir index leaves */
ocfs2_rename_credits(struct super_block * sb)471 static inline int ocfs2_rename_credits(struct super_block *sb)
472 {
473 	return 3 * OCFS2_INODE_UPDATE_CREDITS + 6 + ocfs2_unlink_credits(sb);
474 }
475 
476 /* global bitmap dinode, group desc., relinked group,
477  * suballocator dinode, group desc., relinked group,
478  * dinode, xattr block */
479 #define OCFS2_XATTR_BLOCK_CREATE_CREDITS (OCFS2_SUBALLOC_ALLOC * 2 + \
480 					  + OCFS2_INODE_UPDATE_CREDITS \
481 					  + OCFS2_XATTR_BLOCK_UPDATE_CREDITS)
482 
483 /* inode update, removal of dx root block from allocator */
484 #define OCFS2_DX_ROOT_REMOVE_CREDITS (OCFS2_INODE_UPDATE_CREDITS +	\
485 				      OCFS2_SUBALLOC_FREE)
486 
ocfs2_calc_dxi_expand_credits(struct super_block * sb)487 static inline int ocfs2_calc_dxi_expand_credits(struct super_block *sb)
488 {
489 	int credits = 1 + OCFS2_SUBALLOC_ALLOC;
490 
491 	credits += ocfs2_clusters_to_blocks(sb, 1);
492 	credits += ocfs2_quota_trans_credits(sb);
493 
494 	return credits;
495 }
496 
497 /* inode update, new refcount block and its allocation credits. */
498 #define OCFS2_REFCOUNT_TREE_CREATE_CREDITS (OCFS2_INODE_UPDATE_CREDITS + 1 \
499 					    + OCFS2_SUBALLOC_ALLOC)
500 
501 /* inode and the refcount block update. */
502 #define OCFS2_REFCOUNT_TREE_SET_CREDITS (OCFS2_INODE_UPDATE_CREDITS + 1)
503 
504 /*
505  * inode and the refcount block update.
506  * It doesn't include the credits for sub alloc change.
507  * So if we need to free the bit, OCFS2_SUBALLOC_FREE needs to be added.
508  */
509 #define OCFS2_REFCOUNT_TREE_REMOVE_CREDITS (OCFS2_INODE_UPDATE_CREDITS + 1)
510 
511 /* 2 metadata alloc, 2 new blocks and root refcount block */
512 #define OCFS2_EXPAND_REFCOUNT_TREE_CREDITS (OCFS2_SUBALLOC_ALLOC * 2 + 3)
513 
514 /*
515  * Please note that the caller must make sure that root_el is the root
516  * of extent tree. So for an inode, it should be &fe->id2.i_list. Otherwise
517  * the result may be wrong.
518  */
ocfs2_calc_extend_credits(struct super_block * sb,struct ocfs2_extent_list * root_el)519 static inline int ocfs2_calc_extend_credits(struct super_block *sb,
520 					    struct ocfs2_extent_list *root_el)
521 {
522 	int bitmap_blocks, sysfile_bitmap_blocks, extent_blocks;
523 
524 	/* bitmap dinode, group desc. + relinked group. */
525 	bitmap_blocks = OCFS2_SUBALLOC_ALLOC;
526 
527 	/* we might need to shift tree depth so lets assume an
528 	 * absolute worst case of complete fragmentation.  Even with
529 	 * that, we only need one update for the dinode, and then
530 	 * however many metadata chunks needed * a remaining suballoc
531 	 * alloc. */
532 	sysfile_bitmap_blocks = 1 +
533 		(OCFS2_SUBALLOC_ALLOC - 1) * ocfs2_extend_meta_needed(root_el);
534 
535 	/* this does not include *new* metadata blocks, which are
536 	 * accounted for in sysfile_bitmap_blocks. root_el +
537 	 * prev. last_eb_blk + blocks along edge of tree.
538 	 * calc_symlink_credits passes because we just need 1
539 	 * credit for the dinode there. */
540 	extent_blocks = 1 + 1 + le16_to_cpu(root_el->l_tree_depth);
541 
542 	return bitmap_blocks + sysfile_bitmap_blocks + extent_blocks +
543 	       ocfs2_quota_trans_credits(sb);
544 }
545 
ocfs2_calc_symlink_credits(struct super_block * sb)546 static inline int ocfs2_calc_symlink_credits(struct super_block *sb)
547 {
548 	int blocks = ocfs2_mknod_credits(sb, 0, 0);
549 
550 	/* links can be longer than one block so we may update many
551 	 * within our single allocated extent. */
552 	blocks += ocfs2_clusters_to_blocks(sb, 1);
553 
554 	return blocks + ocfs2_quota_trans_credits(sb);
555 }
556 
ocfs2_calc_group_alloc_credits(struct super_block * sb,unsigned int cpg)557 static inline int ocfs2_calc_group_alloc_credits(struct super_block *sb,
558 						 unsigned int cpg)
559 {
560 	int blocks;
561 	int bitmap_blocks = OCFS2_SUBALLOC_ALLOC + 1;
562 	/* parent inode update + new block group header + bitmap inode update
563 	   + bitmap blocks affected */
564 	blocks = 1 + 1 + 1 + bitmap_blocks;
565 	return blocks;
566 }
567 
568 /*
569  * Allocating a discontiguous block group requires the credits from
570  * ocfs2_calc_group_alloc_credits() as well as enough credits to fill
571  * the group descriptor's extent list.  The caller already has started
572  * the transaction with ocfs2_calc_group_alloc_credits().  They extend
573  * it with these credits.
574  */
ocfs2_calc_bg_discontig_credits(struct super_block * sb)575 static inline int ocfs2_calc_bg_discontig_credits(struct super_block *sb)
576 {
577 	return ocfs2_extent_recs_per_gd(sb);
578 }
579 
ocfs2_jbd2_inode_add_write(handle_t * handle,struct inode * inode,loff_t start_byte,loff_t length)580 static inline int ocfs2_jbd2_inode_add_write(handle_t *handle, struct inode *inode,
581 					     loff_t start_byte, loff_t length)
582 {
583 	return jbd2_journal_inode_ranged_write(handle,
584 					       &OCFS2_I(inode)->ip_jinode,
585 					       start_byte, length);
586 }
587 
ocfs2_begin_ordered_truncate(struct inode * inode,loff_t new_size)588 static inline int ocfs2_begin_ordered_truncate(struct inode *inode,
589 					       loff_t new_size)
590 {
591 	return jbd2_journal_begin_ordered_truncate(
592 				OCFS2_SB(inode->i_sb)->journal->j_journal,
593 				&OCFS2_I(inode)->ip_jinode,
594 				new_size);
595 }
596 
ocfs2_update_inode_fsync_trans(handle_t * handle,struct inode * inode,int datasync)597 static inline void ocfs2_update_inode_fsync_trans(handle_t *handle,
598 						  struct inode *inode,
599 						  int datasync)
600 {
601 	struct ocfs2_inode_info *oi = OCFS2_I(inode);
602 
603 	if (!is_handle_aborted(handle)) {
604 		oi->i_sync_tid = handle->h_transaction->t_tid;
605 		if (datasync)
606 			oi->i_datasync_tid = handle->h_transaction->t_tid;
607 	}
608 }
609 
610 #endif /* OCFS2_JOURNAL_H */
611