ifcpu64.c32: clean up the sources
[syslinux.git] / extlinux / ext2_fs.h
blobc0eeb7b759ec64270af0da922063cab7f5e5d0b2
1 /*
2 * linux/include/linux/ext2_fs.h
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)
9 * from
11 * linux/include/linux/minix_fs.h
13 * Copyright (C) 1991, 1992 Linus Torvalds
16 /* Private copy for extlinux */
18 #ifndef _LINUX_EXT2_FS_H
19 #define _LINUX_EXT2_FS_H
21 #include <linux/types.h>
24 * The second extended filesystem constants/structures
28 * Define EXT2FS_DEBUG to produce debug messages
30 #undef EXT2FS_DEBUG
33 * Define EXT2_PREALLOCATE to preallocate data blocks for expanding files
35 #define EXT2_PREALLOCATE
36 #define EXT2_DEFAULT_PREALLOC_BLOCKS 8
39 * The second extended file system version
41 #define EXT2FS_DATE "95/08/09"
42 #define EXT2FS_VERSION "0.5b"
45 * Debug code
47 #ifdef EXT2FS_DEBUG
48 # define ext2_debug(f, a...) { \
49 printk ("EXT2-fs DEBUG (%s, %d): %s:", \
50 __FILE__, __LINE__, __FUNCTION__); \
51 printk (f, ## a); \
53 #else
54 # define ext2_debug(f, a...) /**/
55 #endif
58 * Special inode numbers
60 #define EXT2_BAD_INO 1 /* Bad blocks inode */
61 #define EXT2_ROOT_INO 2 /* Root inode */
62 #define EXT2_ACL_IDX_INO 3 /* ACL inode */
63 #define EXT2_ACL_DATA_INO 4 /* ACL inode */
64 #define EXT2_BOOT_LOADER_INO 5 /* Boot loader inode */
65 #define EXT2_UNDEL_DIR_INO 6 /* Undelete directory inode */
67 /* First non-reserved inode for old ext2 filesystems */
68 #define EXT2_GOOD_OLD_FIRST_INO 11
71 * The second extended file system magic number
73 #define EXT2_SUPER_MAGIC 0xEF53
76 * Maximal count of links to a file
78 #define EXT2_LINK_MAX 32000
81 * Macro-instructions used to manage several block sizes
83 #define EXT2_MIN_BLOCK_SIZE 1024
84 #define EXT2_MAX_BLOCK_SIZE 4096
85 #define EXT2_MIN_BLOCK_LOG_SIZE 10
86 # define EXT2_BLOCK_SIZE(s) (EXT2_MIN_BLOCK_SIZE << (s)->s_log_block_size)
87 #define EXT2_ACLE_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof (struct ext2_acl_entry))
88 #define EXT2_ADDR_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof (__u32))
89 # define EXT2_BLOCK_SIZE_BITS(s) ((s)->s_log_block_size + 10)
90 #define EXT2_INODE_SIZE(s) (((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
91 EXT2_GOOD_OLD_INODE_SIZE : \
92 (s)->s_inode_size)
93 #define EXT2_FIRST_INO(s) (((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
94 EXT2_GOOD_OLD_FIRST_INO : \
95 (s)->s_first_ino)
98 * Macro-instructions used to manage fragments
100 #define EXT2_MIN_FRAG_SIZE 1024
101 #define EXT2_MAX_FRAG_SIZE 4096
102 #define EXT2_MIN_FRAG_LOG_SIZE 10
103 # define EXT2_FRAG_SIZE(s) (EXT2_MIN_FRAG_SIZE << (s)->s_log_frag_size)
104 # define EXT2_FRAGS_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / EXT2_FRAG_SIZE(s))
107 * ACL structures
109 struct ext2_acl_header /* Header of Access Control Lists */
111 __u32 aclh_size;
112 __u32 aclh_file_count;
113 __u32 aclh_acle_count;
114 __u32 aclh_first_acle;
117 struct ext2_acl_entry /* Access Control List Entry */
119 __u32 acle_size;
120 __u16 acle_perms; /* Access permissions */
121 __u16 acle_type; /* Type of entry */
122 __u16 acle_tag; /* User or group identity */
123 __u16 acle_pad1;
124 __u32 acle_next; /* Pointer on next entry for the */
125 /* same inode or on next free entry */
129 * Structure of a blocks group descriptor
131 struct ext2_group_desc
133 __u32 bg_block_bitmap; /* Blocks bitmap block */
134 __u32 bg_inode_bitmap; /* Inodes bitmap block */
135 __u32 bg_inode_table; /* Inodes table block */
136 __u16 bg_free_blocks_count; /* Free blocks count */
137 __u16 bg_free_inodes_count; /* Free inodes count */
138 __u16 bg_used_dirs_count; /* Directories count */
139 __u16 bg_pad;
140 __u32 bg_reserved[3];
144 * Macro-instructions used to manage group descriptors
146 # define EXT2_BLOCKS_PER_GROUP(s) ((s)->s_blocks_per_group)
147 # define EXT2_DESC_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof (struct ext2_group_desc))
148 # define EXT2_INODES_PER_GROUP(s) ((s)->s_inodes_per_group)
151 * Constants relative to the data blocks
153 #define EXT2_NDIR_BLOCKS 12
154 #define EXT2_IND_BLOCK EXT2_NDIR_BLOCKS
155 #define EXT2_DIND_BLOCK (EXT2_IND_BLOCK + 1)
156 #define EXT2_TIND_BLOCK (EXT2_DIND_BLOCK + 1)
157 #define EXT2_N_BLOCKS (EXT2_TIND_BLOCK + 1)
160 * Inode flags
162 #define EXT2_SECRM_FL 0x00000001 /* Secure deletion */
163 #define EXT2_UNRM_FL 0x00000002 /* Undelete */
164 #define EXT2_COMPR_FL 0x00000004 /* Compress file */
165 #define EXT2_SYNC_FL 0x00000008 /* Synchronous updates */
166 #define EXT2_IMMUTABLE_FL 0x00000010 /* Immutable file */
167 #define EXT2_APPEND_FL 0x00000020 /* writes to file may only append */
168 #define EXT2_NODUMP_FL 0x00000040 /* do not dump file */
169 #define EXT2_NOATIME_FL 0x00000080 /* do not update atime */
170 /* Reserved for compression usage... */
171 #define EXT2_DIRTY_FL 0x00000100
172 #define EXT2_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */
173 #define EXT2_NOCOMP_FL 0x00000400 /* Don't compress */
174 #define EXT2_ECOMPR_FL 0x00000800 /* Compression error */
175 /* End compression flags --- maybe not all used */
176 #define EXT2_BTREE_FL 0x00001000 /* btree format dir */
177 #define EXT2_RESERVED_FL 0x80000000 /* reserved for ext2 lib */
179 #define EXT2_FL_USER_VISIBLE 0x00001FFF /* User visible flags */
180 #define EXT2_FL_USER_MODIFIABLE 0x000000FF /* User modifiable flags */
183 * ioctl commands
185 #define EXT2_IOC_GETFLAGS _IOR('f', 1, long)
186 #define EXT2_IOC_SETFLAGS _IOW('f', 2, long)
187 #define EXT2_IOC_GETVERSION _IOR('v', 1, long)
188 #define EXT2_IOC_SETVERSION _IOW('v', 2, long)
191 * Structure of an inode on the disk
193 struct ext2_inode {
194 __u16 i_mode; /* File mode */
195 __u16 i_uid; /* Low 16 bits of Owner Uid */
196 __u32 i_size; /* Size in bytes */
197 __u32 i_atime; /* Access time */
198 __u32 i_ctime; /* Creation time */
199 __u32 i_mtime; /* Modification time */
200 __u32 i_dtime; /* Deletion Time */
201 __u16 i_gid; /* Low 16 bits of Group Id */
202 __u16 i_links_count; /* Links count */
203 __u32 i_blocks; /* Blocks count */
204 __u32 i_flags; /* File flags */
205 union {
206 struct {
207 __u32 l_i_reserved1;
208 } linux1;
209 struct {
210 __u32 h_i_translator;
211 } hurd1;
212 struct {
213 __u32 m_i_reserved1;
214 } masix1;
215 } osd1; /* OS dependent 1 */
216 __u32 i_block[EXT2_N_BLOCKS];/* Pointers to blocks */
217 __u32 i_generation; /* File version (for NFS) */
218 __u32 i_file_acl; /* File ACL */
219 __u32 i_dir_acl; /* Directory ACL */
220 __u32 i_faddr; /* Fragment address */
221 union {
222 struct {
223 __u8 l_i_frag; /* Fragment number */
224 __u8 l_i_fsize; /* Fragment size */
225 __u16 i_pad1;
226 __u16 l_i_uid_high; /* these 2 fields */
227 __u16 l_i_gid_high; /* were reserved2[0] */
228 __u32 l_i_reserved2;
229 } linux2;
230 struct {
231 __u8 h_i_frag; /* Fragment number */
232 __u8 h_i_fsize; /* Fragment size */
233 __u16 h_i_mode_high;
234 __u16 h_i_uid_high;
235 __u16 h_i_gid_high;
236 __u32 h_i_author;
237 } hurd2;
238 struct {
239 __u8 m_i_frag; /* Fragment number */
240 __u8 m_i_fsize; /* Fragment size */
241 __u16 m_pad1;
242 __u32 m_i_reserved2[2];
243 } masix2;
244 } osd2; /* OS dependent 2 */
247 #define i_size_high i_dir_acl
249 #if defined(__KERNEL__) || defined(__linux__)
250 #define i_reserved1 osd1.linux1.l_i_reserved1
251 #define i_frag osd2.linux2.l_i_frag
252 #define i_fsize osd2.linux2.l_i_fsize
253 #define i_uid_low i_uid
254 #define i_gid_low i_gid
255 #define i_uid_high osd2.linux2.l_i_uid_high
256 #define i_gid_high osd2.linux2.l_i_gid_high
257 #define i_reserved2 osd2.linux2.l_i_reserved2
258 #endif
260 #ifdef __hurd__
261 #define i_translator osd1.hurd1.h_i_translator
262 #define i_frag osd2.hurd2.h_i_frag;
263 #define i_fsize osd2.hurd2.h_i_fsize;
264 #define i_uid_high osd2.hurd2.h_i_uid_high
265 #define i_gid_high osd2.hurd2.h_i_gid_high
266 #define i_author osd2.hurd2.h_i_author
267 #endif
269 #ifdef __masix__
270 #define i_reserved1 osd1.masix1.m_i_reserved1
271 #define i_frag osd2.masix2.m_i_frag
272 #define i_fsize osd2.masix2.m_i_fsize
273 #define i_reserved2 osd2.masix2.m_i_reserved2
274 #endif
277 * File system states
279 #define EXT2_VALID_FS 0x0001 /* Unmounted cleanly */
280 #define EXT2_ERROR_FS 0x0002 /* Errors detected */
283 * Mount flags
285 #define EXT2_MOUNT_CHECK 0x0001 /* Do mount-time checks */
286 #define EXT2_MOUNT_GRPID 0x0004 /* Create files with directory's group */
287 #define EXT2_MOUNT_DEBUG 0x0008 /* Some debugging messages */
288 #define EXT2_MOUNT_ERRORS_CONT 0x0010 /* Continue on errors */
289 #define EXT2_MOUNT_ERRORS_RO 0x0020 /* Remount fs ro on errors */
290 #define EXT2_MOUNT_ERRORS_PANIC 0x0040 /* Panic on errors */
291 #define EXT2_MOUNT_MINIX_DF 0x0080 /* Mimics the Minix statfs */
292 #define EXT2_MOUNT_NO_UID32 0x0200 /* Disable 32-bit UIDs */
294 #define clear_opt(o, opt) o &= ~EXT2_MOUNT_##opt
295 #define set_opt(o, opt) o |= EXT2_MOUNT_##opt
296 #define test_opt(sb, opt) ((sb)->u.ext2_sb.s_mount_opt & \
297 EXT2_MOUNT_##opt)
299 * Maximal mount counts between two filesystem checks
301 #define EXT2_DFL_MAX_MNT_COUNT 20 /* Allow 20 mounts */
302 #define EXT2_DFL_CHECKINTERVAL 0 /* Don't use interval check */
305 * Behaviour when detecting errors
307 #define EXT2_ERRORS_CONTINUE 1 /* Continue execution */
308 #define EXT2_ERRORS_RO 2 /* Remount fs read-only */
309 #define EXT2_ERRORS_PANIC 3 /* Panic */
310 #define EXT2_ERRORS_DEFAULT EXT2_ERRORS_CONTINUE
313 * Structure of the super block
315 struct ext2_super_block {
316 __u32 s_inodes_count; /* Inodes count */
317 __u32 s_blocks_count; /* Blocks count */
318 __u32 s_r_blocks_count; /* Reserved blocks count */
319 __u32 s_free_blocks_count; /* Free blocks count */
320 __u32 s_free_inodes_count; /* Free inodes count */
321 __u32 s_first_data_block; /* First Data Block */
322 __u32 s_log_block_size; /* Block size */
323 __s32 s_log_frag_size; /* Fragment size */
324 __u32 s_blocks_per_group; /* # Blocks per group */
325 __u32 s_frags_per_group; /* # Fragments per group */
326 __u32 s_inodes_per_group; /* # Inodes per group */
327 __u32 s_mtime; /* Mount time */
328 __u32 s_wtime; /* Write time */
329 __u16 s_mnt_count; /* Mount count */
330 __s16 s_max_mnt_count; /* Maximal mount count */
331 __u16 s_magic; /* Magic signature */
332 __u16 s_state; /* File system state */
333 __u16 s_errors; /* Behaviour when detecting errors */
334 __u16 s_minor_rev_level; /* minor revision level */
335 __u32 s_lastcheck; /* time of last check */
336 __u32 s_checkinterval; /* max. time between checks */
337 __u32 s_creator_os; /* OS */
338 __u32 s_rev_level; /* Revision level */
339 __u16 s_def_resuid; /* Default uid for reserved blocks */
340 __u16 s_def_resgid; /* Default gid for reserved blocks */
342 * These fields are for EXT2_DYNAMIC_REV superblocks only.
344 * Note: the difference between the compatible feature set and
345 * the incompatible feature set is that if there is a bit set
346 * in the incompatible feature set that the kernel doesn't
347 * know about, it should refuse to mount the filesystem.
349 * e2fsck's requirements are more strict; if it doesn't know
350 * about a feature in either the compatible or incompatible
351 * feature set, it must abort and not try to meddle with
352 * things it doesn't understand...
354 __u32 s_first_ino; /* First non-reserved inode */
355 __u16 s_inode_size; /* size of inode structure */
356 __u16 s_block_group_nr; /* block group # of this superblock */
357 __u32 s_feature_compat; /* compatible feature set */
358 __u32 s_feature_incompat; /* incompatible feature set */
359 __u32 s_feature_ro_compat; /* readonly-compatible feature set */
360 __u8 s_uuid[16]; /* 128-bit uuid for volume */
361 char s_volume_name[16]; /* volume name */
362 char s_last_mounted[64]; /* directory where last mounted */
363 __u32 s_algorithm_usage_bitmap; /* For compression */
365 * Performance hints. Directory preallocation should only
366 * happen if the EXT2_COMPAT_PREALLOC flag is on.
368 __u8 s_prealloc_blocks; /* Nr of blocks to try to preallocate*/
369 __u8 s_prealloc_dir_blocks; /* Nr to preallocate for dirs */
370 __u16 s_padding1;
371 __u32 s_reserved[204]; /* Padding to the end of the block */
374 /* Assume that user mode programs are passing in an ext2fs superblock, not
375 * a kernel struct super_block. This will allow us to call the feature-test
376 * macros from user land. */
377 #define EXT2_SB(sb) (sb)
380 * Codes for operating systems
382 #define EXT2_OS_LINUX 0
383 #define EXT2_OS_HURD 1
384 #define EXT2_OS_MASIX 2
385 #define EXT2_OS_FREEBSD 3
386 #define EXT2_OS_LITES 4
389 * Revision levels
391 #define EXT2_GOOD_OLD_REV 0 /* The good old (original) format */
392 #define EXT2_DYNAMIC_REV 1 /* V2 format w/ dynamic inode sizes */
394 #define EXT2_CURRENT_REV EXT2_GOOD_OLD_REV
395 #define EXT2_MAX_SUPP_REV EXT2_DYNAMIC_REV
397 #define EXT2_GOOD_OLD_INODE_SIZE 128
400 * Feature set definitions
403 #define EXT2_HAS_COMPAT_FEATURE(sb,mask) \
404 ( EXT2_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask) )
405 #define EXT2_HAS_RO_COMPAT_FEATURE(sb,mask) \
406 ( EXT2_SB(sb)->s_es->s_feature_ro_compat & cpu_to_le32(mask) )
407 #define EXT2_HAS_INCOMPAT_FEATURE(sb,mask) \
408 ( EXT2_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask) )
409 #define EXT2_SET_COMPAT_FEATURE(sb,mask) \
410 EXT2_SB(sb)->s_es->s_feature_compat |= cpu_to_le32(mask)
411 #define EXT2_SET_RO_COMPAT_FEATURE(sb,mask) \
412 EXT2_SB(sb)->s_es->s_feature_ro_compat |= cpu_to_le32(mask)
413 #define EXT2_SET_INCOMPAT_FEATURE(sb,mask) \
414 EXT2_SB(sb)->s_es->s_feature_incompat |= cpu_to_le32(mask)
415 #define EXT2_CLEAR_COMPAT_FEATURE(sb,mask) \
416 EXT2_SB(sb)->s_es->s_feature_compat &= ~cpu_to_le32(mask)
417 #define EXT2_CLEAR_RO_COMPAT_FEATURE(sb,mask) \
418 EXT2_SB(sb)->s_es->s_feature_ro_compat &= ~cpu_to_le32(mask)
419 #define EXT2_CLEAR_INCOMPAT_FEATURE(sb,mask) \
420 EXT2_SB(sb)->s_es->s_feature_incompat &= ~cpu_to_le32(mask)
422 #define EXT2_FEATURE_COMPAT_DIR_PREALLOC 0x0001
423 #define EXT2_FEATURE_COMPAT_IMAGIC_INODES 0x0002
424 #define EXT3_FEATURE_COMPAT_HAS_JOURNAL 0x0004
425 #define EXT2_FEATURE_COMPAT_EXT_ATTR 0x0008
426 #define EXT2_FEATURE_COMPAT_RESIZE_INO 0x0010
427 #define EXT2_FEATURE_COMPAT_DIR_INDEX 0x0020
428 #define EXT2_FEATURE_COMPAT_ANY 0xffffffff
430 #define EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER 0x0001
431 #define EXT2_FEATURE_RO_COMPAT_LARGE_FILE 0x0002
432 #define EXT2_FEATURE_RO_COMPAT_BTREE_DIR 0x0004
433 #define EXT2_FEATURE_RO_COMPAT_ANY 0xffffffff
435 #define EXT2_FEATURE_INCOMPAT_COMPRESSION 0x0001
436 #define EXT2_FEATURE_INCOMPAT_FILETYPE 0x0002
437 #define EXT3_FEATURE_INCOMPAT_RECOVER 0x0004
438 #define EXT3_FEATURE_INCOMPAT_JOURNAL_DEV 0x0008
439 #define EXT2_FEATURE_INCOMPAT_ANY 0xffffffff
441 #define EXT2_FEATURE_COMPAT_SUPP 0
442 #define EXT2_FEATURE_INCOMPAT_SUPP EXT2_FEATURE_INCOMPAT_FILETYPE
443 #define EXT2_FEATURE_RO_COMPAT_SUPP (EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER| \
444 EXT2_FEATURE_RO_COMPAT_LARGE_FILE| \
445 EXT2_FEATURE_RO_COMPAT_BTREE_DIR)
446 #define EXT2_FEATURE_RO_COMPAT_UNSUPPORTED ~EXT2_FEATURE_RO_COMPAT_SUPP
447 #define EXT2_FEATURE_INCOMPAT_UNSUPPORTED ~EXT2_FEATURE_INCOMPAT_SUPP
450 * Default values for user and/or group using reserved blocks
452 #define EXT2_DEF_RESUID 0
453 #define EXT2_DEF_RESGID 0
456 * Structure of a directory entry
458 #define EXT2_NAME_LEN 255
460 struct ext2_dir_entry {
461 __u32 inode; /* Inode number */
462 __u16 rec_len; /* Directory entry length */
463 __u16 name_len; /* Name length */
464 char name[EXT2_NAME_LEN]; /* File name */
468 * The new version of the directory entry. Since EXT2 structures are
469 * stored in intel byte order, and the name_len field could never be
470 * bigger than 255 chars, it's safe to reclaim the extra byte for the
471 * file_type field.
473 struct ext2_dir_entry_2 {
474 __u32 inode; /* Inode number */
475 __u16 rec_len; /* Directory entry length */
476 __u8 name_len; /* Name length */
477 __u8 file_type;
478 char name[EXT2_NAME_LEN]; /* File name */
482 * Ext2 directory file types. Only the low 3 bits are used. The
483 * other bits are reserved for now.
485 enum {
486 EXT2_FT_UNKNOWN,
487 EXT2_FT_REG_FILE,
488 EXT2_FT_DIR,
489 EXT2_FT_CHRDEV,
490 EXT2_FT_BLKDEV,
491 EXT2_FT_FIFO,
492 EXT2_FT_SOCK,
493 EXT2_FT_SYMLINK,
494 EXT2_FT_MAX
498 * EXT2_DIR_PAD defines the directory entries boundaries
500 * NOTE: It must be a multiple of 4
502 #define EXT2_DIR_PAD 4
503 #define EXT2_DIR_ROUND (EXT2_DIR_PAD - 1)
504 #define EXT2_DIR_REC_LEN(name_len) (((name_len) + 8 + EXT2_DIR_ROUND) & \
505 ~EXT2_DIR_ROUND)
508 #endif /* _LINUX_EXT2_FS_H */