4 * Copyright (C) 1992, 1993, 1994, 1995
5 * Remy Card (card@masi.ibp.fr)
6 * Laboratoire MASI - Institut Blaise Pascal
7 * Universite Pierre et Marie Curie (Paris VI)
11 * linux/fs/minix/dir.c
13 * Copyright (C) 1991, 1992 Linus Torvalds
15 * ext2 directory handling functions
17 * Big-endian to little-endian byte-swapping/bitmaps by
18 * David S. Miller (davem@caip.rutgers.edu), 1995
20 * All code that works with directory layout had been switched to pagecache
25 #include <linux/buffer_head.h>
26 #include <linux/pagemap.h>
27 #include <linux/swap.h>
29 typedef struct ext2_dir_entry_2 ext2_dirent
;
31 static inline unsigned ext2_rec_len_from_disk(__le16 dlen
)
33 unsigned len
= le16_to_cpu(dlen
);
35 if (len
== EXT2_MAX_REC_LEN
)
40 static inline __le16
ext2_rec_len_to_disk(unsigned len
)
43 return cpu_to_le16(EXT2_MAX_REC_LEN
);
45 BUG_ON(len
> (1 << 16));
46 return cpu_to_le16(len
);
50 * ext2 uses block-sized chunks. Arguably, sector-sized ones would be
51 * more robust, but we have what we have
53 static inline unsigned ext2_chunk_size(struct inode
*inode
)
55 return inode
->i_sb
->s_blocksize
;
58 static inline void ext2_put_page(struct page
*page
)
61 page_cache_release(page
);
64 static inline unsigned long dir_pages(struct inode
*inode
)
66 return (inode
->i_size
+PAGE_CACHE_SIZE
-1)>>PAGE_CACHE_SHIFT
;
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_CACHE_SHIFT
;
79 if (last_byte
> PAGE_CACHE_SIZE
)
80 last_byte
= PAGE_CACHE_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
;
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
, 1);
101 err
= ext2_sync_inode(dir
);
109 static void 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_CACHE_SIZE
;
121 if ((dir
->i_size
>> PAGE_CACHE_SHIFT
) == page
->index
) {
122 limit
= dir
->i_size
& ~PAGE_CACHE_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 (rec_len
< EXT2_DIR_REC_LEN(1))
136 if (rec_len
< EXT2_DIR_REC_LEN(p
->name_len
))
138 if (((offs
+ rec_len
- 1) ^ offs
) & ~(chunk_size
-1))
140 if (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_CACHE_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_CACHE_SHIFT
)+offs
,
186 (unsigned long) le32_to_cpu(p
->inode
));
189 SetPageChecked(page
);
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 (!PageChecked(page
))
201 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 unsigned char ext2_filetype_table
[EXT2_FT_MAX
] = {
250 [EXT2_FT_UNKNOWN
] = DT_UNKNOWN
,
251 [EXT2_FT_REG_FILE
] = DT_REG
,
252 [EXT2_FT_DIR
] = DT_DIR
,
253 [EXT2_FT_CHRDEV
] = DT_CHR
,
254 [EXT2_FT_BLKDEV
] = DT_BLK
,
255 [EXT2_FT_FIFO
] = DT_FIFO
,
256 [EXT2_FT_SOCK
] = DT_SOCK
,
257 [EXT2_FT_SYMLINK
] = DT_LNK
,
261 static unsigned char ext2_type_by_mode
[S_IFMT
>> S_SHIFT
] = {
262 [S_IFREG
>> S_SHIFT
] = EXT2_FT_REG_FILE
,
263 [S_IFDIR
>> S_SHIFT
] = EXT2_FT_DIR
,
264 [S_IFCHR
>> S_SHIFT
] = EXT2_FT_CHRDEV
,
265 [S_IFBLK
>> S_SHIFT
] = EXT2_FT_BLKDEV
,
266 [S_IFIFO
>> S_SHIFT
] = EXT2_FT_FIFO
,
267 [S_IFSOCK
>> S_SHIFT
] = EXT2_FT_SOCK
,
268 [S_IFLNK
>> S_SHIFT
] = EXT2_FT_SYMLINK
,
271 static inline void ext2_set_de_type(ext2_dirent
*de
, struct inode
*inode
)
273 mode_t mode
= inode
->i_mode
;
274 if (EXT2_HAS_INCOMPAT_FEATURE(inode
->i_sb
, EXT2_FEATURE_INCOMPAT_FILETYPE
))
275 de
->file_type
= ext2_type_by_mode
[(mode
& S_IFMT
)>>S_SHIFT
];
281 ext2_readdir (struct file
* filp
, void * dirent
, filldir_t filldir
)
283 loff_t pos
= filp
->f_pos
;
284 struct inode
*inode
= filp
->f_path
.dentry
->d_inode
;
285 struct super_block
*sb
= inode
->i_sb
;
286 unsigned int offset
= pos
& ~PAGE_CACHE_MASK
;
287 unsigned long n
= pos
>> PAGE_CACHE_SHIFT
;
288 unsigned long npages
= dir_pages(inode
);
289 unsigned chunk_mask
= ~(ext2_chunk_size(inode
)-1);
290 unsigned char *types
= NULL
;
291 int need_revalidate
= filp
->f_version
!= inode
->i_version
;
293 if (pos
> inode
->i_size
- EXT2_DIR_REC_LEN(1))
296 if (EXT2_HAS_INCOMPAT_FEATURE(sb
, EXT2_FEATURE_INCOMPAT_FILETYPE
))
297 types
= ext2_filetype_table
;
299 for ( ; n
< npages
; n
++, offset
= 0) {
302 struct page
*page
= ext2_get_page(inode
, n
, 0);
305 ext2_error(sb
, __func__
,
308 filp
->f_pos
+= PAGE_CACHE_SIZE
- offset
;
309 return PTR_ERR(page
);
311 kaddr
= page_address(page
);
312 if (unlikely(need_revalidate
)) {
314 offset
= ext2_validate_entry(kaddr
, offset
, chunk_mask
);
315 filp
->f_pos
= (n
<<PAGE_CACHE_SHIFT
) + offset
;
317 filp
->f_version
= inode
->i_version
;
320 de
= (ext2_dirent
*)(kaddr
+offset
);
321 limit
= kaddr
+ ext2_last_byte(inode
, n
) - EXT2_DIR_REC_LEN(1);
322 for ( ;(char*)de
<= limit
; de
= ext2_next_entry(de
)) {
323 if (de
->rec_len
== 0) {
324 ext2_error(sb
, __func__
,
325 "zero-length directory entry");
331 unsigned char d_type
= DT_UNKNOWN
;
333 if (types
&& de
->file_type
< EXT2_FT_MAX
)
334 d_type
= types
[de
->file_type
];
336 offset
= (char *)de
- kaddr
;
337 over
= filldir(dirent
, de
->name
, de
->name_len
,
338 (n
<<PAGE_CACHE_SHIFT
) | offset
,
339 le32_to_cpu(de
->inode
), d_type
);
345 filp
->f_pos
+= ext2_rec_len_from_disk(de
->rec_len
);
355 * finds an entry in the specified directory with the wanted name. It
356 * returns the page in which the entry was found (as a parameter - res_page),
357 * and the entry itself. Page is returned mapped and unlocked.
358 * Entry is guaranteed to be valid.
360 struct ext2_dir_entry_2
*ext2_find_entry (struct inode
* dir
,
361 struct qstr
*child
, struct page
** res_page
)
363 const char *name
= child
->name
;
364 int namelen
= child
->len
;
365 unsigned reclen
= EXT2_DIR_REC_LEN(namelen
);
366 unsigned long start
, n
;
367 unsigned long npages
= dir_pages(dir
);
368 struct page
*page
= NULL
;
369 struct ext2_inode_info
*ei
= EXT2_I(dir
);
371 int dir_has_error
= 0;
379 start
= ei
->i_dir_start_lookup
;
385 page
= ext2_get_page(dir
, n
, dir_has_error
);
387 kaddr
= page_address(page
);
388 de
= (ext2_dirent
*) kaddr
;
389 kaddr
+= ext2_last_byte(dir
, n
) - reclen
;
390 while ((char *) de
<= kaddr
) {
391 if (de
->rec_len
== 0) {
392 ext2_error(dir
->i_sb
, __func__
,
393 "zero-length directory entry");
397 if (ext2_match (namelen
, name
, de
))
399 de
= ext2_next_entry(de
);
407 /* next page is past the blocks we've got */
408 if (unlikely(n
> (dir
->i_blocks
>> (PAGE_CACHE_SHIFT
- 9)))) {
409 ext2_error(dir
->i_sb
, __func__
,
410 "dir %lu size %lld exceeds block count %llu",
411 dir
->i_ino
, dir
->i_size
,
412 (unsigned long long)dir
->i_blocks
);
415 } while (n
!= start
);
421 ei
->i_dir_start_lookup
= n
;
425 struct ext2_dir_entry_2
* ext2_dotdot (struct inode
*dir
, struct page
**p
)
427 struct page
*page
= ext2_get_page(dir
, 0, 0);
428 ext2_dirent
*de
= NULL
;
431 de
= ext2_next_entry((ext2_dirent
*) page_address(page
));
437 ino_t
ext2_inode_by_name(struct inode
*dir
, struct qstr
*child
)
440 struct ext2_dir_entry_2
*de
;
443 de
= ext2_find_entry (dir
, child
, &page
);
445 res
= le32_to_cpu(de
->inode
);
451 static int ext2_prepare_chunk(struct page
*page
, loff_t pos
, unsigned len
)
453 return __block_write_begin(page
, pos
, len
, ext2_get_block
);
456 /* Releases the page */
457 void ext2_set_link(struct inode
*dir
, struct ext2_dir_entry_2
*de
,
458 struct page
*page
, struct inode
*inode
, int update_times
)
460 loff_t pos
= page_offset(page
) +
461 (char *) de
- (char *) page_address(page
);
462 unsigned len
= ext2_rec_len_from_disk(de
->rec_len
);
466 err
= ext2_prepare_chunk(page
, pos
, len
);
468 de
->inode
= cpu_to_le32(inode
->i_ino
);
469 ext2_set_de_type(de
, inode
);
470 err
= ext2_commit_chunk(page
, pos
, len
);
473 dir
->i_mtime
= dir
->i_ctime
= CURRENT_TIME_SEC
;
474 EXT2_I(dir
)->i_flags
&= ~EXT2_BTREE_FL
;
475 mark_inode_dirty(dir
);
481 int ext2_add_link (struct dentry
*dentry
, struct inode
*inode
)
483 struct inode
*dir
= dentry
->d_parent
->d_inode
;
484 const char *name
= dentry
->d_name
.name
;
485 int namelen
= dentry
->d_name
.len
;
486 unsigned chunk_size
= ext2_chunk_size(dir
);
487 unsigned reclen
= EXT2_DIR_REC_LEN(namelen
);
488 unsigned short rec_len
, name_len
;
489 struct page
*page
= NULL
;
491 unsigned long npages
= dir_pages(dir
);
498 * We take care of directory expansion in the same loop.
499 * This code plays outside i_size, so it locks the page
500 * to protect that region.
502 for (n
= 0; n
<= npages
; n
++) {
505 page
= ext2_get_page(dir
, n
, 0);
510 kaddr
= page_address(page
);
511 dir_end
= kaddr
+ ext2_last_byte(dir
, n
);
512 de
= (ext2_dirent
*)kaddr
;
513 kaddr
+= PAGE_CACHE_SIZE
- reclen
;
514 while ((char *)de
<= kaddr
) {
515 if ((char *)de
== dir_end
) {
518 rec_len
= chunk_size
;
519 de
->rec_len
= ext2_rec_len_to_disk(chunk_size
);
523 if (de
->rec_len
== 0) {
524 ext2_error(dir
->i_sb
, __func__
,
525 "zero-length directory entry");
530 if (ext2_match (namelen
, name
, de
))
532 name_len
= EXT2_DIR_REC_LEN(de
->name_len
);
533 rec_len
= ext2_rec_len_from_disk(de
->rec_len
);
534 if (!de
->inode
&& rec_len
>= reclen
)
536 if (rec_len
>= name_len
+ reclen
)
538 de
= (ext2_dirent
*) ((char *) de
+ rec_len
);
547 pos
= page_offset(page
) +
548 (char*)de
- (char*)page_address(page
);
549 err
= ext2_prepare_chunk(page
, pos
, rec_len
);
553 ext2_dirent
*de1
= (ext2_dirent
*) ((char *) de
+ name_len
);
554 de1
->rec_len
= ext2_rec_len_to_disk(rec_len
- name_len
);
555 de
->rec_len
= ext2_rec_len_to_disk(name_len
);
558 de
->name_len
= namelen
;
559 memcpy(de
->name
, name
, namelen
);
560 de
->inode
= cpu_to_le32(inode
->i_ino
);
561 ext2_set_de_type (de
, inode
);
562 err
= ext2_commit_chunk(page
, pos
, rec_len
);
563 dir
->i_mtime
= dir
->i_ctime
= CURRENT_TIME_SEC
;
564 EXT2_I(dir
)->i_flags
&= ~EXT2_BTREE_FL
;
565 mark_inode_dirty(dir
);
577 * ext2_delete_entry deletes a directory entry by merging it with the
578 * previous entry. Page is up-to-date. Releases the page.
580 int ext2_delete_entry (struct ext2_dir_entry_2
* dir
, struct page
* page
)
582 struct inode
*inode
= page
->mapping
->host
;
583 char *kaddr
= page_address(page
);
584 unsigned from
= ((char*)dir
- kaddr
) & ~(ext2_chunk_size(inode
)-1);
585 unsigned to
= ((char *)dir
- kaddr
) +
586 ext2_rec_len_from_disk(dir
->rec_len
);
588 ext2_dirent
* pde
= NULL
;
589 ext2_dirent
* de
= (ext2_dirent
*) (kaddr
+ from
);
592 while ((char*)de
< (char*)dir
) {
593 if (de
->rec_len
== 0) {
594 ext2_error(inode
->i_sb
, __func__
,
595 "zero-length directory entry");
600 de
= ext2_next_entry(de
);
603 from
= (char*)pde
- (char*)page_address(page
);
604 pos
= page_offset(page
) + from
;
606 err
= ext2_prepare_chunk(page
, pos
, to
- from
);
609 pde
->rec_len
= ext2_rec_len_to_disk(to
- from
);
611 err
= ext2_commit_chunk(page
, pos
, to
- from
);
612 inode
->i_ctime
= inode
->i_mtime
= CURRENT_TIME_SEC
;
613 EXT2_I(inode
)->i_flags
&= ~EXT2_BTREE_FL
;
614 mark_inode_dirty(inode
);
621 * Set the first fragment of directory.
623 int ext2_make_empty(struct inode
*inode
, struct inode
*parent
)
625 struct page
*page
= grab_cache_page(inode
->i_mapping
, 0);
626 unsigned chunk_size
= ext2_chunk_size(inode
);
627 struct ext2_dir_entry_2
* de
;
634 err
= ext2_prepare_chunk(page
, 0, chunk_size
);
639 kaddr
= kmap_atomic(page
, KM_USER0
);
640 memset(kaddr
, 0, chunk_size
);
641 de
= (struct ext2_dir_entry_2
*)kaddr
;
643 de
->rec_len
= ext2_rec_len_to_disk(EXT2_DIR_REC_LEN(1));
644 memcpy (de
->name
, ".\0\0", 4);
645 de
->inode
= cpu_to_le32(inode
->i_ino
);
646 ext2_set_de_type (de
, inode
);
648 de
= (struct ext2_dir_entry_2
*)(kaddr
+ EXT2_DIR_REC_LEN(1));
650 de
->rec_len
= ext2_rec_len_to_disk(chunk_size
- EXT2_DIR_REC_LEN(1));
651 de
->inode
= cpu_to_le32(parent
->i_ino
);
652 memcpy (de
->name
, "..\0", 4);
653 ext2_set_de_type (de
, inode
);
654 kunmap_atomic(kaddr
, KM_USER0
);
655 err
= ext2_commit_chunk(page
, 0, chunk_size
);
657 page_cache_release(page
);
662 * routine to check that the specified directory is empty (for rmdir)
664 int ext2_empty_dir (struct inode
* inode
)
666 struct page
*page
= NULL
;
667 unsigned long i
, npages
= dir_pages(inode
);
668 int dir_has_error
= 0;
670 for (i
= 0; i
< npages
; i
++) {
673 page
= ext2_get_page(inode
, i
, dir_has_error
);
680 kaddr
= page_address(page
);
681 de
= (ext2_dirent
*)kaddr
;
682 kaddr
+= ext2_last_byte(inode
, i
) - EXT2_DIR_REC_LEN(1);
684 while ((char *)de
<= kaddr
) {
685 if (de
->rec_len
== 0) {
686 ext2_error(inode
->i_sb
, __func__
,
687 "zero-length directory entry");
688 printk("kaddr=%p, de=%p\n", kaddr
, de
);
691 if (de
->inode
!= 0) {
692 /* check for . and .. */
693 if (de
->name
[0] != '.')
695 if (de
->name_len
> 2)
697 if (de
->name_len
< 2) {
699 cpu_to_le32(inode
->i_ino
))
701 } else if (de
->name
[1] != '.')
704 de
= ext2_next_entry(de
);
715 const struct file_operations ext2_dir_operations
= {
716 .llseek
= generic_file_llseek
,
717 .read
= generic_read_dir
,
718 .readdir
= ext2_readdir
,
719 .unlocked_ioctl
= ext2_ioctl
,
721 .compat_ioctl
= ext2_compat_ioctl
,