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