xref: /openbmc/linux/fs/freevxfs/vxfs.h (revision 1da177e4)
1 /*
2  * Copyright (c) 2000-2001 Christoph Hellwig.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions, and the following disclaimer,
10  *    without modification.
11  * 2. The name of the author may not be used to endorse or promote products
12  *    derived from this software without specific prior written permission.
13  *
14  * Alternatively, this software may be distributed under the terms of the
15  * GNU General Public License ("GPL").
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
21  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  */
30 #ifndef _VXFS_SUPER_H_
31 #define _VXFS_SUPER_H_
32 
33 /*
34  * Veritas filesystem driver - superblock structure.
35  *
36  * This file contains the definition of the disk and core
37  * superblocks of the Veritas Filesystem.
38  */
39 #include <linux/types.h>
40 #include "vxfs_kcompat.h"
41 
42 
43 /*
44  * Data types for use with the VxFS ondisk format.
45  */
46 typedef	int32_t		vx_daddr_t;
47 typedef int32_t		vx_ino_t;
48 
49 /*
50  * Superblock magic number (vxfs_super->vs_magic).
51  */
52 #define VXFS_SUPER_MAGIC	0xa501FCF5
53 
54 /*
55  * The root inode.
56  */
57 #define VXFS_ROOT_INO		2
58 
59 /*
60  * Num of entries in free extent array
61  */
62 #define VXFS_NEFREE		32
63 
64 
65 /*
66  * VxFS superblock (disk).
67  */
68 struct vxfs_sb {
69 	/*
70 	 * Readonly fields for the version 1 superblock.
71 	 *
72 	 * Lots of this fields are no more used by version 2
73 	 * and never filesystems.
74 	 */
75 	u_int32_t	vs_magic;		/* Magic number */
76 	int32_t		vs_version;		/* VxFS version */
77 	u_int32_t	vs_ctime;		/* create time - secs */
78 	u_int32_t	vs_cutime;		/* create time - usecs */
79 	int32_t		__unused1;		/* unused */
80 	int32_t		__unused2;		/* unused */
81 	vx_daddr_t	vs_old_logstart;	/* obsolete */
82 	vx_daddr_t	vs_old_logend;		/* obsolete */
83 	int32_t		vs_bsize;		/* block size */
84 	int32_t		vs_size;		/* number of blocks */
85 	int32_t		vs_dsize;		/* number of data blocks */
86 	u_int32_t	vs_old_ninode;		/* obsolete */
87 	int32_t		vs_old_nau;		/* obsolete */
88 	int32_t		__unused3;		/* unused */
89 	int32_t		vs_old_defiextsize;	/* obsolete */
90 	int32_t		vs_old_ilbsize;		/* obsolete */
91 	int32_t		vs_immedlen;		/* size of immediate data area */
92 	int32_t		vs_ndaddr;		/* number of direct extentes */
93 	vx_daddr_t	vs_firstau;		/* address of first AU */
94 	vx_daddr_t	vs_emap;		/* offset of extent map in AU */
95 	vx_daddr_t	vs_imap;		/* offset of inode map in AU */
96 	vx_daddr_t	vs_iextop;		/* offset of ExtOp. map in AU */
97 	vx_daddr_t	vs_istart;		/* offset of inode list in AU */
98 	vx_daddr_t	vs_bstart;		/* offset of fdblock in AU */
99 	vx_daddr_t	vs_femap;		/* aufirst + emap */
100 	vx_daddr_t	vs_fimap;		/* aufirst + imap */
101 	vx_daddr_t	vs_fiextop;		/* aufirst + iextop */
102 	vx_daddr_t	vs_fistart;		/* aufirst + istart */
103 	vx_daddr_t	vs_fbstart;		/* aufirst + bstart */
104 	int32_t		vs_nindir;		/* number of entries in indir */
105 	int32_t		vs_aulen;		/* length of AU in blocks */
106 	int32_t		vs_auimlen;		/* length of imap in blocks */
107 	int32_t		vs_auemlen;		/* length of emap in blocks */
108 	int32_t		vs_auilen;		/* length of ilist in blocks */
109 	int32_t		vs_aupad;		/* length of pad in blocks */
110 	int32_t		vs_aublocks;		/* data blocks in AU */
111 	int32_t		vs_maxtier;		/* log base 2 of aublocks */
112 	int32_t		vs_inopb;		/* number of inodes per blk */
113 	int32_t		vs_old_inopau;		/* obsolete */
114 	int32_t		vs_old_inopilb;		/* obsolete */
115 	int32_t		vs_old_ndiripau;	/* obsolete */
116 	int32_t		vs_iaddrlen;		/* size of indirect addr ext. */
117 	int32_t		vs_bshift;		/* log base 2 of bsize */
118 	int32_t		vs_inoshift;		/* log base 2 of inobp */
119 	int32_t		vs_bmask;		/* ~( bsize - 1 ) */
120 	int32_t		vs_boffmask;		/* bsize - 1 */
121 	int32_t		vs_old_inomask;		/* old_inopilb - 1 */
122 	int32_t		vs_checksum;		/* checksum of V1 data */
123 
124 	/*
125 	 * Version 1, writable
126 	 */
127 	int32_t		vs_free;		/* number of free blocks */
128 	int32_t		vs_ifree;		/* number of free inodes */
129 	int32_t		vs_efree[VXFS_NEFREE];	/* number of free extents by size */
130 	int32_t		vs_flags;		/* flags ?!? */
131 	u_int8_t	vs_mod;			/* filesystem has been changed */
132 	u_int8_t	vs_clean;		/* clean FS */
133 	u_int16_t	__unused4;		/* unused */
134 	u_int32_t	vs_firstlogid;		/* mount time log ID */
135 	u_int32_t	vs_wtime;		/* last time written - sec */
136 	u_int32_t	vs_wutime;		/* last time written - usec */
137 	u_int8_t	vs_fname[6];		/* FS name */
138 	u_int8_t	vs_fpack[6];		/* FS pack name */
139 	int32_t		vs_logversion;		/* log format version */
140 	int32_t		__unused5;		/* unused */
141 
142 	/*
143 	 * Version 2, Read-only
144 	 */
145 	vx_daddr_t	vs_oltext[2];		/* OLT extent and replica */
146 	int32_t		vs_oltsize;		/* OLT extent size */
147 	int32_t		vs_iauimlen;		/* size of inode map */
148 	int32_t		vs_iausize;		/* size of IAU in blocks */
149 	int32_t		vs_dinosize;		/* size of inode in bytes */
150 	int32_t		vs_old_dniaddr;		/* indir levels per inode */
151 	int32_t		vs_checksum2;		/* checksum of V2 RO */
152 
153 	/*
154 	 * Actually much more...
155 	 */
156 };
157 
158 
159 /*
160  * In core superblock filesystem private data for VxFS.
161  */
162 struct vxfs_sb_info {
163 	struct vxfs_sb		*vsi_raw;	/* raw (on disk) supeblock */
164 	struct buffer_head	*vsi_bp;	/* buffer for raw superblock*/
165 	struct inode		*vsi_fship;	/* fileset header inode */
166 	struct inode		*vsi_ilist;	/* inode list inode */
167 	struct inode		*vsi_stilist;	/* structual inode list inode */
168 	u_long			vsi_iext;	/* initial inode list */
169 	ino_t			vsi_fshino;	/* fileset header inode */
170 	daddr_t			vsi_oltext;	/* OLT extent */
171 	daddr_t			vsi_oltsize;	/* OLT size */
172 };
173 
174 
175 /*
176  * File modes.  File types above 0xf000 are vxfs internal only, they should
177  * not be passed back to higher levels of the system.  vxfs file types must
178  * never have one of the regular file type bits set.
179  */
180 enum vxfs_mode {
181 	VXFS_ISUID = 0x00000800,	/* setuid */
182 	VXFS_ISGID = 0x00000400,	/* setgid */
183 	VXFS_ISVTX = 0x00000200,	/* sticky bit */
184 	VXFS_IREAD = 0x00000100,	/* read */
185 	VXFS_IWRITE = 0x00000080,	/* write */
186 	VXFS_IEXEC = 0x00000040,	/* exec */
187 
188 	VXFS_IFIFO = 0x00001000,	/* Named pipe */
189 	VXFS_IFCHR = 0x00002000,	/* Character device */
190 	VXFS_IFDIR = 0x00004000,	/* Directory */
191 	VXFS_IFNAM = 0x00005000,	/* Xenix device ?? */
192 	VXFS_IFBLK = 0x00006000,	/* Block device */
193 	VXFS_IFREG = 0x00008000,	/* Regular file */
194 	VXFS_IFCMP = 0x00009000,	/* Compressed file ?!? */
195 	VXFS_IFLNK = 0x0000a000,	/* Symlink */
196 	VXFS_IFSOC = 0x0000c000,	/* Socket */
197 
198 	/* VxFS internal */
199 	VXFS_IFFSH = 0x10000000,	/* Fileset header */
200 	VXFS_IFILT = 0x20000000,	/* Inode list */
201 	VXFS_IFIAU = 0x30000000,	/* Inode allocation unit */
202 	VXFS_IFCUT = 0x40000000,	/* Current usage table */
203 	VXFS_IFATT = 0x50000000,	/* Attr. inode */
204 	VXFS_IFLCT = 0x60000000,	/* Link count table */
205 	VXFS_IFIAT = 0x70000000,	/* Indirect attribute file */
206 	VXFS_IFEMR = 0x80000000,	/* Extent map reorg file */
207 	VXFS_IFQUO = 0x90000000,	/* BSD quota file */
208 	VXFS_IFPTI = 0xa0000000,	/* "Pass through" inode */
209 	VXFS_IFLAB = 0x11000000,	/* Device label file */
210 	VXFS_IFOLT = 0x12000000,	/* OLT file */
211 	VXFS_IFLOG = 0x13000000,	/* Log file */
212 	VXFS_IFEMP = 0x14000000,	/* Extent map file */
213 	VXFS_IFEAU = 0x15000000,	/* Extent AU file */
214 	VXFS_IFAUS = 0x16000000,	/* Extent AU summary file */
215 	VXFS_IFDEV = 0x17000000,	/* Device config file */
216 
217 };
218 
219 #define	VXFS_TYPE_MASK		0xfffff000
220 
221 #define VXFS_IS_TYPE(ip,type)	(((ip)->vii_mode & VXFS_TYPE_MASK) == (type))
222 #define VXFS_ISFIFO(x)		VXFS_IS_TYPE((x),VXFS_IFIFO)
223 #define VXFS_ISCHR(x)		VXFS_IS_TYPE((x),VXFS_IFCHR)
224 #define VXFS_ISDIR(x)		VXFS_IS_TYPE((x),VXFS_IFDIR)
225 #define VXFS_ISNAM(x)		VXFS_IS_TYPE((x),VXFS_IFNAM)
226 #define VXFS_ISBLK(x)		VXFS_IS_TYPE((x),VXFS_IFBLK)
227 #define VXFS_ISLNK(x)		VXFS_IS_TYPE((x),VXFS_IFLNK)
228 #define VXFS_ISREG(x)		VXFS_IS_TYPE((x),VXFS_IFREG)
229 #define VXFS_ISCMP(x)		VXFS_IS_TYPE((x),VXFS_IFCMP)
230 #define VXFS_ISSOC(x)		VXFS_IS_TYPE((x),VXFS_IFSOC)
231 
232 #define VXFS_ISFSH(x)		VXFS_IS_TYPE((x),VXFS_IFFSH)
233 #define VXFS_ISILT(x)		VXFS_IS_TYPE((x),VXFS_IFILT)
234 
235 /*
236  * Inmode organisation types.
237  */
238 enum {
239 	VXFS_ORG_NONE	= 0,	/* Inode has *no* format ?!? */
240 	VXFS_ORG_EXT4	= 1,	/* Ext4 */
241 	VXFS_ORG_IMMED	= 2,	/* All data stored in inode */
242 	VXFS_ORG_TYPED	= 3,	/* Typed extents */
243 };
244 
245 #define VXFS_IS_ORG(ip,org)	((ip)->vii_orgtype == (org))
246 #define VXFS_ISNONE(ip)		VXFS_IS_ORG((ip), VXFS_ORG_NONE)
247 #define VXFS_ISEXT4(ip)		VXFS_IS_ORG((ip), VXFS_ORG_EXT4)
248 #define VXFS_ISIMMED(ip)	VXFS_IS_ORG((ip), VXFS_ORG_IMMED)
249 #define VXFS_ISTYPED(ip)	VXFS_IS_ORG((ip), VXFS_ORG_TYPED)
250 
251 
252 /*
253  * Get filesystem private data from VFS inode.
254  */
255 #define VXFS_INO(ip) \
256 	((struct vxfs_inode_info *)(ip)->u.generic_ip)
257 
258 /*
259  * Get filesystem private data from VFS superblock.
260  */
261 #define VXFS_SBI(sbp) \
262 	((struct vxfs_sb_info *)(sbp)->s_fs_info)
263 
264 #endif /* _VXFS_SUPER_H_ */
265