Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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#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
37#define GFS2_FORMAT_EA 1600
38#define GFS2_FORMAT_ED 1700
39#define GFS2_FORMAT_QC 1400
40/* These are format numbers for entities contained in files */
41#define GFS2_FORMAT_RI 1100
42#define GFS2_FORMAT_DE 1200
43#define GFS2_FORMAT_QU 1500
44/* 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
52struct gfs2_inum {
53 __be64 no_formal_ino;
54 __be64 no_addr;
55};
56
57struct gfs2_inum_host {
58 __u64 no_formal_ino;
59 __u64 no_addr;
60};
61
62static inline int gfs2_inum_equal(const struct gfs2_inum_host *ino1,
63 const struct gfs2_inum_host *ino2)
64{
65 return ino1->no_formal_ino == ino2->no_formal_ino &&
66 ino1->no_addr == ino2->no_addr;
67}
68
69/*
70 * Generic metadata head structure
71 * Every inplace buffer logged in the journal must start with this.
72 */
73
74#define GFS2_METATYPE_NONE 0
75#define GFS2_METATYPE_SB 1
76#define GFS2_METATYPE_RG 2
77#define GFS2_METATYPE_RB 3
78#define GFS2_METATYPE_DI 4
79#define GFS2_METATYPE_IN 5
80#define GFS2_METATYPE_LF 6
81#define GFS2_METATYPE_JD 7
82#define GFS2_METATYPE_LH 8
83#define GFS2_METATYPE_LD 9
84#define GFS2_METATYPE_LB 12
85#define GFS2_METATYPE_EA 10
86#define GFS2_METATYPE_ED 11
87#define GFS2_METATYPE_QC 14
88
89struct gfs2_meta_header {
90 __be32 mh_magic;
91 __be32 mh_type;
92 __be64 __pad0; /* Was generation number in gfs1 */
93 __be32 mh_format;
94 __be32 __pad1; /* Was incarnation number in gfs1 */
95};
96
97struct gfs2_meta_header_host {
98 __u32 mh_magic;
99 __u32 mh_type;
100 __u32 mh_format;
101};
102
103/*
104 * super-block structure
105 *
106 * It's probably good if SIZEOF_SB <= GFS2_BASIC_BLOCK (512 bytes)
107 *
108 * Order is important, need to be able to read old superblocks to do on-disk
109 * version upgrades.
110 */
111
112/* Address of superblock in GFS2 basic blocks */
113#define GFS2_SB_ADDR 128
114
115/* The lock number for the superblock (must be zero) */
116#define GFS2_SB_LOCK 0
117
118/* Requirement: GFS2_LOCKNAME_LEN % 8 == 0
119 Includes: the fencing zero at the end */
120#define GFS2_LOCKNAME_LEN 64
121
122struct gfs2_sb {
123 struct gfs2_meta_header sb_header;
124
125 __be32 sb_fs_format;
126 __be32 sb_multihost_format;
127 __u32 __pad0; /* Was superblock flags in gfs1 */
128
129 __be32 sb_bsize;
130 __be32 sb_bsize_shift;
131 __u32 __pad1; /* Was journal segment size in gfs1 */
132
133 struct gfs2_inum sb_master_dir; /* Was jindex dinode in gfs1 */
134 struct gfs2_inum __pad2; /* Was rindex dinode in gfs1 */
135 struct gfs2_inum sb_root_dir;
136
137 char sb_lockproto[GFS2_LOCKNAME_LEN];
138 char sb_locktable[GFS2_LOCKNAME_LEN];
139 /* In gfs1, quota and license dinodes followed */
140};
141
142struct gfs2_sb_host {
143 struct gfs2_meta_header_host sb_header;
144
145 __u32 sb_fs_format;
146 __u32 sb_multihost_format;
147
148 __u32 sb_bsize;
149 __u32 sb_bsize_shift;
150
151 struct gfs2_inum_host sb_master_dir; /* Was jindex dinode in gfs1 */
152 struct gfs2_inum_host sb_root_dir;
153
154 char sb_lockproto[GFS2_LOCKNAME_LEN];
155 char sb_locktable[GFS2_LOCKNAME_LEN];
156 /* In gfs1, quota and license dinodes followed */
157};
158
159/*
160 * resource index structure
161 */
162
163struct gfs2_rindex {
164 __be64 ri_addr; /* grp block disk address */
165 __be32 ri_length; /* length of rgrp header in fs blocks */
166 __u32 __pad;
167
168 __be64 ri_data0; /* first data location */
169 __be32 ri_data; /* num of data blocks in rgrp */
170
171 __be32 ri_bitbytes; /* number of bytes in data bitmaps */
172
173 __u8 ri_reserved[64];
174};
175
176struct gfs2_rindex_host {
177 __u64 ri_addr; /* grp block disk address */
178 __u64 ri_data0; /* first data location */
179 __u32 ri_length; /* length of rgrp header in fs blocks */
180 __u32 ri_data; /* num of data blocks in rgrp */
181 __u32 ri_bitbytes; /* number of bytes in data bitmaps */
182};
183
184/*
185 * resource group header structure
186 */
187
188/* Number of blocks per byte in rgrp */
189#define GFS2_NBBY 4
190#define GFS2_BIT_SIZE 2
191#define GFS2_BIT_MASK 0x00000003
192
193#define GFS2_BLKST_FREE 0
194#define GFS2_BLKST_USED 1
195#define GFS2_BLKST_UNLINKED 2
196#define GFS2_BLKST_DINODE 3
197
198#define GFS2_RGF_JOURNAL 0x00000001
199#define GFS2_RGF_METAONLY 0x00000002
200#define GFS2_RGF_DATAONLY 0x00000004
201#define GFS2_RGF_NOALLOC 0x00000008
202
203struct gfs2_rgrp {
204 struct gfs2_meta_header rg_header;
205
206 __be32 rg_flags;
207 __be32 rg_free;
208 __be32 rg_dinodes;
209 __be32 __pad;
210 __be64 rg_igeneration;
211
212 __u8 rg_reserved[80]; /* Several fields from gfs1 now reserved */
213};
214
215struct gfs2_rgrp_host {
216 __u32 rg_flags;
217 __u32 rg_free;
218 __u32 rg_dinodes;
219 __u64 rg_igeneration;
220};
221
222/*
223 * quota structure
224 */
225
226struct gfs2_quota {
227 __be64 qu_limit;
228 __be64 qu_warn;
229 __be64 qu_value;
230 __u8 qu_reserved[64];
231};
232
233struct gfs2_quota_host {
234 __u64 qu_limit;
235 __u64 qu_warn;
236 __u64 qu_value;
237};
238
239/*
240 * dinode structure
241 */
242
243#define GFS2_MAX_META_HEIGHT 10
244#define GFS2_DIR_MAX_DEPTH 17
245
246#define DT2IF(dt) (((dt) << 12) & S_IFMT)
247#define IF2DT(sif) (((sif) & S_IFMT) >> 12)
248
249enum {
250 gfs2fl_Jdata = 0,
251 gfs2fl_ExHash = 1,
252 gfs2fl_Unused = 2,
253 gfs2fl_EaIndirect = 3,
254 gfs2fl_Directio = 4,
255 gfs2fl_Immutable = 5,
256 gfs2fl_AppendOnly = 6,
257 gfs2fl_NoAtime = 7,
258 gfs2fl_Sync = 8,
259 gfs2fl_System = 9,
260 gfs2fl_TruncInProg = 29,
261 gfs2fl_InheritDirectio = 30,
262 gfs2fl_InheritJdata = 31,
263};
264
265/* Dinode flags */
266#define GFS2_DIF_JDATA 0x00000001
267#define GFS2_DIF_EXHASH 0x00000002
268#define GFS2_DIF_UNUSED 0x00000004 /* only in gfs1 */
269#define GFS2_DIF_EA_INDIRECT 0x00000008
270#define GFS2_DIF_DIRECTIO 0x00000010
271#define GFS2_DIF_IMMUTABLE 0x00000020
272#define GFS2_DIF_APPENDONLY 0x00000040
273#define GFS2_DIF_NOATIME 0x00000080
274#define GFS2_DIF_SYNC 0x00000100
275#define GFS2_DIF_SYSTEM 0x00000200 /* New in gfs2 */
276#define GFS2_DIF_TRUNC_IN_PROG 0x20000000 /* New in gfs2 */
277#define GFS2_DIF_INHERIT_DIRECTIO 0x40000000
278#define GFS2_DIF_INHERIT_JDATA 0x80000000
279
280struct gfs2_dinode {
281 struct gfs2_meta_header di_header;
282
283 struct gfs2_inum di_num;
284
285 __be32 di_mode; /* mode of file */
286 __be32 di_uid; /* owner's user id */
287 __be32 di_gid; /* owner's group id */
288 __be32 di_nlink; /* number of links to this file */
289 __be64 di_size; /* number of bytes in file */
290 __be64 di_blocks; /* number of blocks in file */
291 __be64 di_atime; /* time last accessed */
292 __be64 di_mtime; /* time last modified */
293 __be64 di_ctime; /* time last changed */
294 __be32 di_major; /* device major number */
295 __be32 di_minor; /* device minor number */
296
297 /* This section varies from gfs1. Padding added to align with
298 * remainder of dinode
299 */
300 __be64 di_goal_meta; /* rgrp to alloc from next */
301 __be64 di_goal_data; /* data block goal */
302 __be64 di_generation; /* generation number for NFS */
303
304 __be32 di_flags; /* GFS2_DIF_... */
305 __be32 di_payload_format; /* GFS2_FORMAT_... */
306 __u16 __pad1; /* Was ditype in gfs1 */
307 __be16 di_height; /* height of metadata */
308 __u32 __pad2; /* Unused incarnation number from gfs1 */
309
310 /* These only apply to directories */
311 __u16 __pad3; /* Padding */
312 __be16 di_depth; /* Number of bits in the table */
313 __be32 di_entries; /* The number of entries in the directory */
314
315 struct gfs2_inum __pad4; /* Unused even in current gfs1 */
316
317 __be64 di_eattr; /* extended attribute block number */
318
319 __u8 di_reserved[56];
320};
321
322struct gfs2_dinode_host {
323 __u64 di_size; /* number of bytes in file */
324 __u64 di_blocks; /* number of blocks in file */
325
326 /* This section varies from gfs1. Padding added to align with
327 * remainder of dinode
328 */
329 __u64 di_goal_meta; /* rgrp to alloc from next */
330 __u64 di_goal_data; /* data block goal */
331 __u64 di_generation; /* generation number for NFS */
332
333 __u32 di_flags; /* GFS2_DIF_... */
334 __u16 di_height; /* height of metadata */
335
336 /* These only apply to directories */
337 __u16 di_depth; /* Number of bits in the table */
338 __u32 di_entries; /* The number of entries in the directory */
339
340 __u64 di_eattr; /* extended attribute block number */
341};
342
343/*
344 * directory structure - many of these per directory file
345 */
346
347#define GFS2_FNAMESIZE 255
348#define GFS2_DIRENT_SIZE(name_len) ((sizeof(struct gfs2_dirent) + (name_len) + 7) & ~7)
349
350struct gfs2_dirent {
351 struct gfs2_inum de_inum;
352 __be32 de_hash;
353 __be16 de_rec_len;
354 __be16 de_name_len;
355 __be16 de_type;
356 __u8 __pad[14];
357};
358
359/*
360 * Header of leaf directory nodes
361 */
362
363struct gfs2_leaf {
364 struct gfs2_meta_header lf_header;
365
366 __be16 lf_depth; /* Depth of leaf */
367 __be16 lf_entries; /* Number of dirents in leaf */
368 __be32 lf_dirent_format; /* Format of the dirents */
369 __be64 lf_next; /* Next leaf, if overflow */
370
371 __u8 lf_reserved[64];
372};
373
374/*
375 * Extended attribute header format
376 */
377
378#define GFS2_EA_MAX_NAME_LEN 255
379#define GFS2_EA_MAX_DATA_LEN 65536
380
381#define GFS2_EATYPE_UNUSED 0
382#define GFS2_EATYPE_USR 1
383#define GFS2_EATYPE_SYS 2
384#define GFS2_EATYPE_SECURITY 3
385
386#define GFS2_EATYPE_LAST 3
387#define GFS2_EATYPE_VALID(x) ((x) <= GFS2_EATYPE_LAST)
388
389#define GFS2_EAFLAG_LAST 0x01 /* last ea in block */
390
391struct gfs2_ea_header {
392 __be32 ea_rec_len;
393 __be32 ea_data_len;
394 __u8 ea_name_len; /* no NULL pointer after the string */
395 __u8 ea_type; /* GFS2_EATYPE_... */
396 __u8 ea_flags; /* GFS2_EAFLAG_... */
397 __u8 ea_num_ptrs;
398 __u32 __pad;
399};
400
401/*
402 * Log header structure
403 */
404
405#define GFS2_LOG_HEAD_UNMOUNT 0x00000001 /* log is clean */
406
407struct gfs2_log_header {
408 struct gfs2_meta_header lh_header;
409
410 __be64 lh_sequence; /* Sequence number of this transaction */
411 __be32 lh_flags; /* GFS2_LOG_HEAD_... */
412 __be32 lh_tail; /* Block number of log tail */
413 __be32 lh_blkno;
414 __be32 lh_hash;
415};
416
417struct gfs2_log_header_host {
418 struct gfs2_meta_header_host lh_header;
419
420 __u64 lh_sequence; /* Sequence number of this transaction */
421 __u32 lh_flags; /* GFS2_LOG_HEAD_... */
422 __u32 lh_tail; /* Block number of log tail */
423 __u32 lh_blkno;
424 __u32 lh_hash;
425};
426
427/*
428 * Log type descriptor
429 */
430
431#define GFS2_LOG_DESC_METADATA 300
432/* ld_data1 is the number of metadata blocks in the descriptor.
433 ld_data2 is unused. */
434
435#define GFS2_LOG_DESC_REVOKE 301
436/* ld_data1 is the number of revoke blocks in the descriptor.
437 ld_data2 is unused. */
438
439#define GFS2_LOG_DESC_JDATA 302
440/* ld_data1 is the number of data blocks in the descriptor.
441 ld_data2 is unused. */
442
443struct gfs2_log_descriptor {
444 struct gfs2_meta_header ld_header;
445
446 __be32 ld_type; /* GFS2_LOG_DESC_... */
447 __be32 ld_length; /* Number of buffers in this chunk */
448 __be32 ld_data1; /* descriptor-specific field */
449 __be32 ld_data2; /* descriptor-specific field */
450
451 __u8 ld_reserved[32];
452};
453
454/*
455 * Inum Range
456 * Describe a range of formal inode numbers allocated to
457 * one machine to assign to inodes.
458 */
459
460#define GFS2_INUM_QUANTUM 1048576
461
462struct gfs2_inum_range {
463 __be64 ir_start;
464 __be64 ir_length;
465};
466
467struct gfs2_inum_range_host {
468 __u64 ir_start;
469 __u64 ir_length;
470};
471
472/*
473 * Statfs change
474 * Describes an change to the pool of free and allocated
475 * blocks.
476 */
477
478struct gfs2_statfs_change {
479 __be64 sc_total;
480 __be64 sc_free;
481 __be64 sc_dinodes;
482};
483
484struct gfs2_statfs_change_host {
485 __u64 sc_total;
486 __u64 sc_free;
487 __u64 sc_dinodes;
488};
489
490/*
491 * Quota change
492 * Describes an allocation change for a particular
493 * user or group.
494 */
495
496#define GFS2_QCF_USER 0x00000001
497
498struct gfs2_quota_change {
499 __be64 qc_change;
500 __be32 qc_flags; /* GFS2_QCF_... */
501 __be32 qc_id;
502};
503
504struct gfs2_quota_change_host {
505 __u64 qc_change;
506 __u32 qc_flags; /* GFS2_QCF_... */
507 __u32 qc_id;
508};
509
510#ifdef __KERNEL__
511/* Translation functions */
512
513extern void gfs2_inum_in(struct gfs2_inum_host *no, const void *buf);
514extern void gfs2_inum_out(const struct gfs2_inum_host *no, void *buf);
515extern void gfs2_sb_in(struct gfs2_sb_host *sb, const void *buf);
516extern void gfs2_rindex_in(struct gfs2_rindex_host *ri, const void *buf);
517extern void gfs2_rindex_out(const struct gfs2_rindex_host *ri, void *buf);
518extern void gfs2_rgrp_in(struct gfs2_rgrp_host *rg, const void *buf);
519extern void gfs2_rgrp_out(const struct gfs2_rgrp_host *rg, void *buf);
520extern void gfs2_quota_in(struct gfs2_quota_host *qu, const void *buf);
521struct gfs2_inode;
522extern void gfs2_dinode_out(const struct gfs2_inode *ip, void *buf);
523extern void gfs2_ea_header_in(struct gfs2_ea_header *ea, const void *buf);
524extern void gfs2_ea_header_out(const struct gfs2_ea_header *ea, void *buf);
525extern void gfs2_log_header_in(struct gfs2_log_header_host *lh, const void *buf);
526extern void gfs2_inum_range_in(struct gfs2_inum_range_host *ir, const void *buf);
527extern void gfs2_inum_range_out(const struct gfs2_inum_range_host *ir, void *buf);
528extern void gfs2_statfs_change_in(struct gfs2_statfs_change_host *sc, const void *buf);
529extern void gfs2_statfs_change_out(const struct gfs2_statfs_change_host *sc, void *buf);
530extern void gfs2_quota_change_in(struct gfs2_quota_change_host *qc, const void *buf);
531
532/* Printing functions */
533
534extern void gfs2_rindex_print(const struct gfs2_rindex_host *ri);
535extern void gfs2_dinode_print(const struct gfs2_inode *ip);
536
537#endif /* __KERNEL__ */
538
539#endif /* __GFS2_ONDISK_DOT_H__ */