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