Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
gfs2_ondisk.h
Go to the documentation of this file.
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 #define GFS2_CONTROL_LOCK 4
26 #define GFS2_MOUNTED_LOCK 5
27 
28 /* Format numbers for various metadata types */
29 
30 #define GFS2_FORMAT_NONE 0
31 #define GFS2_FORMAT_SB 100
32 #define GFS2_FORMAT_RG 200
33 #define GFS2_FORMAT_RB 300
34 #define GFS2_FORMAT_DI 400
35 #define GFS2_FORMAT_IN 500
36 #define GFS2_FORMAT_LF 600
37 #define GFS2_FORMAT_JD 700
38 #define GFS2_FORMAT_LH 800
39 #define GFS2_FORMAT_LD 900
40 #define GFS2_FORMAT_LB 1000
41 #define GFS2_FORMAT_EA 1600
42 #define GFS2_FORMAT_ED 1700
43 #define GFS2_FORMAT_QC 1400
44 /* These are format numbers for entities contained in files */
45 #define GFS2_FORMAT_RI 1100
46 #define GFS2_FORMAT_DE 1200
47 #define GFS2_FORMAT_QU 1500
48 /* These are part of the superblock */
49 #define GFS2_FORMAT_FS 1801
50 #define GFS2_FORMAT_MULTI 1900
51 
52 /*
53  * An on-disk inode number
54  */
55 
56 struct gfs2_inum {
59 };
60 
61 /*
62  * Generic metadata head structure
63  * Every inplace buffer logged in the journal must start with this.
64  */
65 
66 #define GFS2_METATYPE_NONE 0
67 #define GFS2_METATYPE_SB 1
68 #define GFS2_METATYPE_RG 2
69 #define GFS2_METATYPE_RB 3
70 #define GFS2_METATYPE_DI 4
71 #define GFS2_METATYPE_IN 5
72 #define GFS2_METATYPE_LF 6
73 #define GFS2_METATYPE_JD 7
74 #define GFS2_METATYPE_LH 8
75 #define GFS2_METATYPE_LD 9
76 #define GFS2_METATYPE_LB 12
77 #define GFS2_METATYPE_EA 10
78 #define GFS2_METATYPE_ED 11
79 #define GFS2_METATYPE_QC 14
80 
84  __be64 __pad0; /* Was generation number in gfs1 */
86  /* This union is to keep userspace happy */
87  union {
88  __be32 mh_jid; /* Was incarnation number in gfs1 */
90  };
91 };
92 
93 /*
94  * super-block structure
95  *
96  * It's probably good if SIZEOF_SB <= GFS2_BASIC_BLOCK (512 bytes)
97  *
98  * Order is important, need to be able to read old superblocks to do on-disk
99  * version upgrades.
100  */
101 
102 /* Address of superblock in GFS2 basic blocks */
103 #define GFS2_SB_ADDR 128
104 
105 /* The lock number for the superblock (must be zero) */
106 #define GFS2_SB_LOCK 0
107 
108 /* Requirement: GFS2_LOCKNAME_LEN % 8 == 0
109  Includes: the fencing zero at the end */
110 #define GFS2_LOCKNAME_LEN 64
111 
112 struct gfs2_sb {
114 
117  __u32 __pad0; /* Was superblock flags in gfs1 */
118 
121  __u32 __pad1; /* Was journal segment size in gfs1 */
122 
123  struct gfs2_inum sb_master_dir; /* Was jindex dinode in gfs1 */
124  struct gfs2_inum __pad2; /* Was rindex dinode in gfs1 */
126 
129 
130  struct gfs2_inum __pad3; /* Was quota inode in gfs1 */
131  struct gfs2_inum __pad4; /* Was licence inode in gfs1 */
132 #define GFS2_HAS_UUID 1
133  __u8 sb_uuid[16]; /* The UUID, maybe 0 for backwards compat */
134 };
135 
136 /*
137  * resource index structure
138  */
139 
140 struct gfs2_rindex {
141  __be64 ri_addr; /* grp block disk address */
142  __be32 ri_length; /* length of rgrp header in fs blocks */
144 
145  __be64 ri_data0; /* first data location */
146  __be32 ri_data; /* num of data blocks in rgrp */
147 
148  __be32 ri_bitbytes; /* number of bytes in data bitmaps */
149 
151 };
152 
153 /*
154  * resource group header structure
155  */
156 
157 /* Number of blocks per byte in rgrp */
158 #define GFS2_NBBY 4
159 #define GFS2_BIT_SIZE 2
160 #define GFS2_BIT_MASK 0x00000003
161 
162 #define GFS2_BLKST_FREE 0
163 #define GFS2_BLKST_USED 1
164 #define GFS2_BLKST_UNLINKED 2
165 #define GFS2_BLKST_DINODE 3
166 
167 #define GFS2_RGF_JOURNAL 0x00000001
168 #define GFS2_RGF_METAONLY 0x00000002
169 #define GFS2_RGF_DATAONLY 0x00000004
170 #define GFS2_RGF_NOALLOC 0x00000008
171 #define GFS2_RGF_TRIMMED 0x00000010
172 
181 };
182 
183 struct gfs2_rgrp {
185 
191 
192  __u8 rg_reserved[80]; /* Several fields from gfs1 now reserved */
193 };
194 
195 /*
196  * quota structure
197  */
198 
199 struct gfs2_quota {
204 };
205 
206 /*
207  * dinode structure
208  */
209 
210 #define GFS2_MAX_META_HEIGHT 10
211 #define GFS2_DIR_MAX_DEPTH 17
212 
213 #define DT2IF(dt) (((dt) << 12) & S_IFMT)
214 #define IF2DT(sif) (((sif) & S_IFMT) >> 12)
215 
216 enum {
231 };
232 
233 /* Dinode flags */
234 #define GFS2_DIF_JDATA 0x00000001
235 #define GFS2_DIF_EXHASH 0x00000002
236 #define GFS2_DIF_UNUSED 0x00000004 /* only in gfs1 */
237 #define GFS2_DIF_EA_INDIRECT 0x00000008
238 #define GFS2_DIF_DIRECTIO 0x00000010
239 #define GFS2_DIF_IMMUTABLE 0x00000020
240 #define GFS2_DIF_APPENDONLY 0x00000040
241 #define GFS2_DIF_NOATIME 0x00000080
242 #define GFS2_DIF_SYNC 0x00000100
243 #define GFS2_DIF_SYSTEM 0x00000200 /* New in gfs2 */
244 #define GFS2_DIF_TOPDIR 0x00000400 /* New in gfs2 */
245 #define GFS2_DIF_TRUNC_IN_PROG 0x20000000 /* New in gfs2 */
246 #define GFS2_DIF_INHERIT_DIRECTIO 0x40000000 /* only in gfs1 */
247 #define GFS2_DIF_INHERIT_JDATA 0x80000000
248 
249 struct gfs2_dinode {
251 
253 
254  __be32 di_mode; /* mode of file */
255  __be32 di_uid; /* owner's user id */
256  __be32 di_gid; /* owner's group id */
257  __be32 di_nlink; /* number of links to this file */
258  __be64 di_size; /* number of bytes in file */
259  __be64 di_blocks; /* number of blocks in file */
260  __be64 di_atime; /* time last accessed */
261  __be64 di_mtime; /* time last modified */
262  __be64 di_ctime; /* time last changed */
263  __be32 di_major; /* device major number */
264  __be32 di_minor; /* device minor number */
265 
266  /* This section varies from gfs1. Padding added to align with
267  * remainder of dinode
268  */
269  __be64 di_goal_meta; /* rgrp to alloc from next */
270  __be64 di_goal_data; /* data block goal */
271  __be64 di_generation; /* generation number for NFS */
272 
273  __be32 di_flags; /* GFS2_DIF_... */
274  __be32 di_payload_format; /* GFS2_FORMAT_... */
275  __u16 __pad1; /* Was ditype in gfs1 */
276  __be16 di_height; /* height of metadata */
277  __u32 __pad2; /* Unused incarnation number from gfs1 */
278 
279  /* These only apply to directories */
280  __u16 __pad3; /* Padding */
281  __be16 di_depth; /* Number of bits in the table */
282  __be32 di_entries; /* The number of entries in the directory */
283 
284  struct gfs2_inum __pad4; /* Unused even in current gfs1 */
285 
286  __be64 di_eattr; /* extended attribute block number */
287  __be32 di_atime_nsec; /* nsec portion of atime */
288  __be32 di_mtime_nsec; /* nsec portion of mtime */
289  __be32 di_ctime_nsec; /* nsec portion of ctime */
290 
292 };
293 
294 /*
295  * directory structure - many of these per directory file
296  */
297 
298 #define GFS2_FNAMESIZE 255
299 #define GFS2_DIRENT_SIZE(name_len) ((sizeof(struct gfs2_dirent) + (name_len) + 7) & ~7)
300 
301 struct gfs2_dirent {
307  __u8 __pad[14];
308 };
309 
310 /*
311  * Header of leaf directory nodes
312  */
313 
314 struct gfs2_leaf {
316 
317  __be16 lf_depth; /* Depth of leaf */
318  __be16 lf_entries; /* Number of dirents in leaf */
319  __be32 lf_dirent_format; /* Format of the dirents */
320  __be64 lf_next; /* Next leaf, if overflow */
321 
323 };
324 
325 /*
326  * Extended attribute header format
327  *
328  * This works in a similar way to dirents. There is a fixed size header
329  * followed by a variable length section made up of the name and the
330  * associated data. In the case of a "stuffed" entry, the value is
331  * inline directly after the name, the ea_num_ptrs entry will be
332  * zero in that case. For non-"stuffed" entries, there will be
333  * a set of pointers (aligned to 8 byte boundary) to the block(s)
334  * containing the value.
335  *
336  * The blocks containing the values and the blocks containing the
337  * extended attribute headers themselves all start with the common
338  * metadata header. Each inode, if it has extended attributes, will
339  * have either a single block containing the extended attribute headers
340  * or a single indirect block pointing to blocks containing the
341  * extended attribure headers.
342  *
343  * The maximim size of the data part of an extended attribute is 64k
344  * so the number of blocks required depends upon block size. Since the
345  * block size also determines the number of pointers in an indirect
346  * block, its a fairly complicated calculation to work out the maximum
347  * number of blocks that an inode may have relating to extended attributes.
348  *
349  */
350 
351 #define GFS2_EA_MAX_NAME_LEN 255
352 #define GFS2_EA_MAX_DATA_LEN 65536
353 
354 #define GFS2_EATYPE_UNUSED 0
355 #define GFS2_EATYPE_USR 1
356 #define GFS2_EATYPE_SYS 2
357 #define GFS2_EATYPE_SECURITY 3
358 
359 #define GFS2_EATYPE_LAST 3
360 #define GFS2_EATYPE_VALID(x) ((x) <= GFS2_EATYPE_LAST)
361 
362 #define GFS2_EAFLAG_LAST 0x01 /* last ea in block */
363 
367  __u8 ea_name_len; /* no NULL pointer after the string */
368  __u8 ea_type; /* GFS2_EATYPE_... */
369  __u8 ea_flags; /* GFS2_EAFLAG_... */
372 };
373 
374 /*
375  * Log header structure
376  */
377 
378 #define GFS2_LOG_HEAD_UNMOUNT 0x00000001 /* log is clean */
379 
382 
383  __be64 lh_sequence; /* Sequence number of this transaction */
384  __be32 lh_flags; /* GFS2_LOG_HEAD_... */
385  __be32 lh_tail; /* Block number of log tail */
388 };
389 
390 /*
391  * Log type descriptor
392  */
393 
394 #define GFS2_LOG_DESC_METADATA 300
395 /* ld_data1 is the number of metadata blocks in the descriptor.
396  ld_data2 is unused. */
397 
398 #define GFS2_LOG_DESC_REVOKE 301
399 /* ld_data1 is the number of revoke blocks in the descriptor.
400  ld_data2 is unused. */
401 
402 #define GFS2_LOG_DESC_JDATA 302
403 /* ld_data1 is the number of data blocks in the descriptor.
404  ld_data2 is unused. */
405 
408 
409  __be32 ld_type; /* GFS2_LOG_DESC_... */
410  __be32 ld_length; /* Number of buffers in this chunk */
411  __be32 ld_data1; /* descriptor-specific field */
412  __be32 ld_data2; /* descriptor-specific field */
413 
415 };
416 
417 /*
418  * Inum Range
419  * Describe a range of formal inode numbers allocated to
420  * one machine to assign to inodes.
421  */
422 
423 #define GFS2_INUM_QUANTUM 1048576
424 
428 };
429 
430 /*
431  * Statfs change
432  * Describes an change to the pool of free and allocated
433  * blocks.
434  */
435 
440 };
441 
442 /*
443  * Quota change
444  * Describes an allocation change for a particular
445  * user or group.
446  */
447 
448 #define GFS2_QCF_USER 0x00000001
449 
452  __be32 qc_flags; /* GFS2_QCF_... */
454 };
455 
459  __be64 qb_limit; /* Hard limit of # blocks to alloc */
460  __be64 qb_warn; /* Warn user when alloc is above this # */
461  __be64 qb_value; /* Current # blocks allocated */
462 };
463 
464 #endif /* __GFS2_ONDISK_DOT_H__ */