blob: 43da76eff9ae64a6c3e51b8fa551c04b4941f26f [file] [log] [blame]
Mark Fashehccd979b2005-12-15 14:31:24 -08001/* -*- 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"
Tao Ma5a7bc8e2008-08-18 17:38:46 +080067#define OCFS2_XATTR_BLOCK_SIGNATURE "XATTR01"
Mark Fasheh87d35a72008-12-10 17:36:25 -080068#define OCFS2_DIR_TRAILER_SIGNATURE "DIRTRL1"
Mark Fasheh9b7895e2008-11-12 16:27:44 -080069#define OCFS2_DX_ROOT_SIGNATURE "DXDIR01"
70#define OCFS2_DX_LEAF_SIGNATURE "DXLEAF1"
Mark Fashehccd979b2005-12-15 14:31:24 -080071
72/* Compatibility flags */
73#define OCFS2_HAS_COMPAT_FEATURE(sb,mask) \
74 ( OCFS2_SB(sb)->s_feature_compat & (mask) )
75#define OCFS2_HAS_RO_COMPAT_FEATURE(sb,mask) \
76 ( OCFS2_SB(sb)->s_feature_ro_compat & (mask) )
77#define OCFS2_HAS_INCOMPAT_FEATURE(sb,mask) \
78 ( OCFS2_SB(sb)->s_feature_incompat & (mask) )
79#define OCFS2_SET_COMPAT_FEATURE(sb,mask) \
80 OCFS2_SB(sb)->s_feature_compat |= (mask)
81#define OCFS2_SET_RO_COMPAT_FEATURE(sb,mask) \
82 OCFS2_SB(sb)->s_feature_ro_compat |= (mask)
83#define OCFS2_SET_INCOMPAT_FEATURE(sb,mask) \
84 OCFS2_SB(sb)->s_feature_incompat |= (mask)
85#define OCFS2_CLEAR_COMPAT_FEATURE(sb,mask) \
86 OCFS2_SB(sb)->s_feature_compat &= ~(mask)
87#define OCFS2_CLEAR_RO_COMPAT_FEATURE(sb,mask) \
88 OCFS2_SB(sb)->s_feature_ro_compat &= ~(mask)
89#define OCFS2_CLEAR_INCOMPAT_FEATURE(sb,mask) \
90 OCFS2_SB(sb)->s_feature_incompat &= ~(mask)
91
Joel Beckera9772182008-12-16 18:10:18 -080092#define OCFS2_FEATURE_COMPAT_SUPP (OCFS2_FEATURE_COMPAT_BACKUP_SB \
93 | OCFS2_FEATURE_COMPAT_JBD2_SB)
Mark Fashehdcd05382007-01-16 11:32:23 -080094#define OCFS2_FEATURE_INCOMPAT_SUPP (OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT \
Mark Fasheh15b1e362007-09-07 13:58:15 -070095 | OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC \
Joel Becker386a2ef2008-02-01 12:06:54 -080096 | OCFS2_FEATURE_INCOMPAT_INLINE_DATA \
Joel Beckerb61817e2008-02-01 15:08:23 -080097 | OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP \
Tiger Yang8154da32008-08-18 17:11:46 +080098 | OCFS2_FEATURE_INCOMPAT_USERSPACE_STACK \
Joel Becker9d28cfb2008-10-16 17:53:29 -070099 | OCFS2_FEATURE_INCOMPAT_XATTR \
100 | OCFS2_FEATURE_INCOMPAT_META_ECC)
Jan Kara19ece542008-08-21 20:13:17 +0200101#define OCFS2_FEATURE_RO_COMPAT_SUPP (OCFS2_FEATURE_RO_COMPAT_UNWRITTEN \
102 | OCFS2_FEATURE_RO_COMPAT_USRQUOTA \
103 | OCFS2_FEATURE_RO_COMPAT_GRPQUOTA)
Mark Fashehccd979b2005-12-15 14:31:24 -0800104
105/*
106 * Heartbeat-only devices are missing journals and other files. The
107 * filesystem driver can't load them, but the library can. Never put
108 * this in OCFS2_FEATURE_INCOMPAT_SUPP, *ever*.
109 */
110#define OCFS2_FEATURE_INCOMPAT_HEARTBEAT_DEV 0x0002
111
Mark Fasheh89039012006-12-07 18:05:37 -0800112/*
113 * tunefs sets this incompat flag before starting the resize and clears it
114 * at the end. This flag protects users from inadvertently mounting the fs
115 * after an aborted run without fsck-ing.
116 */
117#define OCFS2_FEATURE_INCOMPAT_RESIZE_INPROG 0x0004
Mark Fashehccd979b2005-12-15 14:31:24 -0800118
Sunil Mushranc271c5c2006-12-05 17:56:35 -0800119/* Used to denote a non-clustered volume */
120#define OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT 0x0008
121
Mark Fasheh89039012006-12-07 18:05:37 -0800122/* Support for sparse allocation in b-trees */
123#define OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC 0x0010
124
Mark Fashehccd979b2005-12-15 14:31:24 -0800125/*
Mark Fasheh92e91ce2007-09-20 11:19:20 -0700126 * Tunefs sets this incompat flag before starting an operation which
127 * would require cleanup on abort. This is done to protect users from
128 * inadvertently mounting the fs after an aborted run without
129 * fsck-ing.
130 *
131 * s_tunefs_flags on the super block describes precisely which
132 * operations were in progress.
133 */
134#define OCFS2_FEATURE_INCOMPAT_TUNEFS_INPROG 0x0020
135
Mark Fasheh15b1e362007-09-07 13:58:15 -0700136/* Support for data packed into inode blocks */
137#define OCFS2_FEATURE_INCOMPAT_INLINE_DATA 0x0040
138
Mark Fasheh92e91ce2007-09-20 11:19:20 -0700139/*
Joel Beckerb61817e2008-02-01 15:08:23 -0800140 * Support for alternate, userspace cluster stacks. If set, the superblock
141 * field s_cluster_info contains a tag for the alternate stack in use as
142 * well as the name of the cluster being joined.
143 * mount.ocfs2 must pass in a matching stack name.
144 *
145 * If not set, the classic stack will be used. This is compatbile with
146 * all older versions.
147 */
148#define OCFS2_FEATURE_INCOMPAT_USERSPACE_STACK 0x0080
149
Tiger Yang8154da32008-08-18 17:11:46 +0800150/* Support for the extended slot map */
151#define OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP 0x100
152
153/* Support for extended attributes */
154#define OCFS2_FEATURE_INCOMPAT_XATTR 0x0200
155
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800156/* Support for indexed directores */
157#define OCFS2_FEATURE_INCOMPAT_INDEXED_DIRS 0x0400
158
Joel Beckerab552d52008-10-16 17:50:30 -0700159/* Metadata checksum and error correction */
160#define OCFS2_FEATURE_INCOMPAT_META_ECC 0x0800
161
Joel Beckerb61817e2008-02-01 15:08:23 -0800162/*
Mark Fasheh50af94b2007-01-21 14:44:59 -0800163 * backup superblock flag is used to indicate that this volume
164 * has backup superblocks.
165 */
166#define OCFS2_FEATURE_COMPAT_BACKUP_SB 0x0001
167
Mark Fasheh328d5752007-06-18 10:48:04 -0700168/*
Joel Beckera9772182008-12-16 18:10:18 -0800169 * The filesystem will correctly handle journal feature bits.
170 */
171#define OCFS2_FEATURE_COMPAT_JBD2_SB 0x0002
172
173/*
Mark Fasheh328d5752007-06-18 10:48:04 -0700174 * Unwritten extents support.
175 */
176#define OCFS2_FEATURE_RO_COMPAT_UNWRITTEN 0x0001
177
Jan Kara1a224ad2008-08-20 15:43:36 +0200178/*
179 * Maintain quota information for this filesystem
180 */
181#define OCFS2_FEATURE_RO_COMPAT_USRQUOTA 0x0002
182#define OCFS2_FEATURE_RO_COMPAT_GRPQUOTA 0x0004
183
Mark Fasheh50af94b2007-01-21 14:44:59 -0800184/* The byte offset of the first backup block will be 1G.
185 * The following will be 4G, 16G, 64G, 256G and 1T.
186 */
187#define OCFS2_BACKUP_SB_START 1 << 30
188
189/* the max backup superblock nums */
190#define OCFS2_MAX_BACKUP_SUPERBLOCKS 6
191
192/*
Mark Fasheh92e91ce2007-09-20 11:19:20 -0700193 * Flags on ocfs2_super_block.s_tunefs_flags
194 */
195#define OCFS2_TUNEFS_INPROG_REMOVE_SLOT 0x0001 /* Removing slots */
196
197/*
Mark Fashehccd979b2005-12-15 14:31:24 -0800198 * Flags on ocfs2_dinode.i_flags
199 */
200#define OCFS2_VALID_FL (0x00000001) /* Inode is valid */
201#define OCFS2_UNUSED2_FL (0x00000002)
202#define OCFS2_ORPHANED_FL (0x00000004) /* On the orphan list */
203#define OCFS2_UNUSED3_FL (0x00000008)
204/* System inode flags */
205#define OCFS2_SYSTEM_FL (0x00000010) /* System inode */
206#define OCFS2_SUPER_BLOCK_FL (0x00000020) /* Super block */
207#define OCFS2_LOCAL_ALLOC_FL (0x00000040) /* Slot local alloc bitmap */
208#define OCFS2_BITMAP_FL (0x00000080) /* Allocation bitmap */
209#define OCFS2_JOURNAL_FL (0x00000100) /* Slot local journal */
210#define OCFS2_HEARTBEAT_FL (0x00000200) /* Heartbeat area */
211#define OCFS2_CHAIN_FL (0x00000400) /* Chain allocator */
212#define OCFS2_DEALLOC_FL (0x00000800) /* Truncate log */
Jan Kara1a224ad2008-08-20 15:43:36 +0200213#define OCFS2_QUOTA_FL (0x00001000) /* Quota file */
Mark Fashehccd979b2005-12-15 14:31:24 -0800214
Mark Fasheh15b1e362007-09-07 13:58:15 -0700215/*
216 * Flags on ocfs2_dinode.i_dyn_features
217 *
218 * These can change much more often than i_flags. When adding flags,
219 * keep in mind that i_dyn_features is only 16 bits wide.
220 */
221#define OCFS2_INLINE_DATA_FL (0x0001) /* Data stored in inode block */
222#define OCFS2_HAS_XATTR_FL (0x0002)
223#define OCFS2_INLINE_XATTR_FL (0x0004)
224#define OCFS2_INDEXED_DIR_FL (0x0008)
225
Herbert Poetzlca4d1472006-07-03 17:27:12 -0700226/* Inode attributes, keep in sync with EXT2 */
227#define OCFS2_SECRM_FL (0x00000001) /* Secure deletion */
228#define OCFS2_UNRM_FL (0x00000002) /* Undelete */
229#define OCFS2_COMPR_FL (0x00000004) /* Compress file */
230#define OCFS2_SYNC_FL (0x00000008) /* Synchronous updates */
231#define OCFS2_IMMUTABLE_FL (0x00000010) /* Immutable file */
232#define OCFS2_APPEND_FL (0x00000020) /* writes to file may only append */
233#define OCFS2_NODUMP_FL (0x00000040) /* do not dump file */
234#define OCFS2_NOATIME_FL (0x00000080) /* do not update atime */
235#define OCFS2_DIRSYNC_FL (0x00010000) /* dirsync behaviour (directories only) */
236
237#define OCFS2_FL_VISIBLE (0x000100FF) /* User visible flags */
238#define OCFS2_FL_MODIFIABLE (0x000100FF) /* User modifiable flags */
239
240/*
Mark Fashehe48edee2007-03-07 16:46:57 -0800241 * Extent record flags (e_node.leaf.flags)
242 */
243#define OCFS2_EXT_UNWRITTEN (0x01) /* Extent is allocated but
244 * unwritten */
245
246/*
Herbert Poetzlca4d1472006-07-03 17:27:12 -0700247 * ioctl commands
248 */
249#define OCFS2_IOC_GETFLAGS _IOR('f', 1, long)
250#define OCFS2_IOC_SETFLAGS _IOW('f', 2, long)
Mark Fasheh586d2322007-03-09 15:56:28 -0800251#define OCFS2_IOC32_GETFLAGS _IOR('f', 1, int)
252#define OCFS2_IOC32_SETFLAGS _IOW('f', 2, int)
Herbert Poetzlca4d1472006-07-03 17:27:12 -0700253
Mark Fashehccd979b2005-12-15 14:31:24 -0800254/*
Mark Fashehb2580102007-03-09 16:53:21 -0800255 * Space reservation / allocation / free ioctls and argument structure
256 * are designed to be compatible with XFS.
257 *
258 * ALLOCSP* and FREESP* are not and will never be supported, but are
259 * included here for completeness.
260 */
261struct ocfs2_space_resv {
262 __s16 l_type;
263 __s16 l_whence;
264 __s64 l_start;
265 __s64 l_len; /* len == 0 means until end of file */
266 __s32 l_sysid;
267 __u32 l_pid;
268 __s32 l_pad[4]; /* reserve area */
269};
270
271#define OCFS2_IOC_ALLOCSP _IOW ('X', 10, struct ocfs2_space_resv)
272#define OCFS2_IOC_FREESP _IOW ('X', 11, struct ocfs2_space_resv)
273#define OCFS2_IOC_RESVSP _IOW ('X', 40, struct ocfs2_space_resv)
274#define OCFS2_IOC_UNRESVSP _IOW ('X', 41, struct ocfs2_space_resv)
275#define OCFS2_IOC_ALLOCSP64 _IOW ('X', 36, struct ocfs2_space_resv)
276#define OCFS2_IOC_FREESP64 _IOW ('X', 37, struct ocfs2_space_resv)
277#define OCFS2_IOC_RESVSP64 _IOW ('X', 42, struct ocfs2_space_resv)
278#define OCFS2_IOC_UNRESVSP64 _IOW ('X', 43, struct ocfs2_space_resv)
279
Tao Ma7909f2b2007-12-18 15:47:25 +0800280/* Used to pass group descriptor data when online resize is done */
281struct ocfs2_new_group_input {
282 __u64 group; /* Group descriptor's blkno. */
283 __u32 clusters; /* Total number of clusters in this group */
284 __u32 frees; /* Total free clusters in this group */
285 __u16 chain; /* Chain for this group */
286 __u16 reserved1;
287 __u32 reserved2;
288};
289
Tao Mad6590722007-12-18 15:47:03 +0800290#define OCFS2_IOC_GROUP_EXTEND _IOW('o', 1, int)
Tao Ma7909f2b2007-12-18 15:47:25 +0800291#define OCFS2_IOC_GROUP_ADD _IOW('o', 2,struct ocfs2_new_group_input)
292#define OCFS2_IOC_GROUP_ADD64 _IOW('o', 3,struct ocfs2_new_group_input)
Tao Mad6590722007-12-18 15:47:03 +0800293
Mark Fashehb2580102007-03-09 16:53:21 -0800294/*
Mark Fashehccd979b2005-12-15 14:31:24 -0800295 * Journal Flags (ocfs2_dinode.id1.journal1.i_flags)
296 */
297#define OCFS2_JOURNAL_DIRTY_FL (0x00000001) /* Journal needs recovery */
298
299/*
300 * superblock s_state flags
301 */
302#define OCFS2_ERROR_FS (0x00000001) /* FS saw errors */
303
304/* Limit of space in ocfs2_dir_entry */
305#define OCFS2_MAX_FILENAME_LEN 255
306
307/* Maximum slots on an ocfs2 file system */
308#define OCFS2_MAX_SLOTS 255
309
310/* Slot map indicator for an empty slot */
311#define OCFS2_INVALID_SLOT -1
312
313#define OCFS2_VOL_UUID_LEN 16
314#define OCFS2_MAX_VOL_LABEL_LEN 64
315
Joel Beckerb61817e2008-02-01 15:08:23 -0800316/* The alternate, userspace stack fields */
317#define OCFS2_STACK_LABEL_LEN 4
318#define OCFS2_CLUSTER_NAME_LEN 16
319
Mark Fashehccd979b2005-12-15 14:31:24 -0800320/* Journal limits (in bytes) */
321#define OCFS2_MIN_JOURNAL_SIZE (4 * 1024 * 1024)
Mark Fashehccd979b2005-12-15 14:31:24 -0800322
Sunil Mushran2fbe8d12007-12-20 14:58:11 -0800323/*
324 * Default local alloc size (in megabytes)
325 *
326 * The value chosen should be such that most allocations, including new
327 * block groups, use local alloc.
328 */
329#define OCFS2_DEFAULT_LOCAL_ALLOC_SIZE 8
330
Tiger Yangfdd77702008-08-18 17:08:55 +0800331/*
332 * Inline extended attribute size (in bytes)
333 * The value chosen should be aligned to 16 byte boundaries.
334 */
335#define OCFS2_MIN_XATTR_INLINE_SIZE 256
336
Mark Fashehccd979b2005-12-15 14:31:24 -0800337struct ocfs2_system_inode_info {
338 char *si_name;
339 int si_iflags;
340 int si_mode;
341};
342
343/* System file index */
344enum {
345 BAD_BLOCK_SYSTEM_INODE = 0,
346 GLOBAL_INODE_ALLOC_SYSTEM_INODE,
347 SLOT_MAP_SYSTEM_INODE,
348#define OCFS2_FIRST_ONLINE_SYSTEM_INODE SLOT_MAP_SYSTEM_INODE
349 HEARTBEAT_SYSTEM_INODE,
350 GLOBAL_BITMAP_SYSTEM_INODE,
Jan Kara1a224ad2008-08-20 15:43:36 +0200351 USER_QUOTA_SYSTEM_INODE,
352 GROUP_QUOTA_SYSTEM_INODE,
353#define OCFS2_LAST_GLOBAL_SYSTEM_INODE GROUP_QUOTA_SYSTEM_INODE
Mark Fashehccd979b2005-12-15 14:31:24 -0800354 ORPHAN_DIR_SYSTEM_INODE,
355 EXTENT_ALLOC_SYSTEM_INODE,
356 INODE_ALLOC_SYSTEM_INODE,
357 JOURNAL_SYSTEM_INODE,
358 LOCAL_ALLOC_SYSTEM_INODE,
359 TRUNCATE_LOG_SYSTEM_INODE,
Jan Kara1a224ad2008-08-20 15:43:36 +0200360 LOCAL_USER_QUOTA_SYSTEM_INODE,
361 LOCAL_GROUP_QUOTA_SYSTEM_INODE,
Mark Fashehccd979b2005-12-15 14:31:24 -0800362 NUM_SYSTEM_INODES
363};
364
365static struct ocfs2_system_inode_info ocfs2_system_inodes[NUM_SYSTEM_INODES] = {
366 /* Global system inodes (single copy) */
367 /* The first two are only used from userspace mfks/tunefs */
368 [BAD_BLOCK_SYSTEM_INODE] = { "bad_blocks", 0, S_IFREG | 0644 },
369 [GLOBAL_INODE_ALLOC_SYSTEM_INODE] = { "global_inode_alloc", OCFS2_BITMAP_FL | OCFS2_CHAIN_FL, S_IFREG | 0644 },
370
371 /* These are used by the running filesystem */
372 [SLOT_MAP_SYSTEM_INODE] = { "slot_map", 0, S_IFREG | 0644 },
373 [HEARTBEAT_SYSTEM_INODE] = { "heartbeat", OCFS2_HEARTBEAT_FL, S_IFREG | 0644 },
374 [GLOBAL_BITMAP_SYSTEM_INODE] = { "global_bitmap", 0, S_IFREG | 0644 },
Jan Kara1a224ad2008-08-20 15:43:36 +0200375 [USER_QUOTA_SYSTEM_INODE] = { "aquota.user", OCFS2_QUOTA_FL, S_IFREG | 0644 },
376 [GROUP_QUOTA_SYSTEM_INODE] = { "aquota.group", OCFS2_QUOTA_FL, S_IFREG | 0644 },
Mark Fashehccd979b2005-12-15 14:31:24 -0800377
378 /* Slot-specific system inodes (one copy per slot) */
379 [ORPHAN_DIR_SYSTEM_INODE] = { "orphan_dir:%04d", 0, S_IFDIR | 0755 },
380 [EXTENT_ALLOC_SYSTEM_INODE] = { "extent_alloc:%04d", OCFS2_BITMAP_FL | OCFS2_CHAIN_FL, S_IFREG | 0644 },
381 [INODE_ALLOC_SYSTEM_INODE] = { "inode_alloc:%04d", OCFS2_BITMAP_FL | OCFS2_CHAIN_FL, S_IFREG | 0644 },
382 [JOURNAL_SYSTEM_INODE] = { "journal:%04d", OCFS2_JOURNAL_FL, S_IFREG | 0644 },
383 [LOCAL_ALLOC_SYSTEM_INODE] = { "local_alloc:%04d", OCFS2_BITMAP_FL | OCFS2_LOCAL_ALLOC_FL, S_IFREG | 0644 },
Jan Kara1a224ad2008-08-20 15:43:36 +0200384 [TRUNCATE_LOG_SYSTEM_INODE] = { "truncate_log:%04d", OCFS2_DEALLOC_FL, S_IFREG | 0644 },
385 [LOCAL_USER_QUOTA_SYSTEM_INODE] = { "aquota.user:%04d", OCFS2_QUOTA_FL, S_IFREG | 0644 },
386 [LOCAL_GROUP_QUOTA_SYSTEM_INODE] = { "aquota.group:%04d", OCFS2_QUOTA_FL, S_IFREG | 0644 },
Mark Fashehccd979b2005-12-15 14:31:24 -0800387};
388
389/* Parameter passed from mount.ocfs2 to module */
390#define OCFS2_HB_NONE "heartbeat=none"
391#define OCFS2_HB_LOCAL "heartbeat=local"
392
393/*
394 * OCFS2 directory file types. Only the low 3 bits are used. The
395 * other bits are reserved for now.
396 */
397#define OCFS2_FT_UNKNOWN 0
398#define OCFS2_FT_REG_FILE 1
399#define OCFS2_FT_DIR 2
400#define OCFS2_FT_CHRDEV 3
401#define OCFS2_FT_BLKDEV 4
402#define OCFS2_FT_FIFO 5
403#define OCFS2_FT_SOCK 6
404#define OCFS2_FT_SYMLINK 7
405
406#define OCFS2_FT_MAX 8
407
408/*
409 * OCFS2_DIR_PAD defines the directory entries boundaries
410 *
411 * NOTE: It must be a multiple of 4
412 */
413#define OCFS2_DIR_PAD 4
414#define OCFS2_DIR_ROUND (OCFS2_DIR_PAD - 1)
415#define OCFS2_DIR_MEMBER_LEN offsetof(struct ocfs2_dir_entry, name)
416#define OCFS2_DIR_REC_LEN(name_len) (((name_len) + OCFS2_DIR_MEMBER_LEN + \
417 OCFS2_DIR_ROUND) & \
418 ~OCFS2_DIR_ROUND)
Mark Fashehe7c17e42009-01-29 18:17:46 -0800419#define OCFS2_DIR_MIN_REC_LEN OCFS2_DIR_REC_LEN(1)
Mark Fashehccd979b2005-12-15 14:31:24 -0800420
421#define OCFS2_LINK_MAX 32000
Mark Fasheh198a1ca2008-11-20 17:54:57 -0800422#define OCFS2_DX_LINK_MAX ((1U << 31) - 1U)
423#define OCFS2_LINKS_HI_SHIFT 16
Mark Fashehccd979b2005-12-15 14:31:24 -0800424
425#define S_SHIFT 12
426static unsigned char ocfs2_type_by_mode[S_IFMT >> S_SHIFT] = {
427 [S_IFREG >> S_SHIFT] = OCFS2_FT_REG_FILE,
428 [S_IFDIR >> S_SHIFT] = OCFS2_FT_DIR,
429 [S_IFCHR >> S_SHIFT] = OCFS2_FT_CHRDEV,
430 [S_IFBLK >> S_SHIFT] = OCFS2_FT_BLKDEV,
431 [S_IFIFO >> S_SHIFT] = OCFS2_FT_FIFO,
432 [S_IFSOCK >> S_SHIFT] = OCFS2_FT_SOCK,
433 [S_IFLNK >> S_SHIFT] = OCFS2_FT_SYMLINK,
434};
435
436
437/*
438 * Convenience casts
439 */
440#define OCFS2_RAW_SB(dinode) (&((dinode)->id2.i_super))
441
442/*
Joel Beckerab552d52008-10-16 17:50:30 -0700443 * Block checking structure. This is used in metadata to validate the
444 * contents. If OCFS2_FEATURE_INCOMPAT_META_ECC is not set, it is all
445 * zeros.
446 */
447struct ocfs2_block_check {
448/*00*/ __le32 bc_crc32e; /* 802.3 Ethernet II CRC32 */
449 __le16 bc_ecc; /* Single-error-correction parity vector.
450 This is a simple Hamming code dependant
451 on the blocksize. OCFS2's maximum
452 blocksize, 4K, requires 16 parity bits,
453 so we fit in __le16. */
454 __le16 bc_reserved1;
455/*08*/
456};
457
458/*
Mark Fashehccd979b2005-12-15 14:31:24 -0800459 * On disk extent record for OCFS2
460 * It describes a range of clusters on disk.
Mark Fashehe48edee2007-03-07 16:46:57 -0800461 *
462 * Length fields are divided into interior and leaf node versions.
463 * This leaves room for a flags field (OCFS2_EXT_*) in the leaf nodes.
Mark Fashehccd979b2005-12-15 14:31:24 -0800464 */
465struct ocfs2_extent_rec {
466/*00*/ __le32 e_cpos; /* Offset into the file, in clusters */
Mark Fashehe48edee2007-03-07 16:46:57 -0800467 union {
468 __le32 e_int_clusters; /* Clusters covered by all children */
469 struct {
470 __le16 e_leaf_clusters; /* Clusters covered by this
471 extent */
472 __u8 e_reserved1;
473 __u8 e_flags; /* Extent flags */
474 };
475 };
Mark Fashehccd979b2005-12-15 14:31:24 -0800476 __le64 e_blkno; /* Physical disk offset, in blocks */
477/*10*/
478};
479
480struct ocfs2_chain_rec {
481 __le32 c_free; /* Number of free bits in this chain. */
482 __le32 c_total; /* Number of total bits in this chain */
483 __le64 c_blkno; /* Physical disk offset (blocks) of 1st group */
484};
485
486struct ocfs2_truncate_rec {
487 __le32 t_start; /* 1st cluster in this log */
488 __le32 t_clusters; /* Number of total clusters covered */
489};
490
491/*
492 * On disk extent list for OCFS2 (node in the tree). Note that this
493 * is contained inside ocfs2_dinode or ocfs2_extent_block, so the
494 * offsets are relative to ocfs2_dinode.id2.i_list or
495 * ocfs2_extent_block.h_list, respectively.
496 */
497struct ocfs2_extent_list {
498/*00*/ __le16 l_tree_depth; /* Extent tree depth from this
499 point. 0 means data extents
500 hang directly off this
Mark Fashehdcd05382007-01-16 11:32:23 -0800501 header (a leaf)
502 NOTE: The high 8 bits cannot be
503 used - tree_depth is never that big.
504 */
Mark Fashehccd979b2005-12-15 14:31:24 -0800505 __le16 l_count; /* Number of extent records */
506 __le16 l_next_free_rec; /* Next unused extent slot */
507 __le16 l_reserved1;
508 __le64 l_reserved2; /* Pad to
509 sizeof(ocfs2_extent_rec) */
510/*10*/ struct ocfs2_extent_rec l_recs[0]; /* Extent records */
511};
512
513/*
514 * On disk allocation chain list for OCFS2. Note that this is
515 * contained inside ocfs2_dinode, so the offsets are relative to
516 * ocfs2_dinode.id2.i_chain.
517 */
518struct ocfs2_chain_list {
519/*00*/ __le16 cl_cpg; /* Clusters per Block Group */
520 __le16 cl_bpc; /* Bits per cluster */
521 __le16 cl_count; /* Total chains in this list */
522 __le16 cl_next_free_rec; /* Next unused chain slot */
523 __le64 cl_reserved1;
524/*10*/ struct ocfs2_chain_rec cl_recs[0]; /* Chain records */
525};
526
527/*
528 * On disk deallocation log for OCFS2. Note that this is
529 * contained inside ocfs2_dinode, so the offsets are relative to
530 * ocfs2_dinode.id2.i_dealloc.
531 */
532struct ocfs2_truncate_log {
533/*00*/ __le16 tl_count; /* Total records in this log */
534 __le16 tl_used; /* Number of records in use */
535 __le32 tl_reserved1;
536/*08*/ struct ocfs2_truncate_rec tl_recs[0]; /* Truncate records */
537};
538
539/*
540 * On disk extent block (indirect block) for OCFS2
541 */
542struct ocfs2_extent_block
543{
544/*00*/ __u8 h_signature[8]; /* Signature for verification */
Joel Beckerab552d52008-10-16 17:50:30 -0700545 struct ocfs2_block_check h_check; /* Error checking */
Mark Fashehccd979b2005-12-15 14:31:24 -0800546/*10*/ __le16 h_suballoc_slot; /* Slot suballocator this
547 extent_header belongs to */
548 __le16 h_suballoc_bit; /* Bit offset in suballocator
549 block group */
550 __le32 h_fs_generation; /* Must match super block */
551 __le64 h_blkno; /* Offset on disk, in blocks */
552/*20*/ __le64 h_reserved3;
553 __le64 h_next_leaf_blk; /* Offset on disk, in blocks,
554 of next leaf header pointing
555 to data */
556/*30*/ struct ocfs2_extent_list h_list; /* Extent record list */
557/* Actual on-disk size is one block */
558};
559
560/*
Joel Beckerfb86b1f2008-02-01 11:59:05 -0800561 * On disk slot map for OCFS2. This defines the contents of the "slot_map"
Joel Becker386a2ef2008-02-01 12:06:54 -0800562 * system file. A slot is valid if it contains a node number >= 0. The
563 * value -1 (0xFFFF) is OCFS2_INVALID_SLOT. This marks a slot empty.
Joel Beckerfb86b1f2008-02-01 11:59:05 -0800564 */
565struct ocfs2_slot_map {
566/*00*/ __le16 sm_slots[0];
567/*
568 * Actual on-disk size is one block. OCFS2_MAX_SLOTS is 255,
569 * 255 * sizeof(__le16) == 512B, within the 512B block minimum blocksize.
570 */
571};
572
Joel Becker386a2ef2008-02-01 12:06:54 -0800573struct ocfs2_extended_slot {
574/*00*/ __u8 es_valid;
575 __u8 es_reserved1[3];
576 __le32 es_node_num;
577/*10*/
578};
579
580/*
581 * The extended slot map, used when OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP
582 * is set. It separates out the valid marker from the node number, and
583 * has room to grow. Unlike the old slot map, this format is defined by
584 * i_size.
585 */
586struct ocfs2_slot_map_extended {
587/*00*/ struct ocfs2_extended_slot se_slots[0];
588/*
589 * Actual size is i_size of the slot_map system file. It should
590 * match s_max_slots * sizeof(struct ocfs2_extended_slot)
591 */
592};
593
Joel Beckerb61817e2008-02-01 15:08:23 -0800594struct ocfs2_cluster_info {
595/*00*/ __u8 ci_stack[OCFS2_STACK_LABEL_LEN];
596 __le32 ci_reserved;
597/*08*/ __u8 ci_cluster[OCFS2_CLUSTER_NAME_LEN];
598/*18*/
599};
600
Joel Beckerfb86b1f2008-02-01 11:59:05 -0800601/*
Mark Fashehccd979b2005-12-15 14:31:24 -0800602 * On disk superblock for OCFS2
603 * Note that it is contained inside an ocfs2_dinode, so all offsets
604 * are relative to the start of ocfs2_dinode.id2.
605 */
606struct ocfs2_super_block {
607/*00*/ __le16 s_major_rev_level;
608 __le16 s_minor_rev_level;
609 __le16 s_mnt_count;
610 __le16 s_max_mnt_count;
611 __le16 s_state; /* File system state */
612 __le16 s_errors; /* Behaviour when detecting errors */
613 __le32 s_checkinterval; /* Max time between checks */
614/*10*/ __le64 s_lastcheck; /* Time of last check */
615 __le32 s_creator_os; /* OS */
616 __le32 s_feature_compat; /* Compatible feature set */
617/*20*/ __le32 s_feature_incompat; /* Incompatible feature set */
618 __le32 s_feature_ro_compat; /* Readonly-compatible feature set */
619 __le64 s_root_blkno; /* Offset, in blocks, of root directory
620 dinode */
621/*30*/ __le64 s_system_dir_blkno; /* Offset, in blocks, of system
622 directory dinode */
623 __le32 s_blocksize_bits; /* Blocksize for this fs */
624 __le32 s_clustersize_bits; /* Clustersize for this fs */
625/*40*/ __le16 s_max_slots; /* Max number of simultaneous mounts
626 before tunefs required */
Mark Fasheh92e91ce2007-09-20 11:19:20 -0700627 __le16 s_tunefs_flag;
Tiger Yangcf1d6c72008-08-18 17:11:00 +0800628 __le32 s_uuid_hash; /* hash value of uuid */
Mark Fashehccd979b2005-12-15 14:31:24 -0800629 __le64 s_first_cluster_group; /* Block offset of 1st cluster
630 * group header */
631/*50*/ __u8 s_label[OCFS2_MAX_VOL_LABEL_LEN]; /* Label for mounting, etc. */
632/*90*/ __u8 s_uuid[OCFS2_VOL_UUID_LEN]; /* 128-bit uuid */
Joel Beckerb61817e2008-02-01 15:08:23 -0800633/*A0*/ struct ocfs2_cluster_info s_cluster_info; /* Selected userspace
634 stack. Only valid
635 with INCOMPAT flag. */
Tiger Yang8154da32008-08-18 17:11:46 +0800636/*B8*/ __le16 s_xattr_inline_size; /* extended attribute inline size
637 for this fs*/
638 __le16 s_reserved0;
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800639 __le32 s_dx_seed[3]; /* seed[0-2] for dx dir hash.
640 * s_uuid_hash serves as seed[3]. */
641/*C0*/ __le64 s_reserved2[15]; /* Fill out superblock */
Joel Beckerb61817e2008-02-01 15:08:23 -0800642/*140*/
643
644 /*
645 * NOTE: As stated above, all offsets are relative to
646 * ocfs2_dinode.id2, which is at 0xC0 in the inode.
647 * 0xC0 + 0x140 = 0x200 or 512 bytes. A superblock must fit within
648 * our smallest blocksize, which is 512 bytes. To ensure this,
649 * we reserve the space in s_reserved2. Anything past s_reserved2
650 * will not be available on the smallest blocksize.
651 */
Mark Fashehccd979b2005-12-15 14:31:24 -0800652};
653
654/*
655 * Local allocation bitmap for OCFS2 slots
656 * Note that it exists inside an ocfs2_dinode, so all offsets are
657 * relative to the start of ocfs2_dinode.id2.
658 */
659struct ocfs2_local_alloc
660{
661/*00*/ __le32 la_bm_off; /* Starting bit offset in main bitmap */
662 __le16 la_size; /* Size of included bitmap, in bytes */
663 __le16 la_reserved1;
664 __le64 la_reserved2;
665/*10*/ __u8 la_bitmap[0];
666};
667
668/*
Mark Fasheh15b1e362007-09-07 13:58:15 -0700669 * Data-in-inode header. This is only used if i_dyn_features has
670 * OCFS2_INLINE_DATA_FL set.
671 */
672struct ocfs2_inline_data
673{
674/*00*/ __le16 id_count; /* Number of bytes that can be used
675 * for data, starting at id_data */
676 __le16 id_reserved0;
677 __le32 id_reserved1;
678 __u8 id_data[0]; /* Start of user data */
679};
680
681/*
Mark Fashehccd979b2005-12-15 14:31:24 -0800682 * On disk inode for OCFS2
683 */
684struct ocfs2_dinode {
685/*00*/ __u8 i_signature[8]; /* Signature for validation */
686 __le32 i_generation; /* Generation number */
687 __le16 i_suballoc_slot; /* Slot suballocator this inode
688 belongs to */
689 __le16 i_suballoc_bit; /* Bit offset in suballocator
690 block group */
Mark Fasheh198a1ca2008-11-20 17:54:57 -0800691/*10*/ __le16 i_links_count_hi; /* High 16 bits of links count */
Tiger Yangfdd77702008-08-18 17:08:55 +0800692 __le16 i_xattr_inline_size;
Mark Fashehccd979b2005-12-15 14:31:24 -0800693 __le32 i_clusters; /* Cluster count */
694 __le32 i_uid; /* Owner UID */
695 __le32 i_gid; /* Owning GID */
696/*20*/ __le64 i_size; /* Size in bytes */
697 __le16 i_mode; /* File mode */
698 __le16 i_links_count; /* Links count */
699 __le32 i_flags; /* File flags */
700/*30*/ __le64 i_atime; /* Access time */
701 __le64 i_ctime; /* Creation time */
702/*40*/ __le64 i_mtime; /* Modification time */
703 __le64 i_dtime; /* Deletion time */
704/*50*/ __le64 i_blkno; /* Offset on disk, in blocks */
705 __le64 i_last_eb_blk; /* Pointer to last extent
706 block */
707/*60*/ __le32 i_fs_generation; /* Generation per fs-instance */
708 __le32 i_atime_nsec;
709 __le32 i_ctime_nsec;
710 __le32 i_mtime_nsec;
Tiger Yangfdd77702008-08-18 17:08:55 +0800711/*70*/ __le32 i_attr;
Tiger Yang50008632007-03-20 16:01:38 -0700712 __le16 i_orphaned_slot; /* Only valid when OCFS2_ORPHANED_FL
713 was set in i_flags */
Mark Fasheh15b1e362007-09-07 13:58:15 -0700714 __le16 i_dyn_features;
Tiger Yangfdd77702008-08-18 17:08:55 +0800715 __le64 i_xattr_loc;
Joel Beckerab552d52008-10-16 17:50:30 -0700716/*80*/ struct ocfs2_block_check i_check; /* Error checking */
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800717/*88*/ __le64 i_dx_root; /* Pointer to dir index root block */
718 __le64 i_reserved2[5];
Mark Fashehccd979b2005-12-15 14:31:24 -0800719/*B8*/ union {
720 __le64 i_pad1; /* Generic way to refer to this
721 64bit union */
722 struct {
723 __le64 i_rdev; /* Device number */
724 } dev1;
725 struct { /* Info for bitmap system
726 inodes */
727 __le32 i_used; /* Bits (ie, clusters) used */
728 __le32 i_total; /* Total bits (clusters)
729 available */
730 } bitmap1;
731 struct { /* Info for journal system
732 inodes */
733 __le32 ij_flags; /* Mounted, version, etc. */
Sunil Mushranc69991a2008-07-14 17:31:09 -0700734 __le32 ij_recovery_generation; /* Incremented when the
735 journal is recovered
736 after an unclean
737 shutdown */
Mark Fashehccd979b2005-12-15 14:31:24 -0800738 } journal1;
739 } id1; /* Inode type dependant 1 */
740/*C0*/ union {
741 struct ocfs2_super_block i_super;
742 struct ocfs2_local_alloc i_lab;
743 struct ocfs2_chain_list i_chain;
744 struct ocfs2_extent_list i_list;
745 struct ocfs2_truncate_log i_dealloc;
Mark Fasheh15b1e362007-09-07 13:58:15 -0700746 struct ocfs2_inline_data i_data;
Mark Fashehccd979b2005-12-15 14:31:24 -0800747 __u8 i_symlink[0];
748 } id2;
749/* Actual on-disk size is one block */
750};
751
752/*
753 * On-disk directory entry structure for OCFS2
754 *
755 * Packed as this structure could be accessed unaligned on 64-bit platforms
756 */
757struct ocfs2_dir_entry {
758/*00*/ __le64 inode; /* Inode number */
759 __le16 rec_len; /* Directory entry length */
760 __u8 name_len; /* Name length */
761 __u8 file_type;
762/*0C*/ char name[OCFS2_MAX_FILENAME_LEN]; /* File name */
763/* Actual on-disk length specified by rec_len */
764} __attribute__ ((packed));
765
766/*
Mark Fasheh87d35a72008-12-10 17:36:25 -0800767 * Per-block record for the unindexed directory btree. This is carefully
768 * crafted so that the rec_len and name_len records of an ocfs2_dir_entry are
769 * mirrored. That way, the directory manipulation code needs a minimal amount
770 * of update.
771 *
772 * NOTE: Keep this structure aligned to a multiple of 4 bytes.
773 */
774struct ocfs2_dir_block_trailer {
775/*00*/ __le64 db_compat_inode; /* Always zero. Was inode */
776
777 __le16 db_compat_rec_len; /* Backwards compatible with
778 * ocfs2_dir_entry. */
779 __u8 db_compat_name_len; /* Always zero. Was name_len */
780 __u8 db_reserved0;
781 __le16 db_reserved1;
782 __le16 db_free_rec_len; /* Size of largest empty hole
783 * in this block. (unused) */
784/*10*/ __u8 db_signature[8]; /* Signature for verification */
785 __le64 db_reserved2;
786 __le64 db_free_next; /* Next block in list (unused) */
787/*20*/ __le64 db_blkno; /* Offset on disk, in blocks */
788 __le64 db_parent_dinode; /* dinode which owns me, in
789 blocks */
Joel Beckerc175a512008-12-10 17:58:22 -0800790/*30*/ struct ocfs2_block_check db_check; /* Error checking */
Mark Fasheh87d35a72008-12-10 17:36:25 -0800791/*40*/
792};
793
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800794 /*
795 * A directory entry in the indexed tree. We don't store the full name here,
796 * but instead provide a pointer to the full dirent in the unindexed tree.
797 *
798 * We also store name_len here so as to reduce the number of leaf blocks we
799 * need to search in case of collisions.
800 */
801struct ocfs2_dx_entry {
802 __le32 dx_major_hash; /* Used to find logical
803 * cluster in index */
804 __le32 dx_minor_hash; /* Lower bits used to find
805 * block in cluster */
806 __le64 dx_dirent_blk; /* Physical block in unindexed
807 * tree holding this dirent. */
808};
809
810struct ocfs2_dx_entry_list {
811 __le32 de_reserved;
812 __le16 de_count; /* Maximum number of entries
813 * possible in de_entries */
814 __le16 de_num_used; /* Current number of
815 * de_entries entries */
816 struct ocfs2_dx_entry de_entries[0]; /* Indexed dir entries
817 * in a packed array of
818 * length de_num_used */
819};
820
Mark Fasheh4ed8a6b2008-11-24 17:02:08 -0800821#define OCFS2_DX_FLAG_INLINE 0x01
822
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800823/*
824 * A directory indexing block. Each indexed directory has one of these,
825 * pointed to by ocfs2_dinode.
826 *
827 * This block stores an indexed btree root, and a set of free space
828 * start-of-list pointers.
829 */
830struct ocfs2_dx_root_block {
831 __u8 dr_signature[8]; /* Signature for verification */
832 struct ocfs2_block_check dr_check; /* Error checking */
833 __le16 dr_suballoc_slot; /* Slot suballocator this
834 * block belongs to. */
835 __le16 dr_suballoc_bit; /* Bit offset in suballocator
836 * block group */
837 __le32 dr_fs_generation; /* Must match super block */
838 __le64 dr_blkno; /* Offset on disk, in blocks */
839 __le64 dr_last_eb_blk; /* Pointer to last
840 * extent block */
841 __le32 dr_clusters; /* Clusters allocated
842 * to the indexed tree. */
Mark Fasheh4ed8a6b2008-11-24 17:02:08 -0800843 __u8 dr_flags; /* OCFS2_DX_FLAG_* flags */
844 __u8 dr_reserved0;
845 __le16 dr_reserved1;
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800846 __le64 dr_dir_blkno; /* Pointer to parent inode */
847 __le64 dr_reserved2;
Mark Fashehe7c17e42009-01-29 18:17:46 -0800848 __le64 dr_free_blk; /* Pointer to head of free
849 * unindexed block list. */
850 __le64 dr_reserved3[15];
Mark Fasheh4ed8a6b2008-11-24 17:02:08 -0800851 union {
852 struct ocfs2_extent_list dr_list; /* Keep this aligned to 128
853 * bits for maximum space
854 * efficiency. */
855 struct ocfs2_dx_entry_list dr_entries; /* In-root-block list of
856 * entries. We grow out
857 * to extents if this
858 * gets too big. */
859 };
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800860};
861
862/*
863 * The header of a leaf block in the indexed tree.
864 */
865struct ocfs2_dx_leaf {
866 __u8 dl_signature[8];/* Signature for verification */
867 struct ocfs2_block_check dl_check; /* Error checking */
868 __le64 dl_blkno; /* Offset on disk, in blocks */
869 __le32 dl_fs_generation;/* Must match super block */
870 __le32 dl_reserved0;
871 __le64 dl_reserved1;
872 struct ocfs2_dx_entry_list dl_list;
873};
874
Mark Fasheh87d35a72008-12-10 17:36:25 -0800875/*
Mark Fashehccd979b2005-12-15 14:31:24 -0800876 * On disk allocator group structure for OCFS2
877 */
878struct ocfs2_group_desc
879{
880/*00*/ __u8 bg_signature[8]; /* Signature for validation */
881 __le16 bg_size; /* Size of included bitmap in
882 bytes. */
883 __le16 bg_bits; /* Bits represented by this
884 group. */
885 __le16 bg_free_bits_count; /* Free bits count */
886 __le16 bg_chain; /* What chain I am in. */
887/*10*/ __le32 bg_generation;
888 __le32 bg_reserved1;
889 __le64 bg_next_group; /* Next group in my list, in
890 blocks */
891/*20*/ __le64 bg_parent_dinode; /* dinode which owns me, in
892 blocks */
893 __le64 bg_blkno; /* Offset on disk, in blocks */
Joel Beckerab552d52008-10-16 17:50:30 -0700894/*30*/ struct ocfs2_block_check bg_check; /* Error checking */
895 __le64 bg_reserved2;
Mark Fashehccd979b2005-12-15 14:31:24 -0800896/*40*/ __u8 bg_bitmap[0];
897};
898
Tao Ma5a7bc8e2008-08-18 17:38:46 +0800899/*
900 * On disk extended attribute structure for OCFS2.
901 */
902
903/*
904 * ocfs2_xattr_entry indicates one extend attribute.
905 *
906 * Note that it can be stored in inode, one block or one xattr bucket.
907 */
908struct ocfs2_xattr_entry {
909 __le32 xe_name_hash; /* hash value of xattr prefix+suffix. */
Tao Ma8573f792008-10-24 22:24:17 +0800910 __le16 xe_name_offset; /* byte offset from the 1st entry in the
Tao Ma5a7bc8e2008-08-18 17:38:46 +0800911 local xattr storage(inode, xattr block or
912 xattr bucket). */
913 __u8 xe_name_len; /* xattr name len, does't include prefix. */
Tao Ma8573f792008-10-24 22:24:17 +0800914 __u8 xe_type; /* the low 7 bits indicate the name prefix
915 * type and the highest bit indicates whether
Tao Ma5a7bc8e2008-08-18 17:38:46 +0800916 * the EA is stored in the local storage. */
917 __le64 xe_value_size; /* real xattr value length. */
918};
919
920/*
921 * On disk structure for xattr header.
922 *
923 * One ocfs2_xattr_header describes how many ocfs2_xattr_entry records in
924 * the local xattr storage.
925 */
926struct ocfs2_xattr_header {
927 __le16 xh_count; /* contains the count of how
928 many records are in the
929 local xattr storage. */
Tao Ma0c044f02008-08-18 17:38:50 +0800930 __le16 xh_free_start; /* current offset for storing
931 xattr. */
932 __le16 xh_name_value_len; /* total length of name/value
933 length in this bucket. */
Tao Ma8573f792008-10-24 22:24:17 +0800934 __le16 xh_num_buckets; /* Number of xattr buckets
935 in this extent record,
936 only valid in the first
937 bucket. */
Joel Beckerab552d52008-10-16 17:50:30 -0700938 struct ocfs2_block_check xh_check; /* Error checking
939 (Note, this is only
940 used for xattr
941 buckets. A block uses
942 xb_check and sets
943 this field to zero.) */
Tao Ma5a7bc8e2008-08-18 17:38:46 +0800944 struct ocfs2_xattr_entry xh_entries[0]; /* xattr entry list. */
945};
946
947/*
948 * On disk structure for xattr value root.
949 *
Tao Ma8573f792008-10-24 22:24:17 +0800950 * When an xattr's value is large enough, it is stored in an external
951 * b-tree like file data. The xattr value root points to this structure.
Tao Ma5a7bc8e2008-08-18 17:38:46 +0800952 */
953struct ocfs2_xattr_value_root {
954/*00*/ __le32 xr_clusters; /* clusters covered by xattr value. */
955 __le32 xr_reserved0;
956 __le64 xr_last_eb_blk; /* Pointer to last extent block */
957/*10*/ struct ocfs2_extent_list xr_list; /* Extent record list */
958};
959
960/*
961 * On disk structure for xattr tree root.
962 *
963 * It is used when there are too many extended attributes for one file. These
964 * attributes will be organized and stored in an indexed-btree.
965 */
966struct ocfs2_xattr_tree_root {
967/*00*/ __le32 xt_clusters; /* clusters covered by xattr. */
968 __le32 xt_reserved0;
969 __le64 xt_last_eb_blk; /* Pointer to last extent block */
970/*10*/ struct ocfs2_extent_list xt_list; /* Extent record list */
971};
972
Tiger Yangcf1d6c72008-08-18 17:11:00 +0800973#define OCFS2_XATTR_INDEXED 0x1
974#define OCFS2_HASH_SHIFT 5
975#define OCFS2_XATTR_ROUND 3
976#define OCFS2_XATTR_SIZE(size) (((size) + OCFS2_XATTR_ROUND) & \
977 ~(OCFS2_XATTR_ROUND))
Tao Ma5a7bc8e2008-08-18 17:38:46 +0800978
Tao Ma0c044f02008-08-18 17:38:50 +0800979#define OCFS2_XATTR_BUCKET_SIZE 4096
980#define OCFS2_XATTR_MAX_BLOCKS_PER_BUCKET (OCFS2_XATTR_BUCKET_SIZE \
981 / OCFS2_MIN_BLOCKSIZE)
982
Tao Ma5a7bc8e2008-08-18 17:38:46 +0800983/*
984 * On disk structure for xattr block.
985 */
986struct ocfs2_xattr_block {
987/*00*/ __u8 xb_signature[8]; /* Signature for verification */
988 __le16 xb_suballoc_slot; /* Slot suballocator this
989 block belongs to. */
990 __le16 xb_suballoc_bit; /* Bit offset in suballocator
991 block group */
992 __le32 xb_fs_generation; /* Must match super block */
993/*10*/ __le64 xb_blkno; /* Offset on disk, in blocks */
Joel Beckerab552d52008-10-16 17:50:30 -0700994 struct ocfs2_block_check xb_check; /* Error checking */
Tao Ma5a7bc8e2008-08-18 17:38:46 +0800995/*20*/ __le16 xb_flags; /* Indicates whether this block contains
996 real xattr or a xattr tree. */
997 __le16 xb_reserved0;
998 __le32 xb_reserved1;
999 __le64 xb_reserved2;
1000/*30*/ union {
1001 struct ocfs2_xattr_header xb_header; /* xattr header if this
1002 block contains xattr */
1003 struct ocfs2_xattr_tree_root xb_root;/* xattr tree root if this
1004 block cotains xattr
1005 tree. */
1006 } xb_attrs;
1007};
1008
1009#define OCFS2_XATTR_ENTRY_LOCAL 0x80
1010#define OCFS2_XATTR_TYPE_MASK 0x7F
1011static inline void ocfs2_xattr_set_local(struct ocfs2_xattr_entry *xe,
1012 int local)
1013{
1014 if (local)
1015 xe->xe_type |= OCFS2_XATTR_ENTRY_LOCAL;
1016 else
1017 xe->xe_type &= ~OCFS2_XATTR_ENTRY_LOCAL;
1018}
1019
1020static inline int ocfs2_xattr_is_local(struct ocfs2_xattr_entry *xe)
1021{
1022 return xe->xe_type & OCFS2_XATTR_ENTRY_LOCAL;
1023}
1024
1025static inline void ocfs2_xattr_set_type(struct ocfs2_xattr_entry *xe, int type)
1026{
1027 xe->xe_type |= type & OCFS2_XATTR_TYPE_MASK;
1028}
1029
1030static inline int ocfs2_xattr_get_type(struct ocfs2_xattr_entry *xe)
1031{
1032 return xe->xe_type & OCFS2_XATTR_TYPE_MASK;
1033}
1034
Jan Kara9e33d692008-08-25 19:56:50 +02001035/*
1036 * On disk structures for global quota file
1037 */
1038
1039/* Magic numbers and known versions for global quota files */
1040#define OCFS2_GLOBAL_QMAGICS {\
1041 0x0cf52470, /* USRQUOTA */ \
1042 0x0cf52471 /* GRPQUOTA */ \
1043}
1044
1045#define OCFS2_GLOBAL_QVERSIONS {\
1046 0, \
1047 0, \
1048}
1049
1050
1051/* Each block of each quota file has a certain fixed number of bytes reserved
1052 * for OCFS2 internal use at its end. OCFS2 can use it for things like
1053 * checksums, etc. */
1054#define OCFS2_QBLK_RESERVED_SPACE 8
1055
1056/* Generic header of all quota files */
1057struct ocfs2_disk_dqheader {
1058 __le32 dqh_magic; /* Magic number identifying file */
1059 __le32 dqh_version; /* Quota format version */
1060};
1061
1062#define OCFS2_GLOBAL_INFO_OFF (sizeof(struct ocfs2_disk_dqheader))
1063
1064/* Information header of global quota file (immediately follows the generic
1065 * header) */
1066struct ocfs2_global_disk_dqinfo {
1067/*00*/ __le32 dqi_bgrace; /* Grace time for space softlimit excess */
1068 __le32 dqi_igrace; /* Grace time for inode softlimit excess */
1069 __le32 dqi_syncms; /* Time after which we sync local changes to
1070 * global quota file */
1071 __le32 dqi_blocks; /* Number of blocks in quota file */
1072/*10*/ __le32 dqi_free_blk; /* First free block in quota file */
1073 __le32 dqi_free_entry; /* First block with free dquot entry in quota
1074 * file */
1075};
1076
1077/* Structure with global user / group information. We reserve some space
1078 * for future use. */
1079struct ocfs2_global_disk_dqblk {
1080/*00*/ __le32 dqb_id; /* ID the structure belongs to */
1081 __le32 dqb_use_count; /* Number of nodes having reference to this structure */
1082 __le64 dqb_ihardlimit; /* absolute limit on allocated inodes */
1083/*10*/ __le64 dqb_isoftlimit; /* preferred inode limit */
1084 __le64 dqb_curinodes; /* current # allocated inodes */
1085/*20*/ __le64 dqb_bhardlimit; /* absolute limit on disk space */
1086 __le64 dqb_bsoftlimit; /* preferred limit on disk space */
1087/*30*/ __le64 dqb_curspace; /* current space occupied */
1088 __le64 dqb_btime; /* time limit for excessive disk use */
1089/*40*/ __le64 dqb_itime; /* time limit for excessive inode use */
1090 __le64 dqb_pad1;
1091/*50*/ __le64 dqb_pad2;
1092};
1093
1094/*
1095 * On-disk structures for local quota file
1096 */
1097
1098/* Magic numbers and known versions for local quota files */
1099#define OCFS2_LOCAL_QMAGICS {\
1100 0x0cf524c0, /* USRQUOTA */ \
1101 0x0cf524c1 /* GRPQUOTA */ \
1102}
1103
1104#define OCFS2_LOCAL_QVERSIONS {\
1105 0, \
1106 0, \
1107}
1108
1109/* Quota flags in dqinfo header */
1110#define OLQF_CLEAN 0x0001 /* Quota file is empty (this should be after\
1111 * quota has been cleanly turned off) */
1112
1113#define OCFS2_LOCAL_INFO_OFF (sizeof(struct ocfs2_disk_dqheader))
1114
1115/* Information header of local quota file (immediately follows the generic
1116 * header) */
1117struct ocfs2_local_disk_dqinfo {
1118 __le32 dqi_flags; /* Flags for quota file */
1119 __le32 dqi_chunks; /* Number of chunks of quota structures
1120 * with a bitmap */
1121 __le32 dqi_blocks; /* Number of blocks allocated for quota file */
1122};
1123
1124/* Header of one chunk of a quota file */
1125struct ocfs2_local_disk_chunk {
1126 __le32 dqc_free; /* Number of free entries in the bitmap */
1127 u8 dqc_bitmap[0]; /* Bitmap of entries in the corresponding
1128 * chunk of quota file */
1129};
1130
1131/* One entry in local quota file */
1132struct ocfs2_local_disk_dqblk {
1133/*00*/ __le64 dqb_id; /* id this quota applies to */
1134 __le64 dqb_spacemod; /* Change in the amount of used space */
1135/*10*/ __le64 dqb_inodemod; /* Change in the amount of used inodes */
1136};
1137
Joel Beckerab552d52008-10-16 17:50:30 -07001138
1139/*
1140 * The quota trailer lives at the end of each quota block.
1141 */
1142
1143struct ocfs2_disk_dqtrailer {
1144/*00*/ struct ocfs2_block_check dq_check; /* Error checking */
1145/*08*/ /* Cannot be larger than OCFS2_QBLK_RESERVED_SPACE */
1146};
1147
1148static inline struct ocfs2_disk_dqtrailer *ocfs2_block_dqtrailer(int blocksize,
1149 void *buf)
1150{
1151 char *ptr = buf;
1152 ptr += blocksize - OCFS2_QBLK_RESERVED_SPACE;
1153
1154 return (struct ocfs2_disk_dqtrailer *)ptr;
1155}
1156
Mark Fashehccd979b2005-12-15 14:31:24 -08001157#ifdef __KERNEL__
1158static inline int ocfs2_fast_symlink_chars(struct super_block *sb)
1159{
1160 return sb->s_blocksize -
1161 offsetof(struct ocfs2_dinode, id2.i_symlink);
1162}
1163
Tiger Yangfdd77702008-08-18 17:08:55 +08001164static inline int ocfs2_max_inline_data_with_xattr(struct super_block *sb,
1165 struct ocfs2_dinode *di)
1166{
1167 unsigned int xattrsize = le16_to_cpu(di->i_xattr_inline_size);
1168
1169 if (le16_to_cpu(di->i_dyn_features) & OCFS2_INLINE_XATTR_FL)
1170 return sb->s_blocksize -
1171 offsetof(struct ocfs2_dinode, id2.i_data.id_data) -
1172 xattrsize;
1173 else
1174 return sb->s_blocksize -
1175 offsetof(struct ocfs2_dinode, id2.i_data.id_data);
1176}
1177
Mark Fashehccd979b2005-12-15 14:31:24 -08001178static inline int ocfs2_extent_recs_per_inode(struct super_block *sb)
1179{
1180 int size;
1181
1182 size = sb->s_blocksize -
1183 offsetof(struct ocfs2_dinode, id2.i_list.l_recs);
1184
1185 return size / sizeof(struct ocfs2_extent_rec);
1186}
1187
Tiger Yangfdd77702008-08-18 17:08:55 +08001188static inline int ocfs2_extent_recs_per_inode_with_xattr(
1189 struct super_block *sb,
1190 struct ocfs2_dinode *di)
1191{
1192 int size;
1193 unsigned int xattrsize = le16_to_cpu(di->i_xattr_inline_size);
1194
1195 if (le16_to_cpu(di->i_dyn_features) & OCFS2_INLINE_XATTR_FL)
1196 size = sb->s_blocksize -
1197 offsetof(struct ocfs2_dinode, id2.i_list.l_recs) -
1198 xattrsize;
1199 else
1200 size = sb->s_blocksize -
1201 offsetof(struct ocfs2_dinode, id2.i_list.l_recs);
1202
1203 return size / sizeof(struct ocfs2_extent_rec);
1204}
1205
Mark Fasheh9b7895e2008-11-12 16:27:44 -08001206static inline int ocfs2_extent_recs_per_dx_root(struct super_block *sb)
1207{
1208 int size;
1209
1210 size = sb->s_blocksize -
1211 offsetof(struct ocfs2_dx_root_block, dr_list.l_recs);
1212
1213 return size / sizeof(struct ocfs2_extent_rec);
1214}
1215
Mark Fashehccd979b2005-12-15 14:31:24 -08001216static inline int ocfs2_chain_recs_per_inode(struct super_block *sb)
1217{
1218 int size;
1219
1220 size = sb->s_blocksize -
1221 offsetof(struct ocfs2_dinode, id2.i_chain.cl_recs);
1222
1223 return size / sizeof(struct ocfs2_chain_rec);
1224}
1225
1226static inline u16 ocfs2_extent_recs_per_eb(struct super_block *sb)
1227{
1228 int size;
1229
1230 size = sb->s_blocksize -
1231 offsetof(struct ocfs2_extent_block, h_list.l_recs);
1232
1233 return size / sizeof(struct ocfs2_extent_rec);
1234}
1235
Mark Fasheh9b7895e2008-11-12 16:27:44 -08001236static inline int ocfs2_dx_entries_per_leaf(struct super_block *sb)
1237{
1238 int size;
1239
1240 size = sb->s_blocksize -
1241 offsetof(struct ocfs2_dx_leaf, dl_list.de_entries);
1242
1243 return size / sizeof(struct ocfs2_dx_entry);
1244}
1245
Mark Fasheh4ed8a6b2008-11-24 17:02:08 -08001246static inline int ocfs2_dx_entries_per_root(struct super_block *sb)
1247{
1248 int size;
1249
1250 size = sb->s_blocksize -
1251 offsetof(struct ocfs2_dx_root_block, dr_entries.de_entries);
1252
1253 return size / sizeof(struct ocfs2_dx_entry);
1254}
1255
Mark Fashehccd979b2005-12-15 14:31:24 -08001256static inline u16 ocfs2_local_alloc_size(struct super_block *sb)
1257{
1258 u16 size;
1259
1260 size = sb->s_blocksize -
1261 offsetof(struct ocfs2_dinode, id2.i_lab.la_bitmap);
1262
1263 return size;
1264}
1265
1266static inline int ocfs2_group_bitmap_size(struct super_block *sb)
1267{
1268 int size;
1269
1270 size = sb->s_blocksize -
1271 offsetof(struct ocfs2_group_desc, bg_bitmap);
1272
1273 return size;
1274}
1275
1276static inline int ocfs2_truncate_recs_per_inode(struct super_block *sb)
1277{
1278 int size;
1279
1280 size = sb->s_blocksize -
1281 offsetof(struct ocfs2_dinode, id2.i_dealloc.tl_recs);
1282
1283 return size / sizeof(struct ocfs2_truncate_rec);
1284}
Mark Fasheh50af94b2007-01-21 14:44:59 -08001285
1286static inline u64 ocfs2_backup_super_blkno(struct super_block *sb, int index)
1287{
1288 u64 offset = OCFS2_BACKUP_SB_START;
1289
1290 if (index >= 0 && index < OCFS2_MAX_BACKUP_SUPERBLOCKS) {
1291 offset <<= (2 * index);
Mark Fasheha8a75a22007-01-26 10:46:59 -08001292 offset >>= sb->s_blocksize_bits;
Mark Fasheh50af94b2007-01-21 14:44:59 -08001293 return offset;
1294 }
1295
1296 return 0;
1297
1298}
Tao Ma0c044f02008-08-18 17:38:50 +08001299
1300static inline u16 ocfs2_xattr_recs_per_xb(struct super_block *sb)
1301{
1302 int size;
1303
1304 size = sb->s_blocksize -
1305 offsetof(struct ocfs2_xattr_block,
1306 xb_attrs.xb_root.xt_list.l_recs);
1307
1308 return size / sizeof(struct ocfs2_extent_rec);
1309}
Mark Fashehccd979b2005-12-15 14:31:24 -08001310#else
1311static inline int ocfs2_fast_symlink_chars(int blocksize)
1312{
1313 return blocksize - offsetof(struct ocfs2_dinode, id2.i_symlink);
1314}
1315
Mark Fasheh15b1e362007-09-07 13:58:15 -07001316static inline int ocfs2_max_inline_data(int blocksize)
1317{
1318 return blocksize - offsetof(struct ocfs2_dinode, id2.i_data.id_data);
1319}
1320
Mark Fashehccd979b2005-12-15 14:31:24 -08001321static inline int ocfs2_extent_recs_per_inode(int blocksize)
1322{
1323 int size;
1324
1325 size = blocksize -
1326 offsetof(struct ocfs2_dinode, id2.i_list.l_recs);
1327
1328 return size / sizeof(struct ocfs2_extent_rec);
1329}
1330
1331static inline int ocfs2_chain_recs_per_inode(int blocksize)
1332{
1333 int size;
1334
1335 size = blocksize -
1336 offsetof(struct ocfs2_dinode, id2.i_chain.cl_recs);
1337
1338 return size / sizeof(struct ocfs2_chain_rec);
1339}
1340
1341static inline int ocfs2_extent_recs_per_eb(int blocksize)
1342{
1343 int size;
1344
1345 size = blocksize -
1346 offsetof(struct ocfs2_extent_block, h_list.l_recs);
1347
1348 return size / sizeof(struct ocfs2_extent_rec);
1349}
1350
1351static inline int ocfs2_local_alloc_size(int blocksize)
1352{
1353 int size;
1354
1355 size = blocksize -
1356 offsetof(struct ocfs2_dinode, id2.i_lab.la_bitmap);
1357
1358 return size;
1359}
1360
1361static inline int ocfs2_group_bitmap_size(int blocksize)
1362{
1363 int size;
1364
1365 size = blocksize -
1366 offsetof(struct ocfs2_group_desc, bg_bitmap);
1367
1368 return size;
1369}
1370
1371static inline int ocfs2_truncate_recs_per_inode(int blocksize)
1372{
1373 int size;
1374
1375 size = blocksize -
1376 offsetof(struct ocfs2_dinode, id2.i_dealloc.tl_recs);
1377
1378 return size / sizeof(struct ocfs2_truncate_rec);
1379}
Mark Fasheh50af94b2007-01-21 14:44:59 -08001380
1381static inline uint64_t ocfs2_backup_super_blkno(int blocksize, int index)
1382{
1383 uint64_t offset = OCFS2_BACKUP_SB_START;
1384
1385 if (index >= 0 && index < OCFS2_MAX_BACKUP_SUPERBLOCKS) {
1386 offset <<= (2 * index);
1387 offset /= blocksize;
1388 return offset;
1389 }
1390
1391 return 0;
1392}
Tao Ma0c044f02008-08-18 17:38:50 +08001393
1394static inline int ocfs2_xattr_recs_per_xb(int blocksize)
1395{
1396 int size;
1397
1398 size = blocksize -
1399 offsetof(struct ocfs2_xattr_block,
1400 xb_attrs.xb_root.xt_list.l_recs);
1401
1402 return size / sizeof(struct ocfs2_extent_rec);
1403}
Mark Fashehccd979b2005-12-15 14:31:24 -08001404#endif /* __KERNEL__ */
1405
1406
1407static inline int ocfs2_system_inode_is_global(int type)
1408{
1409 return ((type >= 0) &&
1410 (type <= OCFS2_LAST_GLOBAL_SYSTEM_INODE));
1411}
1412
1413static inline int ocfs2_sprintf_system_inode_name(char *buf, int len,
1414 int type, int slot)
1415{
1416 int chars;
1417
1418 /*
1419 * Global system inodes can only have one copy. Everything
1420 * after OCFS2_LAST_GLOBAL_SYSTEM_INODE in the system inode
1421 * list has a copy per slot.
1422 */
1423 if (type <= OCFS2_LAST_GLOBAL_SYSTEM_INODE)
Joel Beckerfe9f3872008-06-12 22:39:18 -07001424 chars = snprintf(buf, len, "%s",
Mark Fashehccd979b2005-12-15 14:31:24 -08001425 ocfs2_system_inodes[type].si_name);
1426 else
1427 chars = snprintf(buf, len,
1428 ocfs2_system_inodes[type].si_name,
1429 slot);
1430
1431 return chars;
1432}
1433
1434static inline void ocfs2_set_de_type(struct ocfs2_dir_entry *de,
1435 umode_t mode)
1436{
1437 de->file_type = ocfs2_type_by_mode[(mode & S_IFMT)>>S_SHIFT];
1438}
1439
1440#endif /* _OCFS2_FS_H */
1441