1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
3 * Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
4 * Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved.
6 * This copyrighted material is made available to anyone wishing to use,
7 * modify, copy, or redistribute it subject to the terms and conditions
8 * of the GNU General Public License v.2.
11 #ifndef __GFS2_ONDISK_DOT_H__
12 #define __GFS2_ONDISK_DOT_H__
14 #include <linux/types.h>
16 #define GFS2_MAGIC 0x01161970
17 #define GFS2_BASIC_BLOCK 512
18 #define GFS2_BASIC_BLOCK_SHIFT 9
20 /* Lock numbers of the LM_TYPE_NONDISK type */
22 #define GFS2_MOUNT_LOCK 0
23 #define GFS2_LIVE_LOCK 1
24 #define GFS2_FREEZE_LOCK 2
25 #define GFS2_RENAME_LOCK 3
26 #define GFS2_CONTROL_LOCK 4
27 #define GFS2_MOUNTED_LOCK 5
29 /* Format numbers for various metadata types */
31 #define GFS2_FORMAT_NONE 0
32 #define GFS2_FORMAT_SB 100
33 #define GFS2_FORMAT_RG 200
34 #define GFS2_FORMAT_RB 300
35 #define GFS2_FORMAT_DI 400
36 #define GFS2_FORMAT_IN 500
37 #define GFS2_FORMAT_LF 600
38 #define GFS2_FORMAT_JD 700
39 #define GFS2_FORMAT_LH 800
40 #define GFS2_FORMAT_LD 900
41 #define GFS2_FORMAT_LB 1000
42 #define GFS2_FORMAT_EA 1600
43 #define GFS2_FORMAT_ED 1700
44 #define GFS2_FORMAT_QC 1400
45 /* These are format numbers for entities contained in files */
46 #define GFS2_FORMAT_RI 1100
47 #define GFS2_FORMAT_DE 1200
48 #define GFS2_FORMAT_QU 1500
49 /* These are part of the superblock */
50 #define GFS2_FORMAT_FS 1801
51 #define GFS2_FORMAT_MULTI 1900
54 * An on-disk inode number
63 * Generic metadata head structure
64 * Every inplace buffer logged in the journal must start with this.
67 #define GFS2_METATYPE_NONE 0
68 #define GFS2_METATYPE_SB 1
69 #define GFS2_METATYPE_RG 2
70 #define GFS2_METATYPE_RB 3
71 #define GFS2_METATYPE_DI 4
72 #define GFS2_METATYPE_IN 5
73 #define GFS2_METATYPE_LF 6
74 #define GFS2_METATYPE_JD 7
75 #define GFS2_METATYPE_LH 8
76 #define GFS2_METATYPE_LD 9
77 #define GFS2_METATYPE_LB 12
78 #define GFS2_METATYPE_EA 10
79 #define GFS2_METATYPE_ED 11
80 #define GFS2_METATYPE_QC 14
82 struct gfs2_meta_header {
85 __be64 __pad0; /* Was generation number in gfs1 */
87 /* This union is to keep userspace happy */
89 __be32 mh_jid; /* 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];
131 struct gfs2_inum __pad3; /* Was quota inode in gfs1 */
132 struct gfs2_inum __pad4; /* Was licence inode in gfs1 */
133 #define GFS2_HAS_UUID 1
134 __u8 sb_uuid[16]; /* The UUID, maybe 0 for backwards compat */
138 * resource index structure
142 __be64 ri_addr; /* grp block disk address */
143 __be32 ri_length; /* length of rgrp header in fs blocks */
146 __be64 ri_data0; /* first data location */
147 __be32 ri_data; /* num of data blocks in rgrp */
149 __be32 ri_bitbytes; /* number of bytes in data bitmaps */
151 __u8 ri_reserved[64];
155 * resource group header structure
158 /* Number of blocks per byte in rgrp */
160 #define GFS2_BIT_SIZE 2
161 #define GFS2_BIT_MASK 0x00000003
163 #define GFS2_BLKST_FREE 0
164 #define GFS2_BLKST_USED 1
165 #define GFS2_BLKST_UNLINKED 2
166 #define GFS2_BLKST_DINODE 3
168 #define GFS2_RGF_JOURNAL 0x00000001
169 #define GFS2_RGF_METAONLY 0x00000002
170 #define GFS2_RGF_DATAONLY 0x00000004
171 #define GFS2_RGF_NOALLOC 0x00000008
172 #define GFS2_RGF_TRIMMED 0x00000010
174 struct gfs2_rgrp_lvb {
179 __be64 rl_igeneration;
185 struct gfs2_meta_header rg_header;
191 __be64 rg_igeneration;
193 __u8 rg_reserved[80]; /* Several fields from gfs1 now reserved */
204 __u8 qu_reserved[64];
211 #define GFS2_MAX_META_HEIGHT 10
212 #define GFS2_DIR_MAX_DEPTH 17
214 #define DT2IF(dt) (((dt) << 12) & S_IFMT)
215 #define IF2DT(sif) (((sif) & S_IFMT) >> 12)
221 gfs2fl_EaIndirect = 3,
223 gfs2fl_Immutable = 5,
224 gfs2fl_AppendOnly = 6,
228 gfs2fl_TopLevel = 10,
229 gfs2fl_TruncInProg = 29,
230 gfs2fl_InheritDirectio = 30,
231 gfs2fl_InheritJdata = 31,
235 #define GFS2_DIF_JDATA 0x00000001
236 #define GFS2_DIF_EXHASH 0x00000002
237 #define GFS2_DIF_UNUSED 0x00000004 /* only in gfs1 */
238 #define GFS2_DIF_EA_INDIRECT 0x00000008
239 #define GFS2_DIF_DIRECTIO 0x00000010
240 #define GFS2_DIF_IMMUTABLE 0x00000020
241 #define GFS2_DIF_APPENDONLY 0x00000040
242 #define GFS2_DIF_NOATIME 0x00000080
243 #define GFS2_DIF_SYNC 0x00000100
244 #define GFS2_DIF_SYSTEM 0x00000200 /* New in gfs2 */
245 #define GFS2_DIF_TOPDIR 0x00000400 /* New in gfs2 */
246 #define GFS2_DIF_TRUNC_IN_PROG 0x20000000 /* New in gfs2 */
247 #define GFS2_DIF_INHERIT_DIRECTIO 0x40000000 /* only in gfs1 */
248 #define GFS2_DIF_INHERIT_JDATA 0x80000000
251 struct gfs2_meta_header di_header;
253 struct gfs2_inum di_num;
255 __be32 di_mode; /* mode of file */
256 __be32 di_uid; /* owner's user id */
257 __be32 di_gid; /* owner's group id */
258 __be32 di_nlink; /* number of links to this file */
259 __be64 di_size; /* number of bytes in file */
260 __be64 di_blocks; /* number of blocks in file */
261 __be64 di_atime; /* time last accessed */
262 __be64 di_mtime; /* time last modified */
263 __be64 di_ctime; /* time last changed */
264 __be32 di_major; /* device major number */
265 __be32 di_minor; /* device minor number */
267 /* This section varies from gfs1. Padding added to align with
268 * remainder of dinode
270 __be64 di_goal_meta; /* rgrp to alloc from next */
271 __be64 di_goal_data; /* data block goal */
272 __be64 di_generation; /* generation number for NFS */
274 __be32 di_flags; /* GFS2_DIF_... */
275 __be32 di_payload_format; /* GFS2_FORMAT_... */
276 __u16 __pad1; /* Was ditype in gfs1 */
277 __be16 di_height; /* height of metadata */
278 __u32 __pad2; /* Unused incarnation number from gfs1 */
280 /* These only apply to directories */
281 __u16 __pad3; /* Padding */
282 __be16 di_depth; /* Number of bits in the table */
283 __be32 di_entries; /* The number of entries in the directory */
285 struct gfs2_inum __pad4; /* Unused even in current gfs1 */
287 __be64 di_eattr; /* extended attribute block number */
288 __be32 di_atime_nsec; /* nsec portion of atime */
289 __be32 di_mtime_nsec; /* nsec portion of mtime */
290 __be32 di_ctime_nsec; /* nsec portion of ctime */
292 __u8 di_reserved[44];
296 * directory structure - many of these per directory file
299 #define GFS2_FNAMESIZE 255
300 #define GFS2_DIRENT_SIZE(name_len) ((sizeof(struct gfs2_dirent) + (name_len) + 7) & ~7)
301 #define GFS2_MIN_DIRENT_SIZE (GFS2_DIRENT_SIZE(1))
305 struct gfs2_inum de_inum;
314 __u32 de_cookie; /* ondisk value not used */
321 * Header of leaf directory nodes
325 struct gfs2_meta_header lf_header;
327 __be16 lf_depth; /* Depth of leaf */
328 __be16 lf_entries; /* Number of dirents in leaf */
329 __be32 lf_dirent_format; /* Format of the dirents */
330 __be64 lf_next; /* Next leaf, if overflow */
333 __u8 lf_reserved[64];
335 __be64 lf_inode; /* Dir inode number */
336 __be32 lf_dist; /* Dist from inode on chain */
337 __be32 lf_nsec; /* Last ins/del usecs */
338 __be64 lf_sec; /* Last ins/del in secs */
339 __u8 lf_reserved2[40];
345 * Extended attribute header format
347 * This works in a similar way to dirents. There is a fixed size header
348 * followed by a variable length section made up of the name and the
349 * associated data. In the case of a "stuffed" entry, the value is
350 * inline directly after the name, the ea_num_ptrs entry will be
351 * zero in that case. For non-"stuffed" entries, there will be
352 * a set of pointers (aligned to 8 byte boundary) to the block(s)
353 * containing the value.
355 * The blocks containing the values and the blocks containing the
356 * extended attribute headers themselves all start with the common
357 * metadata header. Each inode, if it has extended attributes, will
358 * have either a single block containing the extended attribute headers
359 * or a single indirect block pointing to blocks containing the
360 * extended attribute headers.
362 * The maximum size of the data part of an extended attribute is 64k
363 * so the number of blocks required depends upon block size. Since the
364 * block size also determines the number of pointers in an indirect
365 * block, its a fairly complicated calculation to work out the maximum
366 * number of blocks that an inode may have relating to extended attributes.
370 #define GFS2_EA_MAX_NAME_LEN 255
371 #define GFS2_EA_MAX_DATA_LEN 65536
373 #define GFS2_EATYPE_UNUSED 0
374 #define GFS2_EATYPE_USR 1
375 #define GFS2_EATYPE_SYS 2
376 #define GFS2_EATYPE_SECURITY 3
378 #define GFS2_EATYPE_LAST 3
379 #define GFS2_EATYPE_VALID(x) ((x) <= GFS2_EATYPE_LAST)
381 #define GFS2_EAFLAG_LAST 0x01 /* last ea in block */
383 struct gfs2_ea_header {
386 __u8 ea_name_len; /* no NULL pointer after the string */
387 __u8 ea_type; /* GFS2_EATYPE_... */
388 __u8 ea_flags; /* GFS2_EAFLAG_... */
394 * Log header structure
397 #define GFS2_LOG_HEAD_UNMOUNT 0x00000001 /* log is clean */
399 struct gfs2_log_header {
400 struct gfs2_meta_header lh_header;
402 __be64 lh_sequence; /* Sequence number of this transaction */
403 __be32 lh_flags; /* GFS2_LOG_HEAD_... */
404 __be32 lh_tail; /* Block number of log tail */
410 * Log type descriptor
413 #define GFS2_LOG_DESC_METADATA 300
414 /* ld_data1 is the number of metadata blocks in the descriptor.
415 ld_data2 is unused. */
417 #define GFS2_LOG_DESC_REVOKE 301
418 /* ld_data1 is the number of revoke blocks in the descriptor.
419 ld_data2 is unused. */
421 #define GFS2_LOG_DESC_JDATA 302
422 /* ld_data1 is the number of data blocks in the descriptor.
423 ld_data2 is unused. */
425 struct gfs2_log_descriptor {
426 struct gfs2_meta_header ld_header;
428 __be32 ld_type; /* GFS2_LOG_DESC_... */
429 __be32 ld_length; /* Number of buffers in this chunk */
430 __be32 ld_data1; /* descriptor-specific field */
431 __be32 ld_data2; /* descriptor-specific field */
433 __u8 ld_reserved[32];
438 * Describe a range of formal inode numbers allocated to
439 * one machine to assign to inodes.
442 #define GFS2_INUM_QUANTUM 1048576
444 struct gfs2_inum_range {
451 * Describes an change to the pool of free and allocated
455 struct gfs2_statfs_change {
463 * Describes an allocation change for a particular
467 #define GFS2_QCF_USER 0x00000001
469 struct gfs2_quota_change {
471 __be32 qc_flags; /* GFS2_QCF_... */
475 struct gfs2_quota_lvb {
478 __be64 qb_limit; /* Hard limit of # blocks to alloc */
479 __be64 qb_warn; /* Warn user when alloc is above this # */
480 __be64 qb_value; /* Current # blocks allocated */
483 #endif /* __GFS2_ONDISK_DOT_H__ */