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 * ext3 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
24 #include <linux/compat.h>
27 static unsigned char ext3_filetype_table
[] = {
28 DT_UNKNOWN
, DT_REG
, DT_DIR
, DT_CHR
, DT_BLK
, DT_FIFO
, DT_SOCK
, DT_LNK
31 static int ext3_dx_readdir(struct file
* filp
,
32 void * dirent
, filldir_t filldir
);
34 static unsigned char get_dtype(struct super_block
*sb
, int filetype
)
36 if (!EXT3_HAS_INCOMPAT_FEATURE(sb
, EXT3_FEATURE_INCOMPAT_FILETYPE
) ||
37 (filetype
>= EXT3_FT_MAX
))
40 return (ext3_filetype_table
[filetype
]);
44 * Check if the given dir-inode refers to an htree-indexed directory
45 * (or a directory which chould potentially get coverted to use htree
48 * Return 1 if it is a dx dir, 0 if not
50 static int is_dx_dir(struct inode
*inode
)
52 struct super_block
*sb
= inode
->i_sb
;
54 if (EXT3_HAS_COMPAT_FEATURE(inode
->i_sb
,
55 EXT3_FEATURE_COMPAT_DIR_INDEX
) &&
56 ((EXT3_I(inode
)->i_flags
& EXT3_INDEX_FL
) ||
57 ((inode
->i_size
>> sb
->s_blocksize_bits
) == 1)))
63 int ext3_check_dir_entry (const char * function
, struct inode
* dir
,
64 struct ext3_dir_entry_2
* de
,
65 struct buffer_head
* bh
,
68 const char * error_msg
= NULL
;
69 const int rlen
= ext3_rec_len_from_disk(de
->rec_len
);
71 if (unlikely(rlen
< EXT3_DIR_REC_LEN(1)))
72 error_msg
= "rec_len is smaller than minimal";
73 else if (unlikely(rlen
% 4 != 0))
74 error_msg
= "rec_len % 4 != 0";
75 else if (unlikely(rlen
< EXT3_DIR_REC_LEN(de
->name_len
)))
76 error_msg
= "rec_len is too small for name_len";
77 else if (unlikely((((char *) de
- bh
->b_data
) + rlen
> dir
->i_sb
->s_blocksize
)))
78 error_msg
= "directory entry across blocks";
79 else if (unlikely(le32_to_cpu(de
->inode
) >
80 le32_to_cpu(EXT3_SB(dir
->i_sb
)->s_es
->s_inodes_count
)))
81 error_msg
= "inode out of bounds";
83 if (unlikely(error_msg
!= NULL
))
84 ext3_error (dir
->i_sb
, function
,
85 "bad entry in directory #%lu: %s - "
86 "offset=%lu, inode=%lu, rec_len=%d, name_len=%d",
87 dir
->i_ino
, error_msg
, offset
,
88 (unsigned long) le32_to_cpu(de
->inode
),
91 return error_msg
== NULL
? 1 : 0;
94 static int ext3_readdir(struct file
* filp
,
95 void * dirent
, filldir_t filldir
)
100 struct ext3_dir_entry_2
*de
;
102 struct inode
*inode
= filp
->f_path
.dentry
->d_inode
;
103 struct super_block
*sb
= inode
->i_sb
;
105 int dir_has_error
= 0;
107 if (is_dx_dir(inode
)) {
108 err
= ext3_dx_readdir(filp
, dirent
, filldir
);
109 if (err
!= ERR_BAD_DX_DIR
) {
114 * We don't set the inode dirty flag since it's not
115 * critical that it get flushed back to the disk.
117 EXT3_I(filp
->f_path
.dentry
->d_inode
)->i_flags
&= ~EXT3_INDEX_FL
;
120 offset
= filp
->f_pos
& (sb
->s_blocksize
- 1);
122 while (!error
&& !stored
&& filp
->f_pos
< inode
->i_size
) {
123 unsigned long blk
= filp
->f_pos
>> EXT3_BLOCK_SIZE_BITS(sb
);
124 struct buffer_head map_bh
;
125 struct buffer_head
*bh
= NULL
;
128 err
= ext3_get_blocks_handle(NULL
, inode
, blk
, 1, &map_bh
, 0);
130 pgoff_t index
= map_bh
.b_blocknr
>>
131 (PAGE_CACHE_SHIFT
- inode
->i_blkbits
);
132 if (!ra_has_index(&filp
->f_ra
, index
))
133 page_cache_sync_readahead(
134 sb
->s_bdev
->bd_inode
->i_mapping
,
137 filp
->f_ra
.prev_pos
= (loff_t
)index
<< PAGE_CACHE_SHIFT
;
138 bh
= ext3_bread(NULL
, inode
, blk
, 0, &err
);
142 * We ignore I/O errors on directories so users have a chance
143 * of recovering data when there's a bad sector
146 if (!dir_has_error
) {
147 ext3_error(sb
, __func__
, "directory #%lu "
148 "contains a hole at offset %lld",
149 inode
->i_ino
, filp
->f_pos
);
152 /* corrupt size? Maybe no more blocks to read */
153 if (filp
->f_pos
> inode
->i_blocks
<< 9)
155 filp
->f_pos
+= sb
->s_blocksize
- offset
;
160 /* If the dir block has changed since the last call to
161 * readdir(2), then we might be pointing to an invalid
162 * dirent right now. Scan from the start of the block
164 if (filp
->f_version
!= inode
->i_version
) {
165 for (i
= 0; i
< sb
->s_blocksize
&& i
< offset
; ) {
166 de
= (struct ext3_dir_entry_2
*)
168 /* It's too expensive to do a full
169 * dirent test each time round this
170 * loop, but we do have to test at
171 * least that it is non-zero. A
172 * failure will be detected in the
173 * dirent test below. */
174 if (ext3_rec_len_from_disk(de
->rec_len
) <
177 i
+= ext3_rec_len_from_disk(de
->rec_len
);
180 filp
->f_pos
= (filp
->f_pos
& ~(sb
->s_blocksize
- 1))
182 filp
->f_version
= inode
->i_version
;
185 while (!error
&& filp
->f_pos
< inode
->i_size
186 && offset
< sb
->s_blocksize
) {
187 de
= (struct ext3_dir_entry_2
*) (bh
->b_data
+ offset
);
188 if (!ext3_check_dir_entry ("ext3_readdir", inode
, de
,
190 /* On error, skip the f_pos to the
192 filp
->f_pos
= (filp
->f_pos
|
193 (sb
->s_blocksize
- 1)) + 1;
198 offset
+= ext3_rec_len_from_disk(de
->rec_len
);
199 if (le32_to_cpu(de
->inode
)) {
200 /* We might block in the next section
201 * if the data destination is
202 * currently swapped out. So, use a
203 * version stamp to detect whether or
204 * not the directory has been modified
205 * during the copy operation.
207 u64 version
= filp
->f_version
;
209 error
= filldir(dirent
, de
->name
,
212 le32_to_cpu(de
->inode
),
213 get_dtype(sb
, de
->file_type
));
216 if (version
!= filp
->f_version
)
220 filp
->f_pos
+= ext3_rec_len_from_disk(de
->rec_len
);
229 static inline int is_32bit_api(void)
232 return is_compat_task();
234 return (BITS_PER_LONG
== 32);
239 * These functions convert from the major/minor hash to an f_pos
240 * value for dx directories
242 * Upper layer (for example NFS) should specify FMODE_32BITHASH or
243 * FMODE_64BITHASH explicitly. On the other hand, we allow ext3 to be mounted
244 * directly on both 32-bit and 64-bit nodes, under such case, neither
245 * FMODE_32BITHASH nor FMODE_64BITHASH is specified.
247 static inline loff_t
hash2pos(struct file
*filp
, __u32 major
, __u32 minor
)
249 if ((filp
->f_mode
& FMODE_32BITHASH
) ||
250 (!(filp
->f_mode
& FMODE_64BITHASH
) && is_32bit_api()))
253 return ((__u64
)(major
>> 1) << 32) | (__u64
)minor
;
256 static inline __u32
pos2maj_hash(struct file
*filp
, loff_t pos
)
258 if ((filp
->f_mode
& FMODE_32BITHASH
) ||
259 (!(filp
->f_mode
& FMODE_64BITHASH
) && is_32bit_api()))
260 return (pos
<< 1) & 0xffffffff;
262 return ((pos
>> 32) << 1) & 0xffffffff;
265 static inline __u32
pos2min_hash(struct file
*filp
, loff_t pos
)
267 if ((filp
->f_mode
& FMODE_32BITHASH
) ||
268 (!(filp
->f_mode
& FMODE_64BITHASH
) && is_32bit_api()))
271 return pos
& 0xffffffff;
275 * Return 32- or 64-bit end-of-file for dx directories
277 static inline loff_t
ext3_get_htree_eof(struct file
*filp
)
279 if ((filp
->f_mode
& FMODE_32BITHASH
) ||
280 (!(filp
->f_mode
& FMODE_64BITHASH
) && is_32bit_api()))
281 return EXT3_HTREE_EOF_32BIT
;
283 return EXT3_HTREE_EOF_64BIT
;
288 * ext3_dir_llseek() calls generic_file_llseek[_size]() to handle both
289 * non-htree and htree directories, where the "offset" is in terms
290 * of the filename hash value instead of the byte offset.
292 * Because we may return a 64-bit hash that is well beyond s_maxbytes,
293 * we need to pass the max hash as the maximum allowable offset in
294 * the htree directory case.
296 * NOTE: offsets obtained *before* ext3_set_inode_flag(dir, EXT3_INODE_INDEX)
297 * will be invalid once the directory was converted into a dx directory
299 loff_t
ext3_dir_llseek(struct file
*file
, loff_t offset
, int origin
)
301 struct inode
*inode
= file
->f_mapping
->host
;
302 int dx_dir
= is_dx_dir(inode
);
303 loff_t htree_max
= ext3_get_htree_eof(file
);
306 return generic_file_llseek_size(file
, offset
, origin
,
307 htree_max
, htree_max
);
309 return generic_file_llseek(file
, offset
, origin
);
313 * This structure holds the nodes of the red-black tree used to store
314 * the directory entry in hash order.
319 struct rb_node rb_hash
;
328 * This functoin implements a non-recursive way of freeing all of the
329 * nodes in the red-black tree.
331 static void free_rb_tree_fname(struct rb_root
*root
)
333 struct rb_node
*n
= root
->rb_node
;
334 struct rb_node
*parent
;
338 /* Do the node's children first */
348 * The node has no children; free it, and then zero
349 * out parent's link to it. Finally go to the
350 * beginning of the loop and try to free the parent
353 parent
= rb_parent(n
);
354 fname
= rb_entry(n
, struct fname
, rb_hash
);
356 struct fname
* old
= fname
;
362 else if (parent
->rb_left
== n
)
363 parent
->rb_left
= NULL
;
364 else if (parent
->rb_right
== n
)
365 parent
->rb_right
= NULL
;
371 static struct dir_private_info
*ext3_htree_create_dir_info(struct file
*filp
,
374 struct dir_private_info
*p
;
376 p
= kzalloc(sizeof(struct dir_private_info
), GFP_KERNEL
);
379 p
->curr_hash
= pos2maj_hash(filp
, pos
);
380 p
->curr_minor_hash
= pos2min_hash(filp
, pos
);
384 void ext3_htree_free_dir_info(struct dir_private_info
*p
)
386 free_rb_tree_fname(&p
->root
);
391 * Given a directory entry, enter it into the fname rb tree.
393 int ext3_htree_store_dirent(struct file
*dir_file
, __u32 hash
,
395 struct ext3_dir_entry_2
*dirent
)
397 struct rb_node
**p
, *parent
= NULL
;
398 struct fname
* fname
, *new_fn
;
399 struct dir_private_info
*info
;
402 info
= (struct dir_private_info
*) dir_file
->private_data
;
403 p
= &info
->root
.rb_node
;
405 /* Create and allocate the fname structure */
406 len
= sizeof(struct fname
) + dirent
->name_len
+ 1;
407 new_fn
= kzalloc(len
, GFP_KERNEL
);
411 new_fn
->minor_hash
= minor_hash
;
412 new_fn
->inode
= le32_to_cpu(dirent
->inode
);
413 new_fn
->name_len
= dirent
->name_len
;
414 new_fn
->file_type
= dirent
->file_type
;
415 memcpy(new_fn
->name
, dirent
->name
, dirent
->name_len
);
416 new_fn
->name
[dirent
->name_len
] = 0;
420 fname
= rb_entry(parent
, struct fname
, rb_hash
);
423 * If the hash and minor hash match up, then we put
424 * them on a linked list. This rarely happens...
426 if ((new_fn
->hash
== fname
->hash
) &&
427 (new_fn
->minor_hash
== fname
->minor_hash
)) {
428 new_fn
->next
= fname
->next
;
429 fname
->next
= new_fn
;
433 if (new_fn
->hash
< fname
->hash
)
435 else if (new_fn
->hash
> fname
->hash
)
437 else if (new_fn
->minor_hash
< fname
->minor_hash
)
439 else /* if (new_fn->minor_hash > fname->minor_hash) */
443 rb_link_node(&new_fn
->rb_hash
, parent
, p
);
444 rb_insert_color(&new_fn
->rb_hash
, &info
->root
);
451 * This is a helper function for ext3_dx_readdir. It calls filldir
452 * for all entres on the fname linked list. (Normally there is only
453 * one entry on the linked list, unless there are 62 bit hash collisions.)
455 static int call_filldir(struct file
* filp
, void * dirent
,
456 filldir_t filldir
, struct fname
*fname
)
458 struct dir_private_info
*info
= filp
->private_data
;
460 struct inode
*inode
= filp
->f_path
.dentry
->d_inode
;
461 struct super_block
* sb
;
467 printk("call_filldir: called with null fname?!?\n");
470 curr_pos
= hash2pos(filp
, fname
->hash
, fname
->minor_hash
);
472 error
= filldir(dirent
, fname
->name
,
473 fname
->name_len
, curr_pos
,
475 get_dtype(sb
, fname
->file_type
));
477 filp
->f_pos
= curr_pos
;
478 info
->extra_fname
= fname
;
486 static int ext3_dx_readdir(struct file
* filp
,
487 void * dirent
, filldir_t filldir
)
489 struct dir_private_info
*info
= filp
->private_data
;
490 struct inode
*inode
= filp
->f_path
.dentry
->d_inode
;
495 info
= ext3_htree_create_dir_info(filp
, filp
->f_pos
);
498 filp
->private_data
= info
;
501 if (filp
->f_pos
== ext3_get_htree_eof(filp
))
504 /* Some one has messed with f_pos; reset the world */
505 if (info
->last_pos
!= filp
->f_pos
) {
506 free_rb_tree_fname(&info
->root
);
507 info
->curr_node
= NULL
;
508 info
->extra_fname
= NULL
;
509 info
->curr_hash
= pos2maj_hash(filp
, filp
->f_pos
);
510 info
->curr_minor_hash
= pos2min_hash(filp
, filp
->f_pos
);
514 * If there are any leftover names on the hash collision
515 * chain, return them first.
517 if (info
->extra_fname
) {
518 if (call_filldir(filp
, dirent
, filldir
, info
->extra_fname
))
520 info
->extra_fname
= NULL
;
522 } else if (!info
->curr_node
)
523 info
->curr_node
= rb_first(&info
->root
);
527 * Fill the rbtree if we have no more entries,
528 * or the inode has changed since we last read in the
531 if ((!info
->curr_node
) ||
532 (filp
->f_version
!= inode
->i_version
)) {
533 info
->curr_node
= NULL
;
534 free_rb_tree_fname(&info
->root
);
535 filp
->f_version
= inode
->i_version
;
536 ret
= ext3_htree_fill_tree(filp
, info
->curr_hash
,
537 info
->curr_minor_hash
,
542 filp
->f_pos
= ext3_get_htree_eof(filp
);
545 info
->curr_node
= rb_first(&info
->root
);
548 fname
= rb_entry(info
->curr_node
, struct fname
, rb_hash
);
549 info
->curr_hash
= fname
->hash
;
550 info
->curr_minor_hash
= fname
->minor_hash
;
551 if (call_filldir(filp
, dirent
, filldir
, fname
))
554 info
->curr_node
= rb_next(info
->curr_node
);
555 if (info
->curr_node
) {
556 fname
= rb_entry(info
->curr_node
, struct fname
,
558 info
->curr_hash
= fname
->hash
;
559 info
->curr_minor_hash
= fname
->minor_hash
;
561 if (info
->next_hash
== ~0) {
562 filp
->f_pos
= ext3_get_htree_eof(filp
);
565 info
->curr_hash
= info
->next_hash
;
566 info
->curr_minor_hash
= 0;
570 info
->last_pos
= filp
->f_pos
;
574 static int ext3_release_dir (struct inode
* inode
, struct file
* filp
)
576 if (filp
->private_data
)
577 ext3_htree_free_dir_info(filp
->private_data
);
582 const struct file_operations ext3_dir_operations
= {
583 .llseek
= ext3_dir_llseek
,
584 .read
= generic_read_dir
,
585 .readdir
= ext3_readdir
,
586 .unlocked_ioctl
= ext3_ioctl
,
588 .compat_ioctl
= ext3_compat_ioctl
,
590 .fsync
= ext3_sync_file
,
591 .release
= ext3_release_dir
,