1 /* -*- mode: c; c-basic-offset: 8; -*-
2 * vim: noexpandtab sw=8 ts=8 sts=0:
6 * Defines journalling api and structures.
8 * Copyright (C) 2003, 2005 Oracle. All rights reserved.
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.
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.
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.
26 #ifndef OCFS2_JOURNAL_H
27 #define OCFS2_JOURNAL_H
30 #include <linux/jbd2.h>
32 enum ocfs2_journal_state {
33 OCFS2_JOURNAL_FREE = 0,
35 OCFS2_JOURNAL_IN_SHUTDOWN,
42 * The recovery_list is a simple linked list of node numbers to recover.
43 * It is protected by the recovery_lock.
46 struct ocfs2_recovery_map {
48 unsigned int *rm_entries;
52 struct ocfs2_journal {
53 enum ocfs2_journal_state j_state; /* Journals current state */
55 journal_t *j_journal; /* The kernels journal type */
56 struct inode *j_inode; /* Kernel inode pointing to
58 struct ocfs2_super *j_osb; /* pointer to the super
62 * necessarily the super
64 * which we usually run
67 struct buffer_head *j_bh; /* Journal disk inode block */
68 atomic_t j_num_trans; /* Number of transactions
69 * currently in the system. */
70 unsigned long j_trans_id;
71 struct rw_semaphore j_trans_barrier;
72 wait_queue_head_t j_checkpointed;
75 struct list_head j_la_cleanups;
76 struct work_struct j_recovery_work;
79 extern spinlock_t trans_inc_lock;
81 /* wrap j_trans_id so we never have it equal to zero. */
82 static inline unsigned long ocfs2_inc_trans_id(struct ocfs2_journal *j)
85 spin_lock(&trans_inc_lock);
86 old_id = j->j_trans_id++;
87 if (unlikely(!j->j_trans_id))
89 spin_unlock(&trans_inc_lock);
93 static inline void ocfs2_set_ci_lock_trans(struct ocfs2_journal *journal,
94 struct ocfs2_caching_info *ci)
96 spin_lock(&trans_inc_lock);
97 ci->ci_last_trans = journal->j_trans_id;
98 spin_unlock(&trans_inc_lock);
101 /* Used to figure out whether it's safe to drop a metadata lock on an
102 * cached object. Returns true if all the object's changes have been
103 * checkpointed to disk. You should be holding the spinlock on the
104 * metadata lock while calling this to be sure that nobody can take
105 * the lock and put it on another transaction. */
106 static inline int ocfs2_ci_fully_checkpointed(struct ocfs2_caching_info *ci)
109 struct ocfs2_journal *journal =
110 OCFS2_SB(ocfs2_metadata_cache_get_super(ci))->journal;
112 spin_lock(&trans_inc_lock);
113 ret = time_after(journal->j_trans_id, ci->ci_last_trans);
114 spin_unlock(&trans_inc_lock);
118 /* convenience function to check if an object backed by struct
119 * ocfs2_caching_info is still new (has never hit disk) Will do you a
120 * favor and set created_trans = 0 when you've
121 * been checkpointed. returns '1' if the ci is still new. */
122 static inline int ocfs2_ci_is_new(struct ocfs2_caching_info *ci)
125 struct ocfs2_journal *journal =
126 OCFS2_SB(ocfs2_metadata_cache_get_super(ci))->journal;
128 spin_lock(&trans_inc_lock);
129 ret = !(time_after(journal->j_trans_id, ci->ci_created_trans));
131 ci->ci_created_trans = 0;
132 spin_unlock(&trans_inc_lock);
136 /* Wrapper for inodes so we can check system files */
137 static inline int ocfs2_inode_is_new(struct inode *inode)
139 /* System files are never "new" as they're written out by
140 * mkfs. This helps us early during mount, before we have the
141 * journal open and j_trans_id could be junk. */
142 if (OCFS2_I(inode)->ip_flags & OCFS2_INODE_SYSTEM_FILE)
145 return ocfs2_ci_is_new(INODE_CACHE(inode));
148 static inline void ocfs2_ci_set_new(struct ocfs2_super *osb,
149 struct ocfs2_caching_info *ci)
151 spin_lock(&trans_inc_lock);
152 ci->ci_created_trans = osb->journal->j_trans_id;
153 spin_unlock(&trans_inc_lock);
156 /* Exported only for the journal struct init code in super.c. Do not call. */
157 void ocfs2_orphan_scan_init(struct ocfs2_super *osb);
158 void ocfs2_orphan_scan_start(struct ocfs2_super *osb);
159 void ocfs2_orphan_scan_stop(struct ocfs2_super *osb);
160 void ocfs2_orphan_scan_exit(struct ocfs2_super *osb);
162 void ocfs2_complete_recovery(struct work_struct *work);
163 void ocfs2_wait_for_recovery(struct ocfs2_super *osb);
165 int ocfs2_recovery_init(struct ocfs2_super *osb);
166 void ocfs2_recovery_exit(struct ocfs2_super *osb);
168 int ocfs2_compute_replay_slots(struct ocfs2_super *osb);
171 * Initialize, Load, Shutdown, Wipe a journal.
173 * ocfs2_journal_init - Initialize journal structures in the OSB.
174 * ocfs2_journal_load - Load the given journal off disk. Replay it if
175 * there's transactions still in there.
176 * ocfs2_journal_shutdown - Shutdown a journal, this will flush all
177 * uncommitted, uncheckpointed transactions.
178 * ocfs2_journal_wipe - Wipe transactions from a journal. Optionally
179 * zero out each block.
180 * ocfs2_recovery_thread - Perform recovery on a node. osb is our own osb.
181 * ocfs2_mark_dead_nodes - Start recovery on nodes we won't get a heartbeat
183 * ocfs2_start_checkpoint - Kick the commit thread to do a checkpoint.
185 void ocfs2_set_journal_params(struct ocfs2_super *osb);
186 int ocfs2_journal_init(struct ocfs2_journal *journal,
188 void ocfs2_journal_shutdown(struct ocfs2_super *osb);
189 int ocfs2_journal_wipe(struct ocfs2_journal *journal,
191 int ocfs2_journal_load(struct ocfs2_journal *journal, int local,
193 int ocfs2_check_journals_nolocks(struct ocfs2_super *osb);
194 void ocfs2_recovery_thread(struct ocfs2_super *osb,
196 int ocfs2_mark_dead_nodes(struct ocfs2_super *osb);
197 void ocfs2_complete_mount_recovery(struct ocfs2_super *osb);
198 void ocfs2_complete_quota_recovery(struct ocfs2_super *osb);
200 static inline void ocfs2_start_checkpoint(struct ocfs2_super *osb)
202 atomic_set(&osb->needs_checkpoint, 1);
203 wake_up(&osb->checkpoint_event);
206 static inline void ocfs2_checkpoint_inode(struct inode *inode)
208 struct ocfs2_super *osb = OCFS2_SB(inode->i_sb);
210 if (ocfs2_mount_local(osb))
213 if (!ocfs2_ci_fully_checkpointed(INODE_CACHE(inode))) {
214 /* WARNING: This only kicks off a single
215 * checkpoint. If someone races you and adds more
216 * metadata to the journal, you won't know, and will
217 * wind up waiting *alot* longer than necessary. Right
218 * now we only use this in clear_inode so that's
220 ocfs2_start_checkpoint(osb);
222 wait_event(osb->journal->j_checkpointed,
223 ocfs2_ci_fully_checkpointed(INODE_CACHE(inode)));
228 * Transaction Handling:
229 * Manage the lifetime of a transaction handle.
231 * ocfs2_start_trans - Begin a transaction. Give it an upper estimate of
232 * the number of blocks that will be changed during
234 * ocfs2_commit_trans - Complete a handle. It might return -EIO if
235 * the journal was aborted. The majority of paths don't
236 * check the return value as an error there comes too
237 * late to do anything (and will be picked up in a
238 * later transaction).
239 * ocfs2_extend_trans - Extend a handle by nblocks credits. This may
240 * commit the handle to disk in the process, but will
241 * not release any locks taken during the transaction.
242 * ocfs2_journal_access* - Notify the handle that we want to journal this
243 * buffer. Will have to call ocfs2_journal_dirty once
244 * we've actually dirtied it. Type is one of . or .
245 * Always call the specific flavor of
246 * ocfs2_journal_access_*() unless you intend to
247 * manage the checksum by hand.
248 * ocfs2_journal_dirty - Mark a journalled buffer as having dirty data.
249 * ocfs2_jbd2_file_inode - Mark an inode so that its data goes out before
250 * the current handle commits.
253 /* You must always start_trans with a number of buffs > 0, but it's
254 * perfectly legal to go through an entire transaction without having
255 * dirtied any buffers. */
256 handle_t *ocfs2_start_trans(struct ocfs2_super *osb,
258 int ocfs2_commit_trans(struct ocfs2_super *osb,
260 int ocfs2_extend_trans(handle_t *handle, int nblocks);
263 * Create access is for when we get a newly created buffer and we're
264 * not gonna read it off disk, but rather fill it ourselves. Right
265 * now, we don't do anything special with this (it turns into a write
266 * request), but this is a good placeholder in case we do...
268 * Write access is for when we read a block off disk and are going to
269 * modify it. This way the journalling layer knows it may need to make
270 * a copy of that block (if it's part of another, uncommitted
271 * transaction) before we do so.
273 #define OCFS2_JOURNAL_ACCESS_CREATE 0
274 #define OCFS2_JOURNAL_ACCESS_WRITE 1
275 #define OCFS2_JOURNAL_ACCESS_UNDO 2
279 int ocfs2_journal_access_di(handle_t *handle, struct ocfs2_caching_info *ci,
280 struct buffer_head *bh, int type);
281 /* ocfs2_extent_block */
282 int ocfs2_journal_access_eb(handle_t *handle, struct ocfs2_caching_info *ci,
283 struct buffer_head *bh, int type);
284 /* ocfs2_group_desc */
285 int ocfs2_journal_access_gd(handle_t *handle, struct ocfs2_caching_info *ci,
286 struct buffer_head *bh, int type);
287 /* ocfs2_xattr_block */
288 int ocfs2_journal_access_xb(handle_t *handle, struct ocfs2_caching_info *ci,
289 struct buffer_head *bh, int type);
291 int ocfs2_journal_access_dq(handle_t *handle, struct ocfs2_caching_info *ci,
292 struct buffer_head *bh, int type);
294 int ocfs2_journal_access_db(handle_t *handle, struct ocfs2_caching_info *ci,
295 struct buffer_head *bh, int type);
296 /* ocfs2_dx_root_block */
297 int ocfs2_journal_access_dr(handle_t *handle, struct ocfs2_caching_info *ci,
298 struct buffer_head *bh, int type);
300 int ocfs2_journal_access_dl(handle_t *handle, struct ocfs2_caching_info *ci,
301 struct buffer_head *bh, int type);
302 /* Anything that has no ecc */
303 int ocfs2_journal_access(handle_t *handle, struct ocfs2_caching_info *ci,
304 struct buffer_head *bh, int type);
307 * A word about the journal_access/journal_dirty "dance". It is
308 * entirely legal to journal_access a buffer more than once (as long
309 * as the access type is the same -- I'm not sure what will happen if
310 * access type is different but this should never happen anyway) It is
311 * also legal to journal_dirty a buffer more than once. In fact, you
312 * can even journal_access a buffer after you've done a
313 * journal_access/journal_dirty pair. The only thing you cannot do
314 * however, is journal_dirty a buffer which you haven't yet passed to
315 * journal_access at least once.
317 * That said, 99% of the time this doesn't matter and this is what the
321 * ocfs2_journal_access(handle, bh, OCFS2_JOURNAL_ACCESS_WRITE);
323 * ocfs2_journal_dirty(handle, bh);
325 int ocfs2_journal_dirty(handle_t *handle,
326 struct buffer_head *bh);
330 * Convenience macros to calculate number of credits needed.
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
337 /* simple file updates like chmod, etc. */
338 #define OCFS2_INODE_UPDATE_CREDITS 1
340 /* extended attribute block update */
341 #define OCFS2_XATTR_BLOCK_UPDATE_CREDITS 1
343 /* Update of a single quota block */
344 #define OCFS2_QUOTA_BLOCK_UPDATE_CREDITS 1
346 /* global quotafile inode update, data block */
347 #define OCFS2_QINFO_WRITE_CREDITS (OCFS2_INODE_UPDATE_CREDITS + \
348 OCFS2_QUOTA_BLOCK_UPDATE_CREDITS)
350 #define OCFS2_LOCAL_QINFO_WRITE_CREDITS OCFS2_QUOTA_BLOCK_UPDATE_CREDITS
352 * The two writes below can accidentally see global info dirty due
353 * to set_info() quotactl so make them prepared for the writes.
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)
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)
365 static inline int ocfs2_quota_trans_credits(struct super_block *sb)
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;
376 /* group extend. inode update and last group update. */
377 #define OCFS2_GROUP_EXTEND_CREDITS (OCFS2_INODE_UPDATE_CREDITS + 1)
379 /* group add. inode update and the new group update. */
380 #define OCFS2_GROUP_ADD_CREDITS (OCFS2_INODE_UPDATE_CREDITS + 1)
382 /* get one bit out of a suballocator: dinode + group descriptor +
383 * prev. group desc. if we relink. */
384 #define OCFS2_SUBALLOC_ALLOC (3)
386 static inline int ocfs2_inline_to_extents_credits(struct super_block *sb)
388 return OCFS2_SUBALLOC_ALLOC + OCFS2_INODE_UPDATE_CREDITS +
389 ocfs2_quota_trans_credits(sb);
392 /* dinode + group descriptor update. We don't relink on free yet. */
393 #define OCFS2_SUBALLOC_FREE (2)
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)
399 static inline int ocfs2_remove_extent_credits(struct super_block *sb)
401 return OCFS2_TRUNCATE_LOG_UPDATE + OCFS2_INODE_UPDATE_CREDITS +
402 ocfs2_quota_trans_credits(sb);
405 /* data block for new dir/symlink, 2 for bitmap updates (bitmap fe +
406 * bitmap block for the new bit) dx_root update for free list */
407 #define OCFS2_DIR_LINK_ADDITIONAL_CREDITS (1 + 2 + 1)
409 static inline int ocfs2_add_dir_index_credits(struct super_block *sb)
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);
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 */
420 static inline int ocfs2_mknod_credits(struct super_block *sb, int is_dir,
423 int dir_credits = OCFS2_DIR_LINK_ADDITIONAL_CREDITS;
426 dir_credits += ocfs2_add_dir_index_credits(sb);
428 return 4 + OCFS2_SUBALLOC_ALLOC + dir_credits + xattr_credits +
429 ocfs2_quota_trans_credits(sb);
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)
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)
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 static inline int ocfs2_link_credits(struct super_block *sb)
444 return 2*OCFS2_INODE_UPDATE_CREDITS + 3 +
445 ocfs2_quota_trans_credits(sb);
448 /* inode + dir inode (if we unlink a dir), + dir entry block + orphan
449 * dir inode link + dir inode index leaf + dir index root */
450 static inline int ocfs2_unlink_credits(struct super_block *sb)
452 /* The quota update from ocfs2_link_credits is unused here... */
453 return 2 * OCFS2_INODE_UPDATE_CREDITS + 3 + ocfs2_link_credits(sb);
456 /* dinode + orphan dir dinode + inode alloc dinode + orphan dir entry +
457 * inode alloc group descriptor + orphan dir index root +
458 * orphan dir index leaf */
459 #define OCFS2_DELETE_INODE_CREDITS (3 * OCFS2_INODE_UPDATE_CREDITS + 4)
461 /* dinode update, old dir dinode update, new dir dinode update, old
462 * dir dir entry, new dir dir entry, dir entry update for renaming
463 * directory + target unlink + 3 x dir index leaves */
464 static inline int ocfs2_rename_credits(struct super_block *sb)
466 return 3 * OCFS2_INODE_UPDATE_CREDITS + 6 + ocfs2_unlink_credits(sb);
469 /* global bitmap dinode, group desc., relinked group,
470 * suballocator dinode, group desc., relinked group,
471 * dinode, xattr block */
472 #define OCFS2_XATTR_BLOCK_CREATE_CREDITS (OCFS2_SUBALLOC_ALLOC * 2 + \
473 + OCFS2_INODE_UPDATE_CREDITS \
474 + OCFS2_XATTR_BLOCK_UPDATE_CREDITS)
476 /* inode update, removal of dx root block from allocator */
477 #define OCFS2_DX_ROOT_REMOVE_CREDITS (OCFS2_INODE_UPDATE_CREDITS + \
480 static inline int ocfs2_calc_dxi_expand_credits(struct super_block *sb)
482 int credits = 1 + OCFS2_SUBALLOC_ALLOC;
484 credits += ocfs2_clusters_to_blocks(sb, 1);
485 credits += ocfs2_quota_trans_credits(sb);
491 * Please note that the caller must make sure that root_el is the root
492 * of extent tree. So for an inode, it should be &fe->id2.i_list. Otherwise
493 * the result may be wrong.
495 static inline int ocfs2_calc_extend_credits(struct super_block *sb,
496 struct ocfs2_extent_list *root_el,
499 int bitmap_blocks, sysfile_bitmap_blocks, extent_blocks;
501 /* bitmap dinode, group desc. + relinked group. */
502 bitmap_blocks = OCFS2_SUBALLOC_ALLOC;
504 /* we might need to shift tree depth so lets assume an
505 * absolute worst case of complete fragmentation. Even with
506 * that, we only need one update for the dinode, and then
507 * however many metadata chunks needed * a remaining suballoc
509 sysfile_bitmap_blocks = 1 +
510 (OCFS2_SUBALLOC_ALLOC - 1) * ocfs2_extend_meta_needed(root_el);
512 /* this does not include *new* metadata blocks, which are
513 * accounted for in sysfile_bitmap_blocks. root_el +
514 * prev. last_eb_blk + blocks along edge of tree.
515 * calc_symlink_credits passes because we just need 1
516 * credit for the dinode there. */
517 extent_blocks = 1 + 1 + le16_to_cpu(root_el->l_tree_depth);
519 return bitmap_blocks + sysfile_bitmap_blocks + extent_blocks +
520 ocfs2_quota_trans_credits(sb);
523 static inline int ocfs2_calc_symlink_credits(struct super_block *sb)
525 int blocks = ocfs2_mknod_credits(sb, 0, 0);
527 /* links can be longer than one block so we may update many
528 * within our single allocated extent. */
529 blocks += ocfs2_clusters_to_blocks(sb, 1);
531 return blocks + ocfs2_quota_trans_credits(sb);
534 static inline int ocfs2_calc_group_alloc_credits(struct super_block *sb,
538 int bitmap_blocks = OCFS2_SUBALLOC_ALLOC + 1;
539 /* parent inode update + new block group header + bitmap inode update
540 + bitmap blocks affected */
541 blocks = 1 + 1 + 1 + bitmap_blocks;
545 static inline int ocfs2_calc_tree_trunc_credits(struct super_block *sb,
546 unsigned int clusters_to_del,
547 struct ocfs2_dinode *fe,
548 struct ocfs2_extent_list *last_el)
550 /* for dinode + all headers in this pass + update to next leaf */
551 u16 next_free = le16_to_cpu(last_el->l_next_free_rec);
552 u16 tree_depth = le16_to_cpu(fe->id2.i_list.l_tree_depth);
553 int credits = 1 + tree_depth + 1;
559 /* We may be deleting metadata blocks, so metadata alloc dinode +
560 one desc. block for each possible delete. */
561 if (tree_depth && next_free == 1 &&
562 ocfs2_rec_clusters(last_el, &last_el->l_recs[i]) == clusters_to_del)
563 credits += 1 + tree_depth;
565 /* update to the truncate log. */
566 credits += OCFS2_TRUNCATE_LOG_UPDATE;
568 credits += ocfs2_quota_trans_credits(sb);
573 static inline int ocfs2_jbd2_file_inode(handle_t *handle, struct inode *inode)
575 return jbd2_journal_file_inode(handle, &OCFS2_I(inode)->ip_jinode);
578 static inline int ocfs2_begin_ordered_truncate(struct inode *inode,
581 return jbd2_journal_begin_ordered_truncate(
582 OCFS2_SB(inode->i_sb)->journal->j_journal,
583 &OCFS2_I(inode)->ip_jinode,
587 #endif /* OCFS2_JOURNAL_H */