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