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;
69 static inline void ext2_put_page(struct page *page)
76 * Return the offset into page `page_nr' of the last valid
77 * byte in that page, plus one.
80 ext2_last_byte(struct inode *inode, unsigned long page_nr)
82 unsigned last_byte = inode->i_size;
84 last_byte -= page_nr << PAGE_SHIFT;
85 if (last_byte > PAGE_SIZE)
86 last_byte = PAGE_SIZE;
90 static int ext2_commit_chunk(struct page *page, loff_t pos, unsigned len)
92 struct address_space *mapping = page->mapping;
93 struct inode *dir = mapping->host;
96 inode_inc_iversion(dir);
97 block_write_end(NULL, mapping, pos, len, len, page, NULL);
99 if (pos+len > dir->i_size) {
100 i_size_write(dir, pos+len);
101 mark_inode_dirty(dir);
104 if (IS_DIRSYNC(dir)) {
105 err = write_one_page(page);
107 err = sync_inode_metadata(dir, 1);
115 static bool ext2_check_page(struct page *page, int quiet)
117 struct inode *dir = page->mapping->host;
118 struct super_block *sb = dir->i_sb;
119 unsigned chunk_size = ext2_chunk_size(dir);
120 char *kaddr = page_address(page);
121 u32 max_inumber = le32_to_cpu(EXT2_SB(sb)->s_es->s_inodes_count);
122 unsigned offs, rec_len;
123 unsigned limit = PAGE_SIZE;
127 if ((dir->i_size >> PAGE_SHIFT) == page->index) {
128 limit = dir->i_size & ~PAGE_MASK;
129 if (limit & (chunk_size - 1))
134 for (offs = 0; offs <= limit - EXT2_DIR_REC_LEN(1); offs += rec_len) {
135 p = (ext2_dirent *)(kaddr + offs);
136 rec_len = ext2_rec_len_from_disk(p->rec_len);
138 if (unlikely(rec_len < EXT2_DIR_REC_LEN(1)))
140 if (unlikely(rec_len & 3))
142 if (unlikely(rec_len < EXT2_DIR_REC_LEN(p->name_len)))
144 if (unlikely(((offs + rec_len - 1) ^ offs) & ~(chunk_size-1)))
146 if (unlikely(le32_to_cpu(p->inode) > max_inumber))
152 SetPageChecked(page);
155 /* Too bad, we had an error */
159 ext2_error(sb, __func__,
160 "size of directory #%lu is not a multiple "
161 "of chunk size", dir->i_ino);
164 error = "rec_len is smaller than minimal";
167 error = "unaligned directory entry";
170 error = "rec_len is too small for name_len";
173 error = "directory entry across blocks";
176 error = "inode out of bounds";
179 ext2_error(sb, __func__, "bad entry in directory #%lu: : %s - "
180 "offset=%lu, inode=%lu, rec_len=%d, name_len=%d",
181 dir->i_ino, error, (page->index<<PAGE_SHIFT)+offs,
182 (unsigned long) le32_to_cpu(p->inode),
183 rec_len, p->name_len);
187 p = (ext2_dirent *)(kaddr + offs);
188 ext2_error(sb, "ext2_check_page",
189 "entry in directory #%lu spans the page boundary"
190 "offset=%lu, inode=%lu",
191 dir->i_ino, (page->index<<PAGE_SHIFT)+offs,
192 (unsigned long) le32_to_cpu(p->inode));
199 static struct page * ext2_get_page(struct inode *dir, unsigned long n,
202 struct address_space *mapping = dir->i_mapping;
203 struct page *page = read_mapping_page(mapping, n, NULL);
206 if (unlikely(!PageChecked(page))) {
207 if (PageError(page) || !ext2_check_page(page, quiet))
215 return ERR_PTR(-EIO);
219 * NOTE! unlike strncmp, ext2_match returns 1 for success, 0 for failure.
221 * len <= EXT2_NAME_LEN and de != NULL are guaranteed by caller.
223 static inline int ext2_match (int len, const char * const name,
224 struct ext2_dir_entry_2 * de)
226 if (len != de->name_len)
230 return !memcmp(name, de->name, len);
234 * p is at least 6 bytes before the end of page
236 static inline ext2_dirent *ext2_next_entry(ext2_dirent *p)
238 return (ext2_dirent *)((char *)p +
239 ext2_rec_len_from_disk(p->rec_len));
242 static inline unsigned
243 ext2_validate_entry(char *base, unsigned offset, unsigned mask)
245 ext2_dirent *de = (ext2_dirent*)(base + offset);
246 ext2_dirent *p = (ext2_dirent*)(base + (offset&mask));
247 while ((char*)p < (char*)de) {
250 p = ext2_next_entry(p);
252 return (char *)p - base;
255 static inline void ext2_set_de_type(ext2_dirent *de, struct inode *inode)
257 if (EXT2_HAS_INCOMPAT_FEATURE(inode->i_sb, EXT2_FEATURE_INCOMPAT_FILETYPE))
258 de->file_type = fs_umode_to_ftype(inode->i_mode);
264 ext2_readdir(struct file *file, struct dir_context *ctx)
266 loff_t pos = ctx->pos;
267 struct inode *inode = file_inode(file);
268 struct super_block *sb = inode->i_sb;
269 unsigned int offset = pos & ~PAGE_MASK;
270 unsigned long n = pos >> PAGE_SHIFT;
271 unsigned long npages = dir_pages(inode);
272 unsigned chunk_mask = ~(ext2_chunk_size(inode)-1);
273 bool need_revalidate = !inode_eq_iversion(inode, file->f_version);
276 if (pos > inode->i_size - EXT2_DIR_REC_LEN(1))
280 EXT2_HAS_INCOMPAT_FEATURE(sb, EXT2_FEATURE_INCOMPAT_FILETYPE);
282 for ( ; n < npages; n++, offset = 0) {
285 struct page *page = ext2_get_page(inode, n, 0);
288 ext2_error(sb, __func__,
291 ctx->pos += PAGE_SIZE - offset;
292 return PTR_ERR(page);
294 kaddr = page_address(page);
295 if (unlikely(need_revalidate)) {
297 offset = ext2_validate_entry(kaddr, offset, chunk_mask);
298 ctx->pos = (n<<PAGE_SHIFT) + offset;
300 file->f_version = inode_query_iversion(inode);
301 need_revalidate = false;
303 de = (ext2_dirent *)(kaddr+offset);
304 limit = kaddr + ext2_last_byte(inode, n) - EXT2_DIR_REC_LEN(1);
305 for ( ;(char*)de <= limit; de = ext2_next_entry(de)) {
306 if (de->rec_len == 0) {
307 ext2_error(sb, __func__,
308 "zero-length directory entry");
313 unsigned char d_type = DT_UNKNOWN;
316 d_type = fs_ftype_to_dtype(de->file_type);
318 if (!dir_emit(ctx, de->name, de->name_len,
319 le32_to_cpu(de->inode),
325 ctx->pos += ext2_rec_len_from_disk(de->rec_len);
335 * finds an entry in the specified directory with the wanted name. It
336 * returns the page in which the entry was found (as a parameter - res_page),
337 * and the entry itself. Page is returned mapped and unlocked.
338 * Entry is guaranteed to be valid.
340 struct ext2_dir_entry_2 *ext2_find_entry (struct inode *dir,
341 const struct qstr *child, struct page **res_page)
343 const char *name = child->name;
344 int namelen = child->len;
345 unsigned reclen = EXT2_DIR_REC_LEN(namelen);
346 unsigned long start, n;
347 unsigned long npages = dir_pages(dir);
348 struct page *page = NULL;
349 struct ext2_inode_info *ei = EXT2_I(dir);
358 start = ei->i_dir_start_lookup;
364 page = ext2_get_page(dir, n, 0);
366 return ERR_CAST(page);
368 kaddr = page_address(page);
369 de = (ext2_dirent *) kaddr;
370 kaddr += ext2_last_byte(dir, n) - reclen;
371 while ((char *) de <= kaddr) {
372 if (de->rec_len == 0) {
373 ext2_error(dir->i_sb, __func__,
374 "zero-length directory entry");
378 if (ext2_match(namelen, name, de))
380 de = ext2_next_entry(de);
386 /* next page is past the blocks we've got */
387 if (unlikely(n > (dir->i_blocks >> (PAGE_SHIFT - 9)))) {
388 ext2_error(dir->i_sb, __func__,
389 "dir %lu size %lld exceeds block count %llu",
390 dir->i_ino, dir->i_size,
391 (unsigned long long)dir->i_blocks);
394 } while (n != start);
396 return ERR_PTR(-ENOENT);
400 ei->i_dir_start_lookup = n;
404 struct ext2_dir_entry_2 * ext2_dotdot (struct inode *dir, struct page **p)
406 struct page *page = ext2_get_page(dir, 0, 0);
407 ext2_dirent *de = NULL;
410 de = ext2_next_entry((ext2_dirent *) page_address(page));
416 int ext2_inode_by_name(struct inode *dir, const struct qstr *child, ino_t *ino)
418 struct ext2_dir_entry_2 *de;
421 de = ext2_find_entry(dir, child, &page);
425 *ino = le32_to_cpu(de->inode);
430 static int ext2_prepare_chunk(struct page *page, loff_t pos, unsigned len)
432 return __block_write_begin(page, pos, len, ext2_get_block);
435 /* Releases the page */
436 void ext2_set_link(struct inode *dir, struct ext2_dir_entry_2 *de,
437 struct page *page, struct inode *inode, int update_times)
439 loff_t pos = page_offset(page) +
440 (char *) de - (char *) page_address(page);
441 unsigned len = ext2_rec_len_from_disk(de->rec_len);
445 err = ext2_prepare_chunk(page, pos, len);
447 de->inode = cpu_to_le32(inode->i_ino);
448 ext2_set_de_type(de, inode);
449 err = ext2_commit_chunk(page, pos, len);
452 dir->i_mtime = dir->i_ctime = current_time(dir);
453 EXT2_I(dir)->i_flags &= ~EXT2_BTREE_FL;
454 mark_inode_dirty(dir);
460 int ext2_add_link (struct dentry *dentry, struct inode *inode)
462 struct inode *dir = d_inode(dentry->d_parent);
463 const char *name = dentry->d_name.name;
464 int namelen = dentry->d_name.len;
465 unsigned chunk_size = ext2_chunk_size(dir);
466 unsigned reclen = EXT2_DIR_REC_LEN(namelen);
467 unsigned short rec_len, name_len;
468 struct page *page = NULL;
470 unsigned long npages = dir_pages(dir);
477 * We take care of directory expansion in the same loop.
478 * This code plays outside i_size, so it locks the page
479 * to protect that region.
481 for (n = 0; n <= npages; n++) {
484 page = ext2_get_page(dir, n, 0);
489 kaddr = page_address(page);
490 dir_end = kaddr + ext2_last_byte(dir, n);
491 de = (ext2_dirent *)kaddr;
492 kaddr += PAGE_SIZE - reclen;
493 while ((char *)de <= kaddr) {
494 if ((char *)de == dir_end) {
497 rec_len = chunk_size;
498 de->rec_len = ext2_rec_len_to_disk(chunk_size);
502 if (de->rec_len == 0) {
503 ext2_error(dir->i_sb, __func__,
504 "zero-length directory entry");
509 if (ext2_match (namelen, name, de))
511 name_len = EXT2_DIR_REC_LEN(de->name_len);
512 rec_len = ext2_rec_len_from_disk(de->rec_len);
513 if (!de->inode && rec_len >= reclen)
515 if (rec_len >= name_len + reclen)
517 de = (ext2_dirent *) ((char *) de + rec_len);
526 pos = page_offset(page) +
527 (char*)de - (char*)page_address(page);
528 err = ext2_prepare_chunk(page, pos, rec_len);
532 ext2_dirent *de1 = (ext2_dirent *) ((char *) de + name_len);
533 de1->rec_len = ext2_rec_len_to_disk(rec_len - name_len);
534 de->rec_len = ext2_rec_len_to_disk(name_len);
537 de->name_len = namelen;
538 memcpy(de->name, name, namelen);
539 de->inode = cpu_to_le32(inode->i_ino);
540 ext2_set_de_type (de, inode);
541 err = ext2_commit_chunk(page, pos, rec_len);
542 dir->i_mtime = dir->i_ctime = current_time(dir);
543 EXT2_I(dir)->i_flags &= ~EXT2_BTREE_FL;
544 mark_inode_dirty(dir);
556 * ext2_delete_entry deletes a directory entry by merging it with the
557 * previous entry. Page is up-to-date. Releases the page.
559 int ext2_delete_entry (struct ext2_dir_entry_2 * dir, struct page * page )
561 struct inode *inode = page->mapping->host;
562 char *kaddr = page_address(page);
563 unsigned from = ((char*)dir - kaddr) & ~(ext2_chunk_size(inode)-1);
564 unsigned to = ((char *)dir - kaddr) +
565 ext2_rec_len_from_disk(dir->rec_len);
567 ext2_dirent * pde = NULL;
568 ext2_dirent * de = (ext2_dirent *) (kaddr + from);
571 while ((char*)de < (char*)dir) {
572 if (de->rec_len == 0) {
573 ext2_error(inode->i_sb, __func__,
574 "zero-length directory entry");
579 de = ext2_next_entry(de);
582 from = (char*)pde - (char*)page_address(page);
583 pos = page_offset(page) + from;
585 err = ext2_prepare_chunk(page, pos, to - from);
588 pde->rec_len = ext2_rec_len_to_disk(to - from);
590 err = ext2_commit_chunk(page, pos, to - from);
591 inode->i_ctime = inode->i_mtime = current_time(inode);
592 EXT2_I(inode)->i_flags &= ~EXT2_BTREE_FL;
593 mark_inode_dirty(inode);
600 * Set the first fragment of directory.
602 int ext2_make_empty(struct inode *inode, struct inode *parent)
604 struct page *page = grab_cache_page(inode->i_mapping, 0);
605 unsigned chunk_size = ext2_chunk_size(inode);
606 struct ext2_dir_entry_2 * de;
613 err = ext2_prepare_chunk(page, 0, chunk_size);
618 kaddr = kmap_atomic(page);
619 memset(kaddr, 0, chunk_size);
620 de = (struct ext2_dir_entry_2 *)kaddr;
622 de->rec_len = ext2_rec_len_to_disk(EXT2_DIR_REC_LEN(1));
623 memcpy (de->name, ".\0\0", 4);
624 de->inode = cpu_to_le32(inode->i_ino);
625 ext2_set_de_type (de, inode);
627 de = (struct ext2_dir_entry_2 *)(kaddr + EXT2_DIR_REC_LEN(1));
629 de->rec_len = ext2_rec_len_to_disk(chunk_size - EXT2_DIR_REC_LEN(1));
630 de->inode = cpu_to_le32(parent->i_ino);
631 memcpy (de->name, "..\0", 4);
632 ext2_set_de_type (de, inode);
633 kunmap_atomic(kaddr);
634 err = ext2_commit_chunk(page, 0, chunk_size);
641 * routine to check that the specified directory is empty (for rmdir)
643 int ext2_empty_dir (struct inode * inode)
645 struct page *page = NULL;
646 unsigned long i, npages = dir_pages(inode);
647 int dir_has_error = 0;
649 for (i = 0; i < npages; i++) {
652 page = ext2_get_page(inode, i, dir_has_error);
659 kaddr = page_address(page);
660 de = (ext2_dirent *)kaddr;
661 kaddr += ext2_last_byte(inode, i) - EXT2_DIR_REC_LEN(1);
663 while ((char *)de <= kaddr) {
664 if (de->rec_len == 0) {
665 ext2_error(inode->i_sb, __func__,
666 "zero-length directory entry");
667 printk("kaddr=%p, de=%p\n", kaddr, de);
670 if (de->inode != 0) {
671 /* check for . and .. */
672 if (de->name[0] != '.')
674 if (de->name_len > 2)
676 if (de->name_len < 2) {
678 cpu_to_le32(inode->i_ino))
680 } else if (de->name[1] != '.')
683 de = ext2_next_entry(de);
694 const struct file_operations ext2_dir_operations = {
695 .llseek = generic_file_llseek,
696 .read = generic_read_dir,
697 .iterate_shared = ext2_readdir,
698 .unlocked_ioctl = ext2_ioctl,
700 .compat_ioctl = ext2_compat_ioctl,