xref: /openbmc/linux/fs/nilfs2/inode.c (revision e156805a)
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * inode.c - NILFS inode operations.
4  *
5  * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
6  *
7  * Written by Ryusuke Konishi.
8  *
9  */
10 
11 #include <linux/buffer_head.h>
12 #include <linux/gfp.h>
13 #include <linux/mpage.h>
14 #include <linux/pagemap.h>
15 #include <linux/writeback.h>
16 #include <linux/uio.h>
17 #include <linux/fiemap.h>
18 #include "nilfs.h"
19 #include "btnode.h"
20 #include "segment.h"
21 #include "page.h"
22 #include "mdt.h"
23 #include "cpfile.h"
24 #include "ifile.h"
25 
26 /**
27  * struct nilfs_iget_args - arguments used during comparison between inodes
28  * @ino: inode number
29  * @cno: checkpoint number
30  * @root: pointer on NILFS root object (mounted checkpoint)
31  * @for_gc: inode for GC flag
32  * @for_btnc: inode for B-tree node cache flag
33  * @for_shadow: inode for shadowed page cache flag
34  */
35 struct nilfs_iget_args {
36 	u64 ino;
37 	__u64 cno;
38 	struct nilfs_root *root;
39 	bool for_gc;
40 	bool for_btnc;
41 	bool for_shadow;
42 };
43 
44 static int nilfs_iget_test(struct inode *inode, void *opaque);
45 
46 void nilfs_inode_add_blocks(struct inode *inode, int n)
47 {
48 	struct nilfs_root *root = NILFS_I(inode)->i_root;
49 
50 	inode_add_bytes(inode, i_blocksize(inode) * n);
51 	if (root)
52 		atomic64_add(n, &root->blocks_count);
53 }
54 
55 void nilfs_inode_sub_blocks(struct inode *inode, int n)
56 {
57 	struct nilfs_root *root = NILFS_I(inode)->i_root;
58 
59 	inode_sub_bytes(inode, i_blocksize(inode) * n);
60 	if (root)
61 		atomic64_sub(n, &root->blocks_count);
62 }
63 
64 /**
65  * nilfs_get_block() - get a file block on the filesystem (callback function)
66  * @inode - inode struct of the target file
67  * @blkoff - file block number
68  * @bh_result - buffer head to be mapped on
69  * @create - indicate whether allocating the block or not when it has not
70  *      been allocated yet.
71  *
72  * This function does not issue actual read request of the specified data
73  * block. It is done by VFS.
74  */
75 int nilfs_get_block(struct inode *inode, sector_t blkoff,
76 		    struct buffer_head *bh_result, int create)
77 {
78 	struct nilfs_inode_info *ii = NILFS_I(inode);
79 	struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
80 	__u64 blknum = 0;
81 	int err = 0, ret;
82 	unsigned int maxblocks = bh_result->b_size >> inode->i_blkbits;
83 
84 	down_read(&NILFS_MDT(nilfs->ns_dat)->mi_sem);
85 	ret = nilfs_bmap_lookup_contig(ii->i_bmap, blkoff, &blknum, maxblocks);
86 	up_read(&NILFS_MDT(nilfs->ns_dat)->mi_sem);
87 	if (ret >= 0) {	/* found */
88 		map_bh(bh_result, inode->i_sb, blknum);
89 		if (ret > 0)
90 			bh_result->b_size = (ret << inode->i_blkbits);
91 		goto out;
92 	}
93 	/* data block was not found */
94 	if (ret == -ENOENT && create) {
95 		struct nilfs_transaction_info ti;
96 
97 		bh_result->b_blocknr = 0;
98 		err = nilfs_transaction_begin(inode->i_sb, &ti, 1);
99 		if (unlikely(err))
100 			goto out;
101 		err = nilfs_bmap_insert(ii->i_bmap, blkoff,
102 					(unsigned long)bh_result);
103 		if (unlikely(err != 0)) {
104 			if (err == -EEXIST) {
105 				/*
106 				 * The get_block() function could be called
107 				 * from multiple callers for an inode.
108 				 * However, the page having this block must
109 				 * be locked in this case.
110 				 */
111 				nilfs_warn(inode->i_sb,
112 					   "%s (ino=%lu): a race condition while inserting a data block at offset=%llu",
113 					   __func__, inode->i_ino,
114 					   (unsigned long long)blkoff);
115 				err = 0;
116 			}
117 			nilfs_transaction_abort(inode->i_sb);
118 			goto out;
119 		}
120 		nilfs_mark_inode_dirty_sync(inode);
121 		nilfs_transaction_commit(inode->i_sb); /* never fails */
122 		/* Error handling should be detailed */
123 		set_buffer_new(bh_result);
124 		set_buffer_delay(bh_result);
125 		map_bh(bh_result, inode->i_sb, 0);
126 		/* Disk block number must be changed to proper value */
127 
128 	} else if (ret == -ENOENT) {
129 		/*
130 		 * not found is not error (e.g. hole); must return without
131 		 * the mapped state flag.
132 		 */
133 		;
134 	} else {
135 		err = ret;
136 	}
137 
138  out:
139 	return err;
140 }
141 
142 /**
143  * nilfs_readpage() - implement readpage() method of nilfs_aops {}
144  * address_space_operations.
145  * @file - file struct of the file to be read
146  * @page - the page to be read
147  */
148 static int nilfs_readpage(struct file *file, struct page *page)
149 {
150 	return mpage_readpage(page, nilfs_get_block);
151 }
152 
153 static void nilfs_readahead(struct readahead_control *rac)
154 {
155 	mpage_readahead(rac, nilfs_get_block);
156 }
157 
158 static int nilfs_writepages(struct address_space *mapping,
159 			    struct writeback_control *wbc)
160 {
161 	struct inode *inode = mapping->host;
162 	int err = 0;
163 
164 	if (sb_rdonly(inode->i_sb)) {
165 		nilfs_clear_dirty_pages(mapping, false);
166 		return -EROFS;
167 	}
168 
169 	if (wbc->sync_mode == WB_SYNC_ALL)
170 		err = nilfs_construct_dsync_segment(inode->i_sb, inode,
171 						    wbc->range_start,
172 						    wbc->range_end);
173 	return err;
174 }
175 
176 static int nilfs_writepage(struct page *page, struct writeback_control *wbc)
177 {
178 	struct inode *inode = page->mapping->host;
179 	int err;
180 
181 	if (sb_rdonly(inode->i_sb)) {
182 		/*
183 		 * It means that filesystem was remounted in read-only
184 		 * mode because of error or metadata corruption. But we
185 		 * have dirty pages that try to be flushed in background.
186 		 * So, here we simply discard this dirty page.
187 		 */
188 		nilfs_clear_dirty_page(page, false);
189 		unlock_page(page);
190 		return -EROFS;
191 	}
192 
193 	redirty_page_for_writepage(wbc, page);
194 	unlock_page(page);
195 
196 	if (wbc->sync_mode == WB_SYNC_ALL) {
197 		err = nilfs_construct_segment(inode->i_sb);
198 		if (unlikely(err))
199 			return err;
200 	} else if (wbc->for_reclaim)
201 		nilfs_flush_segment(inode->i_sb, inode->i_ino);
202 
203 	return 0;
204 }
205 
206 static int nilfs_set_page_dirty(struct page *page)
207 {
208 	struct inode *inode = page->mapping->host;
209 	int ret = __set_page_dirty_nobuffers(page);
210 
211 	if (page_has_buffers(page)) {
212 		unsigned int nr_dirty = 0;
213 		struct buffer_head *bh, *head;
214 
215 		/*
216 		 * This page is locked by callers, and no other thread
217 		 * concurrently marks its buffers dirty since they are
218 		 * only dirtied through routines in fs/buffer.c in
219 		 * which call sites of mark_buffer_dirty are protected
220 		 * by page lock.
221 		 */
222 		bh = head = page_buffers(page);
223 		do {
224 			/* Do not mark hole blocks dirty */
225 			if (buffer_dirty(bh) || !buffer_mapped(bh))
226 				continue;
227 
228 			set_buffer_dirty(bh);
229 			nr_dirty++;
230 		} while (bh = bh->b_this_page, bh != head);
231 
232 		if (nr_dirty)
233 			nilfs_set_file_dirty(inode, nr_dirty);
234 	} else if (ret) {
235 		unsigned int nr_dirty = 1 << (PAGE_SHIFT - inode->i_blkbits);
236 
237 		nilfs_set_file_dirty(inode, nr_dirty);
238 	}
239 	return ret;
240 }
241 
242 void nilfs_write_failed(struct address_space *mapping, loff_t to)
243 {
244 	struct inode *inode = mapping->host;
245 
246 	if (to > inode->i_size) {
247 		truncate_pagecache(inode, inode->i_size);
248 		nilfs_truncate(inode);
249 	}
250 }
251 
252 static int nilfs_write_begin(struct file *file, struct address_space *mapping,
253 			     loff_t pos, unsigned len, unsigned flags,
254 			     struct page **pagep, void **fsdata)
255 
256 {
257 	struct inode *inode = mapping->host;
258 	int err = nilfs_transaction_begin(inode->i_sb, NULL, 1);
259 
260 	if (unlikely(err))
261 		return err;
262 
263 	err = block_write_begin(mapping, pos, len, flags, pagep,
264 				nilfs_get_block);
265 	if (unlikely(err)) {
266 		nilfs_write_failed(mapping, pos + len);
267 		nilfs_transaction_abort(inode->i_sb);
268 	}
269 	return err;
270 }
271 
272 static int nilfs_write_end(struct file *file, struct address_space *mapping,
273 			   loff_t pos, unsigned len, unsigned copied,
274 			   struct page *page, void *fsdata)
275 {
276 	struct inode *inode = mapping->host;
277 	unsigned int start = pos & (PAGE_SIZE - 1);
278 	unsigned int nr_dirty;
279 	int err;
280 
281 	nr_dirty = nilfs_page_count_clean_buffers(page, start,
282 						  start + copied);
283 	copied = generic_write_end(file, mapping, pos, len, copied, page,
284 				   fsdata);
285 	nilfs_set_file_dirty(inode, nr_dirty);
286 	err = nilfs_transaction_commit(inode->i_sb);
287 	return err ? : copied;
288 }
289 
290 static ssize_t
291 nilfs_direct_IO(struct kiocb *iocb, struct iov_iter *iter)
292 {
293 	struct inode *inode = file_inode(iocb->ki_filp);
294 
295 	if (iov_iter_rw(iter) == WRITE)
296 		return 0;
297 
298 	/* Needs synchronization with the cleaner */
299 	return blockdev_direct_IO(iocb, inode, iter, nilfs_get_block);
300 }
301 
302 const struct address_space_operations nilfs_aops = {
303 	.writepage		= nilfs_writepage,
304 	.readpage		= nilfs_readpage,
305 	.writepages		= nilfs_writepages,
306 	.set_page_dirty		= nilfs_set_page_dirty,
307 	.readahead		= nilfs_readahead,
308 	.write_begin		= nilfs_write_begin,
309 	.write_end		= nilfs_write_end,
310 	/* .releasepage		= nilfs_releasepage, */
311 	.invalidatepage		= block_invalidatepage,
312 	.direct_IO		= nilfs_direct_IO,
313 	.is_partially_uptodate  = block_is_partially_uptodate,
314 };
315 
316 static int nilfs_insert_inode_locked(struct inode *inode,
317 				     struct nilfs_root *root,
318 				     unsigned long ino)
319 {
320 	struct nilfs_iget_args args = {
321 		.ino = ino, .root = root, .cno = 0, .for_gc = false,
322 		.for_btnc = false, .for_shadow = false
323 	};
324 
325 	return insert_inode_locked4(inode, ino, nilfs_iget_test, &args);
326 }
327 
328 struct inode *nilfs_new_inode(struct inode *dir, umode_t mode)
329 {
330 	struct super_block *sb = dir->i_sb;
331 	struct the_nilfs *nilfs = sb->s_fs_info;
332 	struct inode *inode;
333 	struct nilfs_inode_info *ii;
334 	struct nilfs_root *root;
335 	int err = -ENOMEM;
336 	ino_t ino;
337 
338 	inode = new_inode(sb);
339 	if (unlikely(!inode))
340 		goto failed;
341 
342 	mapping_set_gfp_mask(inode->i_mapping,
343 			   mapping_gfp_constraint(inode->i_mapping, ~__GFP_FS));
344 
345 	root = NILFS_I(dir)->i_root;
346 	ii = NILFS_I(inode);
347 	ii->i_state = BIT(NILFS_I_NEW);
348 	ii->i_root = root;
349 
350 	err = nilfs_ifile_create_inode(root->ifile, &ino, &ii->i_bh);
351 	if (unlikely(err))
352 		goto failed_ifile_create_inode;
353 	/* reference count of i_bh inherits from nilfs_mdt_read_block() */
354 
355 	atomic64_inc(&root->inodes_count);
356 	inode_init_owner(&init_user_ns, inode, dir, mode);
357 	inode->i_ino = ino;
358 	inode->i_mtime = inode->i_atime = inode->i_ctime = current_time(inode);
359 
360 	if (S_ISREG(mode) || S_ISDIR(mode) || S_ISLNK(mode)) {
361 		err = nilfs_bmap_read(ii->i_bmap, NULL);
362 		if (err < 0)
363 			goto failed_after_creation;
364 
365 		set_bit(NILFS_I_BMAP, &ii->i_state);
366 		/* No lock is needed; iget() ensures it. */
367 	}
368 
369 	ii->i_flags = nilfs_mask_flags(
370 		mode, NILFS_I(dir)->i_flags & NILFS_FL_INHERITED);
371 
372 	/* ii->i_file_acl = 0; */
373 	/* ii->i_dir_acl = 0; */
374 	ii->i_dir_start_lookup = 0;
375 	nilfs_set_inode_flags(inode);
376 	spin_lock(&nilfs->ns_next_gen_lock);
377 	inode->i_generation = nilfs->ns_next_generation++;
378 	spin_unlock(&nilfs->ns_next_gen_lock);
379 	if (nilfs_insert_inode_locked(inode, root, ino) < 0) {
380 		err = -EIO;
381 		goto failed_after_creation;
382 	}
383 
384 	err = nilfs_init_acl(inode, dir);
385 	if (unlikely(err))
386 		/*
387 		 * Never occur.  When supporting nilfs_init_acl(),
388 		 * proper cancellation of above jobs should be considered.
389 		 */
390 		goto failed_after_creation;
391 
392 	return inode;
393 
394  failed_after_creation:
395 	clear_nlink(inode);
396 	if (inode->i_state & I_NEW)
397 		unlock_new_inode(inode);
398 	iput(inode);  /*
399 		       * raw_inode will be deleted through
400 		       * nilfs_evict_inode().
401 		       */
402 	goto failed;
403 
404  failed_ifile_create_inode:
405 	make_bad_inode(inode);
406 	iput(inode);
407  failed:
408 	return ERR_PTR(err);
409 }
410 
411 void nilfs_set_inode_flags(struct inode *inode)
412 {
413 	unsigned int flags = NILFS_I(inode)->i_flags;
414 	unsigned int new_fl = 0;
415 
416 	if (flags & FS_SYNC_FL)
417 		new_fl |= S_SYNC;
418 	if (flags & FS_APPEND_FL)
419 		new_fl |= S_APPEND;
420 	if (flags & FS_IMMUTABLE_FL)
421 		new_fl |= S_IMMUTABLE;
422 	if (flags & FS_NOATIME_FL)
423 		new_fl |= S_NOATIME;
424 	if (flags & FS_DIRSYNC_FL)
425 		new_fl |= S_DIRSYNC;
426 	inode_set_flags(inode, new_fl, S_SYNC | S_APPEND | S_IMMUTABLE |
427 			S_NOATIME | S_DIRSYNC);
428 }
429 
430 int nilfs_read_inode_common(struct inode *inode,
431 			    struct nilfs_inode *raw_inode)
432 {
433 	struct nilfs_inode_info *ii = NILFS_I(inode);
434 	int err;
435 
436 	inode->i_mode = le16_to_cpu(raw_inode->i_mode);
437 	i_uid_write(inode, le32_to_cpu(raw_inode->i_uid));
438 	i_gid_write(inode, le32_to_cpu(raw_inode->i_gid));
439 	set_nlink(inode, le16_to_cpu(raw_inode->i_links_count));
440 	inode->i_size = le64_to_cpu(raw_inode->i_size);
441 	inode->i_atime.tv_sec = le64_to_cpu(raw_inode->i_mtime);
442 	inode->i_ctime.tv_sec = le64_to_cpu(raw_inode->i_ctime);
443 	inode->i_mtime.tv_sec = le64_to_cpu(raw_inode->i_mtime);
444 	inode->i_atime.tv_nsec = le32_to_cpu(raw_inode->i_mtime_nsec);
445 	inode->i_ctime.tv_nsec = le32_to_cpu(raw_inode->i_ctime_nsec);
446 	inode->i_mtime.tv_nsec = le32_to_cpu(raw_inode->i_mtime_nsec);
447 	if (inode->i_nlink == 0)
448 		return -ESTALE; /* this inode is deleted */
449 
450 	inode->i_blocks = le64_to_cpu(raw_inode->i_blocks);
451 	ii->i_flags = le32_to_cpu(raw_inode->i_flags);
452 #if 0
453 	ii->i_file_acl = le32_to_cpu(raw_inode->i_file_acl);
454 	ii->i_dir_acl = S_ISREG(inode->i_mode) ?
455 		0 : le32_to_cpu(raw_inode->i_dir_acl);
456 #endif
457 	ii->i_dir_start_lookup = 0;
458 	inode->i_generation = le32_to_cpu(raw_inode->i_generation);
459 
460 	if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
461 	    S_ISLNK(inode->i_mode)) {
462 		err = nilfs_bmap_read(ii->i_bmap, raw_inode);
463 		if (err < 0)
464 			return err;
465 		set_bit(NILFS_I_BMAP, &ii->i_state);
466 		/* No lock is needed; iget() ensures it. */
467 	}
468 	return 0;
469 }
470 
471 static int __nilfs_read_inode(struct super_block *sb,
472 			      struct nilfs_root *root, unsigned long ino,
473 			      struct inode *inode)
474 {
475 	struct the_nilfs *nilfs = sb->s_fs_info;
476 	struct buffer_head *bh;
477 	struct nilfs_inode *raw_inode;
478 	int err;
479 
480 	down_read(&NILFS_MDT(nilfs->ns_dat)->mi_sem);
481 	err = nilfs_ifile_get_inode_block(root->ifile, ino, &bh);
482 	if (unlikely(err))
483 		goto bad_inode;
484 
485 	raw_inode = nilfs_ifile_map_inode(root->ifile, ino, bh);
486 
487 	err = nilfs_read_inode_common(inode, raw_inode);
488 	if (err)
489 		goto failed_unmap;
490 
491 	if (S_ISREG(inode->i_mode)) {
492 		inode->i_op = &nilfs_file_inode_operations;
493 		inode->i_fop = &nilfs_file_operations;
494 		inode->i_mapping->a_ops = &nilfs_aops;
495 	} else if (S_ISDIR(inode->i_mode)) {
496 		inode->i_op = &nilfs_dir_inode_operations;
497 		inode->i_fop = &nilfs_dir_operations;
498 		inode->i_mapping->a_ops = &nilfs_aops;
499 	} else if (S_ISLNK(inode->i_mode)) {
500 		inode->i_op = &nilfs_symlink_inode_operations;
501 		inode_nohighmem(inode);
502 		inode->i_mapping->a_ops = &nilfs_aops;
503 	} else {
504 		inode->i_op = &nilfs_special_inode_operations;
505 		init_special_inode(
506 			inode, inode->i_mode,
507 			huge_decode_dev(le64_to_cpu(raw_inode->i_device_code)));
508 	}
509 	nilfs_ifile_unmap_inode(root->ifile, ino, bh);
510 	brelse(bh);
511 	up_read(&NILFS_MDT(nilfs->ns_dat)->mi_sem);
512 	nilfs_set_inode_flags(inode);
513 	mapping_set_gfp_mask(inode->i_mapping,
514 			   mapping_gfp_constraint(inode->i_mapping, ~__GFP_FS));
515 	return 0;
516 
517  failed_unmap:
518 	nilfs_ifile_unmap_inode(root->ifile, ino, bh);
519 	brelse(bh);
520 
521  bad_inode:
522 	up_read(&NILFS_MDT(nilfs->ns_dat)->mi_sem);
523 	return err;
524 }
525 
526 static int nilfs_iget_test(struct inode *inode, void *opaque)
527 {
528 	struct nilfs_iget_args *args = opaque;
529 	struct nilfs_inode_info *ii;
530 
531 	if (args->ino != inode->i_ino || args->root != NILFS_I(inode)->i_root)
532 		return 0;
533 
534 	ii = NILFS_I(inode);
535 	if (test_bit(NILFS_I_BTNC, &ii->i_state)) {
536 		if (!args->for_btnc)
537 			return 0;
538 	} else if (args->for_btnc) {
539 		return 0;
540 	}
541 	if (test_bit(NILFS_I_SHADOW, &ii->i_state)) {
542 		if (!args->for_shadow)
543 			return 0;
544 	} else if (args->for_shadow) {
545 		return 0;
546 	}
547 
548 	if (!test_bit(NILFS_I_GCINODE, &ii->i_state))
549 		return !args->for_gc;
550 
551 	return args->for_gc && args->cno == ii->i_cno;
552 }
553 
554 static int nilfs_iget_set(struct inode *inode, void *opaque)
555 {
556 	struct nilfs_iget_args *args = opaque;
557 
558 	inode->i_ino = args->ino;
559 	NILFS_I(inode)->i_cno = args->cno;
560 	NILFS_I(inode)->i_root = args->root;
561 	if (args->root && args->ino == NILFS_ROOT_INO)
562 		nilfs_get_root(args->root);
563 
564 	if (args->for_gc)
565 		NILFS_I(inode)->i_state = BIT(NILFS_I_GCINODE);
566 	if (args->for_btnc)
567 		NILFS_I(inode)->i_state |= BIT(NILFS_I_BTNC);
568 	if (args->for_shadow)
569 		NILFS_I(inode)->i_state |= BIT(NILFS_I_SHADOW);
570 	return 0;
571 }
572 
573 struct inode *nilfs_ilookup(struct super_block *sb, struct nilfs_root *root,
574 			    unsigned long ino)
575 {
576 	struct nilfs_iget_args args = {
577 		.ino = ino, .root = root, .cno = 0, .for_gc = false,
578 		.for_btnc = false, .for_shadow = false
579 	};
580 
581 	return ilookup5(sb, ino, nilfs_iget_test, &args);
582 }
583 
584 struct inode *nilfs_iget_locked(struct super_block *sb, struct nilfs_root *root,
585 				unsigned long ino)
586 {
587 	struct nilfs_iget_args args = {
588 		.ino = ino, .root = root, .cno = 0, .for_gc = false,
589 		.for_btnc = false, .for_shadow = false
590 	};
591 
592 	return iget5_locked(sb, ino, nilfs_iget_test, nilfs_iget_set, &args);
593 }
594 
595 struct inode *nilfs_iget(struct super_block *sb, struct nilfs_root *root,
596 			 unsigned long ino)
597 {
598 	struct inode *inode;
599 	int err;
600 
601 	inode = nilfs_iget_locked(sb, root, ino);
602 	if (unlikely(!inode))
603 		return ERR_PTR(-ENOMEM);
604 	if (!(inode->i_state & I_NEW))
605 		return inode;
606 
607 	err = __nilfs_read_inode(sb, root, ino, inode);
608 	if (unlikely(err)) {
609 		iget_failed(inode);
610 		return ERR_PTR(err);
611 	}
612 	unlock_new_inode(inode);
613 	return inode;
614 }
615 
616 struct inode *nilfs_iget_for_gc(struct super_block *sb, unsigned long ino,
617 				__u64 cno)
618 {
619 	struct nilfs_iget_args args = {
620 		.ino = ino, .root = NULL, .cno = cno, .for_gc = true,
621 		.for_btnc = false, .for_shadow = false
622 	};
623 	struct inode *inode;
624 	int err;
625 
626 	inode = iget5_locked(sb, ino, nilfs_iget_test, nilfs_iget_set, &args);
627 	if (unlikely(!inode))
628 		return ERR_PTR(-ENOMEM);
629 	if (!(inode->i_state & I_NEW))
630 		return inode;
631 
632 	err = nilfs_init_gcinode(inode);
633 	if (unlikely(err)) {
634 		iget_failed(inode);
635 		return ERR_PTR(err);
636 	}
637 	unlock_new_inode(inode);
638 	return inode;
639 }
640 
641 /**
642  * nilfs_attach_btree_node_cache - attach a B-tree node cache to the inode
643  * @inode: inode object
644  *
645  * nilfs_attach_btree_node_cache() attaches a B-tree node cache to @inode,
646  * or does nothing if the inode already has it.  This function allocates
647  * an additional inode to maintain page cache of B-tree nodes one-on-one.
648  *
649  * Return Value: On success, 0 is returned. On errors, one of the following
650  * negative error code is returned.
651  *
652  * %-ENOMEM - Insufficient memory available.
653  */
654 int nilfs_attach_btree_node_cache(struct inode *inode)
655 {
656 	struct nilfs_inode_info *ii = NILFS_I(inode);
657 	struct inode *btnc_inode;
658 	struct nilfs_iget_args args;
659 
660 	if (ii->i_assoc_inode)
661 		return 0;
662 
663 	args.ino = inode->i_ino;
664 	args.root = ii->i_root;
665 	args.cno = ii->i_cno;
666 	args.for_gc = test_bit(NILFS_I_GCINODE, &ii->i_state) != 0;
667 	args.for_btnc = true;
668 	args.for_shadow = test_bit(NILFS_I_SHADOW, &ii->i_state) != 0;
669 
670 	btnc_inode = iget5_locked(inode->i_sb, inode->i_ino, nilfs_iget_test,
671 				  nilfs_iget_set, &args);
672 	if (unlikely(!btnc_inode))
673 		return -ENOMEM;
674 	if (btnc_inode->i_state & I_NEW) {
675 		nilfs_init_btnc_inode(btnc_inode);
676 		unlock_new_inode(btnc_inode);
677 	}
678 	NILFS_I(btnc_inode)->i_assoc_inode = inode;
679 	NILFS_I(btnc_inode)->i_bmap = ii->i_bmap;
680 	ii->i_assoc_inode = btnc_inode;
681 
682 	return 0;
683 }
684 
685 /**
686  * nilfs_detach_btree_node_cache - detach the B-tree node cache from the inode
687  * @inode: inode object
688  *
689  * nilfs_detach_btree_node_cache() detaches the B-tree node cache and its
690  * holder inode bound to @inode, or does nothing if @inode doesn't have it.
691  */
692 void nilfs_detach_btree_node_cache(struct inode *inode)
693 {
694 	struct nilfs_inode_info *ii = NILFS_I(inode);
695 	struct inode *btnc_inode = ii->i_assoc_inode;
696 
697 	if (btnc_inode) {
698 		NILFS_I(btnc_inode)->i_assoc_inode = NULL;
699 		ii->i_assoc_inode = NULL;
700 		iput(btnc_inode);
701 	}
702 }
703 
704 /**
705  * nilfs_iget_for_shadow - obtain inode for shadow mapping
706  * @inode: inode object that uses shadow mapping
707  *
708  * nilfs_iget_for_shadow() allocates a pair of inodes that holds page
709  * caches for shadow mapping.  The page cache for data pages is set up
710  * in one inode and the one for b-tree node pages is set up in the
711  * other inode, which is attached to the former inode.
712  *
713  * Return Value: On success, a pointer to the inode for data pages is
714  * returned. On errors, one of the following negative error code is returned
715  * in a pointer type.
716  *
717  * %-ENOMEM - Insufficient memory available.
718  */
719 struct inode *nilfs_iget_for_shadow(struct inode *inode)
720 {
721 	struct nilfs_iget_args args = {
722 		.ino = inode->i_ino, .root = NULL, .cno = 0, .for_gc = false,
723 		.for_btnc = false, .for_shadow = true
724 	};
725 	struct inode *s_inode;
726 	int err;
727 
728 	s_inode = iget5_locked(inode->i_sb, inode->i_ino, nilfs_iget_test,
729 			       nilfs_iget_set, &args);
730 	if (unlikely(!s_inode))
731 		return ERR_PTR(-ENOMEM);
732 	if (!(s_inode->i_state & I_NEW))
733 		return inode;
734 
735 	NILFS_I(s_inode)->i_flags = 0;
736 	memset(NILFS_I(s_inode)->i_bmap, 0, sizeof(struct nilfs_bmap));
737 	mapping_set_gfp_mask(s_inode->i_mapping, GFP_NOFS);
738 
739 	err = nilfs_attach_btree_node_cache(s_inode);
740 	if (unlikely(err)) {
741 		iget_failed(s_inode);
742 		return ERR_PTR(err);
743 	}
744 	unlock_new_inode(s_inode);
745 	return s_inode;
746 }
747 
748 void nilfs_write_inode_common(struct inode *inode,
749 			      struct nilfs_inode *raw_inode, int has_bmap)
750 {
751 	struct nilfs_inode_info *ii = NILFS_I(inode);
752 
753 	raw_inode->i_mode = cpu_to_le16(inode->i_mode);
754 	raw_inode->i_uid = cpu_to_le32(i_uid_read(inode));
755 	raw_inode->i_gid = cpu_to_le32(i_gid_read(inode));
756 	raw_inode->i_links_count = cpu_to_le16(inode->i_nlink);
757 	raw_inode->i_size = cpu_to_le64(inode->i_size);
758 	raw_inode->i_ctime = cpu_to_le64(inode->i_ctime.tv_sec);
759 	raw_inode->i_mtime = cpu_to_le64(inode->i_mtime.tv_sec);
760 	raw_inode->i_ctime_nsec = cpu_to_le32(inode->i_ctime.tv_nsec);
761 	raw_inode->i_mtime_nsec = cpu_to_le32(inode->i_mtime.tv_nsec);
762 	raw_inode->i_blocks = cpu_to_le64(inode->i_blocks);
763 
764 	raw_inode->i_flags = cpu_to_le32(ii->i_flags);
765 	raw_inode->i_generation = cpu_to_le32(inode->i_generation);
766 
767 	if (NILFS_ROOT_METADATA_FILE(inode->i_ino)) {
768 		struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
769 
770 		/* zero-fill unused portion in the case of super root block */
771 		raw_inode->i_xattr = 0;
772 		raw_inode->i_pad = 0;
773 		memset((void *)raw_inode + sizeof(*raw_inode), 0,
774 		       nilfs->ns_inode_size - sizeof(*raw_inode));
775 	}
776 
777 	if (has_bmap)
778 		nilfs_bmap_write(ii->i_bmap, raw_inode);
779 	else if (S_ISCHR(inode->i_mode) || S_ISBLK(inode->i_mode))
780 		raw_inode->i_device_code =
781 			cpu_to_le64(huge_encode_dev(inode->i_rdev));
782 	/*
783 	 * When extending inode, nilfs->ns_inode_size should be checked
784 	 * for substitutions of appended fields.
785 	 */
786 }
787 
788 void nilfs_update_inode(struct inode *inode, struct buffer_head *ibh, int flags)
789 {
790 	ino_t ino = inode->i_ino;
791 	struct nilfs_inode_info *ii = NILFS_I(inode);
792 	struct inode *ifile = ii->i_root->ifile;
793 	struct nilfs_inode *raw_inode;
794 
795 	raw_inode = nilfs_ifile_map_inode(ifile, ino, ibh);
796 
797 	if (test_and_clear_bit(NILFS_I_NEW, &ii->i_state))
798 		memset(raw_inode, 0, NILFS_MDT(ifile)->mi_entry_size);
799 	if (flags & I_DIRTY_DATASYNC)
800 		set_bit(NILFS_I_INODE_SYNC, &ii->i_state);
801 
802 	nilfs_write_inode_common(inode, raw_inode, 0);
803 		/*
804 		 * XXX: call with has_bmap = 0 is a workaround to avoid
805 		 * deadlock of bmap.  This delays update of i_bmap to just
806 		 * before writing.
807 		 */
808 
809 	nilfs_ifile_unmap_inode(ifile, ino, ibh);
810 }
811 
812 #define NILFS_MAX_TRUNCATE_BLOCKS	16384  /* 64MB for 4KB block */
813 
814 static void nilfs_truncate_bmap(struct nilfs_inode_info *ii,
815 				unsigned long from)
816 {
817 	__u64 b;
818 	int ret;
819 
820 	if (!test_bit(NILFS_I_BMAP, &ii->i_state))
821 		return;
822 repeat:
823 	ret = nilfs_bmap_last_key(ii->i_bmap, &b);
824 	if (ret == -ENOENT)
825 		return;
826 	else if (ret < 0)
827 		goto failed;
828 
829 	if (b < from)
830 		return;
831 
832 	b -= min_t(__u64, NILFS_MAX_TRUNCATE_BLOCKS, b - from);
833 	ret = nilfs_bmap_truncate(ii->i_bmap, b);
834 	nilfs_relax_pressure_in_lock(ii->vfs_inode.i_sb);
835 	if (!ret || (ret == -ENOMEM &&
836 		     nilfs_bmap_truncate(ii->i_bmap, b) == 0))
837 		goto repeat;
838 
839 failed:
840 	nilfs_warn(ii->vfs_inode.i_sb, "error %d truncating bmap (ino=%lu)",
841 		   ret, ii->vfs_inode.i_ino);
842 }
843 
844 void nilfs_truncate(struct inode *inode)
845 {
846 	unsigned long blkoff;
847 	unsigned int blocksize;
848 	struct nilfs_transaction_info ti;
849 	struct super_block *sb = inode->i_sb;
850 	struct nilfs_inode_info *ii = NILFS_I(inode);
851 
852 	if (!test_bit(NILFS_I_BMAP, &ii->i_state))
853 		return;
854 	if (IS_APPEND(inode) || IS_IMMUTABLE(inode))
855 		return;
856 
857 	blocksize = sb->s_blocksize;
858 	blkoff = (inode->i_size + blocksize - 1) >> sb->s_blocksize_bits;
859 	nilfs_transaction_begin(sb, &ti, 0); /* never fails */
860 
861 	block_truncate_page(inode->i_mapping, inode->i_size, nilfs_get_block);
862 
863 	nilfs_truncate_bmap(ii, blkoff);
864 
865 	inode->i_mtime = inode->i_ctime = current_time(inode);
866 	if (IS_SYNC(inode))
867 		nilfs_set_transaction_flag(NILFS_TI_SYNC);
868 
869 	nilfs_mark_inode_dirty(inode);
870 	nilfs_set_file_dirty(inode, 0);
871 	nilfs_transaction_commit(sb);
872 	/*
873 	 * May construct a logical segment and may fail in sync mode.
874 	 * But truncate has no return value.
875 	 */
876 }
877 
878 static void nilfs_clear_inode(struct inode *inode)
879 {
880 	struct nilfs_inode_info *ii = NILFS_I(inode);
881 
882 	/*
883 	 * Free resources allocated in nilfs_read_inode(), here.
884 	 */
885 	BUG_ON(!list_empty(&ii->i_dirty));
886 	brelse(ii->i_bh);
887 	ii->i_bh = NULL;
888 
889 	if (nilfs_is_metadata_file_inode(inode))
890 		nilfs_mdt_clear(inode);
891 
892 	if (test_bit(NILFS_I_BMAP, &ii->i_state))
893 		nilfs_bmap_clear(ii->i_bmap);
894 
895 	if (!test_bit(NILFS_I_BTNC, &ii->i_state))
896 		nilfs_detach_btree_node_cache(inode);
897 
898 	if (ii->i_root && inode->i_ino == NILFS_ROOT_INO)
899 		nilfs_put_root(ii->i_root);
900 }
901 
902 void nilfs_evict_inode(struct inode *inode)
903 {
904 	struct nilfs_transaction_info ti;
905 	struct super_block *sb = inode->i_sb;
906 	struct nilfs_inode_info *ii = NILFS_I(inode);
907 	int ret;
908 
909 	if (inode->i_nlink || !ii->i_root || unlikely(is_bad_inode(inode))) {
910 		truncate_inode_pages_final(&inode->i_data);
911 		clear_inode(inode);
912 		nilfs_clear_inode(inode);
913 		return;
914 	}
915 	nilfs_transaction_begin(sb, &ti, 0); /* never fails */
916 
917 	truncate_inode_pages_final(&inode->i_data);
918 
919 	/* TODO: some of the following operations may fail.  */
920 	nilfs_truncate_bmap(ii, 0);
921 	nilfs_mark_inode_dirty(inode);
922 	clear_inode(inode);
923 
924 	ret = nilfs_ifile_delete_inode(ii->i_root->ifile, inode->i_ino);
925 	if (!ret)
926 		atomic64_dec(&ii->i_root->inodes_count);
927 
928 	nilfs_clear_inode(inode);
929 
930 	if (IS_SYNC(inode))
931 		nilfs_set_transaction_flag(NILFS_TI_SYNC);
932 	nilfs_transaction_commit(sb);
933 	/*
934 	 * May construct a logical segment and may fail in sync mode.
935 	 * But delete_inode has no return value.
936 	 */
937 }
938 
939 int nilfs_setattr(struct user_namespace *mnt_userns, struct dentry *dentry,
940 		  struct iattr *iattr)
941 {
942 	struct nilfs_transaction_info ti;
943 	struct inode *inode = d_inode(dentry);
944 	struct super_block *sb = inode->i_sb;
945 	int err;
946 
947 	err = setattr_prepare(&init_user_ns, dentry, iattr);
948 	if (err)
949 		return err;
950 
951 	err = nilfs_transaction_begin(sb, &ti, 0);
952 	if (unlikely(err))
953 		return err;
954 
955 	if ((iattr->ia_valid & ATTR_SIZE) &&
956 	    iattr->ia_size != i_size_read(inode)) {
957 		inode_dio_wait(inode);
958 		truncate_setsize(inode, iattr->ia_size);
959 		nilfs_truncate(inode);
960 	}
961 
962 	setattr_copy(&init_user_ns, inode, iattr);
963 	mark_inode_dirty(inode);
964 
965 	if (iattr->ia_valid & ATTR_MODE) {
966 		err = nilfs_acl_chmod(inode);
967 		if (unlikely(err))
968 			goto out_err;
969 	}
970 
971 	return nilfs_transaction_commit(sb);
972 
973 out_err:
974 	nilfs_transaction_abort(sb);
975 	return err;
976 }
977 
978 int nilfs_permission(struct user_namespace *mnt_userns, struct inode *inode,
979 		     int mask)
980 {
981 	struct nilfs_root *root = NILFS_I(inode)->i_root;
982 
983 	if ((mask & MAY_WRITE) && root &&
984 	    root->cno != NILFS_CPTREE_CURRENT_CNO)
985 		return -EROFS; /* snapshot is not writable */
986 
987 	return generic_permission(&init_user_ns, inode, mask);
988 }
989 
990 int nilfs_load_inode_block(struct inode *inode, struct buffer_head **pbh)
991 {
992 	struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
993 	struct nilfs_inode_info *ii = NILFS_I(inode);
994 	int err;
995 
996 	spin_lock(&nilfs->ns_inode_lock);
997 	if (ii->i_bh == NULL) {
998 		spin_unlock(&nilfs->ns_inode_lock);
999 		err = nilfs_ifile_get_inode_block(ii->i_root->ifile,
1000 						  inode->i_ino, pbh);
1001 		if (unlikely(err))
1002 			return err;
1003 		spin_lock(&nilfs->ns_inode_lock);
1004 		if (ii->i_bh == NULL)
1005 			ii->i_bh = *pbh;
1006 		else {
1007 			brelse(*pbh);
1008 			*pbh = ii->i_bh;
1009 		}
1010 	} else
1011 		*pbh = ii->i_bh;
1012 
1013 	get_bh(*pbh);
1014 	spin_unlock(&nilfs->ns_inode_lock);
1015 	return 0;
1016 }
1017 
1018 int nilfs_inode_dirty(struct inode *inode)
1019 {
1020 	struct nilfs_inode_info *ii = NILFS_I(inode);
1021 	struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1022 	int ret = 0;
1023 
1024 	if (!list_empty(&ii->i_dirty)) {
1025 		spin_lock(&nilfs->ns_inode_lock);
1026 		ret = test_bit(NILFS_I_DIRTY, &ii->i_state) ||
1027 			test_bit(NILFS_I_BUSY, &ii->i_state);
1028 		spin_unlock(&nilfs->ns_inode_lock);
1029 	}
1030 	return ret;
1031 }
1032 
1033 int nilfs_set_file_dirty(struct inode *inode, unsigned int nr_dirty)
1034 {
1035 	struct nilfs_inode_info *ii = NILFS_I(inode);
1036 	struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1037 
1038 	atomic_add(nr_dirty, &nilfs->ns_ndirtyblks);
1039 
1040 	if (test_and_set_bit(NILFS_I_DIRTY, &ii->i_state))
1041 		return 0;
1042 
1043 	spin_lock(&nilfs->ns_inode_lock);
1044 	if (!test_bit(NILFS_I_QUEUED, &ii->i_state) &&
1045 	    !test_bit(NILFS_I_BUSY, &ii->i_state)) {
1046 		/*
1047 		 * Because this routine may race with nilfs_dispose_list(),
1048 		 * we have to check NILFS_I_QUEUED here, too.
1049 		 */
1050 		if (list_empty(&ii->i_dirty) && igrab(inode) == NULL) {
1051 			/*
1052 			 * This will happen when somebody is freeing
1053 			 * this inode.
1054 			 */
1055 			nilfs_warn(inode->i_sb,
1056 				   "cannot set file dirty (ino=%lu): the file is being freed",
1057 				   inode->i_ino);
1058 			spin_unlock(&nilfs->ns_inode_lock);
1059 			return -EINVAL; /*
1060 					 * NILFS_I_DIRTY may remain for
1061 					 * freeing inode.
1062 					 */
1063 		}
1064 		list_move_tail(&ii->i_dirty, &nilfs->ns_dirty_files);
1065 		set_bit(NILFS_I_QUEUED, &ii->i_state);
1066 	}
1067 	spin_unlock(&nilfs->ns_inode_lock);
1068 	return 0;
1069 }
1070 
1071 int __nilfs_mark_inode_dirty(struct inode *inode, int flags)
1072 {
1073 	struct buffer_head *ibh;
1074 	int err;
1075 
1076 	err = nilfs_load_inode_block(inode, &ibh);
1077 	if (unlikely(err)) {
1078 		nilfs_warn(inode->i_sb,
1079 			   "cannot mark inode dirty (ino=%lu): error %d loading inode block",
1080 			   inode->i_ino, err);
1081 		return err;
1082 	}
1083 	nilfs_update_inode(inode, ibh, flags);
1084 	mark_buffer_dirty(ibh);
1085 	nilfs_mdt_mark_dirty(NILFS_I(inode)->i_root->ifile);
1086 	brelse(ibh);
1087 	return 0;
1088 }
1089 
1090 /**
1091  * nilfs_dirty_inode - reflect changes on given inode to an inode block.
1092  * @inode: inode of the file to be registered.
1093  *
1094  * nilfs_dirty_inode() loads a inode block containing the specified
1095  * @inode and copies data from a nilfs_inode to a corresponding inode
1096  * entry in the inode block. This operation is excluded from the segment
1097  * construction. This function can be called both as a single operation
1098  * and as a part of indivisible file operations.
1099  */
1100 void nilfs_dirty_inode(struct inode *inode, int flags)
1101 {
1102 	struct nilfs_transaction_info ti;
1103 	struct nilfs_mdt_info *mdi = NILFS_MDT(inode);
1104 
1105 	if (is_bad_inode(inode)) {
1106 		nilfs_warn(inode->i_sb,
1107 			   "tried to mark bad_inode dirty. ignored.");
1108 		dump_stack();
1109 		return;
1110 	}
1111 	if (mdi) {
1112 		nilfs_mdt_mark_dirty(inode);
1113 		return;
1114 	}
1115 	nilfs_transaction_begin(inode->i_sb, &ti, 0);
1116 	__nilfs_mark_inode_dirty(inode, flags);
1117 	nilfs_transaction_commit(inode->i_sb); /* never fails */
1118 }
1119 
1120 int nilfs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
1121 		 __u64 start, __u64 len)
1122 {
1123 	struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1124 	__u64 logical = 0, phys = 0, size = 0;
1125 	__u32 flags = 0;
1126 	loff_t isize;
1127 	sector_t blkoff, end_blkoff;
1128 	sector_t delalloc_blkoff;
1129 	unsigned long delalloc_blklen;
1130 	unsigned int blkbits = inode->i_blkbits;
1131 	int ret, n;
1132 
1133 	ret = fiemap_prep(inode, fieinfo, start, &len, 0);
1134 	if (ret)
1135 		return ret;
1136 
1137 	inode_lock(inode);
1138 
1139 	isize = i_size_read(inode);
1140 
1141 	blkoff = start >> blkbits;
1142 	end_blkoff = (start + len - 1) >> blkbits;
1143 
1144 	delalloc_blklen = nilfs_find_uncommitted_extent(inode, blkoff,
1145 							&delalloc_blkoff);
1146 
1147 	do {
1148 		__u64 blkphy;
1149 		unsigned int maxblocks;
1150 
1151 		if (delalloc_blklen && blkoff == delalloc_blkoff) {
1152 			if (size) {
1153 				/* End of the current extent */
1154 				ret = fiemap_fill_next_extent(
1155 					fieinfo, logical, phys, size, flags);
1156 				if (ret)
1157 					break;
1158 			}
1159 			if (blkoff > end_blkoff)
1160 				break;
1161 
1162 			flags = FIEMAP_EXTENT_MERGED | FIEMAP_EXTENT_DELALLOC;
1163 			logical = blkoff << blkbits;
1164 			phys = 0;
1165 			size = delalloc_blklen << blkbits;
1166 
1167 			blkoff = delalloc_blkoff + delalloc_blklen;
1168 			delalloc_blklen = nilfs_find_uncommitted_extent(
1169 				inode, blkoff, &delalloc_blkoff);
1170 			continue;
1171 		}
1172 
1173 		/*
1174 		 * Limit the number of blocks that we look up so as
1175 		 * not to get into the next delayed allocation extent.
1176 		 */
1177 		maxblocks = INT_MAX;
1178 		if (delalloc_blklen)
1179 			maxblocks = min_t(sector_t, delalloc_blkoff - blkoff,
1180 					  maxblocks);
1181 		blkphy = 0;
1182 
1183 		down_read(&NILFS_MDT(nilfs->ns_dat)->mi_sem);
1184 		n = nilfs_bmap_lookup_contig(
1185 			NILFS_I(inode)->i_bmap, blkoff, &blkphy, maxblocks);
1186 		up_read(&NILFS_MDT(nilfs->ns_dat)->mi_sem);
1187 
1188 		if (n < 0) {
1189 			int past_eof;
1190 
1191 			if (unlikely(n != -ENOENT))
1192 				break; /* error */
1193 
1194 			/* HOLE */
1195 			blkoff++;
1196 			past_eof = ((blkoff << blkbits) >= isize);
1197 
1198 			if (size) {
1199 				/* End of the current extent */
1200 
1201 				if (past_eof)
1202 					flags |= FIEMAP_EXTENT_LAST;
1203 
1204 				ret = fiemap_fill_next_extent(
1205 					fieinfo, logical, phys, size, flags);
1206 				if (ret)
1207 					break;
1208 				size = 0;
1209 			}
1210 			if (blkoff > end_blkoff || past_eof)
1211 				break;
1212 		} else {
1213 			if (size) {
1214 				if (phys && blkphy << blkbits == phys + size) {
1215 					/* The current extent goes on */
1216 					size += n << blkbits;
1217 				} else {
1218 					/* Terminate the current extent */
1219 					ret = fiemap_fill_next_extent(
1220 						fieinfo, logical, phys, size,
1221 						flags);
1222 					if (ret || blkoff > end_blkoff)
1223 						break;
1224 
1225 					/* Start another extent */
1226 					flags = FIEMAP_EXTENT_MERGED;
1227 					logical = blkoff << blkbits;
1228 					phys = blkphy << blkbits;
1229 					size = n << blkbits;
1230 				}
1231 			} else {
1232 				/* Start a new extent */
1233 				flags = FIEMAP_EXTENT_MERGED;
1234 				logical = blkoff << blkbits;
1235 				phys = blkphy << blkbits;
1236 				size = n << blkbits;
1237 			}
1238 			blkoff += n;
1239 		}
1240 		cond_resched();
1241 	} while (true);
1242 
1243 	/* If ret is 1 then we just hit the end of the extent array */
1244 	if (ret == 1)
1245 		ret = 0;
1246 
1247 	inode_unlock(inode);
1248 	return ret;
1249 }
1250