]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/ext3_fs.h
projects / mirror_ubuntu-bionic-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
printk: remove bounds checking for log_prefix
[mirror_ubuntu-bionic-kernel.git] / include / linux / ext3_fs.h
CommitLineData
1da177e4
LT		 1/*
2 * linux/include/linux/ext3_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_EXT3_FS_H
17#define _LINUX_EXT3_FS_H
18
19#include <linux/types.h>
e18fa700 20#include <linux/magic.h>
1da177e4
LT		 21
22/*
23 * The second extended filesystem constants/structures
24 */
25
26/*
27 * Define EXT3FS_DEBUG to produce debug messages
28 */
29#undef EXT3FS_DEBUG
30
31/*
32 * Define EXT3_RESERVATION to reserve data blocks for expanding files
33 */
34#define EXT3_DEFAULT_RESERVE_BLOCKS 8
b54e41ec
MC		 35/*max window size: 1024(direct blocks) + 3([t,d]indirect blocks) */
36#define EXT3_MAX_RESERVE_BLOCKS 1027
1da177e4 37#define EXT3_RESERVE_WINDOW_NOT_ALLOCATED 0
1da177e4
LT		 38
39/*
40 * Debug code
41 */
42#ifdef EXT3FS_DEBUG
43#define ext3_debug(f, a...) \
44 do { \
45 printk (KERN_DEBUG "EXT3-fs DEBUG (%s, %d): %s:", \
d5c003b4 46 __FILE__, __LINE__, __func__); \
1da177e4
LT		 47 printk (KERN_DEBUG f, ## a); \
48 } while (0)
49#else
50#define ext3_debug(f, a...) do {} while (0)
51#endif
52
53/*
54 * Special inodes numbers
55 */
56#define EXT3_BAD_INO 1 /* Bad blocks inode */
57#define EXT3_ROOT_INO 2 /* Root inode */
58#define EXT3_BOOT_LOADER_INO 5 /* Boot loader inode */
59#define EXT3_UNDEL_DIR_INO 6 /* Undelete directory inode */
60#define EXT3_RESIZE_INO 7 /* Reserved group descriptors inode */
61#define EXT3_JOURNAL_INO 8 /* Journal inode */
62
63/* First non-reserved inode for old ext3 filesystems */
64#define EXT3_GOOD_OLD_FIRST_INO 11
65
1da177e4
LT		 66/*
67 * Maximal count of links to a file
68 */
69#define EXT3_LINK_MAX 32000
70
71/*
72 * Macro-instructions used to manage several block sizes
73 */
74#define EXT3_MIN_BLOCK_SIZE 1024
0f0a89eb
TS		 75#define EXT3_MAX_BLOCK_SIZE 65536
76#define EXT3_MIN_BLOCK_LOG_SIZE 10
1da177e4
LT		 77#ifdef __KERNEL__
78# define EXT3_BLOCK_SIZE(s) ((s)->s_blocksize)
79#else
80# define EXT3_BLOCK_SIZE(s) (EXT3_MIN_BLOCK_SIZE << (s)->s_log_block_size)
81#endif
82#define EXT3_ADDR_PER_BLOCK(s) (EXT3_BLOCK_SIZE(s) / sizeof (__u32))
83#ifdef __KERNEL__
84# define EXT3_BLOCK_SIZE_BITS(s) ((s)->s_blocksize_bits)
85#else
86# define EXT3_BLOCK_SIZE_BITS(s) ((s)->s_log_block_size + 10)
87#endif
88#ifdef __KERNEL__
89#define EXT3_ADDR_PER_BLOCK_BITS(s) (EXT3_SB(s)->s_addr_per_block_bits)
90#define EXT3_INODE_SIZE(s) (EXT3_SB(s)->s_inode_size)
91#define EXT3_FIRST_INO(s) (EXT3_SB(s)->s_first_ino)
92#else
93#define EXT3_INODE_SIZE(s) (((s)->s_rev_level == EXT3_GOOD_OLD_REV) ? \
94 EXT3_GOOD_OLD_INODE_SIZE : \
95 (s)->s_inode_size)
96#define EXT3_FIRST_INO(s) (((s)->s_rev_level == EXT3_GOOD_OLD_REV) ? \
97 EXT3_GOOD_OLD_FIRST_INO : \
98 (s)->s_first_ino)
99#endif
100
101/*
102 * Macro-instructions used to manage fragments
103 */
104#define EXT3_MIN_FRAG_SIZE 1024
105#define EXT3_MAX_FRAG_SIZE 4096
106#define EXT3_MIN_FRAG_LOG_SIZE 10
107#ifdef __KERNEL__
108# define EXT3_FRAG_SIZE(s) (EXT3_SB(s)->s_frag_size)
109# define EXT3_FRAGS_PER_BLOCK(s) (EXT3_SB(s)->s_frags_per_block)
110#else
111# define EXT3_FRAG_SIZE(s) (EXT3_MIN_FRAG_SIZE << (s)->s_log_frag_size)
112# define EXT3_FRAGS_PER_BLOCK(s) (EXT3_BLOCK_SIZE(s) / EXT3_FRAG_SIZE(s))
113#endif
114
115/*
116 * Structure of a blocks group descriptor
117 */
118struct ext3_group_desc
119{
120 __le32 bg_block_bitmap; /* Blocks bitmap block */
121 __le32 bg_inode_bitmap; /* Inodes bitmap block */
122 __le32 bg_inode_table; /* Inodes table block */
123 __le16 bg_free_blocks_count; /* Free blocks count */
124 __le16 bg_free_inodes_count; /* Free inodes count */
125 __le16 bg_used_dirs_count; /* Directories count */
126 __u16 bg_pad;
127 __le32 bg_reserved[3];
128};
129
130/*
131 * Macro-instructions used to manage group descriptors
132 */
133#ifdef __KERNEL__
134# define EXT3_BLOCKS_PER_GROUP(s) (EXT3_SB(s)->s_blocks_per_group)
135# define EXT3_DESC_PER_BLOCK(s) (EXT3_SB(s)->s_desc_per_block)
136# define EXT3_INODES_PER_GROUP(s) (EXT3_SB(s)->s_inodes_per_group)
137# define EXT3_DESC_PER_BLOCK_BITS(s) (EXT3_SB(s)->s_desc_per_block_bits)
138#else
139# define EXT3_BLOCKS_PER_GROUP(s) ((s)->s_blocks_per_group)
140# define EXT3_DESC_PER_BLOCK(s) (EXT3_BLOCK_SIZE(s) / sizeof (struct ext3_group_desc))
141# define EXT3_INODES_PER_GROUP(s) ((s)->s_inodes_per_group)
142#endif
143
144/*
145 * Constants relative to the data blocks
146 */
147#define EXT3_NDIR_BLOCKS 12
148#define EXT3_IND_BLOCK EXT3_NDIR_BLOCKS
149#define EXT3_DIND_BLOCK (EXT3_IND_BLOCK + 1)
150#define EXT3_TIND_BLOCK (EXT3_DIND_BLOCK + 1)
151#define EXT3_N_BLOCKS (EXT3_TIND_BLOCK + 1)
152
153/*
154 * Inode flags
155 */
156#define EXT3_SECRM_FL 0x00000001 /* Secure deletion */
157#define EXT3_UNRM_FL 0x00000002 /* Undelete */
158#define EXT3_COMPR_FL 0x00000004 /* Compress file */
159#define EXT3_SYNC_FL 0x00000008 /* Synchronous updates */
160#define EXT3_IMMUTABLE_FL 0x00000010 /* Immutable file */
161#define EXT3_APPEND_FL 0x00000020 /* writes to file may only append */
162#define EXT3_NODUMP_FL 0x00000040 /* do not dump file */
163#define EXT3_NOATIME_FL 0x00000080 /* do not update atime */
164/* Reserved for compression usage... */
165#define EXT3_DIRTY_FL 0x00000100
166#define EXT3_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */
167#define EXT3_NOCOMPR_FL 0x00000400 /* Don't compress */
168#define EXT3_ECOMPR_FL 0x00000800 /* Compression error */
169/* End compression flags --- maybe not all used */
170#define EXT3_INDEX_FL 0x00001000 /* hash-indexed directory */
171#define EXT3_IMAGIC_FL 0x00002000 /* AFS directory */
172#define EXT3_JOURNAL_DATA_FL 0x00004000 /* file data should be journaled */
173#define EXT3_NOTAIL_FL 0x00008000 /* file tail should not be merged */
174#define EXT3_DIRSYNC_FL 0x00010000 /* dirsync behaviour (directories only) */
175#define EXT3_TOPDIR_FL 0x00020000 /* Top of directory hierarchies*/
176#define EXT3_RESERVED_FL 0x80000000 /* reserved for ext3 lib */
177
178#define EXT3_FL_USER_VISIBLE 0x0003DFFF /* User visible flags */
179#define EXT3_FL_USER_MODIFIABLE 0x000380FF /* User modifiable flags */
180
2e8671cb
DG		 181/* Flags that should be inherited by new inodes from their parent. */
182#define EXT3_FL_INHERITED (EXT3_SECRM_FL | EXT3_UNRM_FL | EXT3_COMPR_FL |\
183 EXT3_SYNC_FL | EXT3_IMMUTABLE_FL | EXT3_APPEND_FL |\
184 EXT3_NODUMP_FL | EXT3_NOATIME_FL | EXT3_COMPRBLK_FL|\
185 EXT3_NOCOMPR_FL | EXT3_JOURNAL_DATA_FL |\
186 EXT3_NOTAIL_FL | EXT3_DIRSYNC_FL)
187
04143e2f
DG		 188/* Flags that are appropriate for regular files (all but dir-specific ones). */
189#define EXT3_REG_FLMASK (~(EXT3_DIRSYNC_FL | EXT3_TOPDIR_FL))
190
191/* Flags that are appropriate for non-directories/regular files. */
192#define EXT3_OTHER_FLMASK (EXT3_NODUMP_FL | EXT3_NOATIME_FL)
193
194/* Mask out flags that are inappropriate for the given type of inode. */
195static inline __u32 ext3_mask_flags(umode_t mode, __u32 flags)
196{
197 if (S_ISDIR(mode))
198 return flags;
199 else if (S_ISREG(mode))
200 return flags & EXT3_REG_FLMASK;
201 else
202 return flags & EXT3_OTHER_FLMASK;
203}
204
1da177e4
LT		 205/* Used to pass group descriptor data when online resize is done */
206struct ext3_new_group_input {
207 __u32 group; /* Group number for this data */
208 __u32 block_bitmap; /* Absolute block number of block bitmap */
209 __u32 inode_bitmap; /* Absolute block number of inode bitmap */
210 __u32 inode_table; /* Absolute block number of inode table start */
211 __u32 blocks_count; /* Total number of blocks in this group */
212 __u16 reserved_blocks; /* Number of reserved blocks in this group */
213 __u16 unused;
214};
215
216/* The struct ext3_new_group_input in kernel space, with free_blocks_count */
217struct ext3_new_group_data {
218 __u32 group;
219 __u32 block_bitmap;
220 __u32 inode_bitmap;
221 __u32 inode_table;
222 __u32 blocks_count;
223 __u16 reserved_blocks;
224 __u16 unused;
225 __u32 free_blocks_count;
226};
227
228
229/*
230 * ioctl commands
231 */
36695673
DH		 232#define EXT3_IOC_GETFLAGS FS_IOC_GETFLAGS
233#define EXT3_IOC_SETFLAGS FS_IOC_SETFLAGS
1da177e4
LT		 234#define EXT3_IOC_GETVERSION _IOR('f', 3, long)
235#define EXT3_IOC_SETVERSION _IOW('f', 4, long)
236#define EXT3_IOC_GROUP_EXTEND _IOW('f', 7, unsigned long)
237#define EXT3_IOC_GROUP_ADD _IOW('f', 8,struct ext3_new_group_input)
36695673
DH		 238#define EXT3_IOC_GETVERSION_OLD FS_IOC_GETVERSION
239#define EXT3_IOC_SETVERSION_OLD FS_IOC_SETVERSION
1da177e4
LT		 240#ifdef CONFIG_JBD_DEBUG
241#define EXT3_IOC_WAIT_FOR_READONLY _IOR('f', 99, long)
242#endif
243#define EXT3_IOC_GETRSVSZ _IOR('f', 5, long)
244#define EXT3_IOC_SETRSVSZ _IOW('f', 6, long)
245
36695673
DH		 246/*
247 * ioctl commands in 32 bit emulation
248 */
52a700c5
DH		 249#define EXT3_IOC32_GETFLAGS FS_IOC32_GETFLAGS
250#define EXT3_IOC32_SETFLAGS FS_IOC32_SETFLAGS
36695673
DH		 251#define EXT3_IOC32_GETVERSION _IOR('f', 3, int)
252#define EXT3_IOC32_SETVERSION _IOW('f', 4, int)
253#define EXT3_IOC32_GETRSVSZ _IOR('f', 5, int)
254#define EXT3_IOC32_SETRSVSZ _IOW('f', 6, int)
255#define EXT3_IOC32_GROUP_EXTEND _IOW('f', 7, unsigned int)
256#ifdef CONFIG_JBD_DEBUG
257#define EXT3_IOC32_WAIT_FOR_READONLY _IOR('f', 99, int)
258#endif
52a700c5
DH		 259#define EXT3_IOC32_GETVERSION_OLD FS_IOC32_GETVERSION
260#define EXT3_IOC32_SETVERSION_OLD FS_IOC32_SETVERSION
261
36695673 262
08c6a96f
JK		 263/*
264 * Mount options
265 */
266struct ext3_mount_options {
267 unsigned long s_mount_opt;
268 uid_t s_resuid;
269 gid_t s_resgid;
270 unsigned long s_commit_interval;
271#ifdef CONFIG_QUOTA
272 int s_jquota_fmt;
273 char *s_qf_names[MAXQUOTAS];
274#endif
275};
276
1da177e4
LT		 277/*
278 * Structure of an inode on the disk
279 */
280struct ext3_inode {
281 __le16 i_mode; /* File mode */
282 __le16 i_uid; /* Low 16 bits of Owner Uid */
283 __le32 i_size; /* Size in bytes */
284 __le32 i_atime; /* Access time */
285 __le32 i_ctime; /* Creation time */
286 __le32 i_mtime; /* Modification time */
287 __le32 i_dtime; /* Deletion Time */
288 __le16 i_gid; /* Low 16 bits of Group Id */
289 __le16 i_links_count; /* Links count */
290 __le32 i_blocks; /* Blocks count */
291 __le32 i_flags; /* File flags */
292 union {
293 struct {
294 __u32 l_i_reserved1;
295 } linux1;
296 struct {
297 __u32 h_i_translator;
298 } hurd1;
299 struct {
300 __u32 m_i_reserved1;
301 } masix1;
302 } osd1; /* OS dependent 1 */
303 __le32 i_block[EXT3_N_BLOCKS];/* Pointers to blocks */
304 __le32 i_generation; /* File version (for NFS) */
305 __le32 i_file_acl; /* File ACL */
306 __le32 i_dir_acl; /* Directory ACL */
307 __le32 i_faddr; /* Fragment address */
308 union {
309 struct {
310 __u8 l_i_frag; /* Fragment number */
311 __u8 l_i_fsize; /* Fragment size */
312 __u16 i_pad1;
313 __le16 l_i_uid_high; /* these 2 fields */
314 __le16 l_i_gid_high; /* were reserved2[0] */
315 __u32 l_i_reserved2;
316 } linux2;
317 struct {
318 __u8 h_i_frag; /* Fragment number */
319 __u8 h_i_fsize; /* Fragment size */
320 __u16 h_i_mode_high;
321 __u16 h_i_uid_high;
322 __u16 h_i_gid_high;
323 __u32 h_i_author;
324 } hurd2;
325 struct {
326 __u8 m_i_frag; /* Fragment number */
327 __u8 m_i_fsize; /* Fragment size */
328 __u16 m_pad1;
329 __u32 m_i_reserved2[2];
330 } masix2;
331 } osd2; /* OS dependent 2 */
332 __le16 i_extra_isize;
333 __le16 i_pad1;
334};
335
336#define i_size_high i_dir_acl
337
338#if defined(__KERNEL__) || defined(__linux__)
339#define i_reserved1 osd1.linux1.l_i_reserved1
340#define i_frag osd2.linux2.l_i_frag
341#define i_fsize osd2.linux2.l_i_fsize
342#define i_uid_low i_uid
343#define i_gid_low i_gid
344#define i_uid_high osd2.linux2.l_i_uid_high
345#define i_gid_high osd2.linux2.l_i_gid_high
346#define i_reserved2 osd2.linux2.l_i_reserved2
347
348#elif defined(__GNU__)
349
350#define i_translator osd1.hurd1.h_i_translator
351#define i_frag osd2.hurd2.h_i_frag;
352#define i_fsize osd2.hurd2.h_i_fsize;
353#define i_uid_high osd2.hurd2.h_i_uid_high
354#define i_gid_high osd2.hurd2.h_i_gid_high
355#define i_author osd2.hurd2.h_i_author
356
357#elif defined(__masix__)
358
359#define i_reserved1 osd1.masix1.m_i_reserved1
360#define i_frag osd2.masix2.m_i_frag
361#define i_fsize osd2.masix2.m_i_fsize
362#define i_reserved2 osd2.masix2.m_i_reserved2
363
364#endif /* defined(__KERNEL__) || defined(__linux__) */
365
366/*
367 * File system states
368 */
369#define EXT3_VALID_FS 0x0001 /* Unmounted cleanly */
370#define EXT3_ERROR_FS 0x0002 /* Errors detected */
371#define EXT3_ORPHAN_FS 0x0004 /* Orphans being recovered */
372
5e1f8c9e
TT		 373/*
374 * Misc. filesystem flags
375 */
376#define EXT2_FLAGS_SIGNED_HASH 0x0001 /* Signed dirhash in use */
377#define EXT2_FLAGS_UNSIGNED_HASH 0x0002 /* Unsigned dirhash in use */
378#define EXT2_FLAGS_TEST_FILESYS 0x0004 /* to test development code */
379
1da177e4
LT		 380/*
381 * Mount flags
382 */
383#define EXT3_MOUNT_CHECK 0x00001 /* Do mount-time checks */
384#define EXT3_MOUNT_OLDALLOC 0x00002 /* Don't use the new Orlov allocator */
385#define EXT3_MOUNT_GRPID 0x00004 /* Create files with directory's group */
386#define EXT3_MOUNT_DEBUG 0x00008 /* Some debugging messages */
387#define EXT3_MOUNT_ERRORS_CONT 0x00010 /* Continue on errors */
388#define EXT3_MOUNT_ERRORS_RO 0x00020 /* Remount fs ro on errors */
389#define EXT3_MOUNT_ERRORS_PANIC 0x00040 /* Panic on errors */
390#define EXT3_MOUNT_MINIX_DF 0x00080 /* Mimics the Minix statfs */
391#define EXT3_MOUNT_NOLOAD 0x00100 /* Don't use existing journal*/
392#define EXT3_MOUNT_ABORT 0x00200 /* Fatal error detected */
393#define EXT3_MOUNT_DATA_FLAGS 0x00C00 /* Mode for data writes: */
394#define EXT3_MOUNT_JOURNAL_DATA 0x00400 /* Write data to journal */
395#define EXT3_MOUNT_ORDERED_DATA 0x00800 /* Flush data before commit */
396#define EXT3_MOUNT_WRITEBACK_DATA 0x00C00 /* No data ordering */
397#define EXT3_MOUNT_UPDATE_JOURNAL 0x01000 /* Update the journal format */
398#define EXT3_MOUNT_NO_UID32 0x02000 /* Disable 32-bit UIDs */
399#define EXT3_MOUNT_XATTR_USER 0x04000 /* Extended user attributes */
400#define EXT3_MOUNT_POSIX_ACL 0x08000 /* POSIX Access Control Lists */
401#define EXT3_MOUNT_RESERVATION 0x10000 /* Preallocation */
402#define EXT3_MOUNT_BARRIER 0x20000 /* Use block barriers */
1f54587b 403#define EXT3_MOUNT_QUOTA 0x80000 /* Some quota option set */
8fc2751b
MB		 404#define EXT3_MOUNT_USRQUOTA 0x100000 /* "old" user quota */
405#define EXT3_MOUNT_GRPQUOTA 0x200000 /* "old" group quota */
0e4fb5e2
HK		 406#define EXT3_MOUNT_DATA_ERR_ABORT 0x400000 /* Abort on file data write
407 * error in ordered mode */
1da177e4
LT		 408
409/* Compatibility, for having both ext2_fs.h and ext3_fs.h included at once */
410#ifndef _LINUX_EXT2_FS_H
411#define clear_opt(o, opt) o &= ~EXT3_MOUNT_##opt
412#define set_opt(o, opt) o |= EXT3_MOUNT_##opt
413#define test_opt(sb, opt) (EXT3_SB(sb)->s_mount_opt & \
414 EXT3_MOUNT_##opt)
415#else
416#define EXT2_MOUNT_NOLOAD EXT3_MOUNT_NOLOAD
417#define EXT2_MOUNT_ABORT EXT3_MOUNT_ABORT
418#define EXT2_MOUNT_DATA_FLAGS EXT3_MOUNT_DATA_FLAGS
419#endif
420
90085930 421#define ext3_set_bit __set_bit_le
1da177e4 422#define ext3_set_bit_atomic ext2_set_bit_atomic
90085930 423#define ext3_clear_bit __clear_bit_le
1da177e4 424#define ext3_clear_bit_atomic ext2_clear_bit_atomic
0795ccea 425#define ext3_test_bit test_bit_le
0795ccea 426#define ext3_find_next_zero_bit find_next_zero_bit_le
1da177e4
LT		 427
428/*
429 * Maximal mount counts between two filesystem checks
430 */
431#define EXT3_DFL_MAX_MNT_COUNT 20 /* Allow 20 mounts */
432#define EXT3_DFL_CHECKINTERVAL 0 /* Don't use interval check */
433
434/*
435 * Behaviour when detecting errors
436 */
437#define EXT3_ERRORS_CONTINUE 1 /* Continue execution */
438#define EXT3_ERRORS_RO 2 /* Remount fs read-only */
439#define EXT3_ERRORS_PANIC 3 /* Panic */
440#define EXT3_ERRORS_DEFAULT EXT3_ERRORS_CONTINUE
441
442/*
443 * Structure of the super block
444 */
445struct ext3_super_block {
446/*00*/ __le32 s_inodes_count; /* Inodes count */
447 __le32 s_blocks_count; /* Blocks count */
448 __le32 s_r_blocks_count; /* Reserved blocks count */
449 __le32 s_free_blocks_count; /* Free blocks count */
450/*10*/ __le32 s_free_inodes_count; /* Free inodes count */
451 __le32 s_first_data_block; /* First Data Block */
452 __le32 s_log_block_size; /* Block size */
453 __le32 s_log_frag_size; /* Fragment size */
454/*20*/ __le32 s_blocks_per_group; /* # Blocks per group */
455 __le32 s_frags_per_group; /* # Fragments per group */
456 __le32 s_inodes_per_group; /* # Inodes per group */
457 __le32 s_mtime; /* Mount time */
458/*30*/ __le32 s_wtime; /* Write time */
459 __le16 s_mnt_count; /* Mount count */
460 __le16 s_max_mnt_count; /* Maximal mount count */
461 __le16 s_magic; /* Magic signature */
462 __le16 s_state; /* File system state */
463 __le16 s_errors; /* Behaviour when detecting errors */
464 __le16 s_minor_rev_level; /* minor revision level */
465/*40*/ __le32 s_lastcheck; /* time of last check */
466 __le32 s_checkinterval; /* max. time between checks */
467 __le32 s_creator_os; /* OS */
468 __le32 s_rev_level; /* Revision level */
469/*50*/ __le16 s_def_resuid; /* Default uid for reserved blocks */
470 __le16 s_def_resgid; /* Default gid for reserved blocks */
471 /*
472 * These fields are for EXT3_DYNAMIC_REV superblocks only.
473 *
474 * Note: the difference between the compatible feature set and
475 * the incompatible feature set is that if there is a bit set
476 * in the incompatible feature set that the kernel doesn't
477 * know about, it should refuse to mount the filesystem.
478 *
479 * e2fsck's requirements are more strict; if it doesn't know
480 * about a feature in either the compatible or incompatible
481 * feature set, it must abort and not try to meddle with
482 * things it doesn't understand...
483 */
484 __le32 s_first_ino; /* First non-reserved inode */
485 __le16 s_inode_size; /* size of inode structure */
486 __le16 s_block_group_nr; /* block group # of this superblock */
487 __le32 s_feature_compat; /* compatible feature set */
488/*60*/ __le32 s_feature_incompat; /* incompatible feature set */
489 __le32 s_feature_ro_compat; /* readonly-compatible feature set */
490/*68*/ __u8 s_uuid[16]; /* 128-bit uuid for volume */
491/*78*/ char s_volume_name[16]; /* volume name */
492/*88*/ char s_last_mounted[64]; /* directory where last mounted */
493/*C8*/ __le32 s_algorithm_usage_bitmap; /* For compression */
494 /*
495 * Performance hints. Directory preallocation should only
496 * happen if the EXT3_FEATURE_COMPAT_DIR_PREALLOC flag is on.
497 */
498 __u8 s_prealloc_blocks; /* Nr of blocks to try to preallocate*/
499 __u8 s_prealloc_dir_blocks; /* Nr to preallocate for dirs */
a4e4de36 500 __le16 s_reserved_gdt_blocks; /* Per group desc for online growth */
1da177e4
LT		 501 /*
502 * Journaling support valid if EXT3_FEATURE_COMPAT_HAS_JOURNAL set.
503 */
504/*D0*/ __u8 s_journal_uuid[16]; /* uuid of journal superblock */
505/*E0*/ __le32 s_journal_inum; /* inode number of journal file */
506 __le32 s_journal_dev; /* device number of journal file */
507 __le32 s_last_orphan; /* start of list of inodes to delete */
508 __le32 s_hash_seed[4]; /* HTREE hash seed */
509 __u8 s_def_hash_version; /* Default hash version to use */
510 __u8 s_reserved_char_pad;
511 __u16 s_reserved_word_pad;
512 __le32 s_default_mount_opts;
e9ad5620 513 __le32 s_first_meta_bg; /* First metablock block group */
5e1f8c9e
TT		 514 __le32 s_mkfs_time; /* When the filesystem was created */
515 __le32 s_jnl_blocks[17]; /* Backup of the journal inode */
516 /* 64bit support valid if EXT4_FEATURE_COMPAT_64BIT */
517/*150*/ __le32 s_blocks_count_hi; /* Blocks count */
518 __le32 s_r_blocks_count_hi; /* Reserved blocks count */
519 __le32 s_free_blocks_count_hi; /* Free blocks count */
520 __le16 s_min_extra_isize; /* All inodes have at least # bytes */
521 __le16 s_want_extra_isize; /* New inodes should reserve # bytes */
522 __le32 s_flags; /* Miscellaneous flags */
523 __le16 s_raid_stride; /* RAID stride */
524 __le16 s_mmp_interval; /* # seconds to wait in MMP checking */
525 __le64 s_mmp_block; /* Block for multi-mount protection */
526 __le32 s_raid_stripe_width; /* blocks on all data disks (N*stride)*/
527 __u8 s_log_groups_per_flex; /* FLEX_BG group size */
528 __u8 s_reserved_char_pad2;
529 __le16 s_reserved_pad;
530 __u32 s_reserved[162]; /* Padding to the end of the block */
1da177e4
LT		 531};
532
533#ifdef __KERNEL__
d85004eb
DW		 534#include <linux/ext3_fs_i.h>
535#include <linux/ext3_fs_sb.h>
1da177e4
LT		 536static inline struct ext3_sb_info * EXT3_SB(struct super_block *sb)
537{
538 return sb->s_fs_info;
539}
540static inline struct ext3_inode_info *EXT3_I(struct inode *inode)
541{
542 return container_of(inode, struct ext3_inode_info, vfs_inode);
543}
2ccb48eb
NB		 544
545static inline int ext3_valid_inum(struct super_block *sb, unsigned long ino)
546{
547 return ino == EXT3_ROOT_INO ||
548 ino == EXT3_JOURNAL_INO ||
549 ino == EXT3_RESIZE_INO ||
550 (ino >= EXT3_FIRST_INO(sb) &&
551 ino <= le32_to_cpu(EXT3_SB(sb)->s_es->s_inodes_count));
552}
9df93939
JK		 553
554/*
555 * Inode dynamic state flags
556 */
557enum {
558 EXT3_STATE_JDATA, /* journaled data exists */
559 EXT3_STATE_NEW, /* inode is newly created */
560 EXT3_STATE_XATTR, /* has in-inode xattrs */
561 EXT3_STATE_FLUSH_ON_CLOSE, /* flush dirty pages on close */
562};
563
564static inline int ext3_test_inode_state(struct inode *inode, int bit)
565{
de329820 566 return test_bit(bit, &EXT3_I(inode)->i_state_flags);
9df93939
JK		 567}
568
569static inline void ext3_set_inode_state(struct inode *inode, int bit)
570{
de329820 571 set_bit(bit, &EXT3_I(inode)->i_state_flags);
9df93939
JK		 572}
573
574static inline void ext3_clear_inode_state(struct inode *inode, int bit)
575{
de329820 576 clear_bit(bit, &EXT3_I(inode)->i_state_flags);
9df93939 577}
1da177e4
LT		 578#else
579/* Assume that user mode programs are passing in an ext3fs superblock, not
580 * a kernel struct super_block. This will allow us to call the feature-test
581 * macros from user land. */
582#define EXT3_SB(sb) (sb)
583#endif
584
585#define NEXT_ORPHAN(inode) EXT3_I(inode)->i_dtime
586
587/*
588 * Codes for operating systems
589 */
590#define EXT3_OS_LINUX 0
591#define EXT3_OS_HURD 1
592#define EXT3_OS_MASIX 2
593#define EXT3_OS_FREEBSD 3
594#define EXT3_OS_LITES 4
595
596/*
597 * Revision levels
598 */
599#define EXT3_GOOD_OLD_REV 0 /* The good old (original) format */
600#define EXT3_DYNAMIC_REV 1 /* V2 format w/ dynamic inode sizes */
601
602#define EXT3_CURRENT_REV EXT3_GOOD_OLD_REV
603#define EXT3_MAX_SUPP_REV EXT3_DYNAMIC_REV
604
605#define EXT3_GOOD_OLD_INODE_SIZE 128
606
607/*
608 * Feature set definitions
609 */
610
611#define EXT3_HAS_COMPAT_FEATURE(sb,mask) \
612 ( EXT3_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask) )
613#define EXT3_HAS_RO_COMPAT_FEATURE(sb,mask) \
614 ( EXT3_SB(sb)->s_es->s_feature_ro_compat & cpu_to_le32(mask) )
615#define EXT3_HAS_INCOMPAT_FEATURE(sb,mask) \
616 ( EXT3_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask) )
617#define EXT3_SET_COMPAT_FEATURE(sb,mask) \
618 EXT3_SB(sb)->s_es->s_feature_compat |= cpu_to_le32(mask)
619#define EXT3_SET_RO_COMPAT_FEATURE(sb,mask) \
620 EXT3_SB(sb)->s_es->s_feature_ro_compat |= cpu_to_le32(mask)
621#define EXT3_SET_INCOMPAT_FEATURE(sb,mask) \
622 EXT3_SB(sb)->s_es->s_feature_incompat |= cpu_to_le32(mask)
623#define EXT3_CLEAR_COMPAT_FEATURE(sb,mask) \
624 EXT3_SB(sb)->s_es->s_feature_compat &= ~cpu_to_le32(mask)
625#define EXT3_CLEAR_RO_COMPAT_FEATURE(sb,mask) \
626 EXT3_SB(sb)->s_es->s_feature_ro_compat &= ~cpu_to_le32(mask)
627#define EXT3_CLEAR_INCOMPAT_FEATURE(sb,mask) \
628 EXT3_SB(sb)->s_es->s_feature_incompat &= ~cpu_to_le32(mask)
629
630#define EXT3_FEATURE_COMPAT_DIR_PREALLOC 0x0001
631#define EXT3_FEATURE_COMPAT_IMAGIC_INODES 0x0002
632#define EXT3_FEATURE_COMPAT_HAS_JOURNAL 0x0004
633#define EXT3_FEATURE_COMPAT_EXT_ATTR 0x0008
634#define EXT3_FEATURE_COMPAT_RESIZE_INODE 0x0010
635#define EXT3_FEATURE_COMPAT_DIR_INDEX 0x0020
636
637#define EXT3_FEATURE_RO_COMPAT_SPARSE_SUPER 0x0001
638#define EXT3_FEATURE_RO_COMPAT_LARGE_FILE 0x0002
639#define EXT3_FEATURE_RO_COMPAT_BTREE_DIR 0x0004
640
641#define EXT3_FEATURE_INCOMPAT_COMPRESSION 0x0001
642#define EXT3_FEATURE_INCOMPAT_FILETYPE 0x0002
643#define EXT3_FEATURE_INCOMPAT_RECOVER 0x0004 /* Needs recovery */
644#define EXT3_FEATURE_INCOMPAT_JOURNAL_DEV 0x0008 /* Journal device */
645#define EXT3_FEATURE_INCOMPAT_META_BG 0x0010
646
647#define EXT3_FEATURE_COMPAT_SUPP EXT2_FEATURE_COMPAT_EXT_ATTR
648#define EXT3_FEATURE_INCOMPAT_SUPP (EXT3_FEATURE_INCOMPAT_FILETYPE| \
649 EXT3_FEATURE_INCOMPAT_RECOVER| \
650 EXT3_FEATURE_INCOMPAT_META_BG)
651#define EXT3_FEATURE_RO_COMPAT_SUPP (EXT3_FEATURE_RO_COMPAT_SPARSE_SUPER| \
652 EXT3_FEATURE_RO_COMPAT_LARGE_FILE| \
653 EXT3_FEATURE_RO_COMPAT_BTREE_DIR)
654
655/*
656 * Default values for user and/or group using reserved blocks
657 */
658#define EXT3_DEF_RESUID 0
659#define EXT3_DEF_RESGID 0
660
661/*
662 * Default mount options
663 */
664#define EXT3_DEFM_DEBUG 0x0001
665#define EXT3_DEFM_BSDGROUPS 0x0002
666#define EXT3_DEFM_XATTR_USER 0x0004
667#define EXT3_DEFM_ACL 0x0008
668#define EXT3_DEFM_UID16 0x0010
669#define EXT3_DEFM_JMODE 0x0060
670#define EXT3_DEFM_JMODE_DATA 0x0020
671#define EXT3_DEFM_JMODE_ORDERED 0x0040
672#define EXT3_DEFM_JMODE_WBACK 0x0060
673
674/*
675 * Structure of a directory entry
676 */
677#define EXT3_NAME_LEN 255
678
679struct ext3_dir_entry {
680 __le32 inode; /* Inode number */
681 __le16 rec_len; /* Directory entry length */
682 __le16 name_len; /* Name length */
683 char name[EXT3_NAME_LEN]; /* File name */
684};
685
686/*
687 * The new version of the directory entry. Since EXT3 structures are
688 * stored in intel byte order, and the name_len field could never be
689 * bigger than 255 chars, it's safe to reclaim the extra byte for the
690 * file_type field.
691 */
692struct ext3_dir_entry_2 {
693 __le32 inode; /* Inode number */
694 __le16 rec_len; /* Directory entry length */
695 __u8 name_len; /* Name length */
696 __u8 file_type;
697 char name[EXT3_NAME_LEN]; /* File name */
698};
699
700/*
701 * Ext3 directory file types. Only the low 3 bits are used. The
702 * other bits are reserved for now.
703 */
704#define EXT3_FT_UNKNOWN 0
705#define EXT3_FT_REG_FILE 1
706#define EXT3_FT_DIR 2
707#define EXT3_FT_CHRDEV 3
708#define EXT3_FT_BLKDEV 4
709#define EXT3_FT_FIFO 5
710#define EXT3_FT_SOCK 6
711#define EXT3_FT_SYMLINK 7
712
713#define EXT3_FT_MAX 8
714
715/*
716 * EXT3_DIR_PAD defines the directory entries boundaries
717 *
718 * NOTE: It must be a multiple of 4
719 */
720#define EXT3_DIR_PAD 4
721#define EXT3_DIR_ROUND (EXT3_DIR_PAD - 1)
722#define EXT3_DIR_REC_LEN(name_len) (((name_len) + 8 + EXT3_DIR_ROUND) & \
723 ~EXT3_DIR_ROUND)
7c06a8dc
JK		 724#define EXT3_MAX_REC_LEN ((1<<16)-1)
725
a4ae3094
ES		 726/*
727 * Tests against MAX_REC_LEN etc were put in place for 64k block
728 * sizes; if that is not possible on this arch, we can skip
729 * those tests and speed things up.
730 */
7c06a8dc
JK		 731static inline unsigned ext3_rec_len_from_disk(__le16 dlen)
732{
733 unsigned len = le16_to_cpu(dlen);
734
a4ae3094 735#if (PAGE_CACHE_SIZE >= 65536)
7c06a8dc
JK		 736 if (len == EXT3_MAX_REC_LEN)
737 return 1 << 16;
a4ae3094 738#endif
7c06a8dc
JK		 739 return len;
740}
741
742static inline __le16 ext3_rec_len_to_disk(unsigned len)
743{
a4ae3094 744#if (PAGE_CACHE_SIZE >= 65536)
7c06a8dc
JK		 745 if (len == (1 << 16))
746 return cpu_to_le16(EXT3_MAX_REC_LEN);
747 else if (len > (1 << 16))
748 BUG();
a4ae3094 749#endif
7c06a8dc
JK		 750 return cpu_to_le16(len);
751}
752
1da177e4
LT		 753/*
754 * Hash Tree Directory indexing
755 * (c) Daniel Phillips, 2001
756 */
757
059590f4
ES		 758#define is_dx(dir) (EXT3_HAS_COMPAT_FEATURE(dir->i_sb, \
759 EXT3_FEATURE_COMPAT_DIR_INDEX) && \
1da177e4
LT		 760 (EXT3_I(dir)->i_flags & EXT3_INDEX_FL))
761#define EXT3_DIR_LINK_MAX(dir) (!is_dx(dir) && (dir)->i_nlink >= EXT3_LINK_MAX)
762#define EXT3_DIR_LINK_EMPTY(dir) ((dir)->i_nlink == 2 || (dir)->i_nlink == 1)
1da177e4
LT		 763
764/* Legal values for the dx_root hash_version field: */
765
766#define DX_HASH_LEGACY 0
767#define DX_HASH_HALF_MD4 1
768#define DX_HASH_TEA 2
5e1f8c9e
TT		 769#define DX_HASH_LEGACY_UNSIGNED 3
770#define DX_HASH_HALF_MD4_UNSIGNED 4
771#define DX_HASH_TEA_UNSIGNED 5
1da177e4 772
de654c97
DW		 773#ifdef __KERNEL__
774
1da177e4
LT		 775/* hash info structure used by the directory hash */
776struct dx_hash_info
777{
778 u32 hash;
779 u32 minor_hash;
780 int hash_version;
781 u32 *seed;
782};
783
784#define EXT3_HTREE_EOF 0x7fffffff
785
1da177e4
LT		 786/*
787 * Control parameters used by ext3_htree_next_block
788 */
789#define HASH_NB_ALWAYS 1
790
791
792/*
793 * Describe an inode's exact location on disk and in memory
794 */
795struct ext3_iloc
796{
797 struct buffer_head *bh;
798 unsigned long offset;
799 unsigned long block_group;
800};
801
802static inline struct ext3_inode *ext3_raw_inode(struct ext3_iloc *iloc)
803{
804 return (struct ext3_inode *) (iloc->bh->b_data + iloc->offset);
805}
806
807/*
808 * This structure is stuffed into the struct file's private_data field
809 * for directories. It is where we put information so that we can do
810 * readdir operations in hash tree order.
811 */
812struct dir_private_info {
813 struct rb_root root;
814 struct rb_node *curr_node;
815 struct fname *extra_fname;
816 loff_t last_pos;
817 __u32 curr_hash;
818 __u32 curr_minor_hash;
819 __u32 next_hash;
820};
821
43d23f90
MC		 822/* calculate the first block number of the group */
823static inline ext3_fsblk_t
824ext3_group_first_block_no(struct super_block *sb, unsigned long group_no)
825{
826 return group_no * (ext3_fsblk_t)EXT3_BLOCKS_PER_GROUP(sb) +
827 le32_to_cpu(EXT3_SB(sb)->s_es->s_first_data_block);
828}
829
1da177e4
LT		 830/*
831 * Special error return code only used by dx_probe() and its callers.
832 */
833#define ERR_BAD_DX_DIR -75000
834
835/*
836 * Function prototypes
837 */
838
839/*
840 * Ok, these declarations are also in <linux/kernel.h> but none of the
841 * ext3 source programs needs to include it so they are duplicated here.
842 */
843# define NORET_TYPE /**/
844# define ATTRIB_NORET __attribute__((noreturn))
845# define NORET_AND noreturn,
846
847/* balloc.c */
848extern int ext3_bg_has_super(struct super_block *sb, int group);
849extern unsigned long ext3_bg_num_gdb(struct super_block *sb, int group);
1c2bf374
MC		 850extern ext3_fsblk_t ext3_new_block (handle_t *handle, struct inode *inode,
851 ext3_fsblk_t goal, int *errp);
852extern ext3_fsblk_t ext3_new_blocks (handle_t *handle, struct inode *inode,
853 ext3_fsblk_t goal, unsigned long *count, int *errp);
854extern void ext3_free_blocks (handle_t *handle, struct inode *inode,
855 ext3_fsblk_t block, unsigned long count);
856extern void ext3_free_blocks_sb (handle_t *handle, struct super_block *sb,
857 ext3_fsblk_t block, unsigned long count,
858 unsigned long *pdquot_freed_blocks);
43d23f90 859extern ext3_fsblk_t ext3_count_free_blocks (struct super_block *);
1da177e4
LT		 860extern void ext3_check_blocks_bitmap (struct super_block *);
861extern struct ext3_group_desc * ext3_get_group_desc(struct super_block * sb,
862 unsigned int block_group,
863 struct buffer_head ** bh);
864extern int ext3_should_retry_alloc(struct super_block *sb, int *retries);
865extern void ext3_init_block_alloc_info(struct inode *);
866extern void ext3_rsv_window_add(struct super_block *sb, struct ext3_reserve_window_node *rsv);
b853b96b 867extern int ext3_trim_fs(struct super_block *sb, struct fstrim_range *range);
1da177e4
LT		 868
869/* dir.c */
870extern int ext3_check_dir_entry(const char *, struct inode *,
871 struct ext3_dir_entry_2 *,
872 struct buffer_head *, unsigned long);
873extern int ext3_htree_store_dirent(struct file *dir_file, __u32 hash,
874 __u32 minor_hash,
875 struct ext3_dir_entry_2 *dirent);
876extern void ext3_htree_free_dir_info(struct dir_private_info *p);
877
878/* fsync.c */
02c24a82 879extern int ext3_sync_file(struct file *, loff_t, loff_t, int);
1da177e4
LT		 880
881/* hash.c */
882extern int ext3fs_dirhash(const char *name, int len, struct
883 dx_hash_info *hinfo);
884
885/* ialloc.c */
2a7dba39
EP		 886extern struct inode * ext3_new_inode (handle_t *, struct inode *,
887 const struct qstr *, int);
1da177e4
LT		 888extern void ext3_free_inode (handle_t *, struct inode *);
889extern struct inode * ext3_orphan_get (struct super_block *, unsigned long);
890extern unsigned long ext3_count_free_inodes (struct super_block *);
891extern unsigned long ext3_count_dirs (struct super_block *);
892extern void ext3_check_inodes_bitmap (struct super_block *);
893extern unsigned long ext3_count_free (struct buffer_head *, unsigned);
894
895
896/* inode.c */
1c2bf374
MC		 897int ext3_forget(handle_t *handle, int is_metadata, struct inode *inode,
898 struct buffer_head *bh, ext3_fsblk_t blocknr);
d8733c29
AM		 899struct buffer_head * ext3_getblk (handle_t *, struct inode *, long, int, int *);
900struct buffer_head * ext3_bread (handle_t *, struct inode *, int, int, int *);
89747d36
MC		 901int ext3_get_blocks_handle(handle_t *handle, struct inode *inode,
902 sector_t iblock, unsigned long maxblocks, struct buffer_head *bh_result,
43237b54 903 int create);
1da177e4 904
473043dc 905extern struct inode *ext3_iget(struct super_block *, unsigned long);
a9185b41 906extern int ext3_write_inode (struct inode *, struct writeback_control *);
1da177e4 907extern int ext3_setattr (struct dentry *, struct iattr *);
ac14a95b 908extern void ext3_evict_inode (struct inode *);
1da177e4
LT		 909extern int ext3_sync_inode (handle_t *, struct inode *);
910extern void ext3_discard_reservation (struct inode *);
aa385729 911extern void ext3_dirty_inode(struct inode *, int);
1da177e4
LT		 912extern int ext3_change_inode_journal_flag(struct inode *, int);
913extern int ext3_get_inode_loc(struct inode *, struct ext3_iloc *);
ae76dd9a 914extern int ext3_can_truncate(struct inode *inode);
40680f2f 915extern void ext3_truncate(struct inode *inode);
1da177e4 916extern void ext3_set_inode_flags(struct inode *);
28be5abb 917extern void ext3_get_inode_flags(struct ext3_inode_info *);
1da177e4 918extern void ext3_set_aops(struct inode *inode);
68c9d702
JB		 919extern int ext3_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
920 u64 start, u64 len);
1da177e4
LT		 921
922/* ioctl.c */
039fd8ce
CM		 923extern long ext3_ioctl(struct file *, unsigned int, unsigned long);
924extern long ext3_compat_ioctl(struct file *, unsigned int, unsigned long);
1da177e4
LT		 925
926/* namei.c */
927extern int ext3_orphan_add(handle_t *, struct inode *);
928extern int ext3_orphan_del(handle_t *, struct inode *);
929extern int ext3_htree_fill_tree(struct file *dir_file, __u32 start_hash,
930 __u32 start_minor_hash, __u32 *next_hash);
931
932/* resize.c */
933extern int ext3_group_add(struct super_block *sb,
934 struct ext3_new_group_data *input);
935extern int ext3_group_extend(struct super_block *sb,
936 struct ext3_super_block *es,
43d23f90 937 ext3_fsblk_t n_blocks_count);
1da177e4
LT		 938
939/* super.c */
940extern void ext3_error (struct super_block *, const char *, const char *, ...)
941 __attribute__ ((format (printf, 3, 4)));
942extern void __ext3_std_error (struct super_block *, const char *, int);
943extern void ext3_abort (struct super_block *, const char *, const char *, ...)
944 __attribute__ ((format (printf, 3, 4)));
945extern void ext3_warning (struct super_block *, const char *, const char *, ...)
946 __attribute__ ((format (printf, 3, 4)));
4cf46b67
AF		 947extern void ext3_msg(struct super_block *, const char *, const char *, ...)
948 __attribute__ ((format (printf, 3, 4)));
1da177e4
LT		 949extern void ext3_update_dynamic_rev (struct super_block *sb);
950
951#define ext3_std_error(sb, errno) \
952do { \
953 if ((errno)) \
d5c003b4 954 __ext3_std_error((sb), __func__, (errno)); \
1da177e4
LT		 955} while (0)
956
957/*
958 * Inodes and files operations
959 */
960
961/* dir.c */
4b6f5d20 962extern const struct file_operations ext3_dir_operations;
1da177e4
LT		 963
964/* file.c */
c5ef1c42 965extern const struct inode_operations ext3_file_inode_operations;
4b6f5d20 966extern const struct file_operations ext3_file_operations;
1da177e4
LT		 967
968/* namei.c */
c5ef1c42
AV		 969extern const struct inode_operations ext3_dir_inode_operations;
970extern const struct inode_operations ext3_special_inode_operations;
1da177e4
LT		 971
972/* symlink.c */
c5ef1c42
AV		 973extern const struct inode_operations ext3_symlink_inode_operations;
974extern const struct inode_operations ext3_fast_symlink_inode_operations;
1da177e4
LT		 975
976
977#endif /* __KERNEL__ */
978
979#endif /* _LINUX_EXT3_FS_H */
ubuntu-bionic-kernel mirror