blob: 14d0df0b5749833b823b4ff8cfd7de1c08a4e4b3 [file] [log] [blame]
David Teiglandb3b94fa2006-01-16 16:50:04 +00001/*
Steven Whitehousefeaa7bb2006-06-14 15:32:57 -04002 * 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 */
David Teiglandb3b94fa2006-01-16 16:50:04 +00009
10#ifndef __GFS2_ONDISK_DOT_H__
11#define __GFS2_ONDISK_DOT_H__
12
13#define GFS2_MAGIC 0x01161970
14#define GFS2_BASIC_BLOCK 512
15#define GFS2_BASIC_BLOCK_SHIFT 9
16
17/* Lock numbers of the LM_TYPE_NONDISK type */
18
19#define GFS2_MOUNT_LOCK 0
20#define GFS2_LIVE_LOCK 1
21#define GFS2_TRANS_LOCK 2
22#define GFS2_RENAME_LOCK 3
23
24/* Format numbers for various metadata types */
25
26#define GFS2_FORMAT_NONE 0
27#define GFS2_FORMAT_SB 100
28#define GFS2_FORMAT_RG 200
29#define GFS2_FORMAT_RB 300
30#define GFS2_FORMAT_DI 400
31#define GFS2_FORMAT_IN 500
32#define GFS2_FORMAT_LF 600
33#define GFS2_FORMAT_JD 700
34#define GFS2_FORMAT_LH 800
35#define GFS2_FORMAT_LD 900
36#define GFS2_FORMAT_LB 1000
Steven Whitehousefc69d0d2006-02-13 16:21:47 +000037#define GFS2_FORMAT_EA 1600
38#define GFS2_FORMAT_ED 1700
David Teiglandb3b94fa2006-01-16 16:50:04 +000039#define GFS2_FORMAT_QC 1400
40/* These are format numbers for entities contained in files */
Steven Whitehousefc69d0d2006-02-13 16:21:47 +000041#define GFS2_FORMAT_RI 1100
42#define GFS2_FORMAT_DE 1200
43#define GFS2_FORMAT_QU 1500
David Teiglandb3b94fa2006-01-16 16:50:04 +000044/* These are part of the superblock */
45#define GFS2_FORMAT_FS 1801
46#define GFS2_FORMAT_MULTI 1900
47
48/*
49 * An on-disk inode number
50 */
51
David Teiglandb3b94fa2006-01-16 16:50:04 +000052struct gfs2_inum {
53 __be64 no_formal_ino;
54 __be64 no_addr;
55};
56
57/*
58 * Generic metadata head structure
59 * Every inplace buffer logged in the journal must start with this.
60 */
61
62#define GFS2_METATYPE_NONE 0
63#define GFS2_METATYPE_SB 1
64#define GFS2_METATYPE_RG 2
65#define GFS2_METATYPE_RB 3
66#define GFS2_METATYPE_DI 4
67#define GFS2_METATYPE_IN 5
68#define GFS2_METATYPE_LF 6
69#define GFS2_METATYPE_JD 7
70#define GFS2_METATYPE_LH 8
71#define GFS2_METATYPE_LD 9
Steven Whitehousefc69d0d2006-02-13 16:21:47 +000072#define GFS2_METATYPE_LB 12
73#define GFS2_METATYPE_EA 10
74#define GFS2_METATYPE_ED 11
David Teiglandb3b94fa2006-01-16 16:50:04 +000075#define GFS2_METATYPE_QC 14
76
77struct gfs2_meta_header {
78 __be32 mh_magic;
79 __be32 mh_type;
80 __be64 __pad0; /* Was generation number in gfs1 */
81 __be32 mh_format;
82 __be32 __pad1; /* Was incarnation number in gfs1 */
83};
84
85/*
86 * super-block structure
87 *
88 * It's probably good if SIZEOF_SB <= GFS2_BASIC_BLOCK (512 bytes)
89 *
90 * Order is important, need to be able to read old superblocks to do on-disk
91 * version upgrades.
92 */
93
94/* Address of superblock in GFS2 basic blocks */
95#define GFS2_SB_ADDR 128
96
97/* The lock number for the superblock (must be zero) */
98#define GFS2_SB_LOCK 0
99
100/* Requirement: GFS2_LOCKNAME_LEN % 8 == 0
101 Includes: the fencing zero at the end */
102#define GFS2_LOCKNAME_LEN 64
103
104struct gfs2_sb {
105 struct gfs2_meta_header sb_header;
106
107 __be32 sb_fs_format;
108 __be32 sb_multihost_format;
109 __u32 __pad0; /* Was superblock flags in gfs1 */
110
111 __be32 sb_bsize;
112 __be32 sb_bsize_shift;
113 __u32 __pad1; /* Was journal segment size in gfs1 */
114
115 struct gfs2_inum sb_master_dir; /* Was jindex dinode in gfs1 */
116 struct gfs2_inum __pad2; /* Was rindex dinode in gfs1 */
117 struct gfs2_inum sb_root_dir;
118
119 char sb_lockproto[GFS2_LOCKNAME_LEN];
120 char sb_locktable[GFS2_LOCKNAME_LEN];
Steven Whitehouse6d80c392008-09-22 07:29:31 +0100121
122 struct gfs2_inum __pad3; /* Was quota inode in gfs1 */
123 struct gfs2_inum __pad4; /* Was licence inode in gfs1 */
124#define GFS2_HAS_UUID 1
125 __u8 sb_uuid[16]; /* The UUID, maybe 0 for backwards compat */
David Teiglandb3b94fa2006-01-16 16:50:04 +0000126};
127
128/*
129 * resource index structure
130 */
131
132struct gfs2_rindex {
133 __be64 ri_addr; /* grp block disk address */
134 __be32 ri_length; /* length of rgrp header in fs blocks */
135 __u32 __pad;
136
137 __be64 ri_data0; /* first data location */
138 __be32 ri_data; /* num of data blocks in rgrp */
139
140 __be32 ri_bitbytes; /* number of bytes in data bitmaps */
141
142 __u8 ri_reserved[64];
143};
144
145/*
146 * resource group header structure
147 */
148
149/* Number of blocks per byte in rgrp */
150#define GFS2_NBBY 4
151#define GFS2_BIT_SIZE 2
152#define GFS2_BIT_MASK 0x00000003
153
154#define GFS2_BLKST_FREE 0
155#define GFS2_BLKST_USED 1
Steven Whitehousefeaa7bb2006-06-14 15:32:57 -0400156#define GFS2_BLKST_UNLINKED 2
David Teiglandb3b94fa2006-01-16 16:50:04 +0000157#define GFS2_BLKST_DINODE 3
158
159#define GFS2_RGF_JOURNAL 0x00000001
160#define GFS2_RGF_METAONLY 0x00000002
161#define GFS2_RGF_DATAONLY 0x00000004
162#define GFS2_RGF_NOALLOC 0x00000008
163
164struct gfs2_rgrp {
165 struct gfs2_meta_header rg_header;
166
167 __be32 rg_flags;
168 __be32 rg_free;
169 __be32 rg_dinodes;
Steven Whitehouse4340fe62006-07-11 09:46:33 -0400170 __be32 __pad;
171 __be64 rg_igeneration;
David Teiglandb3b94fa2006-01-16 16:50:04 +0000172
Steven Whitehouse4340fe62006-07-11 09:46:33 -0400173 __u8 rg_reserved[80]; /* Several fields from gfs1 now reserved */
David Teiglandb3b94fa2006-01-16 16:50:04 +0000174};
175
176/*
Abhijith Das2d9a4bb2007-08-15 11:25:05 -0500177 * quota linked list: user quotas and group quotas form two separate
178 * singly linked lists. ll_next stores uids or gids of next quotas in the
179 * linked list.
180
181Given the uid/gid, how to calculate the quota file offsets for the corresponding
182gfs2_quota structures on disk:
183
184for user quotas, given uid,
185offset = uid * sizeof(struct gfs2_quota);
186
187for group quotas, given gid,
188offset = (gid * sizeof(struct gfs2_quota)) + sizeof(struct gfs2_quota);
189
190
191 uid:0 gid:0 uid:12 gid:12 uid:17 gid:17 uid:5142 gid:5142
192+-------+-------+ +-------+-------+ +-------+- - - -+ +- - - -+-------+
193| valid | valid | :: | valid | valid | :: | valid | inval | :: | inval | valid |
194+-------+-------+ +-------+-------+ +-------+- - - -+ +- - - -+-------+
195next:12 next:12 next:17 next:5142 next:NULL next:NULL
196 | | | | |<-- user quota list |
197 \______|___________/ \______|___________/ group quota list -->|
198 | | |
199 \__________________/ \_______________________________________/
200
201*/
202
203/*
David Teiglandb3b94fa2006-01-16 16:50:04 +0000204 * quota structure
205 */
206
207struct gfs2_quota {
208 __be64 qu_limit;
209 __be64 qu_warn;
210 __be64 qu_value;
Abhijith Das2d9a4bb2007-08-15 11:25:05 -0500211 __be32 qu_ll_next; /* location of next quota in list */
212 __u8 qu_reserved[60];
David Teiglandb3b94fa2006-01-16 16:50:04 +0000213};
214
215/*
216 * dinode structure
217 */
218
219#define GFS2_MAX_META_HEIGHT 10
220#define GFS2_DIR_MAX_DEPTH 17
221
222#define DT2IF(dt) (((dt) << 12) & S_IFMT)
223#define IF2DT(sif) (((sif) & S_IFMT) >> 12)
224
Steven Whitehouse7ea9ea82006-03-31 15:01:28 -0500225enum {
226 gfs2fl_Jdata = 0,
227 gfs2fl_ExHash = 1,
228 gfs2fl_Unused = 2,
229 gfs2fl_EaIndirect = 3,
230 gfs2fl_Directio = 4,
231 gfs2fl_Immutable = 5,
232 gfs2fl_AppendOnly = 6,
233 gfs2fl_NoAtime = 7,
234 gfs2fl_Sync = 8,
235 gfs2fl_System = 9,
236 gfs2fl_TruncInProg = 29,
237 gfs2fl_InheritDirectio = 30,
238 gfs2fl_InheritJdata = 31,
239};
240
David Teiglandb3b94fa2006-01-16 16:50:04 +0000241/* Dinode flags */
242#define GFS2_DIF_JDATA 0x00000001
243#define GFS2_DIF_EXHASH 0x00000002
244#define GFS2_DIF_UNUSED 0x00000004 /* only in gfs1 */
245#define GFS2_DIF_EA_INDIRECT 0x00000008
246#define GFS2_DIF_DIRECTIO 0x00000010
247#define GFS2_DIF_IMMUTABLE 0x00000020
248#define GFS2_DIF_APPENDONLY 0x00000040
249#define GFS2_DIF_NOATIME 0x00000080
250#define GFS2_DIF_SYNC 0x00000100
251#define GFS2_DIF_SYSTEM 0x00000200 /* New in gfs2 */
252#define GFS2_DIF_TRUNC_IN_PROG 0x20000000 /* New in gfs2 */
253#define GFS2_DIF_INHERIT_DIRECTIO 0x40000000
254#define GFS2_DIF_INHERIT_JDATA 0x80000000
255
256struct gfs2_dinode {
257 struct gfs2_meta_header di_header;
258
259 struct gfs2_inum di_num;
260
261 __be32 di_mode; /* mode of file */
262 __be32 di_uid; /* owner's user id */
263 __be32 di_gid; /* owner's group id */
264 __be32 di_nlink; /* number of links to this file */
265 __be64 di_size; /* number of bytes in file */
266 __be64 di_blocks; /* number of blocks in file */
267 __be64 di_atime; /* time last accessed */
268 __be64 di_mtime; /* time last modified */
269 __be64 di_ctime; /* time last changed */
270 __be32 di_major; /* device major number */
271 __be32 di_minor; /* device minor number */
272
273 /* This section varies from gfs1. Padding added to align with
274 * remainder of dinode
275 */
276 __be64 di_goal_meta; /* rgrp to alloc from next */
277 __be64 di_goal_data; /* data block goal */
Steven Whitehouse4340fe62006-07-11 09:46:33 -0400278 __be64 di_generation; /* generation number for NFS */
David Teiglandb3b94fa2006-01-16 16:50:04 +0000279
280 __be32 di_flags; /* GFS2_DIF_... */
281 __be32 di_payload_format; /* GFS2_FORMAT_... */
282 __u16 __pad1; /* Was ditype in gfs1 */
283 __be16 di_height; /* height of metadata */
284 __u32 __pad2; /* Unused incarnation number from gfs1 */
285
286 /* These only apply to directories */
287 __u16 __pad3; /* Padding */
288 __be16 di_depth; /* Number of bits in the table */
289 __be32 di_entries; /* The number of entries in the directory */
290
291 struct gfs2_inum __pad4; /* Unused even in current gfs1 */
292
293 __be64 di_eattr; /* extended attribute block number */
Steven Whitehouse4bd91ba2007-06-05 09:39:18 +0100294 __be32 di_atime_nsec; /* nsec portion of atime */
295 __be32 di_mtime_nsec; /* nsec portion of mtime */
296 __be32 di_ctime_nsec; /* nsec portion of ctime */
David Teiglandb3b94fa2006-01-16 16:50:04 +0000297
Steven Whitehouse4bd91ba2007-06-05 09:39:18 +0100298 __u8 di_reserved[44];
David Teiglandb3b94fa2006-01-16 16:50:04 +0000299};
300
301/*
302 * directory structure - many of these per directory file
303 */
304
305#define GFS2_FNAMESIZE 255
306#define GFS2_DIRENT_SIZE(name_len) ((sizeof(struct gfs2_dirent) + (name_len) + 7) & ~7)
307
308struct gfs2_dirent {
309 struct gfs2_inum de_inum;
310 __be32 de_hash;
Steven Whitehousefc69d0d2006-02-13 16:21:47 +0000311 __be16 de_rec_len;
312 __be16 de_name_len;
313 __be16 de_type;
314 __u8 __pad[14];
David Teiglandb3b94fa2006-01-16 16:50:04 +0000315};
316
317/*
318 * Header of leaf directory nodes
319 */
320
321struct gfs2_leaf {
322 struct gfs2_meta_header lf_header;
323
324 __be16 lf_depth; /* Depth of leaf */
325 __be16 lf_entries; /* Number of dirents in leaf */
326 __be32 lf_dirent_format; /* Format of the dirents */
327 __be64 lf_next; /* Next leaf, if overflow */
328
Steven Whitehousefc69d0d2006-02-13 16:21:47 +0000329 __u8 lf_reserved[64];
David Teiglandb3b94fa2006-01-16 16:50:04 +0000330};
331
332/*
333 * Extended attribute header format
334 */
335
336#define GFS2_EA_MAX_NAME_LEN 255
337#define GFS2_EA_MAX_DATA_LEN 65536
338
339#define GFS2_EATYPE_UNUSED 0
340#define GFS2_EATYPE_USR 1
341#define GFS2_EATYPE_SYS 2
Ryan O'Hara639b6d72006-05-22 10:08:35 -0400342#define GFS2_EATYPE_SECURITY 3
David Teiglandb3b94fa2006-01-16 16:50:04 +0000343
Ryan O'Hara639b6d72006-05-22 10:08:35 -0400344#define GFS2_EATYPE_LAST 3
David Teiglandb3b94fa2006-01-16 16:50:04 +0000345#define GFS2_EATYPE_VALID(x) ((x) <= GFS2_EATYPE_LAST)
346
347#define GFS2_EAFLAG_LAST 0x01 /* last ea in block */
348
349struct gfs2_ea_header {
350 __be32 ea_rec_len;
351 __be32 ea_data_len;
352 __u8 ea_name_len; /* no NULL pointer after the string */
353 __u8 ea_type; /* GFS2_EATYPE_... */
354 __u8 ea_flags; /* GFS2_EAFLAG_... */
355 __u8 ea_num_ptrs;
356 __u32 __pad;
357};
358
359/*
360 * Log header structure
361 */
362
363#define GFS2_LOG_HEAD_UNMOUNT 0x00000001 /* log is clean */
364
365struct gfs2_log_header {
366 struct gfs2_meta_header lh_header;
367
368 __be64 lh_sequence; /* Sequence number of this transaction */
369 __be32 lh_flags; /* GFS2_LOG_HEAD_... */
370 __be32 lh_tail; /* Block number of log tail */
371 __be32 lh_blkno;
372 __be32 lh_hash;
373};
374
375/*
376 * Log type descriptor
377 */
378
379#define GFS2_LOG_DESC_METADATA 300
380/* ld_data1 is the number of metadata blocks in the descriptor.
381 ld_data2 is unused. */
382
383#define GFS2_LOG_DESC_REVOKE 301
384/* ld_data1 is the number of revoke blocks in the descriptor.
385 ld_data2 is unused. */
386
Steven Whitehouse18ec7d52006-02-08 11:50:51 +0000387#define GFS2_LOG_DESC_JDATA 302
388/* ld_data1 is the number of data blocks in the descriptor.
389 ld_data2 is unused. */
390
David Teiglandb3b94fa2006-01-16 16:50:04 +0000391struct gfs2_log_descriptor {
392 struct gfs2_meta_header ld_header;
393
394 __be32 ld_type; /* GFS2_LOG_DESC_... */
395 __be32 ld_length; /* Number of buffers in this chunk */
396 __be32 ld_data1; /* descriptor-specific field */
397 __be32 ld_data2; /* descriptor-specific field */
398
399 __u8 ld_reserved[32];
400};
401
402/*
403 * Inum Range
404 * Describe a range of formal inode numbers allocated to
405 * one machine to assign to inodes.
406 */
407
408#define GFS2_INUM_QUANTUM 1048576
409
410struct gfs2_inum_range {
411 __be64 ir_start;
412 __be64 ir_length;
413};
414
415/*
416 * Statfs change
417 * Describes an change to the pool of free and allocated
418 * blocks.
419 */
420
421struct gfs2_statfs_change {
422 __be64 sc_total;
423 __be64 sc_free;
424 __be64 sc_dinodes;
425};
426
427/*
David Teiglandb3b94fa2006-01-16 16:50:04 +0000428 * Quota change
429 * Describes an allocation change for a particular
430 * user or group.
431 */
432
433#define GFS2_QCF_USER 0x00000001
434
435struct gfs2_quota_change {
436 __be64 qc_change;
437 __be32 qc_flags; /* GFS2_QCF_... */
438 __be32 qc_id;
439};
440
Abhijith Das2a87ab02007-05-16 17:02:19 -0500441struct gfs2_quota_lvb {
442 __be32 qb_magic;
Fabio Massimo Di Nitto518bbde2007-05-22 09:00:24 +0200443 __u32 __pad;
Abhijith Das2a87ab02007-05-16 17:02:19 -0500444 __be64 qb_limit; /* Hard limit of # blocks to alloc */
445 __be64 qb_warn; /* Warn user when alloc is above this # */
446 __be64 qb_value; /* Current # blocks allocated */
447};
448
David Teiglandb3b94fa2006-01-16 16:50:04 +0000449#endif /* __GFS2_ONDISK_DOT_H__ */