1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  *  linux/fs/bad_inode.c
4  *
5  *  Copyright (C) 1997, Stephen Tweedie
6  *
7  *  Provide stub functions for unreadable inodes
8  *
9  *  Fabian Frederick : August 2003 - All file operations assigned to EIO
10  */
11 
12 #include <linux/fs.h>
13 #include <linux/export.h>
14 #include <linux/stat.h>
15 #include <linux/time.h>
16 #include <linux/namei.h>
17 #include <linux/poll.h>
18 #include <linux/fiemap.h>
19 
bad_file_open(struct inode * inode,struct file * filp)20 static int bad_file_open(struct inode *inode, struct file *filp)
21 {
22 	return -EIO;
23 }
24 
25 static const struct file_operations bad_file_ops =
26 {
27 	.open		= bad_file_open,
28 };
29 
bad_inode_create(struct mnt_idmap * idmap,struct inode * dir,struct dentry * dentry,umode_t mode,bool excl)30 static int bad_inode_create(struct mnt_idmap *idmap,
31 			    struct inode *dir, struct dentry *dentry,
32 			    umode_t mode, bool excl)
33 {
34 	return -EIO;
35 }
36 
bad_inode_lookup(struct inode * dir,struct dentry * dentry,unsigned int flags)37 static struct dentry *bad_inode_lookup(struct inode *dir,
38 			struct dentry *dentry, unsigned int flags)
39 {
40 	return ERR_PTR(-EIO);
41 }
42 
bad_inode_link(struct dentry * old_dentry,struct inode * dir,struct dentry * dentry)43 static int bad_inode_link (struct dentry *old_dentry, struct inode *dir,
44 		struct dentry *dentry)
45 {
46 	return -EIO;
47 }
48 
bad_inode_unlink(struct inode * dir,struct dentry * dentry)49 static int bad_inode_unlink(struct inode *dir, struct dentry *dentry)
50 {
51 	return -EIO;
52 }
53 
bad_inode_symlink(struct mnt_idmap * idmap,struct inode * dir,struct dentry * dentry,const char * symname)54 static int bad_inode_symlink(struct mnt_idmap *idmap,
55 			     struct inode *dir, struct dentry *dentry,
56 			     const char *symname)
57 {
58 	return -EIO;
59 }
60 
bad_inode_mkdir(struct mnt_idmap * idmap,struct inode * dir,struct dentry * dentry,umode_t mode)61 static int bad_inode_mkdir(struct mnt_idmap *idmap, struct inode *dir,
62 			   struct dentry *dentry, umode_t mode)
63 {
64 	return -EIO;
65 }
66 
bad_inode_rmdir(struct inode * dir,struct dentry * dentry)67 static int bad_inode_rmdir (struct inode *dir, struct dentry *dentry)
68 {
69 	return -EIO;
70 }
71 
bad_inode_mknod(struct mnt_idmap * idmap,struct inode * dir,struct dentry * dentry,umode_t mode,dev_t rdev)72 static int bad_inode_mknod(struct mnt_idmap *idmap, struct inode *dir,
73 			   struct dentry *dentry, umode_t mode, dev_t rdev)
74 {
75 	return -EIO;
76 }
77 
bad_inode_rename2(struct mnt_idmap * idmap,struct inode * old_dir,struct dentry * old_dentry,struct inode * new_dir,struct dentry * new_dentry,unsigned int flags)78 static int bad_inode_rename2(struct mnt_idmap *idmap,
79 			     struct inode *old_dir, struct dentry *old_dentry,
80 			     struct inode *new_dir, struct dentry *new_dentry,
81 			     unsigned int flags)
82 {
83 	return -EIO;
84 }
85 
bad_inode_readlink(struct dentry * dentry,char __user * buffer,int buflen)86 static int bad_inode_readlink(struct dentry *dentry, char __user *buffer,
87 		int buflen)
88 {
89 	return -EIO;
90 }
91 
bad_inode_permission(struct mnt_idmap * idmap,struct inode * inode,int mask)92 static int bad_inode_permission(struct mnt_idmap *idmap,
93 				struct inode *inode, int mask)
94 {
95 	return -EIO;
96 }
97 
bad_inode_getattr(struct mnt_idmap * idmap,const struct path * path,struct kstat * stat,u32 request_mask,unsigned int query_flags)98 static int bad_inode_getattr(struct mnt_idmap *idmap,
99 			     const struct path *path, struct kstat *stat,
100 			     u32 request_mask, unsigned int query_flags)
101 {
102 	return -EIO;
103 }
104 
bad_inode_setattr(struct mnt_idmap * idmap,struct dentry * direntry,struct iattr * attrs)105 static int bad_inode_setattr(struct mnt_idmap *idmap,
106 			     struct dentry *direntry, struct iattr *attrs)
107 {
108 	return -EIO;
109 }
110 
bad_inode_listxattr(struct dentry * dentry,char * buffer,size_t buffer_size)111 static ssize_t bad_inode_listxattr(struct dentry *dentry, char *buffer,
112 			size_t buffer_size)
113 {
114 	return -EIO;
115 }
116 
bad_inode_get_link(struct dentry * dentry,struct inode * inode,struct delayed_call * done)117 static const char *bad_inode_get_link(struct dentry *dentry,
118 				      struct inode *inode,
119 				      struct delayed_call *done)
120 {
121 	return ERR_PTR(-EIO);
122 }
123 
bad_inode_get_acl(struct inode * inode,int type,bool rcu)124 static struct posix_acl *bad_inode_get_acl(struct inode *inode, int type, bool rcu)
125 {
126 	return ERR_PTR(-EIO);
127 }
128 
bad_inode_fiemap(struct inode * inode,struct fiemap_extent_info * fieinfo,u64 start,u64 len)129 static int bad_inode_fiemap(struct inode *inode,
130 			    struct fiemap_extent_info *fieinfo, u64 start,
131 			    u64 len)
132 {
133 	return -EIO;
134 }
135 
bad_inode_update_time(struct inode * inode,int flags)136 static int bad_inode_update_time(struct inode *inode, int flags)
137 {
138 	return -EIO;
139 }
140 
bad_inode_atomic_open(struct inode * inode,struct dentry * dentry,struct file * file,unsigned int open_flag,umode_t create_mode)141 static int bad_inode_atomic_open(struct inode *inode, struct dentry *dentry,
142 				 struct file *file, unsigned int open_flag,
143 				 umode_t create_mode)
144 {
145 	return -EIO;
146 }
147 
bad_inode_tmpfile(struct mnt_idmap * idmap,struct inode * inode,struct file * file,umode_t mode)148 static int bad_inode_tmpfile(struct mnt_idmap *idmap,
149 			     struct inode *inode, struct file *file,
150 			     umode_t mode)
151 {
152 	return -EIO;
153 }
154 
bad_inode_set_acl(struct mnt_idmap * idmap,struct dentry * dentry,struct posix_acl * acl,int type)155 static int bad_inode_set_acl(struct mnt_idmap *idmap,
156 			     struct dentry *dentry, struct posix_acl *acl,
157 			     int type)
158 {
159 	return -EIO;
160 }
161 
162 static const struct inode_operations bad_inode_ops =
163 {
164 	.create		= bad_inode_create,
165 	.lookup		= bad_inode_lookup,
166 	.link		= bad_inode_link,
167 	.unlink		= bad_inode_unlink,
168 	.symlink	= bad_inode_symlink,
169 	.mkdir		= bad_inode_mkdir,
170 	.rmdir		= bad_inode_rmdir,
171 	.mknod		= bad_inode_mknod,
172 	.rename		= bad_inode_rename2,
173 	.readlink	= bad_inode_readlink,
174 	.permission	= bad_inode_permission,
175 	.getattr	= bad_inode_getattr,
176 	.setattr	= bad_inode_setattr,
177 	.listxattr	= bad_inode_listxattr,
178 	.get_link	= bad_inode_get_link,
179 	.get_inode_acl	= bad_inode_get_acl,
180 	.fiemap		= bad_inode_fiemap,
181 	.update_time	= bad_inode_update_time,
182 	.atomic_open	= bad_inode_atomic_open,
183 	.tmpfile	= bad_inode_tmpfile,
184 	.set_acl	= bad_inode_set_acl,
185 };
186 
187 
188 /*
189  * When a filesystem is unable to read an inode due to an I/O error in
190  * its read_inode() function, it can call make_bad_inode() to return a
191  * set of stubs which will return EIO errors as required.
192  *
193  * We only need to do limited initialisation: all other fields are
194  * preinitialised to zero automatically.
195  */
196 
197 /**
198  *	make_bad_inode - mark an inode bad due to an I/O error
199  *	@inode: Inode to mark bad
200  *
201  *	When an inode cannot be read due to a media or remote network
202  *	failure this function makes the inode "bad" and causes I/O operations
203  *	on it to fail from this point on.
204  */
205 
make_bad_inode(struct inode * inode)206 void make_bad_inode(struct inode *inode)
207 {
208 	remove_inode_hash(inode);
209 
210 	inode->i_mode = S_IFREG;
211 	inode->i_atime = inode->i_mtime = inode_set_ctime_current(inode);
212 	inode->i_op = &bad_inode_ops;
213 	inode->i_opflags &= ~IOP_XATTR;
214 	inode->i_fop = &bad_file_ops;
215 }
216 EXPORT_SYMBOL(make_bad_inode);
217 
218 /*
219  * This tests whether an inode has been flagged as bad. The test uses
220  * &bad_inode_ops to cover the case of invalidated inodes as well as
221  * those created by make_bad_inode() above.
222  */
223 
224 /**
225  *	is_bad_inode - is an inode errored
226  *	@inode: inode to test
227  *
228  *	Returns true if the inode in question has been marked as bad.
229  */
230 
is_bad_inode(struct inode * inode)231 bool is_bad_inode(struct inode *inode)
232 {
233 	return (inode->i_op == &bad_inode_ops);
234 }
235 
236 EXPORT_SYMBOL(is_bad_inode);
237 
238 /**
239  * iget_failed - Mark an under-construction inode as dead and release it
240  * @inode: The inode to discard
241  *
242  * Mark an under-construction inode as dead and release it.
243  */
iget_failed(struct inode * inode)244 void iget_failed(struct inode *inode)
245 {
246 	make_bad_inode(inode);
247 	unlock_new_inode(inode);
248 	iput(inode);
249 }
250 EXPORT_SYMBOL(iget_failed);
251