fs/btrfs/ordered-data.h

   1 /*
   2  * Copyright (C) 2007 Oracle.  All rights reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public
   6  * License v2 as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public
  14  * License along with this program; if not, write to the
  15  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  16  * Boston, MA 021110-1307, USA.
  17  */
  18
  19 #ifndef __BTRFS_ORDERED_DATA__
  20 #define __BTRFS_ORDERED_DATA__
  21
  22 /* one of these per inode */
  23 struct btrfs_ordered_inode_tree {
  24         struct mutex mutex;
  25         struct rb_root tree;
  26         struct rb_node *last;
  27 };
  28
  29 /*
  30  * these are used to collect checksums done just before bios submission.
  31  * They are attached via a list into the ordered extent, and
  32  * checksum items are inserted into the tree after all the blocks in
  33  * the ordered extent are on disk
  34  */
  35 struct btrfs_sector_sum {
  36         u64 offset;
  37         u32 sum;
  38 };
  39
  40 struct btrfs_ordered_sum {
  41         u64 file_offset;
  42         u64 len;
  43         struct list_head list;
  44         /* last field is a variable length array of btrfs_sector_sums */
  45         struct btrfs_sector_sum sums;
  46 };
  47
  48 /*
  49  * bits for the flags field:
  50  *
  51  * BTRFS_ORDERED_IO_DONE is set when all of the blocks are written.
  52  * It is used to make sure metadata is inserted into the tree only once
  53  * per extent.
  54  *
  55  * BTRFS_ORDERED_COMPLETE is set when the extent is removed from the
  56  * rbtree, just before waking any waiters.  It is used to indicate the
  57  * IO is done and any metadata is inserted into the tree.
  58  */
  59 #define BTRFS_ORDERED_IO_DONE 0 /* set when all the pages are written */
  60
  61 #define BTRFS_ORDERED_COMPLETE 1 /* set when removed from the tree */
  62
  63 struct btrfs_ordered_extent {
  64         /* logical offset in the file */
  65         u64 file_offset;
  66
  67         /* disk byte number */
  68         u64 start;
  69
  70         /* length of the extent in bytes */
  71         u64 len;
  72
  73         /* flags (described above) */
  74         unsigned long flags;
  75
  76         /* reference count */
  77         atomic_t refs;
  78
  79         /* list of checksums for insertion when the extent io is done */
  80         struct list_head list;
  81
  82         /* used to wait for the BTRFS_ORDERED_COMPLETE bit */
  83         wait_queue_head_t wait;
  84
  85         /* our friendly rbtree entry */
  86         struct rb_node rb_node;
  87 };
  88
  89
  90 /*
  91  * calculates the total size you need to allocate for an ordered sum
  92  * structure spanning 'bytes' in the file
  93  */
  94 static inline int btrfs_ordered_sum_size(struct btrfs_root *root, u64 bytes)
  95 {
  96         unsigned long num_sectors = (bytes + root->sectorsize - 1) /
  97                 root->sectorsize;
  98         return sizeof(struct btrfs_ordered_sum) +
  99                 num_sectors * sizeof(struct btrfs_sector_sum);
 100 }
 101
 102 static inline void
 103 btrfs_ordered_inode_tree_init(struct btrfs_ordered_inode_tree *t)
 104 {
 105         mutex_init(&t->mutex);
 106         t->tree.rb_node = NULL;
 107         t->last = NULL;
 108 }
 109
 110 int btrfs_put_ordered_extent(struct btrfs_ordered_extent *entry);
 111 int btrfs_remove_ordered_extent(struct inode *inode,
 112                                 struct btrfs_ordered_extent *entry);
 113 int btrfs_dec_test_ordered_pending(struct inode *inode,
 114                                        u64 file_offset, u64 io_size);
 115 int btrfs_add_ordered_extent(struct inode *inode, u64 file_offset,
 116                              u64 start, u64 len);
 117 int btrfs_add_ordered_sum(struct inode *inode, struct btrfs_ordered_sum *sum);
 118 struct btrfs_ordered_extent *btrfs_lookup_ordered_extent(struct inode *inode,
 119                                                          u64 file_offset);
 120 void btrfs_start_ordered_extent(struct inode *inode,
 121                                 struct btrfs_ordered_extent *entry, int wait);
 122 void btrfs_wait_ordered_range(struct inode *inode, u64 start, u64 len);
 123 struct btrfs_ordered_extent *
 124 btrfs_lookup_first_ordered_extent(struct inode * inode, u64 file_offset);
 125 int btrfs_ordered_update_i_size(struct inode *inode,
 126                                 struct btrfs_ordered_extent *ordered);
 127 int btrfs_find_ordered_sum(struct inode *inode, u64 offset, u32 *sum);
 128 #endif