]> bbs.cooldavid.org Git - net-next-2.6.git/blame - fs/ocfs2/ocfs2_fs.h
ocfs2: Store dir index records inline
[net-next-2.6.git] / fs / ocfs2 / ocfs2_fs.h
CommitLineData
ccd979bd
MF
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"
5a7bc8eb 67#define OCFS2_XATTR_BLOCK_SIGNATURE "XATTR01"
87d35a74 68#define OCFS2_DIR_TRAILER_SIGNATURE "DIRTRL1"
9b7895ef
MF
69#define OCFS2_DX_ROOT_SIGNATURE "DXDIR01"
70#define OCFS2_DX_LEAF_SIGNATURE "DXLEAF1"
ccd979bd
MF
71
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
a9772189
JB
92#define OCFS2_FEATURE_COMPAT_SUPP (OCFS2_FEATURE_COMPAT_BACKUP_SB \
93 | OCFS2_FEATURE_COMPAT_JBD2_SB)
dcd0538f 94#define OCFS2_FEATURE_INCOMPAT_SUPP (OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT \
15b1e36b 95 | OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC \
386a2ef8 96 | OCFS2_FEATURE_INCOMPAT_INLINE_DATA \
b61817e1 97 | OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP \
8154da3d 98 | OCFS2_FEATURE_INCOMPAT_USERSPACE_STACK \
9d28cfb7
JB
99 | OCFS2_FEATURE_INCOMPAT_XATTR \
100 | OCFS2_FEATURE_INCOMPAT_META_ECC)
19ece546
JK
101#define OCFS2_FEATURE_RO_COMPAT_SUPP (OCFS2_FEATURE_RO_COMPAT_UNWRITTEN \
102 | OCFS2_FEATURE_RO_COMPAT_USRQUOTA \
103 | OCFS2_FEATURE_RO_COMPAT_GRPQUOTA)
ccd979bd
MF
104
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
8903901d
MF
112/*
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
ccd979bd 118
c271c5c2
SM
119/* Used to denote a non-clustered volume */
120#define OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT 0x0008
121
8903901d
MF
122/* Support for sparse allocation in b-trees */
123#define OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC 0x0010
124
92e91ce2
MF
125/*
126 * 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
15b1e36b
MF
136/* Support for data packed into inode blocks */
137#define OCFS2_FEATURE_INCOMPAT_INLINE_DATA 0x0040
138
b61817e1
JB
139/*
140 * 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
8154da3d
TY
150/* 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
9b7895ef
MF
156/* Support for indexed directores */
157#define OCFS2_FEATURE_INCOMPAT_INDEXED_DIRS 0x0400
158
ab552d54
JB
159/* Metadata checksum and error correction */
160#define OCFS2_FEATURE_INCOMPAT_META_ECC 0x0800
161
50af94b1
MF
162/*
163 * backup superblock flag is used to indicate that this volume
164 * has backup superblocks.
165 */
166#define OCFS2_FEATURE_COMPAT_BACKUP_SB 0x0001
167
a9772189
JB
168/*
169 * The filesystem will correctly handle journal feature bits.
170 */
171#define OCFS2_FEATURE_COMPAT_JBD2_SB 0x0002
172
328d5752
MF
173/*
174 * Unwritten extents support.
175 */
176#define OCFS2_FEATURE_RO_COMPAT_UNWRITTEN 0x0001
177
1a224ad1
JK
178/*
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
50af94b1
MF
184/* 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
92e91ce2
MF
192/*
193 * Flags on ocfs2_super_block.s_tunefs_flags
194 */
195#define OCFS2_TUNEFS_INPROG_REMOVE_SLOT 0x0001 /* Removing slots */
196
ccd979bd
MF
197/*
198 * 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 */
1a224ad1 213#define OCFS2_QUOTA_FL (0x00001000) /* Quota file */
ccd979bd 214
15b1e36b
MF
215/*
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
ca4d147e
HP
226/* 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
e48edee2
MF
240/*
241 * Extent record flags (e_node.leaf.flags)
242 */
243#define OCFS2_EXT_UNWRITTEN (0x01) /* Extent is allocated but
244 * unwritten */
245
ca4d147e
HP
246/*
247 * ioctl commands
248 */
249#define OCFS2_IOC_GETFLAGS _IOR('f', 1, long)
250#define OCFS2_IOC_SETFLAGS _IOW('f', 2, long)
586d232b
MF
251#define OCFS2_IOC32_GETFLAGS _IOR('f', 1, int)
252#define OCFS2_IOC32_SETFLAGS _IOW('f', 2, int)
ca4d147e 253
b2580103
MF
254/*
255 * 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
7909f2bf
TM
280/* 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
d659072f 290#define OCFS2_IOC_GROUP_EXTEND _IOW('o', 1, int)
7909f2bf
TM
291#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)
d659072f 293
ccd979bd
MF
294/*
295 * 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
b61817e1
JB
316/* The alternate, userspace stack fields */
317#define OCFS2_STACK_LABEL_LEN 4
318#define OCFS2_CLUSTER_NAME_LEN 16
319
ccd979bd
MF
320/* Journal limits (in bytes) */
321#define OCFS2_MIN_JOURNAL_SIZE (4 * 1024 * 1024)
ccd979bd 322
2fbe8d1e
SM
323/*
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
fdd77704
TY
331/*
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
ccd979bd
MF
337struct 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,
1a224ad1
JK
351 USER_QUOTA_SYSTEM_INODE,
352 GROUP_QUOTA_SYSTEM_INODE,
353#define OCFS2_LAST_GLOBAL_SYSTEM_INODE GROUP_QUOTA_SYSTEM_INODE
ccd979bd
MF
354 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,
1a224ad1
JK
360 LOCAL_USER_QUOTA_SYSTEM_INODE,
361 LOCAL_GROUP_QUOTA_SYSTEM_INODE,
ccd979bd
MF
362 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 },
1a224ad1
JK
375 [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 },
ccd979bd
MF
377
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 },
1a224ad1
JK
384 [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 },
ccd979bd
MF
387};
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)
419
420#define OCFS2_LINK_MAX 32000
421
422#define S_SHIFT 12
423static unsigned char ocfs2_type_by_mode[S_IFMT >> S_SHIFT] = {
424 [S_IFREG >> S_SHIFT] = OCFS2_FT_REG_FILE,
425 [S_IFDIR >> S_SHIFT] = OCFS2_FT_DIR,
426 [S_IFCHR >> S_SHIFT] = OCFS2_FT_CHRDEV,
427 [S_IFBLK >> S_SHIFT] = OCFS2_FT_BLKDEV,
428 [S_IFIFO >> S_SHIFT] = OCFS2_FT_FIFO,
429 [S_IFSOCK >> S_SHIFT] = OCFS2_FT_SOCK,
430 [S_IFLNK >> S_SHIFT] = OCFS2_FT_SYMLINK,
431};
432
433
434/*
435 * Convenience casts
436 */
437#define OCFS2_RAW_SB(dinode) (&((dinode)->id2.i_super))
438
ab552d54
JB
439/*
440 * Block checking structure. This is used in metadata to validate the
441 * contents. If OCFS2_FEATURE_INCOMPAT_META_ECC is not set, it is all
442 * zeros.
443 */
444struct ocfs2_block_check {
445/*00*/ __le32 bc_crc32e; /* 802.3 Ethernet II CRC32 */
446 __le16 bc_ecc; /* Single-error-correction parity vector.
447 This is a simple Hamming code dependant
448 on the blocksize. OCFS2's maximum
449 blocksize, 4K, requires 16 parity bits,
450 so we fit in __le16. */
451 __le16 bc_reserved1;
452/*08*/
453};
454
ccd979bd
MF
455/*
456 * On disk extent record for OCFS2
457 * It describes a range of clusters on disk.
e48edee2
MF
458 *
459 * Length fields are divided into interior and leaf node versions.
460 * This leaves room for a flags field (OCFS2_EXT_*) in the leaf nodes.
ccd979bd
MF
461 */
462struct ocfs2_extent_rec {
463/*00*/ __le32 e_cpos; /* Offset into the file, in clusters */
e48edee2
MF
464 union {
465 __le32 e_int_clusters; /* Clusters covered by all children */
466 struct {
467 __le16 e_leaf_clusters; /* Clusters covered by this
468 extent */
469 __u8 e_reserved1;
470 __u8 e_flags; /* Extent flags */
471 };
472 };
ccd979bd
MF
473 __le64 e_blkno; /* Physical disk offset, in blocks */
474/*10*/
475};
476
477struct ocfs2_chain_rec {
478 __le32 c_free; /* Number of free bits in this chain. */
479 __le32 c_total; /* Number of total bits in this chain */
480 __le64 c_blkno; /* Physical disk offset (blocks) of 1st group */
481};
482
483struct ocfs2_truncate_rec {
484 __le32 t_start; /* 1st cluster in this log */
485 __le32 t_clusters; /* Number of total clusters covered */
486};
487
488/*
489 * On disk extent list for OCFS2 (node in the tree). Note that this
490 * is contained inside ocfs2_dinode or ocfs2_extent_block, so the
491 * offsets are relative to ocfs2_dinode.id2.i_list or
492 * ocfs2_extent_block.h_list, respectively.
493 */
494struct ocfs2_extent_list {
495/*00*/ __le16 l_tree_depth; /* Extent tree depth from this
496 point. 0 means data extents
497 hang directly off this
dcd0538f
MF
498 header (a leaf)
499 NOTE: The high 8 bits cannot be
500 used - tree_depth is never that big.
501 */
ccd979bd
MF
502 __le16 l_count; /* Number of extent records */
503 __le16 l_next_free_rec; /* Next unused extent slot */
504 __le16 l_reserved1;
505 __le64 l_reserved2; /* Pad to
506 sizeof(ocfs2_extent_rec) */
507/*10*/ struct ocfs2_extent_rec l_recs[0]; /* Extent records */
508};
509
510/*
511 * On disk allocation chain list for OCFS2. Note that this is
512 * contained inside ocfs2_dinode, so the offsets are relative to
513 * ocfs2_dinode.id2.i_chain.
514 */
515struct ocfs2_chain_list {
516/*00*/ __le16 cl_cpg; /* Clusters per Block Group */
517 __le16 cl_bpc; /* Bits per cluster */
518 __le16 cl_count; /* Total chains in this list */
519 __le16 cl_next_free_rec; /* Next unused chain slot */
520 __le64 cl_reserved1;
521/*10*/ struct ocfs2_chain_rec cl_recs[0]; /* Chain records */
522};
523
524/*
525 * On disk deallocation log for OCFS2. Note that this is
526 * contained inside ocfs2_dinode, so the offsets are relative to
527 * ocfs2_dinode.id2.i_dealloc.
528 */
529struct ocfs2_truncate_log {
530/*00*/ __le16 tl_count; /* Total records in this log */
531 __le16 tl_used; /* Number of records in use */
532 __le32 tl_reserved1;
533/*08*/ struct ocfs2_truncate_rec tl_recs[0]; /* Truncate records */
534};
535
536/*
537 * On disk extent block (indirect block) for OCFS2
538 */
539struct ocfs2_extent_block
540{
541/*00*/ __u8 h_signature[8]; /* Signature for verification */
ab552d54 542 struct ocfs2_block_check h_check; /* Error checking */
ccd979bd
MF
543/*10*/ __le16 h_suballoc_slot; /* Slot suballocator this
544 extent_header belongs to */
545 __le16 h_suballoc_bit; /* Bit offset in suballocator
546 block group */
547 __le32 h_fs_generation; /* Must match super block */
548 __le64 h_blkno; /* Offset on disk, in blocks */
549/*20*/ __le64 h_reserved3;
550 __le64 h_next_leaf_blk; /* Offset on disk, in blocks,
551 of next leaf header pointing
552 to data */
553/*30*/ struct ocfs2_extent_list h_list; /* Extent record list */
554/* Actual on-disk size is one block */
555};
556
fb86b1f0
JB
557/*
558 * On disk slot map for OCFS2. This defines the contents of the "slot_map"
386a2ef8
JB
559 * system file. A slot is valid if it contains a node number >= 0. The
560 * value -1 (0xFFFF) is OCFS2_INVALID_SLOT. This marks a slot empty.
fb86b1f0
JB
561 */
562struct ocfs2_slot_map {
563/*00*/ __le16 sm_slots[0];
564/*
565 * Actual on-disk size is one block. OCFS2_MAX_SLOTS is 255,
566 * 255 * sizeof(__le16) == 512B, within the 512B block minimum blocksize.
567 */
568};
569
386a2ef8
JB
570struct ocfs2_extended_slot {
571/*00*/ __u8 es_valid;
572 __u8 es_reserved1[3];
573 __le32 es_node_num;
574/*10*/
575};
576
577/*
578 * The extended slot map, used when OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP
579 * is set. It separates out the valid marker from the node number, and
580 * has room to grow. Unlike the old slot map, this format is defined by
581 * i_size.
582 */
583struct ocfs2_slot_map_extended {
584/*00*/ struct ocfs2_extended_slot se_slots[0];
585/*
586 * Actual size is i_size of the slot_map system file. It should
587 * match s_max_slots * sizeof(struct ocfs2_extended_slot)
588 */
589};
590
b61817e1
JB
591struct ocfs2_cluster_info {
592/*00*/ __u8 ci_stack[OCFS2_STACK_LABEL_LEN];
593 __le32 ci_reserved;
594/*08*/ __u8 ci_cluster[OCFS2_CLUSTER_NAME_LEN];
595/*18*/
596};
597
ccd979bd
MF
598/*
599 * On disk superblock for OCFS2
600 * Note that it is contained inside an ocfs2_dinode, so all offsets
601 * are relative to the start of ocfs2_dinode.id2.
602 */
603struct ocfs2_super_block {
604/*00*/ __le16 s_major_rev_level;
605 __le16 s_minor_rev_level;
606 __le16 s_mnt_count;
607 __le16 s_max_mnt_count;
608 __le16 s_state; /* File system state */
609 __le16 s_errors; /* Behaviour when detecting errors */
610 __le32 s_checkinterval; /* Max time between checks */
611/*10*/ __le64 s_lastcheck; /* Time of last check */
612 __le32 s_creator_os; /* OS */
613 __le32 s_feature_compat; /* Compatible feature set */
614/*20*/ __le32 s_feature_incompat; /* Incompatible feature set */
615 __le32 s_feature_ro_compat; /* Readonly-compatible feature set */
616 __le64 s_root_blkno; /* Offset, in blocks, of root directory
617 dinode */
618/*30*/ __le64 s_system_dir_blkno; /* Offset, in blocks, of system
619 directory dinode */
620 __le32 s_blocksize_bits; /* Blocksize for this fs */
621 __le32 s_clustersize_bits; /* Clustersize for this fs */
622/*40*/ __le16 s_max_slots; /* Max number of simultaneous mounts
623 before tunefs required */
92e91ce2 624 __le16 s_tunefs_flag;
cf1d6c76 625 __le32 s_uuid_hash; /* hash value of uuid */
ccd979bd
MF
626 __le64 s_first_cluster_group; /* Block offset of 1st cluster
627 * group header */
628/*50*/ __u8 s_label[OCFS2_MAX_VOL_LABEL_LEN]; /* Label for mounting, etc. */
629/*90*/ __u8 s_uuid[OCFS2_VOL_UUID_LEN]; /* 128-bit uuid */
b61817e1
JB
630/*A0*/ struct ocfs2_cluster_info s_cluster_info; /* Selected userspace
631 stack. Only valid
632 with INCOMPAT flag. */
8154da3d
TY
633/*B8*/ __le16 s_xattr_inline_size; /* extended attribute inline size
634 for this fs*/
635 __le16 s_reserved0;
9b7895ef
MF
636 __le32 s_dx_seed[3]; /* seed[0-2] for dx dir hash.
637 * s_uuid_hash serves as seed[3]. */
638/*C0*/ __le64 s_reserved2[15]; /* Fill out superblock */
b61817e1
JB
639/*140*/
640
641 /*
642 * NOTE: As stated above, all offsets are relative to
643 * ocfs2_dinode.id2, which is at 0xC0 in the inode.
644 * 0xC0 + 0x140 = 0x200 or 512 bytes. A superblock must fit within
645 * our smallest blocksize, which is 512 bytes. To ensure this,
646 * we reserve the space in s_reserved2. Anything past s_reserved2
647 * will not be available on the smallest blocksize.
648 */
ccd979bd
MF
649};
650
651/*
652 * Local allocation bitmap for OCFS2 slots
653 * Note that it exists inside an ocfs2_dinode, so all offsets are
654 * relative to the start of ocfs2_dinode.id2.
655 */
656struct ocfs2_local_alloc
657{
658/*00*/ __le32 la_bm_off; /* Starting bit offset in main bitmap */
659 __le16 la_size; /* Size of included bitmap, in bytes */
660 __le16 la_reserved1;
661 __le64 la_reserved2;
662/*10*/ __u8 la_bitmap[0];
663};
664
15b1e36b
MF
665/*
666 * Data-in-inode header. This is only used if i_dyn_features has
667 * OCFS2_INLINE_DATA_FL set.
668 */
669struct ocfs2_inline_data
670{
671/*00*/ __le16 id_count; /* Number of bytes that can be used
672 * for data, starting at id_data */
673 __le16 id_reserved0;
674 __le32 id_reserved1;
675 __u8 id_data[0]; /* Start of user data */
676};
677
ccd979bd
MF
678/*
679 * On disk inode for OCFS2
680 */
681struct ocfs2_dinode {
682/*00*/ __u8 i_signature[8]; /* Signature for validation */
683 __le32 i_generation; /* Generation number */
684 __le16 i_suballoc_slot; /* Slot suballocator this inode
685 belongs to */
686 __le16 i_suballoc_bit; /* Bit offset in suballocator
687 block group */
fdd77704
TY
688/*10*/ __le16 i_reserved0;
689 __le16 i_xattr_inline_size;
ccd979bd
MF
690 __le32 i_clusters; /* Cluster count */
691 __le32 i_uid; /* Owner UID */
692 __le32 i_gid; /* Owning GID */
693/*20*/ __le64 i_size; /* Size in bytes */
694 __le16 i_mode; /* File mode */
695 __le16 i_links_count; /* Links count */
696 __le32 i_flags; /* File flags */
697/*30*/ __le64 i_atime; /* Access time */
698 __le64 i_ctime; /* Creation time */
699/*40*/ __le64 i_mtime; /* Modification time */
700 __le64 i_dtime; /* Deletion time */
701/*50*/ __le64 i_blkno; /* Offset on disk, in blocks */
702 __le64 i_last_eb_blk; /* Pointer to last extent
703 block */
704/*60*/ __le32 i_fs_generation; /* Generation per fs-instance */
705 __le32 i_atime_nsec;
706 __le32 i_ctime_nsec;
707 __le32 i_mtime_nsec;
fdd77704 708/*70*/ __le32 i_attr;
50008630
TY
709 __le16 i_orphaned_slot; /* Only valid when OCFS2_ORPHANED_FL
710 was set in i_flags */
15b1e36b 711 __le16 i_dyn_features;
fdd77704 712 __le64 i_xattr_loc;
ab552d54 713/*80*/ struct ocfs2_block_check i_check; /* Error checking */
9b7895ef
MF
714/*88*/ __le64 i_dx_root; /* Pointer to dir index root block */
715 __le64 i_reserved2[5];
ccd979bd
MF
716/*B8*/ union {
717 __le64 i_pad1; /* Generic way to refer to this
718 64bit union */
719 struct {
720 __le64 i_rdev; /* Device number */
721 } dev1;
722 struct { /* Info for bitmap system
723 inodes */
724 __le32 i_used; /* Bits (ie, clusters) used */
725 __le32 i_total; /* Total bits (clusters)
726 available */
727 } bitmap1;
728 struct { /* Info for journal system
729 inodes */
730 __le32 ij_flags; /* Mounted, version, etc. */
c69991aa
SM
731 __le32 ij_recovery_generation; /* Incremented when the
732 journal is recovered
733 after an unclean
734 shutdown */
ccd979bd
MF
735 } journal1;
736 } id1; /* Inode type dependant 1 */
737/*C0*/ union {
738 struct ocfs2_super_block i_super;
739 struct ocfs2_local_alloc i_lab;
740 struct ocfs2_chain_list i_chain;
741 struct ocfs2_extent_list i_list;
742 struct ocfs2_truncate_log i_dealloc;
15b1e36b 743 struct ocfs2_inline_data i_data;
ccd979bd
MF
744 __u8 i_symlink[0];
745 } id2;
746/* Actual on-disk size is one block */
747};
748
749/*
750 * On-disk directory entry structure for OCFS2
751 *
752 * Packed as this structure could be accessed unaligned on 64-bit platforms
753 */
754struct ocfs2_dir_entry {
755/*00*/ __le64 inode; /* Inode number */
756 __le16 rec_len; /* Directory entry length */
757 __u8 name_len; /* Name length */
758 __u8 file_type;
759/*0C*/ char name[OCFS2_MAX_FILENAME_LEN]; /* File name */
760/* Actual on-disk length specified by rec_len */
761} __attribute__ ((packed));
762
87d35a74
MF
763/*
764 * Per-block record for the unindexed directory btree. This is carefully
765 * crafted so that the rec_len and name_len records of an ocfs2_dir_entry are
766 * mirrored. That way, the directory manipulation code needs a minimal amount
767 * of update.
768 *
769 * NOTE: Keep this structure aligned to a multiple of 4 bytes.
770 */
771struct ocfs2_dir_block_trailer {
772/*00*/ __le64 db_compat_inode; /* Always zero. Was inode */
773
774 __le16 db_compat_rec_len; /* Backwards compatible with
775 * ocfs2_dir_entry. */
776 __u8 db_compat_name_len; /* Always zero. Was name_len */
777 __u8 db_reserved0;
778 __le16 db_reserved1;
779 __le16 db_free_rec_len; /* Size of largest empty hole
780 * in this block. (unused) */
781/*10*/ __u8 db_signature[8]; /* Signature for verification */
782 __le64 db_reserved2;
783 __le64 db_free_next; /* Next block in list (unused) */
784/*20*/ __le64 db_blkno; /* Offset on disk, in blocks */
785 __le64 db_parent_dinode; /* dinode which owns me, in
786 blocks */
c175a518 787/*30*/ struct ocfs2_block_check db_check; /* Error checking */
87d35a74
MF
788/*40*/
789};
790
9b7895ef
MF
791 /*
792 * A directory entry in the indexed tree. We don't store the full name here,
793 * but instead provide a pointer to the full dirent in the unindexed tree.
794 *
795 * We also store name_len here so as to reduce the number of leaf blocks we
796 * need to search in case of collisions.
797 */
798struct ocfs2_dx_entry {
799 __le32 dx_major_hash; /* Used to find logical
800 * cluster in index */
801 __le32 dx_minor_hash; /* Lower bits used to find
802 * block in cluster */
803 __le64 dx_dirent_blk; /* Physical block in unindexed
804 * tree holding this dirent. */
805};
806
807struct ocfs2_dx_entry_list {
808 __le32 de_reserved;
809 __le16 de_count; /* Maximum number of entries
810 * possible in de_entries */
811 __le16 de_num_used; /* Current number of
812 * de_entries entries */
813 struct ocfs2_dx_entry de_entries[0]; /* Indexed dir entries
814 * in a packed array of
815 * length de_num_used */
816};
817
4ed8a6bb
MF
818#define OCFS2_DX_FLAG_INLINE 0x01
819
9b7895ef
MF
820/*
821 * A directory indexing block. Each indexed directory has one of these,
822 * pointed to by ocfs2_dinode.
823 *
824 * This block stores an indexed btree root, and a set of free space
825 * start-of-list pointers.
826 */
827struct ocfs2_dx_root_block {
828 __u8 dr_signature[8]; /* Signature for verification */
829 struct ocfs2_block_check dr_check; /* Error checking */
830 __le16 dr_suballoc_slot; /* Slot suballocator this
831 * block belongs to. */
832 __le16 dr_suballoc_bit; /* Bit offset in suballocator
833 * block group */
834 __le32 dr_fs_generation; /* Must match super block */
835 __le64 dr_blkno; /* Offset on disk, in blocks */
836 __le64 dr_last_eb_blk; /* Pointer to last
837 * extent block */
838 __le32 dr_clusters; /* Clusters allocated
839 * to the indexed tree. */
4ed8a6bb
MF
840 __u8 dr_flags; /* OCFS2_DX_FLAG_* flags */
841 __u8 dr_reserved0;
842 __le16 dr_reserved1;
9b7895ef
MF
843 __le64 dr_dir_blkno; /* Pointer to parent inode */
844 __le64 dr_reserved2;
845 __le64 dr_reserved3[16];
4ed8a6bb
MF
846 union {
847 struct ocfs2_extent_list dr_list; /* Keep this aligned to 128
848 * bits for maximum space
849 * efficiency. */
850 struct ocfs2_dx_entry_list dr_entries; /* In-root-block list of
851 * entries. We grow out
852 * to extents if this
853 * gets too big. */
854 };
9b7895ef
MF
855};
856
857/*
858 * The header of a leaf block in the indexed tree.
859 */
860struct ocfs2_dx_leaf {
861 __u8 dl_signature[8];/* Signature for verification */
862 struct ocfs2_block_check dl_check; /* Error checking */
863 __le64 dl_blkno; /* Offset on disk, in blocks */
864 __le32 dl_fs_generation;/* Must match super block */
865 __le32 dl_reserved0;
866 __le64 dl_reserved1;
867 struct ocfs2_dx_entry_list dl_list;
868};
869
ccd979bd
MF
870/*
871 * On disk allocator group structure for OCFS2
872 */
873struct ocfs2_group_desc
874{
875/*00*/ __u8 bg_signature[8]; /* Signature for validation */
876 __le16 bg_size; /* Size of included bitmap in
877 bytes. */
878 __le16 bg_bits; /* Bits represented by this
879 group. */
880 __le16 bg_free_bits_count; /* Free bits count */
881 __le16 bg_chain; /* What chain I am in. */
882/*10*/ __le32 bg_generation;
883 __le32 bg_reserved1;
884 __le64 bg_next_group; /* Next group in my list, in
885 blocks */
886/*20*/ __le64 bg_parent_dinode; /* dinode which owns me, in
887 blocks */
888 __le64 bg_blkno; /* Offset on disk, in blocks */
ab552d54
JB
889/*30*/ struct ocfs2_block_check bg_check; /* Error checking */
890 __le64 bg_reserved2;
ccd979bd
MF
891/*40*/ __u8 bg_bitmap[0];
892};
893
5a7bc8eb
TM
894/*
895 * On disk extended attribute structure for OCFS2.
896 */
897
898/*
899 * ocfs2_xattr_entry indicates one extend attribute.
900 *
901 * Note that it can be stored in inode, one block or one xattr bucket.
902 */
903struct ocfs2_xattr_entry {
904 __le32 xe_name_hash; /* hash value of xattr prefix+suffix. */
8573f79d 905 __le16 xe_name_offset; /* byte offset from the 1st entry in the
5a7bc8eb
TM
906 local xattr storage(inode, xattr block or
907 xattr bucket). */
908 __u8 xe_name_len; /* xattr name len, does't include prefix. */
8573f79d
TM
909 __u8 xe_type; /* the low 7 bits indicate the name prefix
910 * type and the highest bit indicates whether
5a7bc8eb
TM
911 * the EA is stored in the local storage. */
912 __le64 xe_value_size; /* real xattr value length. */
913};
914
915/*
916 * On disk structure for xattr header.
917 *
918 * One ocfs2_xattr_header describes how many ocfs2_xattr_entry records in
919 * the local xattr storage.
920 */
921struct ocfs2_xattr_header {
922 __le16 xh_count; /* contains the count of how
923 many records are in the
924 local xattr storage. */
0c044f0b
TM
925 __le16 xh_free_start; /* current offset for storing
926 xattr. */
927 __le16 xh_name_value_len; /* total length of name/value
928 length in this bucket. */
8573f79d
TM
929 __le16 xh_num_buckets; /* Number of xattr buckets
930 in this extent record,
931 only valid in the first
932 bucket. */
ab552d54
JB
933 struct ocfs2_block_check xh_check; /* Error checking
934 (Note, this is only
935 used for xattr
936 buckets. A block uses
937 xb_check and sets
938 this field to zero.) */
5a7bc8eb
TM
939 struct ocfs2_xattr_entry xh_entries[0]; /* xattr entry list. */
940};
941
942/*
943 * On disk structure for xattr value root.
944 *
8573f79d
TM
945 * When an xattr's value is large enough, it is stored in an external
946 * b-tree like file data. The xattr value root points to this structure.
5a7bc8eb
TM
947 */
948struct ocfs2_xattr_value_root {
949/*00*/ __le32 xr_clusters; /* clusters covered by xattr value. */
950 __le32 xr_reserved0;
951 __le64 xr_last_eb_blk; /* Pointer to last extent block */
952/*10*/ struct ocfs2_extent_list xr_list; /* Extent record list */
953};
954
955/*
956 * On disk structure for xattr tree root.
957 *
958 * It is used when there are too many extended attributes for one file. These
959 * attributes will be organized and stored in an indexed-btree.
960 */
961struct ocfs2_xattr_tree_root {
962/*00*/ __le32 xt_clusters; /* clusters covered by xattr. */
963 __le32 xt_reserved0;
964 __le64 xt_last_eb_blk; /* Pointer to last extent block */
965/*10*/ struct ocfs2_extent_list xt_list; /* Extent record list */
966};
967
cf1d6c76
TY
968#define OCFS2_XATTR_INDEXED 0x1
969#define OCFS2_HASH_SHIFT 5
970#define OCFS2_XATTR_ROUND 3
971#define OCFS2_XATTR_SIZE(size) (((size) + OCFS2_XATTR_ROUND) & \
972 ~(OCFS2_XATTR_ROUND))
5a7bc8eb 973
0c044f0b
TM
974#define OCFS2_XATTR_BUCKET_SIZE 4096
975#define OCFS2_XATTR_MAX_BLOCKS_PER_BUCKET (OCFS2_XATTR_BUCKET_SIZE \
976 / OCFS2_MIN_BLOCKSIZE)
977
5a7bc8eb
TM
978/*
979 * On disk structure for xattr block.
980 */
981struct ocfs2_xattr_block {
982/*00*/ __u8 xb_signature[8]; /* Signature for verification */
983 __le16 xb_suballoc_slot; /* Slot suballocator this
984 block belongs to. */
985 __le16 xb_suballoc_bit; /* Bit offset in suballocator
986 block group */
987 __le32 xb_fs_generation; /* Must match super block */
988/*10*/ __le64 xb_blkno; /* Offset on disk, in blocks */
ab552d54 989 struct ocfs2_block_check xb_check; /* Error checking */
5a7bc8eb
TM
990/*20*/ __le16 xb_flags; /* Indicates whether this block contains
991 real xattr or a xattr tree. */
992 __le16 xb_reserved0;
993 __le32 xb_reserved1;
994 __le64 xb_reserved2;
995/*30*/ union {
996 struct ocfs2_xattr_header xb_header; /* xattr header if this
997 block contains xattr */
998 struct ocfs2_xattr_tree_root xb_root;/* xattr tree root if this
999 block cotains xattr
1000 tree. */
1001 } xb_attrs;
1002};
1003
1004#define OCFS2_XATTR_ENTRY_LOCAL 0x80
1005#define OCFS2_XATTR_TYPE_MASK 0x7F
1006static inline void ocfs2_xattr_set_local(struct ocfs2_xattr_entry *xe,
1007 int local)
1008{
1009 if (local)
1010 xe->xe_type |= OCFS2_XATTR_ENTRY_LOCAL;
1011 else
1012 xe->xe_type &= ~OCFS2_XATTR_ENTRY_LOCAL;
1013}
1014
1015static inline int ocfs2_xattr_is_local(struct ocfs2_xattr_entry *xe)
1016{
1017 return xe->xe_type & OCFS2_XATTR_ENTRY_LOCAL;
1018}
1019
1020static inline void ocfs2_xattr_set_type(struct ocfs2_xattr_entry *xe, int type)
1021{
1022 xe->xe_type |= type & OCFS2_XATTR_TYPE_MASK;
1023}
1024
1025static inline int ocfs2_xattr_get_type(struct ocfs2_xattr_entry *xe)
1026{
1027 return xe->xe_type & OCFS2_XATTR_TYPE_MASK;
1028}
1029
9e33d69f
JK
1030/*
1031 * On disk structures for global quota file
1032 */
1033
1034/* Magic numbers and known versions for global quota files */
1035#define OCFS2_GLOBAL_QMAGICS {\
1036 0x0cf52470, /* USRQUOTA */ \
1037 0x0cf52471 /* GRPQUOTA */ \
1038}
1039
1040#define OCFS2_GLOBAL_QVERSIONS {\
1041 0, \
1042 0, \
1043}
1044
1045
1046/* Each block of each quota file has a certain fixed number of bytes reserved
1047 * for OCFS2 internal use at its end. OCFS2 can use it for things like
1048 * checksums, etc. */
1049#define OCFS2_QBLK_RESERVED_SPACE 8
1050
1051/* Generic header of all quota files */
1052struct ocfs2_disk_dqheader {
1053 __le32 dqh_magic; /* Magic number identifying file */
1054 __le32 dqh_version; /* Quota format version */
1055};
1056
1057#define OCFS2_GLOBAL_INFO_OFF (sizeof(struct ocfs2_disk_dqheader))
1058
1059/* Information header of global quota file (immediately follows the generic
1060 * header) */
1061struct ocfs2_global_disk_dqinfo {
1062/*00*/ __le32 dqi_bgrace; /* Grace time for space softlimit excess */
1063 __le32 dqi_igrace; /* Grace time for inode softlimit excess */
1064 __le32 dqi_syncms; /* Time after which we sync local changes to
1065 * global quota file */
1066 __le32 dqi_blocks; /* Number of blocks in quota file */
1067/*10*/ __le32 dqi_free_blk; /* First free block in quota file */
1068 __le32 dqi_free_entry; /* First block with free dquot entry in quota
1069 * file */
1070};
1071
1072/* Structure with global user / group information. We reserve some space
1073 * for future use. */
1074struct ocfs2_global_disk_dqblk {
1075/*00*/ __le32 dqb_id; /* ID the structure belongs to */
1076 __le32 dqb_use_count; /* Number of nodes having reference to this structure */
1077 __le64 dqb_ihardlimit; /* absolute limit on allocated inodes */
1078/*10*/ __le64 dqb_isoftlimit; /* preferred inode limit */
1079 __le64 dqb_curinodes; /* current # allocated inodes */
1080/*20*/ __le64 dqb_bhardlimit; /* absolute limit on disk space */
1081 __le64 dqb_bsoftlimit; /* preferred limit on disk space */
1082/*30*/ __le64 dqb_curspace; /* current space occupied */
1083 __le64 dqb_btime; /* time limit for excessive disk use */
1084/*40*/ __le64 dqb_itime; /* time limit for excessive inode use */
1085 __le64 dqb_pad1;
1086/*50*/ __le64 dqb_pad2;
1087};
1088
1089/*
1090 * On-disk structures for local quota file
1091 */
1092
1093/* Magic numbers and known versions for local quota files */
1094#define OCFS2_LOCAL_QMAGICS {\
1095 0x0cf524c0, /* USRQUOTA */ \
1096 0x0cf524c1 /* GRPQUOTA */ \
1097}
1098
1099#define OCFS2_LOCAL_QVERSIONS {\
1100 0, \
1101 0, \
1102}
1103
1104/* Quota flags in dqinfo header */
1105#define OLQF_CLEAN 0x0001 /* Quota file is empty (this should be after\
1106 * quota has been cleanly turned off) */
1107
1108#define OCFS2_LOCAL_INFO_OFF (sizeof(struct ocfs2_disk_dqheader))
1109
1110/* Information header of local quota file (immediately follows the generic
1111 * header) */
1112struct ocfs2_local_disk_dqinfo {
1113 __le32 dqi_flags; /* Flags for quota file */
1114 __le32 dqi_chunks; /* Number of chunks of quota structures
1115 * with a bitmap */
1116 __le32 dqi_blocks; /* Number of blocks allocated for quota file */
1117};
1118
1119/* Header of one chunk of a quota file */
1120struct ocfs2_local_disk_chunk {
1121 __le32 dqc_free; /* Number of free entries in the bitmap */
1122 u8 dqc_bitmap[0]; /* Bitmap of entries in the corresponding
1123 * chunk of quota file */
1124};
1125
1126/* One entry in local quota file */
1127struct ocfs2_local_disk_dqblk {
1128/*00*/ __le64 dqb_id; /* id this quota applies to */
1129 __le64 dqb_spacemod; /* Change in the amount of used space */
1130/*10*/ __le64 dqb_inodemod; /* Change in the amount of used inodes */
1131};
1132
ab552d54
JB
1133
1134/*
1135 * The quota trailer lives at the end of each quota block.
1136 */
1137
1138struct ocfs2_disk_dqtrailer {
1139/*00*/ struct ocfs2_block_check dq_check; /* Error checking */
1140/*08*/ /* Cannot be larger than OCFS2_QBLK_RESERVED_SPACE */
1141};
1142
1143static inline struct ocfs2_disk_dqtrailer *ocfs2_block_dqtrailer(int blocksize,
1144 void *buf)
1145{
1146 char *ptr = buf;
1147 ptr += blocksize - OCFS2_QBLK_RESERVED_SPACE;
1148
1149 return (struct ocfs2_disk_dqtrailer *)ptr;
1150}
1151
ccd979bd
MF
1152#ifdef __KERNEL__
1153static inline int ocfs2_fast_symlink_chars(struct super_block *sb)
1154{
1155 return sb->s_blocksize -
1156 offsetof(struct ocfs2_dinode, id2.i_symlink);
1157}
1158
fdd77704
TY
1159static inline int ocfs2_max_inline_data_with_xattr(struct super_block *sb,
1160 struct ocfs2_dinode *di)
1161{
1162 unsigned int xattrsize = le16_to_cpu(di->i_xattr_inline_size);
1163
1164 if (le16_to_cpu(di->i_dyn_features) & OCFS2_INLINE_XATTR_FL)
1165 return sb->s_blocksize -
1166 offsetof(struct ocfs2_dinode, id2.i_data.id_data) -
1167 xattrsize;
1168 else
1169 return sb->s_blocksize -
1170 offsetof(struct ocfs2_dinode, id2.i_data.id_data);
1171}
1172
ccd979bd
MF
1173static inline int ocfs2_extent_recs_per_inode(struct super_block *sb)
1174{
1175 int size;
1176
1177 size = sb->s_blocksize -
1178 offsetof(struct ocfs2_dinode, id2.i_list.l_recs);
1179
1180 return size / sizeof(struct ocfs2_extent_rec);
1181}
1182
fdd77704
TY
1183static inline int ocfs2_extent_recs_per_inode_with_xattr(
1184 struct super_block *sb,
1185 struct ocfs2_dinode *di)
1186{
1187 int size;
1188 unsigned int xattrsize = le16_to_cpu(di->i_xattr_inline_size);
1189
1190 if (le16_to_cpu(di->i_dyn_features) & OCFS2_INLINE_XATTR_FL)
1191 size = sb->s_blocksize -
1192 offsetof(struct ocfs2_dinode, id2.i_list.l_recs) -
1193 xattrsize;
1194 else
1195 size = sb->s_blocksize -
1196 offsetof(struct ocfs2_dinode, id2.i_list.l_recs);
1197
1198 return size / sizeof(struct ocfs2_extent_rec);
1199}
1200
9b7895ef
MF
1201static inline int ocfs2_extent_recs_per_dx_root(struct super_block *sb)
1202{
1203 int size;
1204
1205 size = sb->s_blocksize -
1206 offsetof(struct ocfs2_dx_root_block, dr_list.l_recs);
1207
1208 return size / sizeof(struct ocfs2_extent_rec);
1209}
1210
ccd979bd
MF
1211static inline int ocfs2_chain_recs_per_inode(struct super_block *sb)
1212{
1213 int size;
1214
1215 size = sb->s_blocksize -
1216 offsetof(struct ocfs2_dinode, id2.i_chain.cl_recs);
1217
1218 return size / sizeof(struct ocfs2_chain_rec);
1219}
1220
1221static inline u16 ocfs2_extent_recs_per_eb(struct super_block *sb)
1222{
1223 int size;
1224
1225 size = sb->s_blocksize -
1226 offsetof(struct ocfs2_extent_block, h_list.l_recs);
1227
1228 return size / sizeof(struct ocfs2_extent_rec);
1229}
1230
9b7895ef
MF
1231static inline int ocfs2_dx_entries_per_leaf(struct super_block *sb)
1232{
1233 int size;
1234
1235 size = sb->s_blocksize -
1236 offsetof(struct ocfs2_dx_leaf, dl_list.de_entries);
1237
1238 return size / sizeof(struct ocfs2_dx_entry);
1239}
1240
4ed8a6bb
MF
1241static inline int ocfs2_dx_entries_per_root(struct super_block *sb)
1242{
1243 int size;
1244
1245 size = sb->s_blocksize -
1246 offsetof(struct ocfs2_dx_root_block, dr_entries.de_entries);
1247
1248 return size / sizeof(struct ocfs2_dx_entry);
1249}
1250
ccd979bd
MF
1251static inline u16 ocfs2_local_alloc_size(struct super_block *sb)
1252{
1253 u16 size;
1254
1255 size = sb->s_blocksize -
1256 offsetof(struct ocfs2_dinode, id2.i_lab.la_bitmap);
1257
1258 return size;
1259}
1260
1261static inline int ocfs2_group_bitmap_size(struct super_block *sb)
1262{
1263 int size;
1264
1265 size = sb->s_blocksize -
1266 offsetof(struct ocfs2_group_desc, bg_bitmap);
1267
1268 return size;
1269}
1270
1271static inline int ocfs2_truncate_recs_per_inode(struct super_block *sb)
1272{
1273 int size;
1274
1275 size = sb->s_blocksize -
1276 offsetof(struct ocfs2_dinode, id2.i_dealloc.tl_recs);
1277
1278 return size / sizeof(struct ocfs2_truncate_rec);
1279}
50af94b1
MF
1280
1281static inline u64 ocfs2_backup_super_blkno(struct super_block *sb, int index)
1282{
1283 u64 offset = OCFS2_BACKUP_SB_START;
1284
1285 if (index >= 0 && index < OCFS2_MAX_BACKUP_SUPERBLOCKS) {
1286 offset <<= (2 * index);
a8a75a20 1287 offset >>= sb->s_blocksize_bits;
50af94b1
MF
1288 return offset;
1289 }
1290
1291 return 0;
1292
1293}
0c044f0b
TM
1294
1295static inline u16 ocfs2_xattr_recs_per_xb(struct super_block *sb)
1296{
1297 int size;
1298
1299 size = sb->s_blocksize -
1300 offsetof(struct ocfs2_xattr_block,
1301 xb_attrs.xb_root.xt_list.l_recs);
1302
1303 return size / sizeof(struct ocfs2_extent_rec);
1304}
ccd979bd
MF
1305#else
1306static inline int ocfs2_fast_symlink_chars(int blocksize)
1307{
1308 return blocksize - offsetof(struct ocfs2_dinode, id2.i_symlink);
1309}
1310
15b1e36b
MF
1311static inline int ocfs2_max_inline_data(int blocksize)
1312{
1313 return blocksize - offsetof(struct ocfs2_dinode, id2.i_data.id_data);
1314}
1315
ccd979bd
MF
1316static inline int ocfs2_extent_recs_per_inode(int blocksize)
1317{
1318 int size;
1319
1320 size = blocksize -
1321 offsetof(struct ocfs2_dinode, id2.i_list.l_recs);
1322
1323 return size / sizeof(struct ocfs2_extent_rec);
1324}
1325
1326static inline int ocfs2_chain_recs_per_inode(int blocksize)
1327{
1328 int size;
1329
1330 size = blocksize -
1331 offsetof(struct ocfs2_dinode, id2.i_chain.cl_recs);
1332
1333 return size / sizeof(struct ocfs2_chain_rec);
1334}
1335
1336static inline int ocfs2_extent_recs_per_eb(int blocksize)
1337{
1338 int size;
1339
1340 size = blocksize -
1341 offsetof(struct ocfs2_extent_block, h_list.l_recs);
1342
1343 return size / sizeof(struct ocfs2_extent_rec);
1344}
1345
1346static inline int ocfs2_local_alloc_size(int blocksize)
1347{
1348 int size;
1349
1350 size = blocksize -
1351 offsetof(struct ocfs2_dinode, id2.i_lab.la_bitmap);
1352
1353 return size;
1354}
1355
1356static inline int ocfs2_group_bitmap_size(int blocksize)
1357{
1358 int size;
1359
1360 size = blocksize -
1361 offsetof(struct ocfs2_group_desc, bg_bitmap);
1362
1363 return size;
1364}
1365
1366static inline int ocfs2_truncate_recs_per_inode(int blocksize)
1367{
1368 int size;
1369
1370 size = blocksize -
1371 offsetof(struct ocfs2_dinode, id2.i_dealloc.tl_recs);
1372
1373 return size / sizeof(struct ocfs2_truncate_rec);
1374}
50af94b1
MF
1375
1376static inline uint64_t ocfs2_backup_super_blkno(int blocksize, int index)
1377{
1378 uint64_t offset = OCFS2_BACKUP_SB_START;
1379
1380 if (index >= 0 && index < OCFS2_MAX_BACKUP_SUPERBLOCKS) {
1381 offset <<= (2 * index);
1382 offset /= blocksize;
1383 return offset;
1384 }
1385
1386 return 0;
1387}
0c044f0b
TM
1388
1389static inline int ocfs2_xattr_recs_per_xb(int blocksize)
1390{
1391 int size;
1392
1393 size = blocksize -
1394 offsetof(struct ocfs2_xattr_block,
1395 xb_attrs.xb_root.xt_list.l_recs);
1396
1397 return size / sizeof(struct ocfs2_extent_rec);
1398}
ccd979bd
MF
1399#endif /* __KERNEL__ */
1400
1401
1402static inline int ocfs2_system_inode_is_global(int type)
1403{
1404 return ((type >= 0) &&
1405 (type <= OCFS2_LAST_GLOBAL_SYSTEM_INODE));
1406}
1407
1408static inline int ocfs2_sprintf_system_inode_name(char *buf, int len,
1409 int type, int slot)
1410{
1411 int chars;
1412
1413 /*
1414 * Global system inodes can only have one copy. Everything
1415 * after OCFS2_LAST_GLOBAL_SYSTEM_INODE in the system inode
1416 * list has a copy per slot.
1417 */
1418 if (type <= OCFS2_LAST_GLOBAL_SYSTEM_INODE)
fe9f3877 1419 chars = snprintf(buf, len, "%s",
ccd979bd
MF
1420 ocfs2_system_inodes[type].si_name);
1421 else
1422 chars = snprintf(buf, len,
1423 ocfs2_system_inodes[type].si_name,
1424 slot);
1425
1426 return chars;
1427}
1428
1429static inline void ocfs2_set_de_type(struct ocfs2_dir_entry *de,
1430 umode_t mode)
1431{
1432 de->file_type = ocfs2_type_by_mode[(mode & S_IFMT)>>S_SHIFT];
1433}
1434
1435#endif /* _OCFS2_FS_H */
1436