fs/ext4/ext4_jbd2.h

   1 /*
   2  * ext4_jbd2.h
   3  *
   4  * Written by Stephen C. Tweedie <sct@redhat.com>, 1999
   5  *
   6  * Copyright 1998--1999 Red Hat corp --- All Rights Reserved
   7  *
   8  * This file is part of the Linux kernel and is made available under
   9  * the terms of the GNU General Public License, version 2, or at your
  10  * option, any later version, incorporated herein by reference.
  11  *
  12  * Ext4-specific journaling extensions.
  13  */
  14
  15 #ifndef _EXT4_JBD2_H
  16 #define _EXT4_JBD2_H
  17
  18 #include <linux/fs.h>
  19 #include <linux/jbd2.h>
  20 #include "ext4.h"
  21
  22 #define EXT4_JOURNAL(inode)     (EXT4_SB((inode)->i_sb)->s_journal)
  23
  24 /* Define the number of blocks we need to account to a transaction to
  25  * modify one block of data.
  26  *
  27  * We may have to touch one inode, one bitmap buffer, up to three
  28  * indirection blocks, the group and superblock summaries, and the data
  29  * block to complete the transaction.
  30  *
  31  * For extents-enabled fs we may have to allocate and modify up to
  32  * 5 levels of tree, data block (for each of these we need bitmap + group
  33  * summaries), root which is stored in the inode, sb
  34  */
  35
  36 #define EXT4_SINGLEDATA_TRANS_BLOCKS(sb)                                \
  37         (EXT4_HAS_INCOMPAT_FEATURE(sb, EXT4_FEATURE_INCOMPAT_EXTENTS)   \
  38          ? 20U : 8U)
  39
  40 /* Extended attribute operations touch at most two data buffers,
  41  * two bitmap buffers, and two group summaries, in addition to the inode
  42  * and the superblock, which are already accounted for. */
  43
  44 #define EXT4_XATTR_TRANS_BLOCKS         6U
  45
  46 /* Define the minimum size for a transaction which modifies data.  This
  47  * needs to take into account the fact that we may end up modifying two
  48  * quota files too (one for the group, one for the user quota).  The
  49  * superblock only gets updated once, of course, so don't bother
  50  * counting that again for the quota updates. */
  51
  52 #define EXT4_DATA_TRANS_BLOCKS(sb)      (EXT4_SINGLEDATA_TRANS_BLOCKS(sb) + \
  53                                          EXT4_XATTR_TRANS_BLOCKS - 2 + \
  54                                          EXT4_MAXQUOTAS_TRANS_BLOCKS(sb))
  55
  56 /*
  57  * Define the number of metadata blocks we need to account to modify data.
  58  *
  59  * This include super block, inode block, quota blocks and xattr blocks
  60  */
  61 #define EXT4_META_TRANS_BLOCKS(sb)      (EXT4_XATTR_TRANS_BLOCKS + \
  62                                         EXT4_MAXQUOTAS_TRANS_BLOCKS(sb))
  63
  64 /* Define an arbitrary limit for the amount of data we will anticipate
  65  * writing to any given transaction.  For unbounded transactions such as
  66  * write(2) and truncate(2) we can write more than this, but we always
  67  * start off at the maximum transaction size and grow the transaction
  68  * optimistically as we go. */
  69
  70 #define EXT4_MAX_TRANS_DATA             64U
  71
  72 /* We break up a large truncate or write transaction once the handle's
  73  * buffer credits gets this low, we need either to extend the
  74  * transaction or to start a new one.  Reserve enough space here for
  75  * inode, bitmap, superblock, group and indirection updates for at least
  76  * one block, plus two quota updates.  Quota allocations are not
  77  * needed. */
  78
  79 #define EXT4_RESERVE_TRANS_BLOCKS       12U
  80
  81 #define EXT4_INDEX_EXTRA_TRANS_BLOCKS   8
  82
  83 #ifdef CONFIG_QUOTA
  84 /* Amount of blocks needed for quota update - we know that the structure was
  85  * allocated so we need to update only data block */
  86 #define EXT4_QUOTA_TRANS_BLOCKS(sb) ((test_opt(sb, QUOTA) ||\
  87                 EXT4_HAS_RO_COMPAT_FEATURE(sb, EXT4_FEATURE_RO_COMPAT_QUOTA)) ?\
  88                 1 : 0)
  89 /* Amount of blocks needed for quota insert/delete - we do some block writes
  90  * but inode, sb and group updates are done only once */
  91 #define EXT4_QUOTA_INIT_BLOCKS(sb) ((test_opt(sb, QUOTA) ||\
  92                 EXT4_HAS_RO_COMPAT_FEATURE(sb, EXT4_FEATURE_RO_COMPAT_QUOTA)) ?\
  93                 (DQUOT_INIT_ALLOC*(EXT4_SINGLEDATA_TRANS_BLOCKS(sb)-3)\
  94                  +3+DQUOT_INIT_REWRITE) : 0)
  95
  96 #define EXT4_QUOTA_DEL_BLOCKS(sb) ((test_opt(sb, QUOTA) ||\
  97                 EXT4_HAS_RO_COMPAT_FEATURE(sb, EXT4_FEATURE_RO_COMPAT_QUOTA)) ?\
  98                 (DQUOT_DEL_ALLOC*(EXT4_SINGLEDATA_TRANS_BLOCKS(sb)-3)\
  99                  +3+DQUOT_DEL_REWRITE) : 0)
 100 #else
 101 #define EXT4_QUOTA_TRANS_BLOCKS(sb) 0
 102 #define EXT4_QUOTA_INIT_BLOCKS(sb) 0
 103 #define EXT4_QUOTA_DEL_BLOCKS(sb) 0
 104 #endif
 105 #define EXT4_MAXQUOTAS_TRANS_BLOCKS(sb) (MAXQUOTAS*EXT4_QUOTA_TRANS_BLOCKS(sb))
 106 #define EXT4_MAXQUOTAS_INIT_BLOCKS(sb) (MAXQUOTAS*EXT4_QUOTA_INIT_BLOCKS(sb))
 107 #define EXT4_MAXQUOTAS_DEL_BLOCKS(sb) (MAXQUOTAS*EXT4_QUOTA_DEL_BLOCKS(sb))
 108
 109 static inline int ext4_jbd2_credits_xattr(struct inode *inode)
 110 {
 111         int credits = EXT4_DATA_TRANS_BLOCKS(inode->i_sb);
 112
 113         /*
 114          * In case of inline data, we may push out the data to a block,
 115          * so we need to reserve credits for this eventuality
 116          */
 117         if (ext4_has_inline_data(inode))
 118                 credits += ext4_writepage_trans_blocks(inode) + 1;
 119         return credits;
 120 }
 121
 122
 123 /*
 124  * Ext4 handle operation types -- for logging purposes
 125  */
 126 #define EXT4_HT_MISC             0
 127 #define EXT4_HT_INODE            1
 128 #define EXT4_HT_WRITE_PAGE       2
 129 #define EXT4_HT_MAP_BLOCKS       3
 130 #define EXT4_HT_DIR              4
 131 #define EXT4_HT_TRUNCATE         5
 132 #define EXT4_HT_QUOTA            6
 133 #define EXT4_HT_RESIZE           7
 134 #define EXT4_HT_MIGRATE          8
 135 #define EXT4_HT_MOVE_EXTENTS     9
 136 #define EXT4_HT_XATTR           10
 137 #define EXT4_HT_EXT_CONVERT     11
 138 #define EXT4_HT_MAX             12
 139
 140 /**
 141  *   struct ext4_journal_cb_entry - Base structure for callback information.
 142  *
 143  *   This struct is a 'seed' structure for a using with your own callback
 144  *   structs. If you are using callbacks you must allocate one of these
 145  *   or another struct of your own definition which has this struct
 146  *   as it's first element and pass it to ext4_journal_callback_add().
 147  */
 148 struct ext4_journal_cb_entry {
 149         /* list information for other callbacks attached to the same handle */
 150         struct list_head jce_list;
 151
 152         /*  Function to call with this callback structure */
 153         void (*jce_func)(struct super_block *sb,
 154                          struct ext4_journal_cb_entry *jce, int error);
 155
 156         /* user data goes here */
 157 };
 158
 159 /**
 160  * ext4_journal_callback_add: add a function to call after transaction commit
 161  * @handle: active journal transaction handle to register callback on
 162  * @func: callback function to call after the transaction has committed:
 163  *        @sb: superblock of current filesystem for transaction
 164  *        @jce: returned journal callback data
 165  *        @rc: journal state at commit (0 = transaction committed properly)
 166  * @jce: journal callback data (internal and function private data struct)
 167  *
 168  * The registered function will be called in the context of the journal thread
 169  * after the transaction for which the handle was created has completed.
 170  *
 171  * No locks are held when the callback function is called, so it is safe to
 172  * call blocking functions from within the callback, but the callback should
 173  * not block or run for too long, or the filesystem will be blocked waiting for
 174  * the next transaction to commit. No journaling functions can be used, or
 175  * there is a risk of deadlock.
 176  *
 177  * There is no guaranteed calling order of multiple registered callbacks on
 178  * the same transaction.
 179  */
 180 static inline void ext4_journal_callback_add(handle_t *handle,
 181                         void (*func)(struct super_block *sb,
 182                                      struct ext4_journal_cb_entry *jce,
 183                                      int rc),
 184                         struct ext4_journal_cb_entry *jce)
 185 {
 186         struct ext4_sb_info *sbi =
 187                         EXT4_SB(handle->h_transaction->t_journal->j_private);
 188
 189         /* Add the jce to transaction's private list */
 190         jce->jce_func = func;
 191         spin_lock(&sbi->s_md_lock);
 192         list_add_tail(&jce->jce_list, &handle->h_transaction->t_private_list);
 193         spin_unlock(&sbi->s_md_lock);
 194 }
 195
 196 /**
 197  * ext4_journal_callback_del: delete a registered callback
 198  * @handle: active journal transaction handle on which callback was registered
 199  * @jce: registered journal callback entry to unregister
 200  * Return true if object was sucessfully removed
 201  */
 202 static inline bool ext4_journal_callback_try_del(handle_t *handle,
 203                                              struct ext4_journal_cb_entry *jce)
 204 {
 205         bool deleted;
 206         struct ext4_sb_info *sbi =
 207                         EXT4_SB(handle->h_transaction->t_journal->j_private);
 208
 209         spin_lock(&sbi->s_md_lock);
 210         deleted = !list_empty(&jce->jce_list);
 211         list_del_init(&jce->jce_list);
 212         spin_unlock(&sbi->s_md_lock);
 213         return deleted;
 214 }
 215
 216 int
 217 ext4_mark_iloc_dirty(handle_t *handle,
 218                      struct inode *inode,
 219                      struct ext4_iloc *iloc);
 220
 221 /*
 222  * On success, We end up with an outstanding reference count against
 223  * iloc->bh.  This _must_ be cleaned up later.
 224  */
 225
 226 int ext4_reserve_inode_write(handle_t *handle, struct inode *inode,
 227                         struct ext4_iloc *iloc);
 228
 229 int ext4_mark_inode_dirty(handle_t *handle, struct inode *inode);
 230
 231 /*
 232  * Wrapper functions with which ext4 calls into JBD.
 233  */
 234 void ext4_journal_abort_handle(const char *caller, unsigned int line,
 235                                const char *err_fn,
 236                 struct buffer_head *bh, handle_t *handle, int err);
 237
 238 int __ext4_journal_get_write_access(const char *where, unsigned int line,
 239                                     handle_t *handle, struct buffer_head *bh);
 240
 241 int __ext4_forget(const char *where, unsigned int line, handle_t *handle,
 242                   int is_metadata, struct inode *inode,
 243                   struct buffer_head *bh, ext4_fsblk_t blocknr);
 244
 245 int __ext4_journal_get_create_access(const char *where, unsigned int line,
 246                                 handle_t *handle, struct buffer_head *bh);
 247
 248 int __ext4_handle_dirty_metadata(const char *where, unsigned int line,
 249                                  handle_t *handle, struct inode *inode,
 250                                  struct buffer_head *bh);
 251
 252 int __ext4_handle_dirty_super(const char *where, unsigned int line,
 253                               handle_t *handle, struct super_block *sb);
 254
 255 #define ext4_journal_get_write_access(handle, bh) \
 256         __ext4_journal_get_write_access(__func__, __LINE__, (handle), (bh))
 257 #define ext4_forget(handle, is_metadata, inode, bh, block_nr) \
 258         __ext4_forget(__func__, __LINE__, (handle), (is_metadata), (inode), \
 259                       (bh), (block_nr))
 260 #define ext4_journal_get_create_access(handle, bh) \
 261         __ext4_journal_get_create_access(__func__, __LINE__, (handle), (bh))
 262 #define ext4_handle_dirty_metadata(handle, inode, bh) \
 263         __ext4_handle_dirty_metadata(__func__, __LINE__, (handle), (inode), \
 264                                      (bh))
 265 #define ext4_handle_dirty_super(handle, sb) \
 266         __ext4_handle_dirty_super(__func__, __LINE__, (handle), (sb))
 267
 268 handle_t *__ext4_journal_start_sb(struct super_block *sb, unsigned int line,
 269                                   int type, int blocks, int rsv_blocks);
 270 int __ext4_journal_stop(const char *where, unsigned int line, handle_t *handle);
 271
 272 #define EXT4_NOJOURNAL_MAX_REF_COUNT ((unsigned long) 4096)
 273
 274 /* Note:  Do not use this for NULL handles.  This is only to determine if
 275  * a properly allocated handle is using a journal or not. */
 276 static inline int ext4_handle_valid(handle_t *handle)
 277 {
 278         if ((unsigned long)handle < EXT4_NOJOURNAL_MAX_REF_COUNT)
 279                 return 0;
 280         return 1;
 281 }
 282
 283 static inline void ext4_handle_sync(handle_t *handle)
 284 {
 285         if (ext4_handle_valid(handle))
 286                 handle->h_sync = 1;
 287 }
 288
 289 static inline int ext4_handle_is_aborted(handle_t *handle)
 290 {
 291         if (ext4_handle_valid(handle))
 292                 return is_handle_aborted(handle);
 293         return 0;
 294 }
 295
 296 static inline int ext4_handle_has_enough_credits(handle_t *handle, int needed)
 297 {
 298         if (ext4_handle_valid(handle) && handle->h_buffer_credits < needed)
 299                 return 0;
 300         return 1;
 301 }
 302
 303 #define ext4_journal_start_sb(sb, type, nblocks)                        \
 304         __ext4_journal_start_sb((sb), __LINE__, (type), (nblocks), 0)
 305
 306 #define ext4_journal_start(inode, type, nblocks)                        \
 307         __ext4_journal_start((inode), __LINE__, (type), (nblocks), 0)
 308
 309 #define ext4_journal_start_with_reserve(inode, type, blocks, rsv_blocks) \
 310         __ext4_journal_start((inode), __LINE__, (type), (blocks), (rsv_blocks))
 311
 312 static inline handle_t *__ext4_journal_start(struct inode *inode,
 313                                              unsigned int line, int type,
 314                                              int blocks, int rsv_blocks)
 315 {
 316         return __ext4_journal_start_sb(inode->i_sb, line, type, blocks,
 317                                        rsv_blocks);
 318 }
 319
 320 #define ext4_journal_stop(handle) \
 321         __ext4_journal_stop(__func__, __LINE__, (handle))
 322
 323 #define ext4_journal_start_reserved(handle, type) \
 324         __ext4_journal_start_reserved((handle), __LINE__, (type))
 325
 326 handle_t *__ext4_journal_start_reserved(handle_t *handle, unsigned int line,
 327                                         int type);
 328
 329 static inline void ext4_journal_free_reserved(handle_t *handle)
 330 {
 331         if (ext4_handle_valid(handle))
 332                 jbd2_journal_free_reserved(handle);
 333 }
 334
 335 static inline handle_t *ext4_journal_current_handle(void)
 336 {
 337         return journal_current_handle();
 338 }
 339
 340 static inline int ext4_journal_extend(handle_t *handle, int nblocks)
 341 {
 342         if (ext4_handle_valid(handle))
 343                 return jbd2_journal_extend(handle, nblocks);
 344         return 0;
 345 }
 346
 347 static inline int ext4_journal_restart(handle_t *handle, int nblocks)
 348 {
 349         if (ext4_handle_valid(handle))
 350                 return jbd2_journal_restart(handle, nblocks);
 351         return 0;
 352 }
 353
 354 static inline int ext4_journal_blocks_per_page(struct inode *inode)
 355 {
 356         if (EXT4_JOURNAL(inode) != NULL)
 357                 return jbd2_journal_blocks_per_page(inode);
 358         return 0;
 359 }
 360
 361 static inline int ext4_journal_force_commit(journal_t *journal)
 362 {
 363         if (journal)
 364                 return jbd2_journal_force_commit(journal);
 365         return 0;
 366 }
 367
 368 static inline int ext4_jbd2_file_inode(handle_t *handle, struct inode *inode)
 369 {
 370         if (ext4_handle_valid(handle))
 371                 return jbd2_journal_file_inode(handle, EXT4_I(inode)->jinode);
 372         return 0;
 373 }
 374
 375 static inline void ext4_update_inode_fsync_trans(handle_t *handle,
 376                                                  struct inode *inode,
 377                                                  int datasync)
 378 {
 379         struct ext4_inode_info *ei = EXT4_I(inode);
 380
 381         if (ext4_handle_valid(handle)) {
 382                 ei->i_sync_tid = handle->h_transaction->t_tid;
 383                 if (datasync)
 384                         ei->i_datasync_tid = handle->h_transaction->t_tid;
 385         }
 386 }
 387
 388 /* super.c */
 389 int ext4_force_commit(struct super_block *sb);
 390
 391 /*
 392  * Ext4 inode journal modes
 393  */
 394 #define EXT4_INODE_JOURNAL_DATA_MODE    0x01 /* journal data mode */
 395 #define EXT4_INODE_ORDERED_DATA_MODE    0x02 /* ordered data mode */
 396 #define EXT4_INODE_WRITEBACK_DATA_MODE  0x04 /* writeback data mode */
 397
 398 static inline int ext4_inode_journal_mode(struct inode *inode)
 399 {
 400         if (EXT4_JOURNAL(inode) == NULL)
 401                 return EXT4_INODE_WRITEBACK_DATA_MODE;  /* writeback */
 402         /* We do not support data journalling with delayed allocation */
 403         if (!S_ISREG(inode->i_mode) ||
 404             test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_JOURNAL_DATA)
 405                 return EXT4_INODE_JOURNAL_DATA_MODE;    /* journal data */
 406         if (ext4_test_inode_flag(inode, EXT4_INODE_JOURNAL_DATA) &&
 407             !test_opt(inode->i_sb, DELALLOC))
 408                 return EXT4_INODE_JOURNAL_DATA_MODE;    /* journal data */
 409         if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_ORDERED_DATA)
 410                 return EXT4_INODE_ORDERED_DATA_MODE;    /* ordered */
 411         if (test_opt(inode->i_sb, DATA_FLAGS) == EXT4_MOUNT_WRITEBACK_DATA)
 412                 return EXT4_INODE_WRITEBACK_DATA_MODE;  /* writeback */
 413         else
 414                 BUG();
 415 }
 416
 417 static inline int ext4_should_journal_data(struct inode *inode)
 418 {
 419         return ext4_inode_journal_mode(inode) & EXT4_INODE_JOURNAL_DATA_MODE;
 420 }
 421
 422 static inline int ext4_should_order_data(struct inode *inode)
 423 {
 424         return ext4_inode_journal_mode(inode) & EXT4_INODE_ORDERED_DATA_MODE;
 425 }
 426
 427 static inline int ext4_should_writeback_data(struct inode *inode)
 428 {
 429         return ext4_inode_journal_mode(inode) & EXT4_INODE_WRITEBACK_DATA_MODE;
 430 }
 431
 432 /*
 433  * This function controls whether or not we should try to go down the
 434  * dioread_nolock code paths, which makes it safe to avoid taking
 435  * i_mutex for direct I/O reads.  This only works for extent-based
 436  * files, and it doesn't work if data journaling is enabled, since the
 437  * dioread_nolock code uses b_private to pass information back to the
 438  * I/O completion handler, and this conflicts with the jbd's use of
 439  * b_private.
 440  */
 441 static inline int ext4_should_dioread_nolock(struct inode *inode)
 442 {
 443         if (!test_opt(inode->i_sb, DIOREAD_NOLOCK))
 444                 return 0;
 445         if (!S_ISREG(inode->i_mode))
 446                 return 0;
 447         if (!(ext4_test_inode_flag(inode, EXT4_INODE_EXTENTS)))
 448                 return 0;
 449         if (ext4_should_journal_data(inode))
 450                 return 0;
 451         return 1;
 452 }
 453
 454 #endif  /* _EXT4_JBD2_H */