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>
30 typedef struct ext2_dir_entry_2 ext2_dirent;
33 * Tests against MAX_REC_LEN etc were put in place for 64k block
34 * sizes; if that is not possible on this arch, we can skip
35 * those tests and speed things up.
37 static inline unsigned ext2_rec_len_from_disk(__le16 dlen)
39 unsigned len = le16_to_cpu(dlen);
41 #if (PAGE_SIZE >= 65536)
42 if (len == EXT2_MAX_REC_LEN)
48 static inline __le16 ext2_rec_len_to_disk(unsigned len)
50 #if (PAGE_SIZE >= 65536)
52 return cpu_to_le16(EXT2_MAX_REC_LEN);
54 BUG_ON(len > (1 << 16));
56 return cpu_to_le16(len);
60 * ext2 uses block-sized chunks. Arguably, sector-sized ones would be
61 * more robust, but we have what we have
63 static inline unsigned ext2_chunk_size(struct inode *inode)
65 return inode->i_sb->s_blocksize;
68 static inline void ext2_put_page(struct page *page)
75 * Return the offset into page `page_nr' of the last valid
76 * byte in that page, plus one.
79 ext2_last_byte(struct inode *inode, unsigned long page_nr)
81 unsigned last_byte = inode->i_size;
83 last_byte -= page_nr << PAGE_SHIFT;
84 if (last_byte > PAGE_SIZE)
85 last_byte = PAGE_SIZE;
89 static int ext2_commit_chunk(struct page *page, loff_t pos, unsigned len)
91 struct address_space *mapping = page->mapping;
92 struct inode *dir = mapping->host;
96 block_write_end(NULL, mapping, pos, len, len, page, NULL);
98 if (pos+len > dir->i_size) {
99 i_size_write(dir, pos+len);
100 mark_inode_dirty(dir);
103 if (IS_DIRSYNC(dir)) {
104 err = write_one_page(page);
106 err = sync_inode_metadata(dir, 1);
114 static bool ext2_check_page(struct page *page, int quiet)
116 struct inode *dir = page->mapping->host;
117 struct super_block *sb = dir->i_sb;
118 unsigned chunk_size = ext2_chunk_size(dir);
119 char *kaddr = page_address(page);
120 u32 max_inumber = le32_to_cpu(EXT2_SB(sb)->s_es->s_inodes_count);
121 unsigned offs, rec_len;
122 unsigned limit = PAGE_SIZE;
126 if ((dir->i_size >> PAGE_SHIFT) == page->index) {
127 limit = dir->i_size & ~PAGE_MASK;
128 if (limit & (chunk_size - 1))
133 for (offs = 0; offs <= limit - EXT2_DIR_REC_LEN(1); offs += rec_len) {
134 p = (ext2_dirent *)(kaddr + offs);
135 rec_len = ext2_rec_len_from_disk(p->rec_len);
137 if (unlikely(rec_len < EXT2_DIR_REC_LEN(1)))
139 if (unlikely(rec_len & 3))
141 if (unlikely(rec_len < EXT2_DIR_REC_LEN(p->name_len)))
143 if (unlikely(((offs + rec_len - 1) ^ offs) & ~(chunk_size-1)))
145 if (unlikely(le32_to_cpu(p->inode) > max_inumber))
151 SetPageChecked(page);
154 /* Too bad, we had an error */
158 ext2_error(sb, __func__,
159 "size of directory #%lu is not a multiple "
160 "of chunk size", dir->i_ino);
163 error = "rec_len is smaller than minimal";
166 error = "unaligned directory entry";
169 error = "rec_len is too small for name_len";
172 error = "directory entry across blocks";
175 error = "inode out of bounds";
178 ext2_error(sb, __func__, "bad entry in directory #%lu: : %s - "
179 "offset=%lu, inode=%lu, rec_len=%d, name_len=%d",
180 dir->i_ino, error, (page->index<<PAGE_SHIFT)+offs,
181 (unsigned long) le32_to_cpu(p->inode),
182 rec_len, p->name_len);
186 p = (ext2_dirent *)(kaddr + offs);
187 ext2_error(sb, "ext2_check_page",
188 "entry in directory #%lu spans the page boundary"
189 "offset=%lu, inode=%lu",
190 dir->i_ino, (page->index<<PAGE_SHIFT)+offs,
191 (unsigned long) le32_to_cpu(p->inode));
198 static struct page * ext2_get_page(struct inode *dir, unsigned long n,
201 struct address_space *mapping = dir->i_mapping;
202 struct page *page = read_mapping_page(mapping, n, NULL);
205 if (unlikely(!PageChecked(page))) {
206 if (PageError(page) || !ext2_check_page(page, quiet))
214 return ERR_PTR(-EIO);
218 * NOTE! unlike strncmp, ext2_match returns 1 for success, 0 for failure.
220 * len <= EXT2_NAME_LEN and de != NULL are guaranteed by caller.
222 static inline int ext2_match (int len, const char * const name,
223 struct ext2_dir_entry_2 * de)
225 if (len != de->name_len)
229 return !memcmp(name, de->name, len);
233 * p is at least 6 bytes before the end of page
235 static inline ext2_dirent *ext2_next_entry(ext2_dirent *p)
237 return (ext2_dirent *)((char *)p +
238 ext2_rec_len_from_disk(p->rec_len));
241 static inline unsigned
242 ext2_validate_entry(char *base, unsigned offset, unsigned mask)
244 ext2_dirent *de = (ext2_dirent*)(base + offset);
245 ext2_dirent *p = (ext2_dirent*)(base + (offset&mask));
246 while ((char*)p < (char*)de) {
249 p = ext2_next_entry(p);
251 return (char *)p - base;
254 static unsigned char ext2_filetype_table[EXT2_FT_MAX] = {
255 [EXT2_FT_UNKNOWN] = DT_UNKNOWN,
256 [EXT2_FT_REG_FILE] = DT_REG,
257 [EXT2_FT_DIR] = DT_DIR,
258 [EXT2_FT_CHRDEV] = DT_CHR,
259 [EXT2_FT_BLKDEV] = DT_BLK,
260 [EXT2_FT_FIFO] = DT_FIFO,
261 [EXT2_FT_SOCK] = DT_SOCK,
262 [EXT2_FT_SYMLINK] = DT_LNK,
266 static unsigned char ext2_type_by_mode[S_IFMT >> S_SHIFT] = {
267 [S_IFREG >> S_SHIFT] = EXT2_FT_REG_FILE,
268 [S_IFDIR >> S_SHIFT] = EXT2_FT_DIR,
269 [S_IFCHR >> S_SHIFT] = EXT2_FT_CHRDEV,
270 [S_IFBLK >> S_SHIFT] = EXT2_FT_BLKDEV,
271 [S_IFIFO >> S_SHIFT] = EXT2_FT_FIFO,
272 [S_IFSOCK >> S_SHIFT] = EXT2_FT_SOCK,
273 [S_IFLNK >> S_SHIFT] = EXT2_FT_SYMLINK,
276 static inline void ext2_set_de_type(ext2_dirent *de, struct inode *inode)
278 umode_t mode = inode->i_mode;
279 if (EXT2_HAS_INCOMPAT_FEATURE(inode->i_sb, EXT2_FEATURE_INCOMPAT_FILETYPE))
280 de->file_type = ext2_type_by_mode[(mode & S_IFMT)>>S_SHIFT];
286 ext2_readdir(struct file *file, struct dir_context *ctx)
288 loff_t pos = ctx->pos;
289 struct inode *inode = file_inode(file);
290 struct super_block *sb = inode->i_sb;
291 unsigned int offset = pos & ~PAGE_MASK;
292 unsigned long n = pos >> PAGE_SHIFT;
293 unsigned long npages = dir_pages(inode);
294 unsigned chunk_mask = ~(ext2_chunk_size(inode)-1);
295 unsigned char *types = NULL;
296 int need_revalidate = file->f_version != inode->i_version;
298 if (pos > inode->i_size - EXT2_DIR_REC_LEN(1))
301 if (EXT2_HAS_INCOMPAT_FEATURE(sb, EXT2_FEATURE_INCOMPAT_FILETYPE))
302 types = ext2_filetype_table;
304 for ( ; n < npages; n++, offset = 0) {
307 struct page *page = ext2_get_page(inode, n, 0);
310 ext2_error(sb, __func__,
313 ctx->pos += PAGE_SIZE - offset;
314 return PTR_ERR(page);
316 kaddr = page_address(page);
317 if (unlikely(need_revalidate)) {
319 offset = ext2_validate_entry(kaddr, offset, chunk_mask);
320 ctx->pos = (n<<PAGE_SHIFT) + offset;
322 file->f_version = inode->i_version;
325 de = (ext2_dirent *)(kaddr+offset);
326 limit = kaddr + ext2_last_byte(inode, n) - EXT2_DIR_REC_LEN(1);
327 for ( ;(char*)de <= limit; de = ext2_next_entry(de)) {
328 if (de->rec_len == 0) {
329 ext2_error(sb, __func__,
330 "zero-length directory entry");
335 unsigned char d_type = DT_UNKNOWN;
337 if (types && de->file_type < EXT2_FT_MAX)
338 d_type = types[de->file_type];
340 if (!dir_emit(ctx, de->name, de->name_len,
341 le32_to_cpu(de->inode),
347 ctx->pos += ext2_rec_len_from_disk(de->rec_len);
357 * finds an entry in the specified directory with the wanted name. It
358 * returns the page in which the entry was found (as a parameter - res_page),
359 * and the entry itself. Page is returned mapped and unlocked.
360 * Entry is guaranteed to be valid.
362 struct ext2_dir_entry_2 *ext2_find_entry (struct inode *dir,
363 const struct qstr *child, struct page **res_page)
365 const char *name = child->name;
366 int namelen = child->len;
367 unsigned reclen = EXT2_DIR_REC_LEN(namelen);
368 unsigned long start, n;
369 unsigned long npages = dir_pages(dir);
370 struct page *page = NULL;
371 struct ext2_inode_info *ei = EXT2_I(dir);
373 int dir_has_error = 0;
381 start = ei->i_dir_start_lookup;
387 page = ext2_get_page(dir, n, dir_has_error);
389 kaddr = page_address(page);
390 de = (ext2_dirent *) kaddr;
391 kaddr += ext2_last_byte(dir, n) - reclen;
392 while ((char *) de <= kaddr) {
393 if (de->rec_len == 0) {
394 ext2_error(dir->i_sb, __func__,
395 "zero-length directory entry");
399 if (ext2_match (namelen, name, de))
401 de = ext2_next_entry(de);
409 /* next page is past the blocks we've got */
410 if (unlikely(n > (dir->i_blocks >> (PAGE_SHIFT - 9)))) {
411 ext2_error(dir->i_sb, __func__,
412 "dir %lu size %lld exceeds block count %llu",
413 dir->i_ino, dir->i_size,
414 (unsigned long long)dir->i_blocks);
417 } while (n != start);
423 ei->i_dir_start_lookup = n;
427 struct ext2_dir_entry_2 * ext2_dotdot (struct inode *dir, struct page **p)
429 struct page *page = ext2_get_page(dir, 0, 0);
430 ext2_dirent *de = NULL;
433 de = ext2_next_entry((ext2_dirent *) page_address(page));
439 ino_t ext2_inode_by_name(struct inode *dir, const struct qstr *child)
442 struct ext2_dir_entry_2 *de;
445 de = ext2_find_entry (dir, child, &page);
447 res = le32_to_cpu(de->inode);
453 static int ext2_prepare_chunk(struct page *page, loff_t pos, unsigned len)
455 return __block_write_begin(page, pos, len, ext2_get_block);
458 /* Releases the page */
459 void ext2_set_link(struct inode *dir, struct ext2_dir_entry_2 *de,
460 struct page *page, struct inode *inode, int update_times)
462 loff_t pos = page_offset(page) +
463 (char *) de - (char *) page_address(page);
464 unsigned len = ext2_rec_len_from_disk(de->rec_len);
468 err = ext2_prepare_chunk(page, pos, len);
470 de->inode = cpu_to_le32(inode->i_ino);
471 ext2_set_de_type(de, inode);
472 err = ext2_commit_chunk(page, pos, len);
475 dir->i_mtime = dir->i_ctime = current_time(dir);
476 EXT2_I(dir)->i_flags &= ~EXT2_BTREE_FL;
477 mark_inode_dirty(dir);
483 int ext2_add_link (struct dentry *dentry, struct inode *inode)
485 struct inode *dir = d_inode(dentry->d_parent);
486 const char *name = dentry->d_name.name;
487 int namelen = dentry->d_name.len;
488 unsigned chunk_size = ext2_chunk_size(dir);
489 unsigned reclen = EXT2_DIR_REC_LEN(namelen);
490 unsigned short rec_len, name_len;
491 struct page *page = NULL;
493 unsigned long npages = dir_pages(dir);
500 * We take care of directory expansion in the same loop.
501 * This code plays outside i_size, so it locks the page
502 * to protect that region.
504 for (n = 0; n <= npages; n++) {
507 page = ext2_get_page(dir, n, 0);
512 kaddr = page_address(page);
513 dir_end = kaddr + ext2_last_byte(dir, n);
514 de = (ext2_dirent *)kaddr;
515 kaddr += PAGE_SIZE - reclen;
516 while ((char *)de <= kaddr) {
517 if ((char *)de == dir_end) {
520 rec_len = chunk_size;
521 de->rec_len = ext2_rec_len_to_disk(chunk_size);
525 if (de->rec_len == 0) {
526 ext2_error(dir->i_sb, __func__,
527 "zero-length directory entry");
532 if (ext2_match (namelen, name, de))
534 name_len = EXT2_DIR_REC_LEN(de->name_len);
535 rec_len = ext2_rec_len_from_disk(de->rec_len);
536 if (!de->inode && rec_len >= reclen)
538 if (rec_len >= name_len + reclen)
540 de = (ext2_dirent *) ((char *) de + rec_len);
549 pos = page_offset(page) +
550 (char*)de - (char*)page_address(page);
551 err = ext2_prepare_chunk(page, pos, rec_len);
555 ext2_dirent *de1 = (ext2_dirent *) ((char *) de + name_len);
556 de1->rec_len = ext2_rec_len_to_disk(rec_len - name_len);
557 de->rec_len = ext2_rec_len_to_disk(name_len);
560 de->name_len = namelen;
561 memcpy(de->name, name, namelen);
562 de->inode = cpu_to_le32(inode->i_ino);
563 ext2_set_de_type (de, inode);
564 err = ext2_commit_chunk(page, pos, rec_len);
565 dir->i_mtime = dir->i_ctime = current_time(dir);
566 EXT2_I(dir)->i_flags &= ~EXT2_BTREE_FL;
567 mark_inode_dirty(dir);
579 * ext2_delete_entry deletes a directory entry by merging it with the
580 * previous entry. Page is up-to-date. Releases the page.
582 int ext2_delete_entry (struct ext2_dir_entry_2 * dir, struct page * page )
584 struct inode *inode = page->mapping->host;
585 char *kaddr = page_address(page);
586 unsigned from = ((char*)dir - kaddr) & ~(ext2_chunk_size(inode)-1);
587 unsigned to = ((char *)dir - kaddr) +
588 ext2_rec_len_from_disk(dir->rec_len);
590 ext2_dirent * pde = NULL;
591 ext2_dirent * de = (ext2_dirent *) (kaddr + from);
594 while ((char*)de < (char*)dir) {
595 if (de->rec_len == 0) {
596 ext2_error(inode->i_sb, __func__,
597 "zero-length directory entry");
602 de = ext2_next_entry(de);
605 from = (char*)pde - (char*)page_address(page);
606 pos = page_offset(page) + from;
608 err = ext2_prepare_chunk(page, pos, to - from);
611 pde->rec_len = ext2_rec_len_to_disk(to - from);
613 err = ext2_commit_chunk(page, pos, to - from);
614 inode->i_ctime = inode->i_mtime = current_time(inode);
615 EXT2_I(inode)->i_flags &= ~EXT2_BTREE_FL;
616 mark_inode_dirty(inode);
623 * Set the first fragment of directory.
625 int ext2_make_empty(struct inode *inode, struct inode *parent)
627 struct page *page = grab_cache_page(inode->i_mapping, 0);
628 unsigned chunk_size = ext2_chunk_size(inode);
629 struct ext2_dir_entry_2 * de;
636 err = ext2_prepare_chunk(page, 0, chunk_size);
641 kaddr = kmap_atomic(page);
642 memset(kaddr, 0, chunk_size);
643 de = (struct ext2_dir_entry_2 *)kaddr;
645 de->rec_len = ext2_rec_len_to_disk(EXT2_DIR_REC_LEN(1));
646 memcpy (de->name, ".\0\0", 4);
647 de->inode = cpu_to_le32(inode->i_ino);
648 ext2_set_de_type (de, inode);
650 de = (struct ext2_dir_entry_2 *)(kaddr + EXT2_DIR_REC_LEN(1));
652 de->rec_len = ext2_rec_len_to_disk(chunk_size - EXT2_DIR_REC_LEN(1));
653 de->inode = cpu_to_le32(parent->i_ino);
654 memcpy (de->name, "..\0", 4);
655 ext2_set_de_type (de, inode);
656 kunmap_atomic(kaddr);
657 err = ext2_commit_chunk(page, 0, chunk_size);
664 * routine to check that the specified directory is empty (for rmdir)
666 int ext2_empty_dir (struct inode * inode)
668 struct page *page = NULL;
669 unsigned long i, npages = dir_pages(inode);
670 int dir_has_error = 0;
672 for (i = 0; i < npages; i++) {
675 page = ext2_get_page(inode, i, dir_has_error);
682 kaddr = page_address(page);
683 de = (ext2_dirent *)kaddr;
684 kaddr += ext2_last_byte(inode, i) - EXT2_DIR_REC_LEN(1);
686 while ((char *)de <= kaddr) {
687 if (de->rec_len == 0) {
688 ext2_error(inode->i_sb, __func__,
689 "zero-length directory entry");
690 printk("kaddr=%p, de=%p\n", kaddr, de);
693 if (de->inode != 0) {
694 /* check for . and .. */
695 if (de->name[0] != '.')
697 if (de->name_len > 2)
699 if (de->name_len < 2) {
701 cpu_to_le32(inode->i_ino))
703 } else if (de->name[1] != '.')
706 de = ext2_next_entry(de);
717 const struct file_operations ext2_dir_operations = {
718 .llseek = generic_file_llseek,
719 .read = generic_read_dir,
720 .iterate_shared = ext2_readdir,
721 .unlocked_ioctl = ext2_ioctl,
723 .compat_ioctl = ext2_compat_ioctl,