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 #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_QC 1400
40 /* These are format numbers for entities contained in files */
41 #define GFS2_FORMAT_RI 1100
42 #define GFS2_FORMAT_DE 1200
43 #define GFS2_FORMAT_QU 1500
44 /* These are part of the superblock */
45 #define GFS2_FORMAT_FS 1801
46 #define GFS2_FORMAT_MULTI 1900
49 * An on-disk inode number
57 static inline int gfs2_inum_equal(const struct gfs2_inum *ino1,
58 const struct gfs2_inum *ino2)
60 return ino1->no_formal_ino == ino2->no_formal_ino &&
61 ino1->no_addr == ino2->no_addr;
65 * Generic metadata head structure
66 * Every inplace buffer logged in the journal must start with this.
69 #define GFS2_METATYPE_NONE 0
70 #define GFS2_METATYPE_SB 1
71 #define GFS2_METATYPE_RG 2
72 #define GFS2_METATYPE_RB 3
73 #define GFS2_METATYPE_DI 4
74 #define GFS2_METATYPE_IN 5
75 #define GFS2_METATYPE_LF 6
76 #define GFS2_METATYPE_JD 7
77 #define GFS2_METATYPE_LH 8
78 #define GFS2_METATYPE_LD 9
79 #define GFS2_METATYPE_LB 12
80 #define GFS2_METATYPE_EA 10
81 #define GFS2_METATYPE_ED 11
82 #define GFS2_METATYPE_QC 14
84 struct gfs2_meta_header {
87 __be64 __pad0; /* Was generation number in gfs1 */
89 __be32 __pad1; /* Was incarnation number in gfs1 */
92 struct gfs2_meta_header_host {
99 * super-block structure
101 * It's probably good if SIZEOF_SB <= GFS2_BASIC_BLOCK (512 bytes)
103 * Order is important, need to be able to read old superblocks to do on-disk
107 /* Address of superblock in GFS2 basic blocks */
108 #define GFS2_SB_ADDR 128
110 /* The lock number for the superblock (must be zero) */
111 #define GFS2_SB_LOCK 0
113 /* Requirement: GFS2_LOCKNAME_LEN % 8 == 0
114 Includes: the fencing zero at the end */
115 #define GFS2_LOCKNAME_LEN 64
118 struct gfs2_meta_header sb_header;
121 __be32 sb_multihost_format;
122 __u32 __pad0; /* Was superblock flags in gfs1 */
125 __be32 sb_bsize_shift;
126 __u32 __pad1; /* Was journal segment size in gfs1 */
128 struct gfs2_inum sb_master_dir; /* Was jindex dinode in gfs1 */
129 struct gfs2_inum __pad2; /* Was rindex dinode in gfs1 */
130 struct gfs2_inum sb_root_dir;
132 char sb_lockproto[GFS2_LOCKNAME_LEN];
133 char sb_locktable[GFS2_LOCKNAME_LEN];
134 /* In gfs1, quota and license dinodes followed */
137 struct gfs2_sb_host {
138 struct gfs2_meta_header_host sb_header;
141 __u32 sb_multihost_format;
144 __u32 sb_bsize_shift;
146 struct gfs2_inum sb_master_dir; /* Was jindex dinode in gfs1 */
147 struct gfs2_inum sb_root_dir;
149 char sb_lockproto[GFS2_LOCKNAME_LEN];
150 char sb_locktable[GFS2_LOCKNAME_LEN];
151 /* In gfs1, quota and license dinodes followed */
155 * resource index structure
159 __be64 ri_addr; /* grp block disk address */
160 __be32 ri_length; /* length of rgrp header in fs blocks */
163 __be64 ri_data0; /* first data location */
164 __be32 ri_data; /* num of data blocks in rgrp */
166 __be32 ri_bitbytes; /* number of bytes in data bitmaps */
168 __u8 ri_reserved[64];
172 * resource group header structure
175 /* Number of blocks per byte in rgrp */
177 #define GFS2_BIT_SIZE 2
178 #define GFS2_BIT_MASK 0x00000003
180 #define GFS2_BLKST_FREE 0
181 #define GFS2_BLKST_USED 1
182 #define GFS2_BLKST_UNLINKED 2
183 #define GFS2_BLKST_DINODE 3
185 #define GFS2_RGF_JOURNAL 0x00000001
186 #define GFS2_RGF_METAONLY 0x00000002
187 #define GFS2_RGF_DATAONLY 0x00000004
188 #define GFS2_RGF_NOALLOC 0x00000008
191 struct gfs2_meta_header rg_header;
197 __be64 rg_igeneration;
199 __u8 rg_reserved[80]; /* Several fields from gfs1 now reserved */
202 struct gfs2_rgrp_host {
203 struct gfs2_meta_header_host rg_header;
208 __u64 rg_igeneration;
219 __u8 qu_reserved[64];
226 #define GFS2_MAX_META_HEIGHT 10
227 #define GFS2_DIR_MAX_DEPTH 17
229 #define DT2IF(dt) (((dt) << 12) & S_IFMT)
230 #define IF2DT(sif) (((sif) & S_IFMT) >> 12)
236 gfs2fl_EaIndirect = 3,
238 gfs2fl_Immutable = 5,
239 gfs2fl_AppendOnly = 6,
243 gfs2fl_TruncInProg = 29,
244 gfs2fl_InheritDirectio = 30,
245 gfs2fl_InheritJdata = 31,
249 #define GFS2_DIF_JDATA 0x00000001
250 #define GFS2_DIF_EXHASH 0x00000002
251 #define GFS2_DIF_UNUSED 0x00000004 /* only in gfs1 */
252 #define GFS2_DIF_EA_INDIRECT 0x00000008
253 #define GFS2_DIF_DIRECTIO 0x00000010
254 #define GFS2_DIF_IMMUTABLE 0x00000020
255 #define GFS2_DIF_APPENDONLY 0x00000040
256 #define GFS2_DIF_NOATIME 0x00000080
257 #define GFS2_DIF_SYNC 0x00000100
258 #define GFS2_DIF_SYSTEM 0x00000200 /* New in gfs2 */
259 #define GFS2_DIF_TRUNC_IN_PROG 0x20000000 /* New in gfs2 */
260 #define GFS2_DIF_INHERIT_DIRECTIO 0x40000000
261 #define GFS2_DIF_INHERIT_JDATA 0x80000000
264 struct gfs2_meta_header di_header;
266 struct gfs2_inum di_num;
268 __be32 di_mode; /* mode of file */
269 __be32 di_uid; /* owner's user id */
270 __be32 di_gid; /* owner's group id */
271 __be32 di_nlink; /* number of links to this file */
272 __be64 di_size; /* number of bytes in file */
273 __be64 di_blocks; /* number of blocks in file */
274 __be64 di_atime; /* time last accessed */
275 __be64 di_mtime; /* time last modified */
276 __be64 di_ctime; /* time last changed */
277 __be32 di_major; /* device major number */
278 __be32 di_minor; /* device minor number */
280 /* This section varies from gfs1. Padding added to align with
281 * remainder of dinode
283 __be64 di_goal_meta; /* rgrp to alloc from next */
284 __be64 di_goal_data; /* data block goal */
285 __be64 di_generation; /* generation number for NFS */
287 __be32 di_flags; /* GFS2_DIF_... */
288 __be32 di_payload_format; /* GFS2_FORMAT_... */
289 __u16 __pad1; /* Was ditype in gfs1 */
290 __be16 di_height; /* height of metadata */
291 __u32 __pad2; /* Unused incarnation number from gfs1 */
293 /* These only apply to directories */
294 __u16 __pad3; /* Padding */
295 __be16 di_depth; /* Number of bits in the table */
296 __be32 di_entries; /* The number of entries in the directory */
298 struct gfs2_inum __pad4; /* Unused even in current gfs1 */
300 __be64 di_eattr; /* extended attribute block number */
302 __u8 di_reserved[56];
305 struct gfs2_dinode_host {
306 struct gfs2_meta_header_host di_header;
308 struct gfs2_inum di_num;
310 __u32 di_mode; /* mode of file */
311 __u32 di_uid; /* owner's user id */
312 __u32 di_gid; /* owner's group id */
313 __u32 di_nlink; /* number of links to this file */
314 __u64 di_size; /* number of bytes in file */
315 __u64 di_blocks; /* number of blocks in file */
316 __u64 di_atime; /* time last accessed */
317 __u64 di_mtime; /* time last modified */
318 __u64 di_ctime; /* time last changed */
319 __u32 di_major; /* device major number */
320 __u32 di_minor; /* device minor number */
322 /* This section varies from gfs1. Padding added to align with
323 * remainder of dinode
325 __u64 di_goal_meta; /* rgrp to alloc from next */
326 __u64 di_goal_data; /* data block goal */
327 __u64 di_generation; /* generation number for NFS */
329 __u32 di_flags; /* GFS2_DIF_... */
330 __u32 di_payload_format; /* GFS2_FORMAT_... */
331 __u16 di_height; /* height of metadata */
333 /* These only apply to directories */
334 __u16 di_depth; /* Number of bits in the table */
335 __u32 di_entries; /* The number of entries in the directory */
337 __u64 di_eattr; /* extended attribute block number */
341 * directory structure - many of these per directory file
344 #define GFS2_FNAMESIZE 255
345 #define GFS2_DIRENT_SIZE(name_len) ((sizeof(struct gfs2_dirent) + (name_len) + 7) & ~7)
348 struct gfs2_inum de_inum;
357 * Header of leaf directory nodes
361 struct gfs2_meta_header lf_header;
363 __be16 lf_depth; /* Depth of leaf */
364 __be16 lf_entries; /* Number of dirents in leaf */
365 __be32 lf_dirent_format; /* Format of the dirents */
366 __be64 lf_next; /* Next leaf, if overflow */
368 __u8 lf_reserved[64];
372 * Extended attribute header format
375 #define GFS2_EA_MAX_NAME_LEN 255
376 #define GFS2_EA_MAX_DATA_LEN 65536
378 #define GFS2_EATYPE_UNUSED 0
379 #define GFS2_EATYPE_USR 1
380 #define GFS2_EATYPE_SYS 2
381 #define GFS2_EATYPE_SECURITY 3
383 #define GFS2_EATYPE_LAST 3
384 #define GFS2_EATYPE_VALID(x) ((x) <= GFS2_EATYPE_LAST)
386 #define GFS2_EAFLAG_LAST 0x01 /* last ea in block */
388 struct gfs2_ea_header {
391 __u8 ea_name_len; /* no NULL pointer after the string */
392 __u8 ea_type; /* GFS2_EATYPE_... */
393 __u8 ea_flags; /* GFS2_EAFLAG_... */
399 * Log header structure
402 #define GFS2_LOG_HEAD_UNMOUNT 0x00000001 /* log is clean */
404 struct gfs2_log_header {
405 struct gfs2_meta_header lh_header;
407 __be64 lh_sequence; /* Sequence number of this transaction */
408 __be32 lh_flags; /* GFS2_LOG_HEAD_... */
409 __be32 lh_tail; /* Block number of log tail */
414 struct gfs2_log_header_host {
415 struct gfs2_meta_header_host lh_header;
417 __u64 lh_sequence; /* Sequence number of this transaction */
418 __u32 lh_flags; /* GFS2_LOG_HEAD_... */
419 __u32 lh_tail; /* Block number of log tail */
425 * Log type descriptor
428 #define GFS2_LOG_DESC_METADATA 300
429 /* ld_data1 is the number of metadata blocks in the descriptor.
430 ld_data2 is unused. */
432 #define GFS2_LOG_DESC_REVOKE 301
433 /* ld_data1 is the number of revoke blocks in the descriptor.
434 ld_data2 is unused. */
436 #define GFS2_LOG_DESC_JDATA 302
437 /* ld_data1 is the number of data blocks in the descriptor.
438 ld_data2 is unused. */
440 struct gfs2_log_descriptor {
441 struct gfs2_meta_header ld_header;
443 __be32 ld_type; /* GFS2_LOG_DESC_... */
444 __be32 ld_length; /* Number of buffers in this chunk */
445 __be32 ld_data1; /* descriptor-specific field */
446 __be32 ld_data2; /* descriptor-specific field */
448 __u8 ld_reserved[32];
453 * Describe a range of formal inode numbers allocated to
454 * one machine to assign to inodes.
457 #define GFS2_INUM_QUANTUM 1048576
459 struct gfs2_inum_range {
464 struct gfs2_inum_range_host {
471 * Describes an change to the pool of free and allocated
475 struct gfs2_statfs_change {
483 * Describes an allocation change for a particular
487 #define GFS2_QCF_USER 0x00000001
489 struct gfs2_quota_change {
491 __be32 qc_flags; /* GFS2_QCF_... */
496 /* Translation functions */
498 extern void gfs2_inum_in(struct gfs2_inum *no, const void *buf);
499 extern void gfs2_inum_out(const struct gfs2_inum *no, void *buf);
500 extern void gfs2_sb_in(struct gfs2_sb_host *sb, const void *buf);
501 extern void gfs2_rindex_in(struct gfs2_rindex *ri, const void *buf);
502 extern void gfs2_rindex_out(const struct gfs2_rindex *ri, void *buf);
503 extern void gfs2_rgrp_in(struct gfs2_rgrp_host *rg, const void *buf);
504 extern void gfs2_rgrp_out(const struct gfs2_rgrp_host *rg, void *buf);
505 extern void gfs2_quota_in(struct gfs2_quota *qu, const void *buf);
506 extern void gfs2_quota_out(const struct gfs2_quota *qu, void *buf);
507 extern void gfs2_dinode_in(struct gfs2_dinode_host *di, const void *buf);
508 extern void gfs2_dinode_out(const struct gfs2_dinode_host *di, void *buf);
509 extern void gfs2_ea_header_in(struct gfs2_ea_header *ea, const void *buf);
510 extern void gfs2_ea_header_out(const struct gfs2_ea_header *ea, void *buf);
511 extern void gfs2_log_header_in(struct gfs2_log_header_host *lh, const void *buf);
512 extern void gfs2_inum_range_in(struct gfs2_inum_range_host *ir, const void *buf);
513 extern void gfs2_inum_range_out(const struct gfs2_inum_range_host *ir, void *buf);
514 extern void gfs2_statfs_change_in(struct gfs2_statfs_change *sc, const void *buf);
515 extern void gfs2_statfs_change_out(const struct gfs2_statfs_change *sc, void *buf);
516 extern void gfs2_quota_change_in(struct gfs2_quota_change *qc, const void *buf);
518 /* Printing functions */
520 extern void gfs2_rindex_print(const struct gfs2_rindex *ri);
521 extern void gfs2_dinode_print(const struct gfs2_dinode_host *di);
523 #endif /* __KERNEL__ */
525 #endif /* __GFS2_ONDISK_DOT_H__ */