freebsd-dev/sys/fs/ext2fs/htree.h
Pedro F. Giffuni 91f5a4670f Initial implementation of the HTree directory index.
This is a port of NetBSD's GSoC 2012 Ext3 HTree directory indexing
by Vyacheslav Matyushin.  It was cleaned up and enhanced for FreeBSD
by Zheng Liu (lz@).

This is an excellent example of work shared among different projects:
Vyacheslav was able to look at an early prototype from Zheng Liu who
was also able to check the code from Haiku (with permission).

As in linux, the feature is not available by default and must be
enabled explicitly with tune2fs. We still do not support the
workarounds required in readdir for NFS.

Submitted by:	Zheng Liu
Tested by:	Mike Ma
Sponsored by:	Google Inc.
MFC after:	1 week
2013-07-06 18:28:06 +00:00

101 lines
2.9 KiB
C

/*-
* Copyright (c) 2010, 2012 Zheng Liu <lz@freebsd.org>
* Copyright (c) 2012, Vyacheslav Matyushin
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $FreeBSD$
*/
#ifndef _FS_EXT2FS_HTREE_H_
#define _FS_EXT2FS_HTREE_H_
/* EXT3 HTree directory indexing */
#define EXT2_HTREE_LEGACY 0
#define EXT2_HTREE_HALF_MD4 1
#define EXT2_HTREE_TEA 2
#define EXT2_HTREE_LEGACY_UNSIGNED 3
#define EXT2_HTREE_HALF_MD4_UNSIGNED 4
#define EXT2_HTREE_TEA_UNSIGNED 5
#define EXT2_HTREE_EOF 0x7FFFFFFF
struct ext2fs_fake_direct {
uint32_t e2d_ino; /* inode number of entry */
uint16_t e2d_reclen; /* length of this record */
uint8_t e2d_namlen; /* length of string in d_name */
uint8_t e2d_type; /* file type */
};
struct ext2fs_htree_count {
uint16_t h_entries_max;
uint16_t h_entries_num;
};
struct ext2fs_htree_entry {
uint32_t h_hash;
uint32_t h_blk;
};
struct ext2fs_htree_root_info {
uint32_t h_reserved1;
uint8_t h_hash_version;
uint8_t h_info_len;
uint8_t h_ind_levels;
uint8_t h_reserved2;
};
struct ext2fs_htree_root {
struct ext2fs_fake_direct h_dot;
char h_dot_name[4];
struct ext2fs_fake_direct h_dotdot;
char h_dotdot_name[4];
struct ext2fs_htree_root_info h_info;
struct ext2fs_htree_entry h_entries[0];
};
struct ext2fs_htree_node {
struct ext2fs_fake_direct h_fake_dirent;
struct ext2fs_htree_entry h_entries[0];
};
struct ext2fs_htree_lookup_level {
struct buf *h_bp;
struct ext2fs_htree_entry *h_entries;
struct ext2fs_htree_entry *h_entry;
};
struct ext2fs_htree_lookup_info {
struct ext2fs_htree_lookup_level h_levels[2];
uint32_t h_levels_num;
};
struct ext2fs_htree_sort_entry {
uint16_t h_offset;
uint16_t h_size;
uint32_t h_hash;
};
#endif /* !_FS_EXT2FS_HTREE_H_ */