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/pagemap.h>
27 typedef struct ext2_dir_entry_2 ext2_dirent
;
30 * ext2 uses block-sized chunks. Arguably, sector-sized ones would be
31 * more robust, but we have what we have
33 static inline unsigned ext2_chunk_size(struct inode
*inode
)
35 return inode
->i_sb
->s_blocksize
;
38 static inline void ext2_put_page(struct page
*page
)
41 page_cache_release(page
);
44 static inline unsigned long dir_pages(struct inode
*inode
)
46 return (inode
->i_size
+PAGE_CACHE_SIZE
-1)>>PAGE_CACHE_SHIFT
;
50 * Return the offset into page `page_nr' of the last valid
51 * byte in that page, plus one.
54 ext2_last_byte(struct inode
*inode
, unsigned long page_nr
)
56 unsigned last_byte
= inode
->i_size
;
58 last_byte
-= page_nr
<< PAGE_CACHE_SHIFT
;
59 if (last_byte
> PAGE_CACHE_SIZE
)
60 last_byte
= PAGE_CACHE_SIZE
;
64 static int ext2_commit_chunk(struct page
*page
, unsigned from
, unsigned to
)
66 struct inode
*dir
= page
->mapping
->host
;
69 page
->mapping
->a_ops
->commit_write(NULL
, page
, from
, to
);
71 err
= write_one_page(page
, 1);
77 static void ext2_check_page(struct page
*page
)
79 struct inode
*dir
= page
->mapping
->host
;
80 struct super_block
*sb
= dir
->i_sb
;
81 unsigned chunk_size
= ext2_chunk_size(dir
);
82 char *kaddr
= page_address(page
);
83 u32 max_inumber
= le32_to_cpu(EXT2_SB(sb
)->s_es
->s_inodes_count
);
84 unsigned offs
, rec_len
;
85 unsigned limit
= PAGE_CACHE_SIZE
;
89 if ((dir
->i_size
>> PAGE_CACHE_SHIFT
) == page
->index
) {
90 limit
= dir
->i_size
& ~PAGE_CACHE_MASK
;
91 if (limit
& (chunk_size
- 1))
96 for (offs
= 0; offs
<= limit
- EXT2_DIR_REC_LEN(1); offs
+= rec_len
) {
97 p
= (ext2_dirent
*)(kaddr
+ offs
);
98 rec_len
= le16_to_cpu(p
->rec_len
);
100 if (rec_len
< EXT2_DIR_REC_LEN(1))
104 if (rec_len
< EXT2_DIR_REC_LEN(p
->name_len
))
106 if (((offs
+ rec_len
- 1) ^ offs
) & ~(chunk_size
-1))
108 if (le32_to_cpu(p
->inode
) > max_inumber
)
114 SetPageChecked(page
);
117 /* Too bad, we had an error */
120 ext2_error(sb
, "ext2_check_page",
121 "size of directory #%lu is not a multiple of chunk size",
126 error
= "rec_len is smaller than minimal";
129 error
= "unaligned directory entry";
132 error
= "rec_len is too small for name_len";
135 error
= "directory entry across blocks";
138 error
= "inode out of bounds";
140 ext2_error (sb
, "ext2_check_page", "bad entry in directory #%lu: %s - "
141 "offset=%lu, inode=%lu, rec_len=%d, name_len=%d",
142 dir
->i_ino
, error
, (page
->index
<<PAGE_CACHE_SHIFT
)+offs
,
143 (unsigned long) le32_to_cpu(p
->inode
),
144 rec_len
, p
->name_len
);
147 p
= (ext2_dirent
*)(kaddr
+ offs
);
148 ext2_error (sb
, "ext2_check_page",
149 "entry in directory #%lu spans the page boundary"
150 "offset=%lu, inode=%lu",
151 dir
->i_ino
, (page
->index
<<PAGE_CACHE_SHIFT
)+offs
,
152 (unsigned long) le32_to_cpu(p
->inode
));
154 SetPageChecked(page
);
158 static struct page
* ext2_get_page(struct inode
*dir
, unsigned long n
)
160 struct address_space
*mapping
= dir
->i_mapping
;
161 struct page
*page
= read_mapping_page(mapping
, n
, NULL
);
164 if (!PageChecked(page
))
165 ext2_check_page(page
);
173 return ERR_PTR(-EIO
);
177 * NOTE! unlike strncmp, ext2_match returns 1 for success, 0 for failure.
179 * len <= EXT2_NAME_LEN and de != NULL are guaranteed by caller.
181 static inline int ext2_match (int len
, const char * const name
,
182 struct ext2_dir_entry_2
* de
)
184 if (len
!= de
->name_len
)
188 return !memcmp(name
, de
->name
, len
);
192 * p is at least 6 bytes before the end of page
194 static inline ext2_dirent
*ext2_next_entry(ext2_dirent
*p
)
196 return (ext2_dirent
*)((char*)p
+ le16_to_cpu(p
->rec_len
));
199 static inline unsigned
200 ext2_validate_entry(char *base
, unsigned offset
, unsigned mask
)
202 ext2_dirent
*de
= (ext2_dirent
*)(base
+ offset
);
203 ext2_dirent
*p
= (ext2_dirent
*)(base
+ (offset
&mask
));
204 while ((char*)p
< (char*)de
) {
207 p
= ext2_next_entry(p
);
209 return (char *)p
- base
;
212 static unsigned char ext2_filetype_table
[EXT2_FT_MAX
] = {
213 [EXT2_FT_UNKNOWN
] = DT_UNKNOWN
,
214 [EXT2_FT_REG_FILE
] = DT_REG
,
215 [EXT2_FT_DIR
] = DT_DIR
,
216 [EXT2_FT_CHRDEV
] = DT_CHR
,
217 [EXT2_FT_BLKDEV
] = DT_BLK
,
218 [EXT2_FT_FIFO
] = DT_FIFO
,
219 [EXT2_FT_SOCK
] = DT_SOCK
,
220 [EXT2_FT_SYMLINK
] = DT_LNK
,
224 static unsigned char ext2_type_by_mode
[S_IFMT
>> S_SHIFT
] = {
225 [S_IFREG
>> S_SHIFT
] = EXT2_FT_REG_FILE
,
226 [S_IFDIR
>> S_SHIFT
] = EXT2_FT_DIR
,
227 [S_IFCHR
>> S_SHIFT
] = EXT2_FT_CHRDEV
,
228 [S_IFBLK
>> S_SHIFT
] = EXT2_FT_BLKDEV
,
229 [S_IFIFO
>> S_SHIFT
] = EXT2_FT_FIFO
,
230 [S_IFSOCK
>> S_SHIFT
] = EXT2_FT_SOCK
,
231 [S_IFLNK
>> S_SHIFT
] = EXT2_FT_SYMLINK
,
234 static inline void ext2_set_de_type(ext2_dirent
*de
, struct inode
*inode
)
236 mode_t mode
= inode
->i_mode
;
237 if (EXT2_HAS_INCOMPAT_FEATURE(inode
->i_sb
, EXT2_FEATURE_INCOMPAT_FILETYPE
))
238 de
->file_type
= ext2_type_by_mode
[(mode
& S_IFMT
)>>S_SHIFT
];
244 ext2_readdir (struct file
* filp
, void * dirent
, filldir_t filldir
)
246 loff_t pos
= filp
->f_pos
;
247 struct inode
*inode
= filp
->f_path
.dentry
->d_inode
;
248 struct super_block
*sb
= inode
->i_sb
;
249 unsigned int offset
= pos
& ~PAGE_CACHE_MASK
;
250 unsigned long n
= pos
>> PAGE_CACHE_SHIFT
;
251 unsigned long npages
= dir_pages(inode
);
252 unsigned chunk_mask
= ~(ext2_chunk_size(inode
)-1);
253 unsigned char *types
= NULL
;
254 int need_revalidate
= filp
->f_version
!= inode
->i_version
;
256 if (pos
> inode
->i_size
- EXT2_DIR_REC_LEN(1))
259 if (EXT2_HAS_INCOMPAT_FEATURE(sb
, EXT2_FEATURE_INCOMPAT_FILETYPE
))
260 types
= ext2_filetype_table
;
262 for ( ; n
< npages
; n
++, offset
= 0) {
265 struct page
*page
= ext2_get_page(inode
, n
);
268 ext2_error(sb
, __FUNCTION__
,
271 filp
->f_pos
+= PAGE_CACHE_SIZE
- offset
;
274 kaddr
= page_address(page
);
275 if (unlikely(need_revalidate
)) {
277 offset
= ext2_validate_entry(kaddr
, offset
, chunk_mask
);
278 filp
->f_pos
= (n
<<PAGE_CACHE_SHIFT
) + offset
;
280 filp
->f_version
= inode
->i_version
;
283 de
= (ext2_dirent
*)(kaddr
+offset
);
284 limit
= kaddr
+ ext2_last_byte(inode
, n
) - EXT2_DIR_REC_LEN(1);
285 for ( ;(char*)de
<= limit
; de
= ext2_next_entry(de
)) {
286 if (de
->rec_len
== 0) {
287 ext2_error(sb
, __FUNCTION__
,
288 "zero-length directory entry");
294 unsigned char d_type
= DT_UNKNOWN
;
296 if (types
&& de
->file_type
< EXT2_FT_MAX
)
297 d_type
= types
[de
->file_type
];
299 offset
= (char *)de
- kaddr
;
300 over
= filldir(dirent
, de
->name
, de
->name_len
,
301 (n
<<PAGE_CACHE_SHIFT
) | offset
,
302 le32_to_cpu(de
->inode
), d_type
);
308 filp
->f_pos
+= le16_to_cpu(de
->rec_len
);
318 * finds an entry in the specified directory with the wanted name. It
319 * returns the page in which the entry was found, and the entry itself
320 * (as a parameter - res_dir). Page is returned mapped and unlocked.
321 * Entry is guaranteed to be valid.
323 struct ext2_dir_entry_2
* ext2_find_entry (struct inode
* dir
,
324 struct dentry
*dentry
, struct page
** res_page
)
326 const char *name
= dentry
->d_name
.name
;
327 int namelen
= dentry
->d_name
.len
;
328 unsigned reclen
= EXT2_DIR_REC_LEN(namelen
);
329 unsigned long start
, n
;
330 unsigned long npages
= dir_pages(dir
);
331 struct page
*page
= NULL
;
332 struct ext2_inode_info
*ei
= EXT2_I(dir
);
341 start
= ei
->i_dir_start_lookup
;
347 page
= ext2_get_page(dir
, n
);
349 kaddr
= page_address(page
);
350 de
= (ext2_dirent
*) kaddr
;
351 kaddr
+= ext2_last_byte(dir
, n
) - reclen
;
352 while ((char *) de
<= kaddr
) {
353 if (de
->rec_len
== 0) {
354 ext2_error(dir
->i_sb
, __FUNCTION__
,
355 "zero-length directory entry");
359 if (ext2_match (namelen
, name
, de
))
361 de
= ext2_next_entry(de
);
367 /* next page is past the blocks we've got */
368 if (unlikely(n
> (dir
->i_blocks
>> (PAGE_CACHE_SHIFT
- 9)))) {
369 ext2_error(dir
->i_sb
, __FUNCTION__
,
370 "dir %lu size %lld exceeds block count %llu",
371 dir
->i_ino
, dir
->i_size
,
372 (unsigned long long)dir
->i_blocks
);
375 } while (n
!= start
);
381 ei
->i_dir_start_lookup
= n
;
385 struct ext2_dir_entry_2
* ext2_dotdot (struct inode
*dir
, struct page
**p
)
387 struct page
*page
= ext2_get_page(dir
, 0);
388 ext2_dirent
*de
= NULL
;
391 de
= ext2_next_entry((ext2_dirent
*) page_address(page
));
397 ino_t
ext2_inode_by_name(struct inode
* dir
, struct dentry
*dentry
)
400 struct ext2_dir_entry_2
* de
;
403 de
= ext2_find_entry (dir
, dentry
, &page
);
405 res
= le32_to_cpu(de
->inode
);
411 /* Releases the page */
412 void ext2_set_link(struct inode
*dir
, struct ext2_dir_entry_2
*de
,
413 struct page
*page
, struct inode
*inode
)
415 unsigned from
= (char *) de
- (char *) page_address(page
);
416 unsigned to
= from
+ le16_to_cpu(de
->rec_len
);
420 err
= page
->mapping
->a_ops
->prepare_write(NULL
, page
, from
, to
);
422 de
->inode
= cpu_to_le32(inode
->i_ino
);
423 ext2_set_de_type (de
, inode
);
424 err
= ext2_commit_chunk(page
, from
, to
);
426 dir
->i_mtime
= dir
->i_ctime
= CURRENT_TIME_SEC
;
427 EXT2_I(dir
)->i_flags
&= ~EXT2_BTREE_FL
;
428 mark_inode_dirty(dir
);
434 int ext2_add_link (struct dentry
*dentry
, struct inode
*inode
)
436 struct inode
*dir
= dentry
->d_parent
->d_inode
;
437 const char *name
= dentry
->d_name
.name
;
438 int namelen
= dentry
->d_name
.len
;
439 unsigned chunk_size
= ext2_chunk_size(dir
);
440 unsigned reclen
= EXT2_DIR_REC_LEN(namelen
);
441 unsigned short rec_len
, name_len
;
442 struct page
*page
= NULL
;
444 unsigned long npages
= dir_pages(dir
);
451 * We take care of directory expansion in the same loop.
452 * This code plays outside i_size, so it locks the page
453 * to protect that region.
455 for (n
= 0; n
<= npages
; n
++) {
458 page
= ext2_get_page(dir
, n
);
463 kaddr
= page_address(page
);
464 dir_end
= kaddr
+ ext2_last_byte(dir
, n
);
465 de
= (ext2_dirent
*)kaddr
;
466 kaddr
+= PAGE_CACHE_SIZE
- reclen
;
467 while ((char *)de
<= kaddr
) {
468 if ((char *)de
== dir_end
) {
471 rec_len
= chunk_size
;
472 de
->rec_len
= cpu_to_le16(chunk_size
);
476 if (de
->rec_len
== 0) {
477 ext2_error(dir
->i_sb
, __FUNCTION__
,
478 "zero-length directory entry");
483 if (ext2_match (namelen
, name
, de
))
485 name_len
= EXT2_DIR_REC_LEN(de
->name_len
);
486 rec_len
= le16_to_cpu(de
->rec_len
);
487 if (!de
->inode
&& rec_len
>= reclen
)
489 if (rec_len
>= name_len
+ reclen
)
491 de
= (ext2_dirent
*) ((char *) de
+ rec_len
);
500 from
= (char*)de
- (char*)page_address(page
);
502 err
= page
->mapping
->a_ops
->prepare_write(NULL
, page
, from
, to
);
506 ext2_dirent
*de1
= (ext2_dirent
*) ((char *) de
+ name_len
);
507 de1
->rec_len
= cpu_to_le16(rec_len
- name_len
);
508 de
->rec_len
= cpu_to_le16(name_len
);
511 de
->name_len
= namelen
;
512 memcpy (de
->name
, name
, namelen
);
513 de
->inode
= cpu_to_le32(inode
->i_ino
);
514 ext2_set_de_type (de
, inode
);
515 err
= ext2_commit_chunk(page
, from
, to
);
516 dir
->i_mtime
= dir
->i_ctime
= CURRENT_TIME_SEC
;
517 EXT2_I(dir
)->i_flags
&= ~EXT2_BTREE_FL
;
518 mark_inode_dirty(dir
);
530 * ext2_delete_entry deletes a directory entry by merging it with the
531 * previous entry. Page is up-to-date. Releases the page.
533 int ext2_delete_entry (struct ext2_dir_entry_2
* dir
, struct page
* page
)
535 struct address_space
*mapping
= page
->mapping
;
536 struct inode
*inode
= mapping
->host
;
537 char *kaddr
= page_address(page
);
538 unsigned from
= ((char*)dir
- kaddr
) & ~(ext2_chunk_size(inode
)-1);
539 unsigned to
= ((char*)dir
- kaddr
) + le16_to_cpu(dir
->rec_len
);
540 ext2_dirent
* pde
= NULL
;
541 ext2_dirent
* de
= (ext2_dirent
*) (kaddr
+ from
);
544 while ((char*)de
< (char*)dir
) {
545 if (de
->rec_len
== 0) {
546 ext2_error(inode
->i_sb
, __FUNCTION__
,
547 "zero-length directory entry");
552 de
= ext2_next_entry(de
);
555 from
= (char*)pde
- (char*)page_address(page
);
557 err
= mapping
->a_ops
->prepare_write(NULL
, page
, from
, to
);
560 pde
->rec_len
= cpu_to_le16(to
-from
);
562 err
= ext2_commit_chunk(page
, from
, to
);
563 inode
->i_ctime
= inode
->i_mtime
= CURRENT_TIME_SEC
;
564 EXT2_I(inode
)->i_flags
&= ~EXT2_BTREE_FL
;
565 mark_inode_dirty(inode
);
572 * Set the first fragment of directory.
574 int ext2_make_empty(struct inode
*inode
, struct inode
*parent
)
576 struct address_space
*mapping
= inode
->i_mapping
;
577 struct page
*page
= grab_cache_page(mapping
, 0);
578 unsigned chunk_size
= ext2_chunk_size(inode
);
579 struct ext2_dir_entry_2
* de
;
585 err
= mapping
->a_ops
->prepare_write(NULL
, page
, 0, chunk_size
);
590 kaddr
= kmap_atomic(page
, KM_USER0
);
591 memset(kaddr
, 0, chunk_size
);
592 de
= (struct ext2_dir_entry_2
*)kaddr
;
594 de
->rec_len
= cpu_to_le16(EXT2_DIR_REC_LEN(1));
595 memcpy (de
->name
, ".\0\0", 4);
596 de
->inode
= cpu_to_le32(inode
->i_ino
);
597 ext2_set_de_type (de
, inode
);
599 de
= (struct ext2_dir_entry_2
*)(kaddr
+ EXT2_DIR_REC_LEN(1));
601 de
->rec_len
= cpu_to_le16(chunk_size
- EXT2_DIR_REC_LEN(1));
602 de
->inode
= cpu_to_le32(parent
->i_ino
);
603 memcpy (de
->name
, "..\0", 4);
604 ext2_set_de_type (de
, inode
);
605 kunmap_atomic(kaddr
, KM_USER0
);
606 err
= ext2_commit_chunk(page
, 0, chunk_size
);
608 page_cache_release(page
);
613 * routine to check that the specified directory is empty (for rmdir)
615 int ext2_empty_dir (struct inode
* inode
)
617 struct page
*page
= NULL
;
618 unsigned long i
, npages
= dir_pages(inode
);
620 for (i
= 0; i
< npages
; i
++) {
623 page
= ext2_get_page(inode
, i
);
628 kaddr
= page_address(page
);
629 de
= (ext2_dirent
*)kaddr
;
630 kaddr
+= ext2_last_byte(inode
, i
) - EXT2_DIR_REC_LEN(1);
632 while ((char *)de
<= kaddr
) {
633 if (de
->rec_len
== 0) {
634 ext2_error(inode
->i_sb
, __FUNCTION__
,
635 "zero-length directory entry");
636 printk("kaddr=%p, de=%p\n", kaddr
, de
);
639 if (de
->inode
!= 0) {
640 /* check for . and .. */
641 if (de
->name
[0] != '.')
643 if (de
->name_len
> 2)
645 if (de
->name_len
< 2) {
647 cpu_to_le32(inode
->i_ino
))
649 } else if (de
->name
[1] != '.')
652 de
= ext2_next_entry(de
);
663 const struct file_operations ext2_dir_operations
= {
664 .llseek
= generic_file_llseek
,
665 .read
= generic_read_dir
,
666 .readdir
= ext2_readdir
,
669 .compat_ioctl
= ext2_compat_ioctl
,
671 .fsync
= ext2_sync_file
,