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 conditions 8 * 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 0x01161970 17 #define GFS2_BASIC_BLOCK 512 18 #define GFS2_BASIC_BLOCK_SHIFT 9 19 20 /* Lock numbers of the LM_TYPE_NONDISK type */ 21 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 28 29 /* Format numbers for various metadata types */ 30 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 52 53 /* 54 * An on-disk inode number 55 */ 56 57 struct gfs2_inum { 58 __be64 no_formal_ino; 59 __be64 no_addr; 60 }; 61 62 /* 63 * Generic metadata head structure 64 * Every inplace buffer logged in the journal must start with this. 65 */ 66 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 81 82 struct 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 structure 96 * 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-disk 100 * version upgrades. 101 */ 102 103 /* Address of superblock in GFS2 basic blocks */ 104 #define GFS2_SB_ADDR 128 105 106 /* The lock number for the superblock (must be zero) */ 107 #define GFS2_SB_LOCK 0 108 109 /* Requirement: GFS2_LOCKNAME_LEN % 8 == 0 110 Includes: the fencing zero at the end */ 111 #define GFS2_LOCKNAME_LEN 64 112 113 struct 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 1 134 __u8 sb_uuid[16]; /* The UUID, maybe 0 for backwards compat */ 135 }; 136 137 /* 138 * resource index structure 139 */ 140 141 struct 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 structure 156 */ 157 158 /* Number of blocks per byte in rgrp */ 159 #define GFS2_NBBY 4 160 #define GFS2_BIT_SIZE 2 161 #define GFS2_BIT_MASK 0x00000003 162 163 #define GFS2_BLKST_FREE 0 164 #define GFS2_BLKST_USED 1 165 #define GFS2_BLKST_UNLINKED 2 166 #define GFS2_BLKST_DINODE 3 167 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 173 174 struct gfs2_rgrp_lvb { 175 __be32 rl_magic; 176 __be32 rl_flags; 177 __be32 rl_free; 178 __be32 rl_dinodes; 179 __be64 rl_igeneration; 180 __be32 rl_unlinked; 181 __be32 __pad; 182 }; 183 184 struct gfs2_rgrp { 185 struct gfs2_meta_header rg_header; 186 187 __be32 rg_flags; 188 __be32 rg_free; 189 __be32 rg_dinodes; 190 __be32 __pad; 191 __be64 rg_igeneration; 192 193 __u8 rg_reserved[80]; /* Several fields from gfs1 now reserved */ 194 }; 195 196 /* 197 * quota structure 198 */ 199 200 struct gfs2_quota { 201 __be64 qu_limit; 202 __be64 qu_warn; 203 __be64 qu_value; 204 __u8 qu_reserved[64]; 205 }; 206 207 /* 208 * dinode structure 209 */ 210 211 #define GFS2_MAX_META_HEIGHT 10 212 #define GFS2_DIR_MAX_DEPTH 17 213 214 #define DT2IF(dt) (((dt) << 12) & S_IFMT) 215 #define IF2DT(sif) (((sif) & S_IFMT) >> 12) 216 217 enum { 218 gfs2fl_Jdata = 0, 219 gfs2fl_ExHash = 1, 220 gfs2fl_Unused = 2, 221 gfs2fl_EaIndirect = 3, 222 gfs2fl_Directio = 4, 223 gfs2fl_Immutable = 5, 224 gfs2fl_AppendOnly = 6, 225 gfs2fl_NoAtime = 7, 226 gfs2fl_Sync = 8, 227 gfs2fl_System = 9, 228 gfs2fl_TopLevel = 10, 229 gfs2fl_TruncInProg = 29, 230 gfs2fl_InheritDirectio = 30, 231 gfs2fl_InheritJdata = 31, 232 }; 233 234 /* Dinode flags */ 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 249 250 struct gfs2_dinode { 251 struct gfs2_meta_header di_header; 252 253 struct gfs2_inum di_num; 254 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 */ 266 267 /* This section varies from gfs1. Padding added to align with 268 * remainder of dinode 269 */ 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 */ 273 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 */ 279 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 */ 284 285 struct gfs2_inum __pad4; /* Unused even in current gfs1 */ 286 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 */ 291 292 __u8 di_reserved[44]; 293 }; 294 295 /* 296 * directory structure - many of these per directory file 297 */ 298 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)) 302 303 304 struct gfs2_dirent { 305 struct gfs2_inum de_inum; 306 __be32 de_hash; 307 __be16 de_rec_len; 308 __be16 de_name_len; 309 __be16 de_type; 310 __be16 de_rahead; 311 union { 312 __u8 __pad[12]; 313 struct { 314 __u32 de_cookie; /* ondisk value not used */ 315 __u8 pad3[8]; 316 }; 317 }; 318 }; 319 320 /* 321 * Header of leaf directory nodes 322 */ 323 324 struct gfs2_leaf { 325 struct gfs2_meta_header lf_header; 326 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 */ 331 332 union { 333 __u8 lf_reserved[64]; 334 struct { 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]; 340 }; 341 }; 342 }; 343 344 /* 345 * Extended attribute header format 346 * 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. 354 * 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. 361 * 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. 367 * 368 */ 369 370 #define GFS2_EA_MAX_NAME_LEN 255 371 #define GFS2_EA_MAX_DATA_LEN 65536 372 373 #define GFS2_EATYPE_UNUSED 0 374 #define GFS2_EATYPE_USR 1 375 #define GFS2_EATYPE_SYS 2 376 #define GFS2_EATYPE_SECURITY 3 377 378 #define GFS2_EATYPE_LAST 3 379 #define GFS2_EATYPE_VALID(x) ((x) <= GFS2_EATYPE_LAST) 380 381 #define GFS2_EAFLAG_LAST 0x01 /* last ea in block */ 382 383 struct gfs2_ea_header { 384 __be32 ea_rec_len; 385 __be32 ea_data_len; 386 __u8 ea_name_len; /* no NULL pointer after the string */ 387 __u8 ea_type; /* GFS2_EATYPE_... */ 388 __u8 ea_flags; /* GFS2_EAFLAG_... */ 389 __u8 ea_num_ptrs; 390 __u32 __pad; 391 }; 392 393 /* 394 * Log header structure 395 */ 396 397 #define GFS2_LOG_HEAD_UNMOUNT 0x00000001 /* log is clean */ 398 399 struct gfs2_log_header { 400 struct gfs2_meta_header lh_header; 401 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 */ 405 __be32 lh_blkno; 406 __be32 lh_hash; 407 }; 408 409 /* 410 * Log type descriptor 411 */ 412 413 #define GFS2_LOG_DESC_METADATA 300 414 /* ld_data1 is the number of metadata blocks in the descriptor. 415 ld_data2 is unused. */ 416 417 #define GFS2_LOG_DESC_REVOKE 301 418 /* ld_data1 is the number of revoke blocks in the descriptor. 419 ld_data2 is unused. */ 420 421 #define GFS2_LOG_DESC_JDATA 302 422 /* ld_data1 is the number of data blocks in the descriptor. 423 ld_data2 is unused. */ 424 425 struct gfs2_log_descriptor { 426 struct gfs2_meta_header ld_header; 427 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 */ 432 433 __u8 ld_reserved[32]; 434 }; 435 436 /* 437 * Inum Range 438 * Describe a range of formal inode numbers allocated to 439 * one machine to assign to inodes. 440 */ 441 442 #define GFS2_INUM_QUANTUM 1048576 443 444 struct gfs2_inum_range { 445 __be64 ir_start; 446 __be64 ir_length; 447 }; 448 449 /* 450 * Statfs change 451 * Describes an change to the pool of free and allocated 452 * blocks. 453 */ 454 455 struct gfs2_statfs_change { 456 __be64 sc_total; 457 __be64 sc_free; 458 __be64 sc_dinodes; 459 }; 460 461 /* 462 * Quota change 463 * Describes an allocation change for a particular 464 * user or group. 465 */ 466 467 #define GFS2_QCF_USER 0x00000001 468 469 struct gfs2_quota_change { 470 __be64 qc_change; 471 __be32 qc_flags; /* GFS2_QCF_... */ 472 __be32 qc_id; 473 }; 474 475 struct gfs2_quota_lvb { 476 __be32 qb_magic; 477 __u32 __pad; 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 */ 481 }; 482 483 #endif /* __GFS2_ONDISK_DOT_H__ */ 484