gfs2_ondisk.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479
  1. /*
  2. * Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
  3. * Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved.
  4. *
  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.
  8. */
  9. #ifndef __GFS2_ONDISK_DOT_H__
  10. #define __GFS2_ONDISK_DOT_H__
  11. #include <linux/types.h>
  12. #define GFS2_MAGIC 0x01161970
  13. #define GFS2_BASIC_BLOCK 512
  14. #define GFS2_BASIC_BLOCK_SHIFT 9
  15. /* Lock numbers of the LM_TYPE_NONDISK type */
  16. #define GFS2_MOUNT_LOCK 0
  17. #define GFS2_LIVE_LOCK 1
  18. #define GFS2_FREEZE_LOCK 2
  19. #define GFS2_RENAME_LOCK 3
  20. #define GFS2_CONTROL_LOCK 4
  21. #define GFS2_MOUNTED_LOCK 5
  22. /* Format numbers for various metadata types */
  23. #define GFS2_FORMAT_NONE 0
  24. #define GFS2_FORMAT_SB 100
  25. #define GFS2_FORMAT_RG 200
  26. #define GFS2_FORMAT_RB 300
  27. #define GFS2_FORMAT_DI 400
  28. #define GFS2_FORMAT_IN 500
  29. #define GFS2_FORMAT_LF 600
  30. #define GFS2_FORMAT_JD 700
  31. #define GFS2_FORMAT_LH 800
  32. #define GFS2_FORMAT_LD 900
  33. #define GFS2_FORMAT_LB 1000
  34. #define GFS2_FORMAT_EA 1600
  35. #define GFS2_FORMAT_ED 1700
  36. #define GFS2_FORMAT_QC 1400
  37. /* These are format numbers for entities contained in files */
  38. #define GFS2_FORMAT_RI 1100
  39. #define GFS2_FORMAT_DE 1200
  40. #define GFS2_FORMAT_QU 1500
  41. /* These are part of the superblock */
  42. #define GFS2_FORMAT_FS 1801
  43. #define GFS2_FORMAT_MULTI 1900
  44. /*
  45. * An on-disk inode number
  46. */
  47. struct gfs2_inum {
  48. __be64 no_formal_ino;
  49. __be64 no_addr;
  50. };
  51. /*
  52. * Generic metadata head structure
  53. * Every inplace buffer logged in the journal must start with this.
  54. */
  55. #define GFS2_METATYPE_NONE 0
  56. #define GFS2_METATYPE_SB 1
  57. #define GFS2_METATYPE_RG 2
  58. #define GFS2_METATYPE_RB 3
  59. #define GFS2_METATYPE_DI 4
  60. #define GFS2_METATYPE_IN 5
  61. #define GFS2_METATYPE_LF 6
  62. #define GFS2_METATYPE_JD 7
  63. #define GFS2_METATYPE_LH 8
  64. #define GFS2_METATYPE_LD 9
  65. #define GFS2_METATYPE_LB 12
  66. #define GFS2_METATYPE_EA 10
  67. #define GFS2_METATYPE_ED 11
  68. #define GFS2_METATYPE_QC 14
  69. struct gfs2_meta_header {
  70. __be32 mh_magic;
  71. __be32 mh_type;
  72. __be64 __pad0; /* Was generation number in gfs1 */
  73. __be32 mh_format;
  74. /* This union is to keep userspace happy */
  75. union {
  76. __be32 mh_jid; /* Was incarnation number in gfs1 */
  77. __be32 __pad1;
  78. };
  79. };
  80. /*
  81. * super-block structure
  82. *
  83. * It's probably good if SIZEOF_SB <= GFS2_BASIC_BLOCK (512 bytes)
  84. *
  85. * Order is important, need to be able to read old superblocks to do on-disk
  86. * version upgrades.
  87. */
  88. /* Address of superblock in GFS2 basic blocks */
  89. #define GFS2_SB_ADDR 128
  90. /* The lock number for the superblock (must be zero) */
  91. #define GFS2_SB_LOCK 0
  92. /* Requirement: GFS2_LOCKNAME_LEN % 8 == 0
  93. Includes: the fencing zero at the end */
  94. #define GFS2_LOCKNAME_LEN 64
  95. struct gfs2_sb {
  96. struct gfs2_meta_header sb_header;
  97. __be32 sb_fs_format;
  98. __be32 sb_multihost_format;
  99. __u32 __pad0; /* Was superblock flags in gfs1 */
  100. __be32 sb_bsize;
  101. __be32 sb_bsize_shift;
  102. __u32 __pad1; /* Was journal segment size in gfs1 */
  103. struct gfs2_inum sb_master_dir; /* Was jindex dinode in gfs1 */
  104. struct gfs2_inum __pad2; /* Was rindex dinode in gfs1 */
  105. struct gfs2_inum sb_root_dir;
  106. char sb_lockproto[GFS2_LOCKNAME_LEN];
  107. char sb_locktable[GFS2_LOCKNAME_LEN];
  108. struct gfs2_inum __pad3; /* Was quota inode in gfs1 */
  109. struct gfs2_inum __pad4; /* Was licence inode in gfs1 */
  110. #define GFS2_HAS_UUID 1
  111. __u8 sb_uuid[16]; /* The UUID, maybe 0 for backwards compat */
  112. };
  113. /*
  114. * resource index structure
  115. */
  116. struct gfs2_rindex {
  117. __be64 ri_addr; /* grp block disk address */
  118. __be32 ri_length; /* length of rgrp header in fs blocks */
  119. __u32 __pad;
  120. __be64 ri_data0; /* first data location */
  121. __be32 ri_data; /* num of data blocks in rgrp */
  122. __be32 ri_bitbytes; /* number of bytes in data bitmaps */
  123. __u8 ri_reserved[64];
  124. };
  125. /*
  126. * resource group header structure
  127. */
  128. /* Number of blocks per byte in rgrp */
  129. #define GFS2_NBBY 4
  130. #define GFS2_BIT_SIZE 2
  131. #define GFS2_BIT_MASK 0x00000003
  132. #define GFS2_BLKST_FREE 0
  133. #define GFS2_BLKST_USED 1
  134. #define GFS2_BLKST_UNLINKED 2
  135. #define GFS2_BLKST_DINODE 3
  136. #define GFS2_RGF_JOURNAL 0x00000001
  137. #define GFS2_RGF_METAONLY 0x00000002
  138. #define GFS2_RGF_DATAONLY 0x00000004
  139. #define GFS2_RGF_NOALLOC 0x00000008
  140. #define GFS2_RGF_TRIMMED 0x00000010
  141. struct gfs2_rgrp_lvb {
  142. __be32 rl_magic;
  143. __be32 rl_flags;
  144. __be32 rl_free;
  145. __be32 rl_dinodes;
  146. __be64 rl_igeneration;
  147. __be32 rl_unlinked;
  148. __be32 __pad;
  149. };
  150. struct gfs2_rgrp {
  151. struct gfs2_meta_header rg_header;
  152. __be32 rg_flags;
  153. __be32 rg_free;
  154. __be32 rg_dinodes;
  155. __be32 __pad;
  156. __be64 rg_igeneration;
  157. __u8 rg_reserved[80]; /* Several fields from gfs1 now reserved */
  158. };
  159. /*
  160. * quota structure
  161. */
  162. struct gfs2_quota {
  163. __be64 qu_limit;
  164. __be64 qu_warn;
  165. __be64 qu_value;
  166. __u8 qu_reserved[64];
  167. };
  168. /*
  169. * dinode structure
  170. */
  171. #define GFS2_MAX_META_HEIGHT 10
  172. #define GFS2_DIR_MAX_DEPTH 17
  173. #define DT2IF(dt) (((dt) << 12) & S_IFMT)
  174. #define IF2DT(sif) (((sif) & S_IFMT) >> 12)
  175. enum {
  176. gfs2fl_Jdata = 0,
  177. gfs2fl_ExHash = 1,
  178. gfs2fl_Unused = 2,
  179. gfs2fl_EaIndirect = 3,
  180. gfs2fl_Directio = 4,
  181. gfs2fl_Immutable = 5,
  182. gfs2fl_AppendOnly = 6,
  183. gfs2fl_NoAtime = 7,
  184. gfs2fl_Sync = 8,
  185. gfs2fl_System = 9,
  186. gfs2fl_TopLevel = 10,
  187. gfs2fl_TruncInProg = 29,
  188. gfs2fl_InheritDirectio = 30,
  189. gfs2fl_InheritJdata = 31,
  190. };
  191. /* Dinode flags */
  192. #define GFS2_DIF_JDATA 0x00000001
  193. #define GFS2_DIF_EXHASH 0x00000002
  194. #define GFS2_DIF_UNUSED 0x00000004 /* only in gfs1 */
  195. #define GFS2_DIF_EA_INDIRECT 0x00000008
  196. #define GFS2_DIF_DIRECTIO 0x00000010
  197. #define GFS2_DIF_IMMUTABLE 0x00000020
  198. #define GFS2_DIF_APPENDONLY 0x00000040
  199. #define GFS2_DIF_NOATIME 0x00000080
  200. #define GFS2_DIF_SYNC 0x00000100
  201. #define GFS2_DIF_SYSTEM 0x00000200 /* New in gfs2 */
  202. #define GFS2_DIF_TOPDIR 0x00000400 /* New in gfs2 */
  203. #define GFS2_DIF_TRUNC_IN_PROG 0x20000000 /* New in gfs2 */
  204. #define GFS2_DIF_INHERIT_DIRECTIO 0x40000000 /* only in gfs1 */
  205. #define GFS2_DIF_INHERIT_JDATA 0x80000000
  206. struct gfs2_dinode {
  207. struct gfs2_meta_header di_header;
  208. struct gfs2_inum di_num;
  209. __be32 di_mode; /* mode of file */
  210. __be32 di_uid; /* owner's user id */
  211. __be32 di_gid; /* owner's group id */
  212. __be32 di_nlink; /* number of links to this file */
  213. __be64 di_size; /* number of bytes in file */
  214. __be64 di_blocks; /* number of blocks in file */
  215. __be64 di_atime; /* time last accessed */
  216. __be64 di_mtime; /* time last modified */
  217. __be64 di_ctime; /* time last changed */
  218. __be32 di_major; /* device major number */
  219. __be32 di_minor; /* device minor number */
  220. /* This section varies from gfs1. Padding added to align with
  221. * remainder of dinode
  222. */
  223. __be64 di_goal_meta; /* rgrp to alloc from next */
  224. __be64 di_goal_data; /* data block goal */
  225. __be64 di_generation; /* generation number for NFS */
  226. __be32 di_flags; /* GFS2_DIF_... */
  227. __be32 di_payload_format; /* GFS2_FORMAT_... */
  228. __u16 __pad1; /* Was ditype in gfs1 */
  229. __be16 di_height; /* height of metadata */
  230. __u32 __pad2; /* Unused incarnation number from gfs1 */
  231. /* These only apply to directories */
  232. __u16 __pad3; /* Padding */
  233. __be16 di_depth; /* Number of bits in the table */
  234. __be32 di_entries; /* The number of entries in the directory */
  235. struct gfs2_inum __pad4; /* Unused even in current gfs1 */
  236. __be64 di_eattr; /* extended attribute block number */
  237. __be32 di_atime_nsec; /* nsec portion of atime */
  238. __be32 di_mtime_nsec; /* nsec portion of mtime */
  239. __be32 di_ctime_nsec; /* nsec portion of ctime */
  240. __u8 di_reserved[44];
  241. };
  242. /*
  243. * directory structure - many of these per directory file
  244. */
  245. #define GFS2_FNAMESIZE 255
  246. #define GFS2_DIRENT_SIZE(name_len) ((sizeof(struct gfs2_dirent) + (name_len) + 7) & ~7)
  247. struct gfs2_dirent {
  248. struct gfs2_inum de_inum;
  249. __be32 de_hash;
  250. __be16 de_rec_len;
  251. __be16 de_name_len;
  252. __be16 de_type;
  253. union {
  254. __u8 __pad[14];
  255. struct {
  256. __be16 de_rahead;
  257. __u8 pad2[12];
  258. };
  259. };
  260. };
  261. /*
  262. * Header of leaf directory nodes
  263. */
  264. struct gfs2_leaf {
  265. struct gfs2_meta_header lf_header;
  266. __be16 lf_depth; /* Depth of leaf */
  267. __be16 lf_entries; /* Number of dirents in leaf */
  268. __be32 lf_dirent_format; /* Format of the dirents */
  269. __be64 lf_next; /* Next leaf, if overflow */
  270. union {
  271. __u8 lf_reserved[64];
  272. struct {
  273. __be64 lf_inode; /* Dir inode number */
  274. __be32 lf_dist; /* Dist from inode on chain */
  275. __be32 lf_nsec; /* Last ins/del usecs */
  276. __be64 lf_sec; /* Last ins/del in secs */
  277. __u8 lf_reserved2[40];
  278. };
  279. };
  280. };
  281. /*
  282. * Extended attribute header format
  283. *
  284. * This works in a similar way to dirents. There is a fixed size header
  285. * followed by a variable length section made up of the name and the
  286. * associated data. In the case of a "stuffed" entry, the value is
  287. * __inline__ directly after the name, the ea_num_ptrs entry will be
  288. * zero in that case. For non-"stuffed" entries, there will be
  289. * a set of pointers (aligned to 8 byte boundary) to the block(s)
  290. * containing the value.
  291. *
  292. * The blocks containing the values and the blocks containing the
  293. * extended attribute headers themselves all start with the common
  294. * metadata header. Each inode, if it has extended attributes, will
  295. * have either a single block containing the extended attribute headers
  296. * or a single indirect block pointing to blocks containing the
  297. * extended attribute headers.
  298. *
  299. * The maximum size of the data part of an extended attribute is 64k
  300. * so the number of blocks required depends upon block size. Since the
  301. * block size also determines the number of pointers in an indirect
  302. * block, its a fairly complicated calculation to work out the maximum
  303. * number of blocks that an inode may have relating to extended attributes.
  304. *
  305. */
  306. #define GFS2_EA_MAX_NAME_LEN 255
  307. #define GFS2_EA_MAX_DATA_LEN 65536
  308. #define GFS2_EATYPE_UNUSED 0
  309. #define GFS2_EATYPE_USR 1
  310. #define GFS2_EATYPE_SYS 2
  311. #define GFS2_EATYPE_SECURITY 3
  312. #define GFS2_EATYPE_LAST 3
  313. #define GFS2_EATYPE_VALID(x) ((x) <= GFS2_EATYPE_LAST)
  314. #define GFS2_EAFLAG_LAST 0x01 /* last ea in block */
  315. struct gfs2_ea_header {
  316. __be32 ea_rec_len;
  317. __be32 ea_data_len;
  318. __u8 ea_name_len; /* no NULL pointer after the string */
  319. __u8 ea_type; /* GFS2_EATYPE_... */
  320. __u8 ea_flags; /* GFS2_EAFLAG_... */
  321. __u8 ea_num_ptrs;
  322. __u32 __pad;
  323. };
  324. /*
  325. * Log header structure
  326. */
  327. #define GFS2_LOG_HEAD_UNMOUNT 0x00000001 /* log is clean */
  328. struct gfs2_log_header {
  329. struct gfs2_meta_header lh_header;
  330. __be64 lh_sequence; /* Sequence number of this transaction */
  331. __be32 lh_flags; /* GFS2_LOG_HEAD_... */
  332. __be32 lh_tail; /* Block number of log tail */
  333. __be32 lh_blkno;
  334. __be32 lh_hash;
  335. };
  336. /*
  337. * Log type descriptor
  338. */
  339. #define GFS2_LOG_DESC_METADATA 300
  340. /* ld_data1 is the number of metadata blocks in the descriptor.
  341. ld_data2 is unused. */
  342. #define GFS2_LOG_DESC_REVOKE 301
  343. /* ld_data1 is the number of revoke blocks in the descriptor.
  344. ld_data2 is unused. */
  345. #define GFS2_LOG_DESC_JDATA 302
  346. /* ld_data1 is the number of data blocks in the descriptor.
  347. ld_data2 is unused. */
  348. struct gfs2_log_descriptor {
  349. struct gfs2_meta_header ld_header;
  350. __be32 ld_type; /* GFS2_LOG_DESC_... */
  351. __be32 ld_length; /* Number of buffers in this chunk */
  352. __be32 ld_data1; /* descriptor-specific field */
  353. __be32 ld_data2; /* descriptor-specific field */
  354. __u8 ld_reserved[32];
  355. };
  356. /*
  357. * Inum Range
  358. * Describe a range of formal inode numbers allocated to
  359. * one machine to assign to inodes.
  360. */
  361. #define GFS2_INUM_QUANTUM 1048576
  362. struct gfs2_inum_range {
  363. __be64 ir_start;
  364. __be64 ir_length;
  365. };
  366. /*
  367. * Statfs change
  368. * Describes an change to the pool of free and allocated
  369. * blocks.
  370. */
  371. struct gfs2_statfs_change {
  372. __be64 sc_total;
  373. __be64 sc_free;
  374. __be64 sc_dinodes;
  375. };
  376. /*
  377. * Quota change
  378. * Describes an allocation change for a particular
  379. * user or group.
  380. */
  381. #define GFS2_QCF_USER 0x00000001
  382. struct gfs2_quota_change {
  383. __be64 qc_change;
  384. __be32 qc_flags; /* GFS2_QCF_... */
  385. __be32 qc_id;
  386. };
  387. struct gfs2_quota_lvb {
  388. __be32 qb_magic;
  389. __u32 __pad;
  390. __be64 qb_limit; /* Hard limit of # blocks to alloc */
  391. __be64 qb_warn; /* Warn user when alloc is above this # */
  392. __be64 qb_value; /* Current # blocks allocated */
  393. };
  394. #endif /* __GFS2_ONDISK_DOT_H__ */