1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright (C) 1992, 1993, 1994, 1995
7 * Laboratoire MASI - Institut Blaise Pascal
8 * Universite Pierre et Marie Curie (Paris VI)
12 * linux/fs/minix/dir.c
14 * Copyright (C) 1991, 1992 Linus Torvalds
16 * ext2 directory handling functions
18 * Big-endian to little-endian byte-swapping/bitmaps by
21 * All code that works with directory layout had been switched to pagecache
26 #include <linux/buffer_head.h>
27 #include <linux/pagemap.h>
28 #include <linux/swap.h>
29 #include <linux/iversion.h>
31 typedef struct ext2_dir_entry_2 ext2_dirent;
34 * Tests against MAX_REC_LEN etc were put in place for 64k block
35 * sizes; if that is not possible on this arch, we can skip
36 * those tests and speed things up.
38 static inline unsigned ext2_rec_len_from_disk(__le16 dlen)
40 unsigned len = le16_to_cpu(dlen);
42 #if (PAGE_SIZE >= 65536)
43 if (len == EXT2_MAX_REC_LEN)
49 static inline __le16 ext2_rec_len_to_disk(unsigned len)
51 #if (PAGE_SIZE >= 65536)
53 return cpu_to_le16(EXT2_MAX_REC_LEN);
55 BUG_ON(len > (1 << 16));
57 return cpu_to_le16(len);
61 * ext2 uses block-sized chunks. Arguably, sector-sized ones would be
62 * more robust, but we have what we have
64 static inline unsigned ext2_chunk_size(struct inode *inode)
66 return inode->i_sb->s_blocksize;
70 * Return the offset into page `page_nr' of the last valid
71 * byte in that page, plus one.
74 ext2_last_byte(struct inode *inode, unsigned long page_nr)
76 unsigned last_byte = inode->i_size;
78 last_byte -= page_nr << PAGE_SHIFT;
79 if (last_byte > PAGE_SIZE)
80 last_byte = PAGE_SIZE;
84 static int ext2_commit_chunk(struct page *page, loff_t pos, unsigned len)
86 struct address_space *mapping = page->mapping;
87 struct inode *dir = mapping->host;
90 inode_inc_iversion(dir);
91 block_write_end(NULL, mapping, pos, len, len, page, NULL);
93 if (pos+len > dir->i_size) {
94 i_size_write(dir, pos+len);
95 mark_inode_dirty(dir);
98 if (IS_DIRSYNC(dir)) {
99 err = write_one_page(page);
101 err = sync_inode_metadata(dir, 1);
109 static bool ext2_check_page(struct page *page, int quiet)
111 struct inode *dir = page->mapping->host;
112 struct super_block *sb = dir->i_sb;
113 unsigned chunk_size = ext2_chunk_size(dir);
114 char *kaddr = page_address(page);
115 u32 max_inumber = le32_to_cpu(EXT2_SB(sb)->s_es->s_inodes_count);
116 unsigned offs, rec_len;
117 unsigned limit = PAGE_SIZE;
121 if ((dir->i_size >> PAGE_SHIFT) == page->index) {
122 limit = dir->i_size & ~PAGE_MASK;
123 if (limit & (chunk_size - 1))
128 for (offs = 0; offs <= limit - EXT2_DIR_REC_LEN(1); offs += rec_len) {
129 p = (ext2_dirent *)(kaddr + offs);
130 rec_len = ext2_rec_len_from_disk(p->rec_len);
132 if (unlikely(rec_len < EXT2_DIR_REC_LEN(1)))
134 if (unlikely(rec_len & 3))
136 if (unlikely(rec_len < EXT2_DIR_REC_LEN(p->name_len)))
138 if (unlikely(((offs + rec_len - 1) ^ offs) & ~(chunk_size-1)))
140 if (unlikely(le32_to_cpu(p->inode) > max_inumber))
146 SetPageChecked(page);
149 /* Too bad, we had an error */
153 ext2_error(sb, __func__,
154 "size of directory #%lu is not a multiple "
155 "of chunk size", dir->i_ino);
158 error = "rec_len is smaller than minimal";
161 error = "unaligned directory entry";
164 error = "rec_len is too small for name_len";
167 error = "directory entry across blocks";
170 error = "inode out of bounds";
173 ext2_error(sb, __func__, "bad entry in directory #%lu: : %s - "
174 "offset=%lu, inode=%lu, rec_len=%d, name_len=%d",
175 dir->i_ino, error, (page->index<<PAGE_SHIFT)+offs,
176 (unsigned long) le32_to_cpu(p->inode),
177 rec_len, p->name_len);
181 p = (ext2_dirent *)(kaddr + offs);
182 ext2_error(sb, "ext2_check_page",
183 "entry in directory #%lu spans the page boundary"
184 "offset=%lu, inode=%lu",
185 dir->i_ino, (page->index<<PAGE_SHIFT)+offs,
186 (unsigned long) le32_to_cpu(p->inode));
193 static struct page * ext2_get_page(struct inode *dir, unsigned long n,
196 struct address_space *mapping = dir->i_mapping;
197 struct page *page = read_mapping_page(mapping, n, NULL);
200 if (unlikely(!PageChecked(page))) {
201 if (PageError(page) || !ext2_check_page(page, quiet))
209 return ERR_PTR(-EIO);
213 * NOTE! unlike strncmp, ext2_match returns 1 for success, 0 for failure.
215 * len <= EXT2_NAME_LEN and de != NULL are guaranteed by caller.
217 static inline int ext2_match (int len, const char * const name,
218 struct ext2_dir_entry_2 * de)
220 if (len != de->name_len)
224 return !memcmp(name, de->name, len);
228 * p is at least 6 bytes before the end of page
230 static inline ext2_dirent *ext2_next_entry(ext2_dirent *p)
232 return (ext2_dirent *)((char *)p +
233 ext2_rec_len_from_disk(p->rec_len));
236 static inline unsigned
237 ext2_validate_entry(char *base, unsigned offset, unsigned mask)
239 ext2_dirent *de = (ext2_dirent*)(base + offset);
240 ext2_dirent *p = (ext2_dirent*)(base + (offset&mask));
241 while ((char*)p < (char*)de) {
244 p = ext2_next_entry(p);
246 return (char *)p - base;
249 static inline void ext2_set_de_type(ext2_dirent *de, struct inode *inode)
251 if (EXT2_HAS_INCOMPAT_FEATURE(inode->i_sb, EXT2_FEATURE_INCOMPAT_FILETYPE))
252 de->file_type = fs_umode_to_ftype(inode->i_mode);
258 ext2_readdir(struct file *file, struct dir_context *ctx)
260 loff_t pos = ctx->pos;
261 struct inode *inode = file_inode(file);
262 struct super_block *sb = inode->i_sb;
263 unsigned int offset = pos & ~PAGE_MASK;
264 unsigned long n = pos >> PAGE_SHIFT;
265 unsigned long npages = dir_pages(inode);
266 unsigned chunk_mask = ~(ext2_chunk_size(inode)-1);
267 bool need_revalidate = !inode_eq_iversion(inode, file->f_version);
270 if (pos > inode->i_size - EXT2_DIR_REC_LEN(1))
274 EXT2_HAS_INCOMPAT_FEATURE(sb, EXT2_FEATURE_INCOMPAT_FILETYPE);
276 for ( ; n < npages; n++, offset = 0) {
279 struct page *page = ext2_get_page(inode, n, 0);
282 ext2_error(sb, __func__,
285 ctx->pos += PAGE_SIZE - offset;
286 return PTR_ERR(page);
288 kaddr = page_address(page);
289 if (unlikely(need_revalidate)) {
291 offset = ext2_validate_entry(kaddr, offset, chunk_mask);
292 ctx->pos = (n<<PAGE_SHIFT) + offset;
294 file->f_version = inode_query_iversion(inode);
295 need_revalidate = false;
297 de = (ext2_dirent *)(kaddr+offset);
298 limit = kaddr + ext2_last_byte(inode, n) - EXT2_DIR_REC_LEN(1);
299 for ( ;(char*)de <= limit; de = ext2_next_entry(de)) {
300 if (de->rec_len == 0) {
301 ext2_error(sb, __func__,
302 "zero-length directory entry");
307 unsigned char d_type = DT_UNKNOWN;
310 d_type = fs_ftype_to_dtype(de->file_type);
312 if (!dir_emit(ctx, de->name, de->name_len,
313 le32_to_cpu(de->inode),
319 ctx->pos += ext2_rec_len_from_disk(de->rec_len);
329 * finds an entry in the specified directory with the wanted name. It
330 * returns the page in which the entry was found (as a parameter - res_page),
331 * and the entry itself. Page is returned mapped and unlocked.
332 * Entry is guaranteed to be valid.
334 * On Success ext2_put_page() should be called on *res_page.
336 struct ext2_dir_entry_2 *ext2_find_entry (struct inode *dir,
337 const struct qstr *child, struct page **res_page)
339 const char *name = child->name;
340 int namelen = child->len;
341 unsigned reclen = EXT2_DIR_REC_LEN(namelen);
342 unsigned long start, n;
343 unsigned long npages = dir_pages(dir);
344 struct page *page = NULL;
345 struct ext2_inode_info *ei = EXT2_I(dir);
354 start = ei->i_dir_start_lookup;
360 page = ext2_get_page(dir, n, 0);
362 return ERR_CAST(page);
364 kaddr = page_address(page);
365 de = (ext2_dirent *) kaddr;
366 kaddr += ext2_last_byte(dir, n) - reclen;
367 while ((char *) de <= kaddr) {
368 if (de->rec_len == 0) {
369 ext2_error(dir->i_sb, __func__,
370 "zero-length directory entry");
374 if (ext2_match(namelen, name, de))
376 de = ext2_next_entry(de);
382 /* next page is past the blocks we've got */
383 if (unlikely(n > (dir->i_blocks >> (PAGE_SHIFT - 9)))) {
384 ext2_error(dir->i_sb, __func__,
385 "dir %lu size %lld exceeds block count %llu",
386 dir->i_ino, dir->i_size,
387 (unsigned long long)dir->i_blocks);
390 } while (n != start);
392 return ERR_PTR(-ENOENT);
396 ei->i_dir_start_lookup = n;
401 * Return the '..' directory entry and the page in which the entry was found
402 * (as a parameter - p).
404 * On Success ext2_put_page() should be called on *p.
406 struct ext2_dir_entry_2 * ext2_dotdot (struct inode *dir, struct page **p)
408 struct page *page = ext2_get_page(dir, 0, 0);
409 ext2_dirent *de = NULL;
412 de = ext2_next_entry((ext2_dirent *) page_address(page));
418 int ext2_inode_by_name(struct inode *dir, const struct qstr *child, ino_t *ino)
420 struct ext2_dir_entry_2 *de;
423 de = ext2_find_entry(dir, child, &page);
427 *ino = le32_to_cpu(de->inode);
432 static int ext2_prepare_chunk(struct page *page, loff_t pos, unsigned len)
434 return __block_write_begin(page, pos, len, ext2_get_block);
437 /* Releases the page */
438 void ext2_set_link(struct inode *dir, struct ext2_dir_entry_2 *de,
439 struct page *page, struct inode *inode, int update_times)
441 loff_t pos = page_offset(page) +
442 (char *) de - (char *) page_address(page);
443 unsigned len = ext2_rec_len_from_disk(de->rec_len);
447 err = ext2_prepare_chunk(page, pos, len);
449 de->inode = cpu_to_le32(inode->i_ino);
450 ext2_set_de_type(de, inode);
451 err = ext2_commit_chunk(page, pos, len);
454 dir->i_mtime = dir->i_ctime = current_time(dir);
455 EXT2_I(dir)->i_flags &= ~EXT2_BTREE_FL;
456 mark_inode_dirty(dir);
462 int ext2_add_link (struct dentry *dentry, struct inode *inode)
464 struct inode *dir = d_inode(dentry->d_parent);
465 const char *name = dentry->d_name.name;
466 int namelen = dentry->d_name.len;
467 unsigned chunk_size = ext2_chunk_size(dir);
468 unsigned reclen = EXT2_DIR_REC_LEN(namelen);
469 unsigned short rec_len, name_len;
470 struct page *page = NULL;
472 unsigned long npages = dir_pages(dir);
479 * We take care of directory expansion in the same loop.
480 * This code plays outside i_size, so it locks the page
481 * to protect that region.
483 for (n = 0; n <= npages; n++) {
486 page = ext2_get_page(dir, n, 0);
491 kaddr = page_address(page);
492 dir_end = kaddr + ext2_last_byte(dir, n);
493 de = (ext2_dirent *)kaddr;
494 kaddr += PAGE_SIZE - reclen;
495 while ((char *)de <= kaddr) {
496 if ((char *)de == dir_end) {
499 rec_len = chunk_size;
500 de->rec_len = ext2_rec_len_to_disk(chunk_size);
504 if (de->rec_len == 0) {
505 ext2_error(dir->i_sb, __func__,
506 "zero-length directory entry");
511 if (ext2_match (namelen, name, de))
513 name_len = EXT2_DIR_REC_LEN(de->name_len);
514 rec_len = ext2_rec_len_from_disk(de->rec_len);
515 if (!de->inode && rec_len >= reclen)
517 if (rec_len >= name_len + reclen)
519 de = (ext2_dirent *) ((char *) de + rec_len);
528 pos = page_offset(page) +
529 (char*)de - (char*)page_address(page);
530 err = ext2_prepare_chunk(page, pos, rec_len);
534 ext2_dirent *de1 = (ext2_dirent *) ((char *) de + name_len);
535 de1->rec_len = ext2_rec_len_to_disk(rec_len - name_len);
536 de->rec_len = ext2_rec_len_to_disk(name_len);
539 de->name_len = namelen;
540 memcpy(de->name, name, namelen);
541 de->inode = cpu_to_le32(inode->i_ino);
542 ext2_set_de_type (de, inode);
543 err = ext2_commit_chunk(page, pos, rec_len);
544 dir->i_mtime = dir->i_ctime = current_time(dir);
545 EXT2_I(dir)->i_flags &= ~EXT2_BTREE_FL;
546 mark_inode_dirty(dir);
558 * ext2_delete_entry deletes a directory entry by merging it with the
559 * previous entry. Page is up-to-date. Releases the page.
561 int ext2_delete_entry (struct ext2_dir_entry_2 * dir, struct page * page )
563 struct inode *inode = page->mapping->host;
564 char *kaddr = page_address(page);
565 unsigned from = ((char*)dir - kaddr) & ~(ext2_chunk_size(inode)-1);
566 unsigned to = ((char *)dir - kaddr) +
567 ext2_rec_len_from_disk(dir->rec_len);
569 ext2_dirent * pde = NULL;
570 ext2_dirent * de = (ext2_dirent *) (kaddr + from);
573 while ((char*)de < (char*)dir) {
574 if (de->rec_len == 0) {
575 ext2_error(inode->i_sb, __func__,
576 "zero-length directory entry");
581 de = ext2_next_entry(de);
584 from = (char*)pde - (char*)page_address(page);
585 pos = page_offset(page) + from;
587 err = ext2_prepare_chunk(page, pos, to - from);
590 pde->rec_len = ext2_rec_len_to_disk(to - from);
592 err = ext2_commit_chunk(page, pos, to - from);
593 inode->i_ctime = inode->i_mtime = current_time(inode);
594 EXT2_I(inode)->i_flags &= ~EXT2_BTREE_FL;
595 mark_inode_dirty(inode);
602 * Set the first fragment of directory.
604 int ext2_make_empty(struct inode *inode, struct inode *parent)
606 struct page *page = grab_cache_page(inode->i_mapping, 0);
607 unsigned chunk_size = ext2_chunk_size(inode);
608 struct ext2_dir_entry_2 * de;
615 err = ext2_prepare_chunk(page, 0, chunk_size);
620 kaddr = kmap_atomic(page);
621 memset(kaddr, 0, chunk_size);
622 de = (struct ext2_dir_entry_2 *)kaddr;
624 de->rec_len = ext2_rec_len_to_disk(EXT2_DIR_REC_LEN(1));
625 memcpy (de->name, ".\0\0", 4);
626 de->inode = cpu_to_le32(inode->i_ino);
627 ext2_set_de_type (de, inode);
629 de = (struct ext2_dir_entry_2 *)(kaddr + EXT2_DIR_REC_LEN(1));
631 de->rec_len = ext2_rec_len_to_disk(chunk_size - EXT2_DIR_REC_LEN(1));
632 de->inode = cpu_to_le32(parent->i_ino);
633 memcpy (de->name, "..\0", 4);
634 ext2_set_de_type (de, inode);
635 kunmap_atomic(kaddr);
636 err = ext2_commit_chunk(page, 0, chunk_size);
643 * routine to check that the specified directory is empty (for rmdir)
645 int ext2_empty_dir (struct inode * inode)
647 struct page *page = NULL;
648 unsigned long i, npages = dir_pages(inode);
649 int dir_has_error = 0;
651 for (i = 0; i < npages; i++) {
654 page = ext2_get_page(inode, i, dir_has_error);
661 kaddr = page_address(page);
662 de = (ext2_dirent *)kaddr;
663 kaddr += ext2_last_byte(inode, i) - EXT2_DIR_REC_LEN(1);
665 while ((char *)de <= kaddr) {
666 if (de->rec_len == 0) {
667 ext2_error(inode->i_sb, __func__,
668 "zero-length directory entry");
669 printk("kaddr=%p, de=%p\n", kaddr, de);
672 if (de->inode != 0) {
673 /* check for . and .. */
674 if (de->name[0] != '.')
676 if (de->name_len > 2)
678 if (de->name_len < 2) {
680 cpu_to_le32(inode->i_ino))
682 } else if (de->name[1] != '.')
685 de = ext2_next_entry(de);
696 const struct file_operations ext2_dir_operations = {
697 .llseek = generic_file_llseek,
698 .read = generic_read_dir,
699 .iterate_shared = ext2_readdir,
700 .unlocked_ioctl = ext2_ioctl,
702 .compat_ioctl = ext2_compat_ioctl,