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