xref: /utopia/UTPA2-700.0.x/projects/tools/lint/mips-linux-gnu_include/linux/gfs2_ondisk.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
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 /*
58  * Generic metadata head structure
59  * Every inplace buffer logged in the journal must start with this.
60  */
61 
62 #define GFS2_METATYPE_NONE	0
63 #define GFS2_METATYPE_SB	1
64 #define GFS2_METATYPE_RG	2
65 #define GFS2_METATYPE_RB	3
66 #define GFS2_METATYPE_DI	4
67 #define GFS2_METATYPE_IN	5
68 #define GFS2_METATYPE_LF	6
69 #define GFS2_METATYPE_JD	7
70 #define GFS2_METATYPE_LH	8
71 #define GFS2_METATYPE_LD	9
72 #define GFS2_METATYPE_LB	12
73 #define GFS2_METATYPE_EA	10
74 #define GFS2_METATYPE_ED	11
75 #define GFS2_METATYPE_QC	14
76 
77 struct gfs2_meta_header {
78 	__be32 mh_magic;
79 	__be32 mh_type;
80 	__be64 __pad0;		/* Was generation number in gfs1 */
81 	__be32 mh_format;
82 	__be32 __pad1;		/* Was incarnation number in gfs1 */
83 };
84 
85 /*
86  * super-block structure
87  *
88  * It's probably good if SIZEOF_SB <= GFS2_BASIC_BLOCK (512 bytes)
89  *
90  * Order is important, need to be able to read old superblocks to do on-disk
91  * version upgrades.
92  */
93 
94 /* Address of superblock in GFS2 basic blocks */
95 #define GFS2_SB_ADDR		128
96 
97 /* The lock number for the superblock (must be zero) */
98 #define GFS2_SB_LOCK		0
99 
100 /* Requirement:  GFS2_LOCKNAME_LEN % 8 == 0
101    Includes: the fencing zero at the end */
102 #define GFS2_LOCKNAME_LEN	64
103 
104 struct gfs2_sb {
105 	struct gfs2_meta_header sb_header;
106 
107 	__be32 sb_fs_format;
108 	__be32 sb_multihost_format;
109 	__u32  __pad0;	/* Was superblock flags in gfs1 */
110 
111 	__be32 sb_bsize;
112 	__be32 sb_bsize_shift;
113 	__u32 __pad1;	/* Was journal segment size in gfs1 */
114 
115 	struct gfs2_inum sb_master_dir; /* Was jindex dinode in gfs1 */
116 	struct gfs2_inum __pad2; /* Was rindex dinode in gfs1 */
117 	struct gfs2_inum sb_root_dir;
118 
119 	char sb_lockproto[GFS2_LOCKNAME_LEN];
120 	char sb_locktable[GFS2_LOCKNAME_LEN];
121 	/* In gfs1, quota and license dinodes followed */
122 };
123 
124 /*
125  * resource index structure
126  */
127 
128 struct gfs2_rindex {
129 	__be64 ri_addr;	/* grp block disk address */
130 	__be32 ri_length;	/* length of rgrp header in fs blocks */
131 	__u32 __pad;
132 
133 	__be64 ri_data0;	/* first data location */
134 	__be32 ri_data;	/* num of data blocks in rgrp */
135 
136 	__be32 ri_bitbytes;	/* number of bytes in data bitmaps */
137 
138 	__u8 ri_reserved[64];
139 };
140 
141 /*
142  * resource group header structure
143  */
144 
145 /* Number of blocks per byte in rgrp */
146 #define GFS2_NBBY		4
147 #define GFS2_BIT_SIZE		2
148 #define GFS2_BIT_MASK		0x00000003
149 
150 #define GFS2_BLKST_FREE		0
151 #define GFS2_BLKST_USED		1
152 #define GFS2_BLKST_UNLINKED	2
153 #define GFS2_BLKST_DINODE	3
154 
155 #define GFS2_RGF_JOURNAL	0x00000001
156 #define GFS2_RGF_METAONLY	0x00000002
157 #define GFS2_RGF_DATAONLY	0x00000004
158 #define GFS2_RGF_NOALLOC	0x00000008
159 
160 struct gfs2_rgrp {
161 	struct gfs2_meta_header rg_header;
162 
163 	__be32 rg_flags;
164 	__be32 rg_free;
165 	__be32 rg_dinodes;
166 	__be32 __pad;
167 	__be64 rg_igeneration;
168 
169 	__u8 rg_reserved[80]; /* Several fields from gfs1 now reserved */
170 };
171 
172 /*
173  * quota linked list: user quotas and group quotas form two separate
174  * singly linked lists. ll_next stores uids or gids of next quotas in the
175  * linked list.
176 
177 Given the uid/gid, how to calculate the quota file offsets for the corresponding
178 gfs2_quota structures on disk:
179 
180 for user quotas, given uid,
181 offset = uid * sizeof(struct gfs2_quota);
182 
183 for group quotas, given gid,
184 offset = (gid * sizeof(struct gfs2_quota)) + sizeof(struct gfs2_quota);
185 
186 
187   uid:0   gid:0       uid:12   gid:12      uid:17   gid:17     uid:5142 gid:5142
188 +-------+-------+    +-------+-------+    +-------+- - - -+    +- - - -+-------+
189 | valid | valid | :: | valid | valid | :: | valid | inval | :: | inval | valid |
190 +-------+-------+    +-------+-------+    +-------+- - - -+    +- - - -+-------+
191 next:12   next:12    next:17 next:5142    next:NULL                    next:NULL
192     |       |            |       |            |<-- user quota list         |
193      \______|___________/ \______|___________/         group quota list -->|
194             |                    |                                         |
195              \__________________/ \_______________________________________/
196 
197 */
198 
199 /*
200  * quota structure
201  */
202 
203 struct gfs2_quota {
204 	__be64 qu_limit;
205 	__be64 qu_warn;
206 	__be64 qu_value;
207 	__be32 qu_ll_next; /* location of next quota in list */
208 	__u8 qu_reserved[60];
209 };
210 
211 /*
212  * dinode structure
213  */
214 
215 #define GFS2_MAX_META_HEIGHT	10
216 #define GFS2_DIR_MAX_DEPTH	17
217 
218 #define DT2IF(dt) (((dt) << 12) & S_IFMT)
219 #define IF2DT(sif) (((sif) & S_IFMT) >> 12)
220 
221 enum {
222 	gfs2fl_Jdata		= 0,
223 	gfs2fl_ExHash		= 1,
224 	gfs2fl_Unused		= 2,
225 	gfs2fl_EaIndirect	= 3,
226 	gfs2fl_Directio		= 4,
227 	gfs2fl_Immutable	= 5,
228 	gfs2fl_AppendOnly	= 6,
229 	gfs2fl_NoAtime		= 7,
230 	gfs2fl_Sync		= 8,
231 	gfs2fl_System		= 9,
232 	gfs2fl_TruncInProg	= 29,
233 	gfs2fl_InheritDirectio	= 30,
234 	gfs2fl_InheritJdata	= 31,
235 };
236 
237 /* Dinode flags */
238 #define GFS2_DIF_JDATA			0x00000001
239 #define GFS2_DIF_EXHASH			0x00000002
240 #define GFS2_DIF_UNUSED			0x00000004  /* only in gfs1 */
241 #define GFS2_DIF_EA_INDIRECT		0x00000008
242 #define GFS2_DIF_DIRECTIO		0x00000010
243 #define GFS2_DIF_IMMUTABLE		0x00000020
244 #define GFS2_DIF_APPENDONLY		0x00000040
245 #define GFS2_DIF_NOATIME		0x00000080
246 #define GFS2_DIF_SYNC			0x00000100
247 #define GFS2_DIF_SYSTEM			0x00000200 /* New in gfs2 */
248 #define GFS2_DIF_TRUNC_IN_PROG		0x20000000 /* New in gfs2 */
249 #define GFS2_DIF_INHERIT_DIRECTIO	0x40000000
250 #define GFS2_DIF_INHERIT_JDATA		0x80000000
251 
252 struct gfs2_dinode {
253 	struct gfs2_meta_header di_header;
254 
255 	struct gfs2_inum di_num;
256 
257 	__be32 di_mode;	/* mode of file */
258 	__be32 di_uid;	/* owner's user id */
259 	__be32 di_gid;	/* owner's group id */
260 	__be32 di_nlink;	/* number of links to this file */
261 	__be64 di_size;	/* number of bytes in file */
262 	__be64 di_blocks;	/* number of blocks in file */
263 	__be64 di_atime;	/* time last accessed */
264 	__be64 di_mtime;	/* time last modified */
265 	__be64 di_ctime;	/* time last changed */
266 	__be32 di_major;	/* device major number */
267 	__be32 di_minor;	/* device minor number */
268 
269 	/* This section varies from gfs1. Padding added to align with
270          * remainder of dinode
271 	 */
272 	__be64 di_goal_meta;	/* rgrp to alloc from next */
273 	__be64 di_goal_data;	/* data block goal */
274 	__be64 di_generation;	/* generation number for NFS */
275 
276 	__be32 di_flags;	/* GFS2_DIF_... */
277 	__be32 di_payload_format;  /* GFS2_FORMAT_... */
278 	__u16 __pad1;	/* Was ditype in gfs1 */
279 	__be16 di_height;	/* height of metadata */
280 	__u32 __pad2;	/* Unused incarnation number from gfs1 */
281 
282 	/* These only apply to directories  */
283 	__u16 __pad3;	/* Padding */
284 	__be16 di_depth;	/* Number of bits in the table */
285 	__be32 di_entries;	/* The number of entries in the directory */
286 
287 	struct gfs2_inum __pad4; /* Unused even in current gfs1 */
288 
289 	__be64 di_eattr;	/* extended attribute block number */
290 	__be32 di_atime_nsec;   /* nsec portion of atime */
291 	__be32 di_mtime_nsec;   /* nsec portion of mtime */
292 	__be32 di_ctime_nsec;   /* nsec portion of ctime */
293 
294 	__u8 di_reserved[44];
295 };
296 
297 /*
298  * directory structure - many of these per directory file
299  */
300 
301 #define GFS2_FNAMESIZE		255
302 #define GFS2_DIRENT_SIZE(name_len) ((sizeof(struct gfs2_dirent) + (name_len) + 7) & ~7)
303 
304 struct gfs2_dirent {
305 	struct gfs2_inum de_inum;
306 	__be32 de_hash;
307 	__be16 de_rec_len;
308 	__be16 de_name_len;
309 	__be16 de_type;
310 	__u8 __pad[14];
311 };
312 
313 /*
314  * Header of leaf directory nodes
315  */
316 
317 struct gfs2_leaf {
318 	struct gfs2_meta_header lf_header;
319 
320 	__be16 lf_depth;		/* Depth of leaf */
321 	__be16 lf_entries;		/* Number of dirents in leaf */
322 	__be32 lf_dirent_format;	/* Format of the dirents */
323 	__be64 lf_next;			/* Next leaf, if overflow */
324 
325 	__u8 lf_reserved[64];
326 };
327 
328 /*
329  * Extended attribute header format
330  */
331 
332 #define GFS2_EA_MAX_NAME_LEN	255
333 #define GFS2_EA_MAX_DATA_LEN	65536
334 
335 #define GFS2_EATYPE_UNUSED	0
336 #define GFS2_EATYPE_USR		1
337 #define GFS2_EATYPE_SYS		2
338 #define GFS2_EATYPE_SECURITY	3
339 
340 #define GFS2_EATYPE_LAST	3
341 #define GFS2_EATYPE_VALID(x)	((x) <= GFS2_EATYPE_LAST)
342 
343 #define GFS2_EAFLAG_LAST	0x01	/* last ea in block */
344 
345 struct gfs2_ea_header {
346 	__be32 ea_rec_len;
347 	__be32 ea_data_len;
348 	__u8 ea_name_len;	/* no NULL pointer after the string */
349 	__u8 ea_type;		/* GFS2_EATYPE_... */
350 	__u8 ea_flags;		/* GFS2_EAFLAG_... */
351 	__u8 ea_num_ptrs;
352 	__u32 __pad;
353 };
354 
355 /*
356  * Log header structure
357  */
358 
359 #define GFS2_LOG_HEAD_UNMOUNT	0x00000001	/* log is clean */
360 
361 struct gfs2_log_header {
362 	struct gfs2_meta_header lh_header;
363 
364 	__be64 lh_sequence;	/* Sequence number of this transaction */
365 	__be32 lh_flags;	/* GFS2_LOG_HEAD_... */
366 	__be32 lh_tail;		/* Block number of log tail */
367 	__be32 lh_blkno;
368 	__be32 lh_hash;
369 };
370 
371 /*
372  * Log type descriptor
373  */
374 
375 #define GFS2_LOG_DESC_METADATA	300
376 /* ld_data1 is the number of metadata blocks in the descriptor.
377    ld_data2 is unused. */
378 
379 #define GFS2_LOG_DESC_REVOKE	301
380 /* ld_data1 is the number of revoke blocks in the descriptor.
381    ld_data2 is unused. */
382 
383 #define GFS2_LOG_DESC_JDATA	302
384 /* ld_data1 is the number of data blocks in the descriptor.
385    ld_data2 is unused. */
386 
387 struct gfs2_log_descriptor {
388 	struct gfs2_meta_header ld_header;
389 
390 	__be32 ld_type;		/* GFS2_LOG_DESC_... */
391 	__be32 ld_length;	/* Number of buffers in this chunk */
392 	__be32 ld_data1;	/* descriptor-specific field */
393 	__be32 ld_data2;	/* descriptor-specific field */
394 
395 	__u8 ld_reserved[32];
396 };
397 
398 /*
399  * Inum Range
400  * Describe a range of formal inode numbers allocated to
401  * one machine to assign to inodes.
402  */
403 
404 #define GFS2_INUM_QUANTUM	1048576
405 
406 struct gfs2_inum_range {
407 	__be64 ir_start;
408 	__be64 ir_length;
409 };
410 
411 /*
412  * Statfs change
413  * Describes an change to the pool of free and allocated
414  * blocks.
415  */
416 
417 struct gfs2_statfs_change {
418 	__be64 sc_total;
419 	__be64 sc_free;
420 	__be64 sc_dinodes;
421 };
422 
423 /*
424  * Quota change
425  * Describes an allocation change for a particular
426  * user or group.
427  */
428 
429 #define GFS2_QCF_USER		0x00000001
430 
431 struct gfs2_quota_change {
432 	__be64 qc_change;
433 	__be32 qc_flags;	/* GFS2_QCF_... */
434 	__be32 qc_id;
435 };
436 
437 struct gfs2_quota_lvb {
438         __be32 qb_magic;
439         __u32 __pad;
440         __be64 qb_limit;      /* Hard limit of # blocks to alloc */
441         __be64 qb_warn;       /* Warn user when alloc is above this # */
442         __be64 qb_value;       /* Current # blocks allocated */
443 };
444 
445 #endif /* __GFS2_ONDISK_DOT_H__ */
446