543 lines · c
1/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */2/*3 * Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.4 * Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved.5 *6 * This copyrighted material is made available to anyone wishing to use,7 * modify, copy, or redistribute it subject to the terms and conditions8 * of the GNU General Public License v.2.9 */10 11#ifndef __GFS2_ONDISK_DOT_H__12#define __GFS2_ONDISK_DOT_H__13 14#include <linux/types.h>15 16#define GFS2_MAGIC 0x0116197017#define GFS2_BASIC_BLOCK 51218#define GFS2_BASIC_BLOCK_SHIFT 919 20/* Lock numbers of the LM_TYPE_NONDISK type */21 22#define GFS2_MOUNT_LOCK 023#define GFS2_LIVE_LOCK 124#define GFS2_FREEZE_LOCK 225#define GFS2_RENAME_LOCK 326#define GFS2_CONTROL_LOCK 427#define GFS2_MOUNTED_LOCK 528 29/* Format numbers for various metadata types */30 31#define GFS2_FORMAT_NONE 032#define GFS2_FORMAT_SB 10033#define GFS2_FORMAT_RG 20034#define GFS2_FORMAT_RB 30035#define GFS2_FORMAT_DI 40036#define GFS2_FORMAT_IN 50037#define GFS2_FORMAT_LF 60038#define GFS2_FORMAT_JD 70039#define GFS2_FORMAT_LH 80040#define GFS2_FORMAT_LD 90041#define GFS2_FORMAT_LB 100042#define GFS2_FORMAT_EA 160043#define GFS2_FORMAT_ED 170044#define GFS2_FORMAT_QC 140045/* These are format numbers for entities contained in files */46#define GFS2_FORMAT_RI 110047#define GFS2_FORMAT_DE 120048#define GFS2_FORMAT_QU 150049/* These are part of the superblock */50#define GFS2_FORMAT_FS 180251#define GFS2_FORMAT_MULTI 190052 53/*54 * An on-disk inode number55 */56 57struct gfs2_inum {58 __be64 no_formal_ino;59 __be64 no_addr;60};61 62/*63 * Generic metadata head structure64 * Every inplace buffer logged in the journal must start with this.65 */66 67#define GFS2_METATYPE_NONE 068#define GFS2_METATYPE_SB 169#define GFS2_METATYPE_RG 270#define GFS2_METATYPE_RB 371#define GFS2_METATYPE_DI 472#define GFS2_METATYPE_IN 573#define GFS2_METATYPE_LF 674#define GFS2_METATYPE_JD 775#define GFS2_METATYPE_LH 876#define GFS2_METATYPE_LD 977#define GFS2_METATYPE_LB 1278#define GFS2_METATYPE_EA 1079#define GFS2_METATYPE_ED 1180#define GFS2_METATYPE_QC 1481 82struct gfs2_meta_header {83 __be32 mh_magic;84 __be32 mh_type;85 __be64 __pad0; /* Was generation number in gfs1 */86 __be32 mh_format;87 /* This union is to keep userspace happy */88 union {89 __be32 mh_jid; /* Was incarnation number in gfs1 */90 __be32 __pad1;91 };92};93 94/*95 * super-block structure96 *97 * It's probably good if SIZEOF_SB <= GFS2_BASIC_BLOCK (512 bytes)98 *99 * Order is important, need to be able to read old superblocks to do on-disk100 * version upgrades.101 */102 103/* Address of superblock in GFS2 basic blocks */104#define GFS2_SB_ADDR 128105 106/* The lock number for the superblock (must be zero) */107#define GFS2_SB_LOCK 0108 109/* Requirement: GFS2_LOCKNAME_LEN % 8 == 0110 Includes: the fencing zero at the end */111#define GFS2_LOCKNAME_LEN 64112 113struct gfs2_sb {114 struct gfs2_meta_header sb_header;115 116 __be32 sb_fs_format;117 __be32 sb_multihost_format;118 __u32 __pad0; /* Was superblock flags in gfs1 */119 120 __be32 sb_bsize;121 __be32 sb_bsize_shift;122 __u32 __pad1; /* Was journal segment size in gfs1 */123 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;127 128 char sb_lockproto[GFS2_LOCKNAME_LEN];129 char sb_locktable[GFS2_LOCKNAME_LEN];130 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 1134 __u8 sb_uuid[16]; /* The UUID, maybe 0 for backwards compat */135};136 137/*138 * resource index structure139 */140 141struct gfs2_rindex {142 __be64 ri_addr; /* grp block disk address */143 __be32 ri_length; /* length of rgrp header in fs blocks */144 __u32 __pad;145 146 __be64 ri_data0; /* first data location */147 __be32 ri_data; /* num of data blocks in rgrp */148 149 __be32 ri_bitbytes; /* number of bytes in data bitmaps */150 151 __u8 ri_reserved[64];152};153 154/*155 * resource group header structure156 */157 158/* Number of blocks per byte in rgrp */159#define GFS2_NBBY 4160#define GFS2_BIT_SIZE 2161#define GFS2_BIT_MASK 0x00000003162 163#define GFS2_BLKST_FREE 0164#define GFS2_BLKST_USED 1165#define GFS2_BLKST_UNLINKED 2166#define GFS2_BLKST_DINODE 3167 168#define GFS2_RGF_JOURNAL 0x00000001169#define GFS2_RGF_METAONLY 0x00000002170#define GFS2_RGF_DATAONLY 0x00000004171#define GFS2_RGF_NOALLOC 0x00000008172#define GFS2_RGF_TRIMMED 0x00000010173 174struct gfs2_inode_lvb {175 __be32 ri_magic;176 __be32 __pad;177 __be64 ri_generation_deleted;178};179 180struct gfs2_rgrp_lvb {181 __be32 rl_magic;182 __be32 rl_flags;183 __be32 rl_free;184 __be32 rl_dinodes;185 __be64 rl_igeneration;186 __be32 rl_unlinked;187 __be32 __pad;188};189 190struct gfs2_rgrp {191 struct gfs2_meta_header rg_header;192 193 __be32 rg_flags;194 __be32 rg_free;195 __be32 rg_dinodes;196 union {197 __be32 __pad;198 __be32 rg_skip; /* Distance to the next rgrp in fs blocks */199 };200 __be64 rg_igeneration;201 /* The following 3 fields are duplicated from gfs2_rindex to reduce202 reliance on the rindex */203 __be64 rg_data0; /* First data location */204 __be32 rg_data; /* Number of data blocks in rgrp */205 __be32 rg_bitbytes; /* Number of bytes in data bitmaps */206 __be32 rg_crc; /* crc32 of the structure with this field 0 */207 208 __u8 rg_reserved[60]; /* Several fields from gfs1 now reserved */209};210 211/*212 * quota structure213 */214 215struct gfs2_quota {216 __be64 qu_limit;217 __be64 qu_warn;218 __be64 qu_value;219 __u8 qu_reserved[64];220};221 222/*223 * dinode structure224 */225 226#define GFS2_MAX_META_HEIGHT 10227#define GFS2_DIR_MAX_DEPTH 17228 229#define DT2IF(dt) (((dt) << 12) & S_IFMT)230#define IF2DT(sif) (((sif) & S_IFMT) >> 12)231 232enum {233 gfs2fl_Jdata = 0,234 gfs2fl_ExHash = 1,235 gfs2fl_Unused = 2,236 gfs2fl_EaIndirect = 3,237 gfs2fl_Directio = 4,238 gfs2fl_Immutable = 5,239 gfs2fl_AppendOnly = 6,240 gfs2fl_NoAtime = 7,241 gfs2fl_Sync = 8,242 gfs2fl_System = 9,243 gfs2fl_TopLevel = 10,244 gfs2fl_TruncInProg = 29,245 gfs2fl_InheritDirectio = 30,246 gfs2fl_InheritJdata = 31,247};248 249/* Dinode flags */250#define GFS2_DIF_JDATA 0x00000001251#define GFS2_DIF_EXHASH 0x00000002252#define GFS2_DIF_UNUSED 0x00000004 /* only in gfs1 */253#define GFS2_DIF_EA_INDIRECT 0x00000008254#define GFS2_DIF_DIRECTIO 0x00000010255#define GFS2_DIF_IMMUTABLE 0x00000020256#define GFS2_DIF_APPENDONLY 0x00000040257#define GFS2_DIF_NOATIME 0x00000080258#define GFS2_DIF_SYNC 0x00000100259#define GFS2_DIF_SYSTEM 0x00000200 /* New in gfs2 */260#define GFS2_DIF_TOPDIR 0x00000400 /* New in gfs2 */261#define GFS2_DIF_TRUNC_IN_PROG 0x20000000 /* New in gfs2 */262#define GFS2_DIF_INHERIT_DIRECTIO 0x40000000 /* only in gfs1 */263#define GFS2_DIF_INHERIT_JDATA 0x80000000264 265struct gfs2_dinode {266 struct gfs2_meta_header di_header;267 268 struct gfs2_inum di_num;269 270 __be32 di_mode; /* mode of file */271 __be32 di_uid; /* owner's user id */272 __be32 di_gid; /* owner's group id */273 __be32 di_nlink; /* number of links to this file */274 __be64 di_size; /* number of bytes in file */275 __be64 di_blocks; /* number of blocks in file */276 __be64 di_atime; /* time last accessed */277 __be64 di_mtime; /* time last modified */278 __be64 di_ctime; /* time last changed */279 __be32 di_major; /* device major number */280 __be32 di_minor; /* device minor number */281 282 /* This section varies from gfs1. Padding added to align with283 * remainder of dinode284 */285 __be64 di_goal_meta; /* rgrp to alloc from next */286 __be64 di_goal_data; /* data block goal */287 __be64 di_generation; /* generation number for NFS */288 289 __be32 di_flags; /* GFS2_DIF_... */290 __be32 di_payload_format; /* GFS2_FORMAT_... */291 __u16 __pad1; /* Was ditype in gfs1 */292 __be16 di_height; /* height of metadata */293 __u32 __pad2; /* Unused incarnation number from gfs1 */294 295 /* These only apply to directories */296 __u16 __pad3; /* Padding */297 __be16 di_depth; /* Number of bits in the table */298 __be32 di_entries; /* The number of entries in the directory */299 300 struct gfs2_inum __pad4; /* Unused even in current gfs1 */301 302 __be64 di_eattr; /* extended attribute block number */303 __be32 di_atime_nsec; /* nsec portion of atime */304 __be32 di_mtime_nsec; /* nsec portion of mtime */305 __be32 di_ctime_nsec; /* nsec portion of ctime */306 307 __u8 di_reserved[44];308};309 310/*311 * directory structure - many of these per directory file312 */313 314#define GFS2_FNAMESIZE 255315#define GFS2_DIRENT_SIZE(name_len) ((sizeof(struct gfs2_dirent) + (name_len) + 7) & ~7)316#define GFS2_MIN_DIRENT_SIZE (GFS2_DIRENT_SIZE(1))317 318 319struct gfs2_dirent {320 struct gfs2_inum de_inum;321 __be32 de_hash;322 __be16 de_rec_len;323 __be16 de_name_len;324 __be16 de_type;325 __be16 de_rahead;326 union {327 __u8 __pad[12];328 struct {329 __u32 de_cookie; /* ondisk value not used */330 __u8 pad3[8];331 };332 };333};334 335/*336 * Header of leaf directory nodes337 */338 339struct gfs2_leaf {340 struct gfs2_meta_header lf_header;341 342 __be16 lf_depth; /* Depth of leaf */343 __be16 lf_entries; /* Number of dirents in leaf */344 __be32 lf_dirent_format; /* Format of the dirents */345 __be64 lf_next; /* Next leaf, if overflow */346 347 union {348 __u8 lf_reserved[64];349 struct {350 __be64 lf_inode; /* Dir inode number */351 __be32 lf_dist; /* Dist from inode on chain */352 __be32 lf_nsec; /* Last ins/del usecs */353 __be64 lf_sec; /* Last ins/del in secs */354 __u8 lf_reserved2[40];355 };356 };357};358 359/*360 * Extended attribute header format361 *362 * This works in a similar way to dirents. There is a fixed size header363 * followed by a variable length section made up of the name and the364 * associated data. In the case of a "stuffed" entry, the value is365 * inline directly after the name, the ea_num_ptrs entry will be366 * zero in that case. For non-"stuffed" entries, there will be367 * a set of pointers (aligned to 8 byte boundary) to the block(s)368 * containing the value.369 *370 * The blocks containing the values and the blocks containing the371 * extended attribute headers themselves all start with the common372 * metadata header. Each inode, if it has extended attributes, will373 * have either a single block containing the extended attribute headers374 * or a single indirect block pointing to blocks containing the375 * extended attribute headers.376 *377 * The maximum size of the data part of an extended attribute is 64k378 * so the number of blocks required depends upon block size. Since the379 * block size also determines the number of pointers in an indirect380 * block, its a fairly complicated calculation to work out the maximum381 * number of blocks that an inode may have relating to extended attributes.382 *383 */384 385#define GFS2_EA_MAX_NAME_LEN 255386#define GFS2_EA_MAX_DATA_LEN 65536387 388#define GFS2_EATYPE_UNUSED 0389#define GFS2_EATYPE_USR 1390#define GFS2_EATYPE_SYS 2391#define GFS2_EATYPE_SECURITY 3392#define GFS2_EATYPE_TRUSTED 4393 394#define GFS2_EATYPE_LAST 4395#define GFS2_EATYPE_VALID(x) ((x) <= GFS2_EATYPE_LAST)396 397#define GFS2_EAFLAG_LAST 0x01 /* last ea in block */398 399struct gfs2_ea_header {400 __be32 ea_rec_len;401 __be32 ea_data_len;402 __u8 ea_name_len; /* no NULL pointer after the string */403 __u8 ea_type; /* GFS2_EATYPE_... */404 __u8 ea_flags; /* GFS2_EAFLAG_... */405 __u8 ea_num_ptrs;406 __u32 __pad;407};408 409/*410 * Log header structure411 */412 413#define GFS2_LOG_HEAD_UNMOUNT 0x00000001 /* log is clean */414#define GFS2_LOG_HEAD_FLUSH_NORMAL 0x00000002 /* normal log flush */415#define GFS2_LOG_HEAD_FLUSH_SYNC 0x00000004 /* Sync log flush */416#define GFS2_LOG_HEAD_FLUSH_SHUTDOWN 0x00000008 /* Shutdown log flush */417#define GFS2_LOG_HEAD_FLUSH_FREEZE 0x00000010 /* Freeze flush */418#define GFS2_LOG_HEAD_RECOVERY 0x00000020 /* Journal recovery */419#define GFS2_LOG_HEAD_USERSPACE 0x80000000 /* Written by gfs2-utils */420 421/* Log flush callers */422#define GFS2_LFC_SHUTDOWN 0x00000100423#define GFS2_LFC_JDATA_WPAGES 0x00000200424#define GFS2_LFC_SET_FLAGS 0x00000400425#define GFS2_LFC_AIL_EMPTY_GL 0x00000800426#define GFS2_LFC_AIL_FLUSH 0x00001000427#define GFS2_LFC_RGRP_GO_SYNC 0x00002000428#define GFS2_LFC_INODE_GO_SYNC 0x00004000429#define GFS2_LFC_INODE_GO_INVAL 0x00008000430#define GFS2_LFC_FREEZE_GO_SYNC 0x00010000431#define GFS2_LFC_KILL_SB 0x00020000432#define GFS2_LFC_DO_SYNC 0x00040000433#define GFS2_LFC_INPLACE_RESERVE 0x00080000434#define GFS2_LFC_WRITE_INODE 0x00100000435#define GFS2_LFC_MAKE_FS_RO 0x00200000436#define GFS2_LFC_SYNC_FS 0x00400000437#define GFS2_LFC_EVICT_INODE 0x00800000438#define GFS2_LFC_TRANS_END 0x01000000439#define GFS2_LFC_LOGD_JFLUSH_REQD 0x02000000440#define GFS2_LFC_LOGD_AIL_FLUSH_REQD 0x04000000441 442#define LH_V1_SIZE (offsetofend(struct gfs2_log_header, lh_hash))443 444struct gfs2_log_header {445 struct gfs2_meta_header lh_header;446 447 __be64 lh_sequence; /* Sequence number of this transaction */448 __be32 lh_flags; /* GFS2_LOG_HEAD_... */449 __be32 lh_tail; /* Block number of log tail */450 __be32 lh_blkno;451 __be32 lh_hash; /* crc up to here with this field 0 */452 453 /* Version 2 additional fields start here */454 __be32 lh_crc; /* crc32c from lh_nsec to end of block */455 __be32 lh_nsec; /* Nanoseconds of timestamp */456 __be64 lh_sec; /* Seconds of timestamp */457 __be64 lh_addr; /* Block addr of this log header (absolute) */458 __be64 lh_jinode; /* Journal inode number */459 __be64 lh_statfs_addr; /* Local statfs inode number */460 __be64 lh_quota_addr; /* Local quota change inode number */461 462 /* Statfs local changes (i.e. diff from global statfs) */463 __be64 lh_local_total;464 __be64 lh_local_free;465 __be64 lh_local_dinodes;466};467 468/*469 * Log type descriptor470 */471 472#define GFS2_LOG_DESC_METADATA 300473/* ld_data1 is the number of metadata blocks in the descriptor.474 ld_data2 is unused. */475 476#define GFS2_LOG_DESC_REVOKE 301477/* ld_data1 is the number of revoke blocks in the descriptor.478 ld_data2 is unused. */479 480#define GFS2_LOG_DESC_JDATA 302481/* ld_data1 is the number of data blocks in the descriptor.482 ld_data2 is unused. */483 484struct gfs2_log_descriptor {485 struct gfs2_meta_header ld_header;486 487 __be32 ld_type; /* GFS2_LOG_DESC_... */488 __be32 ld_length; /* Number of buffers in this chunk */489 __be32 ld_data1; /* descriptor-specific field */490 __be32 ld_data2; /* descriptor-specific field */491 492 __u8 ld_reserved[32];493};494 495/*496 * Inum Range497 * Describe a range of formal inode numbers allocated to498 * one machine to assign to inodes.499 */500 501#define GFS2_INUM_QUANTUM 1048576502 503struct gfs2_inum_range {504 __be64 ir_start;505 __be64 ir_length;506};507 508/*509 * Statfs change510 * Describes an change to the pool of free and allocated511 * blocks.512 */513 514struct gfs2_statfs_change {515 __be64 sc_total;516 __be64 sc_free;517 __be64 sc_dinodes;518};519 520/*521 * Quota change522 * Describes an allocation change for a particular523 * user or group.524 */525 526#define GFS2_QCF_USER 0x00000001527 528struct gfs2_quota_change {529 __be64 qc_change;530 __be32 qc_flags; /* GFS2_QCF_... */531 __be32 qc_id;532};533 534struct gfs2_quota_lvb {535 __be32 qb_magic;536 __u32 __pad;537 __be64 qb_limit; /* Hard limit of # blocks to alloc */538 __be64 qb_warn; /* Warn user when alloc is above this # */539 __be64 qb_value; /* Current # blocks allocated */540};541 542#endif /* __GFS2_ONDISK_DOT_H__ */543