13dcf5451SChristoph Hellwig /* 23dcf5451SChristoph Hellwig * ext4_jbd2.h 33dcf5451SChristoph Hellwig * 43dcf5451SChristoph Hellwig * Written by Stephen C. Tweedie <sct@redhat.com>, 1999 53dcf5451SChristoph Hellwig * 63dcf5451SChristoph Hellwig * Copyright 1998--1999 Red Hat corp --- All Rights Reserved 73dcf5451SChristoph Hellwig * 83dcf5451SChristoph Hellwig * This file is part of the Linux kernel and is made available under 93dcf5451SChristoph Hellwig * the terms of the GNU General Public License, version 2, or at your 103dcf5451SChristoph Hellwig * option, any later version, incorporated herein by reference. 113dcf5451SChristoph Hellwig * 123dcf5451SChristoph Hellwig * Ext4-specific journaling extensions. 133dcf5451SChristoph Hellwig */ 143dcf5451SChristoph Hellwig 153dcf5451SChristoph Hellwig #ifndef _EXT4_JBD2_H 163dcf5451SChristoph Hellwig #define _EXT4_JBD2_H 173dcf5451SChristoph Hellwig 183dcf5451SChristoph Hellwig #include <linux/fs.h> 193dcf5451SChristoph Hellwig #include <linux/jbd2.h> 203dcf5451SChristoph Hellwig #include "ext4.h" 213dcf5451SChristoph Hellwig 223dcf5451SChristoph Hellwig #define EXT4_JOURNAL(inode) (EXT4_SB((inode)->i_sb)->s_journal) 233dcf5451SChristoph Hellwig 243dcf5451SChristoph Hellwig /* Define the number of blocks we need to account to a transaction to 253dcf5451SChristoph Hellwig * modify one block of data. 263dcf5451SChristoph Hellwig * 273dcf5451SChristoph Hellwig * We may have to touch one inode, one bitmap buffer, up to three 283dcf5451SChristoph Hellwig * indirection blocks, the group and superblock summaries, and the data 293dcf5451SChristoph Hellwig * block to complete the transaction. 303dcf5451SChristoph Hellwig * 313dcf5451SChristoph Hellwig * For extents-enabled fs we may have to allocate and modify up to 323dcf5451SChristoph Hellwig * 5 levels of tree + root which are stored in the inode. */ 333dcf5451SChristoph Hellwig 343dcf5451SChristoph Hellwig #define EXT4_SINGLEDATA_TRANS_BLOCKS(sb) \ 353dcf5451SChristoph Hellwig (EXT4_HAS_INCOMPAT_FEATURE(sb, EXT4_FEATURE_INCOMPAT_EXTENTS) \ 3683982b6fSTheodore Ts'o ? 27U : 8U) 373dcf5451SChristoph Hellwig 383dcf5451SChristoph Hellwig /* Extended attribute operations touch at most two data buffers, 393dcf5451SChristoph Hellwig * two bitmap buffers, and two group summaries, in addition to the inode 403dcf5451SChristoph Hellwig * and the superblock, which are already accounted for. */ 413dcf5451SChristoph Hellwig 423dcf5451SChristoph Hellwig #define EXT4_XATTR_TRANS_BLOCKS 6U 433dcf5451SChristoph Hellwig 443dcf5451SChristoph Hellwig /* Define the minimum size for a transaction which modifies data. This 453dcf5451SChristoph Hellwig * needs to take into account the fact that we may end up modifying two 463dcf5451SChristoph Hellwig * quota files too (one for the group, one for the user quota). The 473dcf5451SChristoph Hellwig * superblock only gets updated once, of course, so don't bother 483dcf5451SChristoph Hellwig * counting that again for the quota updates. */ 493dcf5451SChristoph Hellwig 503dcf5451SChristoph Hellwig #define EXT4_DATA_TRANS_BLOCKS(sb) (EXT4_SINGLEDATA_TRANS_BLOCKS(sb) + \ 513dcf5451SChristoph Hellwig EXT4_XATTR_TRANS_BLOCKS - 2 + \ 523dcf5451SChristoph Hellwig 2*EXT4_QUOTA_TRANS_BLOCKS(sb)) 533dcf5451SChristoph Hellwig 54a02908f1SMingming Cao /* 55a02908f1SMingming Cao * Define the number of metadata blocks we need to account to modify data. 56a02908f1SMingming Cao * 57a02908f1SMingming Cao * This include super block, inode block, quota blocks and xattr blocks 58a02908f1SMingming Cao */ 59a02908f1SMingming Cao #define EXT4_META_TRANS_BLOCKS(sb) (EXT4_XATTR_TRANS_BLOCKS + \ 60a02908f1SMingming Cao 2*EXT4_QUOTA_TRANS_BLOCKS(sb)) 61a02908f1SMingming Cao 623dcf5451SChristoph Hellwig /* Delete operations potentially hit one directory's namespace plus an 633dcf5451SChristoph Hellwig * entire inode, plus arbitrary amounts of bitmap/indirection data. Be 643dcf5451SChristoph Hellwig * generous. We can grow the delete transaction later if necessary. */ 653dcf5451SChristoph Hellwig 663dcf5451SChristoph Hellwig #define EXT4_DELETE_TRANS_BLOCKS(sb) (2 * EXT4_DATA_TRANS_BLOCKS(sb) + 64) 673dcf5451SChristoph Hellwig 683dcf5451SChristoph Hellwig /* Define an arbitrary limit for the amount of data we will anticipate 693dcf5451SChristoph Hellwig * writing to any given transaction. For unbounded transactions such as 703dcf5451SChristoph Hellwig * write(2) and truncate(2) we can write more than this, but we always 713dcf5451SChristoph Hellwig * start off at the maximum transaction size and grow the transaction 723dcf5451SChristoph Hellwig * optimistically as we go. */ 733dcf5451SChristoph Hellwig 743dcf5451SChristoph Hellwig #define EXT4_MAX_TRANS_DATA 64U 753dcf5451SChristoph Hellwig 763dcf5451SChristoph Hellwig /* We break up a large truncate or write transaction once the handle's 773dcf5451SChristoph Hellwig * buffer credits gets this low, we need either to extend the 783dcf5451SChristoph Hellwig * transaction or to start a new one. Reserve enough space here for 793dcf5451SChristoph Hellwig * inode, bitmap, superblock, group and indirection updates for at least 803dcf5451SChristoph Hellwig * one block, plus two quota updates. Quota allocations are not 813dcf5451SChristoph Hellwig * needed. */ 823dcf5451SChristoph Hellwig 833dcf5451SChristoph Hellwig #define EXT4_RESERVE_TRANS_BLOCKS 12U 843dcf5451SChristoph Hellwig 853dcf5451SChristoph Hellwig #define EXT4_INDEX_EXTRA_TRANS_BLOCKS 8 863dcf5451SChristoph Hellwig 873dcf5451SChristoph Hellwig #ifdef CONFIG_QUOTA 883dcf5451SChristoph Hellwig /* Amount of blocks needed for quota update - we know that the structure was 893dcf5451SChristoph Hellwig * allocated so we need to update only inode+data */ 903dcf5451SChristoph Hellwig #define EXT4_QUOTA_TRANS_BLOCKS(sb) (test_opt(sb, QUOTA) ? 2 : 0) 913dcf5451SChristoph Hellwig /* Amount of blocks needed for quota insert/delete - we do some block writes 923dcf5451SChristoph Hellwig * but inode, sb and group updates are done only once */ 933dcf5451SChristoph Hellwig #define EXT4_QUOTA_INIT_BLOCKS(sb) (test_opt(sb, QUOTA) ? (DQUOT_INIT_ALLOC*\ 943dcf5451SChristoph Hellwig (EXT4_SINGLEDATA_TRANS_BLOCKS(sb)-3)+3+DQUOT_INIT_REWRITE) : 0) 953dcf5451SChristoph Hellwig #define EXT4_QUOTA_DEL_BLOCKS(sb) (test_opt(sb, QUOTA) ? (DQUOT_DEL_ALLOC*\ 963dcf5451SChristoph Hellwig (EXT4_SINGLEDATA_TRANS_BLOCKS(sb)-3)+3+DQUOT_DEL_REWRITE) : 0) 973dcf5451SChristoph Hellwig #else 983dcf5451SChristoph Hellwig #define EXT4_QUOTA_TRANS_BLOCKS(sb) 0 993dcf5451SChristoph Hellwig #define EXT4_QUOTA_INIT_BLOCKS(sb) 0 1003dcf5451SChristoph Hellwig #define EXT4_QUOTA_DEL_BLOCKS(sb) 0 1013dcf5451SChristoph Hellwig #endif 1023dcf5451SChristoph Hellwig 1033dcf5451SChristoph Hellwig int 1043dcf5451SChristoph Hellwig ext4_mark_iloc_dirty(handle_t *handle, 1053dcf5451SChristoph Hellwig struct inode *inode, 1063dcf5451SChristoph Hellwig struct ext4_iloc *iloc); 1073dcf5451SChristoph Hellwig 1083dcf5451SChristoph Hellwig /* 1093dcf5451SChristoph Hellwig * On success, We end up with an outstanding reference count against 1103dcf5451SChristoph Hellwig * iloc->bh. This _must_ be cleaned up later. 1113dcf5451SChristoph Hellwig */ 1123dcf5451SChristoph Hellwig 1133dcf5451SChristoph Hellwig int ext4_reserve_inode_write(handle_t *handle, struct inode *inode, 1143dcf5451SChristoph Hellwig struct ext4_iloc *iloc); 1153dcf5451SChristoph Hellwig 1163dcf5451SChristoph Hellwig int ext4_mark_inode_dirty(handle_t *handle, struct inode *inode); 1173dcf5451SChristoph Hellwig 1183dcf5451SChristoph Hellwig /* 1193dcf5451SChristoph Hellwig * Wrapper functions with which ext4 calls into JBD. The intent here is 1203dcf5451SChristoph Hellwig * to allow these to be turned into appropriate stubs so ext4 can control 1213dcf5451SChristoph Hellwig * ext2 filesystems, so ext2+ext4 systems only nee one fs. This work hasn't 1223dcf5451SChristoph Hellwig * been done yet. 1233dcf5451SChristoph Hellwig */ 1243dcf5451SChristoph Hellwig 1253dcf5451SChristoph Hellwig void ext4_journal_abort_handle(const char *caller, const char *err_fn, 1263dcf5451SChristoph Hellwig struct buffer_head *bh, handle_t *handle, int err); 1273dcf5451SChristoph Hellwig 1283dcf5451SChristoph Hellwig int __ext4_journal_get_undo_access(const char *where, handle_t *handle, 1293dcf5451SChristoph Hellwig struct buffer_head *bh); 1303dcf5451SChristoph Hellwig 1313dcf5451SChristoph Hellwig int __ext4_journal_get_write_access(const char *where, handle_t *handle, 1323dcf5451SChristoph Hellwig struct buffer_head *bh); 1333dcf5451SChristoph Hellwig 134e6b5d301SCurt Wohlgemuth /* When called with an invalid handle, this will still do a put on the BH */ 1353dcf5451SChristoph Hellwig int __ext4_journal_forget(const char *where, handle_t *handle, 1363dcf5451SChristoph Hellwig struct buffer_head *bh); 1373dcf5451SChristoph Hellwig 138e6b5d301SCurt Wohlgemuth /* When called with an invalid handle, this will still do a put on the BH */ 1393dcf5451SChristoph Hellwig int __ext4_journal_revoke(const char *where, handle_t *handle, 1403dcf5451SChristoph Hellwig ext4_fsblk_t blocknr, struct buffer_head *bh); 1413dcf5451SChristoph Hellwig 142d6797d14STheodore Ts'o int __ext4_forget(const char *where, handle_t *handle, int is_metadata, 143d6797d14STheodore Ts'o struct inode *inode, struct buffer_head *bh, 144d6797d14STheodore Ts'o ext4_fsblk_t blocknr); 145d6797d14STheodore Ts'o 1463dcf5451SChristoph Hellwig int __ext4_journal_get_create_access(const char *where, 1473dcf5451SChristoph Hellwig handle_t *handle, struct buffer_head *bh); 1483dcf5451SChristoph Hellwig 1490390131bSFrank Mayhar int __ext4_handle_dirty_metadata(const char *where, handle_t *handle, 1500390131bSFrank Mayhar struct inode *inode, struct buffer_head *bh); 1513dcf5451SChristoph Hellwig 1523dcf5451SChristoph Hellwig #define ext4_journal_get_undo_access(handle, bh) \ 1534db9c54aSStoyan Gaydarov __ext4_journal_get_undo_access(__func__, (handle), (bh)) 1543dcf5451SChristoph Hellwig #define ext4_journal_get_write_access(handle, bh) \ 1554db9c54aSStoyan Gaydarov __ext4_journal_get_write_access(__func__, (handle), (bh)) 1563dcf5451SChristoph Hellwig #define ext4_journal_revoke(handle, blocknr, bh) \ 1574db9c54aSStoyan Gaydarov __ext4_journal_revoke(__func__, (handle), (blocknr), (bh)) 158d6797d14STheodore Ts'o #define ext4_forget(handle, is_metadata, inode, bh, block_nr) \ 159d6797d14STheodore Ts'o __ext4_forget(__func__, (handle), (is_metadata), (inode), (bh),\ 160d6797d14STheodore Ts'o (block_nr)) 1613dcf5451SChristoph Hellwig #define ext4_journal_get_create_access(handle, bh) \ 1624db9c54aSStoyan Gaydarov __ext4_journal_get_create_access(__func__, (handle), (bh)) 1633dcf5451SChristoph Hellwig #define ext4_journal_forget(handle, bh) \ 1644db9c54aSStoyan Gaydarov __ext4_journal_forget(__func__, (handle), (bh)) 1650390131bSFrank Mayhar #define ext4_handle_dirty_metadata(handle, inode, bh) \ 1660390131bSFrank Mayhar __ext4_handle_dirty_metadata(__func__, (handle), (inode), (bh)) 1673dcf5451SChristoph Hellwig 1683dcf5451SChristoph Hellwig handle_t *ext4_journal_start_sb(struct super_block *sb, int nblocks); 1693dcf5451SChristoph Hellwig int __ext4_journal_stop(const char *where, handle_t *handle); 1703dcf5451SChristoph Hellwig 171d3d1faf6SCurt Wohlgemuth #define EXT4_NOJOURNAL_MAX_REF_COUNT ((unsigned long) 4096) 1720390131bSFrank Mayhar 173d3d1faf6SCurt Wohlgemuth /* Note: Do not use this for NULL handles. This is only to determine if 174d3d1faf6SCurt Wohlgemuth * a properly allocated handle is using a journal or not. */ 1750390131bSFrank Mayhar static inline int ext4_handle_valid(handle_t *handle) 1760390131bSFrank Mayhar { 177d3d1faf6SCurt Wohlgemuth if ((unsigned long)handle < EXT4_NOJOURNAL_MAX_REF_COUNT) 1780390131bSFrank Mayhar return 0; 1790390131bSFrank Mayhar return 1; 1800390131bSFrank Mayhar } 1810390131bSFrank Mayhar 1820390131bSFrank Mayhar static inline void ext4_handle_sync(handle_t *handle) 1830390131bSFrank Mayhar { 1840390131bSFrank Mayhar if (ext4_handle_valid(handle)) 1850390131bSFrank Mayhar handle->h_sync = 1; 1860390131bSFrank Mayhar } 1870390131bSFrank Mayhar 1880390131bSFrank Mayhar static inline void ext4_handle_release_buffer(handle_t *handle, 1890390131bSFrank Mayhar struct buffer_head *bh) 1900390131bSFrank Mayhar { 1910390131bSFrank Mayhar if (ext4_handle_valid(handle)) 1920390131bSFrank Mayhar jbd2_journal_release_buffer(handle, bh); 1930390131bSFrank Mayhar } 1940390131bSFrank Mayhar 1950390131bSFrank Mayhar static inline int ext4_handle_is_aborted(handle_t *handle) 1960390131bSFrank Mayhar { 1970390131bSFrank Mayhar if (ext4_handle_valid(handle)) 1980390131bSFrank Mayhar return is_handle_aborted(handle); 1990390131bSFrank Mayhar return 0; 2000390131bSFrank Mayhar } 2010390131bSFrank Mayhar 2020390131bSFrank Mayhar static inline int ext4_handle_has_enough_credits(handle_t *handle, int needed) 2030390131bSFrank Mayhar { 2040390131bSFrank Mayhar if (ext4_handle_valid(handle) && handle->h_buffer_credits < needed) 2050390131bSFrank Mayhar return 0; 2060390131bSFrank Mayhar return 1; 2070390131bSFrank Mayhar } 2080390131bSFrank Mayhar 2090390131bSFrank Mayhar static inline void ext4_journal_release_buffer(handle_t *handle, 2100390131bSFrank Mayhar struct buffer_head *bh) 2110390131bSFrank Mayhar { 2120390131bSFrank Mayhar if (ext4_handle_valid(handle)) 2130390131bSFrank Mayhar jbd2_journal_release_buffer(handle, bh); 2140390131bSFrank Mayhar } 2150390131bSFrank Mayhar 2163dcf5451SChristoph Hellwig static inline handle_t *ext4_journal_start(struct inode *inode, int nblocks) 2173dcf5451SChristoph Hellwig { 2183dcf5451SChristoph Hellwig return ext4_journal_start_sb(inode->i_sb, nblocks); 2193dcf5451SChristoph Hellwig } 2203dcf5451SChristoph Hellwig 2213dcf5451SChristoph Hellwig #define ext4_journal_stop(handle) \ 2224db9c54aSStoyan Gaydarov __ext4_journal_stop(__func__, (handle)) 2233dcf5451SChristoph Hellwig 2243dcf5451SChristoph Hellwig static inline handle_t *ext4_journal_current_handle(void) 2253dcf5451SChristoph Hellwig { 2263dcf5451SChristoph Hellwig return journal_current_handle(); 2273dcf5451SChristoph Hellwig } 2283dcf5451SChristoph Hellwig 2293dcf5451SChristoph Hellwig static inline int ext4_journal_extend(handle_t *handle, int nblocks) 2303dcf5451SChristoph Hellwig { 2310390131bSFrank Mayhar if (ext4_handle_valid(handle)) 2323dcf5451SChristoph Hellwig return jbd2_journal_extend(handle, nblocks); 2330390131bSFrank Mayhar return 0; 2343dcf5451SChristoph Hellwig } 2353dcf5451SChristoph Hellwig 2363dcf5451SChristoph Hellwig static inline int ext4_journal_restart(handle_t *handle, int nblocks) 2373dcf5451SChristoph Hellwig { 2380390131bSFrank Mayhar if (ext4_handle_valid(handle)) 2393dcf5451SChristoph Hellwig return jbd2_journal_restart(handle, nblocks); 2400390131bSFrank Mayhar return 0; 2413dcf5451SChristoph Hellwig } 2423dcf5451SChristoph Hellwig 2433dcf5451SChristoph Hellwig static inline int ext4_journal_blocks_per_page(struct inode *inode) 2443dcf5451SChristoph Hellwig { 2450390131bSFrank Mayhar if (EXT4_JOURNAL(inode) != NULL) 2463dcf5451SChristoph Hellwig return jbd2_journal_blocks_per_page(inode); 2470390131bSFrank Mayhar return 0; 2483dcf5451SChristoph Hellwig } 2493dcf5451SChristoph Hellwig 2503dcf5451SChristoph Hellwig static inline int ext4_journal_force_commit(journal_t *journal) 2513dcf5451SChristoph Hellwig { 2520390131bSFrank Mayhar if (journal) 2533dcf5451SChristoph Hellwig return jbd2_journal_force_commit(journal); 2540390131bSFrank Mayhar return 0; 2553dcf5451SChristoph Hellwig } 2563dcf5451SChristoph Hellwig 257678aaf48SJan Kara static inline int ext4_jbd2_file_inode(handle_t *handle, struct inode *inode) 258678aaf48SJan Kara { 2590390131bSFrank Mayhar if (ext4_handle_valid(handle)) 260678aaf48SJan Kara return jbd2_journal_file_inode(handle, &EXT4_I(inode)->jinode); 2610390131bSFrank Mayhar return 0; 262678aaf48SJan Kara } 263678aaf48SJan Kara 2643dcf5451SChristoph Hellwig /* super.c */ 2653dcf5451SChristoph Hellwig int ext4_force_commit(struct super_block *sb); 2663dcf5451SChristoph Hellwig 2673dcf5451SChristoph Hellwig static inline int ext4_should_journal_data(struct inode *inode) 2683dcf5451SChristoph Hellwig { 2690390131bSFrank Mayhar if (EXT4_JOURNAL(inode) == NULL) 2700390131bSFrank Mayhar return 0; 2713dcf5451SChristoph Hellwig if (!S_ISREG(inode->i_mode)) 2723dcf5451SChristoph Hellwig return 1; 2733dcf5451SChristoph Hellwig if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_JOURNAL_DATA) 2743dcf5451SChristoph Hellwig return 1; 2753dcf5451SChristoph Hellwig if (EXT4_I(inode)->i_flags & EXT4_JOURNAL_DATA_FL) 2763dcf5451SChristoph Hellwig return 1; 2773dcf5451SChristoph Hellwig return 0; 2783dcf5451SChristoph Hellwig } 2793dcf5451SChristoph Hellwig 2803dcf5451SChristoph Hellwig static inline int ext4_should_order_data(struct inode *inode) 2813dcf5451SChristoph Hellwig { 2820390131bSFrank Mayhar if (EXT4_JOURNAL(inode) == NULL) 2830390131bSFrank Mayhar return 0; 2843dcf5451SChristoph Hellwig if (!S_ISREG(inode->i_mode)) 2853dcf5451SChristoph Hellwig return 0; 2863dcf5451SChristoph Hellwig if (EXT4_I(inode)->i_flags & EXT4_JOURNAL_DATA_FL) 2873dcf5451SChristoph Hellwig return 0; 2883dcf5451SChristoph Hellwig if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_ORDERED_DATA) 2893dcf5451SChristoph Hellwig return 1; 2903dcf5451SChristoph Hellwig return 0; 2913dcf5451SChristoph Hellwig } 2923dcf5451SChristoph Hellwig 2933dcf5451SChristoph Hellwig static inline int ext4_should_writeback_data(struct inode *inode) 2943dcf5451SChristoph Hellwig { 2953dcf5451SChristoph Hellwig if (!S_ISREG(inode->i_mode)) 2963dcf5451SChristoph Hellwig return 0; 2975adfee9cSTheodore Ts'o if (EXT4_JOURNAL(inode) == NULL) 2985adfee9cSTheodore Ts'o return 1; 2993dcf5451SChristoph Hellwig if (EXT4_I(inode)->i_flags & EXT4_JOURNAL_DATA_FL) 3003dcf5451SChristoph Hellwig return 0; 3013dcf5451SChristoph Hellwig if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_WRITEBACK_DATA) 3023dcf5451SChristoph Hellwig return 1; 3033dcf5451SChristoph Hellwig return 0; 3043dcf5451SChristoph Hellwig } 3053dcf5451SChristoph Hellwig 3063dcf5451SChristoph Hellwig #endif /* _EXT4_JBD2_H */ 307