fs/nilfs2/sufile.h

   1 /*
   2  * sufile.h - NILFS segment usage file.
   3  *
   4  * Copyright (C) 2006-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 Koji Sato <koji@osrg.net>.
  21  */
  22
  23 #ifndef _NILFS_SUFILE_H
  24 #define _NILFS_SUFILE_H
  25
  26 #include <linux/fs.h>
  27 #include <linux/buffer_head.h>
  28 #include <linux/nilfs2_fs.h>
  29 #include "mdt.h"
  30
  31
  32 static inline unsigned long nilfs_sufile_get_nsegments(struct inode *sufile)
  33 {
  34         return ((struct the_nilfs *)sufile->i_sb->s_fs_info)->ns_nsegments;
  35 }
  36
  37 unsigned long nilfs_sufile_get_ncleansegs(struct inode *sufile);
  38
  39 int nilfs_sufile_set_alloc_range(struct inode *sufile, __u64 start, __u64 end);
  40 int nilfs_sufile_alloc(struct inode *, __u64 *);
  41 int nilfs_sufile_mark_dirty(struct inode *sufile, __u64 segnum);
  42 int nilfs_sufile_set_segment_usage(struct inode *sufile, __u64 segnum,
  43                                    unsigned long nblocks, time_t modtime);
  44 int nilfs_sufile_get_stat(struct inode *, struct nilfs_sustat *);
  45 ssize_t nilfs_sufile_get_suinfo(struct inode *, __u64, void *, unsigned,
  46                                 size_t);
  47
  48 int nilfs_sufile_updatev(struct inode *, __u64 *, size_t, int, size_t *,
  49                          void (*dofunc)(struct inode *, __u64,
  50                                         struct buffer_head *,
  51                                         struct buffer_head *));
  52 int nilfs_sufile_update(struct inode *, __u64, int,
  53                         void (*dofunc)(struct inode *, __u64,
  54                                        struct buffer_head *,
  55                                        struct buffer_head *));
  56 void nilfs_sufile_do_scrap(struct inode *, __u64, struct buffer_head *,
  57                            struct buffer_head *);
  58 void nilfs_sufile_do_free(struct inode *, __u64, struct buffer_head *,
  59                           struct buffer_head *);
  60 void nilfs_sufile_do_cancel_free(struct inode *, __u64, struct buffer_head *,
  61                                  struct buffer_head *);
  62 void nilfs_sufile_do_set_error(struct inode *, __u64, struct buffer_head *,
  63                                struct buffer_head *);
  64
  65 int nilfs_sufile_resize(struct inode *sufile, __u64 newnsegs);
  66 int nilfs_sufile_read(struct super_block *sb, size_t susize,
  67                       struct nilfs_inode *raw_inode, struct inode **inodep);
  68
  69 /**
  70  * nilfs_sufile_scrap - make a segment garbage
  71  * @sufile: inode of segment usage file
  72  * @segnum: segment number to be freed
  73  */
  74 static inline int nilfs_sufile_scrap(struct inode *sufile, __u64 segnum)
  75 {
  76         return nilfs_sufile_update(sufile, segnum, 1, nilfs_sufile_do_scrap);
  77 }
  78
  79 /**
  80  * nilfs_sufile_free - free segment
  81  * @sufile: inode of segment usage file
  82  * @segnum: segment number to be freed
  83  */
  84 static inline int nilfs_sufile_free(struct inode *sufile, __u64 segnum)
  85 {
  86         return nilfs_sufile_update(sufile, segnum, 0, nilfs_sufile_do_free);
  87 }
  88
  89 /**
  90  * nilfs_sufile_freev - free segments
  91  * @sufile: inode of segment usage file
  92  * @segnumv: array of segment numbers
  93  * @nsegs: size of @segnumv array
  94  * @ndone: place to store the number of freed segments
  95  */
  96 static inline int nilfs_sufile_freev(struct inode *sufile, __u64 *segnumv,
  97                                      size_t nsegs, size_t *ndone)
  98 {
  99         return nilfs_sufile_updatev(sufile, segnumv, nsegs, 0, ndone,
 100                                     nilfs_sufile_do_free);
 101 }
 102
 103 /**
 104  * nilfs_sufile_cancel_freev - reallocate freeing segments
 105  * @sufile: inode of segment usage file
 106  * @segnumv: array of segment numbers
 107  * @nsegs: size of @segnumv array
 108  * @ndone: place to store the number of cancelled segments
 109  *
 110  * Return Value: On success, 0 is returned. On error, a negative error codes
 111  * is returned.
 112  */
 113 static inline int nilfs_sufile_cancel_freev(struct inode *sufile,
 114                                             __u64 *segnumv, size_t nsegs,
 115                                             size_t *ndone)
 116 {
 117         return nilfs_sufile_updatev(sufile, segnumv, nsegs, 0, ndone,
 118                                     nilfs_sufile_do_cancel_free);
 119 }
 120
 121 /**
 122  * nilfs_sufile_set_error - mark a segment as erroneous
 123  * @sufile: inode of segment usage file
 124  * @segnum: segment number
 125  *
 126  * Description: nilfs_sufile_set_error() marks the segment specified by
 127  * @segnum as erroneous. The error segment will never be used again.
 128  *
 129  * Return Value: On success, 0 is returned. On error, one of the following
 130  * negative error codes is returned.
 131  *
 132  * %-EIO - I/O error.
 133  *
 134  * %-ENOMEM - Insufficient amount of memory available.
 135  *
 136  * %-EINVAL - Invalid segment usage number.
 137  */
 138 static inline int nilfs_sufile_set_error(struct inode *sufile, __u64 segnum)
 139 {
 140         return nilfs_sufile_update(sufile, segnum, 0,
 141                                    nilfs_sufile_do_set_error);
 142 }
 143
 144 #endif  /* _NILFS_SUFILE_H */