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