1 // SPDX-License-Identifier: GPL-2.0+
3 * NILFS directory entry operations
5 * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
7 * Modified for NILFS by Amagai Yoshiji.
12 * Copyright (C) 1992, 1993, 1994, 1995
14 * Laboratoire MASI - Institut Blaise Pascal
15 * Universite Pierre et Marie Curie (Paris VI)
19 * linux/fs/minix/dir.c
21 * Copyright (C) 1991, 1992 Linus Torvalds
23 * ext2 directory handling functions
25 * Big-endian to little-endian byte-swapping/bitmaps by
28 * All code that works with directory layout had been switched to pagecache
32 #include <linux/pagemap.h>
36 static inline unsigned int nilfs_rec_len_from_disk(__le16 dlen)
38 unsigned int len = le16_to_cpu(dlen);
40 #if (PAGE_SIZE >= 65536)
41 if (len == NILFS_MAX_REC_LEN)
47 static inline __le16 nilfs_rec_len_to_disk(unsigned int len)
49 #if (PAGE_SIZE >= 65536)
51 return cpu_to_le16(NILFS_MAX_REC_LEN);
53 BUG_ON(len > (1 << 16));
55 return cpu_to_le16(len);
59 * nilfs uses block-sized chunks. Arguably, sector-sized ones would be
60 * more robust, but we have what we have
62 static inline unsigned int nilfs_chunk_size(struct inode *inode)
64 return inode->i_sb->s_blocksize;
68 * Return the offset into page `page_nr' of the last valid
69 * byte in that page, plus one.
71 static unsigned int nilfs_last_byte(struct inode *inode, unsigned long page_nr)
73 unsigned int last_byte = inode->i_size;
75 last_byte -= page_nr << PAGE_SHIFT;
76 if (last_byte > PAGE_SIZE)
77 last_byte = PAGE_SIZE;
81 static int nilfs_prepare_chunk(struct folio *folio, unsigned int from,
84 loff_t pos = folio_pos(folio) + from;
86 return __block_write_begin(&folio->page, pos, to - from, nilfs_get_block);
89 static void nilfs_commit_chunk(struct folio *folio,
90 struct address_space *mapping, size_t from, size_t to)
92 struct inode *dir = mapping->host;
93 loff_t pos = folio_pos(folio) + from;
94 size_t copied, len = to - from;
95 unsigned int nr_dirty;
98 nr_dirty = nilfs_page_count_clean_buffers(&folio->page, from, to);
99 copied = block_write_end(NULL, mapping, pos, len, len, &folio->page, NULL);
100 if (pos + copied > dir->i_size)
101 i_size_write(dir, pos + copied);
103 nilfs_set_transaction_flag(NILFS_TI_SYNC);
104 err = nilfs_set_file_dirty(dir, nr_dirty);
105 WARN_ON(err); /* do not happen */
109 static bool nilfs_check_folio(struct folio *folio, char *kaddr)
111 struct inode *dir = folio->mapping->host;
112 struct super_block *sb = dir->i_sb;
113 unsigned int chunk_size = nilfs_chunk_size(dir);
114 size_t offs, rec_len;
115 size_t limit = folio_size(folio);
116 struct nilfs_dir_entry *p;
119 if (dir->i_size < folio_pos(folio) + limit) {
120 limit = dir->i_size - folio_pos(folio);
121 if (limit & (chunk_size - 1))
126 for (offs = 0; offs <= limit - NILFS_DIR_REC_LEN(1); offs += rec_len) {
127 p = (struct nilfs_dir_entry *)(kaddr + offs);
128 rec_len = nilfs_rec_len_from_disk(p->rec_len);
130 if (rec_len < NILFS_DIR_REC_LEN(1))
134 if (rec_len < NILFS_DIR_REC_LEN(p->name_len))
136 if (((offs + rec_len - 1) ^ offs) & ~(chunk_size-1))
142 folio_set_checked(folio);
145 /* Too bad, we had an error */
149 "size of directory #%lu is not a multiple of chunk size",
153 error = "rec_len is smaller than minimal";
156 error = "unaligned directory entry";
159 error = "rec_len is too small for name_len";
162 error = "directory entry across blocks";
165 "bad entry in directory #%lu: %s - offset=%lu, inode=%lu, rec_len=%zd, name_len=%d",
166 dir->i_ino, error, (folio->index << PAGE_SHIFT) + offs,
167 (unsigned long)le64_to_cpu(p->inode),
168 rec_len, p->name_len);
171 p = (struct nilfs_dir_entry *)(kaddr + offs);
173 "entry in directory #%lu spans the page boundary offset=%lu, inode=%lu",
174 dir->i_ino, (folio->index << PAGE_SHIFT) + offs,
175 (unsigned long)le64_to_cpu(p->inode));
177 folio_set_error(folio);
181 static void *nilfs_get_folio(struct inode *dir, unsigned long n,
182 struct folio **foliop)
184 struct address_space *mapping = dir->i_mapping;
185 struct folio *folio = read_mapping_folio(mapping, n, NULL);
191 kaddr = kmap_local_folio(folio, 0);
192 if (unlikely(!folio_test_checked(folio))) {
193 if (!nilfs_check_folio(folio, kaddr))
201 folio_release_kmap(folio, kaddr);
202 return ERR_PTR(-EIO);
206 * NOTE! unlike strncmp, nilfs_match returns 1 for success, 0 for failure.
208 * len <= NILFS_NAME_LEN and de != NULL are guaranteed by caller.
211 nilfs_match(int len, const unsigned char *name, struct nilfs_dir_entry *de)
213 if (len != de->name_len)
217 return !memcmp(name, de->name, len);
221 * p is at least 6 bytes before the end of page
223 static struct nilfs_dir_entry *nilfs_next_entry(struct nilfs_dir_entry *p)
225 return (struct nilfs_dir_entry *)((char *)p +
226 nilfs_rec_len_from_disk(p->rec_len));
230 nilfs_filetype_table[NILFS_FT_MAX] = {
231 [NILFS_FT_UNKNOWN] = DT_UNKNOWN,
232 [NILFS_FT_REG_FILE] = DT_REG,
233 [NILFS_FT_DIR] = DT_DIR,
234 [NILFS_FT_CHRDEV] = DT_CHR,
235 [NILFS_FT_BLKDEV] = DT_BLK,
236 [NILFS_FT_FIFO] = DT_FIFO,
237 [NILFS_FT_SOCK] = DT_SOCK,
238 [NILFS_FT_SYMLINK] = DT_LNK,
243 nilfs_type_by_mode[S_IFMT >> S_SHIFT] = {
244 [S_IFREG >> S_SHIFT] = NILFS_FT_REG_FILE,
245 [S_IFDIR >> S_SHIFT] = NILFS_FT_DIR,
246 [S_IFCHR >> S_SHIFT] = NILFS_FT_CHRDEV,
247 [S_IFBLK >> S_SHIFT] = NILFS_FT_BLKDEV,
248 [S_IFIFO >> S_SHIFT] = NILFS_FT_FIFO,
249 [S_IFSOCK >> S_SHIFT] = NILFS_FT_SOCK,
250 [S_IFLNK >> S_SHIFT] = NILFS_FT_SYMLINK,
253 static void nilfs_set_de_type(struct nilfs_dir_entry *de, struct inode *inode)
255 umode_t mode = inode->i_mode;
257 de->file_type = nilfs_type_by_mode[(mode & S_IFMT)>>S_SHIFT];
260 static int nilfs_readdir(struct file *file, struct dir_context *ctx)
262 loff_t pos = ctx->pos;
263 struct inode *inode = file_inode(file);
264 struct super_block *sb = inode->i_sb;
265 unsigned int offset = pos & ~PAGE_MASK;
266 unsigned long n = pos >> PAGE_SHIFT;
267 unsigned long npages = dir_pages(inode);
269 if (pos > inode->i_size - NILFS_DIR_REC_LEN(1))
272 for ( ; n < npages; n++, offset = 0) {
274 struct nilfs_dir_entry *de;
277 kaddr = nilfs_get_folio(inode, n, &folio);
279 nilfs_error(sb, "bad page in #%lu", inode->i_ino);
280 ctx->pos += PAGE_SIZE - offset;
283 de = (struct nilfs_dir_entry *)(kaddr + offset);
284 limit = kaddr + nilfs_last_byte(inode, n) -
285 NILFS_DIR_REC_LEN(1);
286 for ( ; (char *)de <= limit; de = nilfs_next_entry(de)) {
287 if (de->rec_len == 0) {
288 nilfs_error(sb, "zero-length directory entry");
289 folio_release_kmap(folio, kaddr);
295 if (de->file_type < NILFS_FT_MAX)
296 t = nilfs_filetype_table[de->file_type];
300 if (!dir_emit(ctx, de->name, de->name_len,
301 le64_to_cpu(de->inode), t)) {
302 folio_release_kmap(folio, kaddr);
306 ctx->pos += nilfs_rec_len_from_disk(de->rec_len);
308 folio_release_kmap(folio, kaddr);
316 * Finds an entry in the specified directory with the wanted name. It
317 * returns the folio in which the entry was found, and the entry itself.
318 * The folio is mapped and unlocked. When the caller is finished with
319 * the entry, it should call folio_release_kmap().
321 * On failure, returns NULL and the caller should ignore foliop.
323 struct nilfs_dir_entry *nilfs_find_entry(struct inode *dir,
324 const struct qstr *qstr, struct folio **foliop)
326 const unsigned char *name = qstr->name;
327 int namelen = qstr->len;
328 unsigned int reclen = NILFS_DIR_REC_LEN(namelen);
329 unsigned long start, n;
330 unsigned long npages = dir_pages(dir);
331 struct nilfs_inode_info *ei = NILFS_I(dir);
332 struct nilfs_dir_entry *de;
337 start = ei->i_dir_start_lookup;
342 char *kaddr = nilfs_get_folio(dir, n, foliop);
344 if (!IS_ERR(kaddr)) {
345 de = (struct nilfs_dir_entry *)kaddr;
346 kaddr += nilfs_last_byte(dir, n) - reclen;
347 while ((char *) de <= kaddr) {
348 if (de->rec_len == 0) {
349 nilfs_error(dir->i_sb,
350 "zero-length directory entry");
351 folio_release_kmap(*foliop, kaddr);
354 if (nilfs_match(namelen, name, de))
356 de = nilfs_next_entry(de);
358 folio_release_kmap(*foliop, kaddr);
362 /* next folio is past the blocks we've got */
363 if (unlikely(n > (dir->i_blocks >> (PAGE_SHIFT - 9)))) {
364 nilfs_error(dir->i_sb,
365 "dir %lu size %lld exceeds block count %llu",
366 dir->i_ino, dir->i_size,
367 (unsigned long long)dir->i_blocks);
370 } while (n != start);
375 ei->i_dir_start_lookup = n;
379 struct nilfs_dir_entry *nilfs_dotdot(struct inode *dir, struct folio **foliop)
381 struct nilfs_dir_entry *de = nilfs_get_folio(dir, 0, foliop);
385 return nilfs_next_entry(de);
388 ino_t nilfs_inode_by_name(struct inode *dir, const struct qstr *qstr)
391 struct nilfs_dir_entry *de;
394 de = nilfs_find_entry(dir, qstr, &folio);
396 res = le64_to_cpu(de->inode);
397 folio_release_kmap(folio, de);
402 void nilfs_set_link(struct inode *dir, struct nilfs_dir_entry *de,
403 struct folio *folio, struct inode *inode)
405 size_t from = offset_in_folio(folio, de);
406 size_t to = from + nilfs_rec_len_from_disk(de->rec_len);
407 struct address_space *mapping = folio->mapping;
411 err = nilfs_prepare_chunk(folio, from, to);
413 de->inode = cpu_to_le64(inode->i_ino);
414 nilfs_set_de_type(de, inode);
415 nilfs_commit_chunk(folio, mapping, from, to);
416 inode_set_mtime_to_ts(dir, inode_set_ctime_current(dir));
422 int nilfs_add_link(struct dentry *dentry, struct inode *inode)
424 struct inode *dir = d_inode(dentry->d_parent);
425 const unsigned char *name = dentry->d_name.name;
426 int namelen = dentry->d_name.len;
427 unsigned int chunk_size = nilfs_chunk_size(dir);
428 unsigned int reclen = NILFS_DIR_REC_LEN(namelen);
429 unsigned short rec_len, name_len;
430 struct folio *folio = NULL;
431 struct nilfs_dir_entry *de;
432 unsigned long npages = dir_pages(dir);
438 * We take care of directory expansion in the same loop.
439 * This code plays outside i_size, so it locks the folio
440 * to protect that region.
442 for (n = 0; n <= npages; n++) {
443 char *kaddr = nilfs_get_folio(dir, n, &folio);
447 return PTR_ERR(kaddr);
449 dir_end = kaddr + nilfs_last_byte(dir, n);
450 de = (struct nilfs_dir_entry *)kaddr;
451 kaddr += folio_size(folio) - reclen;
452 while ((char *)de <= kaddr) {
453 if ((char *)de == dir_end) {
456 rec_len = chunk_size;
457 de->rec_len = nilfs_rec_len_to_disk(chunk_size);
461 if (de->rec_len == 0) {
462 nilfs_error(dir->i_sb,
463 "zero-length directory entry");
468 if (nilfs_match(namelen, name, de))
470 name_len = NILFS_DIR_REC_LEN(de->name_len);
471 rec_len = nilfs_rec_len_from_disk(de->rec_len);
472 if (!de->inode && rec_len >= reclen)
474 if (rec_len >= name_len + reclen)
476 de = (struct nilfs_dir_entry *)((char *)de + rec_len);
479 folio_release_kmap(folio, kaddr);
485 from = offset_in_folio(folio, de);
487 err = nilfs_prepare_chunk(folio, from, to);
491 struct nilfs_dir_entry *de1;
493 de1 = (struct nilfs_dir_entry *)((char *)de + name_len);
494 de1->rec_len = nilfs_rec_len_to_disk(rec_len - name_len);
495 de->rec_len = nilfs_rec_len_to_disk(name_len);
498 de->name_len = namelen;
499 memcpy(de->name, name, namelen);
500 de->inode = cpu_to_le64(inode->i_ino);
501 nilfs_set_de_type(de, inode);
502 nilfs_commit_chunk(folio, folio->mapping, from, to);
503 inode_set_mtime_to_ts(dir, inode_set_ctime_current(dir));
504 nilfs_mark_inode_dirty(dir);
507 folio_release_kmap(folio, de);
515 * nilfs_delete_entry deletes a directory entry by merging it with the
516 * previous entry. Folio is up-to-date.
518 int nilfs_delete_entry(struct nilfs_dir_entry *dir, struct folio *folio)
520 struct address_space *mapping = folio->mapping;
521 struct inode *inode = mapping->host;
522 char *kaddr = (char *)((unsigned long)dir & ~(folio_size(folio) - 1));
524 struct nilfs_dir_entry *de, *pde = NULL;
527 from = ((char *)dir - kaddr) & ~(nilfs_chunk_size(inode) - 1);
528 to = ((char *)dir - kaddr) + nilfs_rec_len_from_disk(dir->rec_len);
529 de = (struct nilfs_dir_entry *)(kaddr + from);
531 while ((char *)de < (char *)dir) {
532 if (de->rec_len == 0) {
533 nilfs_error(inode->i_sb,
534 "zero-length directory entry");
539 de = nilfs_next_entry(de);
542 from = (char *)pde - kaddr;
544 err = nilfs_prepare_chunk(folio, from, to);
547 pde->rec_len = nilfs_rec_len_to_disk(to - from);
549 nilfs_commit_chunk(folio, mapping, from, to);
550 inode_set_mtime_to_ts(inode, inode_set_ctime_current(inode));
556 * Set the first fragment of directory.
558 int nilfs_make_empty(struct inode *inode, struct inode *parent)
560 struct address_space *mapping = inode->i_mapping;
561 struct folio *folio = filemap_grab_folio(mapping, 0);
562 unsigned int chunk_size = nilfs_chunk_size(inode);
563 struct nilfs_dir_entry *de;
568 return PTR_ERR(folio);
570 err = nilfs_prepare_chunk(folio, 0, chunk_size);
575 kaddr = kmap_local_folio(folio, 0);
576 memset(kaddr, 0, chunk_size);
577 de = (struct nilfs_dir_entry *)kaddr;
579 de->rec_len = nilfs_rec_len_to_disk(NILFS_DIR_REC_LEN(1));
580 memcpy(de->name, ".\0\0", 4);
581 de->inode = cpu_to_le64(inode->i_ino);
582 nilfs_set_de_type(de, inode);
584 de = (struct nilfs_dir_entry *)(kaddr + NILFS_DIR_REC_LEN(1));
586 de->rec_len = nilfs_rec_len_to_disk(chunk_size - NILFS_DIR_REC_LEN(1));
587 de->inode = cpu_to_le64(parent->i_ino);
588 memcpy(de->name, "..\0", 4);
589 nilfs_set_de_type(de, inode);
591 nilfs_commit_chunk(folio, mapping, 0, chunk_size);
598 * routine to check that the specified directory is empty (for rmdir)
600 int nilfs_empty_dir(struct inode *inode)
602 struct folio *folio = NULL;
604 unsigned long i, npages = dir_pages(inode);
606 for (i = 0; i < npages; i++) {
607 struct nilfs_dir_entry *de;
609 kaddr = nilfs_get_folio(inode, i, &folio);
613 de = (struct nilfs_dir_entry *)kaddr;
614 kaddr += nilfs_last_byte(inode, i) - NILFS_DIR_REC_LEN(1);
616 while ((char *)de <= kaddr) {
617 if (de->rec_len == 0) {
618 nilfs_error(inode->i_sb,
619 "zero-length directory entry (kaddr=%p, de=%p)",
623 if (de->inode != 0) {
624 /* check for . and .. */
625 if (de->name[0] != '.')
627 if (de->name_len > 2)
629 if (de->name_len < 2) {
631 cpu_to_le64(inode->i_ino))
633 } else if (de->name[1] != '.')
636 de = nilfs_next_entry(de);
638 folio_release_kmap(folio, kaddr);
643 folio_release_kmap(folio, kaddr);
647 const struct file_operations nilfs_dir_operations = {
648 .llseek = generic_file_llseek,
649 .read = generic_read_dir,
650 .iterate_shared = nilfs_readdir,
651 .unlocked_ioctl = nilfs_ioctl,
653 .compat_ioctl = nilfs_compat_ioctl,
654 #endif /* CONFIG_COMPAT */
655 .fsync = nilfs_sync_file,