2 * Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
3 * Copyright (C) 2004-2005 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 #define GFS2_MAGIC 0x01161970
14 #define GFS2_BASIC_BLOCK 512
15 #define GFS2_BASIC_BLOCK_SHIFT 9
17 /* Lock numbers of the LM_TYPE_NONDISK type */
19 #define GFS2_MOUNT_LOCK 0
20 #define GFS2_LIVE_LOCK 1
21 #define GFS2_TRANS_LOCK 2
22 #define GFS2_RENAME_LOCK 3
24 /* Format numbers for various metadata types */
26 #define GFS2_FORMAT_NONE 0
27 #define GFS2_FORMAT_SB 100
28 #define GFS2_FORMAT_RG 200
29 #define GFS2_FORMAT_RB 300
30 #define GFS2_FORMAT_DI 400
31 #define GFS2_FORMAT_IN 500
32 #define GFS2_FORMAT_LF 600
33 #define GFS2_FORMAT_JD 700
34 #define GFS2_FORMAT_LH 800
35 #define GFS2_FORMAT_LD 900
36 #define GFS2_FORMAT_LB 1000
37 #define GFS2_FORMAT_EA 1600
38 #define GFS2_FORMAT_ED 1700
39 #define GFS2_FORMAT_UT 1300
40 #define GFS2_FORMAT_QC 1400
41 /* These are format numbers for entities contained in files */
42 #define GFS2_FORMAT_RI 1100
43 #define GFS2_FORMAT_DE 1200
44 #define GFS2_FORMAT_QU 1500
45 /* These are part of the superblock */
46 #define GFS2_FORMAT_FS 1801
47 #define GFS2_FORMAT_MULTI 1900
50 * An on-disk inode number
58 static inline int gfs2_inum_equal(const struct gfs2_inum *ino1,
59 const struct gfs2_inum *ino2)
61 return ino1->no_formal_ino == ino2->no_formal_ino &&
62 ino1->no_addr == ino2->no_addr;
66 * Generic metadata head structure
67 * Every inplace buffer logged in the journal must start with this.
70 #define GFS2_METATYPE_NONE 0
71 #define GFS2_METATYPE_SB 1
72 #define GFS2_METATYPE_RG 2
73 #define GFS2_METATYPE_RB 3
74 #define GFS2_METATYPE_DI 4
75 #define GFS2_METATYPE_IN 5
76 #define GFS2_METATYPE_LF 6
77 #define GFS2_METATYPE_JD 7
78 #define GFS2_METATYPE_LH 8
79 #define GFS2_METATYPE_LD 9
80 #define GFS2_METATYPE_LB 12
81 #define GFS2_METATYPE_EA 10
82 #define GFS2_METATYPE_ED 11
83 #define GFS2_METATYPE_UT 13
84 #define GFS2_METATYPE_QC 14
86 struct gfs2_meta_header {
89 __be64 __pad0; /* Was generation number in gfs1 */
91 __be32 __pad1; /* Was incarnation number in gfs1 */
95 * super-block structure
97 * It's probably good if SIZEOF_SB <= GFS2_BASIC_BLOCK (512 bytes)
99 * Order is important, need to be able to read old superblocks to do on-disk
103 /* Address of superblock in GFS2 basic blocks */
104 #define GFS2_SB_ADDR 128
106 /* The lock number for the superblock (must be zero) */
107 #define GFS2_SB_LOCK 0
109 /* Requirement: GFS2_LOCKNAME_LEN % 8 == 0
110 Includes: the fencing zero at the end */
111 #define GFS2_LOCKNAME_LEN 64
114 struct gfs2_meta_header sb_header;
117 __be32 sb_multihost_format;
118 __u32 __pad0; /* Was superblock flags in gfs1 */
121 __be32 sb_bsize_shift;
122 __u32 __pad1; /* Was journal segment size in gfs1 */
124 struct gfs2_inum sb_master_dir; /* Was jindex dinode in gfs1 */
125 struct gfs2_inum __pad2; /* Was rindex dinode in gfs1 */
126 struct gfs2_inum sb_root_dir;
128 char sb_lockproto[GFS2_LOCKNAME_LEN];
129 char sb_locktable[GFS2_LOCKNAME_LEN];
130 /* In gfs1, quota and license dinodes followed */
134 * resource index structure
138 __be64 ri_addr; /* grp block disk address */
139 __be32 ri_length; /* length of rgrp header in fs blocks */
142 __be64 ri_data0; /* first data location */
143 __be32 ri_data; /* num of data blocks in rgrp */
145 __be32 ri_bitbytes; /* number of bytes in data bitmaps */
147 __u8 ri_reserved[64];
151 * resource group header structure
154 /* Number of blocks per byte in rgrp */
156 #define GFS2_BIT_SIZE 2
157 #define GFS2_BIT_MASK 0x00000003
159 #define GFS2_BLKST_FREE 0
160 #define GFS2_BLKST_USED 1
161 #define GFS2_BLKST_INVALID 2
162 #define GFS2_BLKST_DINODE 3
164 #define GFS2_RGF_JOURNAL 0x00000001
165 #define GFS2_RGF_METAONLY 0x00000002
166 #define GFS2_RGF_DATAONLY 0x00000004
167 #define GFS2_RGF_NOALLOC 0x00000008
170 struct gfs2_meta_header rg_header;
176 __u8 rg_reserved[92]; /* Several fields from gfs1 now reserved */
187 __u8 qu_reserved[64];
194 #define GFS2_MAX_META_HEIGHT 10
195 #define GFS2_DIR_MAX_DEPTH 17
197 #define DT2IF(dt) (((dt) << 12) & S_IFMT)
198 #define IF2DT(sif) (((sif) & S_IFMT) >> 12)
201 #define GFS2_DIF_JDATA 0x00000001
202 #define GFS2_DIF_EXHASH 0x00000002
203 #define GFS2_DIF_UNUSED 0x00000004 /* only in gfs1 */
204 #define GFS2_DIF_EA_INDIRECT 0x00000008
205 #define GFS2_DIF_DIRECTIO 0x00000010
206 #define GFS2_DIF_IMMUTABLE 0x00000020
207 #define GFS2_DIF_APPENDONLY 0x00000040
208 #define GFS2_DIF_NOATIME 0x00000080
209 #define GFS2_DIF_SYNC 0x00000100
210 #define GFS2_DIF_SYSTEM 0x00000200 /* New in gfs2 */
211 #define GFS2_DIF_TRUNC_IN_PROG 0x20000000 /* New in gfs2 */
212 #define GFS2_DIF_INHERIT_DIRECTIO 0x40000000
213 #define GFS2_DIF_INHERIT_JDATA 0x80000000
216 struct gfs2_meta_header di_header;
218 struct gfs2_inum di_num;
220 __be32 di_mode; /* mode of file */
221 __be32 di_uid; /* owner's user id */
222 __be32 di_gid; /* owner's group id */
223 __be32 di_nlink; /* number of links to this file */
224 __be64 di_size; /* number of bytes in file */
225 __be64 di_blocks; /* number of blocks in file */
226 __be64 di_atime; /* time last accessed */
227 __be64 di_mtime; /* time last modified */
228 __be64 di_ctime; /* time last changed */
229 __be32 di_major; /* device major number */
230 __be32 di_minor; /* device minor number */
232 /* This section varies from gfs1. Padding added to align with
233 * remainder of dinode
235 __be64 di_goal_meta; /* rgrp to alloc from next */
236 __be64 di_goal_data; /* data block goal */
239 __be32 di_flags; /* GFS2_DIF_... */
240 __be32 di_payload_format; /* GFS2_FORMAT_... */
241 __u16 __pad1; /* Was ditype in gfs1 */
242 __be16 di_height; /* height of metadata */
243 __u32 __pad2; /* Unused incarnation number from gfs1 */
245 /* These only apply to directories */
246 __u16 __pad3; /* Padding */
247 __be16 di_depth; /* Number of bits in the table */
248 __be32 di_entries; /* The number of entries in the directory */
250 struct gfs2_inum __pad4; /* Unused even in current gfs1 */
252 __be64 di_eattr; /* extended attribute block number */
254 __u8 di_reserved[56];
258 * directory structure - many of these per directory file
261 #define GFS2_FNAMESIZE 255
262 #define GFS2_DIRENT_SIZE(name_len) ((sizeof(struct gfs2_dirent) + (name_len) + 7) & ~7)
265 struct gfs2_inum de_inum;
274 * Header of leaf directory nodes
278 struct gfs2_meta_header lf_header;
280 __be16 lf_depth; /* Depth of leaf */
281 __be16 lf_entries; /* Number of dirents in leaf */
282 __be32 lf_dirent_format; /* Format of the dirents */
283 __be64 lf_next; /* Next leaf, if overflow */
285 __u8 lf_reserved[64];
289 * Extended attribute header format
292 #define GFS2_EA_MAX_NAME_LEN 255
293 #define GFS2_EA_MAX_DATA_LEN 65536
295 #define GFS2_EATYPE_UNUSED 0
296 #define GFS2_EATYPE_USR 1
297 #define GFS2_EATYPE_SYS 2
299 #define GFS2_EATYPE_LAST 2
300 #define GFS2_EATYPE_VALID(x) ((x) <= GFS2_EATYPE_LAST)
302 #define GFS2_EAFLAG_LAST 0x01 /* last ea in block */
304 struct gfs2_ea_header {
307 __u8 ea_name_len; /* no NULL pointer after the string */
308 __u8 ea_type; /* GFS2_EATYPE_... */
309 __u8 ea_flags; /* GFS2_EAFLAG_... */
315 * Log header structure
318 #define GFS2_LOG_HEAD_UNMOUNT 0x00000001 /* log is clean */
320 struct gfs2_log_header {
321 struct gfs2_meta_header lh_header;
323 __be64 lh_sequence; /* Sequence number of this transaction */
324 __be32 lh_flags; /* GFS2_LOG_HEAD_... */
325 __be32 lh_tail; /* Block number of log tail */
331 * Log type descriptor
334 #define GFS2_LOG_DESC_METADATA 300
335 /* ld_data1 is the number of metadata blocks in the descriptor.
336 ld_data2 is unused. */
338 #define GFS2_LOG_DESC_REVOKE 301
339 /* ld_data1 is the number of revoke blocks in the descriptor.
340 ld_data2 is unused. */
342 #define GFS2_LOG_DESC_JDATA 302
343 /* ld_data1 is the number of data blocks in the descriptor.
344 ld_data2 is unused. */
346 struct gfs2_log_descriptor {
347 struct gfs2_meta_header ld_header;
349 __be32 ld_type; /* GFS2_LOG_DESC_... */
350 __be32 ld_length; /* Number of buffers in this chunk */
351 __be32 ld_data1; /* descriptor-specific field */
352 __be32 ld_data2; /* descriptor-specific field */
354 __u8 ld_reserved[32];
359 * Describe a range of formal inode numbers allocated to
360 * one machine to assign to inodes.
363 #define GFS2_INUM_QUANTUM 1048576
365 struct gfs2_inum_range {
372 * Describes an change to the pool of free and allocated
376 struct gfs2_statfs_change {
384 * Describes an allocated inode that isn't linked into
385 * the directory tree and might need to be deallocated.
388 #define GFS2_UTF_UNINIT 0x00000001
390 struct gfs2_unlinked_tag {
391 struct gfs2_inum ut_inum;
392 __be32 ut_flags; /* GFS2_UTF_... */
398 * Describes an allocation change for a particular
402 #define GFS2_QCF_USER 0x00000001
404 struct gfs2_quota_change {
406 __be32 qc_flags; /* GFS2_QCF_... */
411 /* Translation functions */
413 extern void gfs2_inum_in(struct gfs2_inum *no, char *buf);
414 extern void gfs2_inum_out(struct gfs2_inum *no, char *buf);
415 extern void gfs2_sb_in(struct gfs2_sb *sb, char *buf);
416 extern void gfs2_rindex_in(struct gfs2_rindex *ri, char *buf);
417 extern void gfs2_rindex_out(struct gfs2_rindex *ri, char *buf);
418 extern void gfs2_rgrp_in(struct gfs2_rgrp *rg, char *buf);
419 extern void gfs2_rgrp_out(struct gfs2_rgrp *rg, char *buf);
420 extern void gfs2_quota_in(struct gfs2_quota *qu, char *buf);
421 extern void gfs2_quota_out(struct gfs2_quota *qu, char *buf);
422 extern void gfs2_dinode_in(struct gfs2_dinode *di, char *buf);
423 extern void gfs2_dinode_out(struct gfs2_dinode *di, char *buf);
424 extern void gfs2_leaf_in(struct gfs2_leaf *lf, char *buf);
425 extern void gfs2_ea_header_in(struct gfs2_ea_header *ea, char *buf);
426 extern void gfs2_ea_header_out(struct gfs2_ea_header *ea, char *buf);
427 extern void gfs2_log_header_in(struct gfs2_log_header *lh, char *buf);
428 extern void gfs2_inum_range_in(struct gfs2_inum_range *ir, char *buf);
429 extern void gfs2_inum_range_out(struct gfs2_inum_range *ir, char *buf);
430 extern void gfs2_statfs_change_in(struct gfs2_statfs_change *sc, char *buf);
431 extern void gfs2_statfs_change_out(struct gfs2_statfs_change *sc, char *buf);
432 extern void gfs2_unlinked_tag_in(struct gfs2_unlinked_tag *ut, char *buf);
433 extern void gfs2_unlinked_tag_out(struct gfs2_unlinked_tag *ut, char *buf);
434 extern void gfs2_quota_change_in(struct gfs2_quota_change *qc, char *buf);
436 /* Printing functions */
438 extern void gfs2_inum_print(struct gfs2_inum *no);
439 extern void gfs2_meta_header_print(struct gfs2_meta_header *mh);
440 extern void gfs2_sb_print(struct gfs2_sb *sb);
441 extern void gfs2_rindex_print(struct gfs2_rindex *ri);
442 extern void gfs2_rgrp_print(struct gfs2_rgrp *rg);
443 extern void gfs2_quota_print(struct gfs2_quota *qu);
444 extern void gfs2_dinode_print(struct gfs2_dinode *di);
445 extern void gfs2_dirent_print(struct gfs2_dirent *de, char *name);
446 extern void gfs2_leaf_print(struct gfs2_leaf *lf);
447 extern void gfs2_ea_header_print(struct gfs2_ea_header *ea, char *name);
448 extern void gfs2_log_header_print(struct gfs2_log_header *lh);
449 extern void gfs2_log_descriptor_print(struct gfs2_log_descriptor *ld);
450 extern void gfs2_inum_range_print(struct gfs2_inum_range *ir);
451 extern void gfs2_statfs_change_print(struct gfs2_statfs_change *sc);
452 extern void gfs2_unlinked_tag_print(struct gfs2_unlinked_tag *ut);
453 extern void gfs2_quota_change_print(struct gfs2_quota_change *qc);
455 #endif /* __KERNEL__ */
457 #endif /* __GFS2_ONDISK_DOT_H__ */