blob: 151738af6be2b970af0b90b23cbd4f57ccccd3bb [file] [log] [blame]
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001/*
Mingming Cao617ba132006-10-11 01:20:53 -07002 * linux/include/linux/ext4_fs.h
Dave Kleikampac27a0e2006-10-11 01:20:50 -07003 *
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)
8 *
9 * from
10 *
11 * linux/include/linux/minix_fs.h
12 *
13 * Copyright (C) 1991, 1992 Linus Torvalds
14 */
15
Mingming Cao617ba132006-10-11 01:20:53 -070016#ifndef _LINUX_EXT4_FS_H
17#define _LINUX_EXT4_FS_H
Dave Kleikampac27a0e2006-10-11 01:20:50 -070018
19#include <linux/types.h>
Mingming Cao3a5b2ec2006-10-11 01:21:05 -070020#include <linux/blkdev.h>
Dave Kleikampac27a0e2006-10-11 01:20:50 -070021#include <linux/magic.h>
22
23/*
24 * The second extended filesystem constants/structures
25 */
26
27/*
Mingming Cao617ba132006-10-11 01:20:53 -070028 * Define EXT4FS_DEBUG to produce debug messages
Dave Kleikampac27a0e2006-10-11 01:20:50 -070029 */
Mingming Cao617ba132006-10-11 01:20:53 -070030#undef EXT4FS_DEBUG
Dave Kleikampac27a0e2006-10-11 01:20:50 -070031
32/*
Mingming Cao617ba132006-10-11 01:20:53 -070033 * Define EXT4_RESERVATION to reserve data blocks for expanding files
Dave Kleikampac27a0e2006-10-11 01:20:50 -070034 */
Dave Kleikamp8c55e202007-05-24 13:04:54 -040035#define EXT4_DEFAULT_RESERVE_BLOCKS 8
Dave Kleikampac27a0e2006-10-11 01:20:50 -070036/*max window size: 1024(direct blocks) + 3([t,d]indirect blocks) */
Dave Kleikamp8c55e202007-05-24 13:04:54 -040037#define EXT4_MAX_RESERVE_BLOCKS 1027
Mingming Cao617ba132006-10-11 01:20:53 -070038#define EXT4_RESERVE_WINDOW_NOT_ALLOCATED 0
Dave Kleikampac27a0e2006-10-11 01:20:50 -070039
40/*
41 * Debug code
42 */
Mingming Cao617ba132006-10-11 01:20:53 -070043#ifdef EXT4FS_DEBUG
44#define ext4_debug(f, a...) \
Dave Kleikampac27a0e2006-10-11 01:20:50 -070045 do { \
Mingming Cao617ba132006-10-11 01:20:53 -070046 printk (KERN_DEBUG "EXT4-fs DEBUG (%s, %d): %s:", \
Dave Kleikampac27a0e2006-10-11 01:20:50 -070047 __FILE__, __LINE__, __FUNCTION__); \
48 printk (KERN_DEBUG f, ## a); \
49 } while (0)
50#else
Mingming Cao617ba132006-10-11 01:20:53 -070051#define ext4_debug(f, a...) do {} while (0)
Dave Kleikampac27a0e2006-10-11 01:20:50 -070052#endif
53
54/*
55 * Special inodes numbers
56 */
Mingming Cao617ba132006-10-11 01:20:53 -070057#define EXT4_BAD_INO 1 /* Bad blocks inode */
58#define EXT4_ROOT_INO 2 /* Root inode */
59#define EXT4_BOOT_LOADER_INO 5 /* Boot loader inode */
60#define EXT4_UNDEL_DIR_INO 6 /* Undelete directory inode */
61#define EXT4_RESIZE_INO 7 /* Reserved group descriptors inode */
62#define EXT4_JOURNAL_INO 8 /* Journal inode */
Dave Kleikampac27a0e2006-10-11 01:20:50 -070063
Mingming Cao617ba132006-10-11 01:20:53 -070064/* First non-reserved inode for old ext4 filesystems */
65#define EXT4_GOOD_OLD_FIRST_INO 11
Dave Kleikampac27a0e2006-10-11 01:20:50 -070066
67/*
68 * Maximal count of links to a file
69 */
Andreas Dilgerf8628a12007-07-18 08:38:01 -040070#define EXT4_LINK_MAX 65000
Dave Kleikampac27a0e2006-10-11 01:20:50 -070071
72/*
73 * Macro-instructions used to manage several block sizes
74 */
Mingming Cao617ba132006-10-11 01:20:53 -070075#define EXT4_MIN_BLOCK_SIZE 1024
76#define EXT4_MAX_BLOCK_SIZE 4096
77#define EXT4_MIN_BLOCK_LOG_SIZE 10
Dave Kleikampac27a0e2006-10-11 01:20:50 -070078#ifdef __KERNEL__
Mingming Cao617ba132006-10-11 01:20:53 -070079# define EXT4_BLOCK_SIZE(s) ((s)->s_blocksize)
Dave Kleikampac27a0e2006-10-11 01:20:50 -070080#else
Mingming Cao617ba132006-10-11 01:20:53 -070081# define EXT4_BLOCK_SIZE(s) (EXT4_MIN_BLOCK_SIZE << (s)->s_log_block_size)
Dave Kleikampac27a0e2006-10-11 01:20:50 -070082#endif
Mingming Cao617ba132006-10-11 01:20:53 -070083#define EXT4_ADDR_PER_BLOCK(s) (EXT4_BLOCK_SIZE(s) / sizeof (__u32))
Dave Kleikampac27a0e2006-10-11 01:20:50 -070084#ifdef __KERNEL__
Mingming Cao617ba132006-10-11 01:20:53 -070085# define EXT4_BLOCK_SIZE_BITS(s) ((s)->s_blocksize_bits)
Dave Kleikampac27a0e2006-10-11 01:20:50 -070086#else
Mingming Cao617ba132006-10-11 01:20:53 -070087# define EXT4_BLOCK_SIZE_BITS(s) ((s)->s_log_block_size + 10)
Dave Kleikampac27a0e2006-10-11 01:20:50 -070088#endif
89#ifdef __KERNEL__
Mingming Cao617ba132006-10-11 01:20:53 -070090#define EXT4_ADDR_PER_BLOCK_BITS(s) (EXT4_SB(s)->s_addr_per_block_bits)
91#define EXT4_INODE_SIZE(s) (EXT4_SB(s)->s_inode_size)
92#define EXT4_FIRST_INO(s) (EXT4_SB(s)->s_first_ino)
Dave Kleikampac27a0e2006-10-11 01:20:50 -070093#else
Mingming Cao617ba132006-10-11 01:20:53 -070094#define EXT4_INODE_SIZE(s) (((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
95 EXT4_GOOD_OLD_INODE_SIZE : \
Dave Kleikampac27a0e2006-10-11 01:20:50 -070096 (s)->s_inode_size)
Mingming Cao617ba132006-10-11 01:20:53 -070097#define EXT4_FIRST_INO(s) (((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
98 EXT4_GOOD_OLD_FIRST_INO : \
Dave Kleikampac27a0e2006-10-11 01:20:50 -070099 (s)->s_first_ino)
100#endif
Amit Aroraa2df2a62007-07-17 21:42:41 -0400101#define EXT4_BLOCK_ALIGN(size, blkbits) ALIGN((size), (1 << (blkbits)))
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700102
103/*
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700104 * Structure of a blocks group descriptor
105 */
Mingming Cao617ba132006-10-11 01:20:53 -0700106struct ext4_group_desc
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700107{
108 __le32 bg_block_bitmap; /* Blocks bitmap block */
109 __le32 bg_inode_bitmap; /* Inodes bitmap block */
110 __le32 bg_inode_table; /* Inodes table block */
111 __le16 bg_free_blocks_count; /* Free blocks count */
112 __le16 bg_free_inodes_count; /* Free inodes count */
113 __le16 bg_used_dirs_count; /* Directories count */
Laurent Vivierbd81d8e2006-10-11 01:21:10 -0700114 __u16 bg_flags;
Alexandre Ratchov8fadc142006-10-11 01:21:15 -0700115 __u32 bg_reserved[3];
116 __le32 bg_block_bitmap_hi; /* Blocks bitmap block MSB */
117 __le32 bg_inode_bitmap_hi; /* Inodes bitmap block MSB */
118 __le32 bg_inode_table_hi; /* Inodes table block MSB */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700119};
120
Laurent Vivierbd81d8e2006-10-11 01:21:10 -0700121#ifdef __KERNEL__
122#include <linux/ext4_fs_i.h>
123#include <linux/ext4_fs_sb.h>
124#endif
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700125/*
126 * Macro-instructions used to manage group descriptors
127 */
Alexandre Ratchov0d1ee422006-10-11 01:21:14 -0700128#define EXT4_MIN_DESC_SIZE 32
Alexandre Ratchov8fadc142006-10-11 01:21:15 -0700129#define EXT4_MIN_DESC_SIZE_64BIT 64
Alexandre Ratchov0d1ee422006-10-11 01:21:14 -0700130#define EXT4_MAX_DESC_SIZE EXT4_MIN_BLOCK_SIZE
131#define EXT4_DESC_SIZE(s) (EXT4_SB(s)->s_desc_size)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700132#ifdef __KERNEL__
Mingming Cao617ba132006-10-11 01:20:53 -0700133# define EXT4_BLOCKS_PER_GROUP(s) (EXT4_SB(s)->s_blocks_per_group)
134# define EXT4_DESC_PER_BLOCK(s) (EXT4_SB(s)->s_desc_per_block)
135# define EXT4_INODES_PER_GROUP(s) (EXT4_SB(s)->s_inodes_per_group)
136# define EXT4_DESC_PER_BLOCK_BITS(s) (EXT4_SB(s)->s_desc_per_block_bits)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700137#else
Mingming Cao617ba132006-10-11 01:20:53 -0700138# define EXT4_BLOCKS_PER_GROUP(s) ((s)->s_blocks_per_group)
Alexandre Ratchov0d1ee422006-10-11 01:21:14 -0700139# define EXT4_DESC_PER_BLOCK(s) (EXT4_BLOCK_SIZE(s) / EXT4_DESC_SIZE(s))
Mingming Cao617ba132006-10-11 01:20:53 -0700140# define EXT4_INODES_PER_GROUP(s) ((s)->s_inodes_per_group)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700141#endif
142
143/*
144 * Constants relative to the data blocks
145 */
Mingming Cao617ba132006-10-11 01:20:53 -0700146#define EXT4_NDIR_BLOCKS 12
147#define EXT4_IND_BLOCK EXT4_NDIR_BLOCKS
148#define EXT4_DIND_BLOCK (EXT4_IND_BLOCK + 1)
149#define EXT4_TIND_BLOCK (EXT4_DIND_BLOCK + 1)
150#define EXT4_N_BLOCKS (EXT4_TIND_BLOCK + 1)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700151
152/*
153 * Inode flags
154 */
Mingming Cao617ba132006-10-11 01:20:53 -0700155#define EXT4_SECRM_FL 0x00000001 /* Secure deletion */
156#define EXT4_UNRM_FL 0x00000002 /* Undelete */
157#define EXT4_COMPR_FL 0x00000004 /* Compress file */
158#define EXT4_SYNC_FL 0x00000008 /* Synchronous updates */
159#define EXT4_IMMUTABLE_FL 0x00000010 /* Immutable file */
160#define EXT4_APPEND_FL 0x00000020 /* writes to file may only append */
161#define EXT4_NODUMP_FL 0x00000040 /* do not dump file */
162#define EXT4_NOATIME_FL 0x00000080 /* do not update atime */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700163/* Reserved for compression usage... */
Mingming Cao617ba132006-10-11 01:20:53 -0700164#define EXT4_DIRTY_FL 0x00000100
165#define EXT4_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */
166#define EXT4_NOCOMPR_FL 0x00000400 /* Don't compress */
167#define EXT4_ECOMPR_FL 0x00000800 /* Compression error */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700168/* End compression flags --- maybe not all used */
Mingming Cao617ba132006-10-11 01:20:53 -0700169#define EXT4_INDEX_FL 0x00001000 /* hash-indexed directory */
170#define EXT4_IMAGIC_FL 0x00002000 /* AFS directory */
171#define EXT4_JOURNAL_DATA_FL 0x00004000 /* file data should be journaled */
172#define EXT4_NOTAIL_FL 0x00008000 /* file tail should not be merged */
173#define EXT4_DIRSYNC_FL 0x00010000 /* dirsync behaviour (directories only) */
174#define EXT4_TOPDIR_FL 0x00020000 /* Top of directory hierarchies*/
175#define EXT4_RESERVED_FL 0x80000000 /* reserved for ext4 lib */
Alex Tomasa86c6182006-10-11 01:21:03 -0700176#define EXT4_EXTENTS_FL 0x00080000 /* Inode uses extents */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700177
Alex Tomasa86c6182006-10-11 01:21:03 -0700178#define EXT4_FL_USER_VISIBLE 0x000BDFFF /* User visible flags */
Mingming Cao617ba132006-10-11 01:20:53 -0700179#define EXT4_FL_USER_MODIFIABLE 0x000380FF /* User modifiable flags */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700180
181/*
182 * Inode dynamic state flags
183 */
Mingming Cao617ba132006-10-11 01:20:53 -0700184#define EXT4_STATE_JDATA 0x00000001 /* journaled data exists */
185#define EXT4_STATE_NEW 0x00000002 /* inode is newly created */
186#define EXT4_STATE_XATTR 0x00000004 /* has in-inode xattrs */
Kalpak Shah6dd4ee72007-07-18 09:19:57 -0400187#define EXT4_STATE_NO_EXPAND 0x00000008 /* No space for expansion */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700188
189/* Used to pass group descriptor data when online resize is done */
Mingming Cao617ba132006-10-11 01:20:53 -0700190struct ext4_new_group_input {
Dave Kleikamp8c55e202007-05-24 13:04:54 -0400191 __u32 group; /* Group number for this data */
192 __u64 block_bitmap; /* Absolute block number of block bitmap */
193 __u64 inode_bitmap; /* Absolute block number of inode bitmap */
194 __u64 inode_table; /* Absolute block number of inode table start */
195 __u32 blocks_count; /* Total number of blocks in this group */
196 __u16 reserved_blocks; /* Number of reserved blocks in this group */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700197 __u16 unused;
198};
199
Mingming Cao617ba132006-10-11 01:20:53 -0700200/* The struct ext4_new_group_input in kernel space, with free_blocks_count */
201struct ext4_new_group_data {
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700202 __u32 group;
Laurent Vivierbd81d8e2006-10-11 01:21:10 -0700203 __u64 block_bitmap;
204 __u64 inode_bitmap;
205 __u64 inode_table;
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700206 __u32 blocks_count;
207 __u16 reserved_blocks;
208 __u16 unused;
209 __u32 free_blocks_count;
210};
211
Amit Aroraa2df2a62007-07-17 21:42:41 -0400212/*
213 * Following is used by preallocation code to tell get_blocks() that we
214 * want uninitialzed extents.
215 */
216#define EXT4_CREATE_UNINITIALIZED_EXT 2
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700217
218/*
219 * ioctl commands
220 */
Mingming Cao617ba132006-10-11 01:20:53 -0700221#define EXT4_IOC_GETFLAGS FS_IOC_GETFLAGS
222#define EXT4_IOC_SETFLAGS FS_IOC_SETFLAGS
223#define EXT4_IOC_GETVERSION _IOR('f', 3, long)
224#define EXT4_IOC_SETVERSION _IOW('f', 4, long)
225#define EXT4_IOC_GROUP_EXTEND _IOW('f', 7, unsigned long)
226#define EXT4_IOC_GROUP_ADD _IOW('f', 8,struct ext4_new_group_input)
227#define EXT4_IOC_GETVERSION_OLD FS_IOC_GETVERSION
228#define EXT4_IOC_SETVERSION_OLD FS_IOC_SETVERSION
Jose R. Santose23291b2007-07-18 08:57:06 -0400229#ifdef CONFIG_JBD2_DEBUG
Mingming Cao617ba132006-10-11 01:20:53 -0700230#define EXT4_IOC_WAIT_FOR_READONLY _IOR('f', 99, long)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700231#endif
Mingming Cao617ba132006-10-11 01:20:53 -0700232#define EXT4_IOC_GETRSVSZ _IOR('f', 5, long)
233#define EXT4_IOC_SETRSVSZ _IOW('f', 6, long)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700234
235/*
236 * ioctl commands in 32 bit emulation
237 */
Mingming Cao617ba132006-10-11 01:20:53 -0700238#define EXT4_IOC32_GETFLAGS FS_IOC32_GETFLAGS
239#define EXT4_IOC32_SETFLAGS FS_IOC32_SETFLAGS
240#define EXT4_IOC32_GETVERSION _IOR('f', 3, int)
241#define EXT4_IOC32_SETVERSION _IOW('f', 4, int)
242#define EXT4_IOC32_GETRSVSZ _IOR('f', 5, int)
243#define EXT4_IOC32_SETRSVSZ _IOW('f', 6, int)
244#define EXT4_IOC32_GROUP_EXTEND _IOW('f', 7, unsigned int)
Jose R. Santose23291b2007-07-18 08:57:06 -0400245#ifdef CONFIG_JBD2_DEBUG
Mingming Cao617ba132006-10-11 01:20:53 -0700246#define EXT4_IOC32_WAIT_FOR_READONLY _IOR('f', 99, int)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700247#endif
Mingming Cao617ba132006-10-11 01:20:53 -0700248#define EXT4_IOC32_GETVERSION_OLD FS_IOC32_GETVERSION
249#define EXT4_IOC32_SETVERSION_OLD FS_IOC32_SETVERSION
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700250
251
252/*
253 * Mount options
254 */
Mingming Cao617ba132006-10-11 01:20:53 -0700255struct ext4_mount_options {
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700256 unsigned long s_mount_opt;
257 uid_t s_resuid;
258 gid_t s_resgid;
259 unsigned long s_commit_interval;
260#ifdef CONFIG_QUOTA
261 int s_jquota_fmt;
262 char *s_qf_names[MAXQUOTAS];
263#endif
264};
265
266/*
267 * Structure of an inode on the disk
268 */
Mingming Cao617ba132006-10-11 01:20:53 -0700269struct ext4_inode {
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700270 __le16 i_mode; /* File mode */
271 __le16 i_uid; /* Low 16 bits of Owner Uid */
272 __le32 i_size; /* Size in bytes */
273 __le32 i_atime; /* Access time */
Kalpak Shahef7f3832007-07-18 09:15:20 -0400274 __le32 i_ctime; /* Inode Change time */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700275 __le32 i_mtime; /* Modification time */
276 __le32 i_dtime; /* Deletion Time */
277 __le16 i_gid; /* Low 16 bits of Group Id */
278 __le16 i_links_count; /* Links count */
279 __le32 i_blocks; /* Blocks count */
280 __le32 i_flags; /* File flags */
281 union {
282 struct {
283 __u32 l_i_reserved1;
284 } linux1;
285 struct {
286 __u32 h_i_translator;
287 } hurd1;
288 struct {
289 __u32 m_i_reserved1;
290 } masix1;
291 } osd1; /* OS dependent 1 */
Mingming Cao617ba132006-10-11 01:20:53 -0700292 __le32 i_block[EXT4_N_BLOCKS];/* Pointers to blocks */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700293 __le32 i_generation; /* File version (for NFS) */
294 __le32 i_file_acl; /* File ACL */
295 __le32 i_dir_acl; /* Directory ACL */
Coly Lif077d0d2007-10-16 18:38:25 -0400296 __le32 i_obso_faddr; /* Obsoleted fragment address */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700297 union {
298 struct {
Coly Lif077d0d2007-10-16 18:38:25 -0400299 __le16 l_i_reserved1; /* Obsoleted fragment number/size which are removed in ext4 */
Badari Pulavartya1ddeb72006-10-11 01:21:09 -0700300 __le16 l_i_file_acl_high;
Dave Kleikamp8c55e202007-05-24 13:04:54 -0400301 __le16 l_i_uid_high; /* these 2 fields */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700302 __le16 l_i_gid_high; /* were reserved2[0] */
303 __u32 l_i_reserved2;
304 } linux2;
305 struct {
Coly Lif077d0d2007-10-16 18:38:25 -0400306 __le16 h_i_reserved1; /* Obsoleted fragment number/size which are removed in ext4 */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700307 __u16 h_i_mode_high;
308 __u16 h_i_uid_high;
309 __u16 h_i_gid_high;
310 __u32 h_i_author;
311 } hurd2;
312 struct {
Coly Lif077d0d2007-10-16 18:38:25 -0400313 __le16 h_i_reserved1; /* Obsoleted fragment number/size which are removed in ext4 */
Badari Pulavartya1ddeb72006-10-11 01:21:09 -0700314 __le16 m_i_file_acl_high;
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700315 __u32 m_i_reserved2[2];
316 } masix2;
317 } osd2; /* OS dependent 2 */
318 __le16 i_extra_isize;
319 __le16 i_pad1;
Kalpak Shahef7f3832007-07-18 09:15:20 -0400320 __le32 i_ctime_extra; /* extra Change time (nsec << 2 | epoch) */
321 __le32 i_mtime_extra; /* extra Modification time(nsec << 2 | epoch) */
322 __le32 i_atime_extra; /* extra Access time (nsec << 2 | epoch) */
323 __le32 i_crtime; /* File Creation time */
324 __le32 i_crtime_extra; /* extra FileCreationtime (nsec << 2 | epoch) */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700325};
326
327#define i_size_high i_dir_acl
328
Kalpak Shahef7f3832007-07-18 09:15:20 -0400329#define EXT4_EPOCH_BITS 2
330#define EXT4_EPOCH_MASK ((1 << EXT4_EPOCH_BITS) - 1)
331#define EXT4_NSEC_MASK (~0UL << EXT4_EPOCH_BITS)
332
333/*
334 * Extended fields will fit into an inode if the filesystem was formatted
335 * with large inodes (-I 256 or larger) and there are not currently any EAs
336 * consuming all of the available space. For new inodes we always reserve
337 * enough space for the kernel's known extended fields, but for inodes
338 * created with an old kernel this might not have been the case. None of
339 * the extended inode fields is critical for correct filesystem operation.
340 * This macro checks if a certain field fits in the inode. Note that
341 * inode-size = GOOD_OLD_INODE_SIZE + i_extra_isize
342 */
343#define EXT4_FITS_IN_INODE(ext4_inode, einode, field) \
344 ((offsetof(typeof(*ext4_inode), field) + \
345 sizeof((ext4_inode)->field)) \
346 <= (EXT4_GOOD_OLD_INODE_SIZE + \
347 (einode)->i_extra_isize)) \
348
349static inline __le32 ext4_encode_extra_time(struct timespec *time)
350{
351 return cpu_to_le32((sizeof(time->tv_sec) > 4 ?
352 time->tv_sec >> 32 : 0) |
353 ((time->tv_nsec << 2) & EXT4_NSEC_MASK));
354}
355
356static inline void ext4_decode_extra_time(struct timespec *time, __le32 extra)
357{
358 if (sizeof(time->tv_sec) > 4)
359 time->tv_sec |= (__u64)(le32_to_cpu(extra) & EXT4_EPOCH_MASK)
360 << 32;
361 time->tv_nsec = (le32_to_cpu(extra) & EXT4_NSEC_MASK) >> 2;
362}
363
364#define EXT4_INODE_SET_XTIME(xtime, inode, raw_inode) \
365do { \
366 (raw_inode)->xtime = cpu_to_le32((inode)->xtime.tv_sec); \
367 if (EXT4_FITS_IN_INODE(raw_inode, EXT4_I(inode), xtime ## _extra)) \
368 (raw_inode)->xtime ## _extra = \
369 ext4_encode_extra_time(&(inode)->xtime); \
370} while (0)
371
372#define EXT4_EINODE_SET_XTIME(xtime, einode, raw_inode) \
373do { \
374 if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime)) \
375 (raw_inode)->xtime = cpu_to_le32((einode)->xtime.tv_sec); \
376 if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime ## _extra)) \
377 (raw_inode)->xtime ## _extra = \
378 ext4_encode_extra_time(&(einode)->xtime); \
379} while (0)
380
381#define EXT4_INODE_GET_XTIME(xtime, inode, raw_inode) \
382do { \
383 (inode)->xtime.tv_sec = (signed)le32_to_cpu((raw_inode)->xtime); \
384 if (EXT4_FITS_IN_INODE(raw_inode, EXT4_I(inode), xtime ## _extra)) \
385 ext4_decode_extra_time(&(inode)->xtime, \
386 raw_inode->xtime ## _extra); \
387} while (0)
388
389#define EXT4_EINODE_GET_XTIME(xtime, einode, raw_inode) \
390do { \
391 if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime)) \
392 (einode)->xtime.tv_sec = \
393 (signed)le32_to_cpu((raw_inode)->xtime); \
394 if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime ## _extra)) \
395 ext4_decode_extra_time(&(einode)->xtime, \
396 raw_inode->xtime ## _extra); \
397} while (0)
398
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700399#if defined(__KERNEL__) || defined(__linux__)
400#define i_reserved1 osd1.linux1.l_i_reserved1
Badari Pulavartya1ddeb72006-10-11 01:21:09 -0700401#define i_file_acl_high osd2.linux2.l_i_file_acl_high
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700402#define i_uid_low i_uid
403#define i_gid_low i_gid
404#define i_uid_high osd2.linux2.l_i_uid_high
405#define i_gid_high osd2.linux2.l_i_gid_high
406#define i_reserved2 osd2.linux2.l_i_reserved2
407
408#elif defined(__GNU__)
409
410#define i_translator osd1.hurd1.h_i_translator
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700411#define i_uid_high osd2.hurd2.h_i_uid_high
412#define i_gid_high osd2.hurd2.h_i_gid_high
413#define i_author osd2.hurd2.h_i_author
414
415#elif defined(__masix__)
416
417#define i_reserved1 osd1.masix1.m_i_reserved1
Badari Pulavartya1ddeb72006-10-11 01:21:09 -0700418#define i_file_acl_high osd2.masix2.m_i_file_acl_high
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700419#define i_reserved2 osd2.masix2.m_i_reserved2
420
421#endif /* defined(__KERNEL__) || defined(__linux__) */
422
423/*
424 * File system states
425 */
Mingming Cao617ba132006-10-11 01:20:53 -0700426#define EXT4_VALID_FS 0x0001 /* Unmounted cleanly */
427#define EXT4_ERROR_FS 0x0002 /* Errors detected */
428#define EXT4_ORPHAN_FS 0x0004 /* Orphans being recovered */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700429
430/*
431 * Mount flags
432 */
Mingming Cao617ba132006-10-11 01:20:53 -0700433#define EXT4_MOUNT_CHECK 0x00001 /* Do mount-time checks */
434#define EXT4_MOUNT_OLDALLOC 0x00002 /* Don't use the new Orlov allocator */
435#define EXT4_MOUNT_GRPID 0x00004 /* Create files with directory's group */
436#define EXT4_MOUNT_DEBUG 0x00008 /* Some debugging messages */
437#define EXT4_MOUNT_ERRORS_CONT 0x00010 /* Continue on errors */
438#define EXT4_MOUNT_ERRORS_RO 0x00020 /* Remount fs ro on errors */
439#define EXT4_MOUNT_ERRORS_PANIC 0x00040 /* Panic on errors */
440#define EXT4_MOUNT_MINIX_DF 0x00080 /* Mimics the Minix statfs */
441#define EXT4_MOUNT_NOLOAD 0x00100 /* Don't use existing journal*/
442#define EXT4_MOUNT_ABORT 0x00200 /* Fatal error detected */
443#define EXT4_MOUNT_DATA_FLAGS 0x00C00 /* Mode for data writes: */
444#define EXT4_MOUNT_JOURNAL_DATA 0x00400 /* Write data to journal */
445#define EXT4_MOUNT_ORDERED_DATA 0x00800 /* Flush data before commit */
446#define EXT4_MOUNT_WRITEBACK_DATA 0x00C00 /* No data ordering */
447#define EXT4_MOUNT_UPDATE_JOURNAL 0x01000 /* Update the journal format */
448#define EXT4_MOUNT_NO_UID32 0x02000 /* Disable 32-bit UIDs */
449#define EXT4_MOUNT_XATTR_USER 0x04000 /* Extended user attributes */
450#define EXT4_MOUNT_POSIX_ACL 0x08000 /* POSIX Access Control Lists */
451#define EXT4_MOUNT_RESERVATION 0x10000 /* Preallocation */
452#define EXT4_MOUNT_BARRIER 0x20000 /* Use block barriers */
453#define EXT4_MOUNT_NOBH 0x40000 /* No bufferheads */
454#define EXT4_MOUNT_QUOTA 0x80000 /* Some quota option set */
455#define EXT4_MOUNT_USRQUOTA 0x100000 /* "old" user quota */
456#define EXT4_MOUNT_GRPQUOTA 0x200000 /* "old" group quota */
Alex Tomasa86c6182006-10-11 01:21:03 -0700457#define EXT4_MOUNT_EXTENTS 0x400000 /* Extents support */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700458
Mingming Cao617ba132006-10-11 01:20:53 -0700459/* Compatibility, for having both ext2_fs.h and ext4_fs.h included at once */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700460#ifndef _LINUX_EXT2_FS_H
Mingming Cao617ba132006-10-11 01:20:53 -0700461#define clear_opt(o, opt) o &= ~EXT4_MOUNT_##opt
462#define set_opt(o, opt) o |= EXT4_MOUNT_##opt
463#define test_opt(sb, opt) (EXT4_SB(sb)->s_mount_opt & \
464 EXT4_MOUNT_##opt)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700465#else
Mingming Cao617ba132006-10-11 01:20:53 -0700466#define EXT2_MOUNT_NOLOAD EXT4_MOUNT_NOLOAD
467#define EXT2_MOUNT_ABORT EXT4_MOUNT_ABORT
468#define EXT2_MOUNT_DATA_FLAGS EXT4_MOUNT_DATA_FLAGS
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700469#endif
470
Mingming Cao617ba132006-10-11 01:20:53 -0700471#define ext4_set_bit ext2_set_bit
472#define ext4_set_bit_atomic ext2_set_bit_atomic
473#define ext4_clear_bit ext2_clear_bit
474#define ext4_clear_bit_atomic ext2_clear_bit_atomic
475#define ext4_test_bit ext2_test_bit
476#define ext4_find_first_zero_bit ext2_find_first_zero_bit
477#define ext4_find_next_zero_bit ext2_find_next_zero_bit
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700478
479/*
480 * Maximal mount counts between two filesystem checks
481 */
Mingming Cao617ba132006-10-11 01:20:53 -0700482#define EXT4_DFL_MAX_MNT_COUNT 20 /* Allow 20 mounts */
483#define EXT4_DFL_CHECKINTERVAL 0 /* Don't use interval check */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700484
485/*
486 * Behaviour when detecting errors
487 */
Mingming Cao617ba132006-10-11 01:20:53 -0700488#define EXT4_ERRORS_CONTINUE 1 /* Continue execution */
489#define EXT4_ERRORS_RO 2 /* Remount fs read-only */
490#define EXT4_ERRORS_PANIC 3 /* Panic */
491#define EXT4_ERRORS_DEFAULT EXT4_ERRORS_CONTINUE
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700492
493/*
494 * Structure of the super block
495 */
Mingming Cao617ba132006-10-11 01:20:53 -0700496struct ext4_super_block {
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700497/*00*/ __le32 s_inodes_count; /* Inodes count */
498 __le32 s_blocks_count; /* Blocks count */
499 __le32 s_r_blocks_count; /* Reserved blocks count */
500 __le32 s_free_blocks_count; /* Free blocks count */
501/*10*/ __le32 s_free_inodes_count; /* Free inodes count */
502 __le32 s_first_data_block; /* First Data Block */
503 __le32 s_log_block_size; /* Block size */
Coly Lif077d0d2007-10-16 18:38:25 -0400504 __le32 s_obso_log_frag_size; /* Obsoleted fragment size */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700505/*20*/ __le32 s_blocks_per_group; /* # Blocks per group */
Coly Lif077d0d2007-10-16 18:38:25 -0400506 __le32 s_obso_frags_per_group; /* Obsoleted fragments per group */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700507 __le32 s_inodes_per_group; /* # Inodes per group */
508 __le32 s_mtime; /* Mount time */
509/*30*/ __le32 s_wtime; /* Write time */
510 __le16 s_mnt_count; /* Mount count */
511 __le16 s_max_mnt_count; /* Maximal mount count */
512 __le16 s_magic; /* Magic signature */
513 __le16 s_state; /* File system state */
514 __le16 s_errors; /* Behaviour when detecting errors */
515 __le16 s_minor_rev_level; /* minor revision level */
516/*40*/ __le32 s_lastcheck; /* time of last check */
517 __le32 s_checkinterval; /* max. time between checks */
518 __le32 s_creator_os; /* OS */
519 __le32 s_rev_level; /* Revision level */
520/*50*/ __le16 s_def_resuid; /* Default uid for reserved blocks */
521 __le16 s_def_resgid; /* Default gid for reserved blocks */
522 /*
Mingming Cao617ba132006-10-11 01:20:53 -0700523 * These fields are for EXT4_DYNAMIC_REV superblocks only.
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700524 *
525 * Note: the difference between the compatible feature set and
526 * the incompatible feature set is that if there is a bit set
527 * in the incompatible feature set that the kernel doesn't
528 * know about, it should refuse to mount the filesystem.
529 *
530 * e2fsck's requirements are more strict; if it doesn't know
531 * about a feature in either the compatible or incompatible
532 * feature set, it must abort and not try to meddle with
533 * things it doesn't understand...
534 */
535 __le32 s_first_ino; /* First non-reserved inode */
Alexandre Ratchov0d1ee422006-10-11 01:21:14 -0700536 __le16 s_inode_size; /* size of inode structure */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700537 __le16 s_block_group_nr; /* block group # of this superblock */
538 __le32 s_feature_compat; /* compatible feature set */
539/*60*/ __le32 s_feature_incompat; /* incompatible feature set */
540 __le32 s_feature_ro_compat; /* readonly-compatible feature set */
541/*68*/ __u8 s_uuid[16]; /* 128-bit uuid for volume */
542/*78*/ char s_volume_name[16]; /* volume name */
543/*88*/ char s_last_mounted[64]; /* directory where last mounted */
544/*C8*/ __le32 s_algorithm_usage_bitmap; /* For compression */
545 /*
546 * Performance hints. Directory preallocation should only
Mingming Cao617ba132006-10-11 01:20:53 -0700547 * happen if the EXT4_FEATURE_COMPAT_DIR_PREALLOC flag is on.
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700548 */
549 __u8 s_prealloc_blocks; /* Nr of blocks to try to preallocate*/
550 __u8 s_prealloc_dir_blocks; /* Nr to preallocate for dirs */
551 __le16 s_reserved_gdt_blocks; /* Per group desc for online growth */
552 /*
Mingming Cao617ba132006-10-11 01:20:53 -0700553 * Journaling support valid if EXT4_FEATURE_COMPAT_HAS_JOURNAL set.
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700554 */
555/*D0*/ __u8 s_journal_uuid[16]; /* uuid of journal superblock */
556/*E0*/ __le32 s_journal_inum; /* inode number of journal file */
557 __le32 s_journal_dev; /* device number of journal file */
558 __le32 s_last_orphan; /* start of list of inodes to delete */
559 __le32 s_hash_seed[4]; /* HTREE hash seed */
560 __u8 s_def_hash_version; /* Default hash version to use */
561 __u8 s_reserved_char_pad;
Alexandre Ratchov0d1ee422006-10-11 01:21:14 -0700562 __le16 s_desc_size; /* size of group descriptor */
Laurent Vivierbd81d8e2006-10-11 01:21:10 -0700563/*100*/ __le32 s_default_mount_opts;
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700564 __le32 s_first_meta_bg; /* First metablock block group */
Laurent Vivierbd81d8e2006-10-11 01:21:10 -0700565 __le32 s_mkfs_time; /* When the filesystem was created */
566 __le32 s_jnl_blocks[17]; /* Backup of the journal inode */
567 /* 64bit support valid if EXT4_FEATURE_COMPAT_64BIT */
568/*150*/ __le32 s_blocks_count_hi; /* Blocks count */
569 __le32 s_r_blocks_count_hi; /* Reserved blocks count */
570 __le32 s_free_blocks_count_hi; /* Free blocks count */
Theodore Ts'o436bd752007-05-31 12:43:28 -0400571 __u16 s_min_extra_isize; /* All inodes have at least # bytes */
572 __u16 s_want_extra_isize; /* New inodes should reserve # bytes */
573 __u32 s_flags; /* Miscellaneous flags */
574 __u16 s_raid_stride; /* RAID stride */
575 __u16 s_mmp_interval; /* # seconds to wait in MMP checking */
576 __u64 s_mmp_block; /* Block for multi-mount protection */
577 __u32 s_raid_stripe_width; /* blocks on all data disks (N*stride)*/
578 __u32 s_reserved[163]; /* Padding to the end of the block */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700579};
580
581#ifdef __KERNEL__
Mingming Cao617ba132006-10-11 01:20:53 -0700582static inline struct ext4_sb_info * EXT4_SB(struct super_block *sb)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700583{
584 return sb->s_fs_info;
585}
Mingming Cao617ba132006-10-11 01:20:53 -0700586static inline struct ext4_inode_info *EXT4_I(struct inode *inode)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700587{
Mingming Cao617ba132006-10-11 01:20:53 -0700588 return container_of(inode, struct ext4_inode_info, vfs_inode);
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700589}
590
Kalpak Shahef7f3832007-07-18 09:15:20 -0400591static inline struct timespec ext4_current_time(struct inode *inode)
592{
593 return (inode->i_sb->s_time_gran < NSEC_PER_SEC) ?
594 current_fs_time(inode->i_sb) : CURRENT_TIME_SEC;
595}
596
597
Mingming Cao617ba132006-10-11 01:20:53 -0700598static inline int ext4_valid_inum(struct super_block *sb, unsigned long ino)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700599{
Mingming Cao617ba132006-10-11 01:20:53 -0700600 return ino == EXT4_ROOT_INO ||
601 ino == EXT4_JOURNAL_INO ||
602 ino == EXT4_RESIZE_INO ||
603 (ino >= EXT4_FIRST_INO(sb) &&
604 ino <= le32_to_cpu(EXT4_SB(sb)->s_es->s_inodes_count));
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700605}
606#else
Mingming Cao617ba132006-10-11 01:20:53 -0700607/* Assume that user mode programs are passing in an ext4fs superblock, not
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700608 * a kernel struct super_block. This will allow us to call the feature-test
609 * macros from user land. */
Mingming Cao617ba132006-10-11 01:20:53 -0700610#define EXT4_SB(sb) (sb)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700611#endif
612
Mingming Cao617ba132006-10-11 01:20:53 -0700613#define NEXT_ORPHAN(inode) EXT4_I(inode)->i_dtime
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700614
615/*
616 * Codes for operating systems
617 */
Mingming Cao617ba132006-10-11 01:20:53 -0700618#define EXT4_OS_LINUX 0
619#define EXT4_OS_HURD 1
620#define EXT4_OS_MASIX 2
621#define EXT4_OS_FREEBSD 3
622#define EXT4_OS_LITES 4
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700623
624/*
625 * Revision levels
626 */
Mingming Cao617ba132006-10-11 01:20:53 -0700627#define EXT4_GOOD_OLD_REV 0 /* The good old (original) format */
628#define EXT4_DYNAMIC_REV 1 /* V2 format w/ dynamic inode sizes */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700629
Mingming Cao617ba132006-10-11 01:20:53 -0700630#define EXT4_CURRENT_REV EXT4_GOOD_OLD_REV
631#define EXT4_MAX_SUPP_REV EXT4_DYNAMIC_REV
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700632
Mingming Cao617ba132006-10-11 01:20:53 -0700633#define EXT4_GOOD_OLD_INODE_SIZE 128
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700634
635/*
636 * Feature set definitions
637 */
638
Mingming Cao617ba132006-10-11 01:20:53 -0700639#define EXT4_HAS_COMPAT_FEATURE(sb,mask) \
640 ( EXT4_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask) )
641#define EXT4_HAS_RO_COMPAT_FEATURE(sb,mask) \
642 ( EXT4_SB(sb)->s_es->s_feature_ro_compat & cpu_to_le32(mask) )
643#define EXT4_HAS_INCOMPAT_FEATURE(sb,mask) \
644 ( EXT4_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask) )
645#define EXT4_SET_COMPAT_FEATURE(sb,mask) \
646 EXT4_SB(sb)->s_es->s_feature_compat |= cpu_to_le32(mask)
647#define EXT4_SET_RO_COMPAT_FEATURE(sb,mask) \
648 EXT4_SB(sb)->s_es->s_feature_ro_compat |= cpu_to_le32(mask)
649#define EXT4_SET_INCOMPAT_FEATURE(sb,mask) \
650 EXT4_SB(sb)->s_es->s_feature_incompat |= cpu_to_le32(mask)
651#define EXT4_CLEAR_COMPAT_FEATURE(sb,mask) \
652 EXT4_SB(sb)->s_es->s_feature_compat &= ~cpu_to_le32(mask)
653#define EXT4_CLEAR_RO_COMPAT_FEATURE(sb,mask) \
654 EXT4_SB(sb)->s_es->s_feature_ro_compat &= ~cpu_to_le32(mask)
655#define EXT4_CLEAR_INCOMPAT_FEATURE(sb,mask) \
656 EXT4_SB(sb)->s_es->s_feature_incompat &= ~cpu_to_le32(mask)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700657
Mingming Cao617ba132006-10-11 01:20:53 -0700658#define EXT4_FEATURE_COMPAT_DIR_PREALLOC 0x0001
659#define EXT4_FEATURE_COMPAT_IMAGIC_INODES 0x0002
660#define EXT4_FEATURE_COMPAT_HAS_JOURNAL 0x0004
661#define EXT4_FEATURE_COMPAT_EXT_ATTR 0x0008
662#define EXT4_FEATURE_COMPAT_RESIZE_INODE 0x0010
663#define EXT4_FEATURE_COMPAT_DIR_INDEX 0x0020
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700664
Mingming Cao617ba132006-10-11 01:20:53 -0700665#define EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER 0x0001
666#define EXT4_FEATURE_RO_COMPAT_LARGE_FILE 0x0002
667#define EXT4_FEATURE_RO_COMPAT_BTREE_DIR 0x0004
Andreas Dilgerf8628a12007-07-18 08:38:01 -0400668#define EXT4_FEATURE_RO_COMPAT_DIR_NLINK 0x0020
Kalpak Shahef7f3832007-07-18 09:15:20 -0400669#define EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE 0x0040
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700670
Mingming Cao617ba132006-10-11 01:20:53 -0700671#define EXT4_FEATURE_INCOMPAT_COMPRESSION 0x0001
672#define EXT4_FEATURE_INCOMPAT_FILETYPE 0x0002
673#define EXT4_FEATURE_INCOMPAT_RECOVER 0x0004 /* Needs recovery */
674#define EXT4_FEATURE_INCOMPAT_JOURNAL_DEV 0x0008 /* Journal device */
675#define EXT4_FEATURE_INCOMPAT_META_BG 0x0010
Alex Tomasa86c6182006-10-11 01:21:03 -0700676#define EXT4_FEATURE_INCOMPAT_EXTENTS 0x0040 /* extents support */
Laurent Vivierbd81d8e2006-10-11 01:21:10 -0700677#define EXT4_FEATURE_INCOMPAT_64BIT 0x0080
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700678
Mingming Cao617ba132006-10-11 01:20:53 -0700679#define EXT4_FEATURE_COMPAT_SUPP EXT2_FEATURE_COMPAT_EXT_ATTR
680#define EXT4_FEATURE_INCOMPAT_SUPP (EXT4_FEATURE_INCOMPAT_FILETYPE| \
681 EXT4_FEATURE_INCOMPAT_RECOVER| \
Alex Tomasa86c6182006-10-11 01:21:03 -0700682 EXT4_FEATURE_INCOMPAT_META_BG| \
Laurent Vivierbd81d8e2006-10-11 01:21:10 -0700683 EXT4_FEATURE_INCOMPAT_EXTENTS| \
684 EXT4_FEATURE_INCOMPAT_64BIT)
Mingming Cao617ba132006-10-11 01:20:53 -0700685#define EXT4_FEATURE_RO_COMPAT_SUPP (EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER| \
686 EXT4_FEATURE_RO_COMPAT_LARGE_FILE| \
Andreas Dilgerf8628a12007-07-18 08:38:01 -0400687 EXT4_FEATURE_RO_COMPAT_DIR_NLINK | \
Kalpak Shahef7f3832007-07-18 09:15:20 -0400688 EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE | \
Mingming Cao617ba132006-10-11 01:20:53 -0700689 EXT4_FEATURE_RO_COMPAT_BTREE_DIR)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700690
691/*
692 * Default values for user and/or group using reserved blocks
693 */
Mingming Cao617ba132006-10-11 01:20:53 -0700694#define EXT4_DEF_RESUID 0
695#define EXT4_DEF_RESGID 0
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700696
697/*
698 * Default mount options
699 */
Mingming Cao617ba132006-10-11 01:20:53 -0700700#define EXT4_DEFM_DEBUG 0x0001
701#define EXT4_DEFM_BSDGROUPS 0x0002
702#define EXT4_DEFM_XATTR_USER 0x0004
703#define EXT4_DEFM_ACL 0x0008
704#define EXT4_DEFM_UID16 0x0010
705#define EXT4_DEFM_JMODE 0x0060
706#define EXT4_DEFM_JMODE_DATA 0x0020
707#define EXT4_DEFM_JMODE_ORDERED 0x0040
708#define EXT4_DEFM_JMODE_WBACK 0x0060
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700709
710/*
711 * Structure of a directory entry
712 */
Mingming Cao617ba132006-10-11 01:20:53 -0700713#define EXT4_NAME_LEN 255
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700714
Mingming Cao617ba132006-10-11 01:20:53 -0700715struct ext4_dir_entry {
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700716 __le32 inode; /* Inode number */
717 __le16 rec_len; /* Directory entry length */
718 __le16 name_len; /* Name length */
Mingming Cao617ba132006-10-11 01:20:53 -0700719 char name[EXT4_NAME_LEN]; /* File name */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700720};
721
722/*
Mingming Cao617ba132006-10-11 01:20:53 -0700723 * The new version of the directory entry. Since EXT4 structures are
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700724 * stored in intel byte order, and the name_len field could never be
725 * bigger than 255 chars, it's safe to reclaim the extra byte for the
726 * file_type field.
727 */
Mingming Cao617ba132006-10-11 01:20:53 -0700728struct ext4_dir_entry_2 {
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700729 __le32 inode; /* Inode number */
730 __le16 rec_len; /* Directory entry length */
731 __u8 name_len; /* Name length */
732 __u8 file_type;
Mingming Cao617ba132006-10-11 01:20:53 -0700733 char name[EXT4_NAME_LEN]; /* File name */
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700734};
735
736/*
Mingming Cao617ba132006-10-11 01:20:53 -0700737 * Ext4 directory file types. Only the low 3 bits are used. The
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700738 * other bits are reserved for now.
739 */
Mingming Cao617ba132006-10-11 01:20:53 -0700740#define EXT4_FT_UNKNOWN 0
741#define EXT4_FT_REG_FILE 1
742#define EXT4_FT_DIR 2
743#define EXT4_FT_CHRDEV 3
744#define EXT4_FT_BLKDEV 4
745#define EXT4_FT_FIFO 5
746#define EXT4_FT_SOCK 6
747#define EXT4_FT_SYMLINK 7
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700748
Mingming Cao617ba132006-10-11 01:20:53 -0700749#define EXT4_FT_MAX 8
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700750
751/*
Mingming Cao617ba132006-10-11 01:20:53 -0700752 * EXT4_DIR_PAD defines the directory entries boundaries
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700753 *
754 * NOTE: It must be a multiple of 4
755 */
Mingming Cao617ba132006-10-11 01:20:53 -0700756#define EXT4_DIR_PAD 4
757#define EXT4_DIR_ROUND (EXT4_DIR_PAD - 1)
758#define EXT4_DIR_REC_LEN(name_len) (((name_len) + 8 + EXT4_DIR_ROUND) & \
759 ~EXT4_DIR_ROUND)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700760/*
761 * Hash Tree Directory indexing
762 * (c) Daniel Phillips, 2001
763 */
764
Eric Sandeen4074fe32007-10-16 18:38:25 -0400765#define is_dx(dir) (EXT4_HAS_COMPAT_FEATURE(dir->i_sb, \
766 EXT4_FEATURE_COMPAT_DIR_INDEX) && \
Mingming Cao617ba132006-10-11 01:20:53 -0700767 (EXT4_I(dir)->i_flags & EXT4_INDEX_FL))
768#define EXT4_DIR_LINK_MAX(dir) (!is_dx(dir) && (dir)->i_nlink >= EXT4_LINK_MAX)
769#define EXT4_DIR_LINK_EMPTY(dir) ((dir)->i_nlink == 2 || (dir)->i_nlink == 1)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700770
771/* Legal values for the dx_root hash_version field: */
772
773#define DX_HASH_LEGACY 0
774#define DX_HASH_HALF_MD4 1
775#define DX_HASH_TEA 2
776
777#ifdef __KERNEL__
778
779/* hash info structure used by the directory hash */
780struct dx_hash_info
781{
782 u32 hash;
783 u32 minor_hash;
784 int hash_version;
785 u32 *seed;
786};
787
Mingming Cao617ba132006-10-11 01:20:53 -0700788#define EXT4_HTREE_EOF 0x7fffffff
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700789
790/*
Mingming Cao617ba132006-10-11 01:20:53 -0700791 * Control parameters used by ext4_htree_next_block
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700792 */
793#define HASH_NB_ALWAYS 1
794
795
796/*
797 * Describe an inode's exact location on disk and in memory
798 */
Mingming Cao617ba132006-10-11 01:20:53 -0700799struct ext4_iloc
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700800{
801 struct buffer_head *bh;
802 unsigned long offset;
803 unsigned long block_group;
804};
805
Mingming Cao617ba132006-10-11 01:20:53 -0700806static inline struct ext4_inode *ext4_raw_inode(struct ext4_iloc *iloc)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700807{
Mingming Cao617ba132006-10-11 01:20:53 -0700808 return (struct ext4_inode *) (iloc->bh->b_data + iloc->offset);
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700809}
810
811/*
812 * This structure is stuffed into the struct file's private_data field
813 * for directories. It is where we put information so that we can do
814 * readdir operations in hash tree order.
815 */
816struct dir_private_info {
817 struct rb_root root;
818 struct rb_node *curr_node;
819 struct fname *extra_fname;
820 loff_t last_pos;
821 __u32 curr_hash;
822 __u32 curr_minor_hash;
823 __u32 next_hash;
824};
825
826/* calculate the first block number of the group */
Mingming Cao617ba132006-10-11 01:20:53 -0700827static inline ext4_fsblk_t
828ext4_group_first_block_no(struct super_block *sb, unsigned long group_no)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700829{
Mingming Cao617ba132006-10-11 01:20:53 -0700830 return group_no * (ext4_fsblk_t)EXT4_BLOCKS_PER_GROUP(sb) +
831 le32_to_cpu(EXT4_SB(sb)->s_es->s_first_data_block);
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700832}
833
834/*
835 * Special error return code only used by dx_probe() and its callers.
836 */
837#define ERR_BAD_DX_DIR -75000
838
Andrew Morton72b64b52006-10-11 01:21:18 -0700839void ext4_get_group_no_and_offset(struct super_block *sb, ext4_fsblk_t blocknr,
840 unsigned long *blockgrpp, ext4_grpblk_t *offsetp);
Mingming Cao3a5b2ec2006-10-11 01:21:05 -0700841
842/*
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700843 * Function prototypes
844 */
845
846/*
847 * Ok, these declarations are also in <linux/kernel.h> but none of the
Mingming Cao617ba132006-10-11 01:20:53 -0700848 * ext4 source programs needs to include it so they are duplicated here.
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700849 */
Dave Kleikamp8c55e202007-05-24 13:04:54 -0400850# define NORET_TYPE /**/
851# define ATTRIB_NORET __attribute__((noreturn))
852# define NORET_AND noreturn,
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700853
854/* balloc.c */
Mingming Cao3a5b2ec2006-10-11 01:21:05 -0700855extern unsigned int ext4_block_group(struct super_block *sb,
856 ext4_fsblk_t blocknr);
857extern ext4_grpblk_t ext4_block_group_offset(struct super_block *sb,
858 ext4_fsblk_t blocknr);
Mingming Cao617ba132006-10-11 01:20:53 -0700859extern int ext4_bg_has_super(struct super_block *sb, int group);
860extern unsigned long ext4_bg_num_gdb(struct super_block *sb, int group);
861extern ext4_fsblk_t ext4_new_block (handle_t *handle, struct inode *inode,
862 ext4_fsblk_t goal, int *errp);
863extern ext4_fsblk_t ext4_new_blocks (handle_t *handle, struct inode *inode,
864 ext4_fsblk_t goal, unsigned long *count, int *errp);
865extern void ext4_free_blocks (handle_t *handle, struct inode *inode,
866 ext4_fsblk_t block, unsigned long count);
867extern void ext4_free_blocks_sb (handle_t *handle, struct super_block *sb,
868 ext4_fsblk_t block, unsigned long count,
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700869 unsigned long *pdquot_freed_blocks);
Mingming Cao617ba132006-10-11 01:20:53 -0700870extern ext4_fsblk_t ext4_count_free_blocks (struct super_block *);
871extern void ext4_check_blocks_bitmap (struct super_block *);
872extern struct ext4_group_desc * ext4_get_group_desc(struct super_block * sb,
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700873 unsigned int block_group,
874 struct buffer_head ** bh);
Mingming Cao617ba132006-10-11 01:20:53 -0700875extern int ext4_should_retry_alloc(struct super_block *sb, int *retries);
876extern void ext4_init_block_alloc_info(struct inode *);
877extern void ext4_rsv_window_add(struct super_block *sb, struct ext4_reserve_window_node *rsv);
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700878
879/* dir.c */
Mingming Cao617ba132006-10-11 01:20:53 -0700880extern int ext4_check_dir_entry(const char *, struct inode *,
881 struct ext4_dir_entry_2 *,
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700882 struct buffer_head *, unsigned long);
Mingming Cao617ba132006-10-11 01:20:53 -0700883extern int ext4_htree_store_dirent(struct file *dir_file, __u32 hash,
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700884 __u32 minor_hash,
Mingming Cao617ba132006-10-11 01:20:53 -0700885 struct ext4_dir_entry_2 *dirent);
886extern void ext4_htree_free_dir_info(struct dir_private_info *p);
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700887
888/* fsync.c */
Mingming Cao617ba132006-10-11 01:20:53 -0700889extern int ext4_sync_file (struct file *, struct dentry *, int);
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700890
891/* hash.c */
Mingming Cao617ba132006-10-11 01:20:53 -0700892extern int ext4fs_dirhash(const char *name, int len, struct
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700893 dx_hash_info *hinfo);
894
895/* ialloc.c */
Mingming Cao617ba132006-10-11 01:20:53 -0700896extern struct inode * ext4_new_inode (handle_t *, struct inode *, int);
897extern void ext4_free_inode (handle_t *, struct inode *);
898extern struct inode * ext4_orphan_get (struct super_block *, unsigned long);
899extern unsigned long ext4_count_free_inodes (struct super_block *);
900extern unsigned long ext4_count_dirs (struct super_block *);
901extern void ext4_check_inodes_bitmap (struct super_block *);
902extern unsigned long ext4_count_free (struct buffer_head *, unsigned);
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700903
904
905/* inode.c */
Mingming Cao617ba132006-10-11 01:20:53 -0700906int ext4_forget(handle_t *handle, int is_metadata, struct inode *inode,
907 struct buffer_head *bh, ext4_fsblk_t blocknr);
908struct buffer_head * ext4_getblk (handle_t *, struct inode *, long, int, int *);
909struct buffer_head * ext4_bread (handle_t *, struct inode *, int, int, int *);
910int ext4_get_blocks_handle(handle_t *handle, struct inode *inode,
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700911 sector_t iblock, unsigned long maxblocks, struct buffer_head *bh_result,
912 int create, int extend_disksize);
913
Mingming Cao617ba132006-10-11 01:20:53 -0700914extern void ext4_read_inode (struct inode *);
915extern int ext4_write_inode (struct inode *, int);
916extern int ext4_setattr (struct dentry *, struct iattr *);
917extern void ext4_delete_inode (struct inode *);
918extern int ext4_sync_inode (handle_t *, struct inode *);
919extern void ext4_discard_reservation (struct inode *);
920extern void ext4_dirty_inode(struct inode *);
921extern int ext4_change_inode_journal_flag(struct inode *, int);
922extern int ext4_get_inode_loc(struct inode *, struct ext4_iloc *);
923extern void ext4_truncate (struct inode *);
924extern void ext4_set_inode_flags(struct inode *);
Jan Karaff9ddf72007-07-18 09:24:20 -0400925extern void ext4_get_inode_flags(struct ext4_inode_info *);
Mingming Cao617ba132006-10-11 01:20:53 -0700926extern void ext4_set_aops(struct inode *inode);
Alex Tomasa86c6182006-10-11 01:21:03 -0700927extern int ext4_writepage_trans_blocks(struct inode *);
928extern int ext4_block_truncate_page(handle_t *handle, struct page *page,
929 struct address_space *mapping, loff_t from);
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700930
931/* ioctl.c */
Mingming Cao617ba132006-10-11 01:20:53 -0700932extern int ext4_ioctl (struct inode *, struct file *, unsigned int,
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700933 unsigned long);
Mingming Cao617ba132006-10-11 01:20:53 -0700934extern long ext4_compat_ioctl (struct file *, unsigned int, unsigned long);
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700935
936/* namei.c */
Mingming Cao617ba132006-10-11 01:20:53 -0700937extern int ext4_orphan_add(handle_t *, struct inode *);
938extern int ext4_orphan_del(handle_t *, struct inode *);
939extern int ext4_htree_fill_tree(struct file *dir_file, __u32 start_hash,
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700940 __u32 start_minor_hash, __u32 *next_hash);
941
942/* resize.c */
Mingming Cao617ba132006-10-11 01:20:53 -0700943extern int ext4_group_add(struct super_block *sb,
944 struct ext4_new_group_data *input);
945extern int ext4_group_extend(struct super_block *sb,
946 struct ext4_super_block *es,
947 ext4_fsblk_t n_blocks_count);
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700948
949/* super.c */
Mingming Cao617ba132006-10-11 01:20:53 -0700950extern void ext4_error (struct super_block *, const char *, const char *, ...)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700951 __attribute__ ((format (printf, 3, 4)));
Mingming Cao617ba132006-10-11 01:20:53 -0700952extern void __ext4_std_error (struct super_block *, const char *, int);
953extern void ext4_abort (struct super_block *, const char *, const char *, ...)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700954 __attribute__ ((format (printf, 3, 4)));
Mingming Cao617ba132006-10-11 01:20:53 -0700955extern void ext4_warning (struct super_block *, const char *, const char *, ...)
Dave Kleikampac27a0e2006-10-11 01:20:50 -0700956 __attribute__ ((format (printf, 3, 4)));
Mingming Cao617ba132006-10-11 01:20:53 -0700957extern void ext4_update_dynamic_rev (struct super_block *sb);
Alexandre Ratchov8fadc142006-10-11 01:21:15 -0700958extern ext4_fsblk_t ext4_block_bitmap(struct super_block *sb,
959 struct ext4_group_desc *bg);
960extern ext4_fsblk_t ext4_inode_bitmap(struct super_block *sb,
961 struct ext4_group_desc *bg);
962extern ext4_fsblk_t ext4_inode_table(struct super_block *sb,
963 struct ext4_group_desc *bg);
964extern void ext4_block_bitmap_set(struct super_block *sb,
965 struct ext4_group_desc *bg, ext4_fsblk_t blk);
966extern void ext4_inode_bitmap_set(struct super_block *sb,
967 struct ext4_group_desc *bg, ext4_fsblk_t blk);
968extern void ext4_inode_table_set(struct super_block *sb,
969 struct ext4_group_desc *bg, ext4_fsblk_t blk);
Laurent Vivierbd81d8e2006-10-11 01:21:10 -0700970
971static inline ext4_fsblk_t ext4_blocks_count(struct ext4_super_block *es)
972{
973 return ((ext4_fsblk_t)le32_to_cpu(es->s_blocks_count_hi) << 32) |
974 le32_to_cpu(es->s_blocks_count);
975}
976
977static inline ext4_fsblk_t ext4_r_blocks_count(struct ext4_super_block *es)
978{
979 return ((ext4_fsblk_t)le32_to_cpu(es->s_r_blocks_count_hi) << 32) |
980 le32_to_cpu(es->s_r_blocks_count);
981}
982
983static inline ext4_fsblk_t ext4_free_blocks_count(struct ext4_super_block *es)
984{
985 return ((ext4_fsblk_t)le32_to_cpu(es->s_free_blocks_count_hi) << 32) |
986 le32_to_cpu(es->s_free_blocks_count);
987}
988
989static inline void ext4_blocks_count_set(struct ext4_super_block *es,
990 ext4_fsblk_t blk)
991{
992 es->s_blocks_count = cpu_to_le32((u32)blk);
993 es->s_blocks_count_hi = cpu_to_le32(blk >> 32);
994}
995
996static inline void ext4_free_blocks_count_set(struct ext4_super_block *es,
997 ext4_fsblk_t blk)
998{
999 es->s_free_blocks_count = cpu_to_le32((u32)blk);
1000 es->s_free_blocks_count_hi = cpu_to_le32(blk >> 32);
1001}
1002
1003static inline void ext4_r_blocks_count_set(struct ext4_super_block *es,
1004 ext4_fsblk_t blk)
1005{
1006 es->s_r_blocks_count = cpu_to_le32((u32)blk);
1007 es->s_r_blocks_count_hi = cpu_to_le32(blk >> 32);
1008}
1009
1010
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001011
Mingming Cao617ba132006-10-11 01:20:53 -07001012#define ext4_std_error(sb, errno) \
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001013do { \
1014 if ((errno)) \
Mingming Cao617ba132006-10-11 01:20:53 -07001015 __ext4_std_error((sb), __FUNCTION__, (errno)); \
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001016} while (0)
1017
1018/*
1019 * Inodes and files operations
1020 */
1021
1022/* dir.c */
Mingming Cao617ba132006-10-11 01:20:53 -07001023extern const struct file_operations ext4_dir_operations;
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001024
1025/* file.c */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08001026extern const struct inode_operations ext4_file_inode_operations;
Mingming Cao617ba132006-10-11 01:20:53 -07001027extern const struct file_operations ext4_file_operations;
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001028
1029/* namei.c */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08001030extern const struct inode_operations ext4_dir_inode_operations;
1031extern const struct inode_operations ext4_special_inode_operations;
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001032
1033/* symlink.c */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08001034extern const struct inode_operations ext4_symlink_inode_operations;
1035extern const struct inode_operations ext4_fast_symlink_inode_operations;
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001036
Alex Tomasa86c6182006-10-11 01:21:03 -07001037/* extents.c */
1038extern int ext4_ext_tree_init(handle_t *handle, struct inode *);
1039extern int ext4_ext_writepage_trans_blocks(struct inode *, int);
1040extern int ext4_ext_get_blocks(handle_t *handle, struct inode *inode,
1041 ext4_fsblk_t iblock,
1042 unsigned long max_blocks, struct buffer_head *bh_result,
1043 int create, int extend_disksize);
1044extern void ext4_ext_truncate(struct inode *, struct page *);
1045extern void ext4_ext_init(struct super_block *);
1046extern void ext4_ext_release(struct super_block *);
Amit Aroraa2df2a62007-07-17 21:42:41 -04001047extern long ext4_fallocate(struct inode *inode, int mode, loff_t offset,
1048 loff_t len);
Alex Tomasa86c6182006-10-11 01:21:03 -07001049static inline int
1050ext4_get_blocks_wrap(handle_t *handle, struct inode *inode, sector_t block,
1051 unsigned long max_blocks, struct buffer_head *bh,
1052 int create, int extend_disksize)
1053{
1054 if (EXT4_I(inode)->i_flags & EXT4_EXTENTS_FL)
1055 return ext4_ext_get_blocks(handle, inode, block, max_blocks,
1056 bh, create, extend_disksize);
1057 return ext4_get_blocks_handle(handle, inode, block, max_blocks, bh,
1058 create, extend_disksize);
1059}
1060
Dave Kleikampac27a0e2006-10-11 01:20:50 -07001061
1062#endif /* __KERNEL__ */
1063
Mingming Cao617ba132006-10-11 01:20:53 -07001064#endif /* _LINUX_EXT4_FS_H */