[linux-block.git] / fs / ext4 / ext4_jbd2.h

// SPDX-License-Identifier: GPL-2.0+
/*
 * ext4_jbd2.h
 *
 * Written by Stephen C. Tweedie <sct@redhat.com>, 1999
 *
 * Copyright 1998--1999 Red Hat corp --- All Rights Reserved
 *
 * Ext4-specific journaling extensions.
 */

#ifndef _EXT4_JBD2_H
#define _EXT4_JBD2_H

#include <linux/fs.h>
#include <linux/jbd2.h>
#include "ext4.h"

#define EXT4_JOURNAL(inode)	(EXT4_SB((inode)->i_sb)->s_journal)

/* Define the number of blocks we need to account to a transaction to
 * modify one block of data.
 *
 * We may have to touch one inode, one bitmap buffer, up to three
 * indirection blocks, the group and superblock summaries, and the data
 * block to complete the transaction.
 *
 * For extents-enabled fs we may have to allocate and modify up to
 * 5 levels of tree, data block (for each of these we need bitmap + group
 * summaries), root which is stored in the inode, sb
 */

#define EXT4_SINGLEDATA_TRANS_BLOCKS(sb)				\
	(ext4_has_feature_extents(sb) ? 20U : 8U)

/* Extended attribute operations touch at most two data buffers,
 * two bitmap buffers, and two group summaries, in addition to the inode
 * and the superblock, which are already accounted for. */

#define EXT4_XATTR_TRANS_BLOCKS		6U

/* Define the minimum size for a transaction which modifies data.  This
 * needs to take into account the fact that we may end up modifying two
 * quota files too (one for the group, one for the user quota).  The
 * superblock only gets updated once, of course, so don't bother
 * counting that again for the quota updates. */

#define EXT4_DATA_TRANS_BLOCKS(sb)	(EXT4_SINGLEDATA_TRANS_BLOCKS(sb) + \
					 EXT4_XATTR_TRANS_BLOCKS - 2 + \
					 EXT4_MAXQUOTAS_TRANS_BLOCKS(sb))

/*
 * Define the number of metadata blocks we need to account to modify data.
 *
 * This include super block, inode block, quota blocks and xattr blocks
 */
#define EXT4_META_TRANS_BLOCKS(sb)	(EXT4_XATTR_TRANS_BLOCKS + \
					EXT4_MAXQUOTAS_TRANS_BLOCKS(sb))

/* Define an arbitrary limit for the amount of data we will anticipate
 * writing to any given transaction.  For unbounded transactions such as
 * write(2) and truncate(2) we can write more than this, but we always
 * start off at the maximum transaction size and grow the transaction
 * optimistically as we go. */

#define EXT4_MAX_TRANS_DATA		64U

/* We break up a large truncate or write transaction once the handle's
 * buffer credits gets this low, we need either to extend the
 * transaction or to start a new one.  Reserve enough space here for
 * inode, bitmap, superblock, group and indirection updates for at least
 * one block, plus two quota updates.  Quota allocations are not
 * needed. */

#define EXT4_RESERVE_TRANS_BLOCKS	12U

/*
 * Number of credits needed if we need to insert an entry into a
 * directory.  For each new index block, we need 4 blocks (old index
 * block, new index block, bitmap block, bg summary).  For normal
 * htree directories there are 2 levels; if the largedir feature
 * enabled it's 3 levels.
 */
#define EXT4_INDEX_EXTRA_TRANS_BLOCKS	12U

#ifdef CONFIG_QUOTA
/* Amount of blocks needed for quota update - we know that the structure was
 * allocated so we need to update only data block */
#define EXT4_QUOTA_TRANS_BLOCKS(sb) ((test_opt(sb, QUOTA) ||\
		ext4_has_feature_quota(sb)) ? 1 : 0)
/* Amount of blocks needed for quota insert/delete - we do some block writes
 * but inode, sb and group updates are done only once */
#define EXT4_QUOTA_INIT_BLOCKS(sb) ((test_opt(sb, QUOTA) ||\
		ext4_has_feature_quota(sb)) ?\
		(DQUOT_INIT_ALLOC*(EXT4_SINGLEDATA_TRANS_BLOCKS(sb)-3)\
		 +3+DQUOT_INIT_REWRITE) : 0)

#define EXT4_QUOTA_DEL_BLOCKS(sb) ((test_opt(sb, QUOTA) ||\
		ext4_has_feature_quota(sb)) ?\
		(DQUOT_DEL_ALLOC*(EXT4_SINGLEDATA_TRANS_BLOCKS(sb)-3)\
		 +3+DQUOT_DEL_REWRITE) : 0)
#else
#define EXT4_QUOTA_TRANS_BLOCKS(sb) 0
#define EXT4_QUOTA_INIT_BLOCKS(sb) 0
#define EXT4_QUOTA_DEL_BLOCKS(sb) 0
#endif
#define EXT4_MAXQUOTAS_TRANS_BLOCKS(sb) (EXT4_MAXQUOTAS*EXT4_QUOTA_TRANS_BLOCKS(sb))
#define EXT4_MAXQUOTAS_INIT_BLOCKS(sb) (EXT4_MAXQUOTAS*EXT4_QUOTA_INIT_BLOCKS(sb))
#define EXT4_MAXQUOTAS_DEL_BLOCKS(sb) (EXT4_MAXQUOTAS*EXT4_QUOTA_DEL_BLOCKS(sb))

/*
 * Ext4 handle operation types -- for logging purposes
 */
#define EXT4_HT_MISC             0
#define EXT4_HT_INODE            1
#define EXT4_HT_WRITE_PAGE       2
#define EXT4_HT_MAP_BLOCKS       3
#define EXT4_HT_DIR              4
#define EXT4_HT_TRUNCATE         5
#define EXT4_HT_QUOTA            6
#define EXT4_HT_RESIZE           7
#define EXT4_HT_MIGRATE          8
#define EXT4_HT_MOVE_EXTENTS     9
#define EXT4_HT_XATTR           10
#define EXT4_HT_EXT_CONVERT     11
#define EXT4_HT_MAX             12

/**
 *   struct ext4_journal_cb_entry - Base structure for callback information.
 *
 *   This struct is a 'seed' structure for a using with your own callback
 *   structs. If you are using callbacks you must allocate one of these
 *   or another struct of your own definition which has this struct
 *   as it's first element and pass it to ext4_journal_callback_add().
 */
struct ext4_journal_cb_entry {
	/* list information for other callbacks attached to the same handle */
	struct list_head jce_list;

	/*  Function to call with this callback structure */
	void (*jce_func)(struct super_block *sb,
			 struct ext4_journal_cb_entry *jce, int error);

	/* user data goes here */
};

/**
 * ext4_journal_callback_add: add a function to call after transaction commit
 * @handle: active journal transaction handle to register callback on
 * @func: callback function to call after the transaction has committed:
 *        @sb: superblock of current filesystem for transaction
 *        @jce: returned journal callback data
 *        @rc: journal state at commit (0 = transaction committed properly)
 * @jce: journal callback data (internal and function private data struct)
 *
 * The registered function will be called in the context of the journal thread
 * after the transaction for which the handle was created has completed.
 *
 * No locks are held when the callback function is called, so it is safe to
 * call blocking functions from within the callback, but the callback should
 * not block or run for too long, or the filesystem will be blocked waiting for
 * the next transaction to commit. No journaling functions can be used, or
 * there is a risk of deadlock.
 *
 * There is no guaranteed calling order of multiple registered callbacks on
 * the same transaction.
 */
static inline void _ext4_journal_callback_add(handle_t *handle,
			struct ext4_journal_cb_entry *jce)
{
	/* Add the jce to transaction's private list */
	list_add_tail(&jce->jce_list, &handle->h_transaction->t_private_list);
}

static inline void ext4_journal_callback_add(handle_t *handle,
			void (*func)(struct super_block *sb,
				     struct ext4_journal_cb_entry *jce,
				     int rc),
			struct ext4_journal_cb_entry *jce)
{
	struct ext4_sb_info *sbi =
			EXT4_SB(handle->h_transaction->t_journal->j_private);

	/* Add the jce to transaction's private list */
	jce->jce_func = func;
	spin_lock(&sbi->s_md_lock);
	_ext4_journal_callback_add(handle, jce);
	spin_unlock(&sbi->s_md_lock);
}


/**
 * ext4_journal_callback_del: delete a registered callback
 * @handle: active journal transaction handle on which callback was registered
 * @jce: registered journal callback entry to unregister
 * Return true if object was successfully removed
 */
static inline bool ext4_journal_callback_try_del(handle_t *handle,
					     struct ext4_journal_cb_entry *jce)
{
	bool deleted;
	struct ext4_sb_info *sbi =
			EXT4_SB(handle->h_transaction->t_journal->j_private);

	spin_lock(&sbi->s_md_lock);
	deleted = !list_empty(&jce->jce_list);
	list_del_init(&jce->jce_list);
	spin_unlock(&sbi->s_md_lock);
	return deleted;
}

int
ext4_mark_iloc_dirty(handle_t *handle,
		     struct inode *inode,
		     struct ext4_iloc *iloc);

/*
 * On success, We end up with an outstanding reference count against
 * iloc->bh.  This _must_ be cleaned up later.
 */

int ext4_reserve_inode_write(handle_t *handle, struct inode *inode,
			struct ext4_iloc *iloc);

int ext4_mark_inode_dirty(handle_t *handle, struct inode *inode);

int ext4_expand_extra_isize(struct inode *inode,
			    unsigned int new_extra_isize,
			    struct ext4_iloc *iloc);
/*
 * Wrapper functions with which ext4 calls into JBD.
 */
int __ext4_journal_get_write_access(const char *where, unsigned int line,
				    handle_t *handle, struct buffer_head *bh);

int __ext4_forget(const char *where, unsigned int line, handle_t *handle,
		  int is_metadata, struct inode *inode,
		  struct buffer_head *bh, ext4_fsblk_t blocknr);

int __ext4_journal_get_create_access(const char *where, unsigned int line,
				handle_t *handle, struct buffer_head *bh);

int __ext4_handle_dirty_metadata(const char *where, unsigned int line,
				 handle_t *handle, struct inode *inode,
				 struct buffer_head *bh);

int __ext4_handle_dirty_super(const char *where, unsigned int line,
			      handle_t *handle, struct super_block *sb);

#define ext4_journal_get_write_access(handle, bh) \
	__ext4_journal_get_write_access(__func__, __LINE__, (handle), (bh))
#define ext4_forget(handle, is_metadata, inode, bh, block_nr) \
	__ext4_forget(__func__, __LINE__, (handle), (is_metadata), (inode), \
		      (bh), (block_nr))
#define ext4_journal_get_create_access(handle, bh) \
	__ext4_journal_get_create_access(__func__, __LINE__, (handle), (bh))
#define ext4_handle_dirty_metadata(handle, inode, bh) \
	__ext4_handle_dirty_metadata(__func__, __LINE__, (handle), (inode), \
				     (bh))
#define ext4_handle_dirty_super(handle, sb) \
	__ext4_handle_dirty_super(__func__, __LINE__, (handle), (sb))

handle_t *__ext4_journal_start_sb(struct super_block *sb, unsigned int line,
				  int type, int blocks, int rsv_blocks,
				  int revoke_creds);
int __ext4_journal_stop(const char *where, unsigned int line, handle_t *handle);

#define EXT4_NOJOURNAL_MAX_REF_COUNT ((unsigned long) 4096)

/* Note:  Do not use this for NULL handles.  This is only to determine if
 * a properly allocated handle is using a journal or not. */
static inline int ext4_handle_valid(handle_t *handle)
{
	if ((unsigned long)handle < EXT4_NOJOURNAL_MAX_REF_COUNT)
		return 0;
	return 1;
}

static inline void ext4_handle_sync(handle_t *handle)
{
	if (ext4_handle_valid(handle))
		handle->h_sync = 1;
}

static inline int ext4_handle_is_aborted(handle_t *handle)
{
	if (ext4_handle_valid(handle))
		return is_handle_aborted(handle);
	return 0;
}

static inline int ext4_free_metadata_revoke_credits(struct super_block *sb,
						    int blocks)
{
	/* Freeing each metadata block can result in freeing one cluster */
	return blocks * EXT4_SB(sb)->s_cluster_ratio;
}

static inline int ext4_trans_default_revoke_credits(struct super_block *sb)
{
	return ext4_free_metadata_revoke_credits(sb, 8);
}

#define ext4_journal_start_sb(sb, type, nblocks)			\
	__ext4_journal_start_sb((sb), __LINE__, (type), (nblocks), 0,	\
				ext4_trans_default_revoke_credits(sb))

#define ext4_journal_start(inode, type, nblocks)			\
	__ext4_journal_start((inode), __LINE__, (type), (nblocks), 0,	\
			     ext4_trans_default_revoke_credits((inode)->i_sb))

#define ext4_journal_start_with_reserve(inode, type, blocks, rsv_blocks)\
	__ext4_journal_start((inode), __LINE__, (type), (blocks), (rsv_blocks),\
			     ext4_trans_default_revoke_credits((inode)->i_sb))

#define ext4_journal_start_with_revoke(inode, type, blocks, revoke_creds) \
	__ext4_journal_start((inode), __LINE__, (type), (blocks), 0,	\
			     (revoke_creds))

static inline handle_t *__ext4_journal_start(struct inode *inode,
					     unsigned int line, int type,
					     int blocks, int rsv_blocks,
					     int revoke_creds)
{
	return __ext4_journal_start_sb(inode->i_sb, line, type, blocks,
				       rsv_blocks, revoke_creds);
}

#define ext4_journal_stop(handle) \
	__ext4_journal_stop(__func__, __LINE__, (handle))

#define ext4_journal_start_reserved(handle, type) \
	__ext4_journal_start_reserved((handle), __LINE__, (type))

handle_t *__ext4_journal_start_reserved(handle_t *handle, unsigned int line,
					int type);

static inline void ext4_journal_free_reserved(handle_t *handle)
{
	if (ext4_handle_valid(handle))
		jbd2_journal_free_reserved(handle);
}

static inline handle_t *ext4_journal_current_handle(void)
{
	return journal_current_handle();
}

static inline int ext4_journal_extend(handle_t *handle, int nblocks, int revoke)
{
	if (ext4_handle_valid(handle))
		return jbd2_journal_extend(handle, nblocks, revoke);
	return 0;
}

static inline int ext4_journal_restart(handle_t *handle, int nblocks,
				       int revoke)
{
	if (ext4_handle_valid(handle))
		return jbd2__journal_restart(handle, nblocks, revoke, GFP_NOFS);
	return 0;
}

int __ext4_journal_ensure_credits(handle_t *handle, int check_cred,
				  int extend_cred, int revoke_cred);


/*
 * Ensure @handle has at least @check_creds credits available. If not,
 * transaction will be extended or restarted to contain at least @extend_cred
 * credits. Before restarting transaction @fn is executed to allow for cleanup
 * before the transaction is restarted.
 *
 * The return value is < 0 in case of error, 0 in case the handle has enough
 * credits or transaction extension succeeded, 1 in case transaction had to be
 * restarted.
 */
#define ext4_journal_ensure_credits_fn(handle, check_cred, extend_cred,	\
				       revoke_cred, fn) \
({									\
	__label__ __ensure_end;						\
	int err = __ext4_journal_ensure_credits((handle), (check_cred),	\
					(extend_cred), (revoke_cred));	\
									\
	if (err <= 0)							\
		goto __ensure_end;					\
	err = (fn);							\
	if (err < 0)							\
		goto __ensure_end;					\
	err = ext4_journal_restart((handle), (extend_cred), (revoke_cred)); \
	if (err == 0)							\
		err = 1;						\
__ensure_end:								\
	err;								\
})

/*
 * Ensure given handle has at least requested amount of credits available,
 * possibly restarting transaction if needed. We also make sure the transaction
 * has space for at least ext4_trans_default_revoke_credits(sb) revoke records
 * as freeing one or two blocks is very common pattern and requesting this is
 * very cheap.
 */
static inline int ext4_journal_ensure_credits(handle_t *handle, int credits,
					      int revoke_creds)
{
	return ext4_journal_ensure_credits_fn(handle, credits, credits,
				revoke_creds, 0);
}

static inline int ext4_journal_blocks_per_page(struct inode *inode)
{
	if (EXT4_JOURNAL(inode) != NULL)
		return jbd2_journal_blocks_per_page(inode);
	return 0;
}

static inline int ext4_journal_force_commit(journal_t *journal)
{
	if (journal)
		return jbd2_journal_force_commit(journal);
	return 0;
}

static inline int ext4_jbd2_inode_add_write(handle_t *handle,
		struct inode *inode, loff_t start_byte, loff_t length)
{
	if (ext4_handle_valid(handle))
		return jbd2_journal_inode_ranged_write(handle,
				EXT4_I(inode)->jinode, start_byte, length);
	return 0;
}

static inline int ext4_jbd2_inode_add_wait(handle_t *handle,
		struct inode *inode, loff_t start_byte, loff_t length)
{
	if (ext4_handle_valid(handle))
		return jbd2_journal_inode_ranged_wait(handle,
				EXT4_I(inode)->jinode, start_byte, length);
	return 0;
}

static inline void ext4_update_inode_fsync_trans(handle_t *handle,
						 struct inode *inode,
						 int datasync)
{
	struct ext4_inode_info *ei = EXT4_I(inode);

	if (ext4_handle_valid(handle) && !is_handle_aborted(handle)) {
		ei->i_sync_tid = handle->h_transaction->t_tid;
		if (datasync)
			ei->i_datasync_tid = handle->h_transaction->t_tid;
	}
}

/* super.c */
int ext4_force_commit(struct super_block *sb);

/*
 * Ext4 inode journal modes
 */
#define EXT4_INODE_JOURNAL_DATA_MODE	0x01 /* journal data mode */
#define EXT4_INODE_ORDERED_DATA_MODE	0x02 /* ordered data mode */
#define EXT4_INODE_WRITEBACK_DATA_MODE	0x04 /* writeback data mode */

int ext4_inode_journal_mode(struct inode *inode);

static inline int ext4_should_journal_data(struct inode *inode)
{
	return ext4_inode_journal_mode(inode) & EXT4_INODE_JOURNAL_DATA_MODE;
}

static inline int ext4_should_order_data(struct inode *inode)
{
	return ext4_inode_journal_mode(inode) & EXT4_INODE_ORDERED_DATA_MODE;
}

static inline int ext4_should_writeback_data(struct inode *inode)
{
	return ext4_inode_journal_mode(inode) & EXT4_INODE_WRITEBACK_DATA_MODE;
}

static inline int ext4_free_data_revoke_credits(struct inode *inode, int blocks)
{
	if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_JOURNAL_DATA)
		return 0;
	if (!ext4_should_journal_data(inode))
		return 0;
	/*
	 * Data blocks in one extent are contiguous, just account for partial
	 * clusters at extent boundaries
	 */
	return blocks + 2*(EXT4_SB(inode->i_sb)->s_cluster_ratio - 1);
}

/*
 * This function controls whether or not we should try to go down the
 * dioread_nolock code paths, which makes it safe to avoid taking
 * i_mutex for direct I/O reads.  This only works for extent-based
 * files, and it doesn't work if data journaling is enabled, since the
 * dioread_nolock code uses b_private to pass information back to the
 * I/O completion handler, and this conflicts with the jbd's use of
 * b_private.
 */
static inline int ext4_should_dioread_nolock(struct inode *inode)
{
	if (!test_opt(inode->i_sb, DIOREAD_NOLOCK))
		return 0;
	if (!S_ISREG(inode->i_mode))
		return 0;
	if (!(ext4_test_inode_flag(inode, EXT4_INODE_EXTENTS)))
		return 0;
	if (ext4_should_journal_data(inode))
		return 0;
	return 1;
}

#endif	/* _EXT4_JBD2_H */
Commit	Line	Data
f5166768	1	// SPDX-License-Identifier: GPL-2.0+
470decc6	2	/*
3dcf5451	3	* ext4_jbd2.h
470decc6 DK	4	*
	5	* Written by Stephen C. Tweedie <sct@redhat.com>, 1999
	6	*
	7	* Copyright 1998--1999 Red Hat corp --- All Rights Reserved
	8	*
470decc6 DK	9	* Ext4-specific journaling extensions.
	10	*/
	11
3dcf5451 CH	12	#ifndef _EXT4_JBD2_H
3dcf5451 CH	13	#define _EXT4_JBD2_H
470decc6 DK	14
470decc6 DK	15	#include <linux/fs.h>
f7f4bccb	16	#include <linux/jbd2.h>
3dcf5451	17	#include "ext4.h"
470decc6 DK	18
	19	#define EXT4_JOURNAL(inode) (EXT4_SB((inode)->i_sb)->s_journal)
	20
	21	/* Define the number of blocks we need to account to a transaction to
	22	* modify one block of data.
	23	*
	24	* We may have to touch one inode, one bitmap buffer, up to three
	25	* indirection blocks, the group and superblock summaries, and the data
a86c6181 AT	26	* block to complete the transaction.
a86c6181 AT	27	*
d0d856e8	28	* For extents-enabled fs we may have to allocate and modify up to
f45a5ef9 JK	29	* 5 levels of tree, data block (for each of these we need bitmap + group
	30	* summaries), root which is stored in the inode, sb
	31	*/
470decc6	32
a86c6181	33	#define EXT4_SINGLEDATA_TRANS_BLOCKS(sb) \
e2b911c5	34	(ext4_has_feature_extents(sb) ? 20U : 8U)
470decc6 DK	35
	36	/* Extended attribute operations touch at most two data buffers,
	37	* two bitmap buffers, and two group summaries, in addition to the inode
	38	* and the superblock, which are already accounted for. */
	39
	40	#define EXT4_XATTR_TRANS_BLOCKS 6U
	41
	42	/* Define the minimum size for a transaction which modifies data. This
	43	* needs to take into account the fact that we may end up modifying two
	44	* quota files too (one for the group, one for the user quota). The
	45	* superblock only gets updated once, of course, so don't bother
	46	* counting that again for the quota updates. */
	47
a86c6181	48	#define EXT4_DATA_TRANS_BLOCKS(sb) (EXT4_SINGLEDATA_TRANS_BLOCKS(sb) + \
470decc6	49	EXT4_XATTR_TRANS_BLOCKS - 2 + \
5aca07eb	50	EXT4_MAXQUOTAS_TRANS_BLOCKS(sb))
470decc6	51
a02908f1 MC	52	/*
	53	* Define the number of metadata blocks we need to account to modify data.
	54	*
	55	* This include super block, inode block, quota blocks and xattr blocks
	56	*/
	57	#define EXT4_META_TRANS_BLOCKS(sb) (EXT4_XATTR_TRANS_BLOCKS + \
5aca07eb	58	EXT4_MAXQUOTAS_TRANS_BLOCKS(sb))
a02908f1	59
470decc6 DK	60	/* Define an arbitrary limit for the amount of data we will anticipate
	61	* writing to any given transaction. For unbounded transactions such as
	62	* write(2) and truncate(2) we can write more than this, but we always
	63	* start off at the maximum transaction size and grow the transaction
	64	* optimistically as we go. */
	65
	66	#define EXT4_MAX_TRANS_DATA 64U
	67
	68	/* We break up a large truncate or write transaction once the handle's
	69	* buffer credits gets this low, we need either to extend the
	70	* transaction or to start a new one. Reserve enough space here for
	71	* inode, bitmap, superblock, group and indirection updates for at least
	72	* one block, plus two quota updates. Quota allocations are not
	73	* needed. */
	74
	75	#define EXT4_RESERVE_TRANS_BLOCKS 12U
	76
e08ac99f AB	77	/*
	78	* Number of credits needed if we need to insert an entry into a
	79	* directory. For each new index block, we need 4 blocks (old index
	80	* block, new index block, bitmap block, bg summary). For normal
	81	* htree directories there are 2 levels; if the largedir feature
	82	* enabled it's 3 levels.
	83	*/
	84	#define EXT4_INDEX_EXTRA_TRANS_BLOCKS 12U
470decc6 DK	85
	86	#ifdef CONFIG_QUOTA
	87	/* Amount of blocks needed for quota update - we know that the structure was
21f97697	88	* allocated so we need to update only data block */
7c319d32	89	#define EXT4_QUOTA_TRANS_BLOCKS(sb) ((test_opt(sb, QUOTA) \|\|\
e2b911c5	90	ext4_has_feature_quota(sb)) ? 1 : 0)
470decc6 DK	91	/* Amount of blocks needed for quota insert/delete - we do some block writes
470decc6 DK	92	* but inode, sb and group updates are done only once */
7c319d32	93	#define EXT4_QUOTA_INIT_BLOCKS(sb) ((test_opt(sb, QUOTA) \|\|\
e2b911c5	94	ext4_has_feature_quota(sb)) ?\
7c319d32 AK	95	(DQUOT_INIT_ALLOC*(EXT4_SINGLEDATA_TRANS_BLOCKS(sb)-3)\
	96	+3+DQUOT_INIT_REWRITE) : 0)
	97
	98	#define EXT4_QUOTA_DEL_BLOCKS(sb) ((test_opt(sb, QUOTA) \|\|\
e2b911c5	99	ext4_has_feature_quota(sb)) ?\
7c319d32 AK	100	(DQUOT_DEL_ALLOC*(EXT4_SINGLEDATA_TRANS_BLOCKS(sb)-3)\
7c319d32 AK	101	+3+DQUOT_DEL_REWRITE) : 0)
470decc6 DK	102	#else
	103	#define EXT4_QUOTA_TRANS_BLOCKS(sb) 0
	104	#define EXT4_QUOTA_INIT_BLOCKS(sb) 0
	105	#define EXT4_QUOTA_DEL_BLOCKS(sb) 0
	106	#endif
a2d4a646 JK	107	#define EXT4_MAXQUOTAS_TRANS_BLOCKS(sb) (EXT4_MAXQUOTAS*EXT4_QUOTA_TRANS_BLOCKS(sb))
	108	#define EXT4_MAXQUOTAS_INIT_BLOCKS(sb) (EXT4_MAXQUOTAS*EXT4_QUOTA_INIT_BLOCKS(sb))
	109	#define EXT4_MAXQUOTAS_DEL_BLOCKS(sb) (EXT4_MAXQUOTAS*EXT4_QUOTA_DEL_BLOCKS(sb))
470decc6	110
9924a92a TT	111	/*
	112	* Ext4 handle operation types -- for logging purposes
	113	*/
	114	#define EXT4_HT_MISC 0
	115	#define EXT4_HT_INODE 1
	116	#define EXT4_HT_WRITE_PAGE 2
	117	#define EXT4_HT_MAP_BLOCKS 3
	118	#define EXT4_HT_DIR 4
	119	#define EXT4_HT_TRUNCATE 5
	120	#define EXT4_HT_QUOTA 6
	121	#define EXT4_HT_RESIZE 7
	122	#define EXT4_HT_MIGRATE 8
	123	#define EXT4_HT_MOVE_EXTENTS 9
	124	#define EXT4_HT_XATTR 10
6b523df4 JK	125	#define EXT4_HT_EXT_CONVERT 11
6b523df4 JK	126	#define EXT4_HT_MAX 12
9924a92a	127
18aadd47 BJ	128	/**
	129	* struct ext4_journal_cb_entry - Base structure for callback information.
	130	*
	131	* This struct is a 'seed' structure for a using with your own callback
	132	* structs. If you are using callbacks you must allocate one of these
	133	* or another struct of your own definition which has this struct
	134	* as it's first element and pass it to ext4_journal_callback_add().
	135	*/
	136	struct ext4_journal_cb_entry {
	137	/* list information for other callbacks attached to the same handle */
	138	struct list_head jce_list;
	139
	140	/* Function to call with this callback structure */
	141	void (jce_func)(struct super_block sb,
	142	struct ext4_journal_cb_entry *jce, int error);
	143
	144	/* user data goes here */
	145	};
	146
	147	/**
	148	* ext4_journal_callback_add: add a function to call after transaction commit
	149	* @handle: active journal transaction handle to register callback on
	150	* @func: callback function to call after the transaction has committed:
	151	* @sb: superblock of current filesystem for transaction
	152	* @jce: returned journal callback data
	153	* @rc: journal state at commit (0 = transaction committed properly)
	154	* @jce: journal callback data (internal and function private data struct)
	155	*
	156	* The registered function will be called in the context of the journal thread
	157	* after the transaction for which the handle was created has completed.
	158	*
	159	* No locks are held when the callback function is called, so it is safe to
	160	* call blocking functions from within the callback, but the callback should
	161	* not block or run for too long, or the filesystem will be blocked waiting for
	162	* the next transaction to commit. No journaling functions can be used, or
	163	* there is a risk of deadlock.
	164	*
	165	* There is no guaranteed calling order of multiple registered callbacks on
	166	* the same transaction.
	167	*/
d08854f5 TT	168	static inline void _ext4_journal_callback_add(handle_t *handle,
	169	struct ext4_journal_cb_entry *jce)
	170	{
	171	/* Add the jce to transaction's private list */
	172	list_add_tail(&jce->jce_list, &handle->h_transaction->t_private_list);
	173	}
	174
18aadd47 BJ	175	static inline void ext4_journal_callback_add(handle_t *handle,
	176	void (func)(struct super_block sb,
	177	struct ext4_journal_cb_entry *jce,
	178	int rc),
	179	struct ext4_journal_cb_entry *jce)
	180	{
	181	struct ext4_sb_info *sbi =
	182	EXT4_SB(handle->h_transaction->t_journal->j_private);
	183
	184	/* Add the jce to transaction's private list */
	185	jce->jce_func = func;
	186	spin_lock(&sbi->s_md_lock);
d08854f5	187	_ext4_journal_callback_add(handle, jce);
18aadd47 BJ	188	spin_unlock(&sbi->s_md_lock);
	189	}
	190
d08854f5	191
18aadd47 BJ	192	/**
	193	* ext4_journal_callback_del: delete a registered callback
	194	* @handle: active journal transaction handle on which callback was registered
	195	* @jce: registered journal callback entry to unregister
70261f56	196	* Return true if object was successfully removed
18aadd47	197	*/
5d3ee208	198	static inline bool ext4_journal_callback_try_del(handle_t *handle,
18aadd47 BJ	199	struct ext4_journal_cb_entry *jce)
18aadd47 BJ	200	{
5d3ee208	201	bool deleted;
18aadd47 BJ	202	struct ext4_sb_info *sbi =
	203	EXT4_SB(handle->h_transaction->t_journal->j_private);
	204
	205	spin_lock(&sbi->s_md_lock);
5d3ee208	206	deleted = !list_empty(&jce->jce_list);
18aadd47 BJ	207	list_del_init(&jce->jce_list);
18aadd47 BJ	208	spin_unlock(&sbi->s_md_lock);
5d3ee208	209	return deleted;
18aadd47 BJ	210	}
18aadd47 BJ	211
470decc6 DK	212	int
	213	ext4_mark_iloc_dirty(handle_t *handle,
	214	struct inode *inode,
	215	struct ext4_iloc *iloc);
	216
	217	/*
	218	* On success, We end up with an outstanding reference count against
	219	* iloc->bh. This _must_ be cleaned up later.
	220	*/
	221
	222	int ext4_reserve_inode_write(handle_t handle, struct inode inode,
	223	struct ext4_iloc *iloc);
	224
	225	int ext4_mark_inode_dirty(handle_t handle, struct inode inode);
	226
c03b45b8 MX	227	int ext4_expand_extra_isize(struct inode *inode,
	228	unsigned int new_extra_isize,
	229	struct ext4_iloc *iloc);
470decc6	230	/*
e4684b3f	231	* Wrapper functions with which ext4 calls into JBD.
470decc6	232	*/
90c7201b TT	233	int __ext4_journal_get_write_access(const char *where, unsigned int line,
90c7201b TT	234	handle_t handle, struct buffer_head bh);
470decc6	235
90c7201b TT	236	int __ext4_forget(const char where, unsigned int line, handle_t handle,
	237	int is_metadata, struct inode *inode,
	238	struct buffer_head *bh, ext4_fsblk_t blocknr);
d6797d14	239
90c7201b	240	int __ext4_journal_get_create_access(const char *where, unsigned int line,
8984d137	241	handle_t handle, struct buffer_head bh);
470decc6	242
90c7201b TT	243	int __ext4_handle_dirty_metadata(const char *where, unsigned int line,
	244	handle_t handle, struct inode inode,
	245	struct buffer_head *bh);
470decc6	246
90c7201b	247	int __ext4_handle_dirty_super(const char *where, unsigned int line,
b50924c2	248	handle_t handle, struct super_block sb);
a0375156	249
470decc6	250	#define ext4_journal_get_write_access(handle, bh) \
90c7201b	251	__ext4_journal_get_write_access(__func__, __LINE__, (handle), (bh))
d6797d14	252	#define ext4_forget(handle, is_metadata, inode, bh, block_nr) \
90c7201b TT	253	__ext4_forget(__func__, __LINE__, (handle), (is_metadata), (inode), \
90c7201b TT	254	(bh), (block_nr))
470decc6	255	#define ext4_journal_get_create_access(handle, bh) \
90c7201b	256	__ext4_journal_get_create_access(__func__, __LINE__, (handle), (bh))
0390131b	257	#define ext4_handle_dirty_metadata(handle, inode, bh) \
90c7201b TT	258	__ext4_handle_dirty_metadata(__func__, __LINE__, (handle), (inode), \
90c7201b TT	259	(bh))
a0375156	260	#define ext4_handle_dirty_super(handle, sb) \
b50924c2	261	__ext4_handle_dirty_super(__func__, __LINE__, (handle), (sb))
470decc6	262
9924a92a	263	handle_t __ext4_journal_start_sb(struct super_block sb, unsigned int line,
83448bdf JK	264	int type, int blocks, int rsv_blocks,
83448bdf JK	265	int revoke_creds);
c398eda0	266	int __ext4_journal_stop(const char where, unsigned int line, handle_t handle);
470decc6	267
d3d1faf6	268	#define EXT4_NOJOURNAL_MAX_REF_COUNT ((unsigned long) 4096)
0390131b	269
d3d1faf6 CW	270	/* Note: Do not use this for NULL handles. This is only to determine if
d3d1faf6 CW	271	* a properly allocated handle is using a journal or not. */
0390131b FM	272	static inline int ext4_handle_valid(handle_t *handle)
0390131b FM	273	{
d3d1faf6	274	if ((unsigned long)handle < EXT4_NOJOURNAL_MAX_REF_COUNT)
0390131b FM	275	return 0;
	276	return 1;
	277	}
	278
	279	static inline void ext4_handle_sync(handle_t *handle)
	280	{
	281	if (ext4_handle_valid(handle))
	282	handle->h_sync = 1;
	283	}
	284
0390131b FM	285	static inline int ext4_handle_is_aborted(handle_t *handle)
	286	{
	287	if (ext4_handle_valid(handle))
	288	return is_handle_aborted(handle);
	289	return 0;
	290	}
	291
83448bdf JK	292	static inline int ext4_free_metadata_revoke_credits(struct super_block *sb,
	293	int blocks)
	294	{
	295	/* Freeing each metadata block can result in freeing one cluster */
	296	return blocks * EXT4_SB(sb)->s_cluster_ratio;
	297	}
	298
	299	static inline int ext4_trans_default_revoke_credits(struct super_block *sb)
	300	{
	301	return ext4_free_metadata_revoke_credits(sb, 8);
	302	}
	303
9924a92a	304	#define ext4_journal_start_sb(sb, type, nblocks) \
83448bdf JK	305	__ext4_journal_start_sb((sb), __LINE__, (type), (nblocks), 0, \
83448bdf JK	306	ext4_trans_default_revoke_credits(sb))
9924a92a TT	307
9924a92a TT	308	#define ext4_journal_start(inode, type, nblocks) \
83448bdf JK	309	__ext4_journal_start((inode), __LINE__, (type), (nblocks), 0, \
83448bdf JK	310	ext4_trans_default_revoke_credits((inode)->i_sb))
5fe2fe89	311
83448bdf JK	312	#define ext4_journal_start_with_reserve(inode, type, blocks, rsv_blocks)\
	313	__ext4_journal_start((inode), __LINE__, (type), (blocks), (rsv_blocks),\
	314	ext4_trans_default_revoke_credits((inode)->i_sb))
	315
	316	#define ext4_journal_start_with_revoke(inode, type, blocks, revoke_creds) \
	317	__ext4_journal_start((inode), __LINE__, (type), (blocks), 0, \
	318	(revoke_creds))
9924a92a TT	319
	320	static inline handle_t __ext4_journal_start(struct inode inode,
	321	unsigned int line, int type,
83448bdf JK	322	int blocks, int rsv_blocks,
83448bdf JK	323	int revoke_creds)
470decc6	324	{
5fe2fe89	325	return __ext4_journal_start_sb(inode->i_sb, line, type, blocks,
83448bdf	326	rsv_blocks, revoke_creds);
470decc6 DK	327	}
	328
	329	#define ext4_journal_stop(handle) \
c398eda0	330	__ext4_journal_stop(__func__, __LINE__, (handle))
470decc6	331
6b523df4	332	#define ext4_journal_start_reserved(handle, type) \
5fe2fe89 JK	333	__ext4_journal_start_reserved((handle), __LINE__, (type))
	334
	335	handle_t __ext4_journal_start_reserved(handle_t handle, unsigned int line,
	336	int type);
	337
	338	static inline void ext4_journal_free_reserved(handle_t *handle)
	339	{
	340	if (ext4_handle_valid(handle))
	341	jbd2_journal_free_reserved(handle);
	342	}
	343
470decc6 DK	344	static inline handle_t *ext4_journal_current_handle(void)
	345	{
	346	return journal_current_handle();
	347	}
	348
83448bdf	349	static inline int ext4_journal_extend(handle_t *handle, int nblocks, int revoke)
470decc6	350	{
0390131b	351	if (ext4_handle_valid(handle))
83448bdf	352	return jbd2_journal_extend(handle, nblocks, revoke);
0390131b	353	return 0;
470decc6 DK	354	}
470decc6 DK	355
83448bdf JK	356	static inline int ext4_journal_restart(handle_t *handle, int nblocks,
83448bdf JK	357	int revoke)
470decc6	358	{
0390131b	359	if (ext4_handle_valid(handle))
83448bdf	360	return jbd2__journal_restart(handle, nblocks, revoke, GFP_NOFS);
0390131b	361	return 0;
470decc6 DK	362	}
470decc6 DK	363
a4130367	364	int __ext4_journal_ensure_credits(handle_t *handle, int check_cred,
83448bdf	365	int extend_cred, int revoke_cred);
a4130367 JK	366
	367
	368	/*
	369	* Ensure @handle has at least @check_creds credits available. If not,
	370	* transaction will be extended or restarted to contain at least @extend_cred
	371	* credits. Before restarting transaction @fn is executed to allow for cleanup
	372	* before the transaction is restarted.
	373	*
	374	* The return value is < 0 in case of error, 0 in case the handle has enough
	375	* credits or transaction extension succeeded, 1 in case transaction had to be
	376	* restarted.
	377	*/
83448bdf JK	378	#define ext4_journal_ensure_credits_fn(handle, check_cred, extend_cred, \
83448bdf JK	379	revoke_cred, fn) \
a4130367 JK	380	({ \
	381	__label__ __ensure_end; \
	382	int err = __ext4_journal_ensure_credits((handle), (check_cred), \
83448bdf	383	(extend_cred), (revoke_cred)); \
a4130367 JK	384	\
	385	if (err <= 0) \
	386	goto __ensure_end; \
	387	err = (fn); \
	388	if (err < 0) \
	389	goto __ensure_end; \
83448bdf	390	err = ext4_journal_restart((handle), (extend_cred), (revoke_cred)); \
a4130367 JK	391	if (err == 0) \
	392	err = 1; \
	393	__ensure_end: \
	394	err; \
	395	})
	396
	397	/*
	398	* Ensure given handle has at least requested amount of credits available,
83448bdf JK	399	* possibly restarting transaction if needed. We also make sure the transaction
	400	* has space for at least ext4_trans_default_revoke_credits(sb) revoke records
	401	* as freeing one or two blocks is very common pattern and requesting this is
	402	* very cheap.
a4130367	403	*/
83448bdf JK	404	static inline int ext4_journal_ensure_credits(handle_t *handle, int credits,
83448bdf JK	405	int revoke_creds)
a4130367	406	{
83448bdf JK	407	return ext4_journal_ensure_credits_fn(handle, credits, credits,
83448bdf JK	408	revoke_creds, 0);
a4130367 JK	409	}
a4130367 JK	410
470decc6 DK	411	static inline int ext4_journal_blocks_per_page(struct inode *inode)
470decc6 DK	412	{
0390131b FM	413	if (EXT4_JOURNAL(inode) != NULL)
	414	return jbd2_journal_blocks_per_page(inode);
	415	return 0;
470decc6 DK	416	}
	417
	418	static inline int ext4_journal_force_commit(journal_t *journal)
	419	{
0390131b FM	420	if (journal)
	421	return jbd2_journal_force_commit(journal);
	422	return 0;
470decc6 DK	423	}
470decc6 DK	424
ee0876bc	425	static inline int ext4_jbd2_inode_add_write(handle_t *handle,
73131fbb	426	struct inode *inode, loff_t start_byte, loff_t length)
678aaf48	427	{
0390131b	428	if (ext4_handle_valid(handle))
73131fbb RZ	429	return jbd2_journal_inode_ranged_write(handle,
73131fbb RZ	430	EXT4_I(inode)->jinode, start_byte, length);
0390131b	431	return 0;
678aaf48 JK	432	}
678aaf48 JK	433
ee0876bc	434	static inline int ext4_jbd2_inode_add_wait(handle_t *handle,
73131fbb	435	struct inode *inode, loff_t start_byte, loff_t length)
ee0876bc JK	436	{
ee0876bc JK	437	if (ext4_handle_valid(handle))
73131fbb RZ	438	return jbd2_journal_inode_ranged_wait(handle,
73131fbb RZ	439	EXT4_I(inode)->jinode, start_byte, length);
ee0876bc JK	440	return 0;
	441	}
	442
b436b9be JK	443	static inline void ext4_update_inode_fsync_trans(handle_t *handle,
	444	struct inode *inode,
	445	int datasync)
	446	{
	447	struct ext4_inode_info *ei = EXT4_I(inode);
	448
fa30dde3	449	if (ext4_handle_valid(handle) && !is_handle_aborted(handle)) {
b436b9be JK	450	ei->i_sync_tid = handle->h_transaction->t_tid;
	451	if (datasync)
	452	ei->i_datasync_tid = handle->h_transaction->t_tid;
	453	}
	454	}
	455
470decc6 DK	456	/* super.c */
	457	int ext4_force_commit(struct super_block *sb);
	458
3d2b1582 LC	459	/*
	460	* Ext4 inode journal modes
	461	*/
	462	#define EXT4_INODE_JOURNAL_DATA_MODE 0x01 /* journal data mode */
	463	#define EXT4_INODE_ORDERED_DATA_MODE 0x02 /* ordered data mode */
	464	#define EXT4_INODE_WRITEBACK_DATA_MODE 0x04 /* writeback data mode */
	465
46797ad7	466	int ext4_inode_journal_mode(struct inode *inode);
3d2b1582 LC	467
	468	static inline int ext4_should_journal_data(struct inode *inode)
	469	{
	470	return ext4_inode_journal_mode(inode) & EXT4_INODE_JOURNAL_DATA_MODE;
470decc6 DK	471	}
	472
	473	static inline int ext4_should_order_data(struct inode *inode)
	474	{
3d2b1582	475	return ext4_inode_journal_mode(inode) & EXT4_INODE_ORDERED_DATA_MODE;
470decc6 DK	476	}
	477
	478	static inline int ext4_should_writeback_data(struct inode *inode)
	479	{
3d2b1582	480	return ext4_inode_journal_mode(inode) & EXT4_INODE_WRITEBACK_DATA_MODE;
470decc6 DK	481	}
470decc6 DK	482
83448bdf JK	483	static inline int ext4_free_data_revoke_credits(struct inode *inode, int blocks)
	484	{
	485	if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_JOURNAL_DATA)
	486	return 0;
	487	if (!ext4_should_journal_data(inode))
	488	return 0;
	489	/*
	490	* Data blocks in one extent are contiguous, just account for partial
	491	* clusters at extent boundaries
	492	*/
	493	return blocks + 2*(EXT4_SB(inode->i_sb)->s_cluster_ratio - 1);
	494	}
	495
744692dc JZ	496	/*
	497	* This function controls whether or not we should try to go down the
	498	* dioread_nolock code paths, which makes it safe to avoid taking
	499	* i_mutex for direct I/O reads. This only works for extent-based
206f7ab4 CH	500	* files, and it doesn't work if data journaling is enabled, since the
	501	* dioread_nolock code uses b_private to pass information back to the
	502	* I/O completion handler, and this conflicts with the jbd's use of
	503	* b_private.
744692dc JZ	504	*/
	505	static inline int ext4_should_dioread_nolock(struct inode *inode)
	506	{
	507	if (!test_opt(inode->i_sb, DIOREAD_NOLOCK))
	508	return 0;
744692dc JZ	509	if (!S_ISREG(inode->i_mode))
744692dc JZ	510	return 0;
12e9b892	511	if (!(ext4_test_inode_flag(inode, EXT4_INODE_EXTENTS)))
744692dc JZ	512	return 0;
	513	if (ext4_should_journal_data(inode))
	514	return 0;
	515	return 1;
	516	}
	517
3dcf5451	518	#endif /* _EXT4_JBD2_H */