1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * fs/f2fs/dir.c
4  *
5  * Copyright (c) 2012 Samsung Electronics Co., Ltd.
6  *             http://www.samsung.com/
7  */
8 #include <linux/unaligned.h>
9 #include <linux/fs.h>
10 #include <linux/f2fs_fs.h>
11 #include <linux/sched/signal.h>
12 #include <linux/unicode.h>
13 #include "f2fs.h"
14 #include "node.h"
15 #include "acl.h"
16 #include "xattr.h"
17 #include <trace/events/f2fs.h>
18 
f2fs_should_fallback_to_linear(struct inode * dir)19 static inline bool f2fs_should_fallback_to_linear(struct inode *dir)
20 {
21 	struct f2fs_sb_info *sbi = F2FS_I_SB(dir);
22 
23 	switch (f2fs_get_lookup_mode(sbi)) {
24 	case LOOKUP_PERF:
25 		return false;
26 	case LOOKUP_COMPAT:
27 		return true;
28 	case LOOKUP_AUTO:
29 		return !sb_no_casefold_compat_fallback(sbi->sb);
30 	}
31 	return false;
32 }
33 
34 #if IS_ENABLED(CONFIG_UNICODE)
35 extern struct kmem_cache *f2fs_cf_name_slab;
36 #endif
37 
dir_blocks(struct inode * inode)38 static unsigned long dir_blocks(struct inode *inode)
39 {
40 	return ((unsigned long long) (i_size_read(inode) + PAGE_SIZE - 1))
41 							>> PAGE_SHIFT;
42 }
43 
dir_buckets(unsigned int level,int dir_level)44 static unsigned int dir_buckets(unsigned int level, int dir_level)
45 {
46 	if (level + dir_level < MAX_DIR_HASH_DEPTH / 2)
47 		return BIT(level + dir_level);
48 	else
49 		return MAX_DIR_BUCKETS;
50 }
51 
bucket_blocks(unsigned int level)52 static unsigned int bucket_blocks(unsigned int level)
53 {
54 	if (level < MAX_DIR_HASH_DEPTH / 2)
55 		return 2;
56 	else
57 		return 4;
58 }
59 
60 #if IS_ENABLED(CONFIG_UNICODE)
61 /* If @dir is casefolded, initialize @fname->cf_name from @fname->usr_fname. */
f2fs_init_casefolded_name(const struct inode * dir,struct f2fs_filename * fname)62 int f2fs_init_casefolded_name(const struct inode *dir,
63 			      struct f2fs_filename *fname)
64 {
65 	struct super_block *sb = dir->i_sb;
66 	unsigned char *buf;
67 	int len;
68 
69 	if (IS_CASEFOLDED(dir) &&
70 	    !is_dot_dotdot(fname->usr_fname->name, fname->usr_fname->len)) {
71 		buf = f2fs_kmem_cache_alloc(f2fs_cf_name_slab,
72 					    GFP_NOFS, false, F2FS_SB(sb));
73 		if (!buf)
74 			return -ENOMEM;
75 
76 		len = utf8_casefold(sb->s_encoding, fname->usr_fname,
77 				    buf, F2FS_NAME_LEN);
78 		if (len <= 0) {
79 			kmem_cache_free(f2fs_cf_name_slab, buf);
80 			if (sb_has_strict_encoding(sb))
81 				return -EINVAL;
82 			/* fall back to treating name as opaque byte sequence */
83 			return 0;
84 		}
85 		fname->cf_name.name = buf;
86 		fname->cf_name.len = len;
87 	}
88 
89 	return 0;
90 }
91 
f2fs_free_casefolded_name(struct f2fs_filename * fname)92 void f2fs_free_casefolded_name(struct f2fs_filename *fname)
93 {
94 	unsigned char *buf = (unsigned char *)fname->cf_name.name;
95 
96 	if (buf) {
97 		kmem_cache_free(f2fs_cf_name_slab, buf);
98 		fname->cf_name.name = NULL;
99 	}
100 }
101 #endif /* CONFIG_UNICODE */
102 
__f2fs_setup_filename(const struct inode * dir,const struct fscrypt_name * crypt_name,struct f2fs_filename * fname)103 static int __f2fs_setup_filename(const struct inode *dir,
104 				 const struct fscrypt_name *crypt_name,
105 				 struct f2fs_filename *fname)
106 {
107 	int err;
108 
109 	memset(fname, 0, sizeof(*fname));
110 
111 	fname->usr_fname = crypt_name->usr_fname;
112 	fname->disk_name = crypt_name->disk_name;
113 #ifdef CONFIG_FS_ENCRYPTION
114 	fname->crypto_buf = crypt_name->crypto_buf;
115 #endif
116 	if (crypt_name->is_nokey_name) {
117 		/* hash was decoded from the no-key name */
118 		fname->hash = cpu_to_le32(crypt_name->hash);
119 	} else {
120 		err = f2fs_init_casefolded_name(dir, fname);
121 		if (err) {
122 			f2fs_free_filename(fname);
123 			return err;
124 		}
125 		f2fs_hash_filename(dir, fname);
126 	}
127 	return 0;
128 }
129 
130 /*
131  * Prepare to search for @iname in @dir.  This is similar to
132  * fscrypt_setup_filename(), but this also handles computing the casefolded name
133  * and the f2fs dirhash if needed, then packing all the information about this
134  * filename up into a 'struct f2fs_filename'.
135  */
f2fs_setup_filename(struct inode * dir,const struct qstr * iname,int lookup,struct f2fs_filename * fname)136 int f2fs_setup_filename(struct inode *dir, const struct qstr *iname,
137 			int lookup, struct f2fs_filename *fname)
138 {
139 	struct fscrypt_name crypt_name;
140 	int err;
141 
142 	err = fscrypt_setup_filename(dir, iname, lookup, &crypt_name);
143 	if (err)
144 		return err;
145 
146 	return __f2fs_setup_filename(dir, &crypt_name, fname);
147 }
148 
149 /*
150  * Prepare to look up @dentry in @dir.  This is similar to
151  * fscrypt_prepare_lookup(), but this also handles computing the casefolded name
152  * and the f2fs dirhash if needed, then packing all the information about this
153  * filename up into a 'struct f2fs_filename'.
154  */
f2fs_prepare_lookup(struct inode * dir,struct dentry * dentry,struct f2fs_filename * fname)155 int f2fs_prepare_lookup(struct inode *dir, struct dentry *dentry,
156 			struct f2fs_filename *fname)
157 {
158 	struct fscrypt_name crypt_name;
159 	int err;
160 
161 	err = fscrypt_prepare_lookup(dir, dentry, &crypt_name);
162 	if (err)
163 		return err;
164 
165 	return __f2fs_setup_filename(dir, &crypt_name, fname);
166 }
167 
f2fs_free_filename(struct f2fs_filename * fname)168 void f2fs_free_filename(struct f2fs_filename *fname)
169 {
170 #ifdef CONFIG_FS_ENCRYPTION
171 	kfree(fname->crypto_buf.name);
172 	fname->crypto_buf.name = NULL;
173 #endif
174 	f2fs_free_casefolded_name(fname);
175 }
176 
dir_block_index(unsigned int level,int dir_level,unsigned int idx)177 static unsigned long dir_block_index(unsigned int level,
178 				int dir_level, unsigned int idx)
179 {
180 	unsigned long i;
181 	unsigned long bidx = 0;
182 
183 	for (i = 0; i < level; i++)
184 		bidx += mul_u32_u32(dir_buckets(i, dir_level),
185 				    bucket_blocks(i));
186 	bidx += idx * bucket_blocks(level);
187 	return bidx;
188 }
189 
find_in_block(struct inode * dir,struct page * dentry_page,const struct f2fs_filename * fname,int * max_slots,bool use_hash)190 static struct f2fs_dir_entry *find_in_block(struct inode *dir,
191 				struct page *dentry_page,
192 				const struct f2fs_filename *fname,
193 				int *max_slots,
194 				bool use_hash)
195 {
196 	struct f2fs_dentry_block *dentry_blk;
197 	struct f2fs_dentry_ptr d;
198 
199 	dentry_blk = (struct f2fs_dentry_block *)page_address(dentry_page);
200 
201 	make_dentry_ptr_block(dir, &d, dentry_blk);
202 	return f2fs_find_target_dentry(&d, fname, max_slots, use_hash);
203 }
204 
f2fs_match_name(const struct inode * dir,const struct f2fs_filename * fname,const u8 * de_name,u32 de_name_len)205 static inline int f2fs_match_name(const struct inode *dir,
206 				   const struct f2fs_filename *fname,
207 				   const u8 *de_name, u32 de_name_len)
208 {
209 	struct fscrypt_name f;
210 
211 #if IS_ENABLED(CONFIG_UNICODE)
212 	if (fname->cf_name.name)
213 		return generic_ci_match(dir, fname->usr_fname,
214 					&fname->cf_name,
215 					de_name, de_name_len);
216 
217 #endif
218 	f.usr_fname = fname->usr_fname;
219 	f.disk_name = fname->disk_name;
220 #ifdef CONFIG_FS_ENCRYPTION
221 	f.crypto_buf = fname->crypto_buf;
222 #endif
223 	return fscrypt_match_name(&f, de_name, de_name_len);
224 }
225 
f2fs_find_target_dentry(const struct f2fs_dentry_ptr * d,const struct f2fs_filename * fname,int * max_slots,bool use_hash)226 struct f2fs_dir_entry *f2fs_find_target_dentry(const struct f2fs_dentry_ptr *d,
227 			const struct f2fs_filename *fname, int *max_slots,
228 			bool use_hash)
229 {
230 	struct f2fs_dir_entry *de;
231 	unsigned long bit_pos = 0;
232 	int max_len = 0;
233 	int res = 0;
234 
235 	if (max_slots)
236 		*max_slots = 0;
237 	while (bit_pos < d->max) {
238 		if (!test_bit_le(bit_pos, d->bitmap)) {
239 			bit_pos++;
240 			max_len++;
241 			continue;
242 		}
243 
244 		de = &d->dentry[bit_pos];
245 
246 		if (unlikely(!de->name_len)) {
247 			bit_pos++;
248 			continue;
249 		}
250 
251 		if (!use_hash || de->hash_code == fname->hash) {
252 			res = f2fs_match_name(d->inode, fname,
253 					      d->filename[bit_pos],
254 					      le16_to_cpu(de->name_len));
255 			if (res < 0)
256 				return ERR_PTR(res);
257 			if (res)
258 				goto found;
259 		}
260 
261 		if (max_slots && max_len > *max_slots)
262 			*max_slots = max_len;
263 		max_len = 0;
264 
265 		bit_pos += GET_DENTRY_SLOTS(le16_to_cpu(de->name_len));
266 	}
267 
268 	de = NULL;
269 found:
270 	if (max_slots && max_len > *max_slots)
271 		*max_slots = max_len;
272 	return de;
273 }
274 
find_in_level(struct inode * dir,unsigned int level,const struct f2fs_filename * fname,struct page ** res_page,bool use_hash)275 static struct f2fs_dir_entry *find_in_level(struct inode *dir,
276 					unsigned int level,
277 					const struct f2fs_filename *fname,
278 					struct page **res_page,
279 					bool use_hash)
280 {
281 	int s = GET_DENTRY_SLOTS(fname->disk_name.len);
282 	unsigned int nbucket, nblock;
283 	unsigned int bidx, end_block, bucket_no;
284 	struct page *dentry_page;
285 	struct f2fs_dir_entry *de = NULL;
286 	pgoff_t next_pgofs;
287 	bool room = false;
288 	int max_slots;
289 
290 	nbucket = dir_buckets(level, F2FS_I(dir)->i_dir_level);
291 	nblock = bucket_blocks(level);
292 
293 	bucket_no = use_hash ? le32_to_cpu(fname->hash) % nbucket : 0;
294 
295 start_find_bucket:
296 	bidx = dir_block_index(level, F2FS_I(dir)->i_dir_level,
297 			       bucket_no);
298 	end_block = bidx + nblock;
299 
300 	while (bidx < end_block) {
301 		/* no need to allocate new dentry pages to all the indices */
302 		dentry_page = f2fs_find_data_page(dir, bidx, &next_pgofs);
303 		if (IS_ERR(dentry_page)) {
304 			if (PTR_ERR(dentry_page) == -ENOENT) {
305 				room = true;
306 				bidx = next_pgofs;
307 				continue;
308 			} else {
309 				*res_page = dentry_page;
310 				break;
311 			}
312 		}
313 
314 		de = find_in_block(dir, dentry_page, fname, &max_slots, use_hash);
315 		if (IS_ERR(de)) {
316 			*res_page = ERR_CAST(de);
317 			de = NULL;
318 			break;
319 		} else if (de) {
320 			*res_page = dentry_page;
321 			break;
322 		}
323 
324 		if (max_slots >= s)
325 			room = true;
326 		f2fs_put_page(dentry_page, 0);
327 
328 		bidx++;
329 	}
330 
331 	if (de)
332 		return de;
333 
334 	if (likely(use_hash)) {
335 		if (room && F2FS_I(dir)->chash != fname->hash) {
336 			F2FS_I(dir)->chash = fname->hash;
337 			F2FS_I(dir)->clevel = level;
338 		}
339 	} else if (++bucket_no < nbucket) {
340 		goto start_find_bucket;
341 	}
342 	return NULL;
343 }
344 
__f2fs_find_entry(struct inode * dir,const struct f2fs_filename * fname,struct page ** res_page)345 struct f2fs_dir_entry *__f2fs_find_entry(struct inode *dir,
346 					 const struct f2fs_filename *fname,
347 					 struct page **res_page)
348 {
349 	unsigned long npages = dir_blocks(dir);
350 	struct f2fs_dir_entry *de = NULL;
351 	unsigned int max_depth;
352 	unsigned int level;
353 	bool use_hash = true;
354 
355 	*res_page = NULL;
356 
357 #if IS_ENABLED(CONFIG_UNICODE)
358 start_find_entry:
359 #endif
360 	if (f2fs_has_inline_dentry(dir)) {
361 		de = f2fs_find_in_inline_dir(dir, fname, res_page, use_hash);
362 		goto out;
363 	}
364 
365 	if (npages == 0)
366 		goto out;
367 
368 	max_depth = F2FS_I(dir)->i_current_depth;
369 	if (unlikely(max_depth > MAX_DIR_HASH_DEPTH)) {
370 		f2fs_warn(F2FS_I_SB(dir), "Corrupted max_depth of %lu: %u",
371 			  dir->i_ino, max_depth);
372 		max_depth = MAX_DIR_HASH_DEPTH;
373 		f2fs_i_depth_write(dir, max_depth);
374 	}
375 
376 	for (level = 0; level < max_depth; level++) {
377 		de = find_in_level(dir, level, fname, res_page, use_hash);
378 		if (de || IS_ERR(*res_page))
379 			break;
380 	}
381 
382 out:
383 #if IS_ENABLED(CONFIG_UNICODE)
384 	if (f2fs_should_fallback_to_linear(dir) &&
385 		IS_CASEFOLDED(dir) && !de && use_hash) {
386 		use_hash = false;
387 		goto start_find_entry;
388 	}
389 #endif
390 	/* This is to increase the speed of f2fs_create */
391 	if (!de)
392 		F2FS_I(dir)->task = current;
393 	return de;
394 }
395 
396 /*
397  * Find an entry in the specified directory with the wanted name.
398  * It returns the page where the entry was found (as a parameter - res_page),
399  * and the entry itself. Page is returned mapped and unlocked.
400  * Entry is guaranteed to be valid.
401  */
f2fs_find_entry(struct inode * dir,const struct qstr * child,struct page ** res_page)402 struct f2fs_dir_entry *f2fs_find_entry(struct inode *dir,
403 			const struct qstr *child, struct page **res_page)
404 {
405 	struct f2fs_dir_entry *de = NULL;
406 	struct f2fs_filename fname;
407 	int err;
408 
409 	err = f2fs_setup_filename(dir, child, 1, &fname);
410 	if (err) {
411 		if (err == -ENOENT)
412 			*res_page = NULL;
413 		else
414 			*res_page = ERR_PTR(err);
415 		return NULL;
416 	}
417 
418 	de = __f2fs_find_entry(dir, &fname, res_page);
419 
420 	f2fs_free_filename(&fname);
421 	return de;
422 }
423 
f2fs_parent_dir(struct inode * dir,struct page ** p)424 struct f2fs_dir_entry *f2fs_parent_dir(struct inode *dir, struct page **p)
425 {
426 	return f2fs_find_entry(dir, &dotdot_name, p);
427 }
428 
f2fs_inode_by_name(struct inode * dir,const struct qstr * qstr,struct page ** page)429 ino_t f2fs_inode_by_name(struct inode *dir, const struct qstr *qstr,
430 							struct page **page)
431 {
432 	ino_t res = 0;
433 	struct f2fs_dir_entry *de;
434 
435 	de = f2fs_find_entry(dir, qstr, page);
436 	if (de) {
437 		res = le32_to_cpu(de->ino);
438 		f2fs_put_page(*page, 0);
439 	}
440 
441 	return res;
442 }
443 
f2fs_set_link(struct inode * dir,struct f2fs_dir_entry * de,struct page * page,struct inode * inode)444 void f2fs_set_link(struct inode *dir, struct f2fs_dir_entry *de,
445 		struct page *page, struct inode *inode)
446 {
447 	enum page_type type = f2fs_has_inline_dentry(dir) ? NODE : DATA;
448 
449 	lock_page(page);
450 	f2fs_wait_on_page_writeback(page, type, true, true);
451 	de->ino = cpu_to_le32(inode->i_ino);
452 	de->file_type = fs_umode_to_ftype(inode->i_mode);
453 	set_page_dirty(page);
454 
455 	inode_set_mtime_to_ts(dir, inode_set_ctime_current(dir));
456 	f2fs_mark_inode_dirty_sync(dir, false);
457 	f2fs_put_page(page, 1);
458 }
459 
init_dent_inode(struct inode * dir,struct inode * inode,const struct f2fs_filename * fname,struct page * ipage)460 static void init_dent_inode(struct inode *dir, struct inode *inode,
461 			    const struct f2fs_filename *fname,
462 			    struct page *ipage)
463 {
464 	struct f2fs_inode *ri;
465 
466 	if (!fname) /* tmpfile case? */
467 		return;
468 
469 	f2fs_wait_on_page_writeback(ipage, NODE, true, true);
470 
471 	/* copy name info. to this inode page */
472 	ri = F2FS_INODE(ipage);
473 	ri->i_namelen = cpu_to_le32(fname->disk_name.len);
474 	memcpy(ri->i_name, fname->disk_name.name, fname->disk_name.len);
475 	if (IS_ENCRYPTED(dir)) {
476 		file_set_enc_name(inode);
477 		/*
478 		 * Roll-forward recovery doesn't have encryption keys available,
479 		 * so it can't compute the dirhash for encrypted+casefolded
480 		 * filenames.  Append it to i_name if possible.  Else, disable
481 		 * roll-forward recovery of the dentry (i.e., make fsync'ing the
482 		 * file force a checkpoint) by setting LOST_PINO.
483 		 */
484 		if (IS_CASEFOLDED(dir)) {
485 			if (fname->disk_name.len + sizeof(f2fs_hash_t) <=
486 			    F2FS_NAME_LEN)
487 				put_unaligned(fname->hash, (f2fs_hash_t *)
488 					&ri->i_name[fname->disk_name.len]);
489 			else
490 				file_lost_pino(inode);
491 		}
492 	}
493 	set_page_dirty(ipage);
494 }
495 
f2fs_do_make_empty_dir(struct inode * inode,struct inode * parent,struct f2fs_dentry_ptr * d)496 void f2fs_do_make_empty_dir(struct inode *inode, struct inode *parent,
497 					struct f2fs_dentry_ptr *d)
498 {
499 	struct fscrypt_str dot = FSTR_INIT(".", 1);
500 	struct fscrypt_str dotdot = FSTR_INIT("..", 2);
501 
502 	/* update dirent of "." */
503 	f2fs_update_dentry(inode->i_ino, inode->i_mode, d, &dot, 0, 0);
504 
505 	/* update dirent of ".." */
506 	f2fs_update_dentry(parent->i_ino, parent->i_mode, d, &dotdot, 0, 1);
507 }
508 
make_empty_dir(struct inode * inode,struct inode * parent,struct page * page)509 static int make_empty_dir(struct inode *inode,
510 		struct inode *parent, struct page *page)
511 {
512 	struct page *dentry_page;
513 	struct f2fs_dentry_block *dentry_blk;
514 	struct f2fs_dentry_ptr d;
515 
516 	if (f2fs_has_inline_dentry(inode))
517 		return f2fs_make_empty_inline_dir(inode, parent, page);
518 
519 	dentry_page = f2fs_get_new_data_page(inode, page, 0, true);
520 	if (IS_ERR(dentry_page))
521 		return PTR_ERR(dentry_page);
522 
523 	dentry_blk = page_address(dentry_page);
524 
525 	make_dentry_ptr_block(NULL, &d, dentry_blk);
526 	f2fs_do_make_empty_dir(inode, parent, &d);
527 
528 	set_page_dirty(dentry_page);
529 	f2fs_put_page(dentry_page, 1);
530 	return 0;
531 }
532 
f2fs_init_inode_metadata(struct inode * inode,struct inode * dir,const struct f2fs_filename * fname,struct page * dpage)533 struct page *f2fs_init_inode_metadata(struct inode *inode, struct inode *dir,
534 			const struct f2fs_filename *fname, struct page *dpage)
535 {
536 	struct page *page;
537 	int err;
538 
539 	if (is_inode_flag_set(inode, FI_NEW_INODE)) {
540 		page = f2fs_new_inode_page(inode);
541 		if (IS_ERR(page))
542 			return page;
543 
544 		if (S_ISDIR(inode->i_mode)) {
545 			/* in order to handle error case */
546 			get_page(page);
547 			err = make_empty_dir(inode, dir, page);
548 			if (err) {
549 				lock_page(page);
550 				goto put_error;
551 			}
552 			put_page(page);
553 		}
554 
555 		err = f2fs_init_acl(inode, dir, page, dpage);
556 		if (err)
557 			goto put_error;
558 
559 		err = f2fs_init_security(inode, dir,
560 					 fname ? fname->usr_fname : NULL, page);
561 		if (err)
562 			goto put_error;
563 
564 		if (IS_ENCRYPTED(inode)) {
565 			err = fscrypt_set_context(inode, page);
566 			if (err)
567 				goto put_error;
568 		}
569 	} else {
570 		page = f2fs_get_inode_page(F2FS_I_SB(dir), inode->i_ino);
571 		if (IS_ERR(page))
572 			return page;
573 	}
574 
575 	init_dent_inode(dir, inode, fname, page);
576 
577 	/*
578 	 * This file should be checkpointed during fsync.
579 	 * We lost i_pino from now on.
580 	 */
581 	if (is_inode_flag_set(inode, FI_INC_LINK)) {
582 		if (!S_ISDIR(inode->i_mode))
583 			file_lost_pino(inode);
584 		/*
585 		 * If link the tmpfile to alias through linkat path,
586 		 * we should remove this inode from orphan list.
587 		 */
588 		if (inode->i_nlink == 0)
589 			f2fs_remove_orphan_inode(F2FS_I_SB(dir), inode->i_ino);
590 		f2fs_i_links_write(inode, true);
591 	}
592 	return page;
593 
594 put_error:
595 	clear_nlink(inode);
596 	f2fs_update_inode(inode, page);
597 	f2fs_put_page(page, 1);
598 	return ERR_PTR(err);
599 }
600 
f2fs_update_parent_metadata(struct inode * dir,struct inode * inode,unsigned int current_depth)601 void f2fs_update_parent_metadata(struct inode *dir, struct inode *inode,
602 						unsigned int current_depth)
603 {
604 	if (inode && is_inode_flag_set(inode, FI_NEW_INODE)) {
605 		if (S_ISDIR(inode->i_mode))
606 			f2fs_i_links_write(dir, true);
607 		clear_inode_flag(inode, FI_NEW_INODE);
608 	}
609 	inode_set_mtime_to_ts(dir, inode_set_ctime_current(dir));
610 	f2fs_mark_inode_dirty_sync(dir, false);
611 
612 	if (F2FS_I(dir)->i_current_depth != current_depth)
613 		f2fs_i_depth_write(dir, current_depth);
614 
615 	if (inode && is_inode_flag_set(inode, FI_INC_LINK))
616 		clear_inode_flag(inode, FI_INC_LINK);
617 }
618 
f2fs_room_for_filename(const void * bitmap,int slots,int max_slots)619 int f2fs_room_for_filename(const void *bitmap, int slots, int max_slots)
620 {
621 	int bit_start = 0;
622 	int zero_start, zero_end;
623 next:
624 	zero_start = find_next_zero_bit_le(bitmap, max_slots, bit_start);
625 	if (zero_start >= max_slots)
626 		return max_slots;
627 
628 	zero_end = find_next_bit_le(bitmap, max_slots, zero_start);
629 	if (zero_end - zero_start >= slots)
630 		return zero_start;
631 
632 	bit_start = zero_end + 1;
633 
634 	if (zero_end + 1 >= max_slots)
635 		return max_slots;
636 	goto next;
637 }
638 
f2fs_has_enough_room(struct inode * dir,struct page * ipage,const struct f2fs_filename * fname)639 bool f2fs_has_enough_room(struct inode *dir, struct page *ipage,
640 			  const struct f2fs_filename *fname)
641 {
642 	struct f2fs_dentry_ptr d;
643 	unsigned int bit_pos;
644 	int slots = GET_DENTRY_SLOTS(fname->disk_name.len);
645 
646 	make_dentry_ptr_inline(dir, &d, inline_data_addr(dir, ipage));
647 
648 	bit_pos = f2fs_room_for_filename(d.bitmap, slots, d.max);
649 
650 	return bit_pos < d.max;
651 }
652 
f2fs_update_dentry(nid_t ino,umode_t mode,struct f2fs_dentry_ptr * d,const struct fscrypt_str * name,f2fs_hash_t name_hash,unsigned int bit_pos)653 void f2fs_update_dentry(nid_t ino, umode_t mode, struct f2fs_dentry_ptr *d,
654 			const struct fscrypt_str *name, f2fs_hash_t name_hash,
655 			unsigned int bit_pos)
656 {
657 	struct f2fs_dir_entry *de;
658 	int slots = GET_DENTRY_SLOTS(name->len);
659 	int i;
660 
661 	de = &d->dentry[bit_pos];
662 	de->hash_code = name_hash;
663 	de->name_len = cpu_to_le16(name->len);
664 	memcpy(d->filename[bit_pos], name->name, name->len);
665 	de->ino = cpu_to_le32(ino);
666 	de->file_type = fs_umode_to_ftype(mode);
667 	for (i = 0; i < slots; i++) {
668 		__set_bit_le(bit_pos + i, (void *)d->bitmap);
669 		/* avoid wrong garbage data for readdir */
670 		if (i)
671 			(de + i)->name_len = 0;
672 	}
673 }
674 
f2fs_add_regular_entry(struct inode * dir,const struct f2fs_filename * fname,struct inode * inode,nid_t ino,umode_t mode)675 int f2fs_add_regular_entry(struct inode *dir, const struct f2fs_filename *fname,
676 			   struct inode *inode, nid_t ino, umode_t mode)
677 {
678 	unsigned int bit_pos;
679 	unsigned int level;
680 	unsigned int current_depth;
681 	unsigned long bidx, block;
682 	unsigned int nbucket, nblock;
683 	struct page *dentry_page = NULL;
684 	struct f2fs_dentry_block *dentry_blk = NULL;
685 	struct f2fs_dentry_ptr d;
686 	struct page *page = NULL;
687 	int slots, err = 0;
688 
689 	level = 0;
690 	slots = GET_DENTRY_SLOTS(fname->disk_name.len);
691 
692 	current_depth = F2FS_I(dir)->i_current_depth;
693 	if (F2FS_I(dir)->chash == fname->hash) {
694 		level = F2FS_I(dir)->clevel;
695 		F2FS_I(dir)->chash = 0;
696 	}
697 
698 start:
699 	if (time_to_inject(F2FS_I_SB(dir), FAULT_DIR_DEPTH))
700 		return -ENOSPC;
701 
702 	if (unlikely(current_depth == MAX_DIR_HASH_DEPTH))
703 		return -ENOSPC;
704 
705 	/* Increase the depth, if required */
706 	if (level == current_depth)
707 		++current_depth;
708 
709 	nbucket = dir_buckets(level, F2FS_I(dir)->i_dir_level);
710 	nblock = bucket_blocks(level);
711 
712 	bidx = dir_block_index(level, F2FS_I(dir)->i_dir_level,
713 				(le32_to_cpu(fname->hash) % nbucket));
714 
715 	for (block = bidx; block <= (bidx + nblock - 1); block++) {
716 		dentry_page = f2fs_get_new_data_page(dir, NULL, block, true);
717 		if (IS_ERR(dentry_page))
718 			return PTR_ERR(dentry_page);
719 
720 		dentry_blk = page_address(dentry_page);
721 		bit_pos = f2fs_room_for_filename(&dentry_blk->dentry_bitmap,
722 						slots, NR_DENTRY_IN_BLOCK);
723 		if (bit_pos < NR_DENTRY_IN_BLOCK)
724 			goto add_dentry;
725 
726 		f2fs_put_page(dentry_page, 1);
727 	}
728 
729 	/* Move to next level to find the empty slot for new dentry */
730 	++level;
731 	goto start;
732 add_dentry:
733 	f2fs_wait_on_page_writeback(dentry_page, DATA, true, true);
734 
735 	if (inode) {
736 		f2fs_down_write(&F2FS_I(inode)->i_sem);
737 		page = f2fs_init_inode_metadata(inode, dir, fname, NULL);
738 		if (IS_ERR(page)) {
739 			err = PTR_ERR(page);
740 			goto fail;
741 		}
742 	}
743 
744 	make_dentry_ptr_block(NULL, &d, dentry_blk);
745 	f2fs_update_dentry(ino, mode, &d, &fname->disk_name, fname->hash,
746 			   bit_pos);
747 
748 	set_page_dirty(dentry_page);
749 
750 	if (inode) {
751 		f2fs_i_pino_write(inode, dir->i_ino);
752 
753 		/* synchronize inode page's data from inode cache */
754 		if (is_inode_flag_set(inode, FI_NEW_INODE))
755 			f2fs_update_inode(inode, page);
756 
757 		f2fs_put_page(page, 1);
758 	}
759 
760 	f2fs_update_parent_metadata(dir, inode, current_depth);
761 fail:
762 	if (inode)
763 		f2fs_up_write(&F2FS_I(inode)->i_sem);
764 
765 	f2fs_put_page(dentry_page, 1);
766 
767 	return err;
768 }
769 
f2fs_add_dentry(struct inode * dir,const struct f2fs_filename * fname,struct inode * inode,nid_t ino,umode_t mode)770 int f2fs_add_dentry(struct inode *dir, const struct f2fs_filename *fname,
771 		    struct inode *inode, nid_t ino, umode_t mode)
772 {
773 	int err = -EAGAIN;
774 
775 	if (f2fs_has_inline_dentry(dir)) {
776 		/*
777 		 * Should get i_xattr_sem to keep the lock order:
778 		 * i_xattr_sem -> inode_page lock used by f2fs_setxattr.
779 		 */
780 		f2fs_down_read(&F2FS_I(dir)->i_xattr_sem);
781 		err = f2fs_add_inline_entry(dir, fname, inode, ino, mode);
782 		f2fs_up_read(&F2FS_I(dir)->i_xattr_sem);
783 	}
784 	if (err == -EAGAIN)
785 		err = f2fs_add_regular_entry(dir, fname, inode, ino, mode);
786 
787 	f2fs_update_time(F2FS_I_SB(dir), REQ_TIME);
788 	return err;
789 }
790 
791 /*
792  * Caller should grab and release a rwsem by calling f2fs_lock_op() and
793  * f2fs_unlock_op().
794  */
f2fs_do_add_link(struct inode * dir,const struct qstr * name,struct inode * inode,nid_t ino,umode_t mode)795 int f2fs_do_add_link(struct inode *dir, const struct qstr *name,
796 				struct inode *inode, nid_t ino, umode_t mode)
797 {
798 	struct f2fs_filename fname;
799 	struct page *page = NULL;
800 	struct f2fs_dir_entry *de = NULL;
801 	int err;
802 
803 	err = f2fs_setup_filename(dir, name, 0, &fname);
804 	if (err)
805 		return err;
806 
807 	/*
808 	 * An immature stackable filesystem shows a race condition between lookup
809 	 * and create. If we have same task when doing lookup and create, it's
810 	 * definitely fine as expected by VFS normally. Otherwise, let's just
811 	 * verify on-disk dentry one more time, which guarantees filesystem
812 	 * consistency more.
813 	 */
814 	if (current != F2FS_I(dir)->task) {
815 		de = __f2fs_find_entry(dir, &fname, &page);
816 		F2FS_I(dir)->task = NULL;
817 	}
818 	if (de) {
819 		f2fs_put_page(page, 0);
820 		err = -EEXIST;
821 	} else if (IS_ERR(page)) {
822 		err = PTR_ERR(page);
823 	} else {
824 		err = f2fs_add_dentry(dir, &fname, inode, ino, mode);
825 	}
826 	f2fs_free_filename(&fname);
827 	return err;
828 }
829 
f2fs_do_tmpfile(struct inode * inode,struct inode * dir,struct f2fs_filename * fname)830 int f2fs_do_tmpfile(struct inode *inode, struct inode *dir,
831 					struct f2fs_filename *fname)
832 {
833 	struct page *page;
834 	int err = 0;
835 
836 	f2fs_down_write(&F2FS_I(inode)->i_sem);
837 	page = f2fs_init_inode_metadata(inode, dir, fname, NULL);
838 	if (IS_ERR(page)) {
839 		err = PTR_ERR(page);
840 		goto fail;
841 	}
842 	f2fs_put_page(page, 1);
843 
844 	clear_inode_flag(inode, FI_NEW_INODE);
845 	f2fs_update_time(F2FS_I_SB(inode), REQ_TIME);
846 fail:
847 	f2fs_up_write(&F2FS_I(inode)->i_sem);
848 	return err;
849 }
850 
f2fs_drop_nlink(struct inode * dir,struct inode * inode)851 void f2fs_drop_nlink(struct inode *dir, struct inode *inode)
852 {
853 	struct f2fs_sb_info *sbi = F2FS_I_SB(dir);
854 
855 	f2fs_down_write(&F2FS_I(inode)->i_sem);
856 
857 	if (S_ISDIR(inode->i_mode))
858 		f2fs_i_links_write(dir, false);
859 	inode_set_ctime_current(inode);
860 
861 	f2fs_i_links_write(inode, false);
862 	if (S_ISDIR(inode->i_mode)) {
863 		f2fs_i_links_write(inode, false);
864 		f2fs_i_size_write(inode, 0);
865 	}
866 	f2fs_up_write(&F2FS_I(inode)->i_sem);
867 
868 	if (inode->i_nlink == 0)
869 		f2fs_add_orphan_inode(inode);
870 	else
871 		f2fs_release_orphan_inode(sbi);
872 }
873 
874 /*
875  * It only removes the dentry from the dentry page, corresponding name
876  * entry in name page does not need to be touched during deletion.
877  */
f2fs_delete_entry(struct f2fs_dir_entry * dentry,struct page * page,struct inode * dir,struct inode * inode)878 void f2fs_delete_entry(struct f2fs_dir_entry *dentry, struct page *page,
879 					struct inode *dir, struct inode *inode)
880 {
881 	struct	f2fs_dentry_block *dentry_blk;
882 	unsigned int bit_pos;
883 	int slots = GET_DENTRY_SLOTS(le16_to_cpu(dentry->name_len));
884 	pgoff_t index = page_folio(page)->index;
885 	int i;
886 
887 	f2fs_update_time(F2FS_I_SB(dir), REQ_TIME);
888 
889 	if (F2FS_OPTION(F2FS_I_SB(dir)).fsync_mode == FSYNC_MODE_STRICT)
890 		f2fs_add_ino_entry(F2FS_I_SB(dir), dir->i_ino, TRANS_DIR_INO);
891 
892 	if (f2fs_has_inline_dentry(dir))
893 		return f2fs_delete_inline_entry(dentry, page, dir, inode);
894 
895 	lock_page(page);
896 	f2fs_wait_on_page_writeback(page, DATA, true, true);
897 
898 	dentry_blk = page_address(page);
899 	bit_pos = dentry - dentry_blk->dentry;
900 	for (i = 0; i < slots; i++)
901 		__clear_bit_le(bit_pos + i, &dentry_blk->dentry_bitmap);
902 
903 	/* Let's check and deallocate this dentry page */
904 	bit_pos = find_next_bit_le(&dentry_blk->dentry_bitmap,
905 			NR_DENTRY_IN_BLOCK,
906 			0);
907 	set_page_dirty(page);
908 
909 	if (bit_pos == NR_DENTRY_IN_BLOCK &&
910 		!f2fs_truncate_hole(dir, index, index + 1)) {
911 		f2fs_clear_page_cache_dirty_tag(page_folio(page));
912 		clear_page_dirty_for_io(page);
913 		ClearPageUptodate(page);
914 		clear_page_private_all(page);
915 
916 		inode_dec_dirty_pages(dir);
917 		f2fs_remove_dirty_inode(dir);
918 	}
919 	f2fs_put_page(page, 1);
920 
921 	inode_set_mtime_to_ts(dir, inode_set_ctime_current(dir));
922 	f2fs_mark_inode_dirty_sync(dir, false);
923 
924 	if (inode)
925 		f2fs_drop_nlink(dir, inode);
926 }
927 
f2fs_empty_dir(struct inode * dir)928 bool f2fs_empty_dir(struct inode *dir)
929 {
930 	unsigned long bidx = 0;
931 	struct page *dentry_page;
932 	unsigned int bit_pos;
933 	struct f2fs_dentry_block *dentry_blk;
934 	unsigned long nblock = dir_blocks(dir);
935 
936 	if (f2fs_has_inline_dentry(dir))
937 		return f2fs_empty_inline_dir(dir);
938 
939 	while (bidx < nblock) {
940 		pgoff_t next_pgofs;
941 
942 		dentry_page = f2fs_find_data_page(dir, bidx, &next_pgofs);
943 		if (IS_ERR(dentry_page)) {
944 			if (PTR_ERR(dentry_page) == -ENOENT) {
945 				bidx = next_pgofs;
946 				continue;
947 			} else {
948 				return false;
949 			}
950 		}
951 
952 		dentry_blk = page_address(dentry_page);
953 		if (bidx == 0)
954 			bit_pos = 2;
955 		else
956 			bit_pos = 0;
957 		bit_pos = find_next_bit_le(&dentry_blk->dentry_bitmap,
958 						NR_DENTRY_IN_BLOCK,
959 						bit_pos);
960 
961 		f2fs_put_page(dentry_page, 0);
962 
963 		if (bit_pos < NR_DENTRY_IN_BLOCK)
964 			return false;
965 
966 		bidx++;
967 	}
968 	return true;
969 }
970 
f2fs_fill_dentries(struct dir_context * ctx,struct f2fs_dentry_ptr * d,unsigned int start_pos,struct fscrypt_str * fstr)971 int f2fs_fill_dentries(struct dir_context *ctx, struct f2fs_dentry_ptr *d,
972 			unsigned int start_pos, struct fscrypt_str *fstr)
973 {
974 	unsigned char d_type = DT_UNKNOWN;
975 	unsigned int bit_pos;
976 	struct f2fs_dir_entry *de = NULL;
977 	struct fscrypt_str de_name = FSTR_INIT(NULL, 0);
978 	struct f2fs_sb_info *sbi = F2FS_I_SB(d->inode);
979 	struct blk_plug plug;
980 	bool readdir_ra = sbi->readdir_ra;
981 	bool found_valid_dirent = false;
982 	int err = 0;
983 
984 	bit_pos = ((unsigned long)ctx->pos % d->max);
985 
986 	if (readdir_ra)
987 		blk_start_plug(&plug);
988 
989 	while (bit_pos < d->max) {
990 		bit_pos = find_next_bit_le(d->bitmap, d->max, bit_pos);
991 		if (bit_pos >= d->max)
992 			break;
993 
994 		de = &d->dentry[bit_pos];
995 		if (de->name_len == 0) {
996 			if (found_valid_dirent || !bit_pos) {
997 				f2fs_warn_ratelimited(sbi,
998 					"invalid namelen(0), ino:%u, run fsck to fix.",
999 					le32_to_cpu(de->ino));
1000 				set_sbi_flag(sbi, SBI_NEED_FSCK);
1001 			}
1002 			bit_pos++;
1003 			ctx->pos = start_pos + bit_pos;
1004 			continue;
1005 		}
1006 
1007 		d_type = fs_ftype_to_dtype(de->file_type);
1008 
1009 		de_name.name = d->filename[bit_pos];
1010 		de_name.len = le16_to_cpu(de->name_len);
1011 
1012 		/* check memory boundary before moving forward */
1013 		bit_pos += GET_DENTRY_SLOTS(le16_to_cpu(de->name_len));
1014 		if (unlikely(bit_pos > d->max ||
1015 				le16_to_cpu(de->name_len) > F2FS_NAME_LEN)) {
1016 			f2fs_warn(sbi, "%s: corrupted namelen=%d, run fsck to fix.",
1017 				  __func__, le16_to_cpu(de->name_len));
1018 			set_sbi_flag(sbi, SBI_NEED_FSCK);
1019 			err = -EFSCORRUPTED;
1020 			f2fs_handle_error(sbi, ERROR_CORRUPTED_DIRENT);
1021 			goto out;
1022 		}
1023 
1024 		if (IS_ENCRYPTED(d->inode)) {
1025 			int save_len = fstr->len;
1026 
1027 			err = fscrypt_fname_disk_to_usr(d->inode,
1028 						(u32)le32_to_cpu(de->hash_code),
1029 						0, &de_name, fstr);
1030 			if (err)
1031 				goto out;
1032 
1033 			de_name = *fstr;
1034 			fstr->len = save_len;
1035 		}
1036 
1037 		if (!dir_emit(ctx, de_name.name, de_name.len,
1038 					le32_to_cpu(de->ino), d_type)) {
1039 			err = 1;
1040 			goto out;
1041 		}
1042 
1043 		if (readdir_ra)
1044 			f2fs_ra_node_page(sbi, le32_to_cpu(de->ino));
1045 
1046 		ctx->pos = start_pos + bit_pos;
1047 		found_valid_dirent = true;
1048 	}
1049 out:
1050 	if (readdir_ra)
1051 		blk_finish_plug(&plug);
1052 	return err;
1053 }
1054 
f2fs_readdir(struct file * file,struct dir_context * ctx)1055 static int f2fs_readdir(struct file *file, struct dir_context *ctx)
1056 {
1057 	struct inode *inode = file_inode(file);
1058 	unsigned long npages = dir_blocks(inode);
1059 	struct f2fs_dentry_block *dentry_blk = NULL;
1060 	struct page *dentry_page = NULL;
1061 	struct file_ra_state *ra = &file->f_ra;
1062 	loff_t start_pos = ctx->pos;
1063 	unsigned int n = ((unsigned long)ctx->pos / NR_DENTRY_IN_BLOCK);
1064 	struct f2fs_dentry_ptr d;
1065 	struct fscrypt_str fstr = FSTR_INIT(NULL, 0);
1066 	int err = 0;
1067 
1068 	if (IS_ENCRYPTED(inode)) {
1069 		err = fscrypt_prepare_readdir(inode);
1070 		if (err)
1071 			goto out;
1072 
1073 		err = fscrypt_fname_alloc_buffer(F2FS_NAME_LEN, &fstr);
1074 		if (err < 0)
1075 			goto out;
1076 	}
1077 
1078 	if (f2fs_has_inline_dentry(inode)) {
1079 		err = f2fs_read_inline_dir(file, ctx, &fstr);
1080 		goto out_free;
1081 	}
1082 
1083 	for (; n < npages; ctx->pos = n * NR_DENTRY_IN_BLOCK) {
1084 		pgoff_t next_pgofs;
1085 
1086 		/* allow readdir() to be interrupted */
1087 		if (fatal_signal_pending(current)) {
1088 			err = -ERESTARTSYS;
1089 			goto out_free;
1090 		}
1091 		cond_resched();
1092 
1093 		/* readahead for multi pages of dir */
1094 		if (npages - n > 1 && !ra_has_index(ra, n))
1095 			page_cache_sync_readahead(inode->i_mapping, ra, file, n,
1096 				min(npages - n, (pgoff_t)MAX_DIR_RA_PAGES));
1097 
1098 		dentry_page = f2fs_find_data_page(inode, n, &next_pgofs);
1099 		if (IS_ERR(dentry_page)) {
1100 			err = PTR_ERR(dentry_page);
1101 			if (err == -ENOENT) {
1102 				err = 0;
1103 				n = next_pgofs;
1104 				continue;
1105 			} else {
1106 				goto out_free;
1107 			}
1108 		}
1109 
1110 		dentry_blk = page_address(dentry_page);
1111 
1112 		make_dentry_ptr_block(inode, &d, dentry_blk);
1113 
1114 		err = f2fs_fill_dentries(ctx, &d,
1115 				n * NR_DENTRY_IN_BLOCK, &fstr);
1116 		if (err) {
1117 			f2fs_put_page(dentry_page, 0);
1118 			break;
1119 		}
1120 
1121 		f2fs_put_page(dentry_page, 0);
1122 
1123 		n++;
1124 	}
1125 out_free:
1126 	fscrypt_fname_free_buffer(&fstr);
1127 out:
1128 	trace_f2fs_readdir(inode, start_pos, ctx->pos, err);
1129 	return err < 0 ? err : 0;
1130 }
1131 
1132 const struct file_operations f2fs_dir_operations = {
1133 	.llseek		= generic_file_llseek,
1134 	.read		= generic_read_dir,
1135 	.iterate_shared	= f2fs_readdir,
1136 	.fsync		= f2fs_sync_file,
1137 	.unlocked_ioctl	= f2fs_ioctl,
1138 #ifdef CONFIG_COMPAT
1139 	.compat_ioctl   = f2fs_compat_ioctl,
1140 #endif
1141 };
1142