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