[GFS2] split gfs2_sb
[linux-2.6.git] / include / linux / gfs2_ondisk.h
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
52 struct gfs2_inum {
53         __be64 no_formal_ino;
54         __be64 no_addr;
55 };
56
57 static 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
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
79 #define GFS2_METATYPE_LB        12
80 #define GFS2_METATYPE_EA        10
81 #define GFS2_METATYPE_ED        11
82 #define GFS2_METATYPE_QC        14
83
84 struct 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
111 struct 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
131 struct gfs2_sb_host {
132         struct gfs2_meta_header sb_header;
133
134         __be32 sb_fs_format;
135         __be32 sb_multihost_format;
136         __u32  __pad0;  /* Was superblock flags in gfs1 */
137
138         __be32 sb_bsize;
139         __be32 sb_bsize_shift;
140         __u32 __pad1;   /* Was journal segment size in gfs1 */
141
142         struct gfs2_inum sb_master_dir; /* Was jindex dinode in gfs1 */
143         struct gfs2_inum __pad2; /* Was rindex dinode in gfs1 */
144         struct gfs2_inum sb_root_dir;
145
146         char sb_lockproto[GFS2_LOCKNAME_LEN];
147         char sb_locktable[GFS2_LOCKNAME_LEN];
148         /* In gfs1, quota and license dinodes followed */
149 };
150
151 /*
152  * resource index structure
153  */
154
155 struct gfs2_rindex {
156         __be64 ri_addr; /* grp block disk address */
157         __be32 ri_length;       /* length of rgrp header in fs blocks */
158         __u32 __pad;
159
160         __be64 ri_data0;        /* first data location */
161         __be32 ri_data; /* num of data blocks in rgrp */
162
163         __be32 ri_bitbytes;     /* number of bytes in data bitmaps */
164
165         __u8 ri_reserved[64];
166 };
167
168 /*
169  * resource group header structure
170  */
171
172 /* Number of blocks per byte in rgrp */
173 #define GFS2_NBBY               4
174 #define GFS2_BIT_SIZE           2
175 #define GFS2_BIT_MASK           0x00000003
176
177 #define GFS2_BLKST_FREE         0
178 #define GFS2_BLKST_USED         1
179 #define GFS2_BLKST_UNLINKED     2
180 #define GFS2_BLKST_DINODE       3
181
182 #define GFS2_RGF_JOURNAL        0x00000001
183 #define GFS2_RGF_METAONLY       0x00000002
184 #define GFS2_RGF_DATAONLY       0x00000004
185 #define GFS2_RGF_NOALLOC        0x00000008
186
187 struct gfs2_rgrp {
188         struct gfs2_meta_header rg_header;
189
190         __be32 rg_flags;
191         __be32 rg_free;
192         __be32 rg_dinodes;
193         __be32 __pad;
194         __be64 rg_igeneration;
195
196         __u8 rg_reserved[80]; /* Several fields from gfs1 now reserved */
197 };
198
199 /*
200  * quota structure
201  */
202
203 struct gfs2_quota {
204         __be64 qu_limit;
205         __be64 qu_warn;
206         __be64 qu_value;
207         __u8 qu_reserved[64];
208 };
209
210 /*
211  * dinode structure
212  */
213
214 #define GFS2_MAX_META_HEIGHT    10
215 #define GFS2_DIR_MAX_DEPTH      17
216
217 #define DT2IF(dt) (((dt) << 12) & S_IFMT)
218 #define IF2DT(sif) (((sif) & S_IFMT) >> 12)
219
220 enum {
221         gfs2fl_Jdata            = 0,
222         gfs2fl_ExHash           = 1,
223         gfs2fl_Unused           = 2,
224         gfs2fl_EaIndirect       = 3,
225         gfs2fl_Directio         = 4,
226         gfs2fl_Immutable        = 5,
227         gfs2fl_AppendOnly       = 6,
228         gfs2fl_NoAtime          = 7,
229         gfs2fl_Sync             = 8,
230         gfs2fl_System           = 9,
231         gfs2fl_TruncInProg      = 29,
232         gfs2fl_InheritDirectio  = 30,
233         gfs2fl_InheritJdata     = 31,
234 };
235
236 /* Dinode flags */
237 #define GFS2_DIF_JDATA                  0x00000001
238 #define GFS2_DIF_EXHASH                 0x00000002
239 #define GFS2_DIF_UNUSED                 0x00000004  /* only in gfs1 */
240 #define GFS2_DIF_EA_INDIRECT            0x00000008
241 #define GFS2_DIF_DIRECTIO               0x00000010
242 #define GFS2_DIF_IMMUTABLE              0x00000020
243 #define GFS2_DIF_APPENDONLY             0x00000040
244 #define GFS2_DIF_NOATIME                0x00000080
245 #define GFS2_DIF_SYNC                   0x00000100
246 #define GFS2_DIF_SYSTEM                 0x00000200 /* New in gfs2 */
247 #define GFS2_DIF_TRUNC_IN_PROG          0x20000000 /* New in gfs2 */
248 #define GFS2_DIF_INHERIT_DIRECTIO       0x40000000
249 #define GFS2_DIF_INHERIT_JDATA          0x80000000
250
251 struct gfs2_dinode {
252         struct gfs2_meta_header di_header;
253
254         struct gfs2_inum di_num;
255
256         __be32 di_mode; /* mode of file */
257         __be32 di_uid;  /* owner's user id */
258         __be32 di_gid;  /* owner's group id */
259         __be32 di_nlink;        /* number of links to this file */
260         __be64 di_size; /* number of bytes in file */
261         __be64 di_blocks;       /* number of blocks in file */
262         __be64 di_atime;        /* time last accessed */
263         __be64 di_mtime;        /* time last modified */
264         __be64 di_ctime;        /* time last changed */
265         __be32 di_major;        /* device major number */
266         __be32 di_minor;        /* device minor number */
267
268         /* This section varies from gfs1. Padding added to align with
269          * remainder of dinode
270          */
271         __be64 di_goal_meta;    /* rgrp to alloc from next */
272         __be64 di_goal_data;    /* data block goal */
273         __be64 di_generation;   /* generation number for NFS */
274
275         __be32 di_flags;        /* GFS2_DIF_... */
276         __be32 di_payload_format;  /* GFS2_FORMAT_... */
277         __u16 __pad1;   /* Was ditype in gfs1 */
278         __be16 di_height;       /* height of metadata */
279         __u32 __pad2;   /* Unused incarnation number from gfs1 */
280
281         /* These only apply to directories  */
282         __u16 __pad3;   /* Padding */
283         __be16 di_depth;        /* Number of bits in the table */
284         __be32 di_entries;      /* The number of entries in the directory */
285
286         struct gfs2_inum __pad4; /* Unused even in current gfs1 */
287
288         __be64 di_eattr;        /* extended attribute block number */
289
290         __u8 di_reserved[56];
291 };
292
293 struct gfs2_dinode_host {
294         struct gfs2_meta_header di_header;
295
296         struct gfs2_inum di_num;
297
298         __u32 di_mode;  /* mode of file */
299         __u32 di_uid;   /* owner's user id */
300         __u32 di_gid;   /* owner's group id */
301         __u32 di_nlink; /* number of links to this file */
302         __u64 di_size;  /* number of bytes in file */
303         __u64 di_blocks;        /* number of blocks in file */
304         __u64 di_atime; /* time last accessed */
305         __u64 di_mtime; /* time last modified */
306         __u64 di_ctime; /* time last changed */
307         __u32 di_major; /* device major number */
308         __u32 di_minor; /* device minor number */
309
310         /* This section varies from gfs1. Padding added to align with
311          * remainder of dinode
312          */
313         __u64 di_goal_meta;     /* rgrp to alloc from next */
314         __u64 di_goal_data;     /* data block goal */
315         __u64 di_generation;    /* generation number for NFS */
316
317         __u32 di_flags; /* GFS2_DIF_... */
318         __u32 di_payload_format;  /* GFS2_FORMAT_... */
319         __u16 di_height;        /* height of metadata */
320
321         /* These only apply to directories  */
322         __u16 di_depth; /* Number of bits in the table */
323         __u32 di_entries;       /* The number of entries in the directory */
324
325         __u64 di_eattr; /* extended attribute block number */
326 };
327
328 /*
329  * directory structure - many of these per directory file
330  */
331
332 #define GFS2_FNAMESIZE          255
333 #define GFS2_DIRENT_SIZE(name_len) ((sizeof(struct gfs2_dirent) + (name_len) + 7) & ~7)
334
335 struct gfs2_dirent {
336         struct gfs2_inum de_inum;
337         __be32 de_hash;
338         __be16 de_rec_len;
339         __be16 de_name_len;
340         __be16 de_type;
341         __u8 __pad[14];
342 };
343
344 /*
345  * Header of leaf directory nodes
346  */
347
348 struct gfs2_leaf {
349         struct gfs2_meta_header lf_header;
350
351         __be16 lf_depth;                /* Depth of leaf */
352         __be16 lf_entries;              /* Number of dirents in leaf */
353         __be32 lf_dirent_format;        /* Format of the dirents */
354         __be64 lf_next;                 /* Next leaf, if overflow */
355
356         __u8 lf_reserved[64];
357 };
358
359 /*
360  * Extended attribute header format
361  */
362
363 #define GFS2_EA_MAX_NAME_LEN    255
364 #define GFS2_EA_MAX_DATA_LEN    65536
365
366 #define GFS2_EATYPE_UNUSED      0
367 #define GFS2_EATYPE_USR         1
368 #define GFS2_EATYPE_SYS         2
369 #define GFS2_EATYPE_SECURITY    3
370
371 #define GFS2_EATYPE_LAST        3
372 #define GFS2_EATYPE_VALID(x)    ((x) <= GFS2_EATYPE_LAST)
373
374 #define GFS2_EAFLAG_LAST        0x01    /* last ea in block */
375
376 struct gfs2_ea_header {
377         __be32 ea_rec_len;
378         __be32 ea_data_len;
379         __u8 ea_name_len;       /* no NULL pointer after the string */
380         __u8 ea_type;           /* GFS2_EATYPE_... */
381         __u8 ea_flags;          /* GFS2_EAFLAG_... */
382         __u8 ea_num_ptrs;
383         __u32 __pad;
384 };
385
386 /*
387  * Log header structure
388  */
389
390 #define GFS2_LOG_HEAD_UNMOUNT   0x00000001      /* log is clean */
391
392 struct gfs2_log_header {
393         struct gfs2_meta_header lh_header;
394
395         __be64 lh_sequence;     /* Sequence number of this transaction */
396         __be32 lh_flags;        /* GFS2_LOG_HEAD_... */
397         __be32 lh_tail;         /* Block number of log tail */
398         __be32 lh_blkno;
399         __be32 lh_hash;
400 };
401
402 /*
403  * Log type descriptor
404  */
405
406 #define GFS2_LOG_DESC_METADATA  300
407 /* ld_data1 is the number of metadata blocks in the descriptor.
408    ld_data2 is unused. */
409
410 #define GFS2_LOG_DESC_REVOKE    301
411 /* ld_data1 is the number of revoke blocks in the descriptor.
412    ld_data2 is unused. */
413
414 #define GFS2_LOG_DESC_JDATA     302
415 /* ld_data1 is the number of data blocks in the descriptor.
416    ld_data2 is unused. */
417
418 struct gfs2_log_descriptor {
419         struct gfs2_meta_header ld_header;
420
421         __be32 ld_type;         /* GFS2_LOG_DESC_... */
422         __be32 ld_length;       /* Number of buffers in this chunk */
423         __be32 ld_data1;        /* descriptor-specific field */
424         __be32 ld_data2;        /* descriptor-specific field */
425
426         __u8 ld_reserved[32];
427 };
428
429 /*
430  * Inum Range
431  * Describe a range of formal inode numbers allocated to
432  * one machine to assign to inodes.
433  */
434
435 #define GFS2_INUM_QUANTUM       1048576
436
437 struct gfs2_inum_range {
438         __be64 ir_start;
439         __be64 ir_length;
440 };
441
442 /*
443  * Statfs change
444  * Describes an change to the pool of free and allocated
445  * blocks.
446  */
447
448 struct gfs2_statfs_change {
449         __be64 sc_total;
450         __be64 sc_free;
451         __be64 sc_dinodes;
452 };
453
454 /*
455  * Quota change
456  * Describes an allocation change for a particular
457  * user or group.
458  */
459
460 #define GFS2_QCF_USER           0x00000001
461
462 struct gfs2_quota_change {
463         __be64 qc_change;
464         __be32 qc_flags;        /* GFS2_QCF_... */
465         __be32 qc_id;
466 };
467
468 #ifdef __KERNEL__
469 /* Translation functions */
470
471 extern void gfs2_inum_in(struct gfs2_inum *no, const void *buf);
472 extern void gfs2_inum_out(const struct gfs2_inum *no, void *buf);
473 extern void gfs2_sb_in(struct gfs2_sb_host *sb, const void *buf);
474 extern void gfs2_rindex_in(struct gfs2_rindex *ri, const void *buf);
475 extern void gfs2_rindex_out(const struct gfs2_rindex *ri, void *buf);
476 extern void gfs2_rgrp_in(struct gfs2_rgrp *rg, const void *buf);
477 extern void gfs2_rgrp_out(const struct gfs2_rgrp *rg, void *buf);
478 extern void gfs2_quota_in(struct gfs2_quota *qu, const void *buf);
479 extern void gfs2_quota_out(const struct gfs2_quota *qu, void *buf);
480 extern void gfs2_dinode_in(struct gfs2_dinode_host *di, const void *buf);
481 extern void gfs2_dinode_out(const struct gfs2_dinode_host *di, void *buf);
482 extern void gfs2_ea_header_in(struct gfs2_ea_header *ea, const void *buf);
483 extern void gfs2_ea_header_out(const struct gfs2_ea_header *ea, void *buf);
484 extern void gfs2_log_header_in(struct gfs2_log_header *lh, const void *buf);
485 extern void gfs2_inum_range_in(struct gfs2_inum_range *ir, const void *buf);
486 extern void gfs2_inum_range_out(const struct gfs2_inum_range *ir, void *buf);
487 extern void gfs2_statfs_change_in(struct gfs2_statfs_change *sc, const void *buf);
488 extern void gfs2_statfs_change_out(const struct gfs2_statfs_change *sc, void *buf);
489 extern void gfs2_quota_change_in(struct gfs2_quota_change *qc, const void *buf);
490
491 /* Printing functions */
492
493 extern void gfs2_rindex_print(const struct gfs2_rindex *ri);
494 extern void gfs2_dinode_print(const struct gfs2_dinode_host *di);
495
496 #endif /* __KERNEL__ */
497
498 #endif /* __GFS2_ONDISK_DOT_H__ */