xref: /linux/fs/ext2/ext2.h (revision 8386f58f8deda81110283798a387fb53ec21957c)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright (C) 1992, 1993, 1994, 1995
4  * Remy Card (card@masi.ibp.fr)
5  * Laboratoire MASI - Institut Blaise Pascal
6  * Universite Pierre et Marie Curie (Paris VI)
7  *
8  *  from
9  *
10  *  linux/include/linux/minix_fs.h
11  *
12  *  Copyright (C) 1991, 1992  Linus Torvalds
13  */
14 #include <linux/fs.h>
15 #include <linux/ext2_fs.h>
16 #include <linux/blockgroup_lock.h>
17 #include <linux/percpu_counter.h>
18 #include <linux/rbtree.h>
19 #include <linux/mm.h>
20 #include <linux/highmem.h>
21 
22 /* XXX Here for now... not interested in restructing headers JUST now */
23 
24 /* data type for block offset of block group */
25 typedef int ext2_grpblk_t;
26 
27 /* data type for filesystem-wide blocks number */
28 typedef unsigned long ext2_fsblk_t;
29 
30 #define E2FSBLK "%lu"
31 
32 struct ext2_reserve_window {
33 	ext2_fsblk_t		_rsv_start;	/* First byte reserved */
34 	ext2_fsblk_t		_rsv_end;	/* Last byte reserved or 0 */
35 };
36 
37 struct ext2_reserve_window_node {
38 	struct rb_node	 	rsv_node;
39 	__u32			rsv_goal_size;
40 	__u32			rsv_alloc_hit;
41 	struct ext2_reserve_window	rsv_window;
42 };
43 
44 struct ext2_block_alloc_info {
45 	/* information about reservation window */
46 	struct ext2_reserve_window_node	rsv_window_node;
47 	/*
48 	 * was i_next_alloc_block in ext2_inode_info
49 	 * is the logical (file-relative) number of the
50 	 * most-recently-allocated block in this file.
51 	 * We use this for detecting linearly ascending allocation requests.
52 	 */
53 	__u32			last_alloc_logical_block;
54 	/*
55 	 * Was i_next_alloc_goal in ext2_inode_info
56 	 * is the *physical* companion to i_next_alloc_block.
57 	 * it is the physical block number of the block which was most-recently
58 	 * allocated to this file.  This gives us the goal (target) for the next
59 	 * allocation when we detect linearly ascending requests.
60 	 */
61 	ext2_fsblk_t		last_alloc_physical_block;
62 };
63 
64 #define rsv_start rsv_window._rsv_start
65 #define rsv_end rsv_window._rsv_end
66 
67 struct mb_cache;
68 
69 /*
70  * second extended-fs super-block data in memory
71  */
72 struct ext2_sb_info {
73 	unsigned long s_frag_size;	/* Size of a fragment in bytes */
74 	unsigned long s_frags_per_block;/* Number of fragments per block */
75 	unsigned long s_inodes_per_block;/* Number of inodes per block */
76 	unsigned long s_frags_per_group;/* Number of fragments in a group */
77 	unsigned long s_blocks_per_group;/* Number of blocks in a group */
78 	unsigned long s_inodes_per_group;/* Number of inodes in a group */
79 	unsigned long s_itb_per_group;	/* Number of inode table blocks per group */
80 	unsigned long s_gdb_count;	/* Number of group descriptor blocks */
81 	unsigned long s_desc_per_block;	/* Number of group descriptors per block */
82 	unsigned long s_groups_count;	/* Number of groups in the fs */
83 	unsigned long s_overhead_last;  /* Last calculated overhead */
84 	unsigned long s_blocks_last;    /* Last seen block count */
85 	struct buffer_head * s_sbh;	/* Buffer containing the super block */
86 	struct ext2_super_block * s_es;	/* Pointer to the super block in the buffer */
87 	struct buffer_head ** s_group_desc;
88 	unsigned long  s_mount_opt;
89 	unsigned long s_sb_block;
90 	kuid_t s_resuid;
91 	kgid_t s_resgid;
92 	unsigned short s_mount_state;
93 	unsigned short s_pad;
94 	int s_addr_per_block_bits;
95 	int s_desc_per_block_bits;
96 	int s_inode_size;
97 	int s_first_ino;
98 	spinlock_t s_next_gen_lock;
99 	u32 s_next_generation;
100 	unsigned long s_dir_count;
101 	u8 *s_debts;
102 	struct percpu_counter s_freeblocks_counter;
103 	struct percpu_counter s_freeinodes_counter;
104 	struct percpu_counter s_dirs_counter;
105 	struct blockgroup_lock *s_blockgroup_lock;
106 	/* root of the per fs reservation window tree */
107 	spinlock_t s_rsv_window_lock;
108 	struct rb_root s_rsv_window_root;
109 	struct ext2_reserve_window_node s_rsv_window_head;
110 	/*
111 	 * s_lock protects against concurrent modifications of s_mount_state,
112 	 * s_blocks_last, s_overhead_last and the content of superblock's
113 	 * buffer pointed to by sbi->s_es.
114 	 *
115 	 * Note: It is used in ext2_show_options() to provide a consistent view
116 	 * of the mount options.
117 	 */
118 	spinlock_t s_lock;
119 	struct mb_cache *s_ea_block_cache;
120 	struct dax_device *s_daxdev;
121 	u64 s_dax_part_off;
122 };
123 
124 static inline spinlock_t *
125 sb_bgl_lock(struct ext2_sb_info *sbi, unsigned int block_group)
126 {
127 	return bgl_lock_ptr(sbi->s_blockgroup_lock, block_group);
128 }
129 
130 /*
131  * Define EXT2FS_DEBUG to produce debug messages
132  */
133 #undef EXT2FS_DEBUG
134 
135 /*
136  * Define EXT2_RESERVATION to reserve data blocks for expanding files
137  */
138 #define EXT2_DEFAULT_RESERVE_BLOCKS     8
139 /*max window size: 1024(direct blocks) + 3([t,d]indirect blocks) */
140 #define EXT2_MAX_RESERVE_BLOCKS         1027
141 #define EXT2_RESERVE_WINDOW_NOT_ALLOCATED 0
142 /*
143  * The second extended file system version
144  */
145 #define EXT2FS_DATE		"95/08/09"
146 #define EXT2FS_VERSION		"0.5b"
147 
148 /*
149  * Debug code
150  */
151 #ifdef EXT2FS_DEBUG
152 #	define ext2_debug(f, a...)	{ \
153 					printk ("EXT2-fs DEBUG (%s, %d): %s:", \
154 						__FILE__, __LINE__, __func__); \
155 				  	printk (f, ## a); \
156 					}
157 #else
158 #	define ext2_debug(f, a...)	/**/
159 #endif
160 
161 /*
162  * Special inode numbers
163  */
164 #define	EXT2_BAD_INO		 1	/* Bad blocks inode */
165 #define EXT2_ROOT_INO		 2	/* Root inode */
166 #define EXT2_BOOT_LOADER_INO	 5	/* Boot loader inode */
167 #define EXT2_UNDEL_DIR_INO	 6	/* Undelete directory inode */
168 
169 /* First non-reserved inode for old ext2 filesystems */
170 #define EXT2_GOOD_OLD_FIRST_INO	11
171 
172 static inline struct ext2_sb_info *EXT2_SB(struct super_block *sb)
173 {
174 	return sb->s_fs_info;
175 }
176 
177 /*
178  * Macro-instructions used to manage several block sizes
179  */
180 #define EXT2_MIN_BLOCK_SIZE		1024
181 #define	EXT2_MAX_BLOCK_SIZE		65536
182 #define EXT2_MIN_BLOCK_LOG_SIZE		  10
183 #define EXT2_MAX_BLOCK_LOG_SIZE		  16
184 #define EXT2_BLOCK_SIZE(s)		((s)->s_blocksize)
185 #define	EXT2_ADDR_PER_BLOCK(s)		(EXT2_BLOCK_SIZE(s) / sizeof (__u32))
186 #define EXT2_BLOCK_SIZE_BITS(s)		((s)->s_blocksize_bits)
187 #define	EXT2_ADDR_PER_BLOCK_BITS(s)	(EXT2_SB(s)->s_addr_per_block_bits)
188 #define EXT2_INODE_SIZE(s)		(EXT2_SB(s)->s_inode_size)
189 #define EXT2_FIRST_INO(s)		(EXT2_SB(s)->s_first_ino)
190 
191 /*
192  * Macro-instructions used to manage fragments
193  */
194 #define EXT2_MIN_FRAG_SIZE		1024
195 #define	EXT2_MAX_FRAG_SIZE		4096
196 #define EXT2_MIN_FRAG_LOG_SIZE		  10
197 #define EXT2_FRAG_SIZE(s)		(EXT2_SB(s)->s_frag_size)
198 #define EXT2_FRAGS_PER_BLOCK(s)		(EXT2_SB(s)->s_frags_per_block)
199 
200 /*
201  * Structure of a blocks group descriptor
202  */
203 struct ext2_group_desc
204 {
205 	__le32	bg_block_bitmap;		/* Blocks bitmap block */
206 	__le32	bg_inode_bitmap;		/* Inodes bitmap block */
207 	__le32	bg_inode_table;		/* Inodes table block */
208 	__le16	bg_free_blocks_count;	/* Free blocks count */
209 	__le16	bg_free_inodes_count;	/* Free inodes count */
210 	__le16	bg_used_dirs_count;	/* Directories count */
211 	__le16	bg_pad;
212 	__le32	bg_reserved[3];
213 };
214 
215 /*
216  * Macro-instructions used to manage group descriptors
217  */
218 #define EXT2_BLOCKS_PER_GROUP(s)	(EXT2_SB(s)->s_blocks_per_group)
219 #define EXT2_DESC_PER_BLOCK(s)		(EXT2_SB(s)->s_desc_per_block)
220 #define EXT2_INODES_PER_GROUP(s)	(EXT2_SB(s)->s_inodes_per_group)
221 #define EXT2_DESC_PER_BLOCK_BITS(s)	(EXT2_SB(s)->s_desc_per_block_bits)
222 
223 /*
224  * Constants relative to the data blocks
225  */
226 #define	EXT2_NDIR_BLOCKS		12
227 #define	EXT2_IND_BLOCK			EXT2_NDIR_BLOCKS
228 #define	EXT2_DIND_BLOCK			(EXT2_IND_BLOCK + 1)
229 #define	EXT2_TIND_BLOCK			(EXT2_DIND_BLOCK + 1)
230 #define	EXT2_N_BLOCKS			(EXT2_TIND_BLOCK + 1)
231 
232 /*
233  * Inode flags (GETFLAGS/SETFLAGS)
234  */
235 #define	EXT2_SECRM_FL			FS_SECRM_FL	/* Secure deletion */
236 #define	EXT2_UNRM_FL			FS_UNRM_FL	/* Undelete */
237 #define	EXT2_COMPR_FL			FS_COMPR_FL	/* Compress file */
238 #define EXT2_SYNC_FL			FS_SYNC_FL	/* Synchronous updates */
239 #define EXT2_IMMUTABLE_FL		FS_IMMUTABLE_FL	/* Immutable file */
240 #define EXT2_APPEND_FL			FS_APPEND_FL	/* writes to file may only append */
241 #define EXT2_NODUMP_FL			FS_NODUMP_FL	/* do not dump file */
242 #define EXT2_NOATIME_FL			FS_NOATIME_FL	/* do not update atime */
243 /* Reserved for compression usage... */
244 #define EXT2_DIRTY_FL			FS_DIRTY_FL
245 #define EXT2_COMPRBLK_FL		FS_COMPRBLK_FL	/* One or more compressed clusters */
246 #define EXT2_NOCOMP_FL			FS_NOCOMP_FL	/* Don't compress */
247 #define EXT2_ECOMPR_FL			FS_ECOMPR_FL	/* Compression error */
248 /* End compression flags --- maybe not all used */
249 #define EXT2_BTREE_FL			FS_BTREE_FL	/* btree format dir */
250 #define EXT2_INDEX_FL			FS_INDEX_FL	/* hash-indexed directory */
251 #define EXT2_IMAGIC_FL			FS_IMAGIC_FL	/* AFS directory */
252 #define EXT2_JOURNAL_DATA_FL		FS_JOURNAL_DATA_FL /* Reserved for ext3 */
253 #define EXT2_NOTAIL_FL			FS_NOTAIL_FL	/* file tail should not be merged */
254 #define EXT2_DIRSYNC_FL			FS_DIRSYNC_FL	/* dirsync behaviour (directories only) */
255 #define EXT2_TOPDIR_FL			FS_TOPDIR_FL	/* Top of directory hierarchies*/
256 #define EXT2_RESERVED_FL		FS_RESERVED_FL	/* reserved for ext2 lib */
257 
258 #define EXT2_FL_USER_VISIBLE		FS_FL_USER_VISIBLE	/* User visible flags */
259 #define EXT2_FL_USER_MODIFIABLE		FS_FL_USER_MODIFIABLE	/* User modifiable flags */
260 
261 /* Flags that should be inherited by new inodes from their parent. */
262 #define EXT2_FL_INHERITED (EXT2_SECRM_FL | EXT2_UNRM_FL | EXT2_COMPR_FL |\
263 			   EXT2_SYNC_FL | EXT2_NODUMP_FL |\
264 			   EXT2_NOATIME_FL | EXT2_COMPRBLK_FL |\
265 			   EXT2_NOCOMP_FL | EXT2_JOURNAL_DATA_FL |\
266 			   EXT2_NOTAIL_FL | EXT2_DIRSYNC_FL)
267 
268 /* Flags that are appropriate for regular files (all but dir-specific ones). */
269 #define EXT2_REG_FLMASK (~(EXT2_DIRSYNC_FL | EXT2_TOPDIR_FL))
270 
271 /* Flags that are appropriate for non-directories/regular files. */
272 #define EXT2_OTHER_FLMASK (EXT2_NODUMP_FL | EXT2_NOATIME_FL)
273 
274 /* Mask out flags that are inappropriate for the given type of inode. */
275 static inline __u32 ext2_mask_flags(umode_t mode, __u32 flags)
276 {
277 	if (S_ISDIR(mode))
278 		return flags;
279 	else if (S_ISREG(mode))
280 		return flags & EXT2_REG_FLMASK;
281 	else
282 		return flags & EXT2_OTHER_FLMASK;
283 }
284 
285 /*
286  * ioctl commands
287  */
288 #define	EXT2_IOC_GETVERSION		FS_IOC_GETVERSION
289 #define	EXT2_IOC_SETVERSION		FS_IOC_SETVERSION
290 #define	EXT2_IOC_GETRSVSZ		_IOR('f', 5, long)
291 #define	EXT2_IOC_SETRSVSZ		_IOW('f', 6, long)
292 
293 /*
294  * ioctl commands in 32 bit emulation
295  */
296 #define EXT2_IOC32_GETVERSION		FS_IOC32_GETVERSION
297 #define EXT2_IOC32_SETVERSION		FS_IOC32_SETVERSION
298 
299 /*
300  * Structure of an inode on the disk
301  */
302 struct ext2_inode {
303 	__le16	i_mode;		/* File mode */
304 	__le16	i_uid;		/* Low 16 bits of Owner Uid */
305 	__le32	i_size;		/* Size in bytes */
306 	__le32	i_atime;	/* Access time */
307 	__le32	i_ctime;	/* Creation time */
308 	__le32	i_mtime;	/* Modification time */
309 	__le32	i_dtime;	/* Deletion Time */
310 	__le16	i_gid;		/* Low 16 bits of Group Id */
311 	__le16	i_links_count;	/* Links count */
312 	__le32	i_blocks;	/* Blocks count */
313 	__le32	i_flags;	/* File flags */
314 	union {
315 		struct {
316 			__le32  l_i_reserved1;
317 		} linux1;
318 		struct {
319 			__le32  h_i_translator;
320 		} hurd1;
321 		struct {
322 			__le32  m_i_reserved1;
323 		} masix1;
324 	} osd1;				/* OS dependent 1 */
325 	__le32	i_block[EXT2_N_BLOCKS];/* Pointers to blocks */
326 	__le32	i_generation;	/* File version (for NFS) */
327 	__le32	i_file_acl;	/* File ACL */
328 	__le32	i_dir_acl;	/* Directory ACL */
329 	__le32	i_faddr;	/* Fragment address */
330 	union {
331 		struct {
332 			__u8	l_i_frag;	/* Fragment number */
333 			__u8	l_i_fsize;	/* Fragment size */
334 			__u16	i_pad1;
335 			__le16	l_i_uid_high;	/* these 2 fields    */
336 			__le16	l_i_gid_high;	/* were reserved2[0] */
337 			__u32	l_i_reserved2;
338 		} linux2;
339 		struct {
340 			__u8	h_i_frag;	/* Fragment number */
341 			__u8	h_i_fsize;	/* Fragment size */
342 			__le16	h_i_mode_high;
343 			__le16	h_i_uid_high;
344 			__le16	h_i_gid_high;
345 			__le32	h_i_author;
346 		} hurd2;
347 		struct {
348 			__u8	m_i_frag;	/* Fragment number */
349 			__u8	m_i_fsize;	/* Fragment size */
350 			__u16	m_pad1;
351 			__u32	m_i_reserved2[2];
352 		} masix2;
353 	} osd2;				/* OS dependent 2 */
354 };
355 
356 #define i_size_high	i_dir_acl
357 
358 #define i_reserved1	osd1.linux1.l_i_reserved1
359 #define i_frag		osd2.linux2.l_i_frag
360 #define i_fsize		osd2.linux2.l_i_fsize
361 #define i_uid_low	i_uid
362 #define i_gid_low	i_gid
363 #define i_uid_high	osd2.linux2.l_i_uid_high
364 #define i_gid_high	osd2.linux2.l_i_gid_high
365 #define i_reserved2	osd2.linux2.l_i_reserved2
366 
367 /*
368  * File system states
369  */
370 #define	EXT2_VALID_FS			0x0001	/* Unmounted cleanly */
371 #define	EXT2_ERROR_FS			0x0002	/* Errors detected */
372 #define	EFSCORRUPTED			EUCLEAN	/* Filesystem is corrupted */
373 
374 /*
375  * Mount flags
376  */
377 #define EXT2_MOUNT_OLDALLOC		0x000002  /* Don't use the new Orlov allocator */
378 #define EXT2_MOUNT_GRPID		0x000004  /* Create files with directory's group */
379 #define EXT2_MOUNT_DEBUG		0x000008  /* Some debugging messages */
380 #define EXT2_MOUNT_ERRORS_CONT		0x000010  /* Continue on errors */
381 #define EXT2_MOUNT_ERRORS_RO		0x000020  /* Remount fs ro on errors */
382 #define EXT2_MOUNT_ERRORS_PANIC		0x000040  /* Panic on errors */
383 #define EXT2_MOUNT_MINIX_DF		0x000080  /* Mimics the Minix statfs */
384 #define EXT2_MOUNT_NOBH			0x000100  /* No buffer_heads */
385 #define EXT2_MOUNT_NO_UID32		0x000200  /* Disable 32-bit UIDs */
386 #define EXT2_MOUNT_XATTR_USER		0x004000  /* Extended user attributes */
387 #define EXT2_MOUNT_POSIX_ACL		0x008000  /* POSIX Access Control Lists */
388 #define EXT2_MOUNT_XIP			0x010000  /* Obsolete, use DAX */
389 #define EXT2_MOUNT_USRQUOTA		0x020000  /* user quota */
390 #define EXT2_MOUNT_GRPQUOTA		0x040000  /* group quota */
391 #define EXT2_MOUNT_RESERVATION		0x080000  /* Preallocation */
392 #define EXT2_MOUNT_DAX			0x100000  /* Direct Access */
393 
394 
395 #define clear_opt(o, opt)		o &= ~EXT2_MOUNT_##opt
396 #define set_opt(o, opt)			o |= EXT2_MOUNT_##opt
397 #define test_opt(sb, opt)		(EXT2_SB(sb)->s_mount_opt & \
398 					 EXT2_MOUNT_##opt)
399 /*
400  * Maximal mount counts between two filesystem checks
401  */
402 #define EXT2_DFL_MAX_MNT_COUNT		20	/* Allow 20 mounts */
403 #define EXT2_DFL_CHECKINTERVAL		0	/* Don't use interval check */
404 
405 /*
406  * Behaviour when detecting errors
407  */
408 #define EXT2_ERRORS_CONTINUE		1	/* Continue execution */
409 #define EXT2_ERRORS_RO			2	/* Remount fs read-only */
410 #define EXT2_ERRORS_PANIC		3	/* Panic */
411 #define EXT2_ERRORS_DEFAULT		EXT2_ERRORS_CONTINUE
412 
413 /*
414  * Structure of the super block
415  */
416 struct ext2_super_block {
417 	__le32	s_inodes_count;		/* Inodes count */
418 	__le32	s_blocks_count;		/* Blocks count */
419 	__le32	s_r_blocks_count;	/* Reserved blocks count */
420 	__le32	s_free_blocks_count;	/* Free blocks count */
421 	__le32	s_free_inodes_count;	/* Free inodes count */
422 	__le32	s_first_data_block;	/* First Data Block */
423 	__le32	s_log_block_size;	/* Block size */
424 	__le32	s_log_frag_size;	/* Fragment size */
425 	__le32	s_blocks_per_group;	/* # Blocks per group */
426 	__le32	s_frags_per_group;	/* # Fragments per group */
427 	__le32	s_inodes_per_group;	/* # Inodes per group */
428 	__le32	s_mtime;		/* Mount time */
429 	__le32	s_wtime;		/* Write time */
430 	__le16	s_mnt_count;		/* Mount count */
431 	__le16	s_max_mnt_count;	/* Maximal mount count */
432 	__le16	s_magic;		/* Magic signature */
433 	__le16	s_state;		/* File system state */
434 	__le16	s_errors;		/* Behaviour when detecting errors */
435 	__le16	s_minor_rev_level; 	/* minor revision level */
436 	__le32	s_lastcheck;		/* time of last check */
437 	__le32	s_checkinterval;	/* max. time between checks */
438 	__le32	s_creator_os;		/* OS */
439 	__le32	s_rev_level;		/* Revision level */
440 	__le16	s_def_resuid;		/* Default uid for reserved blocks */
441 	__le16	s_def_resgid;		/* Default gid for reserved blocks */
442 	/*
443 	 * These fields are for EXT2_DYNAMIC_REV superblocks only.
444 	 *
445 	 * Note: the difference between the compatible feature set and
446 	 * the incompatible feature set is that if there is a bit set
447 	 * in the incompatible feature set that the kernel doesn't
448 	 * know about, it should refuse to mount the filesystem.
449 	 *
450 	 * e2fsck's requirements are more strict; if it doesn't know
451 	 * about a feature in either the compatible or incompatible
452 	 * feature set, it must abort and not try to meddle with
453 	 * things it doesn't understand...
454 	 */
455 	__le32	s_first_ino; 		/* First non-reserved inode */
456 	__le16   s_inode_size; 		/* size of inode structure */
457 	__le16	s_block_group_nr; 	/* block group # of this superblock */
458 	__le32	s_feature_compat; 	/* compatible feature set */
459 	__le32	s_feature_incompat; 	/* incompatible feature set */
460 	__le32	s_feature_ro_compat; 	/* readonly-compatible feature set */
461 	__u8	s_uuid[16];		/* 128-bit uuid for volume */
462 	char	s_volume_name[16]; 	/* volume name */
463 	char	s_last_mounted[64]; 	/* directory where last mounted */
464 	__le32	s_algorithm_usage_bitmap; /* For compression */
465 	/*
466 	 * Performance hints.  Directory preallocation should only
467 	 * happen if the EXT2_COMPAT_PREALLOC flag is on.
468 	 */
469 	__u8	s_prealloc_blocks;	/* Nr of blocks to try to preallocate*/
470 	__u8	s_prealloc_dir_blocks;	/* Nr to preallocate for dirs */
471 	__u16	s_padding1;
472 	/*
473 	 * Journaling support valid if EXT3_FEATURE_COMPAT_HAS_JOURNAL set.
474 	 */
475 	__u8	s_journal_uuid[16];	/* uuid of journal superblock */
476 	__u32	s_journal_inum;		/* inode number of journal file */
477 	__u32	s_journal_dev;		/* device number of journal file */
478 	__u32	s_last_orphan;		/* start of list of inodes to delete */
479 	__u32	s_hash_seed[4];		/* HTREE hash seed */
480 	__u8	s_def_hash_version;	/* Default hash version to use */
481 	__u8	s_reserved_char_pad;
482 	__u16	s_reserved_word_pad;
483 	__le32	s_default_mount_opts;
484  	__le32	s_first_meta_bg; 	/* First metablock block group */
485 	__u32	s_reserved[190];	/* Padding to the end of the block */
486 };
487 
488 /*
489  * Codes for operating systems
490  */
491 #define EXT2_OS_LINUX		0
492 #define EXT2_OS_HURD		1
493 #define EXT2_OS_MASIX		2
494 #define EXT2_OS_FREEBSD		3
495 #define EXT2_OS_LITES		4
496 
497 /*
498  * Revision levels
499  */
500 #define EXT2_GOOD_OLD_REV	0	/* The good old (original) format */
501 #define EXT2_DYNAMIC_REV	1 	/* V2 format w/ dynamic inode sizes */
502 
503 #define EXT2_CURRENT_REV	EXT2_GOOD_OLD_REV
504 #define EXT2_MAX_SUPP_REV	EXT2_DYNAMIC_REV
505 
506 #define EXT2_GOOD_OLD_INODE_SIZE 128
507 
508 /*
509  * Feature set definitions
510  */
511 
512 #define EXT2_HAS_COMPAT_FEATURE(sb,mask)			\
513 	( EXT2_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask) )
514 #define EXT2_HAS_RO_COMPAT_FEATURE(sb,mask)			\
515 	( EXT2_SB(sb)->s_es->s_feature_ro_compat & cpu_to_le32(mask) )
516 #define EXT2_HAS_INCOMPAT_FEATURE(sb,mask)			\
517 	( EXT2_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask) )
518 #define EXT2_SET_COMPAT_FEATURE(sb,mask)			\
519 	EXT2_SB(sb)->s_es->s_feature_compat |= cpu_to_le32(mask)
520 #define EXT2_SET_RO_COMPAT_FEATURE(sb,mask)			\
521 	EXT2_SB(sb)->s_es->s_feature_ro_compat |= cpu_to_le32(mask)
522 #define EXT2_SET_INCOMPAT_FEATURE(sb,mask)			\
523 	EXT2_SB(sb)->s_es->s_feature_incompat |= cpu_to_le32(mask)
524 #define EXT2_CLEAR_COMPAT_FEATURE(sb,mask)			\
525 	EXT2_SB(sb)->s_es->s_feature_compat &= ~cpu_to_le32(mask)
526 #define EXT2_CLEAR_RO_COMPAT_FEATURE(sb,mask)			\
527 	EXT2_SB(sb)->s_es->s_feature_ro_compat &= ~cpu_to_le32(mask)
528 #define EXT2_CLEAR_INCOMPAT_FEATURE(sb,mask)			\
529 	EXT2_SB(sb)->s_es->s_feature_incompat &= ~cpu_to_le32(mask)
530 
531 #define EXT2_FEATURE_COMPAT_DIR_PREALLOC	0x0001
532 #define EXT2_FEATURE_COMPAT_IMAGIC_INODES	0x0002
533 #define EXT3_FEATURE_COMPAT_HAS_JOURNAL		0x0004
534 #define EXT2_FEATURE_COMPAT_EXT_ATTR		0x0008
535 #define EXT2_FEATURE_COMPAT_RESIZE_INO		0x0010
536 #define EXT2_FEATURE_COMPAT_DIR_INDEX		0x0020
537 #define EXT2_FEATURE_COMPAT_ANY			0xffffffff
538 
539 #define EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER	0x0001
540 #define EXT2_FEATURE_RO_COMPAT_LARGE_FILE	0x0002
541 #define EXT2_FEATURE_RO_COMPAT_BTREE_DIR	0x0004
542 #define EXT2_FEATURE_RO_COMPAT_ANY		0xffffffff
543 
544 #define EXT2_FEATURE_INCOMPAT_COMPRESSION	0x0001
545 #define EXT2_FEATURE_INCOMPAT_FILETYPE		0x0002
546 #define EXT3_FEATURE_INCOMPAT_RECOVER		0x0004
547 #define EXT3_FEATURE_INCOMPAT_JOURNAL_DEV	0x0008
548 #define EXT2_FEATURE_INCOMPAT_META_BG		0x0010
549 #define EXT2_FEATURE_INCOMPAT_ANY		0xffffffff
550 
551 #define EXT2_FEATURE_COMPAT_SUPP	EXT2_FEATURE_COMPAT_EXT_ATTR
552 #define EXT2_FEATURE_INCOMPAT_SUPP	(EXT2_FEATURE_INCOMPAT_FILETYPE| \
553 					 EXT2_FEATURE_INCOMPAT_META_BG)
554 #define EXT2_FEATURE_RO_COMPAT_SUPP	(EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER| \
555 					 EXT2_FEATURE_RO_COMPAT_LARGE_FILE| \
556 					 EXT2_FEATURE_RO_COMPAT_BTREE_DIR)
557 #define EXT2_FEATURE_RO_COMPAT_UNSUPPORTED	~EXT2_FEATURE_RO_COMPAT_SUPP
558 #define EXT2_FEATURE_INCOMPAT_UNSUPPORTED	~EXT2_FEATURE_INCOMPAT_SUPP
559 
560 /*
561  * Default values for user and/or group using reserved blocks
562  */
563 #define	EXT2_DEF_RESUID		0
564 #define	EXT2_DEF_RESGID		0
565 
566 /*
567  * Default mount options
568  */
569 #define EXT2_DEFM_DEBUG		0x0001
570 #define EXT2_DEFM_BSDGROUPS	0x0002
571 #define EXT2_DEFM_XATTR_USER	0x0004
572 #define EXT2_DEFM_ACL		0x0008
573 #define EXT2_DEFM_UID16		0x0010
574     /* Not used by ext2, but reserved for use by ext3 */
575 #define EXT3_DEFM_JMODE		0x0060
576 #define EXT3_DEFM_JMODE_DATA	0x0020
577 #define EXT3_DEFM_JMODE_ORDERED	0x0040
578 #define EXT3_DEFM_JMODE_WBACK	0x0060
579 
580 /*
581  * Structure of a directory entry
582  */
583 
584 struct ext2_dir_entry {
585 	__le32	inode;			/* Inode number */
586 	__le16	rec_len;		/* Directory entry length */
587 	__le16	name_len;		/* Name length */
588 	char	name[];			/* File name, up to EXT2_NAME_LEN */
589 };
590 
591 /*
592  * The new version of the directory entry.  Since EXT2 structures are
593  * stored in intel byte order, and the name_len field could never be
594  * bigger than 255 chars, it's safe to reclaim the extra byte for the
595  * file_type field.
596  */
597 struct ext2_dir_entry_2 {
598 	__le32	inode;			/* Inode number */
599 	__le16	rec_len;		/* Directory entry length */
600 	__u8	name_len;		/* Name length */
601 	__u8	file_type;
602 	char	name[];			/* File name, up to EXT2_NAME_LEN */
603 };
604 
605 /*
606  * EXT2_DIR_PAD defines the directory entries boundaries
607  *
608  * NOTE: It must be a multiple of 4
609  */
610 #define EXT2_DIR_PAD		 	4
611 #define EXT2_DIR_ROUND 			(EXT2_DIR_PAD - 1)
612 #define EXT2_DIR_REC_LEN(name_len)	(((name_len) + 8 + EXT2_DIR_ROUND) & \
613 					 ~EXT2_DIR_ROUND)
614 #define EXT2_MAX_REC_LEN		((1<<16)-1)
615 
616 static inline void verify_offsets(void)
617 {
618 #define A(x,y) BUILD_BUG_ON(x != offsetof(struct ext2_super_block, y));
619 	A(EXT2_SB_MAGIC_OFFSET, s_magic);
620 	A(EXT2_SB_BLOCKS_OFFSET, s_blocks_count);
621 	A(EXT2_SB_BSIZE_OFFSET, s_log_block_size);
622 #undef A
623 }
624 
625 /*
626  * ext2 mount options
627  */
628 struct ext2_mount_options {
629 	unsigned long s_mount_opt;
630 	kuid_t s_resuid;
631 	kgid_t s_resgid;
632 };
633 
634 /*
635  * second extended file system inode data in memory
636  */
637 struct ext2_inode_info {
638 	__le32	i_data[15];
639 	__u32	i_flags;
640 	__u32	i_faddr;
641 	__u8	i_frag_no;
642 	__u8	i_frag_size;
643 	__u16	i_state;
644 	__u32	i_file_acl;
645 	__u32	i_dir_acl;
646 	__u32	i_dtime;
647 
648 	/*
649 	 * i_block_group is the number of the block group which contains
650 	 * this file's inode.  Constant across the lifetime of the inode,
651 	 * it is used for making block allocation decisions - we try to
652 	 * place a file's data blocks near its inode block, and new inodes
653 	 * near to their parent directory's inode.
654 	 */
655 	__u32	i_block_group;
656 
657 	/* block reservation info */
658 	struct ext2_block_alloc_info *i_block_alloc_info;
659 
660 	__u32	i_dir_start_lookup;
661 #ifdef CONFIG_EXT2_FS_XATTR
662 	/*
663 	 * Extended attributes can be read independently of the main file
664 	 * data. Taking i_mutex even when reading would cause contention
665 	 * between readers of EAs and writers of regular file data, so
666 	 * instead we synchronize on xattr_sem when reading or changing
667 	 * EAs.
668 	 */
669 	struct rw_semaphore xattr_sem;
670 #endif
671 	rwlock_t i_meta_lock;
672 
673 	/*
674 	 * truncate_mutex is for serialising ext2_truncate() against
675 	 * ext2_getblock().  It also protects the internals of the inode's
676 	 * reservation data structures: ext2_reserve_window and
677 	 * ext2_reserve_window_node.
678 	 */
679 	struct mutex truncate_mutex;
680 	struct inode	vfs_inode;
681 	struct list_head i_orphan;	/* unlinked but open inodes */
682 #ifdef CONFIG_QUOTA
683 	struct dquot *i_dquot[MAXQUOTAS];
684 #endif
685 };
686 
687 /*
688  * Inode dynamic state flags
689  */
690 #define EXT2_STATE_NEW			0x00000001 /* inode is newly created */
691 
692 
693 /*
694  * Function prototypes
695  */
696 
697 /*
698  * Ok, these declarations are also in <linux/kernel.h> but none of the
699  * ext2 source programs needs to include it so they are duplicated here.
700  */
701 
702 static inline struct ext2_inode_info *EXT2_I(struct inode *inode)
703 {
704 	return container_of(inode, struct ext2_inode_info, vfs_inode);
705 }
706 
707 /* balloc.c */
708 extern int ext2_bg_has_super(struct super_block *sb, int group);
709 extern unsigned long ext2_bg_num_gdb(struct super_block *sb, int group);
710 extern ext2_fsblk_t ext2_new_block(struct inode *, unsigned long, int *);
711 extern ext2_fsblk_t ext2_new_blocks(struct inode *, unsigned long,
712 				unsigned long *, int *);
713 extern int ext2_data_block_valid(struct ext2_sb_info *sbi, ext2_fsblk_t start_blk,
714 				 unsigned int count);
715 extern void ext2_free_blocks (struct inode *, unsigned long,
716 			      unsigned long);
717 extern unsigned long ext2_count_free_blocks (struct super_block *);
718 extern unsigned long ext2_count_dirs (struct super_block *);
719 extern struct ext2_group_desc * ext2_get_group_desc(struct super_block * sb,
720 						    unsigned int block_group,
721 						    struct buffer_head ** bh);
722 extern void ext2_discard_reservation (struct inode *);
723 extern int ext2_should_retry_alloc(struct super_block *sb, int *retries);
724 extern void ext2_init_block_alloc_info(struct inode *);
725 extern void ext2_rsv_window_add(struct super_block *sb, struct ext2_reserve_window_node *rsv);
726 
727 /* dir.c */
728 extern int ext2_add_link (struct dentry *, struct inode *);
729 extern int ext2_inode_by_name(struct inode *dir,
730 			      const struct qstr *child, ino_t *ino);
731 extern int ext2_make_empty(struct inode *, struct inode *);
732 extern struct ext2_dir_entry_2 *ext2_find_entry(struct inode *, const struct qstr *,
733 						struct page **, void **res_page_addr);
734 extern int ext2_delete_entry(struct ext2_dir_entry_2 *dir, struct page *page,
735 			     char *kaddr);
736 extern int ext2_empty_dir (struct inode *);
737 extern struct ext2_dir_entry_2 *ext2_dotdot(struct inode *dir, struct page **p, void **pa);
738 int ext2_set_link(struct inode *dir, struct ext2_dir_entry_2 *de,
739 		struct page *page, void *page_addr, struct inode *inode,
740 		bool update_times);
741 static inline void ext2_put_page(struct page *page, void *page_addr)
742 {
743 	kunmap_local(page_addr);
744 	put_page(page);
745 }
746 
747 /* ialloc.c */
748 extern struct inode * ext2_new_inode (struct inode *, umode_t, const struct qstr *);
749 extern void ext2_free_inode (struct inode *);
750 extern unsigned long ext2_count_free_inodes (struct super_block *);
751 extern unsigned long ext2_count_free (struct buffer_head *, unsigned);
752 
753 /* inode.c */
754 extern struct inode *ext2_iget (struct super_block *, unsigned long);
755 extern int ext2_write_inode (struct inode *, struct writeback_control *);
756 extern void ext2_evict_inode(struct inode *);
757 extern int ext2_get_block(struct inode *, sector_t, struct buffer_head *, int);
758 extern int ext2_setattr (struct mnt_idmap *, struct dentry *, struct iattr *);
759 extern int ext2_getattr (struct mnt_idmap *, const struct path *,
760 			 struct kstat *, u32, unsigned int);
761 extern void ext2_set_inode_flags(struct inode *inode);
762 extern int ext2_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
763 		       u64 start, u64 len);
764 
765 /* ioctl.c */
766 extern int ext2_fileattr_get(struct dentry *dentry, struct fileattr *fa);
767 extern int ext2_fileattr_set(struct mnt_idmap *idmap,
768 			     struct dentry *dentry, struct fileattr *fa);
769 extern long ext2_ioctl(struct file *, unsigned int, unsigned long);
770 extern long ext2_compat_ioctl(struct file *, unsigned int, unsigned long);
771 
772 /* namei.c */
773 struct dentry *ext2_get_parent(struct dentry *child);
774 
775 /* super.c */
776 extern __printf(3, 4)
777 void ext2_error(struct super_block *, const char *, const char *, ...);
778 extern __printf(3, 4)
779 void ext2_msg(struct super_block *, const char *, const char *, ...);
780 extern void ext2_update_dynamic_rev (struct super_block *sb);
781 extern void ext2_sync_super(struct super_block *sb, struct ext2_super_block *es,
782 			    int wait);
783 
784 /*
785  * Inodes and files operations
786  */
787 
788 /* dir.c */
789 extern const struct file_operations ext2_dir_operations;
790 
791 /* file.c */
792 extern int ext2_fsync(struct file *file, loff_t start, loff_t end,
793 		      int datasync);
794 extern const struct inode_operations ext2_file_inode_operations;
795 extern const struct file_operations ext2_file_operations;
796 
797 /* inode.c */
798 extern void ext2_set_file_ops(struct inode *inode);
799 extern const struct address_space_operations ext2_aops;
800 extern const struct iomap_ops ext2_iomap_ops;
801 
802 /* namei.c */
803 extern const struct inode_operations ext2_dir_inode_operations;
804 extern const struct inode_operations ext2_special_inode_operations;
805 
806 /* symlink.c */
807 extern const struct inode_operations ext2_fast_symlink_inode_operations;
808 extern const struct inode_operations ext2_symlink_inode_operations;
809 
810 static inline ext2_fsblk_t
811 ext2_group_first_block_no(struct super_block *sb, unsigned long group_no)
812 {
813 	return group_no * (ext2_fsblk_t)EXT2_BLOCKS_PER_GROUP(sb) +
814 		le32_to_cpu(EXT2_SB(sb)->s_es->s_first_data_block);
815 }
816 
817 static inline ext2_fsblk_t
818 ext2_group_last_block_no(struct super_block *sb, unsigned long group_no)
819 {
820 	struct ext2_sb_info *sbi = EXT2_SB(sb);
821 
822 	if (group_no == sbi->s_groups_count - 1)
823 		return le32_to_cpu(sbi->s_es->s_blocks_count) - 1;
824 	else
825 		return ext2_group_first_block_no(sb, group_no) +
826 			EXT2_BLOCKS_PER_GROUP(sb) - 1;
827 }
828 
829 #define ext2_set_bit	__test_and_set_bit_le
830 #define ext2_clear_bit	__test_and_clear_bit_le
831 #define ext2_test_bit	test_bit_le
832 #define ext2_find_first_zero_bit	find_first_zero_bit_le
833 #define ext2_find_next_zero_bit		find_next_zero_bit_le
834