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