Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / e2fsprogs_custom / 24757fa0468170e1420087eef36219650dba8c07 / . / include / linux / ext2_fs.h
blob: 649f7decf5a64b91d4317fc9d308215bfbc2620e [file] [log] [blame]
Theodore Ts'o50e1e101997-04-26 13:58:21 +0000[diff] [blame]1/*
2 * linux/include/linux/ext2_fs.h
3 *
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
16#ifndef _LINUX_EXT2_FS_H
17#define _LINUX_EXT2_FS_H
18
19#include <linux/types.h>
20
21/*
22 * The second extended filesystem constants/structures
23 */
24
25/*
26 * Define EXT2FS_DEBUG to produce debug messages
27 */
28#undef EXT2FS_DEBUG
29
30/*
31 * Define EXT2_PREALLOCATE to preallocate data blocks for expanding files
32 */
33#define EXT2_PREALLOCATE
34
35/*
36 * The second extended file system version
37 */
38#define EXT2FS_DATE "95/08/09"
39#define EXT2FS_VERSION "0.5b"
40
41/*
Theodore Ts'o50e1e101997-04-26 13:58:21 +0000[diff] [blame]42 * Special inodes numbers
43 */
44#define EXT2_BAD_INO 1 /* Bad blocks inode */
45#define EXT2_ROOT_INO 2 /* Root inode */
46#define EXT2_ACL_IDX_INO 3 /* ACL inode */
47#define EXT2_ACL_DATA_INO 4 /* ACL inode */
48#define EXT2_BOOT_LOADER_INO 5 /* Boot loader inode */
49#define EXT2_UNDEL_DIR_INO 6 /* Undelete directory inode */
50#define EXT2_FIRST_INO 11 /* First non reserved inode */
51
52/*
53 * The second extended file system magic number
54 */
55#define EXT2_SUPER_MAGIC 0xEF53
56
57/*
58 * Maximal count of links to a file
59 */
60#define EXT2_LINK_MAX 32000
61
62/*
63 * Macro-instructions used to manage several block sizes
64 */
65#define EXT2_MIN_BLOCK_SIZE 1024
66#define EXT2_MAX_BLOCK_SIZE 4096
67#define EXT2_MIN_BLOCK_LOG_SIZE 10
68#ifdef __KERNEL__
69# define EXT2_BLOCK_SIZE(s) ((s)->s_blocksize)
70#else
71# define EXT2_BLOCK_SIZE(s) (EXT2_MIN_BLOCK_SIZE << (s)->s_log_block_size)
72#endif
73#define EXT2_ACLE_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof (struct ext2_acl_entry))
74#define EXT2_ADDR_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof (__u32))
75#ifdef __KERNEL__
76# define EXT2_BLOCK_SIZE_BITS(s) ((s)->s_blocksize_bits)
77#else
78# define EXT2_BLOCK_SIZE_BITS(s) ((s)->s_log_block_size + 10)
79#endif
80#define EXT2_INODES_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof (struct ext2_inode))
81#ifdef __KERNEL__
82#define EXT2_ADDR_PER_BLOCK_BITS(s) ((s)->u.ext2_sb.s_addr_per_block_bits)
83#define EXT2_INODES_PER_BLOCK_BITS(s) ((s)->u.ext2_sb.s_inodes_per_block_bits)
84#endif
85
86/*
87 * Macro-instructions used to manage fragments
88 */
89#define EXT2_MIN_FRAG_SIZE 1024
90#define EXT2_MAX_FRAG_SIZE 4096
91#define EXT2_MIN_FRAG_LOG_SIZE 10
92#ifdef __KERNEL__
93# define EXT2_FRAG_SIZE(s) ((s)->u.ext2_sb.s_frag_size)
94# define EXT2_FRAGS_PER_BLOCK(s) ((s)->u.ext2_sb.s_frags_per_block)
95#else
96# define EXT2_FRAG_SIZE(s) (EXT2_MIN_FRAG_SIZE << (s)->s_log_frag_size)
97# define EXT2_FRAGS_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / EXT2_FRAG_SIZE(s))
98#endif
99
100/*
101 * ACL structures
102 */
103struct ext2_acl_header /* Header of Access Control Lists */
104{
105 __u32 aclh_size;
106 __u32 aclh_file_count;
107 __u32 aclh_acle_count;
108 __u32 aclh_first_acle;
109};
110
111struct ext2_acl_entry /* Access Control List Entry */
112{
113 __u32 acle_size;
114 __u16 acle_perms; /* Access permissions */
115 __u16 acle_type; /* Type of entry */
116 __u16 acle_tag; /* User or group identity */
117 __u16 acle_pad1;
118 __u32 acle_next; /* Pointer on next entry for the */
119 /* same inode or on next free entry */
120};
121
122/*
123 * Structure of a blocks group descriptor
124 */
125struct ext2_group_desc
126{
127 __u32 bg_block_bitmap; /* Blocks bitmap block */
128 __u32 bg_inode_bitmap; /* Inodes bitmap block */
129 __u32 bg_inode_table; /* Inodes table block */
130 __u16 bg_free_blocks_count; /* Free blocks count */
131 __u16 bg_free_inodes_count; /* Free inodes count */
132 __u16 bg_used_dirs_count; /* Directories count */
133 __u16 bg_pad;
134 __u32 bg_reserved[3];
135};
136
137/*
138 * Macro-instructions used to manage group descriptors
139 */
140#ifdef __KERNEL__
141# define EXT2_BLOCKS_PER_GROUP(s) ((s)->u.ext2_sb.s_blocks_per_group)
142# define EXT2_DESC_PER_BLOCK(s) ((s)->u.ext2_sb.s_desc_per_block)
143# define EXT2_INODES_PER_GROUP(s) ((s)->u.ext2_sb.s_inodes_per_group)
144# define EXT2_DESC_PER_BLOCK_BITS(s) ((s)->u.ext2_sb.s_desc_per_block_bits)
145#else
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)
149#endif
150
151/*
152 * Constants relative to the data blocks
153 */
154#define EXT2_NDIR_BLOCKS 12
155#define EXT2_IND_BLOCK EXT2_NDIR_BLOCKS
156#define EXT2_DIND_BLOCK (EXT2_IND_BLOCK + 1)
157#define EXT2_TIND_BLOCK (EXT2_DIND_BLOCK + 1)
158#define EXT2_N_BLOCKS (EXT2_TIND_BLOCK + 1)
159
160/*
161 * Inode flags
162 */
163#define EXT2_SECRM_FL 0x00000001 /* Secure deletion */
164#define EXT2_UNRM_FL 0x00000002 /* Undelete */
165#define EXT2_COMPR_FL 0x00000004 /* Compress file */
166#define EXT2_SYNC_FL 0x00000008 /* Synchronous updates */
167#define EXT2_IMMUTABLE_FL 0x00000010 /* Immutable file */
168#define EXT2_APPEND_FL 0x00000020 /* writes to file may only append */
169#define EXT2_NODUMP_FL 0x00000040 /* do not dump file */
170
171/*
172 * ioctl commands
173 */
174#define EXT2_IOC_GETFLAGS _IOR('f', 1, long)
175#define EXT2_IOC_SETFLAGS _IOW('f', 2, long)
176#define EXT2_IOC_GETVERSION _IOR('v', 1, long)
177#define EXT2_IOC_SETVERSION _IOW('v', 2, long)
178
179/*
180 * Structure of an inode on the disk
181 */
182struct ext2_inode {
183 __u16 i_mode; /* File mode */
184 __u16 i_uid; /* Owner Uid */
185 __u32 i_size; /* Size in bytes */
186 __u32 i_atime; /* Access time */
187 __u32 i_ctime; /* Creation time */
188 __u32 i_mtime; /* Modification time */
189 __u32 i_dtime; /* Deletion Time */
190 __u16 i_gid; /* Group Id */
191 __u16 i_links_count; /* Links count */
192 __u32 i_blocks; /* Blocks count */
193 __u32 i_flags; /* File flags */
194 union {
195 struct {
196 __u32 l_i_reserved1;
197 } linux1;
198 struct {
199 __u32 h_i_translator;
200 } hurd1;
201 struct {
202 __u32 m_i_reserved1;
203 } masix1;
204 } osd1; /* OS dependent 1 */
205 __u32 i_block[EXT2_N_BLOCKS];/* Pointers to blocks */
206 __u32 i_version; /* File version (for NFS) */
207 __u32 i_file_acl; /* File ACL */
208 __u32 i_dir_acl; /* Directory ACL */
209 __u32 i_faddr; /* Fragment address */
210 union {
211 struct {
212 __u8 l_i_frag; /* Fragment number */
213 __u8 l_i_fsize; /* Fragment size */
214 __u16 i_pad1;
215 __u32 l_i_reserved2[2];
216 } linux2;
217 struct {
218 __u8 h_i_frag; /* Fragment number */
219 __u8 h_i_fsize; /* Fragment size */
220 __u16 h_i_mode_high;
221 __u16 h_i_uid_high;
222 __u16 h_i_gid_high;
223 __u32 h_i_author;
224 } hurd2;
225 struct {
226 __u8 m_i_frag; /* Fragment number */
227 __u8 m_i_fsize; /* Fragment size */
228 __u16 m_pad1;
229 __u32 m_i_reserved2[2];
230 } masix2;
231 } osd2; /* OS dependent 2 */
232};
233
234#if defined(__KERNEL__) || defined(__linux__)
235#define i_reserved1 osd1.linux1.l_i_reserved1
236#define i_frag osd2.linux2.l_i_frag
237#define i_fsize osd2.linux2.l_i_fsize
238#define i_reserved2 osd2.linux2.l_i_reserved2
239#endif
240
241#ifdef __hurd__
242#define i_translator osd1.hurd1.h_i_translator
243#define i_frag osd2.hurd2.h_i_frag;
244#define i_fsize osd2.hurd2.h_i_fsize;
245#define i_uid_high osd2.hurd2.h_i_uid_high
246#define i_gid_high osd2.hurd2.h_i_gid_high
247#define i_author osd2.hurd2.h_i_author
248#endif
249
250#ifdef __masix__
251#define i_reserved1 osd1.masix1.m_i_reserved1
252#define i_frag osd2.masix2.m_i_frag
253#define i_fsize osd2.masix2.m_i_fsize
254#define i_reserved2 osd2.masix2.m_i_reserved2
255#endif
256
257/*
258 * File system states
259 */
260#define EXT2_VALID_FS 0x0001 /* Unmounted cleanly */
261#define EXT2_ERROR_FS 0x0002 /* Errors detected */
262
263/*
264 * Mount flags
265 */
266#define EXT2_MOUNT_CHECK_NORMAL 0x0001 /* Do some more checks */
267#define EXT2_MOUNT_CHECK_STRICT 0x0002 /* Do again more checks */
268#define EXT2_MOUNT_CHECK (EXT2_MOUNT_CHECK_NORMAL | \
269 EXT2_MOUNT_CHECK_STRICT)
270#define EXT2_MOUNT_GRPID 0x0004 /* Create files with directory's group */
271#define EXT2_MOUNT_DEBUG 0x0008 /* Some debugging messages */
272#define EXT2_MOUNT_ERRORS_CONT 0x0010 /* Continue on errors */
273#define EXT2_MOUNT_ERRORS_RO 0x0020 /* Remount fs ro on errors */
274#define EXT2_MOUNT_ERRORS_PANIC 0x0040 /* Panic on errors */
275#define EXT2_MOUNT_MINIX_DF 0x0080 /* Mimics the Minix statfs */
276
277#define clear_opt(o, opt) o &= ~EXT2_MOUNT_##opt
278#define set_opt(o, opt) o |= EXT2_MOUNT_##opt
279#define test_opt(sb, opt) ((sb)->u.ext2_sb.s_mount_opt & \
280 EXT2_MOUNT_##opt)
281/*
282 * Maximal mount counts between two filesystem checks
283 */
284#define EXT2_DFL_MAX_MNT_COUNT 20 /* Allow 20 mounts */
285#define EXT2_DFL_CHECKINTERVAL 0 /* Don't use interval check */
286
287/*
288 * Behaviour when detecting errors
289 */
290#define EXT2_ERRORS_CONTINUE 1 /* Continue execution */
291#define EXT2_ERRORS_RO 2 /* Remount fs read-only */
292#define EXT2_ERRORS_PANIC 3 /* Panic */
293#define EXT2_ERRORS_DEFAULT EXT2_ERRORS_CONTINUE
294
295/*
296 * Structure of the super block
297 */
298struct ext2_super_block {
299 __u32 s_inodes_count; /* Inodes count */
300 __u32 s_blocks_count; /* Blocks count */
301 __u32 s_r_blocks_count; /* Reserved blocks count */
302 __u32 s_free_blocks_count; /* Free blocks count */
303 __u32 s_free_inodes_count; /* Free inodes count */
304 __u32 s_first_data_block; /* First Data Block */
305 __u32 s_log_block_size; /* Block size */
306 __s32 s_log_frag_size; /* Fragment size */
307 __u32 s_blocks_per_group; /* # Blocks per group */
308 __u32 s_frags_per_group; /* # Fragments per group */
309 __u32 s_inodes_per_group; /* # Inodes per group */
310 __u32 s_mtime; /* Mount time */
311 __u32 s_wtime; /* Write time */
312 __u16 s_mnt_count; /* Mount count */
313 __s16 s_max_mnt_count; /* Maximal mount count */
314 __u16 s_magic; /* Magic signature */
315 __u16 s_state; /* File system state */
316 __u16 s_errors; /* Behaviour when detecting errors */
317 __u16 s_pad;
318 __u32 s_lastcheck; /* time of last check */
319 __u32 s_checkinterval; /* max. time between checks */
320 __u32 s_creator_os; /* OS */
321 __u32 s_rev_level; /* Revision level */
322 __u16 s_def_resuid; /* Default uid for reserved blocks */
323 __u16 s_def_resgid; /* Default gid for reserved blocks */
324 __u32 s_reserved[235]; /* Padding to the end of the block */
325};
326
327/*
328 * Codes for operating systems
329 */
330#define EXT2_OS_LINUX 0
331#define EXT2_OS_HURD 1
332#define EXT2_OS_MASIX 2
333#define EXT2_OS_FREEBSD 3
334#define EXT2_OS_LITES 4
335
336/*
337 * Revision levels
338 */
339#define EXT2_GOOD_OLD_REV 0 /* The good old (original) format */
340
341#define EXT2_CURRENT_REV EXT2_GOOD_OLD_REV
342
343/*
344 * Default values for user and/or group using reserved blocks
345 */
346#define EXT2_DEF_RESUID 0
347#define EXT2_DEF_RESGID 0
348
349/*
350 * Structure of a directory entry
351 */
352#define EXT2_NAME_LEN 255
353
354struct ext2_dir_entry {
355 __u32 inode; /* Inode number */
356 __u16 rec_len; /* Directory entry length */
357 __u16 name_len; /* Name length */
358 char name[EXT2_NAME_LEN]; /* File name */
359};
360
361/*
362 * EXT2_DIR_PAD defines the directory entries boundaries
363 *
364 * NOTE: It must be a multiple of 4
365 */
366#define EXT2_DIR_PAD 4
367#define EXT2_DIR_ROUND (EXT2_DIR_PAD - 1)
368#define EXT2_DIR_REC_LEN(name_len) (((name_len) + 8 + EXT2_DIR_ROUND) & \
369 ~EXT2_DIR_ROUND)
370
371#ifdef __KERNEL__
372/*
373 * Function prototypes
374 */
375
376/*
377 * Ok, these declarations are also in <linux/kernel.h> but none of the
378 * ext2 source programs needs to include it so they are duplicated here.
379 */
380#if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5)
381# define NORET_TYPE __volatile__
382# define ATTRIB_NORET /**/
383# define NORET_AND /**/
384#else
385# define NORET_TYPE /**/
386# define ATTRIB_NORET __attribute__((noreturn))
387# define NORET_AND noreturn,
388#endif
389
390/* acl.c */
391extern int ext2_permission (struct inode *, int);
392
393/* balloc.c */
394extern int ext2_new_block (struct super_block *, unsigned long,
395 __u32 *, __u32 *);
396extern void ext2_free_blocks (struct super_block *, unsigned long,
397 unsigned long);
398extern unsigned long ext2_count_free_blocks (struct super_block *);
399extern void ext2_check_blocks_bitmap (struct super_block *);
400
401/* bitmap.c */
402extern unsigned long ext2_count_free (struct buffer_head *, unsigned);
403
404/* dir.c */
405extern int ext2_check_dir_entry (const char *, struct inode *,
406 struct ext2_dir_entry *, struct buffer_head *,
407 unsigned long);
408
409/* file.c */
410extern int ext2_read (struct inode *, struct file *, char *, int);
411extern int ext2_write (struct inode *, struct file *, char *, int);
412
413/* fsync.c */
414extern int ext2_sync_file (struct inode *, struct file *);
415
416/* ialloc.c */
417extern struct inode * ext2_new_inode (const struct inode *, int);
418extern void ext2_free_inode (struct inode *);
419extern unsigned long ext2_count_free_inodes (struct super_block *);
420extern void ext2_check_inodes_bitmap (struct super_block *);
421
422/* inode.c */
423extern int ext2_bmap (struct inode *, int);
424
425extern struct buffer_head * ext2_getblk (struct inode *, long, int, int *);
426extern struct buffer_head * ext2_bread (struct inode *, int, int, int *);
427
428extern int ext2_getcluster (struct inode * inode, long block);
429extern void ext2_read_inode (struct inode *);
430extern void ext2_write_inode (struct inode *);
431extern void ext2_put_inode (struct inode *);
432extern int ext2_sync_inode (struct inode *);
433extern void ext2_discard_prealloc (struct inode *);
434
435/* ioctl.c */
436extern int ext2_ioctl (struct inode *, struct file *, unsigned int,
437 unsigned long);
438
439/* namei.c */
440extern void ext2_release (struct inode *, struct file *);
441extern int ext2_lookup (struct inode *,const char *, int, struct inode **);
442extern int ext2_create (struct inode *,const char *, int, int,
443 struct inode **);
444extern int ext2_mkdir (struct inode *, const char *, int, int);
445extern int ext2_rmdir (struct inode *, const char *, int);
446extern int ext2_unlink (struct inode *, const char *, int);
447extern int ext2_symlink (struct inode *, const char *, int, const char *);
448extern int ext2_link (struct inode *, struct inode *, const char *, int);
449extern int ext2_mknod (struct inode *, const char *, int, int, int);
450extern int ext2_rename (struct inode *, const char *, int,
451 struct inode *, const char *, int);
452
453/* super.c */
454extern void ext2_error (struct super_block *, const char *, const char *, ...)
455 __attribute__ ((format (printf, 3, 4)));
456extern NORET_TYPE void ext2_panic (struct super_block *, const char *,
457 const char *, ...)
458 __attribute__ ((NORET_AND format (printf, 3, 4)));
459extern void ext2_warning (struct super_block *, const char *, const char *, ...)
460 __attribute__ ((format (printf, 3, 4)));
461extern void ext2_put_super (struct super_block *);
462extern void ext2_write_super (struct super_block *);
463extern int ext2_remount (struct super_block *, int *, char *);
464extern struct super_block * ext2_read_super (struct super_block *,void *,int);
465extern void ext2_statfs (struct super_block *, struct statfs *, int);
466
467/* truncate.c */
468extern void ext2_truncate (struct inode *);
469
470/*
471 * Inodes and files operations
472 */
473
474/* dir.c */
475extern struct inode_operations ext2_dir_inode_operations;
476
477/* file.c */
478extern struct inode_operations ext2_file_inode_operations;
479
480/* symlink.c */
481extern struct inode_operations ext2_symlink_inode_operations;
482
483#endif /* __KERNEL__ */
484
485#endif /* _LINUX_EXT2_FS_H */