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