blob: c0fe6ed08ab12dd5715eb2b6f766152943602830 [file] [log] [blame]
Thomas Gleixner328970d2019-05-24 12:04:05 +02001/* SPDX-License-Identifier: GPL-2.0-or-later */
Mark Fashehccd979b2005-12-15 14:31:24 -08002/* -*- mode: c; c-basic-offset: 8; -*-
3 * vim: noexpandtab sw=8 ts=8 sts=0:
4 *
5 * journal.h
6 *
7 * Defines journalling api and structures.
8 *
9 * Copyright (C) 2003, 2005 Oracle. All rights reserved.
Mark Fashehccd979b2005-12-15 14:31:24 -080010 */
11
12#ifndef OCFS2_JOURNAL_H
13#define OCFS2_JOURNAL_H
14
15#include <linux/fs.h>
Mark Fasheh53ef99c2008-11-18 16:53:43 -080016#include <linux/jbd2.h>
Mark Fashehccd979b2005-12-15 14:31:24 -080017
Mark Fashehccd979b2005-12-15 14:31:24 -080018enum ocfs2_journal_state {
19 OCFS2_JOURNAL_FREE = 0,
20 OCFS2_JOURNAL_LOADED,
21 OCFS2_JOURNAL_IN_SHUTDOWN,
22};
23
24struct ocfs2_super;
25struct ocfs2_dinode;
Mark Fashehccd979b2005-12-15 14:31:24 -080026
Sunil Mushran96a6c642008-12-16 15:49:16 -080027/*
28 * The recovery_list is a simple linked list of node numbers to recover.
29 * It is protected by the recovery_lock.
30 */
31
32struct ocfs2_recovery_map {
33 unsigned int rm_used;
34 unsigned int *rm_entries;
35};
36
37
Mark Fashehccd979b2005-12-15 14:31:24 -080038struct ocfs2_journal {
39 enum ocfs2_journal_state j_state; /* Journals current state */
40
41 journal_t *j_journal; /* The kernels journal type */
42 struct inode *j_inode; /* Kernel inode pointing to
43 * this journal */
44 struct ocfs2_super *j_osb; /* pointer to the super
45 * block for the node
46 * we're currently
47 * running on -- not
48 * necessarily the super
49 * block from the node
50 * which we usually run
51 * from (recovery,
52 * etc) */
53 struct buffer_head *j_bh; /* Journal disk inode block */
54 atomic_t j_num_trans; /* Number of transactions
55 * currently in the system. */
Goldwyn Rodrigues83fd9c72010-06-10 17:21:36 -050056 spinlock_t j_lock;
Mark Fashehccd979b2005-12-15 14:31:24 -080057 unsigned long j_trans_id;
58 struct rw_semaphore j_trans_barrier;
59 wait_queue_head_t j_checkpointed;
60
Goldwyn Rodrigues83fd9c72010-06-10 17:21:36 -050061 /* both fields protected by j_lock*/
Mark Fashehccd979b2005-12-15 14:31:24 -080062 struct list_head j_la_cleanups;
63 struct work_struct j_recovery_work;
64};
65
66extern spinlock_t trans_inc_lock;
67
68/* wrap j_trans_id so we never have it equal to zero. */
69static inline unsigned long ocfs2_inc_trans_id(struct ocfs2_journal *j)
70{
71 unsigned long old_id;
72 spin_lock(&trans_inc_lock);
73 old_id = j->j_trans_id++;
74 if (unlikely(!j->j_trans_id))
75 j->j_trans_id = 1;
76 spin_unlock(&trans_inc_lock);
77 return old_id;
78}
79
Joel Becker0cf2f762009-02-12 16:41:25 -080080static inline void ocfs2_set_ci_lock_trans(struct ocfs2_journal *journal,
81 struct ocfs2_caching_info *ci)
Mark Fashehccd979b2005-12-15 14:31:24 -080082{
83 spin_lock(&trans_inc_lock);
Joel Becker0cf2f762009-02-12 16:41:25 -080084 ci->ci_last_trans = journal->j_trans_id;
Mark Fashehccd979b2005-12-15 14:31:24 -080085 spin_unlock(&trans_inc_lock);
86}
87
88/* Used to figure out whether it's safe to drop a metadata lock on an
Joel Becker0cf2f762009-02-12 16:41:25 -080089 * cached object. Returns true if all the object's changes have been
Mark Fashehccd979b2005-12-15 14:31:24 -080090 * checkpointed to disk. You should be holding the spinlock on the
91 * metadata lock while calling this to be sure that nobody can take
92 * the lock and put it on another transaction. */
Joel Becker0cf2f762009-02-12 16:41:25 -080093static inline int ocfs2_ci_fully_checkpointed(struct ocfs2_caching_info *ci)
Mark Fashehccd979b2005-12-15 14:31:24 -080094{
95 int ret;
Joel Becker0cf2f762009-02-12 16:41:25 -080096 struct ocfs2_journal *journal =
97 OCFS2_SB(ocfs2_metadata_cache_get_super(ci))->journal;
Mark Fashehccd979b2005-12-15 14:31:24 -080098
99 spin_lock(&trans_inc_lock);
Joel Becker0cf2f762009-02-12 16:41:25 -0800100 ret = time_after(journal->j_trans_id, ci->ci_last_trans);
Mark Fashehccd979b2005-12-15 14:31:24 -0800101 spin_unlock(&trans_inc_lock);
102 return ret;
103}
104
Joel Becker0cf2f762009-02-12 16:41:25 -0800105/* convenience function to check if an object backed by struct
106 * ocfs2_caching_info is still new (has never hit disk) Will do you a
107 * favor and set created_trans = 0 when you've
108 * been checkpointed. returns '1' if the ci is still new. */
109static inline int ocfs2_ci_is_new(struct ocfs2_caching_info *ci)
Mark Fashehccd979b2005-12-15 14:31:24 -0800110{
111 int ret;
Joel Becker0cf2f762009-02-12 16:41:25 -0800112 struct ocfs2_journal *journal =
113 OCFS2_SB(ocfs2_metadata_cache_get_super(ci))->journal;
Mark Fashehccd979b2005-12-15 14:31:24 -0800114
Joel Becker0cf2f762009-02-12 16:41:25 -0800115 spin_lock(&trans_inc_lock);
116 ret = !(time_after(journal->j_trans_id, ci->ci_created_trans));
117 if (!ret)
118 ci->ci_created_trans = 0;
119 spin_unlock(&trans_inc_lock);
120 return ret;
121}
122
123/* Wrapper for inodes so we can check system files */
124static inline int ocfs2_inode_is_new(struct inode *inode)
125{
Mark Fashehccd979b2005-12-15 14:31:24 -0800126 /* System files are never "new" as they're written out by
127 * mkfs. This helps us early during mount, before we have the
128 * journal open and j_trans_id could be junk. */
129 if (OCFS2_I(inode)->ip_flags & OCFS2_INODE_SYSTEM_FILE)
130 return 0;
Joel Becker0cf2f762009-02-12 16:41:25 -0800131
132 return ocfs2_ci_is_new(INODE_CACHE(inode));
Mark Fashehccd979b2005-12-15 14:31:24 -0800133}
134
Joel Becker0cf2f762009-02-12 16:41:25 -0800135static inline void ocfs2_ci_set_new(struct ocfs2_super *osb,
136 struct ocfs2_caching_info *ci)
Mark Fashehccd979b2005-12-15 14:31:24 -0800137{
138 spin_lock(&trans_inc_lock);
Joel Becker0cf2f762009-02-12 16:41:25 -0800139 ci->ci_created_trans = osb->journal->j_trans_id;
Mark Fashehccd979b2005-12-15 14:31:24 -0800140 spin_unlock(&trans_inc_lock);
141}
142
Mark Fashehccd979b2005-12-15 14:31:24 -0800143/* Exported only for the journal struct init code in super.c. Do not call. */
Sunil Mushrandf152c22009-06-22 11:40:07 -0700144void ocfs2_orphan_scan_init(struct ocfs2_super *osb);
Jeff Mahoney8b712cd2009-07-07 17:22:12 -0400145void ocfs2_orphan_scan_start(struct ocfs2_super *osb);
Srinivas Eeda83273932009-06-03 17:02:55 -0700146void ocfs2_orphan_scan_stop(struct ocfs2_super *osb);
147void ocfs2_orphan_scan_exit(struct ocfs2_super *osb);
148
David Howellsc4028952006-11-22 14:57:56 +0000149void ocfs2_complete_recovery(struct work_struct *work);
Joel Becker553abd02008-02-01 12:03:57 -0800150void ocfs2_wait_for_recovery(struct ocfs2_super *osb);
151
152int ocfs2_recovery_init(struct ocfs2_super *osb);
153void ocfs2_recovery_exit(struct ocfs2_super *osb);
Mark Fashehccd979b2005-12-15 14:31:24 -0800154
Srinivas Eeda9140db02009-03-06 14:21:46 -0800155int ocfs2_compute_replay_slots(struct ocfs2_super *osb);
Mark Fashehccd979b2005-12-15 14:31:24 -0800156/*
157 * Journal Control:
158 * Initialize, Load, Shutdown, Wipe a journal.
159 *
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 */
172void ocfs2_set_journal_params(struct ocfs2_super *osb);
173int ocfs2_journal_init(struct ocfs2_journal *journal,
174 int *dirty);
175void ocfs2_journal_shutdown(struct ocfs2_super *osb);
176int ocfs2_journal_wipe(struct ocfs2_journal *journal,
177 int full);
Sunil Mushran539d8262008-07-14 17:31:10 -0700178int ocfs2_journal_load(struct ocfs2_journal *journal, int local,
179 int replayed);
Mark Fashehccd979b2005-12-15 14:31:24 -0800180int ocfs2_check_journals_nolocks(struct ocfs2_super *osb);
181void ocfs2_recovery_thread(struct ocfs2_super *osb,
182 int node_num);
183int ocfs2_mark_dead_nodes(struct ocfs2_super *osb);
184void ocfs2_complete_mount_recovery(struct ocfs2_super *osb);
Jan Kara22053632008-10-20 23:50:38 +0200185void ocfs2_complete_quota_recovery(struct ocfs2_super *osb);
Mark Fashehccd979b2005-12-15 14:31:24 -0800186
187static inline void ocfs2_start_checkpoint(struct ocfs2_super *osb)
188{
Mark Fashehccd979b2005-12-15 14:31:24 -0800189 wake_up(&osb->checkpoint_event);
190}
191
192static inline void ocfs2_checkpoint_inode(struct inode *inode)
193{
194 struct ocfs2_super *osb = OCFS2_SB(inode->i_sb);
195
Sunil Mushranc271c5c2006-12-05 17:56:35 -0800196 if (ocfs2_mount_local(osb))
197 return;
198
Joel Becker0cf2f762009-02-12 16:41:25 -0800199 if (!ocfs2_ci_fully_checkpointed(INODE_CACHE(inode))) {
Mark Fashehccd979b2005-12-15 14:31:24 -0800200 /* 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
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300203 * wind up waiting *a lot* longer than necessary. Right
Mark Fashehccd979b2005-12-15 14:31:24 -0800204 * 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,
Joel Becker0cf2f762009-02-12 16:41:25 -0800209 ocfs2_ci_fully_checkpointed(INODE_CACHE(inode)));
Mark Fashehccd979b2005-12-15 14:31:24 -0800210 }
211}
212
213/*
214 * Transaction Handling:
215 * Manage the lifetime of a transaction handle.
216 *
Mark Fashehccd979b2005-12-15 14:31:24 -0800217 * 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.
Mark Fasheh1fabe142006-10-09 18:11:45 -0700220 * 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).
Mark Fashehccd979b2005-12-15 14:31:24 -0800225 * 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.
Joel Becker50655ae2008-09-11 15:53:07 -0700228 * ocfs2_journal_access* - Notify the handle that we want to journal this
Mark Fashehccd979b2005-12-15 14:31:24 -0800229 * buffer. Will have to call ocfs2_journal_dirty once
230 * we've actually dirtied it. Type is one of . or .
Joel Becker50655ae2008-09-11 15:53:07 -0700231 * Always call the specific flavor of
232 * ocfs2_journal_access_*() unless you intend to
233 * manage the checksum by hand.
Mark Fashehccd979b2005-12-15 14:31:24 -0800234 * ocfs2_journal_dirty - Mark a journalled buffer as having dirty data.
Joel Becker2b4e30f2008-09-03 20:03:41 -0700235 * ocfs2_jbd2_file_inode - Mark an inode so that its data goes out before
236 * the current handle commits.
Mark Fashehccd979b2005-12-15 14:31:24 -0800237 */
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. */
Mark Fasheh1fabe142006-10-09 18:11:45 -0700242handle_t *ocfs2_start_trans(struct ocfs2_super *osb,
Mark Fashehccd979b2005-12-15 14:31:24 -0800243 int max_buffs);
Mark Fasheh1fabe142006-10-09 18:11:45 -0700244int ocfs2_commit_trans(struct ocfs2_super *osb,
245 handle_t *handle);
Mark Fasheh1fc58142006-10-05 14:15:36 -0700246int ocfs2_extend_trans(handle_t *handle, int nblocks);
Younger Liu2b1e55c2013-09-11 14:19:44 -0700247int ocfs2_allocate_extend_trans(handle_t *handle,
248 int thresh);
249
250/*
251 * Define an arbitrary limit for the amount of data we will anticipate
252 * writing to any given transaction. For unbounded transactions such as
253 * fallocate(2) we can write more than this, but we always
254 * start off at the maximum transaction size and grow the transaction
255 * optimistically as we go.
256 */
257#define OCFS2_MAX_TRANS_DATA 64U
Mark Fashehccd979b2005-12-15 14:31:24 -0800258
259/*
260 * Create access is for when we get a newly created buffer and we're
261 * not gonna read it off disk, but rather fill it ourselves. Right
262 * now, we don't do anything special with this (it turns into a write
263 * request), but this is a good placeholder in case we do...
264 *
265 * Write access is for when we read a block off disk and are going to
266 * modify it. This way the journalling layer knows it may need to make
267 * a copy of that block (if it's part of another, uncommitted
268 * transaction) before we do so.
269 */
270#define OCFS2_JOURNAL_ACCESS_CREATE 0
271#define OCFS2_JOURNAL_ACCESS_WRITE 1
272#define OCFS2_JOURNAL_ACCESS_UNDO 2
273
Joel Becker13723d02008-10-17 19:25:01 -0700274
Joel Becker50655ae2008-09-11 15:53:07 -0700275/* ocfs2_inode */
Joel Becker0cf2f762009-02-12 16:41:25 -0800276int ocfs2_journal_access_di(handle_t *handle, struct ocfs2_caching_info *ci,
Joel Becker13723d02008-10-17 19:25:01 -0700277 struct buffer_head *bh, int type);
Joel Becker50655ae2008-09-11 15:53:07 -0700278/* ocfs2_extent_block */
Joel Becker0cf2f762009-02-12 16:41:25 -0800279int ocfs2_journal_access_eb(handle_t *handle, struct ocfs2_caching_info *ci,
Joel Becker50655ae2008-09-11 15:53:07 -0700280 struct buffer_head *bh, int type);
Tao Ma93c97082009-08-18 11:19:20 +0800281/* ocfs2_refcount_block */
282int ocfs2_journal_access_rb(handle_t *handle, struct ocfs2_caching_info *ci,
283 struct buffer_head *bh, int type);
Joel Becker50655ae2008-09-11 15:53:07 -0700284/* 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 */
Joel Beckerec20cec2010-03-19 14:13:52 -0700325void ocfs2_journal_dirty(handle_t *handle, struct buffer_head *bh);
Mark Fashehccd979b2005-12-15 14:31:24 -0800326
327/*
328 * Credit Macros:
329 * Convenience macros to calculate number of credits needed.
330 *
331 * For convenience sake, I have a set of macros here which calculate
332 * the *maximum* number of sectors which will be changed for various
333 * metadata updates.
334 */
335
336/* simple file updates like chmod, etc. */
337#define OCFS2_INODE_UPDATE_CREDITS 1
338
Tiger Yangcf1d6c72008-08-18 17:11:00 +0800339/* extended attribute block update */
340#define OCFS2_XATTR_BLOCK_UPDATE_CREDITS 1
341
Jan Kara05849742009-07-22 13:17:21 +0200342/* Update of a single quota block */
343#define OCFS2_QUOTA_BLOCK_UPDATE_CREDITS 1
Jan Karaa90714c2008-10-09 19:38:40 +0200344
Jan Kara05849742009-07-22 13:17:21 +0200345/* global quotafile inode update, data block */
346#define OCFS2_QINFO_WRITE_CREDITS (OCFS2_INODE_UPDATE_CREDITS + \
347 OCFS2_QUOTA_BLOCK_UPDATE_CREDITS)
348
349#define OCFS2_LOCAL_QINFO_WRITE_CREDITS OCFS2_QUOTA_BLOCK_UPDATE_CREDITS
Jan Karaa90714c2008-10-09 19:38:40 +0200350/*
351 * The two writes below can accidentally see global info dirty due
352 * to set_info() quotactl so make them prepared for the writes.
353 */
354/* quota data block, global info */
355/* Write to local quota file */
Jan Kara05849742009-07-22 13:17:21 +0200356#define OCFS2_QWRITE_CREDITS (OCFS2_QINFO_WRITE_CREDITS + \
357 OCFS2_QUOTA_BLOCK_UPDATE_CREDITS)
Jan Karaa90714c2008-10-09 19:38:40 +0200358
359/* global quota data block, local quota data block, global quota inode,
360 * global quota info */
Jan Kara05849742009-07-22 13:17:21 +0200361#define OCFS2_QSYNC_CREDITS (OCFS2_QINFO_WRITE_CREDITS + \
362 2 * OCFS2_QUOTA_BLOCK_UPDATE_CREDITS)
Jan Karaa90714c2008-10-09 19:38:40 +0200363
364static inline int ocfs2_quota_trans_credits(struct super_block *sb)
365{
366 int credits = 0;
367
368 if (OCFS2_HAS_RO_COMPAT_FEATURE(sb, OCFS2_FEATURE_RO_COMPAT_USRQUOTA))
369 credits += OCFS2_QWRITE_CREDITS;
370 if (OCFS2_HAS_RO_COMPAT_FEATURE(sb, OCFS2_FEATURE_RO_COMPAT_GRPQUOTA))
371 credits += OCFS2_QWRITE_CREDITS;
372 return credits;
373}
374
Tao Mad6590722007-12-18 15:47:03 +0800375/* group extend. inode update and last group update. */
376#define OCFS2_GROUP_EXTEND_CREDITS (OCFS2_INODE_UPDATE_CREDITS + 1)
377
Tao Ma7909f2b2007-12-18 15:47:25 +0800378/* group add. inode update and the new group update. */
379#define OCFS2_GROUP_ADD_CREDITS (OCFS2_INODE_UPDATE_CREDITS + 1)
380
Mark Fashehccd979b2005-12-15 14:31:24 -0800381/* get one bit out of a suballocator: dinode + group descriptor +
382 * prev. group desc. if we relink. */
383#define OCFS2_SUBALLOC_ALLOC (3)
384
Jan Karaa90714c2008-10-09 19:38:40 +0200385static inline int ocfs2_inline_to_extents_credits(struct super_block *sb)
386{
387 return OCFS2_SUBALLOC_ALLOC + OCFS2_INODE_UPDATE_CREDITS +
388 ocfs2_quota_trans_credits(sb);
389}
Mark Fasheh1afc32b2007-09-07 14:46:51 -0700390
Mark Fashehccd979b2005-12-15 14:31:24 -0800391/* dinode + group descriptor update. We don't relink on free yet. */
392#define OCFS2_SUBALLOC_FREE (2)
393
394#define OCFS2_TRUNCATE_LOG_UPDATE OCFS2_INODE_UPDATE_CREDITS
395#define OCFS2_TRUNCATE_LOG_FLUSH_ONE_REC (OCFS2_SUBALLOC_FREE \
396 + OCFS2_TRUNCATE_LOG_UPDATE)
397
Jan Karaa90714c2008-10-09 19:38:40 +0200398static inline int ocfs2_remove_extent_credits(struct super_block *sb)
399{
400 return OCFS2_TRUNCATE_LOG_UPDATE + OCFS2_INODE_UPDATE_CREDITS +
401 ocfs2_quota_trans_credits(sb);
402}
Mark Fasheh063c4562007-07-03 13:34:11 -0700403
Jan Kara705773a2011-02-03 14:16:19 +0100404/* data block for new dir/symlink, allocation of directory block, dx_root
405 * update for free list */
406#define OCFS2_DIR_LINK_ADDITIONAL_CREDITS (1 + OCFS2_SUBALLOC_ALLOC + 1)
Mark Fashehccd979b2005-12-15 14:31:24 -0800407
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800408static inline int ocfs2_add_dir_index_credits(struct super_block *sb)
Jan Karaa90714c2008-10-09 19:38:40 +0200409{
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800410 /* 1 block for index, 2 allocs (data, metadata), 1 clusters
411 * worth of blocks for initial extent. */
412 return 1 + 2 * OCFS2_SUBALLOC_ALLOC +
413 ocfs2_clusters_to_blocks(sb, 1);
414}
415
416/* parent fe, parent block, new file entry, index leaf, inode alloc fe, inode
417 * alloc group descriptor + mkdir/symlink blocks + dir blocks + xattr
418 * blocks + quota update */
419static inline int ocfs2_mknod_credits(struct super_block *sb, int is_dir,
420 int xattr_credits)
421{
422 int dir_credits = OCFS2_DIR_LINK_ADDITIONAL_CREDITS;
423
424 if (is_dir)
425 dir_credits += ocfs2_add_dir_index_credits(sb);
426
427 return 4 + OCFS2_SUBALLOC_ALLOC + dir_credits + xattr_credits +
Jan Karaa90714c2008-10-09 19:38:40 +0200428 ocfs2_quota_trans_credits(sb);
429}
Mark Fashehccd979b2005-12-15 14:31:24 -0800430
431/* local alloc metadata change + main bitmap updates */
432#define OCFS2_WINDOW_MOVE_CREDITS (OCFS2_INODE_UPDATE_CREDITS \
433 + OCFS2_SUBALLOC_ALLOC + OCFS2_SUBALLOC_FREE)
434
435/* used when we don't need an allocation change for a dir extend. One
436 * for the dinode, one for the new block. */
437#define OCFS2_SIMPLE_DIR_EXTEND_CREDITS (2)
438
Jan Karaa90714c2008-10-09 19:38:40 +0200439/* file update (nlink, etc) + directory mtime/ctime + dir entry block + quota
Xiaowei.Hu0393afe2011-10-19 09:34:19 +0800440 * update on dir + index leaf + dx root update for free list +
441 * previous dirblock update in the free list */
Jan Karaa90714c2008-10-09 19:38:40 +0200442static inline int ocfs2_link_credits(struct super_block *sb)
443{
Xiaowei.Hu0393afe2011-10-19 09:34:19 +0800444 return 2*OCFS2_INODE_UPDATE_CREDITS + 4 +
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
Joseph Qi06ee5c72015-02-16 15:59:54 -0800461/* dinode + orphan dir dinode + extent tree leaf block + orphan dir entry +
462 * orphan dir index root + orphan dir index leaf */
463#define OCFS2_INODE_ADD_TO_ORPHAN_CREDITS (2 * OCFS2_INODE_UPDATE_CREDITS + 4)
464#define OCFS2_INODE_DEL_FROM_ORPHAN_CREDITS OCFS2_INODE_ADD_TO_ORPHAN_CREDITS
465
Mark Fashehccd979b2005-12-15 14:31:24 -0800466/* dinode update, old dir dinode update, new dir dinode update, old
467 * dir dir entry, new dir dir entry, dir entry update for renaming
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800468 * directory + target unlink + 3 x dir index leaves */
Jan Karaa90714c2008-10-09 19:38:40 +0200469static inline int ocfs2_rename_credits(struct super_block *sb)
470{
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800471 return 3 * OCFS2_INODE_UPDATE_CREDITS + 6 + ocfs2_unlink_credits(sb);
Jan Karaa90714c2008-10-09 19:38:40 +0200472}
Mark Fashehccd979b2005-12-15 14:31:24 -0800473
Tiger Yangcf1d6c72008-08-18 17:11:00 +0800474/* global bitmap dinode, group desc., relinked group,
475 * suballocator dinode, group desc., relinked group,
476 * dinode, xattr block */
477#define OCFS2_XATTR_BLOCK_CREATE_CREDITS (OCFS2_SUBALLOC_ALLOC * 2 + \
478 + OCFS2_INODE_UPDATE_CREDITS \
479 + OCFS2_XATTR_BLOCK_UPDATE_CREDITS)
480
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800481/* inode update, removal of dx root block from allocator */
482#define OCFS2_DX_ROOT_REMOVE_CREDITS (OCFS2_INODE_UPDATE_CREDITS + \
483 OCFS2_SUBALLOC_FREE)
484
Mark Fasheh4ed8a6b2008-11-24 17:02:08 -0800485static inline int ocfs2_calc_dxi_expand_credits(struct super_block *sb)
486{
487 int credits = 1 + OCFS2_SUBALLOC_ALLOC;
488
489 credits += ocfs2_clusters_to_blocks(sb, 1);
490 credits += ocfs2_quota_trans_credits(sb);
491
492 return credits;
493}
494
Tao Ma8bf396d2009-08-24 11:12:02 +0800495/* inode update, new refcount block and its allocation credits. */
496#define OCFS2_REFCOUNT_TREE_CREATE_CREDITS (OCFS2_INODE_UPDATE_CREDITS + 1 \
497 + OCFS2_SUBALLOC_ALLOC)
498
499/* inode and the refcount block update. */
500#define OCFS2_REFCOUNT_TREE_SET_CREDITS (OCFS2_INODE_UPDATE_CREDITS + 1)
501
502/*
503 * inode and the refcount block update.
504 * It doesn't include the credits for sub alloc change.
505 * So if we need to free the bit, OCFS2_SUBALLOC_FREE needs to be added.
506 */
507#define OCFS2_REFCOUNT_TREE_REMOVE_CREDITS (OCFS2_INODE_UPDATE_CREDITS + 1)
508
Tao Mabcbbb242009-08-18 11:29:12 +0800509/* 2 metadata alloc, 2 new blocks and root refcount block */
510#define OCFS2_EXPAND_REFCOUNT_TREE_CREDITS (OCFS2_SUBALLOC_ALLOC * 2 + 3)
511
Tao Ma811f9332008-08-18 17:38:43 +0800512/*
513 * Please note that the caller must make sure that root_el is the root
514 * of extent tree. So for an inode, it should be &fe->id2.i_list. Otherwise
515 * the result may be wrong.
516 */
Mark Fashehccd979b2005-12-15 14:31:24 -0800517static inline int ocfs2_calc_extend_credits(struct super_block *sb,
Goldwyn Rodrigues06f9da62013-11-12 15:06:52 -0800518 struct ocfs2_extent_list *root_el)
Mark Fashehccd979b2005-12-15 14:31:24 -0800519{
Tao Ma811f9332008-08-18 17:38:43 +0800520 int bitmap_blocks, sysfile_bitmap_blocks, extent_blocks;
Mark Fashehccd979b2005-12-15 14:31:24 -0800521
522 /* bitmap dinode, group desc. + relinked group. */
523 bitmap_blocks = OCFS2_SUBALLOC_ALLOC;
524
525 /* we might need to shift tree depth so lets assume an
526 * absolute worst case of complete fragmentation. Even with
527 * that, we only need one update for the dinode, and then
528 * however many metadata chunks needed * a remaining suballoc
529 * alloc. */
530 sysfile_bitmap_blocks = 1 +
Tao Ma811f9332008-08-18 17:38:43 +0800531 (OCFS2_SUBALLOC_ALLOC - 1) * ocfs2_extend_meta_needed(root_el);
Mark Fashehccd979b2005-12-15 14:31:24 -0800532
533 /* this does not include *new* metadata blocks, which are
Tao Ma811f9332008-08-18 17:38:43 +0800534 * accounted for in sysfile_bitmap_blocks. root_el +
Mark Fashehccd979b2005-12-15 14:31:24 -0800535 * prev. last_eb_blk + blocks along edge of tree.
536 * calc_symlink_credits passes because we just need 1
537 * credit for the dinode there. */
Tao Ma811f9332008-08-18 17:38:43 +0800538 extent_blocks = 1 + 1 + le16_to_cpu(root_el->l_tree_depth);
Mark Fashehccd979b2005-12-15 14:31:24 -0800539
Jan Karaa90714c2008-10-09 19:38:40 +0200540 return bitmap_blocks + sysfile_bitmap_blocks + extent_blocks +
Jie Liu6115ea22013-08-13 16:00:57 -0700541 ocfs2_quota_trans_credits(sb);
Mark Fashehccd979b2005-12-15 14:31:24 -0800542}
543
544static inline int ocfs2_calc_symlink_credits(struct super_block *sb)
545{
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800546 int blocks = ocfs2_mknod_credits(sb, 0, 0);
Mark Fashehccd979b2005-12-15 14:31:24 -0800547
548 /* links can be longer than one block so we may update many
549 * within our single allocated extent. */
550 blocks += ocfs2_clusters_to_blocks(sb, 1);
551
Jan Karaa90714c2008-10-09 19:38:40 +0200552 return blocks + ocfs2_quota_trans_credits(sb);
Mark Fashehccd979b2005-12-15 14:31:24 -0800553}
554
555static inline int ocfs2_calc_group_alloc_credits(struct super_block *sb,
556 unsigned int cpg)
557{
558 int blocks;
559 int bitmap_blocks = OCFS2_SUBALLOC_ALLOC + 1;
560 /* parent inode update + new block group header + bitmap inode update
561 + bitmap blocks affected */
562 blocks = 1 + 1 + 1 + bitmap_blocks;
563 return blocks;
564}
565
Joel Becker8b06bc52010-03-26 10:09:29 +0800566/*
567 * Allocating a discontiguous block group requires the credits from
568 * ocfs2_calc_group_alloc_credits() as well as enough credits to fill
569 * the group descriptor's extent list. The caller already has started
570 * the transaction with ocfs2_calc_group_alloc_credits(). They extend
571 * it with these credits.
572 */
573static inline int ocfs2_calc_bg_discontig_credits(struct super_block *sb)
574{
575 return ocfs2_extent_recs_per_gd(sb);
576}
577
Mark Fashehccd979b2005-12-15 14:31:24 -0800578static inline int ocfs2_calc_tree_trunc_credits(struct super_block *sb,
579 unsigned int clusters_to_del,
580 struct ocfs2_dinode *fe,
581 struct ocfs2_extent_list *last_el)
582{
583 /* for dinode + all headers in this pass + update to next leaf */
584 u16 next_free = le16_to_cpu(last_el->l_next_free_rec);
585 u16 tree_depth = le16_to_cpu(fe->id2.i_list.l_tree_depth);
586 int credits = 1 + tree_depth + 1;
587 int i;
588
589 i = next_free - 1;
590 BUG_ON(i < 0);
591
592 /* We may be deleting metadata blocks, so metadata alloc dinode +
593 one desc. block for each possible delete. */
594 if (tree_depth && next_free == 1 &&
Mark Fashehe48edee2007-03-07 16:46:57 -0800595 ocfs2_rec_clusters(last_el, &last_el->l_recs[i]) == clusters_to_del)
Mark Fashehccd979b2005-12-15 14:31:24 -0800596 credits += 1 + tree_depth;
597
598 /* update to the truncate log. */
599 credits += OCFS2_TRUNCATE_LOG_UPDATE;
600
Jan Karaa90714c2008-10-09 19:38:40 +0200601 credits += ocfs2_quota_trans_credits(sb);
602
Mark Fashehccd979b2005-12-15 14:31:24 -0800603 return credits;
604}
605
Joel Becker2b4e30f2008-09-03 20:03:41 -0700606static inline int ocfs2_jbd2_file_inode(handle_t *handle, struct inode *inode)
607{
Jan Kara41617e12016-04-24 00:56:07 -0400608 return jbd2_journal_inode_add_write(handle, &OCFS2_I(inode)->ip_jinode);
Joel Becker2b4e30f2008-09-03 20:03:41 -0700609}
610
611static inline int ocfs2_begin_ordered_truncate(struct inode *inode,
612 loff_t new_size)
613{
Jan Kara7f5aa212009-02-10 11:15:34 -0500614 return jbd2_journal_begin_ordered_truncate(
615 OCFS2_SB(inode->i_sb)->journal->j_journal,
616 &OCFS2_I(inode)->ip_jinode,
617 new_size);
Joel Becker2b4e30f2008-09-03 20:03:41 -0700618}
619
Darrick J. Wong2931cdc2014-04-03 14:46:48 -0700620static inline void ocfs2_update_inode_fsync_trans(handle_t *handle,
621 struct inode *inode,
622 int datasync)
623{
624 struct ocfs2_inode_info *oi = OCFS2_I(inode);
625
626 oi->i_sync_tid = handle->h_transaction->t_tid;
627 if (datasync)
628 oi->i_datasync_tid = handle->h_transaction->t_tid;
629}
630
Mark Fashehccd979b2005-12-15 14:31:24 -0800631#endif /* OCFS2_JOURNAL_H */