fs/nilfs2/segbuf.h

   1 /*
   2  * segbuf.h - NILFS Segment buffer prototypes and definitions
   3  *
   4  * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * Written by Ryusuke Konishi <ryusuke@osrg.net>
  21  *
  22  */
  23 #ifndef _NILFS_SEGBUF_H
  24 #define _NILFS_SEGBUF_H
  25
  26 #include <linux/fs.h>
  27 #include <linux/buffer_head.h>
  28 #include <linux/bio.h>
  29 #include <linux/completion.h>
  30
  31 /**
  32  * struct nilfs_segsum_info - On-memory segment summary
  33  * @flags: Flags
  34  * @nfinfo: Number of file information structures
  35  * @nblocks: Number of blocks included in the partial segment
  36  * @nsumblk: Number of summary blocks
  37  * @sumbytes: Byte count of segment summary
  38  * @nfileblk: Total number of file blocks
  39  * @seg_seq: Segment sequence number
  40  * @ctime: Creation time
  41  * @next: Block number of the next full segment
  42  */
  43 struct nilfs_segsum_info {
  44         unsigned int            flags;
  45         unsigned long           nfinfo;
  46         unsigned long           nblocks;
  47         unsigned long           nsumblk;
  48         unsigned long           sumbytes;
  49         unsigned long           nfileblk;
  50         u64                     seg_seq;
  51         time_t                  ctime;
  52         sector_t                next;
  53 };
  54
  55 /* macro for the flags */
  56 #define NILFS_SEG_HAS_SR(sum)    ((sum)->flags & NILFS_SS_SR)
  57 #define NILFS_SEG_LOGBGN(sum)    ((sum)->flags & NILFS_SS_LOGBGN)
  58 #define NILFS_SEG_LOGEND(sum)    ((sum)->flags & NILFS_SS_LOGEND)
  59 #define NILFS_SEG_DSYNC(sum)     ((sum)->flags & NILFS_SS_SYNDT)
  60 #define NILFS_SEG_SIMPLEX(sum) \
  61         (((sum)->flags & (NILFS_SS_LOGBGN | NILFS_SS_LOGEND)) == \
  62          (NILFS_SS_LOGBGN | NILFS_SS_LOGEND))
  63
  64 #define NILFS_SEG_EMPTY(sum)    ((sum)->nblocks == (sum)->nsumblk)
  65
  66 /**
  67  * struct nilfs_segment_buffer - Segment buffer
  68  * @sb_super: back pointer to a superblock struct
  69  * @sb_list: List head to chain this structure
  70  * @sb_sum: On-memory segment summary
  71  * @sb_segnum: Index number of the full segment
  72  * @sb_nextnum: Index number of the next full segment
  73  * @sb_fseg_start: Start block number of the full segment
  74  * @sb_fseg_end: End block number of the full segment
  75  * @sb_pseg_start: Disk block number of partial segment
  76  * @sb_rest_blocks: Number of residual blocks in the current segment
  77  * @sb_segsum_buffers: List of buffers for segment summaries
  78  * @sb_payload_buffers: List of buffers for segment payload
  79  * @sb_super_root: Pointer to buffer storing a super root block (if exists)
  80  * @sb_nbio: Number of flying bio requests
  81  * @sb_err: I/O error status
  82  * @sb_bio_event: Completion event of log writing
  83  */
  84 struct nilfs_segment_buffer {
  85         struct super_block     *sb_super;
  86         struct list_head        sb_list;
  87
  88         /* Segment information */
  89         struct nilfs_segsum_info sb_sum;
  90         __u64                   sb_segnum;
  91         __u64                   sb_nextnum;
  92         sector_t                sb_fseg_start, sb_fseg_end;
  93         sector_t                sb_pseg_start;
  94         unsigned                sb_rest_blocks;
  95
  96         /* Buffers */
  97         struct list_head        sb_segsum_buffers;
  98         struct list_head        sb_payload_buffers; /* including super root */
  99         struct buffer_head     *sb_super_root;
 100
 101         /* io status */
 102         int                     sb_nbio;
 103         atomic_t                sb_err;
 104         struct completion       sb_bio_event;
 105 };
 106
 107 #define NILFS_LIST_SEGBUF(head)  \
 108         list_entry((head), struct nilfs_segment_buffer, sb_list)
 109 #define NILFS_NEXT_SEGBUF(segbuf)  NILFS_LIST_SEGBUF((segbuf)->sb_list.next)
 110 #define NILFS_PREV_SEGBUF(segbuf)  NILFS_LIST_SEGBUF((segbuf)->sb_list.prev)
 111 #define NILFS_LAST_SEGBUF(head)    NILFS_LIST_SEGBUF((head)->prev)
 112 #define NILFS_FIRST_SEGBUF(head)   NILFS_LIST_SEGBUF((head)->next)
 113 #define NILFS_SEGBUF_IS_LAST(segbuf, head)  ((segbuf)->sb_list.next == (head))
 114
 115 #define nilfs_for_each_segbuf_before(s, t, h) \
 116         for ((s) = NILFS_FIRST_SEGBUF(h); (s) != (t); \
 117              (s) = NILFS_NEXT_SEGBUF(s))
 118
 119 #define NILFS_SEGBUF_FIRST_BH(head)  \
 120         (list_entry((head)->next, struct buffer_head, b_assoc_buffers))
 121 #define NILFS_SEGBUF_NEXT_BH(bh)  \
 122         (list_entry((bh)->b_assoc_buffers.next, struct buffer_head, \
 123                     b_assoc_buffers))
 124 #define NILFS_SEGBUF_BH_IS_LAST(bh, head)  ((bh)->b_assoc_buffers.next == head)
 125
 126 extern struct kmem_cache *nilfs_segbuf_cachep;
 127
 128 int __init nilfs_init_segbuf_cache(void);
 129 void nilfs_destroy_segbuf_cache(void);
 130 struct nilfs_segment_buffer *nilfs_segbuf_new(struct super_block *);
 131 void nilfs_segbuf_free(struct nilfs_segment_buffer *);
 132 void nilfs_segbuf_map(struct nilfs_segment_buffer *, __u64, unsigned long,
 133                       struct the_nilfs *);
 134 void nilfs_segbuf_map_cont(struct nilfs_segment_buffer *segbuf,
 135                            struct nilfs_segment_buffer *prev);
 136 void nilfs_segbuf_set_next_segnum(struct nilfs_segment_buffer *, __u64,
 137                                   struct the_nilfs *);
 138 int nilfs_segbuf_reset(struct nilfs_segment_buffer *, unsigned, time_t);
 139 int nilfs_segbuf_extend_segsum(struct nilfs_segment_buffer *);
 140 int nilfs_segbuf_extend_payload(struct nilfs_segment_buffer *,
 141                                 struct buffer_head **);
 142 void nilfs_segbuf_fill_in_segsum(struct nilfs_segment_buffer *);
 143
 144 static inline void
 145 nilfs_segbuf_add_segsum_buffer(struct nilfs_segment_buffer *segbuf,
 146                                struct buffer_head *bh)
 147 {
 148         list_add_tail(&bh->b_assoc_buffers, &segbuf->sb_segsum_buffers);
 149         segbuf->sb_sum.nblocks++;
 150         segbuf->sb_sum.nsumblk++;
 151 }
 152
 153 static inline void
 154 nilfs_segbuf_add_payload_buffer(struct nilfs_segment_buffer *segbuf,
 155                                 struct buffer_head *bh)
 156 {
 157         list_add_tail(&bh->b_assoc_buffers, &segbuf->sb_payload_buffers);
 158         segbuf->sb_sum.nblocks++;
 159 }
 160
 161 static inline void
 162 nilfs_segbuf_add_file_buffer(struct nilfs_segment_buffer *segbuf,
 163                              struct buffer_head *bh)
 164 {
 165         get_bh(bh);
 166         nilfs_segbuf_add_payload_buffer(segbuf, bh);
 167         segbuf->sb_sum.nfileblk++;
 168 }
 169
 170 void nilfs_clear_logs(struct list_head *logs);
 171 void nilfs_truncate_logs(struct list_head *logs,
 172                          struct nilfs_segment_buffer *last);
 173 int nilfs_write_logs(struct list_head *logs, struct the_nilfs *nilfs);
 174 int nilfs_wait_on_logs(struct list_head *logs);
 175 void nilfs_add_checksums_on_logs(struct list_head *logs, u32 seed);
 176
 177 static inline void nilfs_destroy_logs(struct list_head *logs)
 178 {
 179         nilfs_truncate_logs(logs, NULL);
 180 }
 181
 182 #endif /* _NILFS_SEGBUF_H */