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/jbd2.h>
26 #include <linux/buffer_head.h>
27 #include <linux/slab.h>
28 #include <linux/rbtree.h>
31 static unsigned char ext4_filetype_table[] = {
32 DT_UNKNOWN, DT_REG, DT_DIR, DT_CHR, DT_BLK, DT_FIFO, DT_SOCK, DT_LNK
35 static int ext4_readdir(struct file *, void *, filldir_t);
36 static int ext4_dx_readdir(struct file *filp,
37 void *dirent, filldir_t filldir);
38 static int ext4_release_dir(struct inode *inode,
41 const struct file_operations ext4_dir_operations = {
42 .llseek = generic_file_llseek,
43 .read = generic_read_dir,
44 .readdir = ext4_readdir, /* we take BKL. needed?*/
45 .unlocked_ioctl = ext4_ioctl,
47 .compat_ioctl = ext4_compat_ioctl,
49 .fsync = ext4_sync_file,
50 .release = ext4_release_dir,
54 static unsigned char get_dtype(struct super_block *sb, int filetype)
56 if (!EXT4_HAS_INCOMPAT_FEATURE(sb, EXT4_FEATURE_INCOMPAT_FILETYPE) ||
57 (filetype >= EXT4_FT_MAX))
60 return (ext4_filetype_table[filetype]);
64 int ext4_check_dir_entry(const char *function, struct inode *dir,
65 struct ext4_dir_entry_2 *de,
66 struct buffer_head *bh,
69 const char *error_msg = NULL;
70 const int rlen = ext4_rec_len_from_disk(de->rec_len,
71 dir->i_sb->s_blocksize);
73 if (rlen < EXT4_DIR_REC_LEN(1))
74 error_msg = "rec_len is smaller than minimal";
75 else if (rlen % 4 != 0)
76 error_msg = "rec_len % 4 != 0";
77 else if (rlen < EXT4_DIR_REC_LEN(de->name_len))
78 error_msg = "rec_len is too small for name_len";
79 else if (((char *) de - bh->b_data) + rlen > dir->i_sb->s_blocksize)
80 error_msg = "directory entry across blocks";
81 else if (le32_to_cpu(de->inode) >
82 le32_to_cpu(EXT4_SB(dir->i_sb)->s_es->s_inodes_count))
83 error_msg = "inode out of bounds";
85 if (error_msg != NULL)
86 ext4_error(dir->i_sb, function,
87 "bad entry in directory #%lu: %s - "
88 "offset=%u, inode=%u, rec_len=%d, name_len=%d",
89 dir->i_ino, error_msg, offset,
90 le32_to_cpu(de->inode),
92 return error_msg == NULL ? 1 : 0;
95 static int ext4_readdir(struct file *filp,
96 void *dirent, filldir_t filldir)
101 struct ext4_dir_entry_2 *de;
102 struct super_block *sb;
104 struct inode *inode = filp->f_path.dentry->d_inode;
106 int dir_has_error = 0;
110 if (EXT4_HAS_COMPAT_FEATURE(inode->i_sb,
111 EXT4_FEATURE_COMPAT_DIR_INDEX) &&
112 ((EXT4_I(inode)->i_flags & EXT4_INDEX_FL) ||
113 ((inode->i_size >> sb->s_blocksize_bits) == 1))) {
114 err = ext4_dx_readdir(filp, dirent, filldir);
115 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_I(filp->f_path.dentry->d_inode)->i_flags &= ~EXT4_INDEX_FL;
126 offset = filp->f_pos & (sb->s_blocksize - 1);
128 while (!error && !stored && filp->f_pos < inode->i_size) {
129 ext4_lblk_t blk = filp->f_pos >> EXT4_BLOCK_SIZE_BITS(sb);
130 struct buffer_head map_bh;
131 struct buffer_head *bh = NULL;
134 err = ext4_get_blocks_wrap(NULL, inode, blk, 1, &map_bh,
137 pgoff_t index = map_bh.b_blocknr >>
138 (PAGE_CACHE_SHIFT - inode->i_blkbits);
139 if (!ra_has_index(&filp->f_ra, index))
140 page_cache_sync_readahead(
141 sb->s_bdev->bd_inode->i_mapping,
144 filp->f_ra.prev_pos = (loff_t)index << PAGE_CACHE_SHIFT;
145 bh = ext4_bread(NULL, inode, blk, 0, &err);
149 * We ignore I/O errors on directories so users have a chance
150 * of recovering data when there's a bad sector
153 if (!dir_has_error) {
154 ext4_error(sb, __func__, "directory #%lu "
155 "contains a hole at offset %Lu",
157 (unsigned long long) filp->f_pos);
160 /* corrupt size? Maybe no more blocks to read */
161 if (filp->f_pos > inode->i_blocks << 9)
163 filp->f_pos += sb->s_blocksize - offset;
168 /* If the dir block has changed since the last call to
169 * readdir(2), then we might be pointing to an invalid
170 * dirent right now. Scan from the start of the block
172 if (filp->f_version != inode->i_version) {
173 for (i = 0; i < sb->s_blocksize && i < offset; ) {
174 de = (struct ext4_dir_entry_2 *)
176 /* It's too expensive to do a full
177 * dirent test each time round this
178 * loop, but we do have to test at
179 * least that it is non-zero. A
180 * failure will be detected in the
181 * dirent test below. */
182 if (ext4_rec_len_from_disk(de->rec_len,
183 sb->s_blocksize) < EXT4_DIR_REC_LEN(1))
185 i += ext4_rec_len_from_disk(de->rec_len,
189 filp->f_pos = (filp->f_pos & ~(sb->s_blocksize - 1))
191 filp->f_version = inode->i_version;
194 while (!error && filp->f_pos < inode->i_size
195 && offset < sb->s_blocksize) {
196 de = (struct ext4_dir_entry_2 *) (bh->b_data + offset);
197 if (!ext4_check_dir_entry("ext4_readdir", inode, de,
200 * On error, skip the f_pos to the next block
202 filp->f_pos = (filp->f_pos |
203 (sb->s_blocksize - 1)) + 1;
208 offset += ext4_rec_len_from_disk(de->rec_len,
210 if (le32_to_cpu(de->inode)) {
211 /* We might block in the next section
212 * if the data destination is
213 * currently swapped out. So, use a
214 * version stamp to detect whether or
215 * not the directory has been modified
216 * during the copy operation.
218 u64 version = filp->f_version;
220 error = filldir(dirent, de->name,
223 le32_to_cpu(de->inode),
224 get_dtype(sb, de->file_type));
227 if (version != filp->f_version)
231 filp->f_pos += ext4_rec_len_from_disk(de->rec_len,
242 * These functions convert from the major/minor hash to an f_pos
245 * Currently we only use major hash numer. This is unfortunate, but
246 * on 32-bit machines, the same VFS interface is used for lseek and
247 * llseek, so if we use the 64 bit offset, then the 32-bit versions of
248 * lseek/telldir/seekdir will blow out spectacularly, and from within
249 * the ext2 low-level routine, we don't know if we're being called by
250 * a 64-bit version of the system call or the 32-bit version of the
251 * system call. Worse yet, NFSv2 only allows for a 32-bit readdir
254 #define hash2pos(major, minor) (major >> 1)
255 #define pos2maj_hash(pos) ((pos << 1) & 0xffffffff)
256 #define pos2min_hash(pos) (0)
259 * This structure holds the nodes of the red-black tree used to store
260 * the directory entry in hash order.
265 struct rb_node rb_hash;
274 * This functoin implements a non-recursive way of freeing all of the
275 * nodes in the red-black tree.
277 static void free_rb_tree_fname(struct rb_root *root)
279 struct rb_node *n = root->rb_node;
280 struct rb_node *parent;
284 /* Do the node's children first */
294 * The node has no children; free it, and then zero
295 * out parent's link to it. Finally go to the
296 * beginning of the loop and try to free the parent
299 parent = rb_parent(n);
300 fname = rb_entry(n, struct fname, rb_hash);
302 struct fname *old = fname;
307 root->rb_node = NULL;
308 else if (parent->rb_left == n)
309 parent->rb_left = NULL;
310 else if (parent->rb_right == n)
311 parent->rb_right = NULL;
317 static struct dir_private_info *ext4_htree_create_dir_info(loff_t pos)
319 struct dir_private_info *p;
321 p = kzalloc(sizeof(struct dir_private_info), GFP_KERNEL);
324 p->curr_hash = pos2maj_hash(pos);
325 p->curr_minor_hash = pos2min_hash(pos);
329 void ext4_htree_free_dir_info(struct dir_private_info *p)
331 free_rb_tree_fname(&p->root);
336 * Given a directory entry, enter it into the fname rb tree.
338 int ext4_htree_store_dirent(struct file *dir_file, __u32 hash,
340 struct ext4_dir_entry_2 *dirent)
342 struct rb_node **p, *parent = NULL;
343 struct fname *fname, *new_fn;
344 struct dir_private_info *info;
347 info = (struct dir_private_info *) dir_file->private_data;
348 p = &info->root.rb_node;
350 /* Create and allocate the fname structure */
351 len = sizeof(struct fname) + dirent->name_len + 1;
352 new_fn = kzalloc(len, GFP_KERNEL);
356 new_fn->minor_hash = minor_hash;
357 new_fn->inode = le32_to_cpu(dirent->inode);
358 new_fn->name_len = dirent->name_len;
359 new_fn->file_type = dirent->file_type;
360 memcpy(new_fn->name, dirent->name, dirent->name_len);
361 new_fn->name[dirent->name_len] = 0;
365 fname = rb_entry(parent, struct fname, rb_hash);
368 * If the hash and minor hash match up, then we put
369 * them on a linked list. This rarely happens...
371 if ((new_fn->hash == fname->hash) &&
372 (new_fn->minor_hash == fname->minor_hash)) {
373 new_fn->next = fname->next;
374 fname->next = new_fn;
378 if (new_fn->hash < fname->hash)
380 else if (new_fn->hash > fname->hash)
382 else if (new_fn->minor_hash < fname->minor_hash)
384 else /* if (new_fn->minor_hash > fname->minor_hash) */
388 rb_link_node(&new_fn->rb_hash, parent, p);
389 rb_insert_color(&new_fn->rb_hash, &info->root);
396 * This is a helper function for ext4_dx_readdir. It calls filldir
397 * for all entres on the fname linked list. (Normally there is only
398 * one entry on the linked list, unless there are 62 bit hash collisions.)
400 static int call_filldir(struct file *filp, void *dirent,
401 filldir_t filldir, struct fname *fname)
403 struct dir_private_info *info = filp->private_data;
405 struct inode *inode = filp->f_path.dentry->d_inode;
406 struct super_block *sb;
412 printk(KERN_ERR "EXT4-fs: call_filldir: called with "
416 curr_pos = hash2pos(fname->hash, fname->minor_hash);
418 error = filldir(dirent, fname->name,
419 fname->name_len, curr_pos,
421 get_dtype(sb, fname->file_type));
423 filp->f_pos = curr_pos;
424 info->extra_fname = fname;
432 static int ext4_dx_readdir(struct file *filp,
433 void *dirent, filldir_t filldir)
435 struct dir_private_info *info = filp->private_data;
436 struct inode *inode = filp->f_path.dentry->d_inode;
441 info = ext4_htree_create_dir_info(filp->f_pos);
444 filp->private_data = info;
447 if (filp->f_pos == EXT4_HTREE_EOF)
450 /* Some one has messed with f_pos; reset the world */
451 if (info->last_pos != filp->f_pos) {
452 free_rb_tree_fname(&info->root);
453 info->curr_node = NULL;
454 info->extra_fname = NULL;
455 info->curr_hash = pos2maj_hash(filp->f_pos);
456 info->curr_minor_hash = pos2min_hash(filp->f_pos);
460 * If there are any leftover names on the hash collision
461 * chain, return them first.
463 if (info->extra_fname) {
464 if (call_filldir(filp, dirent, filldir, info->extra_fname))
466 info->extra_fname = NULL;
468 } else if (!info->curr_node)
469 info->curr_node = rb_first(&info->root);
473 * Fill the rbtree if we have no more entries,
474 * or the inode has changed since we last read in the
477 if ((!info->curr_node) ||
478 (filp->f_version != inode->i_version)) {
479 info->curr_node = NULL;
480 free_rb_tree_fname(&info->root);
481 filp->f_version = inode->i_version;
482 ret = ext4_htree_fill_tree(filp, info->curr_hash,
483 info->curr_minor_hash,
488 filp->f_pos = EXT4_HTREE_EOF;
491 info->curr_node = rb_first(&info->root);
494 fname = rb_entry(info->curr_node, struct fname, rb_hash);
495 info->curr_hash = fname->hash;
496 info->curr_minor_hash = fname->minor_hash;
497 if (call_filldir(filp, dirent, filldir, fname))
500 info->curr_node = rb_next(info->curr_node);
501 if (info->curr_node) {
502 fname = rb_entry(info->curr_node, struct fname,
504 info->curr_hash = fname->hash;
505 info->curr_minor_hash = fname->minor_hash;
507 if (info->next_hash == ~0) {
508 filp->f_pos = EXT4_HTREE_EOF;
511 info->curr_hash = info->next_hash;
512 info->curr_minor_hash = 0;
516 info->last_pos = filp->f_pos;
520 static int ext4_release_dir(struct inode *inode, struct file *filp)
522 if (filp->private_data)
523 ext4_htree_free_dir_info(filp->private_data);