xref: /openbmc/linux/fs/ocfs2/ocfs2_fs.h (revision 643d1f7f)
1 /* -*- mode: c; c-basic-offset: 8; -*-
2  * vim: noexpandtab sw=8 ts=8 sts=0:
3  *
4  * ocfs2_fs.h
5  *
6  * On-disk structures for OCFS2.
7  *
8  * Copyright (C) 2002, 2004 Oracle.  All rights reserved.
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public
12  * License, version 2,  as published by the Free Software Foundation.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public
20  * License along with this program; if not, write to the
21  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22  * Boston, MA 021110-1307, USA.
23  */
24 
25 #ifndef _OCFS2_FS_H
26 #define _OCFS2_FS_H
27 
28 /* Version */
29 #define OCFS2_MAJOR_REV_LEVEL		0
30 #define OCFS2_MINOR_REV_LEVEL          	90
31 
32 /*
33  * An OCFS2 volume starts this way:
34  * Sector 0: Valid ocfs1_vol_disk_hdr that cleanly fails to mount OCFS.
35  * Sector 1: Valid ocfs1_vol_label that cleanly fails to mount OCFS.
36  * Block OCFS2_SUPER_BLOCK_BLKNO: OCFS2 superblock.
37  *
38  * All other structures are found from the superblock information.
39  *
40  * OCFS2_SUPER_BLOCK_BLKNO is in blocks, not sectors.  eg, for a
41  * blocksize of 2K, it is 4096 bytes into disk.
42  */
43 #define OCFS2_SUPER_BLOCK_BLKNO		2
44 
45 /*
46  * Cluster size limits. The maximum is kept arbitrarily at 1 MB, and could
47  * grow if needed.
48  */
49 #define OCFS2_MIN_CLUSTERSIZE		4096
50 #define OCFS2_MAX_CLUSTERSIZE		1048576
51 
52 /*
53  * Blocks cannot be bigger than clusters, so the maximum blocksize is the
54  * minimum cluster size.
55  */
56 #define OCFS2_MIN_BLOCKSIZE		512
57 #define OCFS2_MAX_BLOCKSIZE		OCFS2_MIN_CLUSTERSIZE
58 
59 /* Filesystem magic number */
60 #define OCFS2_SUPER_MAGIC		0x7461636f
61 
62 /* Object signatures */
63 #define OCFS2_SUPER_BLOCK_SIGNATURE	"OCFSV2"
64 #define OCFS2_INODE_SIGNATURE		"INODE01"
65 #define OCFS2_EXTENT_BLOCK_SIGNATURE	"EXBLK01"
66 #define OCFS2_GROUP_DESC_SIGNATURE      "GROUP01"
67 
68 /* Compatibility flags */
69 #define OCFS2_HAS_COMPAT_FEATURE(sb,mask)			\
70 	( OCFS2_SB(sb)->s_feature_compat & (mask) )
71 #define OCFS2_HAS_RO_COMPAT_FEATURE(sb,mask)			\
72 	( OCFS2_SB(sb)->s_feature_ro_compat & (mask) )
73 #define OCFS2_HAS_INCOMPAT_FEATURE(sb,mask)			\
74 	( OCFS2_SB(sb)->s_feature_incompat & (mask) )
75 #define OCFS2_SET_COMPAT_FEATURE(sb,mask)			\
76 	OCFS2_SB(sb)->s_feature_compat |= (mask)
77 #define OCFS2_SET_RO_COMPAT_FEATURE(sb,mask)			\
78 	OCFS2_SB(sb)->s_feature_ro_compat |= (mask)
79 #define OCFS2_SET_INCOMPAT_FEATURE(sb,mask)			\
80 	OCFS2_SB(sb)->s_feature_incompat |= (mask)
81 #define OCFS2_CLEAR_COMPAT_FEATURE(sb,mask)			\
82 	OCFS2_SB(sb)->s_feature_compat &= ~(mask)
83 #define OCFS2_CLEAR_RO_COMPAT_FEATURE(sb,mask)			\
84 	OCFS2_SB(sb)->s_feature_ro_compat &= ~(mask)
85 #define OCFS2_CLEAR_INCOMPAT_FEATURE(sb,mask)			\
86 	OCFS2_SB(sb)->s_feature_incompat &= ~(mask)
87 
88 #define OCFS2_FEATURE_COMPAT_SUPP	OCFS2_FEATURE_COMPAT_BACKUP_SB
89 #define OCFS2_FEATURE_INCOMPAT_SUPP	(OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT \
90 					 | OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC \
91 					 | OCFS2_FEATURE_INCOMPAT_INLINE_DATA)
92 #define OCFS2_FEATURE_RO_COMPAT_SUPP	OCFS2_FEATURE_RO_COMPAT_UNWRITTEN
93 
94 /*
95  * Heartbeat-only devices are missing journals and other files.  The
96  * filesystem driver can't load them, but the library can.  Never put
97  * this in OCFS2_FEATURE_INCOMPAT_SUPP, *ever*.
98  */
99 #define OCFS2_FEATURE_INCOMPAT_HEARTBEAT_DEV	0x0002
100 
101 /*
102  * tunefs sets this incompat flag before starting the resize and clears it
103  * at the end. This flag protects users from inadvertently mounting the fs
104  * after an aborted run without fsck-ing.
105  */
106 #define OCFS2_FEATURE_INCOMPAT_RESIZE_INPROG    0x0004
107 
108 /* Used to denote a non-clustered volume */
109 #define OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT	0x0008
110 
111 /* Support for sparse allocation in b-trees */
112 #define OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC	0x0010
113 
114 /*
115  * Tunefs sets this incompat flag before starting an operation which
116  * would require cleanup on abort. This is done to protect users from
117  * inadvertently mounting the fs after an aborted run without
118  * fsck-ing.
119  *
120  * s_tunefs_flags on the super block describes precisely which
121  * operations were in progress.
122  */
123 #define OCFS2_FEATURE_INCOMPAT_TUNEFS_INPROG	0x0020
124 
125 /* Support for data packed into inode blocks */
126 #define OCFS2_FEATURE_INCOMPAT_INLINE_DATA	0x0040
127 
128 /*
129  * backup superblock flag is used to indicate that this volume
130  * has backup superblocks.
131  */
132 #define OCFS2_FEATURE_COMPAT_BACKUP_SB		0x0001
133 
134 /*
135  * Unwritten extents support.
136  */
137 #define OCFS2_FEATURE_RO_COMPAT_UNWRITTEN	0x0001
138 
139 /* The byte offset of the first backup block will be 1G.
140  * The following will be 4G, 16G, 64G, 256G and 1T.
141  */
142 #define OCFS2_BACKUP_SB_START			1 << 30
143 
144 /* the max backup superblock nums */
145 #define OCFS2_MAX_BACKUP_SUPERBLOCKS	6
146 
147 /*
148  * Flags on ocfs2_super_block.s_tunefs_flags
149  */
150 #define OCFS2_TUNEFS_INPROG_REMOVE_SLOT		0x0001	/* Removing slots */
151 
152 /*
153  * Flags on ocfs2_dinode.i_flags
154  */
155 #define OCFS2_VALID_FL		(0x00000001)	/* Inode is valid */
156 #define OCFS2_UNUSED2_FL	(0x00000002)
157 #define OCFS2_ORPHANED_FL	(0x00000004)	/* On the orphan list */
158 #define OCFS2_UNUSED3_FL	(0x00000008)
159 /* System inode flags */
160 #define OCFS2_SYSTEM_FL		(0x00000010)	/* System inode */
161 #define OCFS2_SUPER_BLOCK_FL	(0x00000020)	/* Super block */
162 #define OCFS2_LOCAL_ALLOC_FL	(0x00000040)	/* Slot local alloc bitmap */
163 #define OCFS2_BITMAP_FL		(0x00000080)	/* Allocation bitmap */
164 #define OCFS2_JOURNAL_FL	(0x00000100)	/* Slot local journal */
165 #define OCFS2_HEARTBEAT_FL	(0x00000200)	/* Heartbeat area */
166 #define OCFS2_CHAIN_FL		(0x00000400)	/* Chain allocator */
167 #define OCFS2_DEALLOC_FL	(0x00000800)	/* Truncate log */
168 
169 /*
170  * Flags on ocfs2_dinode.i_dyn_features
171  *
172  * These can change much more often than i_flags. When adding flags,
173  * keep in mind that i_dyn_features is only 16 bits wide.
174  */
175 #define OCFS2_INLINE_DATA_FL	(0x0001)	/* Data stored in inode block */
176 #define OCFS2_HAS_XATTR_FL	(0x0002)
177 #define OCFS2_INLINE_XATTR_FL	(0x0004)
178 #define OCFS2_INDEXED_DIR_FL	(0x0008)
179 
180 /* Inode attributes, keep in sync with EXT2 */
181 #define OCFS2_SECRM_FL		(0x00000001)	/* Secure deletion */
182 #define OCFS2_UNRM_FL		(0x00000002)	/* Undelete */
183 #define OCFS2_COMPR_FL		(0x00000004)	/* Compress file */
184 #define OCFS2_SYNC_FL		(0x00000008)	/* Synchronous updates */
185 #define OCFS2_IMMUTABLE_FL	(0x00000010)	/* Immutable file */
186 #define OCFS2_APPEND_FL		(0x00000020)	/* writes to file may only append */
187 #define OCFS2_NODUMP_FL		(0x00000040)	/* do not dump file */
188 #define OCFS2_NOATIME_FL	(0x00000080)	/* do not update atime */
189 #define OCFS2_DIRSYNC_FL	(0x00010000)	/* dirsync behaviour (directories only) */
190 
191 #define OCFS2_FL_VISIBLE	(0x000100FF)	/* User visible flags */
192 #define OCFS2_FL_MODIFIABLE	(0x000100FF)	/* User modifiable flags */
193 
194 /*
195  * Extent record flags (e_node.leaf.flags)
196  */
197 #define OCFS2_EXT_UNWRITTEN	(0x01)	/* Extent is allocated but
198 					 * unwritten */
199 
200 /*
201  * ioctl commands
202  */
203 #define OCFS2_IOC_GETFLAGS	_IOR('f', 1, long)
204 #define OCFS2_IOC_SETFLAGS	_IOW('f', 2, long)
205 #define OCFS2_IOC32_GETFLAGS	_IOR('f', 1, int)
206 #define OCFS2_IOC32_SETFLAGS	_IOW('f', 2, int)
207 
208 /*
209  * Space reservation / allocation / free ioctls and argument structure
210  * are designed to be compatible with XFS.
211  *
212  * ALLOCSP* and FREESP* are not and will never be supported, but are
213  * included here for completeness.
214  */
215 struct ocfs2_space_resv {
216 	__s16		l_type;
217 	__s16		l_whence;
218 	__s64		l_start;
219 	__s64		l_len;		/* len == 0 means until end of file */
220 	__s32		l_sysid;
221 	__u32		l_pid;
222 	__s32		l_pad[4];	/* reserve area			    */
223 };
224 
225 #define OCFS2_IOC_ALLOCSP		_IOW ('X', 10, struct ocfs2_space_resv)
226 #define OCFS2_IOC_FREESP		_IOW ('X', 11, struct ocfs2_space_resv)
227 #define OCFS2_IOC_RESVSP		_IOW ('X', 40, struct ocfs2_space_resv)
228 #define OCFS2_IOC_UNRESVSP	_IOW ('X', 41, struct ocfs2_space_resv)
229 #define OCFS2_IOC_ALLOCSP64	_IOW ('X', 36, struct ocfs2_space_resv)
230 #define OCFS2_IOC_FREESP64	_IOW ('X', 37, struct ocfs2_space_resv)
231 #define OCFS2_IOC_RESVSP64	_IOW ('X', 42, struct ocfs2_space_resv)
232 #define OCFS2_IOC_UNRESVSP64	_IOW ('X', 43, struct ocfs2_space_resv)
233 
234 /* Used to pass group descriptor data when online resize is done */
235 struct ocfs2_new_group_input {
236 	__u64 group;		/* Group descriptor's blkno. */
237 	__u32 clusters;		/* Total number of clusters in this group */
238 	__u32 frees;		/* Total free clusters in this group */
239 	__u16 chain;		/* Chain for this group */
240 	__u16 reserved1;
241 	__u32 reserved2;
242 };
243 
244 #define OCFS2_IOC_GROUP_EXTEND	_IOW('o', 1, int)
245 #define OCFS2_IOC_GROUP_ADD	_IOW('o', 2,struct ocfs2_new_group_input)
246 #define OCFS2_IOC_GROUP_ADD64	_IOW('o', 3,struct ocfs2_new_group_input)
247 
248 /*
249  * Journal Flags (ocfs2_dinode.id1.journal1.i_flags)
250  */
251 #define OCFS2_JOURNAL_DIRTY_FL	(0x00000001)	/* Journal needs recovery */
252 
253 /*
254  * superblock s_state flags
255  */
256 #define OCFS2_ERROR_FS		(0x00000001)	/* FS saw errors */
257 
258 /* Limit of space in ocfs2_dir_entry */
259 #define OCFS2_MAX_FILENAME_LEN		255
260 
261 /* Maximum slots on an ocfs2 file system */
262 #define OCFS2_MAX_SLOTS			255
263 
264 /* Slot map indicator for an empty slot */
265 #define OCFS2_INVALID_SLOT		-1
266 
267 #define OCFS2_VOL_UUID_LEN		16
268 #define OCFS2_MAX_VOL_LABEL_LEN		64
269 
270 /* Journal limits (in bytes) */
271 #define OCFS2_MIN_JOURNAL_SIZE		(4 * 1024 * 1024)
272 
273 /*
274  * Default local alloc size (in megabytes)
275  *
276  * The value chosen should be such that most allocations, including new
277  * block groups, use local alloc.
278  */
279 #define OCFS2_DEFAULT_LOCAL_ALLOC_SIZE	8
280 
281 struct ocfs2_system_inode_info {
282 	char	*si_name;
283 	int	si_iflags;
284 	int	si_mode;
285 };
286 
287 /* System file index */
288 enum {
289 	BAD_BLOCK_SYSTEM_INODE = 0,
290 	GLOBAL_INODE_ALLOC_SYSTEM_INODE,
291 	SLOT_MAP_SYSTEM_INODE,
292 #define OCFS2_FIRST_ONLINE_SYSTEM_INODE SLOT_MAP_SYSTEM_INODE
293 	HEARTBEAT_SYSTEM_INODE,
294 	GLOBAL_BITMAP_SYSTEM_INODE,
295 #define OCFS2_LAST_GLOBAL_SYSTEM_INODE GLOBAL_BITMAP_SYSTEM_INODE
296 	ORPHAN_DIR_SYSTEM_INODE,
297 	EXTENT_ALLOC_SYSTEM_INODE,
298 	INODE_ALLOC_SYSTEM_INODE,
299 	JOURNAL_SYSTEM_INODE,
300 	LOCAL_ALLOC_SYSTEM_INODE,
301 	TRUNCATE_LOG_SYSTEM_INODE,
302 	NUM_SYSTEM_INODES
303 };
304 
305 static struct ocfs2_system_inode_info ocfs2_system_inodes[NUM_SYSTEM_INODES] = {
306 	/* Global system inodes (single copy) */
307 	/* The first two are only used from userspace mfks/tunefs */
308 	[BAD_BLOCK_SYSTEM_INODE]		= { "bad_blocks", 0, S_IFREG | 0644 },
309 	[GLOBAL_INODE_ALLOC_SYSTEM_INODE] 	= { "global_inode_alloc", OCFS2_BITMAP_FL | OCFS2_CHAIN_FL, S_IFREG | 0644 },
310 
311 	/* These are used by the running filesystem */
312 	[SLOT_MAP_SYSTEM_INODE]			= { "slot_map", 0, S_IFREG | 0644 },
313 	[HEARTBEAT_SYSTEM_INODE]		= { "heartbeat", OCFS2_HEARTBEAT_FL, S_IFREG | 0644 },
314 	[GLOBAL_BITMAP_SYSTEM_INODE]		= { "global_bitmap", 0, S_IFREG | 0644 },
315 
316 	/* Slot-specific system inodes (one copy per slot) */
317 	[ORPHAN_DIR_SYSTEM_INODE]		= { "orphan_dir:%04d", 0, S_IFDIR | 0755 },
318 	[EXTENT_ALLOC_SYSTEM_INODE]		= { "extent_alloc:%04d", OCFS2_BITMAP_FL | OCFS2_CHAIN_FL, S_IFREG | 0644 },
319 	[INODE_ALLOC_SYSTEM_INODE]		= { "inode_alloc:%04d", OCFS2_BITMAP_FL | OCFS2_CHAIN_FL, S_IFREG | 0644 },
320 	[JOURNAL_SYSTEM_INODE]			= { "journal:%04d", OCFS2_JOURNAL_FL, S_IFREG | 0644 },
321 	[LOCAL_ALLOC_SYSTEM_INODE]		= { "local_alloc:%04d", OCFS2_BITMAP_FL | OCFS2_LOCAL_ALLOC_FL, S_IFREG | 0644 },
322 	[TRUNCATE_LOG_SYSTEM_INODE]		= { "truncate_log:%04d", OCFS2_DEALLOC_FL, S_IFREG | 0644 }
323 };
324 
325 /* Parameter passed from mount.ocfs2 to module */
326 #define OCFS2_HB_NONE			"heartbeat=none"
327 #define OCFS2_HB_LOCAL			"heartbeat=local"
328 
329 /*
330  * OCFS2 directory file types.  Only the low 3 bits are used.  The
331  * other bits are reserved for now.
332  */
333 #define OCFS2_FT_UNKNOWN	0
334 #define OCFS2_FT_REG_FILE	1
335 #define OCFS2_FT_DIR		2
336 #define OCFS2_FT_CHRDEV		3
337 #define OCFS2_FT_BLKDEV		4
338 #define OCFS2_FT_FIFO		5
339 #define OCFS2_FT_SOCK		6
340 #define OCFS2_FT_SYMLINK	7
341 
342 #define OCFS2_FT_MAX		8
343 
344 /*
345  * OCFS2_DIR_PAD defines the directory entries boundaries
346  *
347  * NOTE: It must be a multiple of 4
348  */
349 #define OCFS2_DIR_PAD			4
350 #define OCFS2_DIR_ROUND			(OCFS2_DIR_PAD - 1)
351 #define OCFS2_DIR_MEMBER_LEN 		offsetof(struct ocfs2_dir_entry, name)
352 #define OCFS2_DIR_REC_LEN(name_len)	(((name_len) + OCFS2_DIR_MEMBER_LEN + \
353                                           OCFS2_DIR_ROUND) & \
354 					 ~OCFS2_DIR_ROUND)
355 
356 #define OCFS2_LINK_MAX		32000
357 
358 #define S_SHIFT			12
359 static unsigned char ocfs2_type_by_mode[S_IFMT >> S_SHIFT] = {
360 	[S_IFREG >> S_SHIFT]  = OCFS2_FT_REG_FILE,
361 	[S_IFDIR >> S_SHIFT]  = OCFS2_FT_DIR,
362 	[S_IFCHR >> S_SHIFT]  = OCFS2_FT_CHRDEV,
363 	[S_IFBLK >> S_SHIFT]  = OCFS2_FT_BLKDEV,
364 	[S_IFIFO >> S_SHIFT]  = OCFS2_FT_FIFO,
365 	[S_IFSOCK >> S_SHIFT] = OCFS2_FT_SOCK,
366 	[S_IFLNK >> S_SHIFT]  = OCFS2_FT_SYMLINK,
367 };
368 
369 
370 /*
371  * Convenience casts
372  */
373 #define OCFS2_RAW_SB(dinode)		(&((dinode)->id2.i_super))
374 
375 /*
376  * On disk extent record for OCFS2
377  * It describes a range of clusters on disk.
378  *
379  * Length fields are divided into interior and leaf node versions.
380  * This leaves room for a flags field (OCFS2_EXT_*) in the leaf nodes.
381  */
382 struct ocfs2_extent_rec {
383 /*00*/	__le32 e_cpos;		/* Offset into the file, in clusters */
384 	union {
385 		__le32 e_int_clusters; /* Clusters covered by all children */
386 		struct {
387 			__le16 e_leaf_clusters; /* Clusters covered by this
388 						   extent */
389 			__u8 e_reserved1;
390 			__u8 e_flags; /* Extent flags */
391 		};
392 	};
393 	__le64 e_blkno;		/* Physical disk offset, in blocks */
394 /*10*/
395 };
396 
397 struct ocfs2_chain_rec {
398 	__le32 c_free;	/* Number of free bits in this chain. */
399 	__le32 c_total;	/* Number of total bits in this chain */
400 	__le64 c_blkno;	/* Physical disk offset (blocks) of 1st group */
401 };
402 
403 struct ocfs2_truncate_rec {
404 	__le32 t_start;		/* 1st cluster in this log */
405 	__le32 t_clusters;	/* Number of total clusters covered */
406 };
407 
408 /*
409  * On disk extent list for OCFS2 (node in the tree).  Note that this
410  * is contained inside ocfs2_dinode or ocfs2_extent_block, so the
411  * offsets are relative to ocfs2_dinode.id2.i_list or
412  * ocfs2_extent_block.h_list, respectively.
413  */
414 struct ocfs2_extent_list {
415 /*00*/	__le16 l_tree_depth;		/* Extent tree depth from this
416 					   point.  0 means data extents
417 					   hang directly off this
418 					   header (a leaf)
419 					   NOTE: The high 8 bits cannot be
420 					   used - tree_depth is never that big.
421 					*/
422 	__le16 l_count;			/* Number of extent records */
423 	__le16 l_next_free_rec;		/* Next unused extent slot */
424 	__le16 l_reserved1;
425 	__le64 l_reserved2;		/* Pad to
426 					   sizeof(ocfs2_extent_rec) */
427 /*10*/	struct ocfs2_extent_rec l_recs[0];	/* Extent records */
428 };
429 
430 /*
431  * On disk allocation chain list for OCFS2.  Note that this is
432  * contained inside ocfs2_dinode, so the offsets are relative to
433  * ocfs2_dinode.id2.i_chain.
434  */
435 struct ocfs2_chain_list {
436 /*00*/	__le16 cl_cpg;			/* Clusters per Block Group */
437 	__le16 cl_bpc;			/* Bits per cluster */
438 	__le16 cl_count;		/* Total chains in this list */
439 	__le16 cl_next_free_rec;	/* Next unused chain slot */
440 	__le64 cl_reserved1;
441 /*10*/	struct ocfs2_chain_rec cl_recs[0];	/* Chain records */
442 };
443 
444 /*
445  * On disk deallocation log for OCFS2.  Note that this is
446  * contained inside ocfs2_dinode, so the offsets are relative to
447  * ocfs2_dinode.id2.i_dealloc.
448  */
449 struct ocfs2_truncate_log {
450 /*00*/	__le16 tl_count;		/* Total records in this log */
451 	__le16 tl_used;			/* Number of records in use */
452 	__le32 tl_reserved1;
453 /*08*/	struct ocfs2_truncate_rec tl_recs[0];	/* Truncate records */
454 };
455 
456 /*
457  * On disk extent block (indirect block) for OCFS2
458  */
459 struct ocfs2_extent_block
460 {
461 /*00*/	__u8 h_signature[8];		/* Signature for verification */
462 	__le64 h_reserved1;
463 /*10*/	__le16 h_suballoc_slot;		/* Slot suballocator this
464 					   extent_header belongs to */
465 	__le16 h_suballoc_bit;		/* Bit offset in suballocator
466 					   block group */
467 	__le32 h_fs_generation;		/* Must match super block */
468 	__le64 h_blkno;			/* Offset on disk, in blocks */
469 /*20*/	__le64 h_reserved3;
470 	__le64 h_next_leaf_blk;		/* Offset on disk, in blocks,
471 					   of next leaf header pointing
472 					   to data */
473 /*30*/	struct ocfs2_extent_list h_list;	/* Extent record list */
474 /* Actual on-disk size is one block */
475 };
476 
477 /*
478  * On disk superblock for OCFS2
479  * Note that it is contained inside an ocfs2_dinode, so all offsets
480  * are relative to the start of ocfs2_dinode.id2.
481  */
482 struct ocfs2_super_block {
483 /*00*/	__le16 s_major_rev_level;
484 	__le16 s_minor_rev_level;
485 	__le16 s_mnt_count;
486 	__le16 s_max_mnt_count;
487 	__le16 s_state;			/* File system state */
488 	__le16 s_errors;			/* Behaviour when detecting errors */
489 	__le32 s_checkinterval;		/* Max time between checks */
490 /*10*/	__le64 s_lastcheck;		/* Time of last check */
491 	__le32 s_creator_os;		/* OS */
492 	__le32 s_feature_compat;		/* Compatible feature set */
493 /*20*/	__le32 s_feature_incompat;	/* Incompatible feature set */
494 	__le32 s_feature_ro_compat;	/* Readonly-compatible feature set */
495 	__le64 s_root_blkno;		/* Offset, in blocks, of root directory
496 					   dinode */
497 /*30*/	__le64 s_system_dir_blkno;	/* Offset, in blocks, of system
498 					   directory dinode */
499 	__le32 s_blocksize_bits;		/* Blocksize for this fs */
500 	__le32 s_clustersize_bits;	/* Clustersize for this fs */
501 /*40*/	__le16 s_max_slots;		/* Max number of simultaneous mounts
502 					   before tunefs required */
503 	__le16 s_tunefs_flag;
504 	__le32 s_reserved1;
505 	__le64 s_first_cluster_group;	/* Block offset of 1st cluster
506 					 * group header */
507 /*50*/	__u8  s_label[OCFS2_MAX_VOL_LABEL_LEN];	/* Label for mounting, etc. */
508 /*90*/	__u8  s_uuid[OCFS2_VOL_UUID_LEN];	/* 128-bit uuid */
509 /*A0*/
510 };
511 
512 /*
513  * Local allocation bitmap for OCFS2 slots
514  * Note that it exists inside an ocfs2_dinode, so all offsets are
515  * relative to the start of ocfs2_dinode.id2.
516  */
517 struct ocfs2_local_alloc
518 {
519 /*00*/	__le32 la_bm_off;	/* Starting bit offset in main bitmap */
520 	__le16 la_size;		/* Size of included bitmap, in bytes */
521 	__le16 la_reserved1;
522 	__le64 la_reserved2;
523 /*10*/	__u8   la_bitmap[0];
524 };
525 
526 /*
527  * Data-in-inode header. This is only used if i_dyn_features has
528  * OCFS2_INLINE_DATA_FL set.
529  */
530 struct ocfs2_inline_data
531 {
532 /*00*/	__le16	id_count;	/* Number of bytes that can be used
533 				 * for data, starting at id_data */
534 	__le16	id_reserved0;
535 	__le32	id_reserved1;
536 	__u8	id_data[0];	/* Start of user data */
537 };
538 
539 /*
540  * On disk inode for OCFS2
541  */
542 struct ocfs2_dinode {
543 /*00*/	__u8 i_signature[8];		/* Signature for validation */
544 	__le32 i_generation;		/* Generation number */
545 	__le16 i_suballoc_slot;		/* Slot suballocator this inode
546 					   belongs to */
547 	__le16 i_suballoc_bit;		/* Bit offset in suballocator
548 					   block group */
549 /*10*/	__le32 i_reserved0;
550 	__le32 i_clusters;		/* Cluster count */
551 	__le32 i_uid;			/* Owner UID */
552 	__le32 i_gid;			/* Owning GID */
553 /*20*/	__le64 i_size;			/* Size in bytes */
554 	__le16 i_mode;			/* File mode */
555 	__le16 i_links_count;		/* Links count */
556 	__le32 i_flags;			/* File flags */
557 /*30*/	__le64 i_atime;			/* Access time */
558 	__le64 i_ctime;			/* Creation time */
559 /*40*/	__le64 i_mtime;			/* Modification time */
560 	__le64 i_dtime;			/* Deletion time */
561 /*50*/	__le64 i_blkno;			/* Offset on disk, in blocks */
562 	__le64 i_last_eb_blk;		/* Pointer to last extent
563 					   block */
564 /*60*/	__le32 i_fs_generation;		/* Generation per fs-instance */
565 	__le32 i_atime_nsec;
566 	__le32 i_ctime_nsec;
567 	__le32 i_mtime_nsec;
568 	__le32 i_attr;
569 	__le16 i_orphaned_slot;		/* Only valid when OCFS2_ORPHANED_FL
570 					   was set in i_flags */
571 	__le16 i_dyn_features;
572 /*70*/	__le64 i_reserved2[8];
573 /*B8*/	union {
574 		__le64 i_pad1;		/* Generic way to refer to this
575 					   64bit union */
576 		struct {
577 			__le64 i_rdev;	/* Device number */
578 		} dev1;
579 		struct {		/* Info for bitmap system
580 					   inodes */
581 			__le32 i_used;	/* Bits (ie, clusters) used  */
582 			__le32 i_total;	/* Total bits (clusters)
583 					   available */
584 		} bitmap1;
585 		struct {		/* Info for journal system
586 					   inodes */
587 			__le32 ij_flags;	/* Mounted, version, etc. */
588 			__le32 ij_pad;
589 		} journal1;
590 	} id1;				/* Inode type dependant 1 */
591 /*C0*/	union {
592 		struct ocfs2_super_block	i_super;
593 		struct ocfs2_local_alloc	i_lab;
594 		struct ocfs2_chain_list		i_chain;
595 		struct ocfs2_extent_list	i_list;
596 		struct ocfs2_truncate_log	i_dealloc;
597 		struct ocfs2_inline_data	i_data;
598 		__u8               		i_symlink[0];
599 	} id2;
600 /* Actual on-disk size is one block */
601 };
602 
603 /*
604  * On-disk directory entry structure for OCFS2
605  *
606  * Packed as this structure could be accessed unaligned on 64-bit platforms
607  */
608 struct ocfs2_dir_entry {
609 /*00*/	__le64   inode;                  /* Inode number */
610 	__le16   rec_len;                /* Directory entry length */
611 	__u8    name_len;               /* Name length */
612 	__u8    file_type;
613 /*0C*/	char    name[OCFS2_MAX_FILENAME_LEN];   /* File name */
614 /* Actual on-disk length specified by rec_len */
615 } __attribute__ ((packed));
616 
617 /*
618  * On disk allocator group structure for OCFS2
619  */
620 struct ocfs2_group_desc
621 {
622 /*00*/	__u8    bg_signature[8];        /* Signature for validation */
623 	__le16   bg_size;                /* Size of included bitmap in
624 					   bytes. */
625 	__le16   bg_bits;                /* Bits represented by this
626 					   group. */
627 	__le16	bg_free_bits_count;     /* Free bits count */
628 	__le16   bg_chain;               /* What chain I am in. */
629 /*10*/	__le32   bg_generation;
630 	__le32	bg_reserved1;
631 	__le64   bg_next_group;          /* Next group in my list, in
632 					   blocks */
633 /*20*/	__le64   bg_parent_dinode;       /* dinode which owns me, in
634 					   blocks */
635 	__le64   bg_blkno;               /* Offset on disk, in blocks */
636 /*30*/	__le64   bg_reserved2[2];
637 /*40*/	__u8    bg_bitmap[0];
638 };
639 
640 #ifdef __KERNEL__
641 static inline int ocfs2_fast_symlink_chars(struct super_block *sb)
642 {
643 	return  sb->s_blocksize -
644 		 offsetof(struct ocfs2_dinode, id2.i_symlink);
645 }
646 
647 static inline int ocfs2_max_inline_data(struct super_block *sb)
648 {
649 	return sb->s_blocksize -
650 		offsetof(struct ocfs2_dinode, id2.i_data.id_data);
651 }
652 
653 static inline int ocfs2_extent_recs_per_inode(struct super_block *sb)
654 {
655 	int size;
656 
657 	size = sb->s_blocksize -
658 		offsetof(struct ocfs2_dinode, id2.i_list.l_recs);
659 
660 	return size / sizeof(struct ocfs2_extent_rec);
661 }
662 
663 static inline int ocfs2_chain_recs_per_inode(struct super_block *sb)
664 {
665 	int size;
666 
667 	size = sb->s_blocksize -
668 		offsetof(struct ocfs2_dinode, id2.i_chain.cl_recs);
669 
670 	return size / sizeof(struct ocfs2_chain_rec);
671 }
672 
673 static inline u16 ocfs2_extent_recs_per_eb(struct super_block *sb)
674 {
675 	int size;
676 
677 	size = sb->s_blocksize -
678 		offsetof(struct ocfs2_extent_block, h_list.l_recs);
679 
680 	return size / sizeof(struct ocfs2_extent_rec);
681 }
682 
683 static inline u16 ocfs2_local_alloc_size(struct super_block *sb)
684 {
685 	u16 size;
686 
687 	size = sb->s_blocksize -
688 		offsetof(struct ocfs2_dinode, id2.i_lab.la_bitmap);
689 
690 	return size;
691 }
692 
693 static inline int ocfs2_group_bitmap_size(struct super_block *sb)
694 {
695 	int size;
696 
697 	size = sb->s_blocksize -
698 		offsetof(struct ocfs2_group_desc, bg_bitmap);
699 
700 	return size;
701 }
702 
703 static inline int ocfs2_truncate_recs_per_inode(struct super_block *sb)
704 {
705 	int size;
706 
707 	size = sb->s_blocksize -
708 		offsetof(struct ocfs2_dinode, id2.i_dealloc.tl_recs);
709 
710 	return size / sizeof(struct ocfs2_truncate_rec);
711 }
712 
713 static inline u64 ocfs2_backup_super_blkno(struct super_block *sb, int index)
714 {
715 	u64 offset = OCFS2_BACKUP_SB_START;
716 
717 	if (index >= 0 && index < OCFS2_MAX_BACKUP_SUPERBLOCKS) {
718 		offset <<= (2 * index);
719 		offset >>= sb->s_blocksize_bits;
720 		return offset;
721 	}
722 
723 	return 0;
724 
725 }
726 #else
727 static inline int ocfs2_fast_symlink_chars(int blocksize)
728 {
729 	return blocksize - offsetof(struct ocfs2_dinode, id2.i_symlink);
730 }
731 
732 static inline int ocfs2_max_inline_data(int blocksize)
733 {
734 	return blocksize - offsetof(struct ocfs2_dinode, id2.i_data.id_data);
735 }
736 
737 static inline int ocfs2_extent_recs_per_inode(int blocksize)
738 {
739 	int size;
740 
741 	size = blocksize -
742 		offsetof(struct ocfs2_dinode, id2.i_list.l_recs);
743 
744 	return size / sizeof(struct ocfs2_extent_rec);
745 }
746 
747 static inline int ocfs2_chain_recs_per_inode(int blocksize)
748 {
749 	int size;
750 
751 	size = blocksize -
752 		offsetof(struct ocfs2_dinode, id2.i_chain.cl_recs);
753 
754 	return size / sizeof(struct ocfs2_chain_rec);
755 }
756 
757 static inline int ocfs2_extent_recs_per_eb(int blocksize)
758 {
759 	int size;
760 
761 	size = blocksize -
762 		offsetof(struct ocfs2_extent_block, h_list.l_recs);
763 
764 	return size / sizeof(struct ocfs2_extent_rec);
765 }
766 
767 static inline int ocfs2_local_alloc_size(int blocksize)
768 {
769 	int size;
770 
771 	size = blocksize -
772 		offsetof(struct ocfs2_dinode, id2.i_lab.la_bitmap);
773 
774 	return size;
775 }
776 
777 static inline int ocfs2_group_bitmap_size(int blocksize)
778 {
779 	int size;
780 
781 	size = blocksize -
782 		offsetof(struct ocfs2_group_desc, bg_bitmap);
783 
784 	return size;
785 }
786 
787 static inline int ocfs2_truncate_recs_per_inode(int blocksize)
788 {
789 	int size;
790 
791 	size = blocksize -
792 		offsetof(struct ocfs2_dinode, id2.i_dealloc.tl_recs);
793 
794 	return size / sizeof(struct ocfs2_truncate_rec);
795 }
796 
797 static inline uint64_t ocfs2_backup_super_blkno(int blocksize, int index)
798 {
799 	uint64_t offset = OCFS2_BACKUP_SB_START;
800 
801 	if (index >= 0 && index < OCFS2_MAX_BACKUP_SUPERBLOCKS) {
802 		offset <<= (2 * index);
803 		offset /= blocksize;
804 		return offset;
805 	}
806 
807 	return 0;
808 }
809 #endif  /* __KERNEL__ */
810 
811 
812 static inline int ocfs2_system_inode_is_global(int type)
813 {
814 	return ((type >= 0) &&
815 		(type <= OCFS2_LAST_GLOBAL_SYSTEM_INODE));
816 }
817 
818 static inline int ocfs2_sprintf_system_inode_name(char *buf, int len,
819 						  int type, int slot)
820 {
821 	int chars;
822 
823         /*
824          * Global system inodes can only have one copy.  Everything
825          * after OCFS2_LAST_GLOBAL_SYSTEM_INODE in the system inode
826          * list has a copy per slot.
827          */
828 	if (type <= OCFS2_LAST_GLOBAL_SYSTEM_INODE)
829 		chars = snprintf(buf, len,
830 				 ocfs2_system_inodes[type].si_name);
831 	else
832 		chars = snprintf(buf, len,
833 				 ocfs2_system_inodes[type].si_name,
834 				 slot);
835 
836 	return chars;
837 }
838 
839 static inline void ocfs2_set_de_type(struct ocfs2_dir_entry *de,
840 				    umode_t mode)
841 {
842 	de->file_type = ocfs2_type_by_mode[(mode & S_IFMT)>>S_SHIFT];
843 }
844 
845 #endif  /* _OCFS2_FS_H */
846 
847