xref: /openbsd/sys/msdosfs/msdosfsmount.h (revision f2dfb0a4)
1 /*	$OpenBSD: msdosfsmount.h,v 1.10 1998/02/08 22:41:44 tholo Exp $	*/
2 /*	$NetBSD: msdosfsmount.h,v 1.16 1997/10/17 11:24:24 ws Exp $	*/
3 
4 /*-
5  * Copyright (C) 1994, 1995, 1997 Wolfgang Solfrank.
6  * Copyright (C) 1994, 1995, 1997 TooLs GmbH.
7  * All rights reserved.
8  * Original code by Paul Popelka (paulp@uts.amdahl.com) (see below).
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed by TooLs GmbH.
21  * 4. The name of TooLs GmbH may not be used to endorse or promote products
22  *    derived from this software without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
25  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
26  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
29  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
30  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
31  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
32  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
33  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  */
35 /*
36  * Written by Paul Popelka (paulp@uts.amdahl.com)
37  *
38  * You can do anything you want with this software, just don't say you wrote
39  * it, and don't remove this notice.
40  *
41  * This software is provided "as is".
42  *
43  * The author supplies this software to be publicly redistributed on the
44  * understanding that the author is not responsible for the correct
45  * functioning of this software in any circumstances and is not liable for
46  * any damages caused by this software.
47  *
48  * October 1992
49  */
50 
51 /*
52  * Layout of the mount control block for a msdos file system.
53  */
54 struct msdosfsmount {
55 	struct mount *pm_mountp;/* vfs mount struct for this fs */
56 	dev_t pm_dev;		/* block special device mounted */
57 	uid_t pm_uid;		/* uid to set as owner of the files */
58 	gid_t pm_gid;		/* gid to set as owner of the files */
59 	mode_t pm_mask;		/* mask to and with file protection bits */
60 	struct vnode *pm_devvp;	/* vnode for block device mntd */
61 	struct bpb50 pm_bpb;	/* BIOS parameter blk for this fs */
62 	u_long pm_FATsecs;	/* actual number of fat sectors */
63 	u_long pm_fatblk;	/* block # of first FAT */
64 	u_long pm_rootdirblk;	/* block # (cluster # for FAT32) of root directory number */
65 	u_long pm_rootdirsize;	/* size in blocks (not clusters) */
66 	u_long pm_firstcluster;	/* block number of first cluster */
67 	u_long pm_nmbrofclusters;	/* # of clusters in filesystem */
68 	u_long pm_maxcluster;	/* maximum cluster number */
69 	u_long pm_freeclustercount;	/* number of free clusters */
70 	u_long pm_cnshift;	/* shift file offset right this amount to get a cluster number */
71 	u_long pm_crbomask;	/* and a file offset with this mask to get cluster rel offset */
72 	u_long pm_bnshift;	/* shift file offset right this amount to get a block number */
73 	u_long pm_bpcluster;	/* bytes per cluster */
74 	u_long pm_fmod;		/* ~0 if fs is modified, this can rollover to 0	*/
75 	u_long pm_fatblocksize;	/* size of fat blocks in bytes */
76 	u_long pm_fatblocksec;	/* size of fat blocks in sectors */
77 	u_long pm_fatsize;	/* size of fat in bytes */
78 	u_long pm_fatmask;	/* mask to use for fat numbers */
79 	u_long pm_fsinfo;	/* fsinfo block number */
80 	u_long pm_nxtfree;	/* next free cluster in fsinfo block */
81 	u_int pm_fatmult;	/* these 2 values are used in fat */
82 	u_int pm_fatdiv;	/*	offset computation */
83 	u_int pm_curfat;	/* current fat for FAT32 (0 otherwise) */
84 	u_int *pm_inusemap;	/* ptr to bitmap of in-use clusters */
85 	u_int pm_flags;		/* see below */
86 	struct netexport pm_export;	/* export information */
87 };
88 /* Byte offset in FAT on filesystem pmp, cluster cn */
89 #define	FATOFS(pmp, cn)	((cn) * (pmp)->pm_fatmult / (pmp)->pm_fatdiv)
90 
91 /*
92  * Mount point flags:
93  */
94 #if 0
95     /* Defined in <sys/mount.h> */
96 #define	MSDOSFSMNT_SHORTNAME	1
97 #define	MSDOSFSMNT_LONGNAME	2
98 #define	MSDOSFSMNT_NOWIN95	4
99 #define	MSDOSFSMNT_GEMDOSFS	8
100 #endif
101 
102 /* All flags above: */
103 #define	MSDOSFSMNT_MNTOPT \
104 	(MSDOSFSMNT_SHORTNAME|MSDOSFSMNT_LONGNAME|MSDOSFSMNT_NOWIN95 \
105 	 |MSDOSFSMNT_GEMDOSFS)
106 #define	MSDOSFSMNT_RONLY	0x80000000	/* mounted read-only	*/
107 #define	MSDOSFSMNT_WAITONFAT	0x40000000	/* mounted synchronous	*/
108 #define	MSDOSFS_FATMIRROR	0x20000000	/* FAT is mirrored */
109 
110 #define	VFSTOMSDOSFS(mp)	((struct msdosfsmount *)mp->mnt_data)
111 
112 /* Number of bits in one pm_inusemap item: */
113 #define	N_INUSEBITS	(8 * sizeof(u_int))
114 
115 /*
116  * Shorthand for fields in the bpb contained in the msdosfsmount structure.
117  */
118 #define	pm_BytesPerSec	pm_bpb.bpbBytesPerSec
119 #define	pm_ResSectors	pm_bpb.bpbResSectors
120 #define	pm_FATs		pm_bpb.bpbFATs
121 #define	pm_RootDirEnts	pm_bpb.bpbRootDirEnts
122 #define	pm_Sectors	pm_bpb.bpbSectors
123 #define	pm_Media	pm_bpb.bpbMedia
124 #define	pm_SecPerTrack	pm_bpb.bpbSecPerTrack
125 #define	pm_Heads	pm_bpb.bpbHeads
126 #define	pm_HiddenSects	pm_bpb.bpbHiddenSecs
127 #define	pm_HugeSectors	pm_bpb.bpbHugeSectors
128 
129 /*
130  * Convert pointer to buffer -> pointer to direntry
131  */
132 #define	bptoep(pmp, bp, dirofs) \
133 	((struct direntry *)(((bp)->b_data)	\
134 	 + ((dirofs) & (pmp)->pm_crbomask)))
135 
136 /*
137  * Convert block number to cluster number
138  */
139 #define	de_bn2cn(pmp, bn) \
140 	((bn) >> ((pmp)->pm_cnshift - (pmp)->pm_bnshift))
141 
142 /*
143  * Convert cluster number to block number
144  */
145 #define	de_cn2bn(pmp, cn) \
146 	((cn) << ((pmp)->pm_cnshift - (pmp)->pm_bnshift))
147 
148 /*
149  * Convert file offset to cluster number
150  */
151 #define de_cluster(pmp, off) \
152 	((off) >> (pmp)->pm_cnshift)
153 
154 /*
155  * Clusters required to hold size bytes
156  */
157 #define	de_clcount(pmp, size) \
158 	(((size) + (pmp)->pm_bpcluster - 1) >> (pmp)->pm_cnshift)
159 
160 /*
161  * Convert file offset to block number
162  */
163 #define de_blk(pmp, off) \
164 	(de_cn2bn(pmp, de_cluster((pmp), (off))))
165 
166 /*
167  * Convert cluster number to file offset
168  */
169 #define	de_cn2off(pmp, cn) \
170 	((cn) << (pmp)->pm_cnshift)
171 
172 /*
173  * Convert block number to file offset
174  */
175 #define	de_bn2off(pmp, bn) \
176 	((bn) << (pmp)->pm_bnshift)
177 /*
178  * Map a cluster number into a filesystem relative block number.
179  */
180 #define	cntobn(pmp, cn) \
181 	(de_cn2bn((pmp), (cn)-CLUST_FIRST) + (pmp)->pm_firstcluster)
182 
183 /*
184  * Calculate block number for directory entry in root dir, offset dirofs
185  */
186 #define	roottobn(pmp, dirofs) \
187 	(de_blk((pmp), (dirofs)) + (pmp)->pm_rootdirblk)
188 
189 /*
190  * Calculate block number for directory entry at cluster dirclu, offset
191  * dirofs
192  */
193 #define	detobn(pmp, dirclu, dirofs) \
194 	((dirclu) == MSDOSFSROOT \
195 	 ? roottobn((pmp), (dirofs)) \
196 	 : cntobn((pmp), (dirclu)))
197 
198 /*
199  * Prototypes for MSDOSFS virtual filesystem operations
200  */
201 int msdosfs_mount __P((struct mount *, const char *, caddr_t, struct nameidata *, struct proc *));
202 int msdosfs_start __P((struct mount *, int, struct proc *));
203 int msdosfs_unmount __P((struct mount *, int, struct proc *));
204 int msdosfs_root __P((struct mount *, struct vnode **));
205 int msdosfs_quotactl __P((struct mount *, int, uid_t, caddr_t, struct proc *));
206 int msdosfs_statfs __P((struct mount *, struct statfs *, struct proc *));
207 int msdosfs_sync __P((struct mount *, int, struct ucred *, struct proc *));
208 int msdosfs_fhtovp __P((struct mount *, struct fid *, struct mbuf *, struct vnode **, int *, struct ucred **));
209 int msdosfs_vptofh __P((struct vnode *, struct fid *));
210 int msdosfs_init __P((struct vfsconf *));
211