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 * ext4 directory handling functions
17 * Big-endian to little-endian byte-swapping/bitmaps by
18 * David S. Miller (davem@caip.rutgers.edu), 1995
20 * Hash Tree Directory indexing (c) 2001 Daniel Phillips
25 #include <linux/buffer_head.h>
26 #include <linux/slab.h>
30 static int ext4_dx_readdir(struct file
*, struct dir_context
*);
33 * Check if the given dir-inode refers to an htree-indexed directory
34 * (or a directory which could potentially get converted to use htree
37 * Return 1 if it is a dx dir, 0 if not
39 static int is_dx_dir(struct inode
*inode
)
41 struct super_block
*sb
= inode
->i_sb
;
43 if (ext4_has_feature_dir_index(inode
->i_sb
) &&
44 ((ext4_test_inode_flag(inode
, EXT4_INODE_INDEX
)) ||
45 ((inode
->i_size
>> sb
->s_blocksize_bits
) == 1) ||
46 ext4_has_inline_data(inode
)))
53 * Return 0 if the directory entry is OK, and 1 if there is a problem
55 * Note: this is the opposite of what ext2 and ext3 historically returned...
57 * bh passed here can be an inode block or a dir data block, depending
58 * on the inode inline data flag.
60 int __ext4_check_dir_entry(const char *function
, unsigned int line
,
61 struct inode
*dir
, struct file
*filp
,
62 struct ext4_dir_entry_2
*de
,
63 struct buffer_head
*bh
, char *buf
, int size
,
66 const char *error_msg
= NULL
;
67 const int rlen
= ext4_rec_len_from_disk(de
->rec_len
,
68 dir
->i_sb
->s_blocksize
);
70 if (unlikely(rlen
< EXT4_DIR_REC_LEN(1)))
71 error_msg
= "rec_len is smaller than minimal";
72 else if (unlikely(rlen
% 4 != 0))
73 error_msg
= "rec_len % 4 != 0";
74 else if (unlikely(rlen
< EXT4_DIR_REC_LEN(de
->name_len
)))
75 error_msg
= "rec_len is too small for name_len";
76 else if (unlikely(((char *) de
- buf
) + rlen
> size
))
77 error_msg
= "directory entry across range";
78 else if (unlikely(le32_to_cpu(de
->inode
) >
79 le32_to_cpu(EXT4_SB(dir
->i_sb
)->s_es
->s_inodes_count
)))
80 error_msg
= "inode out of bounds";
85 ext4_error_file(filp
, function
, line
, bh
->b_blocknr
,
86 "bad entry in directory: %s - offset=%u(%u), "
87 "inode=%u, rec_len=%d, name_len=%d",
88 error_msg
, (unsigned) (offset
% size
),
89 offset
, le32_to_cpu(de
->inode
),
92 ext4_error_inode(dir
, function
, line
, bh
->b_blocknr
,
93 "bad entry in directory: %s - offset=%u(%u), "
94 "inode=%u, rec_len=%d, name_len=%d",
95 error_msg
, (unsigned) (offset
% size
),
96 offset
, le32_to_cpu(de
->inode
),
102 static int ext4_readdir(struct file
*file
, struct dir_context
*ctx
)
106 struct ext4_dir_entry_2
*de
;
108 struct inode
*inode
= file_inode(file
);
109 struct super_block
*sb
= inode
->i_sb
;
110 struct buffer_head
*bh
= NULL
;
111 int dir_has_error
= 0;
112 struct ext4_str fname_crypto_str
= {.name
= NULL
, .len
= 0};
114 if (is_dx_dir(inode
)) {
115 err
= ext4_dx_readdir(file
, ctx
);
116 if (err
!= ERR_BAD_DX_DIR
) {
120 * We don't set the inode dirty flag since it's not
121 * critical that it get flushed back to the disk.
123 ext4_clear_inode_flag(file_inode(file
),
127 if (ext4_has_inline_data(inode
)) {
128 int has_inline_data
= 1;
129 err
= ext4_read_inline_dir(file
, ctx
,
135 if (ext4_encrypted_inode(inode
)) {
136 err
= ext4_fname_crypto_alloc_buffer(inode
, EXT4_NAME_LEN
,
142 offset
= ctx
->pos
& (sb
->s_blocksize
- 1);
144 while (ctx
->pos
< inode
->i_size
) {
145 struct ext4_map_blocks map
;
147 map
.m_lblk
= ctx
->pos
>> EXT4_BLOCK_SIZE_BITS(sb
);
149 err
= ext4_map_blocks(NULL
, inode
, &map
, 0);
151 pgoff_t index
= map
.m_pblk
>>
152 (PAGE_CACHE_SHIFT
- inode
->i_blkbits
);
153 if (!ra_has_index(&file
->f_ra
, index
))
154 page_cache_sync_readahead(
155 sb
->s_bdev
->bd_inode
->i_mapping
,
158 file
->f_ra
.prev_pos
= (loff_t
)index
<< PAGE_CACHE_SHIFT
;
159 bh
= ext4_bread(NULL
, inode
, map
.m_lblk
, 0);
165 if (!dir_has_error
) {
166 EXT4_ERROR_FILE(file
, 0,
167 "directory contains a "
168 "hole at offset %llu",
169 (unsigned long long) ctx
->pos
);
172 /* corrupt size? Maybe no more blocks to read */
173 if (ctx
->pos
> inode
->i_blocks
<< 9)
175 ctx
->pos
+= sb
->s_blocksize
- offset
;
179 /* Check the checksum */
180 if (!buffer_verified(bh
) &&
181 !ext4_dirent_csum_verify(inode
,
182 (struct ext4_dir_entry
*)bh
->b_data
)) {
183 EXT4_ERROR_FILE(file
, 0, "directory fails checksum "
185 (unsigned long long)ctx
->pos
);
186 ctx
->pos
+= sb
->s_blocksize
- offset
;
191 set_buffer_verified(bh
);
193 /* If the dir block has changed since the last call to
194 * readdir(2), then we might be pointing to an invalid
195 * dirent right now. Scan from the start of the block
197 if (file
->f_version
!= inode
->i_version
) {
198 for (i
= 0; i
< sb
->s_blocksize
&& i
< offset
; ) {
199 de
= (struct ext4_dir_entry_2
*)
201 /* It's too expensive to do a full
202 * dirent test each time round this
203 * loop, but we do have to test at
204 * least that it is non-zero. A
205 * failure will be detected in the
206 * dirent test below. */
207 if (ext4_rec_len_from_disk(de
->rec_len
,
208 sb
->s_blocksize
) < EXT4_DIR_REC_LEN(1))
210 i
+= ext4_rec_len_from_disk(de
->rec_len
,
214 ctx
->pos
= (ctx
->pos
& ~(sb
->s_blocksize
- 1))
216 file
->f_version
= inode
->i_version
;
219 while (ctx
->pos
< inode
->i_size
220 && offset
< sb
->s_blocksize
) {
221 de
= (struct ext4_dir_entry_2
*) (bh
->b_data
+ offset
);
222 if (ext4_check_dir_entry(inode
, file
, de
, bh
,
223 bh
->b_data
, bh
->b_size
,
226 * On error, skip to the next block
228 ctx
->pos
= (ctx
->pos
|
229 (sb
->s_blocksize
- 1)) + 1;
232 offset
+= ext4_rec_len_from_disk(de
->rec_len
,
234 if (le32_to_cpu(de
->inode
)) {
235 if (!ext4_encrypted_inode(inode
)) {
236 if (!dir_emit(ctx
, de
->name
,
238 le32_to_cpu(de
->inode
),
239 get_dtype(sb
, de
->file_type
)))
242 int save_len
= fname_crypto_str
.len
;
244 /* Directory is encrypted */
245 err
= ext4_fname_disk_to_usr(inode
,
246 NULL
, de
, &fname_crypto_str
);
247 fname_crypto_str
.len
= save_len
;
251 fname_crypto_str
.name
, err
,
252 le32_to_cpu(de
->inode
),
253 get_dtype(sb
, de
->file_type
)))
257 ctx
->pos
+= ext4_rec_len_from_disk(de
->rec_len
,
260 if ((ctx
->pos
< inode
->i_size
) && !dir_relax(inode
))
269 #ifdef CONFIG_EXT4_FS_ENCRYPTION
270 ext4_fname_crypto_free_buffer(&fname_crypto_str
);
276 static inline int is_32bit_api(void)
279 return is_compat_task();
281 return (BITS_PER_LONG
== 32);
286 * These functions convert from the major/minor hash to an f_pos
287 * value for dx directories
289 * Upper layer (for example NFS) should specify FMODE_32BITHASH or
290 * FMODE_64BITHASH explicitly. On the other hand, we allow ext4 to be mounted
291 * directly on both 32-bit and 64-bit nodes, under such case, neither
292 * FMODE_32BITHASH nor FMODE_64BITHASH is specified.
294 static inline loff_t
hash2pos(struct file
*filp
, __u32 major
, __u32 minor
)
296 if ((filp
->f_mode
& FMODE_32BITHASH
) ||
297 (!(filp
->f_mode
& FMODE_64BITHASH
) && is_32bit_api()))
300 return ((__u64
)(major
>> 1) << 32) | (__u64
)minor
;
303 static inline __u32
pos2maj_hash(struct file
*filp
, loff_t pos
)
305 if ((filp
->f_mode
& FMODE_32BITHASH
) ||
306 (!(filp
->f_mode
& FMODE_64BITHASH
) && is_32bit_api()))
307 return (pos
<< 1) & 0xffffffff;
309 return ((pos
>> 32) << 1) & 0xffffffff;
312 static inline __u32
pos2min_hash(struct file
*filp
, loff_t pos
)
314 if ((filp
->f_mode
& FMODE_32BITHASH
) ||
315 (!(filp
->f_mode
& FMODE_64BITHASH
) && is_32bit_api()))
318 return pos
& 0xffffffff;
322 * Return 32- or 64-bit end-of-file for dx directories
324 static inline loff_t
ext4_get_htree_eof(struct file
*filp
)
326 if ((filp
->f_mode
& FMODE_32BITHASH
) ||
327 (!(filp
->f_mode
& FMODE_64BITHASH
) && is_32bit_api()))
328 return EXT4_HTREE_EOF_32BIT
;
330 return EXT4_HTREE_EOF_64BIT
;
335 * ext4_dir_llseek() calls generic_file_llseek_size to handle htree
336 * directories, where the "offset" is in terms of the filename hash
337 * value instead of the byte offset.
339 * Because we may return a 64-bit hash that is well beyond offset limits,
340 * we need to pass the max hash as the maximum allowable offset in
341 * the htree directory case.
343 * For non-htree, ext4_llseek already chooses the proper max offset.
345 static loff_t
ext4_dir_llseek(struct file
*file
, loff_t offset
, int whence
)
347 struct inode
*inode
= file
->f_mapping
->host
;
348 int dx_dir
= is_dx_dir(inode
);
349 loff_t htree_max
= ext4_get_htree_eof(file
);
352 return generic_file_llseek_size(file
, offset
, whence
,
353 htree_max
, htree_max
);
355 return ext4_llseek(file
, offset
, whence
);
359 * This structure holds the nodes of the red-black tree used to store
360 * the directory entry in hash order.
365 struct rb_node rb_hash
;
374 * This functoin implements a non-recursive way of freeing all of the
375 * nodes in the red-black tree.
377 static void free_rb_tree_fname(struct rb_root
*root
)
379 struct fname
*fname
, *next
;
381 rbtree_postorder_for_each_entry_safe(fname
, next
, root
, rb_hash
)
383 struct fname
*old
= fname
;
392 static struct dir_private_info
*ext4_htree_create_dir_info(struct file
*filp
,
395 struct dir_private_info
*p
;
397 p
= kzalloc(sizeof(struct dir_private_info
), GFP_KERNEL
);
400 p
->curr_hash
= pos2maj_hash(filp
, pos
);
401 p
->curr_minor_hash
= pos2min_hash(filp
, pos
);
405 void ext4_htree_free_dir_info(struct dir_private_info
*p
)
407 free_rb_tree_fname(&p
->root
);
412 * Given a directory entry, enter it into the fname rb tree.
414 * When filename encryption is enabled, the dirent will hold the
415 * encrypted filename, while the htree will hold decrypted filename.
416 * The decrypted filename is passed in via ent_name. parameter.
418 int ext4_htree_store_dirent(struct file
*dir_file
, __u32 hash
,
420 struct ext4_dir_entry_2
*dirent
,
421 struct ext4_str
*ent_name
)
423 struct rb_node
**p
, *parent
= NULL
;
424 struct fname
*fname
, *new_fn
;
425 struct dir_private_info
*info
;
428 info
= dir_file
->private_data
;
429 p
= &info
->root
.rb_node
;
431 /* Create and allocate the fname structure */
432 len
= sizeof(struct fname
) + ent_name
->len
+ 1;
433 new_fn
= kzalloc(len
, GFP_KERNEL
);
437 new_fn
->minor_hash
= minor_hash
;
438 new_fn
->inode
= le32_to_cpu(dirent
->inode
);
439 new_fn
->name_len
= ent_name
->len
;
440 new_fn
->file_type
= dirent
->file_type
;
441 memcpy(new_fn
->name
, ent_name
->name
, ent_name
->len
);
442 new_fn
->name
[ent_name
->len
] = 0;
446 fname
= rb_entry(parent
, struct fname
, rb_hash
);
449 * If the hash and minor hash match up, then we put
450 * them on a linked list. This rarely happens...
452 if ((new_fn
->hash
== fname
->hash
) &&
453 (new_fn
->minor_hash
== fname
->minor_hash
)) {
454 new_fn
->next
= fname
->next
;
455 fname
->next
= new_fn
;
459 if (new_fn
->hash
< fname
->hash
)
461 else if (new_fn
->hash
> fname
->hash
)
463 else if (new_fn
->minor_hash
< fname
->minor_hash
)
465 else /* if (new_fn->minor_hash > fname->minor_hash) */
469 rb_link_node(&new_fn
->rb_hash
, parent
, p
);
470 rb_insert_color(&new_fn
->rb_hash
, &info
->root
);
477 * This is a helper function for ext4_dx_readdir. It calls filldir
478 * for all entres on the fname linked list. (Normally there is only
479 * one entry on the linked list, unless there are 62 bit hash collisions.)
481 static int call_filldir(struct file
*file
, struct dir_context
*ctx
,
484 struct dir_private_info
*info
= file
->private_data
;
485 struct inode
*inode
= file_inode(file
);
486 struct super_block
*sb
= inode
->i_sb
;
489 ext4_msg(sb
, KERN_ERR
, "%s:%d: inode #%lu: comm %s: "
490 "called with null fname?!?", __func__
, __LINE__
,
491 inode
->i_ino
, current
->comm
);
494 ctx
->pos
= hash2pos(file
, fname
->hash
, fname
->minor_hash
);
496 if (!dir_emit(ctx
, fname
->name
,
499 get_dtype(sb
, fname
->file_type
))) {
500 info
->extra_fname
= fname
;
508 static int ext4_dx_readdir(struct file
*file
, struct dir_context
*ctx
)
510 struct dir_private_info
*info
= file
->private_data
;
511 struct inode
*inode
= file_inode(file
);
516 info
= ext4_htree_create_dir_info(file
, ctx
->pos
);
519 file
->private_data
= info
;
522 if (ctx
->pos
== ext4_get_htree_eof(file
))
525 /* Some one has messed with f_pos; reset the world */
526 if (info
->last_pos
!= ctx
->pos
) {
527 free_rb_tree_fname(&info
->root
);
528 info
->curr_node
= NULL
;
529 info
->extra_fname
= NULL
;
530 info
->curr_hash
= pos2maj_hash(file
, ctx
->pos
);
531 info
->curr_minor_hash
= pos2min_hash(file
, ctx
->pos
);
535 * If there are any leftover names on the hash collision
536 * chain, return them first.
538 if (info
->extra_fname
) {
539 if (call_filldir(file
, ctx
, info
->extra_fname
))
541 info
->extra_fname
= NULL
;
543 } else if (!info
->curr_node
)
544 info
->curr_node
= rb_first(&info
->root
);
548 * Fill the rbtree if we have no more entries,
549 * or the inode has changed since we last read in the
552 if ((!info
->curr_node
) ||
553 (file
->f_version
!= inode
->i_version
)) {
554 info
->curr_node
= NULL
;
555 free_rb_tree_fname(&info
->root
);
556 file
->f_version
= inode
->i_version
;
557 ret
= ext4_htree_fill_tree(file
, info
->curr_hash
,
558 info
->curr_minor_hash
,
563 ctx
->pos
= ext4_get_htree_eof(file
);
566 info
->curr_node
= rb_first(&info
->root
);
569 fname
= rb_entry(info
->curr_node
, struct fname
, rb_hash
);
570 info
->curr_hash
= fname
->hash
;
571 info
->curr_minor_hash
= fname
->minor_hash
;
572 if (call_filldir(file
, ctx
, fname
))
575 info
->curr_node
= rb_next(info
->curr_node
);
576 if (info
->curr_node
) {
577 fname
= rb_entry(info
->curr_node
, struct fname
,
579 info
->curr_hash
= fname
->hash
;
580 info
->curr_minor_hash
= fname
->minor_hash
;
582 if (info
->next_hash
== ~0) {
583 ctx
->pos
= ext4_get_htree_eof(file
);
586 info
->curr_hash
= info
->next_hash
;
587 info
->curr_minor_hash
= 0;
591 info
->last_pos
= ctx
->pos
;
595 static int ext4_dir_open(struct inode
* inode
, struct file
* filp
)
597 if (ext4_encrypted_inode(inode
))
598 return ext4_get_encryption_info(inode
) ? -EACCES
: 0;
602 static int ext4_release_dir(struct inode
*inode
, struct file
*filp
)
604 if (filp
->private_data
)
605 ext4_htree_free_dir_info(filp
->private_data
);
610 int ext4_check_all_de(struct inode
*dir
, struct buffer_head
*bh
, void *buf
,
613 struct ext4_dir_entry_2
*de
;
615 unsigned int offset
= 0;
618 de
= (struct ext4_dir_entry_2
*)buf
;
619 top
= buf
+ buf_size
;
620 while ((char *) de
< top
) {
621 if (ext4_check_dir_entry(dir
, NULL
, de
, bh
,
622 buf
, buf_size
, offset
))
623 return -EFSCORRUPTED
;
624 nlen
= EXT4_DIR_REC_LEN(de
->name_len
);
625 rlen
= ext4_rec_len_from_disk(de
->rec_len
, buf_size
);
626 de
= (struct ext4_dir_entry_2
*)((char *)de
+ rlen
);
629 if ((char *) de
> top
)
630 return -EFSCORRUPTED
;
635 const struct file_operations ext4_dir_operations
= {
636 .llseek
= ext4_dir_llseek
,
637 .read
= generic_read_dir
,
638 .iterate
= ext4_readdir
,
639 .unlocked_ioctl
= ext4_ioctl
,
641 .compat_ioctl
= ext4_compat_ioctl
,
643 .fsync
= ext4_sync_file
,
644 .open
= ext4_dir_open
,
645 .release
= ext4_release_dir
,