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