err.no Git - linux-2.6/blob - fs/ocfs2/journal.h

   1 /* -*- mode: c; c-basic-offset: 8; -*-
   2  * vim: noexpandtab sw=8 ts=8 sts=0:
   3  *
   4  * journal.h
   5  *
   6  * Defines journalling api and structures.
   7  *
   8  * Copyright (C) 2003, 2005 Oracle.  All rights reserved.
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2 of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public
  21  * License along with this program; if not, write to the
  22  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23  * Boston, MA 021110-1307, USA.
  24  */
  25
  26 #ifndef OCFS2_JOURNAL_H
  27 #define OCFS2_JOURNAL_H
  28
  29 #include <linux/fs.h>
  30 #include <linux/jbd.h>
  31
  32 enum ocfs2_journal_state {
  33         OCFS2_JOURNAL_FREE = 0,
  34         OCFS2_JOURNAL_LOADED,
  35         OCFS2_JOURNAL_IN_SHUTDOWN,
  36 };
  37
  38 struct ocfs2_super;
  39 struct ocfs2_dinode;
  40 struct ocfs2_journal_handle;
  41
  42 struct ocfs2_journal {
  43         enum ocfs2_journal_state   j_state;    /* Journals current state   */
  44
  45         journal_t                 *j_journal; /* The kernels journal type */
  46         struct inode              *j_inode;   /* Kernel inode pointing to
  47                                                * this journal             */
  48         struct ocfs2_super        *j_osb;     /* pointer to the super
  49                                                * block for the node
  50                                                * we're currently
  51                                                * running on -- not
  52                                                * necessarily the super
  53                                                * block from the node
  54                                                * which we usually run
  55                                                * from (recovery,
  56                                                * etc)                     */
  57         struct buffer_head        *j_bh;      /* Journal disk inode block */
  58         atomic_t                  j_num_trans; /* Number of transactions
  59                                                 * currently in the system. */
  60         unsigned long             j_trans_id;
  61         struct rw_semaphore       j_trans_barrier;
  62         wait_queue_head_t         j_checkpointed;
  63
  64         spinlock_t                j_lock;
  65         struct list_head          j_la_cleanups;
  66         struct work_struct        j_recovery_work;
  67 };
  68
  69 extern spinlock_t trans_inc_lock;
  70
  71 /* wrap j_trans_id so we never have it equal to zero. */
  72 static inline unsigned long ocfs2_inc_trans_id(struct ocfs2_journal *j)
  73 {
  74         unsigned long old_id;
  75         spin_lock(&trans_inc_lock);
  76         old_id = j->j_trans_id++;
  77         if (unlikely(!j->j_trans_id))
  78                 j->j_trans_id = 1;
  79         spin_unlock(&trans_inc_lock);
  80         return old_id;
  81 }
  82
  83 static inline void ocfs2_set_inode_lock_trans(struct ocfs2_journal *journal,
  84                                               struct inode *inode)
  85 {
  86         spin_lock(&trans_inc_lock);
  87         OCFS2_I(inode)->ip_last_trans = journal->j_trans_id;
  88         spin_unlock(&trans_inc_lock);
  89 }
  90
  91 /* Used to figure out whether it's safe to drop a metadata lock on an
  92  * inode. Returns true if all the inodes changes have been
  93  * checkpointed to disk. You should be holding the spinlock on the
  94  * metadata lock while calling this to be sure that nobody can take
  95  * the lock and put it on another transaction. */
  96 static inline int ocfs2_inode_fully_checkpointed(struct inode *inode)
  97 {
  98         int ret;
  99         struct ocfs2_journal *journal = OCFS2_SB(inode->i_sb)->journal;
 100
 101         spin_lock(&trans_inc_lock);
 102         ret = time_after(journal->j_trans_id, OCFS2_I(inode)->ip_last_trans);
 103         spin_unlock(&trans_inc_lock);
 104         return ret;
 105 }
 106
 107 /* convenience function to check if an inode is still new (has never
 108  * hit disk) Will do you a favor and set created_trans = 0 when you've
 109  * been checkpointed.  returns '1' if the inode is still new. */
 110 static inline int ocfs2_inode_is_new(struct inode *inode)
 111 {
 112         int ret;
 113
 114         /* System files are never "new" as they're written out by
 115          * mkfs. This helps us early during mount, before we have the
 116          * journal open and j_trans_id could be junk. */
 117         if (OCFS2_I(inode)->ip_flags & OCFS2_INODE_SYSTEM_FILE)
 118                 return 0;
 119         spin_lock(&trans_inc_lock);
 120         ret = !(time_after(OCFS2_SB(inode->i_sb)->journal->j_trans_id,
 121                            OCFS2_I(inode)->ip_created_trans));
 122         if (!ret)
 123                 OCFS2_I(inode)->ip_created_trans = 0;
 124         spin_unlock(&trans_inc_lock);
 125         return ret;
 126 }
 127
 128 static inline void ocfs2_inode_set_new(struct ocfs2_super *osb,
 129                                        struct inode *inode)
 130 {
 131         spin_lock(&trans_inc_lock);
 132         OCFS2_I(inode)->ip_created_trans = osb->journal->j_trans_id;
 133         spin_unlock(&trans_inc_lock);
 134 }
 135
 136 extern kmem_cache_t *ocfs2_lock_cache;
 137
 138 struct ocfs2_journal_lock {
 139         struct inode     *jl_inode;
 140         struct list_head  jl_lock_list;
 141 };
 142
 143 struct ocfs2_journal_handle {
 144         handle_t            *k_handle; /* kernel handle.                */
 145         struct ocfs2_journal        *journal;
 146
 147         /* The following two fields are for ocfs2_handle_add_lock */
 148         int                 num_locks;
 149         struct list_head    locks;     /* A bunch of locks to
 150                                         * release on commit. This
 151                                         * should be a list_head */
 152
 153         struct list_head     inode_list;
 154 };
 155
 156 /* Exported only for the journal struct init code in super.c. Do not call. */
 157 void ocfs2_complete_recovery(void *data);
 158
 159 /*
 160  *  Journal Control:
 161  *  Initialize, Load, Shutdown, Wipe a journal.
 162  *
 163  *  ocfs2_journal_init     - Initialize journal structures in the OSB.
 164  *  ocfs2_journal_load     - Load the given journal off disk. Replay it if
 165  *                          there's transactions still in there.
 166  *  ocfs2_journal_shutdown - Shutdown a journal, this will flush all
 167  *                          uncommitted, uncheckpointed transactions.
 168  *  ocfs2_journal_wipe     - Wipe transactions from a journal. Optionally
 169  *                          zero out each block.
 170  *  ocfs2_recovery_thread  - Perform recovery on a node. osb is our own osb.
 171  *  ocfs2_mark_dead_nodes - Start recovery on nodes we won't get a heartbeat
 172  *                          event on.
 173  *  ocfs2_start_checkpoint - Kick the commit thread to do a checkpoint.
 174  */
 175 void   ocfs2_set_journal_params(struct ocfs2_super *osb);
 176 int    ocfs2_journal_init(struct ocfs2_journal *journal,
 177                           int *dirty);
 178 void   ocfs2_journal_shutdown(struct ocfs2_super *osb);
 179 int    ocfs2_journal_wipe(struct ocfs2_journal *journal,
 180                           int full);
 181 int    ocfs2_journal_load(struct ocfs2_journal *journal);
 182 int    ocfs2_check_journals_nolocks(struct ocfs2_super *osb);
 183 void   ocfs2_recovery_thread(struct ocfs2_super *osb,
 184                              int node_num);
 185 int    ocfs2_mark_dead_nodes(struct ocfs2_super *osb);
 186 void   ocfs2_complete_mount_recovery(struct ocfs2_super *osb);
 187
 188 static inline void ocfs2_start_checkpoint(struct ocfs2_super *osb)
 189 {
 190         atomic_set(&osb->needs_checkpoint, 1);
 191         wake_up(&osb->checkpoint_event);
 192 }
 193
 194 static inline void ocfs2_checkpoint_inode(struct inode *inode)
 195 {
 196         struct ocfs2_super *osb = OCFS2_SB(inode->i_sb);
 197
 198         if (!ocfs2_inode_fully_checkpointed(inode)) {
 199                 /* WARNING: This only kicks off a single
 200                  * checkpoint. If someone races you and adds more
 201                  * metadata to the journal, you won't know, and will
 202                  * wind up waiting *alot* longer than necessary. Right
 203                  * now we only use this in clear_inode so that's
 204                  * OK. */
 205                 ocfs2_start_checkpoint(osb);
 206
 207                 wait_event(osb->journal->j_checkpointed,
 208                            ocfs2_inode_fully_checkpointed(inode));
 209         }
 210 }
 211
 212 /*
 213  *  Transaction Handling:
 214  *  Manage the lifetime of a transaction handle.
 215  *
 216  *  ocfs2_alloc_handle     - Only allocate a handle so we can start putting
 217  *                          cluster locks on it. To actually change blocks,
 218  *                          call ocfs2_start_trans with the handle returned
 219  *                          from this function. You may call ocfs2_commit_trans
 220  *                           at any time in the lifetime of a handle.
 221  *  ocfs2_start_trans      - Begin a transaction. Give it an upper estimate of
 222  *                          the number of blocks that will be changed during
 223  *                          this handle.
 224  *  ocfs2_commit_trans     - Complete a handle.
 225  *  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.
 228  *  ocfs2_journal_access   - Notify the handle that we want to journal this
 229  *                          buffer. Will have to call ocfs2_journal_dirty once
 230  *                          we've actually dirtied it. Type is one of . or .
 231  *  ocfs2_journal_dirty    - Mark a journalled buffer as having dirty data.
 232  *  ocfs2_journal_dirty_data - Indicate that a data buffer should go out before
 233  *                             the current handle commits.
 234  *  ocfs2_handle_add_lock  - Sometimes we need to delay lock release
 235  *                          until after a transaction has been completed. Use
 236  *                          ocfs2_handle_add_lock to indicate that a lock needs
 237  *                          to be released at the end of that handle. Locks
 238  *                          will be released in the order that they are added.
 239  *  ocfs2_handle_add_inode - Add a locked inode to a transaction.
 240  */
 241
 242 /* You must always start_trans with a number of buffs > 0, but it's
 243  * perfectly legal to go through an entire transaction without having
 244  * dirtied any buffers. */
 245 struct ocfs2_journal_handle *ocfs2_alloc_handle(struct ocfs2_super *osb);
 246 struct ocfs2_journal_handle *ocfs2_start_trans(struct ocfs2_super *osb,
 247                                                struct ocfs2_journal_handle *handle,
 248                                                int max_buffs);
 249 void                         ocfs2_commit_trans(struct ocfs2_journal_handle *handle);
 250 int                          ocfs2_extend_trans(handle_t *handle, int nblocks);
 251
 252 /*
 253  * Create access is for when we get a newly created buffer and we're
 254  * not gonna read it off disk, but rather fill it ourselves.  Right
 255  * now, we don't do anything special with this (it turns into a write
 256  * request), but this is a good placeholder in case we do...
 257  *
 258  * Write access is for when we read a block off disk and are going to
 259  * modify it. This way the journalling layer knows it may need to make
 260  * a copy of that block (if it's part of another, uncommitted
 261  * transaction) before we do so.
 262  */
 263 #define OCFS2_JOURNAL_ACCESS_CREATE 0
 264 #define OCFS2_JOURNAL_ACCESS_WRITE  1
 265 #define OCFS2_JOURNAL_ACCESS_UNDO   2
 266
 267 int                  ocfs2_journal_access(struct ocfs2_journal_handle *handle,
 268                                           struct inode *inode,
 269                                           struct buffer_head *bh,
 270                                           int type);
 271 /*
 272  * A word about the journal_access/journal_dirty "dance". It is
 273  * entirely legal to journal_access a buffer more than once (as long
 274  * as the access type is the same -- I'm not sure what will happen if
 275  * access type is different but this should never happen anyway) It is
 276  * also legal to journal_dirty a buffer more than once. In fact, you
 277  * can even journal_access a buffer after you've done a
 278  * journal_access/journal_dirty pair. The only thing you cannot do
 279  * however, is journal_dirty a buffer which you haven't yet passed to
 280  * journal_access at least once.
 281  *
 282  * That said, 99% of the time this doesn't matter and this is what the
 283  * path looks like:
 284  *
 285  *      <read a bh>
 286  *      ocfs2_journal_access(handle, bh,        OCFS2_JOURNAL_ACCESS_WRITE);
 287  *      <modify the bh>
 288  *      ocfs2_journal_dirty(handle, bh);
 289  */
 290 int                  ocfs2_journal_dirty(struct ocfs2_journal_handle *handle,
 291                                          struct buffer_head *bh);
 292 int                  ocfs2_journal_dirty_data(handle_t *handle,
 293                                               struct buffer_head *bh);
 294 int                  ocfs2_handle_add_lock(struct ocfs2_journal_handle *handle,
 295                                            struct inode *inode);
 296 /*
 297  * Use this to protect from other processes reading buffer state while
 298  * it's in flight.
 299  */
 300 void                 ocfs2_handle_add_inode(struct ocfs2_journal_handle *handle,
 301                                             struct inode *inode);
 302
 303 /*
 304  *  Credit Macros:
 305  *  Convenience macros to calculate number of credits needed.
 306  *
 307  *  For convenience sake, I have a set of macros here which calculate
 308  *  the *maximum* number of sectors which will be changed for various
 309  *  metadata updates.
 310  */
 311
 312 /* simple file updates like chmod, etc. */
 313 #define OCFS2_INODE_UPDATE_CREDITS 1
 314
 315 /* get one bit out of a suballocator: dinode + group descriptor +
 316  * prev. group desc. if we relink. */
 317 #define OCFS2_SUBALLOC_ALLOC (3)
 318
 319 /* dinode + group descriptor update. We don't relink on free yet. */
 320 #define OCFS2_SUBALLOC_FREE  (2)
 321
 322 #define OCFS2_TRUNCATE_LOG_UPDATE OCFS2_INODE_UPDATE_CREDITS
 323 #define OCFS2_TRUNCATE_LOG_FLUSH_ONE_REC (OCFS2_SUBALLOC_FREE                 \
 324                                          + OCFS2_TRUNCATE_LOG_UPDATE)
 325
 326 /* data block for new dir/symlink, 2 for bitmap updates (bitmap fe +
 327  * bitmap block for the new bit) */
 328 #define OCFS2_DIR_LINK_ADDITIONAL_CREDITS (1 + 2)
 329
 330 /* parent fe, parent block, new file entry, inode alloc fe, inode alloc
 331  * group descriptor + mkdir/symlink blocks */
 332 #define OCFS2_MKNOD_CREDITS (3 + OCFS2_SUBALLOC_ALLOC                         \
 333                             + OCFS2_DIR_LINK_ADDITIONAL_CREDITS)
 334
 335 /* local alloc metadata change + main bitmap updates */
 336 #define OCFS2_WINDOW_MOVE_CREDITS (OCFS2_INODE_UPDATE_CREDITS                 \
 337                                   + OCFS2_SUBALLOC_ALLOC + OCFS2_SUBALLOC_FREE)
 338
 339 /* used when we don't need an allocation change for a dir extend. One
 340  * for the dinode, one for the new block. */
 341 #define OCFS2_SIMPLE_DIR_EXTEND_CREDITS (2)
 342
 343 /* file update (nlink, etc) + dir entry block */
 344 #define OCFS2_LINK_CREDITS  (OCFS2_INODE_UPDATE_CREDITS + 1)
 345
 346 /* inode + dir inode (if we unlink a dir), + dir entry block + orphan
 347  * dir inode link */
 348 #define OCFS2_UNLINK_CREDITS  (2 * OCFS2_INODE_UPDATE_CREDITS + 1             \
 349                               + OCFS2_LINK_CREDITS)
 350
 351 /* dinode + orphan dir dinode + inode alloc dinode + orphan dir entry +
 352  * inode alloc group descriptor */
 353 #define OCFS2_DELETE_INODE_CREDITS (3 * OCFS2_INODE_UPDATE_CREDITS + 1 + 1)
 354
 355 /* dinode update, old dir dinode update, new dir dinode update, old
 356  * dir dir entry, new dir dir entry, dir entry update for renaming
 357  * directory + target unlink */
 358 #define OCFS2_RENAME_CREDITS (3 * OCFS2_INODE_UPDATE_CREDITS + 3              \
 359                              + OCFS2_UNLINK_CREDITS)
 360
 361 static inline int ocfs2_calc_extend_credits(struct super_block *sb,
 362                                             struct ocfs2_dinode *fe,
 363                                             u32 bits_wanted)
 364 {
 365         int bitmap_blocks, sysfile_bitmap_blocks, dinode_blocks;
 366
 367         /* bitmap dinode, group desc. + relinked group. */
 368         bitmap_blocks = OCFS2_SUBALLOC_ALLOC;
 369
 370         /* we might need to shift tree depth so lets assume an
 371          * absolute worst case of complete fragmentation.  Even with
 372          * that, we only need one update for the dinode, and then
 373          * however many metadata chunks needed * a remaining suballoc
 374          * alloc. */
 375         sysfile_bitmap_blocks = 1 +
 376                 (OCFS2_SUBALLOC_ALLOC - 1) * ocfs2_extend_meta_needed(fe);
 377
 378         /* this does not include *new* metadata blocks, which are
 379          * accounted for in sysfile_bitmap_blocks. fe +
 380          * prev. last_eb_blk + blocks along edge of tree.
 381          * calc_symlink_credits passes because we just need 1
 382          * credit for the dinode there. */
 383         dinode_blocks = 1 + 1 + le16_to_cpu(fe->id2.i_list.l_tree_depth);
 384
 385         return bitmap_blocks + sysfile_bitmap_blocks + dinode_blocks;
 386 }
 387
 388 static inline int ocfs2_calc_symlink_credits(struct super_block *sb)
 389 {
 390         int blocks = OCFS2_MKNOD_CREDITS;
 391
 392         /* links can be longer than one block so we may update many
 393          * within our single allocated extent. */
 394         blocks += ocfs2_clusters_to_blocks(sb, 1);
 395
 396         return blocks;
 397 }
 398
 399 static inline int ocfs2_calc_group_alloc_credits(struct super_block *sb,
 400                                                  unsigned int cpg)
 401 {
 402         int blocks;
 403         int bitmap_blocks = OCFS2_SUBALLOC_ALLOC + 1;
 404         /* parent inode update + new block group header + bitmap inode update
 405            + bitmap blocks affected */
 406         blocks = 1 + 1 + 1 + bitmap_blocks;
 407         return blocks;
 408 }
 409
 410 static inline int ocfs2_calc_tree_trunc_credits(struct super_block *sb,
 411                                                 unsigned int clusters_to_del,
 412                                                 struct ocfs2_dinode *fe,
 413                                                 struct ocfs2_extent_list *last_el)
 414 {
 415         /* for dinode + all headers in this pass + update to next leaf */
 416         u16 next_free = le16_to_cpu(last_el->l_next_free_rec);
 417         u16 tree_depth = le16_to_cpu(fe->id2.i_list.l_tree_depth);
 418         int credits = 1 + tree_depth + 1;
 419         int i;
 420
 421         i = next_free - 1;
 422         BUG_ON(i < 0);
 423
 424         /* We may be deleting metadata blocks, so metadata alloc dinode +
 425            one desc. block for each possible delete. */
 426         if (tree_depth && next_free == 1 &&
 427             le32_to_cpu(last_el->l_recs[i].e_clusters) == clusters_to_del)
 428                 credits += 1 + tree_depth;
 429
 430         /* update to the truncate log. */
 431         credits += OCFS2_TRUNCATE_LOG_UPDATE;
 432
 433         return credits;
 434 }
 435
 436 #endif /* OCFS2_JOURNAL_H */