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