GFS2: Add explanation of extended attr on-disk format
[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 #include <linux/types.h>
14
15 #define GFS2_MAGIC              0x01161970
16 #define GFS2_BASIC_BLOCK        512
17 #define GFS2_BASIC_BLOCK_SHIFT  9
18
19 /* Lock numbers of the LM_TYPE_NONDISK type */
20
21 #define GFS2_MOUNT_LOCK         0
22 #define GFS2_LIVE_LOCK          1
23 #define GFS2_TRANS_LOCK         2
24 #define GFS2_RENAME_LOCK        3
25
26 /* Format numbers for various metadata types */
27
28 #define GFS2_FORMAT_NONE        0
29 #define GFS2_FORMAT_SB          100
30 #define GFS2_FORMAT_RG          200
31 #define GFS2_FORMAT_RB          300
32 #define GFS2_FORMAT_DI          400
33 #define GFS2_FORMAT_IN          500
34 #define GFS2_FORMAT_LF          600
35 #define GFS2_FORMAT_JD          700
36 #define GFS2_FORMAT_LH          800
37 #define GFS2_FORMAT_LD          900
38 #define GFS2_FORMAT_LB          1000
39 #define GFS2_FORMAT_EA          1600
40 #define GFS2_FORMAT_ED          1700
41 #define GFS2_FORMAT_QC          1400
42 /* These are format numbers for entities contained in files */
43 #define GFS2_FORMAT_RI          1100
44 #define GFS2_FORMAT_DE          1200
45 #define GFS2_FORMAT_QU          1500
46 /* These are part of the superblock */
47 #define GFS2_FORMAT_FS          1801
48 #define GFS2_FORMAT_MULTI       1900
49
50 /*
51  * An on-disk inode number
52  */
53
54 struct gfs2_inum {
55         __be64 no_formal_ino;
56         __be64 no_addr;
57 };
58
59 /*
60  * Generic metadata head structure
61  * Every inplace buffer logged in the journal must start with this.
62  */
63
64 #define GFS2_METATYPE_NONE      0
65 #define GFS2_METATYPE_SB        1
66 #define GFS2_METATYPE_RG        2
67 #define GFS2_METATYPE_RB        3
68 #define GFS2_METATYPE_DI        4
69 #define GFS2_METATYPE_IN        5
70 #define GFS2_METATYPE_LF        6
71 #define GFS2_METATYPE_JD        7
72 #define GFS2_METATYPE_LH        8
73 #define GFS2_METATYPE_LD        9
74 #define GFS2_METATYPE_LB        12
75 #define GFS2_METATYPE_EA        10
76 #define GFS2_METATYPE_ED        11
77 #define GFS2_METATYPE_QC        14
78
79 struct gfs2_meta_header {
80         __be32 mh_magic;
81         __be32 mh_type;
82         __be64 __pad0;          /* Was generation number in gfs1 */
83         __be32 mh_format;
84         __be32 __pad1;          /* Was incarnation number in gfs1 */
85 };
86
87 /*
88  * super-block structure
89  *
90  * It's probably good if SIZEOF_SB <= GFS2_BASIC_BLOCK (512 bytes)
91  *
92  * Order is important, need to be able to read old superblocks to do on-disk
93  * version upgrades.
94  */
95
96 /* Address of superblock in GFS2 basic blocks */
97 #define GFS2_SB_ADDR            128
98
99 /* The lock number for the superblock (must be zero) */
100 #define GFS2_SB_LOCK            0
101
102 /* Requirement:  GFS2_LOCKNAME_LEN % 8 == 0
103    Includes: the fencing zero at the end */
104 #define GFS2_LOCKNAME_LEN       64
105
106 struct gfs2_sb {
107         struct gfs2_meta_header sb_header;
108
109         __be32 sb_fs_format;
110         __be32 sb_multihost_format;
111         __u32  __pad0;  /* Was superblock flags in gfs1 */
112
113         __be32 sb_bsize;
114         __be32 sb_bsize_shift;
115         __u32 __pad1;   /* Was journal segment size in gfs1 */
116
117         struct gfs2_inum sb_master_dir; /* Was jindex dinode in gfs1 */
118         struct gfs2_inum __pad2; /* Was rindex dinode in gfs1 */
119         struct gfs2_inum sb_root_dir;
120
121         char sb_lockproto[GFS2_LOCKNAME_LEN];
122         char sb_locktable[GFS2_LOCKNAME_LEN];
123
124         struct gfs2_inum __pad3; /* Was quota inode in gfs1 */
125         struct gfs2_inum __pad4; /* Was licence inode in gfs1 */
126 #define GFS2_HAS_UUID 1
127         __u8 sb_uuid[16]; /* The UUID, maybe 0 for backwards compat */
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_UNLINKED     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         __be32 __pad;
173         __be64 rg_igeneration;
174
175         __u8 rg_reserved[80]; /* Several fields from gfs1 now reserved */
176 };
177
178 /*
179  * quota linked list: user quotas and group quotas form two separate 
180  * singly linked lists. ll_next stores uids or gids of next quotas in the 
181  * linked list.
182
183 Given the uid/gid, how to calculate the quota file offsets for the corresponding
184 gfs2_quota structures on disk:
185
186 for user quotas, given uid,
187 offset = uid * sizeof(struct gfs2_quota);
188
189 for group quotas, given gid,
190 offset = (gid * sizeof(struct gfs2_quota)) + sizeof(struct gfs2_quota);
191
192
193   uid:0   gid:0       uid:12   gid:12      uid:17   gid:17     uid:5142 gid:5142
194 +-------+-------+    +-------+-------+    +-------+- - - -+    +- - - -+-------+
195 | valid | valid | :: | valid | valid | :: | valid | inval | :: | inval | valid |
196 +-------+-------+    +-------+-------+    +-------+- - - -+    +- - - -+-------+
197 next:12   next:12    next:17 next:5142    next:NULL                    next:NULL
198     |       |            |       |            |<-- user quota list         |
199      \______|___________/ \______|___________/         group quota list -->|
200             |                    |                                         |
201              \__________________/ \_______________________________________/
202
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         __be32 qu_ll_next; /* location of next quota in list */
214         __u8 qu_reserved[60];
215 };
216
217 /*
218  * dinode structure
219  */
220
221 #define GFS2_MAX_META_HEIGHT    10
222 #define GFS2_DIR_MAX_DEPTH      17
223
224 #define DT2IF(dt) (((dt) << 12) & S_IFMT)
225 #define IF2DT(sif) (((sif) & S_IFMT) >> 12)
226
227 enum {
228         gfs2fl_Jdata            = 0,
229         gfs2fl_ExHash           = 1,
230         gfs2fl_Unused           = 2,
231         gfs2fl_EaIndirect       = 3,
232         gfs2fl_Directio         = 4,
233         gfs2fl_Immutable        = 5,
234         gfs2fl_AppendOnly       = 6,
235         gfs2fl_NoAtime          = 7,
236         gfs2fl_Sync             = 8,
237         gfs2fl_System           = 9,
238         gfs2fl_TruncInProg      = 29,
239         gfs2fl_InheritDirectio  = 30,
240         gfs2fl_InheritJdata     = 31,
241 };
242
243 /* Dinode flags */
244 #define GFS2_DIF_JDATA                  0x00000001
245 #define GFS2_DIF_EXHASH                 0x00000002
246 #define GFS2_DIF_UNUSED                 0x00000004  /* only in gfs1 */
247 #define GFS2_DIF_EA_INDIRECT            0x00000008
248 #define GFS2_DIF_DIRECTIO               0x00000010
249 #define GFS2_DIF_IMMUTABLE              0x00000020
250 #define GFS2_DIF_APPENDONLY             0x00000040
251 #define GFS2_DIF_NOATIME                0x00000080
252 #define GFS2_DIF_SYNC                   0x00000100
253 #define GFS2_DIF_SYSTEM                 0x00000200 /* New in gfs2 */
254 #define GFS2_DIF_TRUNC_IN_PROG          0x20000000 /* New in gfs2 */
255 #define GFS2_DIF_INHERIT_DIRECTIO       0x40000000
256 #define GFS2_DIF_INHERIT_JDATA          0x80000000
257
258 struct gfs2_dinode {
259         struct gfs2_meta_header di_header;
260
261         struct gfs2_inum di_num;
262
263         __be32 di_mode; /* mode of file */
264         __be32 di_uid;  /* owner's user id */
265         __be32 di_gid;  /* owner's group id */
266         __be32 di_nlink;        /* number of links to this file */
267         __be64 di_size; /* number of bytes in file */
268         __be64 di_blocks;       /* number of blocks in file */
269         __be64 di_atime;        /* time last accessed */
270         __be64 di_mtime;        /* time last modified */
271         __be64 di_ctime;        /* time last changed */
272         __be32 di_major;        /* device major number */
273         __be32 di_minor;        /* device minor number */
274
275         /* This section varies from gfs1. Padding added to align with
276          * remainder of dinode
277          */
278         __be64 di_goal_meta;    /* rgrp to alloc from next */
279         __be64 di_goal_data;    /* data block goal */
280         __be64 di_generation;   /* generation number for NFS */
281
282         __be32 di_flags;        /* GFS2_DIF_... */
283         __be32 di_payload_format;  /* GFS2_FORMAT_... */
284         __u16 __pad1;   /* Was ditype in gfs1 */
285         __be16 di_height;       /* height of metadata */
286         __u32 __pad2;   /* Unused incarnation number from gfs1 */
287
288         /* These only apply to directories  */
289         __u16 __pad3;   /* Padding */
290         __be16 di_depth;        /* Number of bits in the table */
291         __be32 di_entries;      /* The number of entries in the directory */
292
293         struct gfs2_inum __pad4; /* Unused even in current gfs1 */
294
295         __be64 di_eattr;        /* extended attribute block number */
296         __be32 di_atime_nsec;   /* nsec portion of atime */
297         __be32 di_mtime_nsec;   /* nsec portion of mtime */
298         __be32 di_ctime_nsec;   /* nsec portion of ctime */
299
300         __u8 di_reserved[44];
301 };
302
303 /*
304  * directory structure - many of these per directory file
305  */
306
307 #define GFS2_FNAMESIZE          255
308 #define GFS2_DIRENT_SIZE(name_len) ((sizeof(struct gfs2_dirent) + (name_len) + 7) & ~7)
309
310 struct gfs2_dirent {
311         struct gfs2_inum de_inum;
312         __be32 de_hash;
313         __be16 de_rec_len;
314         __be16 de_name_len;
315         __be16 de_type;
316         __u8 __pad[14];
317 };
318
319 /*
320  * Header of leaf directory nodes
321  */
322
323 struct gfs2_leaf {
324         struct gfs2_meta_header lf_header;
325
326         __be16 lf_depth;                /* Depth of leaf */
327         __be16 lf_entries;              /* Number of dirents in leaf */
328         __be32 lf_dirent_format;        /* Format of the dirents */
329         __be64 lf_next;                 /* Next leaf, if overflow */
330
331         __u8 lf_reserved[64];
332 };
333
334 /*
335  * Extended attribute header format
336  *
337  * This works in a similar way to dirents. There is a fixed size header
338  * followed by a variable length section made up of the name and the
339  * associated data. In the case of a "stuffed" entry, the value is
340  * inline directly after the name, the ea_num_ptrs entry will be
341  * zero in that case. For non-"stuffed" entries, there will be
342  * a set of pointers (aligned to 8 byte boundary) to the block(s)
343  * containing the value.
344  *
345  * The blocks containing the values and the blocks containing the
346  * extended attribute headers themselves all start with the common
347  * metadata header. Each inode, if it has extended attributes, will
348  * have either a single block containing the extended attribute headers
349  * or a single indirect block pointing to blocks containing the
350  * extended attribure headers.
351  *
352  * The maximim size of the data part of an extended attribute is 64k
353  * so the number of blocks required depends upon block size. Since the
354  * block size also determines the number of pointers in an indirect
355  * block, its a fairly complicated calculation to work out the maximum
356  * number of blocks that an inode may have relating to extended attributes.
357  *
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
366 #define GFS2_EATYPE_SECURITY    3
367
368 #define GFS2_EATYPE_LAST        3
369 #define GFS2_EATYPE_VALID(x)    ((x) <= GFS2_EATYPE_LAST)
370
371 #define GFS2_EAFLAG_LAST        0x01    /* last ea in block */
372
373 struct 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
389 struct 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
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
415 struct 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
434 struct 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
445 struct gfs2_statfs_change {
446         __be64 sc_total;
447         __be64 sc_free;
448         __be64 sc_dinodes;
449 };
450
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
459 struct gfs2_quota_change {
460         __be64 qc_change;
461         __be32 qc_flags;        /* GFS2_QCF_... */
462         __be32 qc_id;
463 };
464
465 struct gfs2_quota_lvb {
466         __be32 qb_magic;
467         __u32 __pad;
468         __be64 qb_limit;      /* Hard limit of # blocks to alloc */
469         __be64 qb_warn;       /* Warn user when alloc is above this # */
470         __be64 qb_value;       /* Current # blocks allocated */
471 };
472
473 #endif /* __GFS2_ONDISK_DOT_H__ */