2 * Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
3 * Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved.
5 * This copyrighted material is made available to anyone wishing to use,
6 * modify, copy, or redistribute it subject to the terms and conditions
7 * of the GNU General Public License v.2.
10 #ifndef __GFS2_ONDISK_DOT_H__
11 #define __GFS2_ONDISK_DOT_H__
13 #include <linux/types.h>
15 #define GFS2_MAGIC 0x01161970
16 #define GFS2_BASIC_BLOCK 512
17 #define GFS2_BASIC_BLOCK_SHIFT 9
19 /* Lock numbers of the LM_TYPE_NONDISK type */
21 #define GFS2_MOUNT_LOCK 0
22 #define GFS2_LIVE_LOCK 1
23 #define GFS2_TRANS_LOCK 2
24 #define GFS2_RENAME_LOCK 3
25 #define GFS2_CONTROL_LOCK 4
26 #define GFS2_MOUNTED_LOCK 5
28 /* Format numbers for various metadata types */
30 #define GFS2_FORMAT_NONE 0
31 #define GFS2_FORMAT_SB 100
32 #define GFS2_FORMAT_RG 200
33 #define GFS2_FORMAT_RB 300
34 #define GFS2_FORMAT_DI 400
35 #define GFS2_FORMAT_IN 500
36 #define GFS2_FORMAT_LF 600
37 #define GFS2_FORMAT_JD 700
38 #define GFS2_FORMAT_LH 800
39 #define GFS2_FORMAT_LD 900
40 #define GFS2_FORMAT_LB 1000
41 #define GFS2_FORMAT_EA 1600
42 #define GFS2_FORMAT_ED 1700
43 #define GFS2_FORMAT_QC 1400
44 /* These are format numbers for entities contained in files */
45 #define GFS2_FORMAT_RI 1100
46 #define GFS2_FORMAT_DE 1200
47 #define GFS2_FORMAT_QU 1500
48 /* These are part of the superblock */
49 #define GFS2_FORMAT_FS 1801
50 #define GFS2_FORMAT_MULTI 1900
53 * An on-disk inode number
62 * Generic metadata head structure
63 * Every inplace buffer logged in the journal must start with this.
66 #define GFS2_METATYPE_NONE 0
67 #define GFS2_METATYPE_SB 1
68 #define GFS2_METATYPE_RG 2
69 #define GFS2_METATYPE_RB 3
70 #define GFS2_METATYPE_DI 4
71 #define GFS2_METATYPE_IN 5
72 #define GFS2_METATYPE_LF 6
73 #define GFS2_METATYPE_JD 7
74 #define GFS2_METATYPE_LH 8
75 #define GFS2_METATYPE_LD 9
76 #define GFS2_METATYPE_LB 12
77 #define GFS2_METATYPE_EA 10
78 #define GFS2_METATYPE_ED 11
79 #define GFS2_METATYPE_QC 14
81 struct gfs2_meta_header {
84 __be64 __pad0; /* Was generation number in gfs1 */
86 /* This union is to keep userspace happy */
88 __be32 mh_jid; /* Was incarnation number in gfs1 */
94 * super-block structure
96 * It's probably good if SIZEOF_SB <= GFS2_BASIC_BLOCK (512 bytes)
98 * Order is important, need to be able to read old superblocks to do on-disk
102 /* Address of superblock in GFS2 basic blocks */
103 #define GFS2_SB_ADDR 128
105 /* The lock number for the superblock (must be zero) */
106 #define GFS2_SB_LOCK 0
108 /* Requirement: GFS2_LOCKNAME_LEN % 8 == 0
109 Includes: the fencing zero at the end */
110 #define GFS2_LOCKNAME_LEN 64
113 struct gfs2_meta_header sb_header;
116 __be32 sb_multihost_format;
117 __u32 __pad0; /* Was superblock flags in gfs1 */
120 __be32 sb_bsize_shift;
121 __u32 __pad1; /* Was journal segment size in gfs1 */
123 struct gfs2_inum sb_master_dir; /* Was jindex dinode in gfs1 */
124 struct gfs2_inum __pad2; /* Was rindex dinode in gfs1 */
125 struct gfs2_inum sb_root_dir;
127 char sb_lockproto[GFS2_LOCKNAME_LEN];
128 char sb_locktable[GFS2_LOCKNAME_LEN];
130 struct gfs2_inum __pad3; /* Was quota inode in gfs1 */
131 struct gfs2_inum __pad4; /* Was licence inode in gfs1 */
132 #define GFS2_HAS_UUID 1
133 __u8 sb_uuid[16]; /* The UUID, maybe 0 for backwards compat */
137 * resource index structure
141 __be64 ri_addr; /* grp block disk address */
142 __be32 ri_length; /* length of rgrp header in fs blocks */
145 __be64 ri_data0; /* first data location */
146 __be32 ri_data; /* num of data blocks in rgrp */
148 __be32 ri_bitbytes; /* number of bytes in data bitmaps */
150 __u8 ri_reserved[64];
154 * resource group header structure
157 /* Number of blocks per byte in rgrp */
159 #define GFS2_BIT_SIZE 2
160 #define GFS2_BIT_MASK 0x00000003
162 #define GFS2_BLKST_FREE 0
163 #define GFS2_BLKST_USED 1
164 #define GFS2_BLKST_UNLINKED 2
165 #define GFS2_BLKST_DINODE 3
167 #define GFS2_RGF_JOURNAL 0x00000001
168 #define GFS2_RGF_METAONLY 0x00000002
169 #define GFS2_RGF_DATAONLY 0x00000004
170 #define GFS2_RGF_NOALLOC 0x00000008
171 #define GFS2_RGF_TRIMMED 0x00000010
173 struct gfs2_rgrp_lvb {
178 __be64 rl_igeneration;
184 struct gfs2_meta_header rg_header;
190 __be64 rg_igeneration;
192 __u8 rg_reserved[80]; /* Several fields from gfs1 now reserved */
203 __u8 qu_reserved[64];
210 #define GFS2_MAX_META_HEIGHT 10
211 #define GFS2_DIR_MAX_DEPTH 17
213 #define DT2IF(dt) (((dt) << 12) & S_IFMT)
214 #define IF2DT(sif) (((sif) & S_IFMT) >> 12)
220 gfs2fl_EaIndirect = 3,
222 gfs2fl_Immutable = 5,
223 gfs2fl_AppendOnly = 6,
227 gfs2fl_TopLevel = 10,
228 gfs2fl_TruncInProg = 29,
229 gfs2fl_InheritDirectio = 30,
230 gfs2fl_InheritJdata = 31,
234 #define GFS2_DIF_JDATA 0x00000001
235 #define GFS2_DIF_EXHASH 0x00000002
236 #define GFS2_DIF_UNUSED 0x00000004 /* only in gfs1 */
237 #define GFS2_DIF_EA_INDIRECT 0x00000008
238 #define GFS2_DIF_DIRECTIO 0x00000010
239 #define GFS2_DIF_IMMUTABLE 0x00000020
240 #define GFS2_DIF_APPENDONLY 0x00000040
241 #define GFS2_DIF_NOATIME 0x00000080
242 #define GFS2_DIF_SYNC 0x00000100
243 #define GFS2_DIF_SYSTEM 0x00000200 /* New in gfs2 */
244 #define GFS2_DIF_TOPDIR 0x00000400 /* New in gfs2 */
245 #define GFS2_DIF_TRUNC_IN_PROG 0x20000000 /* New in gfs2 */
246 #define GFS2_DIF_INHERIT_DIRECTIO 0x40000000 /* only in gfs1 */
247 #define GFS2_DIF_INHERIT_JDATA 0x80000000
250 struct gfs2_meta_header di_header;
252 struct gfs2_inum di_num;
254 __be32 di_mode; /* mode of file */
255 __be32 di_uid; /* owner's user id */
256 __be32 di_gid; /* owner's group id */
257 __be32 di_nlink; /* number of links to this file */
258 __be64 di_size; /* number of bytes in file */
259 __be64 di_blocks; /* number of blocks in file */
260 __be64 di_atime; /* time last accessed */
261 __be64 di_mtime; /* time last modified */
262 __be64 di_ctime; /* time last changed */
263 __be32 di_major; /* device major number */
264 __be32 di_minor; /* device minor number */
266 /* This section varies from gfs1. Padding added to align with
267 * remainder of dinode
269 __be64 di_goal_meta; /* rgrp to alloc from next */
270 __be64 di_goal_data; /* data block goal */
271 __be64 di_generation; /* generation number for NFS */
273 __be32 di_flags; /* GFS2_DIF_... */
274 __be32 di_payload_format; /* GFS2_FORMAT_... */
275 __u16 __pad1; /* Was ditype in gfs1 */
276 __be16 di_height; /* height of metadata */
277 __u32 __pad2; /* Unused incarnation number from gfs1 */
279 /* These only apply to directories */
280 __u16 __pad3; /* Padding */
281 __be16 di_depth; /* Number of bits in the table */
282 __be32 di_entries; /* The number of entries in the directory */
284 struct gfs2_inum __pad4; /* Unused even in current gfs1 */
286 __be64 di_eattr; /* extended attribute block number */
287 __be32 di_atime_nsec; /* nsec portion of atime */
288 __be32 di_mtime_nsec; /* nsec portion of mtime */
289 __be32 di_ctime_nsec; /* nsec portion of ctime */
291 __u8 di_reserved[44];
295 * directory structure - many of these per directory file
298 #define GFS2_FNAMESIZE 255
299 #define GFS2_DIRENT_SIZE(name_len) ((sizeof(struct gfs2_dirent) + (name_len) + 7) & ~7)
302 struct gfs2_inum de_inum;
311 * Header of leaf directory nodes
315 struct gfs2_meta_header lf_header;
317 __be16 lf_depth; /* Depth of leaf */
318 __be16 lf_entries; /* Number of dirents in leaf */
319 __be32 lf_dirent_format; /* Format of the dirents */
320 __be64 lf_next; /* Next leaf, if overflow */
322 __u8 lf_reserved[64];
326 * Extended attribute header format
328 * This works in a similar way to dirents. There is a fixed size header
329 * followed by a variable length section made up of the name and the
330 * associated data. In the case of a "stuffed" entry, the value is
331 * __inline__ directly after the name, the ea_num_ptrs entry will be
332 * zero in that case. For non-"stuffed" entries, there will be
333 * a set of pointers (aligned to 8 byte boundary) to the block(s)
334 * containing the value.
336 * The blocks containing the values and the blocks containing the
337 * extended attribute headers themselves all start with the common
338 * metadata header. Each inode, if it has extended attributes, will
339 * have either a single block containing the extended attribute headers
340 * or a single indirect block pointing to blocks containing the
341 * extended attribure headers.
343 * The maximim size of the data part of an extended attribute is 64k
344 * so the number of blocks required depends upon block size. Since the
345 * block size also determines the number of pointers in an indirect
346 * block, its a fairly complicated calculation to work out the maximum
347 * number of blocks that an inode may have relating to extended attributes.
351 #define GFS2_EA_MAX_NAME_LEN 255
352 #define GFS2_EA_MAX_DATA_LEN 65536
354 #define GFS2_EATYPE_UNUSED 0
355 #define GFS2_EATYPE_USR 1
356 #define GFS2_EATYPE_SYS 2
357 #define GFS2_EATYPE_SECURITY 3
359 #define GFS2_EATYPE_LAST 3
360 #define GFS2_EATYPE_VALID(x) ((x) <= GFS2_EATYPE_LAST)
362 #define GFS2_EAFLAG_LAST 0x01 /* last ea in block */
364 struct gfs2_ea_header {
367 __u8 ea_name_len; /* no NULL pointer after the string */
368 __u8 ea_type; /* GFS2_EATYPE_... */
369 __u8 ea_flags; /* GFS2_EAFLAG_... */
375 * Log header structure
378 #define GFS2_LOG_HEAD_UNMOUNT 0x00000001 /* log is clean */
380 struct gfs2_log_header {
381 struct gfs2_meta_header lh_header;
383 __be64 lh_sequence; /* Sequence number of this transaction */
384 __be32 lh_flags; /* GFS2_LOG_HEAD_... */
385 __be32 lh_tail; /* Block number of log tail */
391 * Log type descriptor
394 #define GFS2_LOG_DESC_METADATA 300
395 /* ld_data1 is the number of metadata blocks in the descriptor.
396 ld_data2 is unused. */
398 #define GFS2_LOG_DESC_REVOKE 301
399 /* ld_data1 is the number of revoke blocks in the descriptor.
400 ld_data2 is unused. */
402 #define GFS2_LOG_DESC_JDATA 302
403 /* ld_data1 is the number of data blocks in the descriptor.
404 ld_data2 is unused. */
406 struct gfs2_log_descriptor {
407 struct gfs2_meta_header ld_header;
409 __be32 ld_type; /* GFS2_LOG_DESC_... */
410 __be32 ld_length; /* Number of buffers in this chunk */
411 __be32 ld_data1; /* descriptor-specific field */
412 __be32 ld_data2; /* descriptor-specific field */
414 __u8 ld_reserved[32];
419 * Describe a range of formal inode numbers allocated to
420 * one machine to assign to inodes.
423 #define GFS2_INUM_QUANTUM 1048576
425 struct gfs2_inum_range {
432 * Describes an change to the pool of free and allocated
436 struct gfs2_statfs_change {
444 * Describes an allocation change for a particular
448 #define GFS2_QCF_USER 0x00000001
450 struct gfs2_quota_change {
452 __be32 qc_flags; /* GFS2_QCF_... */
456 struct gfs2_quota_lvb {
459 __be64 qb_limit; /* Hard limit of # blocks to alloc */
460 __be64 qb_warn; /* Warn user when alloc is above this # */
461 __be64 qb_value; /* Current # blocks allocated */
464 #endif /* __GFS2_ONDISK_DOT_H__ */