xref: /dragonfly/sys/vfs/msdosfs/msdosfsmount.h (revision b40e316c)
1 /* $FreeBSD: src/sys/msdosfs/msdosfsmount.h,v 1.20.2.2 2000/10/27 09:45:07 bde Exp $ */
2 /* $DragonFly: src/sys/vfs/msdosfs/msdosfsmount.h,v 1.5 2004/02/05 21:03:37 rob Exp $ */
3 /*	$NetBSD: msdosfsmount.h,v 1.17 1997/11/17 15:37:07 ws Exp $	*/
4 
5 /*-
6  * Copyright (C) 1994, 1995, 1997 Wolfgang Solfrank.
7  * Copyright (C) 1994, 1995, 1997 TooLs GmbH.
8  * All rights reserved.
9  * Original code by Paul Popelka (paulp@uts.amdahl.com) (see below).
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by TooLs GmbH.
22  * 4. The name of TooLs GmbH may not be used to endorse or promote products
23  *    derived from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
26  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
27  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
28  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
30  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
31  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
32  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
33  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
34  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35  */
36 /*
37  * Written by Paul Popelka (paulp@uts.amdahl.com)
38  *
39  * You can do anything you want with this software, just don't say you wrote
40  * it, and don't remove this notice.
41  *
42  * This software is provided "as is".
43  *
44  * The author supplies this software to be publicly redistributed on the
45  * understanding that the author is not responsible for the correct
46  * functioning of this software in any circumstances and is not liable for
47  * any damages caused by this software.
48  *
49  * October 1992
50  */
51 
52 #ifndef _MSDOSFS_MSDOSFSMOUNT_H_
53 #define	_MSDOSFS_MSDOSFSMOUNT_H_
54 
55 #ifdef _KERNEL
56 #ifdef MALLOC_DECLARE
57 MALLOC_DECLARE(M_MSDOSFSMNT);
58 #endif
59 #endif
60 
61 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
62 
63 /*
64  * Layout of the mount control block for a msdos file system.
65  */
66 struct msdosfsmount {
67 	struct mount *pm_mountp;/* vfs mount struct for this fs */
68 	dev_t pm_dev;		/* block special device mounted */
69 	uid_t pm_uid;		/* uid to set as owner of the files */
70 	gid_t pm_gid;		/* gid to set as owner of the files */
71 	mode_t pm_mask;		/* mask to and with file protection bits */
72 	struct vnode *pm_devvp;	/* vnode for block device mntd */
73 	struct bpb50 pm_bpb;	/* BIOS parameter blk for this fs */
74 	u_long pm_BlkPerSec;	/* How many DEV_BSIZE blocks fit inside a physical sector */
75 	u_long pm_FATsecs;	/* actual number of fat sectors */
76 	u_long pm_fatblk;	/* block # of first FAT */
77 	u_long pm_rootdirblk;	/* block # (cluster # for FAT32) of root directory number */
78 	u_long pm_rootdirsize;	/* size in blocks (not clusters) */
79 	u_long pm_firstcluster;	/* block number of first cluster */
80 	u_long pm_maxcluster;	/* maximum cluster number */
81 	u_long pm_freeclustercount;	/* number of free clusters */
82 	u_long pm_cnshift;	/* shift file offset right this amount to get a cluster number */
83 	u_long pm_crbomask;	/* and a file offset with this mask to get cluster rel offset */
84 	u_long pm_bnshift;	/* shift file offset right this amount to get a block number */
85 	u_long pm_bpcluster;	/* bytes per cluster */
86 	u_long pm_fmod;		/* ~0 if fs is modified, this can rollover to 0	*/
87 	u_long pm_fatblocksize;	/* size of fat blocks in bytes */
88 	u_long pm_fatblocksec;	/* size of fat blocks in sectors */
89 	u_long pm_fatsize;	/* size of fat in bytes */
90 	u_int32_t pm_fatmask;	/* mask to use for fat numbers */
91 	u_long pm_fsinfo;	/* fsinfo block number */
92 	u_long pm_nxtfree;	/* next free cluster in fsinfo block */
93 	u_int pm_fatmult;	/* these 2 values are used in fat */
94 	u_int pm_fatdiv;	/*	offset computation */
95 	u_int pm_curfat;	/* current fat for FAT32 (0 otherwise) */
96 	u_int *pm_inusemap;	/* ptr to bitmap of in-use clusters */
97 	u_int pm_flags;		/* see below */
98 	struct netexport pm_export;	/* export information */
99 	u_int16_t pm_u2w[128];  /* Local->Unicode table */
100 	u_int8_t  pm_ul[128];   /* Local upper->lower table */
101 	u_int8_t  pm_lu[128];   /* Local lower->upper table */
102 	u_int8_t  pm_d2u[128];  /* DOS->local table */
103 	u_int8_t  pm_u2d[128];  /* Local->DOS table */
104 };
105 /* Byte offset in FAT on filesystem pmp, cluster cn */
106 #define	FATOFS(pmp, cn)	((cn) * (pmp)->pm_fatmult / (pmp)->pm_fatdiv)
107 
108 
109 #define	VFSTOMSDOSFS(mp)	((struct msdosfsmount *)mp->mnt_data)
110 
111 /* Number of bits in one pm_inusemap item: */
112 #define	N_INUSEBITS	(8 * sizeof(u_int))
113 
114 /*
115  * Shorthand for fields in the bpb contained in the msdosfsmount structure.
116  */
117 #define	pm_BytesPerSec	pm_bpb.bpbBytesPerSec
118 #define	pm_ResSectors	pm_bpb.bpbResSectors
119 #define	pm_FATs		pm_bpb.bpbFATs
120 #define	pm_RootDirEnts	pm_bpb.bpbRootDirEnts
121 #define	pm_Sectors	pm_bpb.bpbSectors
122 #define	pm_Media	pm_bpb.bpbMedia
123 #define	pm_SecPerTrack	pm_bpb.bpbSecPerTrack
124 #define	pm_Heads	pm_bpb.bpbHeads
125 #define	pm_HiddenSects	pm_bpb.bpbHiddenSecs
126 #define	pm_HugeSectors	pm_bpb.bpbHugeSectors
127 
128 /*
129  * Convert pointer to buffer -> pointer to direntry
130  */
131 #define	bptoep(pmp, bp, dirofs) \
132 	((struct direntry *)(((bp)->b_data)	\
133 	 + ((dirofs) & (pmp)->pm_crbomask)))
134 
135 /*
136  * Convert block number to cluster number
137  */
138 #define	de_bn2cn(pmp, bn) \
139 	((bn) >> ((pmp)->pm_cnshift - (pmp)->pm_bnshift))
140 
141 /*
142  * Convert cluster number to block number
143  */
144 #define	de_cn2bn(pmp, cn) \
145 	((cn) << ((pmp)->pm_cnshift - (pmp)->pm_bnshift))
146 
147 /*
148  * Convert file offset to cluster number
149  */
150 #define de_cluster(pmp, off) \
151 	((off) >> (pmp)->pm_cnshift)
152 
153 /*
154  * Clusters required to hold size bytes
155  */
156 #define	de_clcount(pmp, size) \
157 	(((size) + (pmp)->pm_bpcluster - 1) >> (pmp)->pm_cnshift)
158 
159 /*
160  * Convert file offset to block number
161  */
162 #define de_blk(pmp, off) \
163 	(de_cn2bn(pmp, de_cluster((pmp), (off))))
164 
165 /*
166  * Convert cluster number to file offset
167  */
168 #define	de_cn2off(pmp, cn) \
169 	((cn) << (pmp)->pm_cnshift)
170 
171 /*
172  * Convert block number to file offset
173  */
174 #define	de_bn2off(pmp, bn) \
175 	((bn) << (pmp)->pm_bnshift)
176 /*
177  * Map a cluster number into a filesystem relative block number.
178  */
179 #define	cntobn(pmp, cn) \
180 	(de_cn2bn((pmp), (cn)-CLUST_FIRST) + (pmp)->pm_firstcluster)
181 
182 /*
183  * Calculate block number for directory entry in root dir, offset dirofs
184  */
185 #define	roottobn(pmp, dirofs) \
186 	(de_blk((pmp), (dirofs)) + (pmp)->pm_rootdirblk)
187 
188 /*
189  * Calculate block number for directory entry at cluster dirclu, offset
190  * dirofs
191  */
192 #define	detobn(pmp, dirclu, dirofs) \
193 	((dirclu) == MSDOSFSROOT \
194 	 ? roottobn((pmp), (dirofs)) \
195 	 : cntobn((pmp), (dirclu)))
196 
197 /*
198  * Calculate fsinfo block size
199  */
200 #define	fsi_size(pmp) \
201 	(1024 << ((pmp)->pm_BlkPerSec >> 2))
202 
203 #endif /* _KERNEL || _KERNEL_STRUCTURES */
204 
205 #ifdef _KERNEL
206 
207 int msdosfs_init (struct vfsconf *vfsp);
208 int msdosfs_uninit (struct vfsconf *vfsp);
209 int msdosfs_mountroot (void);
210 
211 #endif
212 
213 /*
214  *  Arguments to mount MSDOS filesystems.
215  */
216 struct msdosfs_args {
217 	char	*fspec;		/* blocks special holding the fs to mount */
218 	struct	export_args export;	/* network export information */
219 	uid_t	uid;		/* uid that owns msdosfs files */
220 	gid_t	gid;		/* gid that owns msdosfs files */
221 	mode_t	mask;		/* mask to be applied for msdosfs perms */
222 	int	flags;		/* see below */
223 	int magic;		/* version number */
224 	u_int16_t u2w[128];     /* Local->Unicode table */
225 	u_int8_t  ul[128];      /* Local upper->lower table */
226 	u_int8_t  lu[128];      /* Local lower->upper table */
227 	u_int8_t  d2u[128];     /* DOS->local table */
228 	u_int8_t  u2d[128];     /* Local->DOS table */
229 };
230 
231 /*
232  * Msdosfs mount options:
233  */
234 #define	MSDOSFSMNT_SHORTNAME	1	/* Force old DOS short names only */
235 #define	MSDOSFSMNT_LONGNAME	2	/* Force Win'95 long names */
236 #define	MSDOSFSMNT_NOWIN95	4	/* Completely ignore Win95 entries */
237 #ifndef __DragonFly__
238 #define	MSDOSFSMNT_GEMDOSFS	8	/* This is a gemdos-flavour */
239 #endif
240 #define MSDOSFSMNT_U2WTABLE     0x10    /* Local->Unicode and local<->DOS   */
241 					/* tables loaded                    */
242 #define MSDOSFSMNT_ULTABLE      0x20    /* Local upper<->lower table loaded */
243 /* All flags above: */
244 #define	MSDOSFSMNT_MNTOPT \
245 	(MSDOSFSMNT_SHORTNAME|MSDOSFSMNT_LONGNAME|MSDOSFSMNT_NOWIN95 \
246 	 /*|MSDOSFSMNT_GEMDOSFS*/|MSDOSFSMNT_U2WTABLE|MSDOSFSMNT_ULTABLE)
247 #define	MSDOSFSMNT_RONLY	0x80000000	/* mounted read-only	*/
248 #define	MSDOSFSMNT_WAITONFAT	0x40000000	/* mounted synchronous	*/
249 #define	MSDOSFS_FATMIRROR	0x20000000	/* FAT is mirrored */
250 
251 #define MSDOSFS_ARGSMAGIC	0xe4eff300
252 
253 #endif /* !_MSDOSFS_MSDOSFSMOUNT_H_ */
254