Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
0002 /*
0003  * Copyright (C) Sistina Software, Inc.  1997-2003 All rights reserved.
0004  * Copyright (C) 2004-2006 Red Hat, Inc.  All rights reserved.
0005  *
0006  * This copyrighted material is made available to anyone wishing to use,
0007  * modify, copy, or redistribute it subject to the terms and conditions
0008  * of the GNU General Public License v.2.
0009  */
0010 
0011 #ifndef __GFS2_ONDISK_DOT_H__
0012 #define __GFS2_ONDISK_DOT_H__
0013 
0014 #include <linux/types.h>
0015 
0016 #define GFS2_MAGIC      0x01161970
0017 #define GFS2_BASIC_BLOCK    512
0018 #define GFS2_BASIC_BLOCK_SHIFT  9
0019 
0020 /* Lock numbers of the LM_TYPE_NONDISK type */
0021 
0022 #define GFS2_MOUNT_LOCK     0
0023 #define GFS2_LIVE_LOCK      1
0024 #define GFS2_FREEZE_LOCK    2
0025 #define GFS2_RENAME_LOCK    3
0026 #define GFS2_CONTROL_LOCK   4
0027 #define GFS2_MOUNTED_LOCK   5
0028 
0029 /* Format numbers for various metadata types */
0030 
0031 #define GFS2_FORMAT_NONE    0
0032 #define GFS2_FORMAT_SB      100
0033 #define GFS2_FORMAT_RG      200
0034 #define GFS2_FORMAT_RB      300
0035 #define GFS2_FORMAT_DI      400
0036 #define GFS2_FORMAT_IN      500
0037 #define GFS2_FORMAT_LF      600
0038 #define GFS2_FORMAT_JD      700
0039 #define GFS2_FORMAT_LH      800
0040 #define GFS2_FORMAT_LD      900
0041 #define GFS2_FORMAT_LB      1000
0042 #define GFS2_FORMAT_EA      1600
0043 #define GFS2_FORMAT_ED      1700
0044 #define GFS2_FORMAT_QC      1400
0045 /* These are format numbers for entities contained in files */
0046 #define GFS2_FORMAT_RI      1100
0047 #define GFS2_FORMAT_DE      1200
0048 #define GFS2_FORMAT_QU      1500
0049 /* These are part of the superblock */
0050 #define GFS2_FORMAT_FS      1802
0051 #define GFS2_FORMAT_MULTI   1900
0052 
0053 /*
0054  * An on-disk inode number
0055  */
0056 
0057 struct gfs2_inum {
0058     __be64 no_formal_ino;
0059     __be64 no_addr;
0060 };
0061 
0062 /*
0063  * Generic metadata head structure
0064  * Every inplace buffer logged in the journal must start with this.
0065  */
0066 
0067 #define GFS2_METATYPE_NONE  0
0068 #define GFS2_METATYPE_SB    1
0069 #define GFS2_METATYPE_RG    2
0070 #define GFS2_METATYPE_RB    3
0071 #define GFS2_METATYPE_DI    4
0072 #define GFS2_METATYPE_IN    5
0073 #define GFS2_METATYPE_LF    6
0074 #define GFS2_METATYPE_JD    7
0075 #define GFS2_METATYPE_LH    8
0076 #define GFS2_METATYPE_LD    9
0077 #define GFS2_METATYPE_LB    12
0078 #define GFS2_METATYPE_EA    10
0079 #define GFS2_METATYPE_ED    11
0080 #define GFS2_METATYPE_QC    14
0081 
0082 struct gfs2_meta_header {
0083     __be32 mh_magic;
0084     __be32 mh_type;
0085     __be64 __pad0;      /* Was generation number in gfs1 */
0086     __be32 mh_format;
0087     /* This union is to keep userspace happy */
0088     union {
0089         __be32 mh_jid;      /* Was incarnation number in gfs1 */
0090         __be32 __pad1;
0091     };
0092 };
0093 
0094 /*
0095  * super-block structure
0096  *
0097  * It's probably good if SIZEOF_SB <= GFS2_BASIC_BLOCK (512 bytes)
0098  *
0099  * Order is important, need to be able to read old superblocks to do on-disk
0100  * version upgrades.
0101  */
0102 
0103 /* Address of superblock in GFS2 basic blocks */
0104 #define GFS2_SB_ADDR        128
0105 
0106 /* The lock number for the superblock (must be zero) */
0107 #define GFS2_SB_LOCK        0
0108 
0109 /* Requirement:  GFS2_LOCKNAME_LEN % 8 == 0
0110    Includes: the fencing zero at the end */
0111 #define GFS2_LOCKNAME_LEN   64
0112 
0113 struct gfs2_sb {
0114     struct gfs2_meta_header sb_header;
0115 
0116     __be32 sb_fs_format;
0117     __be32 sb_multihost_format;
0118     __u32  __pad0;  /* Was superblock flags in gfs1 */
0119 
0120     __be32 sb_bsize;
0121     __be32 sb_bsize_shift;
0122     __u32 __pad1;   /* Was journal segment size in gfs1 */
0123 
0124     struct gfs2_inum sb_master_dir; /* Was jindex dinode in gfs1 */
0125     struct gfs2_inum __pad2; /* Was rindex dinode in gfs1 */
0126     struct gfs2_inum sb_root_dir;
0127 
0128     char sb_lockproto[GFS2_LOCKNAME_LEN];
0129     char sb_locktable[GFS2_LOCKNAME_LEN];
0130 
0131     struct gfs2_inum __pad3; /* Was quota inode in gfs1 */
0132     struct gfs2_inum __pad4; /* Was licence inode in gfs1 */
0133 #define GFS2_HAS_UUID 1
0134     __u8 sb_uuid[16]; /* The UUID, maybe 0 for backwards compat */
0135 };
0136 
0137 /*
0138  * resource index structure
0139  */
0140 
0141 struct gfs2_rindex {
0142     __be64 ri_addr; /* grp block disk address */
0143     __be32 ri_length;   /* length of rgrp header in fs blocks */
0144     __u32 __pad;
0145 
0146     __be64 ri_data0;    /* first data location */
0147     __be32 ri_data; /* num of data blocks in rgrp */
0148 
0149     __be32 ri_bitbytes; /* number of bytes in data bitmaps */
0150 
0151     __u8 ri_reserved[64];
0152 };
0153 
0154 /*
0155  * resource group header structure
0156  */
0157 
0158 /* Number of blocks per byte in rgrp */
0159 #define GFS2_NBBY       4
0160 #define GFS2_BIT_SIZE       2
0161 #define GFS2_BIT_MASK       0x00000003
0162 
0163 #define GFS2_BLKST_FREE     0
0164 #define GFS2_BLKST_USED     1
0165 #define GFS2_BLKST_UNLINKED 2
0166 #define GFS2_BLKST_DINODE   3
0167 
0168 #define GFS2_RGF_JOURNAL    0x00000001
0169 #define GFS2_RGF_METAONLY   0x00000002
0170 #define GFS2_RGF_DATAONLY   0x00000004
0171 #define GFS2_RGF_NOALLOC    0x00000008
0172 #define GFS2_RGF_TRIMMED    0x00000010
0173 
0174 struct gfs2_inode_lvb {
0175     __be32 ri_magic;
0176     __be32 __pad;
0177     __be64 ri_generation_deleted;
0178 };
0179 
0180 struct gfs2_rgrp_lvb {
0181     __be32 rl_magic;
0182     __be32 rl_flags;
0183     __be32 rl_free;
0184     __be32 rl_dinodes;
0185     __be64 rl_igeneration;
0186     __be32 rl_unlinked;
0187     __be32 __pad;
0188 };
0189 
0190 struct gfs2_rgrp {
0191     struct gfs2_meta_header rg_header;
0192 
0193     __be32 rg_flags;
0194     __be32 rg_free;
0195     __be32 rg_dinodes;
0196     union {
0197         __be32 __pad;
0198         __be32 rg_skip; /* Distance to the next rgrp in fs blocks */
0199     };
0200     __be64 rg_igeneration;
0201     /* The following 3 fields are duplicated from gfs2_rindex to reduce
0202        reliance on the rindex */
0203     __be64 rg_data0;     /* First data location */
0204     __be32 rg_data;      /* Number of data blocks in rgrp */
0205     __be32 rg_bitbytes;  /* Number of bytes in data bitmaps */
0206     __be32 rg_crc;       /* crc32 of the structure with this field 0 */
0207 
0208     __u8 rg_reserved[60]; /* Several fields from gfs1 now reserved */
0209 };
0210 
0211 /*
0212  * quota structure
0213  */
0214 
0215 struct gfs2_quota {
0216     __be64 qu_limit;
0217     __be64 qu_warn;
0218     __be64 qu_value;
0219     __u8 qu_reserved[64];
0220 };
0221 
0222 /*
0223  * dinode structure
0224  */
0225 
0226 #define GFS2_MAX_META_HEIGHT    10
0227 #define GFS2_DIR_MAX_DEPTH  17
0228 
0229 #define DT2IF(dt) (((dt) << 12) & S_IFMT)
0230 #define IF2DT(sif) (((sif) & S_IFMT) >> 12)
0231 
0232 enum {
0233     gfs2fl_Jdata        = 0,
0234     gfs2fl_ExHash       = 1,
0235     gfs2fl_Unused       = 2,
0236     gfs2fl_EaIndirect   = 3,
0237     gfs2fl_Directio     = 4,
0238     gfs2fl_Immutable    = 5,
0239     gfs2fl_AppendOnly   = 6,
0240     gfs2fl_NoAtime      = 7,
0241     gfs2fl_Sync     = 8,
0242     gfs2fl_System       = 9,
0243     gfs2fl_TopLevel     = 10,
0244     gfs2fl_TruncInProg  = 29,
0245     gfs2fl_InheritDirectio  = 30,
0246     gfs2fl_InheritJdata = 31,
0247 };
0248 
0249 /* Dinode flags */
0250 #define GFS2_DIF_JDATA          0x00000001
0251 #define GFS2_DIF_EXHASH         0x00000002
0252 #define GFS2_DIF_UNUSED         0x00000004  /* only in gfs1 */
0253 #define GFS2_DIF_EA_INDIRECT        0x00000008
0254 #define GFS2_DIF_DIRECTIO       0x00000010
0255 #define GFS2_DIF_IMMUTABLE      0x00000020
0256 #define GFS2_DIF_APPENDONLY     0x00000040
0257 #define GFS2_DIF_NOATIME        0x00000080
0258 #define GFS2_DIF_SYNC           0x00000100
0259 #define GFS2_DIF_SYSTEM         0x00000200 /* New in gfs2 */
0260 #define GFS2_DIF_TOPDIR         0x00000400 /* New in gfs2 */
0261 #define GFS2_DIF_TRUNC_IN_PROG      0x20000000 /* New in gfs2 */
0262 #define GFS2_DIF_INHERIT_DIRECTIO   0x40000000 /* only in gfs1 */
0263 #define GFS2_DIF_INHERIT_JDATA      0x80000000
0264 
0265 struct gfs2_dinode {
0266     struct gfs2_meta_header di_header;
0267 
0268     struct gfs2_inum di_num;
0269 
0270     __be32 di_mode; /* mode of file */
0271     __be32 di_uid;  /* owner's user id */
0272     __be32 di_gid;  /* owner's group id */
0273     __be32 di_nlink;    /* number of links to this file */
0274     __be64 di_size; /* number of bytes in file */
0275     __be64 di_blocks;   /* number of blocks in file */
0276     __be64 di_atime;    /* time last accessed */
0277     __be64 di_mtime;    /* time last modified */
0278     __be64 di_ctime;    /* time last changed */
0279     __be32 di_major;    /* device major number */
0280     __be32 di_minor;    /* device minor number */
0281 
0282     /* This section varies from gfs1. Padding added to align with
0283          * remainder of dinode
0284      */
0285     __be64 di_goal_meta;    /* rgrp to alloc from next */
0286     __be64 di_goal_data;    /* data block goal */
0287     __be64 di_generation;   /* generation number for NFS */
0288 
0289     __be32 di_flags;    /* GFS2_DIF_... */
0290     __be32 di_payload_format;  /* GFS2_FORMAT_... */
0291     __u16 __pad1;   /* Was ditype in gfs1 */
0292     __be16 di_height;   /* height of metadata */
0293     __u32 __pad2;   /* Unused incarnation number from gfs1 */
0294 
0295     /* These only apply to directories  */
0296     __u16 __pad3;   /* Padding */
0297     __be16 di_depth;    /* Number of bits in the table */
0298     __be32 di_entries;  /* The number of entries in the directory */
0299 
0300     struct gfs2_inum __pad4; /* Unused even in current gfs1 */
0301 
0302     __be64 di_eattr;    /* extended attribute block number */
0303     __be32 di_atime_nsec;   /* nsec portion of atime */
0304     __be32 di_mtime_nsec;   /* nsec portion of mtime */
0305     __be32 di_ctime_nsec;   /* nsec portion of ctime */
0306 
0307     __u8 di_reserved[44];
0308 };
0309 
0310 /*
0311  * directory structure - many of these per directory file
0312  */
0313 
0314 #define GFS2_FNAMESIZE      255
0315 #define GFS2_DIRENT_SIZE(name_len) ((sizeof(struct gfs2_dirent) + (name_len) + 7) & ~7)
0316 #define GFS2_MIN_DIRENT_SIZE (GFS2_DIRENT_SIZE(1))
0317 
0318 
0319 struct gfs2_dirent {
0320     struct gfs2_inum de_inum;
0321     __be32 de_hash;
0322     __be16 de_rec_len;
0323     __be16 de_name_len;
0324     __be16 de_type;
0325     __be16 de_rahead;
0326     union {
0327         __u8 __pad[12];
0328         struct {
0329             __u32 de_cookie; /* ondisk value not used */
0330             __u8 pad3[8];
0331         };
0332     };
0333 };
0334 
0335 /*
0336  * Header of leaf directory nodes
0337  */
0338 
0339 struct gfs2_leaf {
0340     struct gfs2_meta_header lf_header;
0341 
0342     __be16 lf_depth;        /* Depth of leaf */
0343     __be16 lf_entries;      /* Number of dirents in leaf */
0344     __be32 lf_dirent_format;    /* Format of the dirents */
0345     __be64 lf_next;         /* Next leaf, if overflow */
0346 
0347     union {
0348         __u8 lf_reserved[64];
0349         struct {
0350             __be64 lf_inode;    /* Dir inode number */
0351             __be32 lf_dist;     /* Dist from inode on chain */
0352             __be32 lf_nsec;     /* Last ins/del usecs */
0353             __be64 lf_sec;      /* Last ins/del in secs */
0354             __u8 lf_reserved2[40];
0355         };
0356     };
0357 };
0358 
0359 /*
0360  * Extended attribute header format
0361  *
0362  * This works in a similar way to dirents. There is a fixed size header
0363  * followed by a variable length section made up of the name and the
0364  * associated data. In the case of a "stuffed" entry, the value is
0365  * inline directly after the name, the ea_num_ptrs entry will be
0366  * zero in that case. For non-"stuffed" entries, there will be
0367  * a set of pointers (aligned to 8 byte boundary) to the block(s)
0368  * containing the value.
0369  *
0370  * The blocks containing the values and the blocks containing the
0371  * extended attribute headers themselves all start with the common
0372  * metadata header. Each inode, if it has extended attributes, will
0373  * have either a single block containing the extended attribute headers
0374  * or a single indirect block pointing to blocks containing the
0375  * extended attribute headers.
0376  *
0377  * The maximum size of the data part of an extended attribute is 64k
0378  * so the number of blocks required depends upon block size. Since the
0379  * block size also determines the number of pointers in an indirect
0380  * block, its a fairly complicated calculation to work out the maximum
0381  * number of blocks that an inode may have relating to extended attributes.
0382  *
0383  */
0384 
0385 #define GFS2_EA_MAX_NAME_LEN    255
0386 #define GFS2_EA_MAX_DATA_LEN    65536
0387 
0388 #define GFS2_EATYPE_UNUSED  0
0389 #define GFS2_EATYPE_USR     1
0390 #define GFS2_EATYPE_SYS     2
0391 #define GFS2_EATYPE_SECURITY    3
0392 #define GFS2_EATYPE_TRUSTED 4
0393 
0394 #define GFS2_EATYPE_LAST    4
0395 #define GFS2_EATYPE_VALID(x)    ((x) <= GFS2_EATYPE_LAST)
0396 
0397 #define GFS2_EAFLAG_LAST    0x01    /* last ea in block */
0398 
0399 struct gfs2_ea_header {
0400     __be32 ea_rec_len;
0401     __be32 ea_data_len;
0402     __u8 ea_name_len;   /* no NULL pointer after the string */
0403     __u8 ea_type;       /* GFS2_EATYPE_... */
0404     __u8 ea_flags;      /* GFS2_EAFLAG_... */
0405     __u8 ea_num_ptrs;
0406     __u32 __pad;
0407 };
0408 
0409 /*
0410  * Log header structure
0411  */
0412 
0413 #define GFS2_LOG_HEAD_UNMOUNT       0x00000001 /* log is clean */
0414 #define GFS2_LOG_HEAD_FLUSH_NORMAL  0x00000002 /* normal log flush */
0415 #define GFS2_LOG_HEAD_FLUSH_SYNC    0x00000004 /* Sync log flush */
0416 #define GFS2_LOG_HEAD_FLUSH_SHUTDOWN    0x00000008 /* Shutdown log flush */
0417 #define GFS2_LOG_HEAD_FLUSH_FREEZE  0x00000010 /* Freeze flush */
0418 #define GFS2_LOG_HEAD_RECOVERY      0x00000020 /* Journal recovery */
0419 #define GFS2_LOG_HEAD_USERSPACE     0x80000000 /* Written by gfs2-utils */
0420 
0421 /* Log flush callers */
0422 #define GFS2_LFC_SHUTDOWN       0x00000100
0423 #define GFS2_LFC_JDATA_WPAGES       0x00000200
0424 #define GFS2_LFC_SET_FLAGS      0x00000400
0425 #define GFS2_LFC_AIL_EMPTY_GL       0x00000800
0426 #define GFS2_LFC_AIL_FLUSH      0x00001000
0427 #define GFS2_LFC_RGRP_GO_SYNC       0x00002000
0428 #define GFS2_LFC_INODE_GO_SYNC      0x00004000
0429 #define GFS2_LFC_INODE_GO_INVAL     0x00008000
0430 #define GFS2_LFC_FREEZE_GO_SYNC     0x00010000
0431 #define GFS2_LFC_KILL_SB        0x00020000
0432 #define GFS2_LFC_DO_SYNC        0x00040000
0433 #define GFS2_LFC_INPLACE_RESERVE    0x00080000
0434 #define GFS2_LFC_WRITE_INODE        0x00100000
0435 #define GFS2_LFC_MAKE_FS_RO     0x00200000
0436 #define GFS2_LFC_SYNC_FS        0x00400000
0437 #define GFS2_LFC_EVICT_INODE        0x00800000
0438 #define GFS2_LFC_TRANS_END      0x01000000
0439 #define GFS2_LFC_LOGD_JFLUSH_REQD   0x02000000
0440 #define GFS2_LFC_LOGD_AIL_FLUSH_REQD    0x04000000
0441 
0442 #define LH_V1_SIZE (offsetofend(struct gfs2_log_header, lh_hash))
0443 
0444 struct gfs2_log_header {
0445     struct gfs2_meta_header lh_header;
0446 
0447     __be64 lh_sequence; /* Sequence number of this transaction */
0448     __be32 lh_flags;    /* GFS2_LOG_HEAD_... */
0449     __be32 lh_tail;     /* Block number of log tail */
0450     __be32 lh_blkno;
0451     __be32 lh_hash;     /* crc up to here with this field 0 */
0452 
0453     /* Version 2 additional fields start here */
0454     __be32 lh_crc;      /* crc32c from lh_nsec to end of block */
0455     __be32 lh_nsec;     /* Nanoseconds of timestamp */
0456     __be64 lh_sec;      /* Seconds of timestamp */
0457     __be64 lh_addr;     /* Block addr of this log header (absolute) */
0458     __be64 lh_jinode;   /* Journal inode number */
0459     __be64 lh_statfs_addr;  /* Local statfs inode number */
0460     __be64 lh_quota_addr;   /* Local quota change inode number */
0461 
0462     /* Statfs local changes (i.e. diff from global statfs) */
0463     __be64 lh_local_total;
0464     __be64 lh_local_free;
0465     __be64 lh_local_dinodes;
0466 };
0467 
0468 /*
0469  * Log type descriptor
0470  */
0471 
0472 #define GFS2_LOG_DESC_METADATA  300
0473 /* ld_data1 is the number of metadata blocks in the descriptor.
0474    ld_data2 is unused. */
0475 
0476 #define GFS2_LOG_DESC_REVOKE    301
0477 /* ld_data1 is the number of revoke blocks in the descriptor.
0478    ld_data2 is unused. */
0479 
0480 #define GFS2_LOG_DESC_JDATA 302
0481 /* ld_data1 is the number of data blocks in the descriptor.
0482    ld_data2 is unused. */
0483 
0484 struct gfs2_log_descriptor {
0485     struct gfs2_meta_header ld_header;
0486 
0487     __be32 ld_type;     /* GFS2_LOG_DESC_... */
0488     __be32 ld_length;   /* Number of buffers in this chunk */
0489     __be32 ld_data1;    /* descriptor-specific field */
0490     __be32 ld_data2;    /* descriptor-specific field */
0491 
0492     __u8 ld_reserved[32];
0493 };
0494 
0495 /*
0496  * Inum Range
0497  * Describe a range of formal inode numbers allocated to
0498  * one machine to assign to inodes.
0499  */
0500 
0501 #define GFS2_INUM_QUANTUM   1048576
0502 
0503 struct gfs2_inum_range {
0504     __be64 ir_start;
0505     __be64 ir_length;
0506 };
0507 
0508 /*
0509  * Statfs change
0510  * Describes an change to the pool of free and allocated
0511  * blocks.
0512  */
0513 
0514 struct gfs2_statfs_change {
0515     __be64 sc_total;
0516     __be64 sc_free;
0517     __be64 sc_dinodes;
0518 };
0519 
0520 /*
0521  * Quota change
0522  * Describes an allocation change for a particular
0523  * user or group.
0524  */
0525 
0526 #define GFS2_QCF_USER       0x00000001
0527 
0528 struct gfs2_quota_change {
0529     __be64 qc_change;
0530     __be32 qc_flags;    /* GFS2_QCF_... */
0531     __be32 qc_id;
0532 };
0533 
0534 struct gfs2_quota_lvb {
0535         __be32 qb_magic;
0536         __u32 __pad;
0537         __be64 qb_limit;      /* Hard limit of # blocks to alloc */
0538         __be64 qb_warn;       /* Warn user when alloc is above this # */
0539         __be64 qb_value;       /* Current # blocks allocated */
0540 };
0541 
0542 #endif /* __GFS2_ONDISK_DOT_H__ */