blob: 6163f28badda75a3fe2f3c6cad240ed0f68f70a7 [file] [log] [blame]
Mark Fashehccd979b2005-12-15 14:31:24 -08001/* -*- mode: c; c-basic-offset: 8; -*-
2 * vim: noexpandtab sw=8 ts=8 sts=0:
3 *
4 * journal.h
5 *
6 * Defines journalling api and structures.
7 *
8 * Copyright (C) 2003, 2005 Oracle. All rights reserved.
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public
21 * License along with this program; if not, write to the
22 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 * Boston, MA 021110-1307, USA.
24 */
25
26#ifndef OCFS2_JOURNAL_H
27#define OCFS2_JOURNAL_H
28
29#include <linux/fs.h>
Mark Fasheh53ef99c2008-11-18 16:53:43 -080030#include <linux/jbd2.h>
Mark Fashehccd979b2005-12-15 14:31:24 -080031
Mark Fashehccd979b2005-12-15 14:31:24 -080032enum ocfs2_journal_state {
33 OCFS2_JOURNAL_FREE = 0,
34 OCFS2_JOURNAL_LOADED,
35 OCFS2_JOURNAL_IN_SHUTDOWN,
36};
37
38struct ocfs2_super;
39struct ocfs2_dinode;
Mark Fashehccd979b2005-12-15 14:31:24 -080040
Sunil Mushran96a6c642008-12-16 15:49:16 -080041/*
42 * The recovery_list is a simple linked list of node numbers to recover.
43 * It is protected by the recovery_lock.
44 */
45
46struct ocfs2_recovery_map {
47 unsigned int rm_used;
48 unsigned int *rm_entries;
49};
50
51
Mark Fashehccd979b2005-12-15 14:31:24 -080052struct ocfs2_journal {
53 enum ocfs2_journal_state j_state; /* Journals current state */
54
55 journal_t *j_journal; /* The kernels journal type */
56 struct inode *j_inode; /* Kernel inode pointing to
57 * this journal */
58 struct ocfs2_super *j_osb; /* pointer to the super
59 * block for the node
60 * we're currently
61 * running on -- not
62 * necessarily the super
63 * block from the node
64 * which we usually run
65 * from (recovery,
66 * etc) */
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;
73
74 spinlock_t j_lock;
75 struct list_head j_la_cleanups;
76 struct work_struct j_recovery_work;
77};
78
79extern spinlock_t trans_inc_lock;
80
81/* wrap j_trans_id so we never have it equal to zero. */
82static inline unsigned long ocfs2_inc_trans_id(struct ocfs2_journal *j)
83{
84 unsigned long old_id;
85 spin_lock(&trans_inc_lock);
86 old_id = j->j_trans_id++;
87 if (unlikely(!j->j_trans_id))
88 j->j_trans_id = 1;
89 spin_unlock(&trans_inc_lock);
90 return old_id;
91}
92
Joel Becker0cf2f762009-02-12 16:41:25 -080093static inline void ocfs2_set_ci_lock_trans(struct ocfs2_journal *journal,
94 struct ocfs2_caching_info *ci)
Mark Fashehccd979b2005-12-15 14:31:24 -080095{
96 spin_lock(&trans_inc_lock);
Joel Becker0cf2f762009-02-12 16:41:25 -080097 ci->ci_last_trans = journal->j_trans_id;
Mark Fashehccd979b2005-12-15 14:31:24 -080098 spin_unlock(&trans_inc_lock);
99}
100
101/* Used to figure out whether it's safe to drop a metadata lock on an
Joel Becker0cf2f762009-02-12 16:41:25 -0800102 * cached object. Returns true if all the object's changes have been
Mark Fashehccd979b2005-12-15 14:31:24 -0800103 * 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. */
Joel Becker0cf2f762009-02-12 16:41:25 -0800106static inline int ocfs2_ci_fully_checkpointed(struct ocfs2_caching_info *ci)
Mark Fashehccd979b2005-12-15 14:31:24 -0800107{
108 int ret;
Joel Becker0cf2f762009-02-12 16:41:25 -0800109 struct ocfs2_journal *journal =
110 OCFS2_SB(ocfs2_metadata_cache_get_super(ci))->journal;
Mark Fashehccd979b2005-12-15 14:31:24 -0800111
112 spin_lock(&trans_inc_lock);
Joel Becker0cf2f762009-02-12 16:41:25 -0800113 ret = time_after(journal->j_trans_id, ci->ci_last_trans);
Mark Fashehccd979b2005-12-15 14:31:24 -0800114 spin_unlock(&trans_inc_lock);
115 return ret;
116}
117
Joel Becker0cf2f762009-02-12 16:41:25 -0800118/* 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. */
122static inline int ocfs2_ci_is_new(struct ocfs2_caching_info *ci)
Mark Fashehccd979b2005-12-15 14:31:24 -0800123{
124 int ret;
Joel Becker0cf2f762009-02-12 16:41:25 -0800125 struct ocfs2_journal *journal =
126 OCFS2_SB(ocfs2_metadata_cache_get_super(ci))->journal;
Mark Fashehccd979b2005-12-15 14:31:24 -0800127
Joel Becker0cf2f762009-02-12 16:41:25 -0800128 spin_lock(&trans_inc_lock);
129 ret = !(time_after(journal->j_trans_id, ci->ci_created_trans));
130 if (!ret)
131 ci->ci_created_trans = 0;
132 spin_unlock(&trans_inc_lock);
133 return ret;
134}
135
136/* Wrapper for inodes so we can check system files */
137static inline int ocfs2_inode_is_new(struct inode *inode)
138{
Mark Fashehccd979b2005-12-15 14:31:24 -0800139 /* 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)
143 return 0;
Joel Becker0cf2f762009-02-12 16:41:25 -0800144
145 return ocfs2_ci_is_new(INODE_CACHE(inode));
Mark Fashehccd979b2005-12-15 14:31:24 -0800146}
147
Joel Becker0cf2f762009-02-12 16:41:25 -0800148static inline void ocfs2_ci_set_new(struct ocfs2_super *osb,
149 struct ocfs2_caching_info *ci)
Mark Fashehccd979b2005-12-15 14:31:24 -0800150{
151 spin_lock(&trans_inc_lock);
Joel Becker0cf2f762009-02-12 16:41:25 -0800152 ci->ci_created_trans = osb->journal->j_trans_id;
Mark Fashehccd979b2005-12-15 14:31:24 -0800153 spin_unlock(&trans_inc_lock);
154}
155
Mark Fashehccd979b2005-12-15 14:31:24 -0800156/* Exported only for the journal struct init code in super.c. Do not call. */
Sunil Mushrandf152c22009-06-22 11:40:07 -0700157void ocfs2_orphan_scan_init(struct ocfs2_super *osb);
Jeff Mahoney8b712cd2009-07-07 17:22:12 -0400158void ocfs2_orphan_scan_start(struct ocfs2_super *osb);
Srinivas Eeda83273932009-06-03 17:02:55 -0700159void ocfs2_orphan_scan_stop(struct ocfs2_super *osb);
160void ocfs2_orphan_scan_exit(struct ocfs2_super *osb);
161
David Howellsc4028952006-11-22 14:57:56 +0000162void ocfs2_complete_recovery(struct work_struct *work);
Joel Becker553abd02008-02-01 12:03:57 -0800163void ocfs2_wait_for_recovery(struct ocfs2_super *osb);
164
165int ocfs2_recovery_init(struct ocfs2_super *osb);
166void ocfs2_recovery_exit(struct ocfs2_super *osb);
Mark Fashehccd979b2005-12-15 14:31:24 -0800167
Srinivas Eeda9140db02009-03-06 14:21:46 -0800168int ocfs2_compute_replay_slots(struct ocfs2_super *osb);
Mark Fashehccd979b2005-12-15 14:31:24 -0800169/*
170 * Journal Control:
171 * Initialize, Load, Shutdown, Wipe a journal.
172 *
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
182 * event on.
183 * ocfs2_start_checkpoint - Kick the commit thread to do a checkpoint.
184 */
185void ocfs2_set_journal_params(struct ocfs2_super *osb);
186int ocfs2_journal_init(struct ocfs2_journal *journal,
187 int *dirty);
188void ocfs2_journal_shutdown(struct ocfs2_super *osb);
189int ocfs2_journal_wipe(struct ocfs2_journal *journal,
190 int full);
Sunil Mushran539d8262008-07-14 17:31:10 -0700191int ocfs2_journal_load(struct ocfs2_journal *journal, int local,
192 int replayed);
Mark Fashehccd979b2005-12-15 14:31:24 -0800193int ocfs2_check_journals_nolocks(struct ocfs2_super *osb);
194void ocfs2_recovery_thread(struct ocfs2_super *osb,
195 int node_num);
196int ocfs2_mark_dead_nodes(struct ocfs2_super *osb);
197void ocfs2_complete_mount_recovery(struct ocfs2_super *osb);
Jan Kara22053632008-10-20 23:50:38 +0200198void ocfs2_complete_quota_recovery(struct ocfs2_super *osb);
Mark Fashehccd979b2005-12-15 14:31:24 -0800199
200static inline void ocfs2_start_checkpoint(struct ocfs2_super *osb)
201{
202 atomic_set(&osb->needs_checkpoint, 1);
203 wake_up(&osb->checkpoint_event);
204}
205
206static inline void ocfs2_checkpoint_inode(struct inode *inode)
207{
208 struct ocfs2_super *osb = OCFS2_SB(inode->i_sb);
209
Sunil Mushranc271c5c2006-12-05 17:56:35 -0800210 if (ocfs2_mount_local(osb))
211 return;
212
Joel Becker0cf2f762009-02-12 16:41:25 -0800213 if (!ocfs2_ci_fully_checkpointed(INODE_CACHE(inode))) {
Mark Fashehccd979b2005-12-15 14:31:24 -0800214 /* 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
219 * OK. */
220 ocfs2_start_checkpoint(osb);
221
222 wait_event(osb->journal->j_checkpointed,
Joel Becker0cf2f762009-02-12 16:41:25 -0800223 ocfs2_ci_fully_checkpointed(INODE_CACHE(inode)));
Mark Fashehccd979b2005-12-15 14:31:24 -0800224 }
225}
226
227/*
228 * Transaction Handling:
229 * Manage the lifetime of a transaction handle.
230 *
Mark Fashehccd979b2005-12-15 14:31:24 -0800231 * ocfs2_start_trans - Begin a transaction. Give it an upper estimate of
232 * the number of blocks that will be changed during
233 * this handle.
Mark Fasheh1fabe142006-10-09 18:11:45 -0700234 * 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).
Mark Fashehccd979b2005-12-15 14:31:24 -0800239 * 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.
Joel Becker50655ae2008-09-11 15:53:07 -0700242 * ocfs2_journal_access* - Notify the handle that we want to journal this
Mark Fashehccd979b2005-12-15 14:31:24 -0800243 * buffer. Will have to call ocfs2_journal_dirty once
244 * we've actually dirtied it. Type is one of . or .
Joel Becker50655ae2008-09-11 15:53:07 -0700245 * Always call the specific flavor of
246 * ocfs2_journal_access_*() unless you intend to
247 * manage the checksum by hand.
Mark Fashehccd979b2005-12-15 14:31:24 -0800248 * ocfs2_journal_dirty - Mark a journalled buffer as having dirty data.
Joel Becker2b4e30f2008-09-03 20:03:41 -0700249 * ocfs2_jbd2_file_inode - Mark an inode so that its data goes out before
250 * the current handle commits.
Mark Fashehccd979b2005-12-15 14:31:24 -0800251 */
252
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. */
Mark Fasheh1fabe142006-10-09 18:11:45 -0700256handle_t *ocfs2_start_trans(struct ocfs2_super *osb,
Mark Fashehccd979b2005-12-15 14:31:24 -0800257 int max_buffs);
Mark Fasheh1fabe142006-10-09 18:11:45 -0700258int ocfs2_commit_trans(struct ocfs2_super *osb,
259 handle_t *handle);
Mark Fasheh1fc58142006-10-05 14:15:36 -0700260int ocfs2_extend_trans(handle_t *handle, int nblocks);
Mark Fashehccd979b2005-12-15 14:31:24 -0800261
262/*
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...
267 *
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.
272 */
273#define OCFS2_JOURNAL_ACCESS_CREATE 0
274#define OCFS2_JOURNAL_ACCESS_WRITE 1
275#define OCFS2_JOURNAL_ACCESS_UNDO 2
276
Joel Becker13723d02008-10-17 19:25:01 -0700277
Joel Becker50655ae2008-09-11 15:53:07 -0700278/* ocfs2_inode */
Joel Becker0cf2f762009-02-12 16:41:25 -0800279int ocfs2_journal_access_di(handle_t *handle, struct ocfs2_caching_info *ci,
Joel Becker13723d02008-10-17 19:25:01 -0700280 struct buffer_head *bh, int type);
Joel Becker50655ae2008-09-11 15:53:07 -0700281/* ocfs2_extent_block */
Joel Becker0cf2f762009-02-12 16:41:25 -0800282int ocfs2_journal_access_eb(handle_t *handle, struct ocfs2_caching_info *ci,
Joel Becker50655ae2008-09-11 15:53:07 -0700283 struct buffer_head *bh, int type);
284/* ocfs2_group_desc */
Joel Becker0cf2f762009-02-12 16:41:25 -0800285int ocfs2_journal_access_gd(handle_t *handle, struct ocfs2_caching_info *ci,
Joel Becker50655ae2008-09-11 15:53:07 -0700286 struct buffer_head *bh, int type);
287/* ocfs2_xattr_block */
Joel Becker0cf2f762009-02-12 16:41:25 -0800288int ocfs2_journal_access_xb(handle_t *handle, struct ocfs2_caching_info *ci,
Joel Becker50655ae2008-09-11 15:53:07 -0700289 struct buffer_head *bh, int type);
290/* quota blocks */
Joel Becker0cf2f762009-02-12 16:41:25 -0800291int ocfs2_journal_access_dq(handle_t *handle, struct ocfs2_caching_info *ci,
Joel Becker50655ae2008-09-11 15:53:07 -0700292 struct buffer_head *bh, int type);
293/* dirblock */
Joel Becker0cf2f762009-02-12 16:41:25 -0800294int ocfs2_journal_access_db(handle_t *handle, struct ocfs2_caching_info *ci,
Joel Becker50655ae2008-09-11 15:53:07 -0700295 struct buffer_head *bh, int type);
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800296/* ocfs2_dx_root_block */
Joel Becker0cf2f762009-02-12 16:41:25 -0800297int ocfs2_journal_access_dr(handle_t *handle, struct ocfs2_caching_info *ci,
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800298 struct buffer_head *bh, int type);
299/* ocfs2_dx_leaf */
Joel Becker0cf2f762009-02-12 16:41:25 -0800300int ocfs2_journal_access_dl(handle_t *handle, struct ocfs2_caching_info *ci,
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800301 struct buffer_head *bh, int type);
Joel Becker50655ae2008-09-11 15:53:07 -0700302/* Anything that has no ecc */
Joel Becker0cf2f762009-02-12 16:41:25 -0800303int ocfs2_journal_access(handle_t *handle, struct ocfs2_caching_info *ci,
Joel Becker50655ae2008-09-11 15:53:07 -0700304 struct buffer_head *bh, int type);
305
Mark Fashehccd979b2005-12-15 14:31:24 -0800306/*
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.
316 *
317 * That said, 99% of the time this doesn't matter and this is what the
318 * path looks like:
319 *
320 * <read a bh>
321 * ocfs2_journal_access(handle, bh, OCFS2_JOURNAL_ACCESS_WRITE);
322 * <modify the bh>
323 * ocfs2_journal_dirty(handle, bh);
324 */
Mark Fasheh1fabe142006-10-09 18:11:45 -0700325int ocfs2_journal_dirty(handle_t *handle,
Mark Fashehccd979b2005-12-15 14:31:24 -0800326 struct buffer_head *bh);
Mark Fashehccd979b2005-12-15 14:31:24 -0800327
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
Tiger Yangcf1d6c72008-08-18 17:11:00 +0800340/* extended attribute block update */
341#define OCFS2_XATTR_BLOCK_UPDATE_CREDITS 1
342
Jan Kara05849742009-07-22 13:17:21 +0200343/* Update of a single quota block */
344#define OCFS2_QUOTA_BLOCK_UPDATE_CREDITS 1
Jan Karaa90714c2008-10-09 19:38:40 +0200345
Jan Kara05849742009-07-22 13:17:21 +0200346/* 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
Jan Karaa90714c2008-10-09 19:38:40 +0200351/*
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 */
Jan Kara05849742009-07-22 13:17:21 +0200357#define OCFS2_QWRITE_CREDITS (OCFS2_QINFO_WRITE_CREDITS + \
358 OCFS2_QUOTA_BLOCK_UPDATE_CREDITS)
Jan Karaa90714c2008-10-09 19:38:40 +0200359
360/* global quota data block, local quota data block, global quota inode,
361 * global quota info */
Jan Kara05849742009-07-22 13:17:21 +0200362#define OCFS2_QSYNC_CREDITS (OCFS2_QINFO_WRITE_CREDITS + \
363 2 * OCFS2_QUOTA_BLOCK_UPDATE_CREDITS)
Jan Karaa90714c2008-10-09 19:38:40 +0200364
365static 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
Tao Mad6590722007-12-18 15:47:03 +0800376/* group extend. inode update and last group update. */
377#define OCFS2_GROUP_EXTEND_CREDITS (OCFS2_INODE_UPDATE_CREDITS + 1)
378
Tao Ma7909f2b2007-12-18 15:47:25 +0800379/* group add. inode update and the new group update. */
380#define OCFS2_GROUP_ADD_CREDITS (OCFS2_INODE_UPDATE_CREDITS + 1)
381
Mark Fashehccd979b2005-12-15 14:31:24 -0800382/* get one bit out of a suballocator: dinode + group descriptor +
383 * prev. group desc. if we relink. */
384#define OCFS2_SUBALLOC_ALLOC (3)
385
Jan Karaa90714c2008-10-09 19:38:40 +0200386static 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}
Mark Fasheh1afc32b2007-09-07 14:46:51 -0700391
Mark Fashehccd979b2005-12-15 14:31:24 -0800392/* 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
Jan Karaa90714c2008-10-09 19:38:40 +0200399static 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}
Mark Fasheh063c4562007-07-03 13:34:11 -0700404
Mark Fashehccd979b2005-12-15 14:31:24 -0800405/* data block for new dir/symlink, 2 for bitmap updates (bitmap fe +
Mark Fashehe7c17e42009-01-29 18:17:46 -0800406 * bitmap block for the new bit) dx_root update for free list */
407#define OCFS2_DIR_LINK_ADDITIONAL_CREDITS (1 + 2 + 1)
Mark Fashehccd979b2005-12-15 14:31:24 -0800408
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800409static inline int ocfs2_add_dir_index_credits(struct super_block *sb)
Jan Karaa90714c2008-10-09 19:38:40 +0200410{
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800411 /* 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 */
420static 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 +
Jan Karaa90714c2008-10-09 19:38:40 +0200429 ocfs2_quota_trans_credits(sb);
430}
Mark Fashehccd979b2005-12-15 14:31:24 -0800431
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
Jan Karaa90714c2008-10-09 19:38:40 +0200440/* file update (nlink, etc) + directory mtime/ctime + dir entry block + quota
Mark Fashehe7c17e42009-01-29 18:17:46 -0800441 * update on dir + index leaf + dx root update for free list */
Jan Karaa90714c2008-10-09 19:38:40 +0200442static inline int ocfs2_link_credits(struct super_block *sb)
443{
Mark Fashehe7c17e42009-01-29 18:17:46 -0800444 return 2*OCFS2_INODE_UPDATE_CREDITS + 3 +
Jan Karaa90714c2008-10-09 19:38:40 +0200445 ocfs2_quota_trans_credits(sb);
446}
Mark Fashehccd979b2005-12-15 14:31:24 -0800447
448/* inode + dir inode (if we unlink a dir), + dir entry block + orphan
Mark Fashehe7c17e42009-01-29 18:17:46 -0800449 * dir inode link + dir inode index leaf + dir index root */
Jan Karaa90714c2008-10-09 19:38:40 +0200450static inline int ocfs2_unlink_credits(struct super_block *sb)
451{
452 /* The quota update from ocfs2_link_credits is unused here... */
Mark Fashehe7c17e42009-01-29 18:17:46 -0800453 return 2 * OCFS2_INODE_UPDATE_CREDITS + 3 + ocfs2_link_credits(sb);
Jan Karaa90714c2008-10-09 19:38:40 +0200454}
Mark Fashehccd979b2005-12-15 14:31:24 -0800455
456/* dinode + orphan dir dinode + inode alloc dinode + orphan dir entry +
Joel Beckerdfa13f32009-04-29 17:55:08 -0700457 * 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)
Mark Fashehccd979b2005-12-15 14:31:24 -0800460
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
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800463 * directory + target unlink + 3 x dir index leaves */
Jan Karaa90714c2008-10-09 19:38:40 +0200464static inline int ocfs2_rename_credits(struct super_block *sb)
465{
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800466 return 3 * OCFS2_INODE_UPDATE_CREDITS + 6 + ocfs2_unlink_credits(sb);
Jan Karaa90714c2008-10-09 19:38:40 +0200467}
Mark Fashehccd979b2005-12-15 14:31:24 -0800468
Tiger Yangcf1d6c72008-08-18 17:11:00 +0800469/* 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)
475
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800476/* inode update, removal of dx root block from allocator */
477#define OCFS2_DX_ROOT_REMOVE_CREDITS (OCFS2_INODE_UPDATE_CREDITS + \
478 OCFS2_SUBALLOC_FREE)
479
Mark Fasheh4ed8a6b2008-11-24 17:02:08 -0800480static inline int ocfs2_calc_dxi_expand_credits(struct super_block *sb)
481{
482 int credits = 1 + OCFS2_SUBALLOC_ALLOC;
483
484 credits += ocfs2_clusters_to_blocks(sb, 1);
485 credits += ocfs2_quota_trans_credits(sb);
486
487 return credits;
488}
489
Tao Ma811f9332008-08-18 17:38:43 +0800490/*
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.
494 */
Mark Fashehccd979b2005-12-15 14:31:24 -0800495static inline int ocfs2_calc_extend_credits(struct super_block *sb,
Tao Ma811f9332008-08-18 17:38:43 +0800496 struct ocfs2_extent_list *root_el,
Mark Fashehccd979b2005-12-15 14:31:24 -0800497 u32 bits_wanted)
498{
Tao Ma811f9332008-08-18 17:38:43 +0800499 int bitmap_blocks, sysfile_bitmap_blocks, extent_blocks;
Mark Fashehccd979b2005-12-15 14:31:24 -0800500
501 /* bitmap dinode, group desc. + relinked group. */
502 bitmap_blocks = OCFS2_SUBALLOC_ALLOC;
503
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
508 * alloc. */
509 sysfile_bitmap_blocks = 1 +
Tao Ma811f9332008-08-18 17:38:43 +0800510 (OCFS2_SUBALLOC_ALLOC - 1) * ocfs2_extend_meta_needed(root_el);
Mark Fashehccd979b2005-12-15 14:31:24 -0800511
512 /* this does not include *new* metadata blocks, which are
Tao Ma811f9332008-08-18 17:38:43 +0800513 * accounted for in sysfile_bitmap_blocks. root_el +
Mark Fashehccd979b2005-12-15 14:31:24 -0800514 * 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. */
Tao Ma811f9332008-08-18 17:38:43 +0800517 extent_blocks = 1 + 1 + le16_to_cpu(root_el->l_tree_depth);
Mark Fashehccd979b2005-12-15 14:31:24 -0800518
Jan Karaa90714c2008-10-09 19:38:40 +0200519 return bitmap_blocks + sysfile_bitmap_blocks + extent_blocks +
520 ocfs2_quota_trans_credits(sb);
Mark Fashehccd979b2005-12-15 14:31:24 -0800521}
522
523static inline int ocfs2_calc_symlink_credits(struct super_block *sb)
524{
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800525 int blocks = ocfs2_mknod_credits(sb, 0, 0);
Mark Fashehccd979b2005-12-15 14:31:24 -0800526
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);
530
Jan Karaa90714c2008-10-09 19:38:40 +0200531 return blocks + ocfs2_quota_trans_credits(sb);
Mark Fashehccd979b2005-12-15 14:31:24 -0800532}
533
534static inline int ocfs2_calc_group_alloc_credits(struct super_block *sb,
535 unsigned int cpg)
536{
537 int blocks;
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;
542 return blocks;
543}
544
545static 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)
549{
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;
554 int i;
555
556 i = next_free - 1;
557 BUG_ON(i < 0);
558
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 &&
Mark Fashehe48edee2007-03-07 16:46:57 -0800562 ocfs2_rec_clusters(last_el, &last_el->l_recs[i]) == clusters_to_del)
Mark Fashehccd979b2005-12-15 14:31:24 -0800563 credits += 1 + tree_depth;
564
565 /* update to the truncate log. */
566 credits += OCFS2_TRUNCATE_LOG_UPDATE;
567
Jan Karaa90714c2008-10-09 19:38:40 +0200568 credits += ocfs2_quota_trans_credits(sb);
569
Mark Fashehccd979b2005-12-15 14:31:24 -0800570 return credits;
571}
572
Joel Becker2b4e30f2008-09-03 20:03:41 -0700573static inline int ocfs2_jbd2_file_inode(handle_t *handle, struct inode *inode)
574{
575 return jbd2_journal_file_inode(handle, &OCFS2_I(inode)->ip_jinode);
576}
577
578static inline int ocfs2_begin_ordered_truncate(struct inode *inode,
579 loff_t new_size)
580{
Jan Kara7f5aa212009-02-10 11:15:34 -0500581 return jbd2_journal_begin_ordered_truncate(
582 OCFS2_SB(inode->i_sb)->journal->j_journal,
583 &OCFS2_I(inode)->ip_jinode,
584 new_size);
Joel Becker2b4e30f2008-09-03 20:03:41 -0700585}
586
Mark Fashehccd979b2005-12-15 14:31:24 -0800587#endif /* OCFS2_JOURNAL_H */