[GFS2] Update init_dinode() to reduce stack usage
[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-2005 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          1100
38 #define GFS2_FORMAT_ED          1200
39 #define GFS2_FORMAT_UT          1300
40 #define GFS2_FORMAT_QC          1400
41 /* These are format numbers for entities contained in files */
42 #define GFS2_FORMAT_RI          1500
43 #define GFS2_FORMAT_DE          1600
44 #define GFS2_FORMAT_QU          1700
45 /* These are part of the superblock */
46 #define GFS2_FORMAT_FS          1801
47 #define GFS2_FORMAT_MULTI       1900
48
49 /*
50  * An on-disk inode number
51  */
52
53 #define gfs2_inum_equal(ino1, ino2) \
54         (((ino1)->no_formal_ino == (ino2)->no_formal_ino) && \
55         ((ino1)->no_addr == (ino2)->no_addr))
56
57 struct gfs2_inum {
58         __be64 no_formal_ino;
59         __be64 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        10
78 #define GFS2_METATYPE_EA        11
79 #define GFS2_METATYPE_ED        12
80 #define GFS2_METATYPE_UT        13
81 #define GFS2_METATYPE_QC        14
82
83 struct gfs2_meta_header {
84         __be32 mh_magic;
85         __be32 mh_type;
86         __be64 __pad0;          /* Was generation number in gfs1 */
87         __be32 mh_format;
88         __be32 __pad1;          /* Was incarnation number in gfs1 */
89 };
90
91 /*
92  * super-block structure
93  *
94  * It's probably good if SIZEOF_SB <= GFS2_BASIC_BLOCK (512 bytes)
95  *
96  * Order is important, need to be able to read old superblocks to do on-disk
97  * version upgrades.
98  */
99
100 /* Address of superblock in GFS2 basic blocks */
101 #define GFS2_SB_ADDR            128
102
103 /* The lock number for the superblock (must be zero) */
104 #define GFS2_SB_LOCK            0
105
106 /* Requirement:  GFS2_LOCKNAME_LEN % 8 == 0
107    Includes: the fencing zero at the end */
108 #define GFS2_LOCKNAME_LEN       64
109
110 struct gfs2_sb {
111         struct gfs2_meta_header sb_header;
112
113         __be32 sb_fs_format;
114         __be32 sb_multihost_format;
115         __u32  __pad0;  /* Was superblock flags in gfs1 */
116
117         __be32 sb_bsize;
118         __be32 sb_bsize_shift;
119         __u32 __pad1;   /* Was journal segment size in gfs1 */
120
121         struct gfs2_inum sb_master_dir; /* Was jindex dinode in gfs1 */
122         struct gfs2_inum __pad2; /* Was rindex dinode in gfs1 */
123         struct gfs2_inum sb_root_dir;
124
125         char sb_lockproto[GFS2_LOCKNAME_LEN];
126         char sb_locktable[GFS2_LOCKNAME_LEN];
127         /* In gfs1, quota and license dinodes followed */
128 };
129
130 /*
131  * resource index structure
132  */
133
134 struct gfs2_rindex {
135         __be64 ri_addr; /* grp block disk address */
136         __be32 ri_length;       /* length of rgrp header in fs blocks */
137         __u32 __pad;
138
139         __be64 ri_data0;        /* first data location */
140         __be32 ri_data; /* num of data blocks in rgrp */
141
142         __be32 ri_bitbytes;     /* number of bytes in data bitmaps */
143
144         __u8 ri_reserved[64];
145 };
146
147 /*
148  * resource group header structure
149  */
150
151 /* Number of blocks per byte in rgrp */
152 #define GFS2_NBBY               4
153 #define GFS2_BIT_SIZE           2
154 #define GFS2_BIT_MASK           0x00000003
155
156 #define GFS2_BLKST_FREE         0
157 #define GFS2_BLKST_USED         1
158 #define GFS2_BLKST_INVALID      2
159 #define GFS2_BLKST_DINODE       3
160
161 #define GFS2_RGF_JOURNAL        0x00000001
162 #define GFS2_RGF_METAONLY       0x00000002
163 #define GFS2_RGF_DATAONLY       0x00000004
164 #define GFS2_RGF_NOALLOC        0x00000008
165
166 struct gfs2_rgrp {
167         struct gfs2_meta_header rg_header;
168
169         __be32 rg_flags;
170         __be32 rg_free;
171         __be32 rg_dinodes;
172
173         __u8 rg_reserved[92]; /* Several fields from gfs1 now reserved */
174 };
175
176 /*
177  * quota structure
178  */
179
180 struct gfs2_quota {
181         __be64 qu_limit;
182         __be64 qu_warn;
183         __be64 qu_value;
184 };
185
186 /*
187  * dinode structure
188  */
189
190 #define GFS2_MAX_META_HEIGHT    10
191 #define GFS2_DIR_MAX_DEPTH      17
192
193 #define DT2IF(dt) (((dt) << 12) & S_IFMT)
194 #define IF2DT(sif) (((sif) & S_IFMT) >> 12)
195
196 /* Dinode flags */
197 #define GFS2_DIF_JDATA                  0x00000001
198 #define GFS2_DIF_EXHASH                 0x00000002
199 #define GFS2_DIF_UNUSED                 0x00000004  /* only in gfs1 */
200 #define GFS2_DIF_EA_INDIRECT            0x00000008
201 #define GFS2_DIF_DIRECTIO               0x00000010
202 #define GFS2_DIF_IMMUTABLE              0x00000020
203 #define GFS2_DIF_APPENDONLY             0x00000040
204 #define GFS2_DIF_NOATIME                0x00000080
205 #define GFS2_DIF_SYNC                   0x00000100
206 #define GFS2_DIF_SYSTEM                 0x00000200 /* New in gfs2 */
207 #define GFS2_DIF_TRUNC_IN_PROG          0x20000000 /* New in gfs2 */
208 #define GFS2_DIF_INHERIT_DIRECTIO       0x40000000
209 #define GFS2_DIF_INHERIT_JDATA          0x80000000
210
211 struct gfs2_dinode {
212         struct gfs2_meta_header di_header;
213
214         struct gfs2_inum di_num;
215
216         __be32 di_mode; /* mode of file */
217         __be32 di_uid;  /* owner's user id */
218         __be32 di_gid;  /* owner's group id */
219         __be32 di_nlink;        /* number of links to this file */
220         __be64 di_size; /* number of bytes in file */
221         __be64 di_blocks;       /* number of blocks in file */
222         __be64 di_atime;        /* time last accessed */
223         __be64 di_mtime;        /* time last modified */
224         __be64 di_ctime;        /* time last changed */
225         __be32 di_major;        /* device major number */
226         __be32 di_minor;        /* device minor number */
227
228         /* This section varies from gfs1. Padding added to align with
229          * remainder of dinode
230          */
231         __be64 di_goal_meta;    /* rgrp to alloc from next */
232         __be64 di_goal_data;    /* data block goal */
233         __u32 __pad[2];
234
235         __be32 di_flags;        /* GFS2_DIF_... */
236         __be32 di_payload_format;  /* GFS2_FORMAT_... */
237         __u16 __pad1;   /* Was ditype in gfs1 */
238         __be16 di_height;       /* height of metadata */
239         __u32 __pad2;   /* Unused incarnation number from gfs1 */
240
241         /* These only apply to directories  */
242         __u16 __pad3;   /* Padding */
243         __be16 di_depth;        /* Number of bits in the table */
244         __be32 di_entries;      /* The number of entries in the directory */
245
246         struct gfs2_inum __pad4; /* Unused even in current gfs1 */
247
248         __be64 di_eattr;        /* extended attribute block number */
249
250         __u8 di_reserved[56];
251 };
252
253 /*
254  * directory structure - many of these per directory file
255  */
256
257 #define GFS2_FNAMESIZE          255
258 #define GFS2_DIRENT_SIZE(name_len) ((sizeof(struct gfs2_dirent) + (name_len) + 7) & ~7)
259
260 struct gfs2_dirent {
261         struct gfs2_inum de_inum;
262         __be32 de_hash;
263         __be32 de_rec_len;
264         __u8 de_name_len;
265         __u8 de_type;
266         __u16 __pad1;
267         __u32 __pad2;
268 };
269
270 /*
271  * Header of leaf directory nodes
272  */
273
274 struct gfs2_leaf {
275         struct gfs2_meta_header lf_header;
276
277         __be16 lf_depth;                /* Depth of leaf */
278         __be16 lf_entries;              /* Number of dirents in leaf */
279         __be32 lf_dirent_format;        /* Format of the dirents */
280         __be64 lf_next;                 /* Next leaf, if overflow */
281
282         __u8 lf_reserved[32];
283 };
284
285 /*
286  * Extended attribute header format
287  */
288
289 #define GFS2_EA_MAX_NAME_LEN    255
290 #define GFS2_EA_MAX_DATA_LEN    65536
291
292 #define GFS2_EATYPE_UNUSED      0
293 #define GFS2_EATYPE_USR         1
294 #define GFS2_EATYPE_SYS         2
295
296 #define GFS2_EATYPE_LAST        2
297 #define GFS2_EATYPE_VALID(x)    ((x) <= GFS2_EATYPE_LAST)
298
299 #define GFS2_EAFLAG_LAST        0x01    /* last ea in block */
300
301 struct gfs2_ea_header {
302         __be32 ea_rec_len;
303         __be32 ea_data_len;
304         __u8 ea_name_len;       /* no NULL pointer after the string */
305         __u8 ea_type;           /* GFS2_EATYPE_... */
306         __u8 ea_flags;          /* GFS2_EAFLAG_... */
307         __u8 ea_num_ptrs;
308         __u32 __pad;
309 };
310
311 /*
312  * Log header structure
313  */
314
315 #define GFS2_LOG_HEAD_UNMOUNT   0x00000001      /* log is clean */
316
317 struct gfs2_log_header {
318         struct gfs2_meta_header lh_header;
319
320         __be64 lh_sequence;     /* Sequence number of this transaction */
321         __be32 lh_flags;        /* GFS2_LOG_HEAD_... */
322         __be32 lh_tail;         /* Block number of log tail */
323         __be32 lh_blkno;
324         __be32 lh_hash;
325 };
326
327 /*
328  * Log type descriptor
329  */
330
331 #define GFS2_LOG_DESC_METADATA  300
332 /* ld_data1 is the number of metadata blocks in the descriptor.
333    ld_data2 is unused. */
334
335 #define GFS2_LOG_DESC_REVOKE    301
336 /* ld_data1 is the number of revoke blocks in the descriptor.
337    ld_data2 is unused. */
338
339 struct gfs2_log_descriptor {
340         struct gfs2_meta_header ld_header;
341
342         __be32 ld_type;         /* GFS2_LOG_DESC_... */
343         __be32 ld_length;       /* Number of buffers in this chunk */
344         __be32 ld_data1;        /* descriptor-specific field */
345         __be32 ld_data2;        /* descriptor-specific field */
346
347         __u8 ld_reserved[32];
348 };
349
350 /*
351  * Inum Range
352  * Describe a range of formal inode numbers allocated to
353  * one machine to assign to inodes.
354  */
355
356 #define GFS2_INUM_QUANTUM       1048576
357
358 struct gfs2_inum_range {
359         __be64 ir_start;
360         __be64 ir_length;
361 };
362
363 /*
364  * Statfs change
365  * Describes an change to the pool of free and allocated
366  * blocks.
367  */
368
369 struct gfs2_statfs_change {
370         __be64 sc_total;
371         __be64 sc_free;
372         __be64 sc_dinodes;
373 };
374
375 /*
376  * Unlinked Tag
377  * Describes an allocated inode that isn't linked into
378  * the directory tree and might need to be deallocated.
379  */
380
381 #define GFS2_UTF_UNINIT         0x00000001
382
383 struct gfs2_unlinked_tag {
384         struct gfs2_inum ut_inum;
385         __be32 ut_flags;        /* GFS2_UTF_... */
386         __u32 __pad;
387 };
388
389 /*
390  * Quota change
391  * Describes an allocation change for a particular
392  * user or group.
393  */
394
395 #define GFS2_QCF_USER           0x00000001
396
397 struct gfs2_quota_change {
398         __be64 qc_change;
399         __be32 qc_flags;        /* GFS2_QCF_... */
400         __be32 qc_id;
401 };
402
403 /* Translation functions */
404
405 extern void gfs2_inum_in(struct gfs2_inum *no, char *buf);
406 extern void gfs2_inum_out(struct gfs2_inum *no, char *buf);
407 extern void gfs2_sb_in(struct gfs2_sb *sb, char *buf);
408 extern void gfs2_rindex_in(struct gfs2_rindex *ri, char *buf);
409 extern void gfs2_rindex_out(struct gfs2_rindex *ri, char *buf);
410 extern void gfs2_rgrp_in(struct gfs2_rgrp *rg, char *buf);
411 extern void gfs2_rgrp_out(struct gfs2_rgrp *rg, char *buf);
412 extern void gfs2_quota_in(struct gfs2_quota *qu, char *buf);
413 extern void gfs2_quota_out(struct gfs2_quota *qu, char *buf);
414 extern void gfs2_dinode_in(struct gfs2_dinode *di, char *buf);
415 extern void gfs2_dinode_out(struct gfs2_dinode *di, char *buf);
416 extern void gfs2_leaf_in(struct gfs2_leaf *lf, char *buf);
417 extern void gfs2_ea_header_in(struct gfs2_ea_header *ea, char *buf);
418 extern void gfs2_ea_header_out(struct gfs2_ea_header *ea, char *buf);
419 extern void gfs2_log_header_in(struct gfs2_log_header *lh, char *buf);
420 extern void gfs2_inum_range_in(struct gfs2_inum_range *ir, char *buf);
421 extern void gfs2_inum_range_out(struct gfs2_inum_range *ir, char *buf);
422 extern void gfs2_statfs_change_in(struct gfs2_statfs_change *sc, char *buf);
423 extern void gfs2_statfs_change_out(struct gfs2_statfs_change *sc, char *buf);
424 extern void gfs2_unlinked_tag_in(struct gfs2_unlinked_tag *ut, char *buf);
425 extern void gfs2_unlinked_tag_out(struct gfs2_unlinked_tag *ut, char *buf);
426 extern void gfs2_quota_change_in(struct gfs2_quota_change *qc, char *buf);
427
428 /* Printing functions */
429
430 extern void gfs2_inum_print(struct gfs2_inum *no);
431 extern void gfs2_meta_header_print(struct gfs2_meta_header *mh);
432 extern void gfs2_sb_print(struct gfs2_sb *sb);
433 extern void gfs2_rindex_print(struct gfs2_rindex *ri);
434 extern void gfs2_rgrp_print(struct gfs2_rgrp *rg);
435 extern void gfs2_quota_print(struct gfs2_quota *qu);
436 extern void gfs2_dinode_print(struct gfs2_dinode *di);
437 extern void gfs2_dirent_print(struct gfs2_dirent *de, char *name);
438 extern void gfs2_leaf_print(struct gfs2_leaf *lf);
439 extern void gfs2_ea_header_print(struct gfs2_ea_header *ea, char *name);
440 extern void gfs2_log_header_print(struct gfs2_log_header *lh);
441 extern void gfs2_log_descriptor_print(struct gfs2_log_descriptor *ld);
442 extern void gfs2_inum_range_print(struct gfs2_inum_range *ir);
443 extern void gfs2_statfs_change_print(struct gfs2_statfs_change *sc);
444 extern void gfs2_unlinked_tag_print(struct gfs2_unlinked_tag *ut);
445 extern void gfs2_quota_change_print(struct gfs2_quota_change *qc);
446
447 #endif /* __GFS2_ONDISK_DOT_H__ */