2 /* $NetBSD: msdosfsmount.h,v 1.17 1997/11/17 15:37:07 ws Exp $ */
5 * SPDX-License-Identifier: BSD-4-Clause
7 * Copyright (C) 1994, 1995, 1997 Wolfgang Solfrank.
8 * Copyright (C) 1994, 1995, 1997 TooLs GmbH.
10 * Original code by Paul Popelka (paulp@uts.amdahl.com) (see below).
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. All advertising materials mentioning features or use of this software
21 * must display the following acknowledgement:
22 * This product includes software developed by TooLs GmbH.
23 * 4. The name of TooLs GmbH may not be used to endorse or promote products
24 * derived from this software without specific prior written permission.
26 * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
27 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
32 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
33 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
34 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
35 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 * Written by Paul Popelka (paulp@uts.amdahl.com)
40 * You can do anything you want with this software, just don't say you wrote
41 * it, and don't remove this notice.
43 * This software is provided "as is".
45 * The author supplies this software to be publicly redistributed on the
46 * understanding that the author is not responsible for the correct
47 * functioning of this software in any circumstances and is not liable for
48 * any damages caused by this software.
53 #ifndef _MSDOSFS_MSDOSFSMOUNT_H_
54 #define _MSDOSFS_MSDOSFSMOUNT_H_
58 #include <sys/types.h>
60 #include <sys/lockmgr.h>
64 MALLOC_DECLARE(M_MSDOSFSMNT);
67 struct msdosfs_fileno;
70 * Layout of the mount control block for a MSDOSFS filesystem.
73 struct mount *pm_mountp;/* vfs mount struct for this fs */
74 struct g_consumer *pm_cp;
76 uid_t pm_uid; /* uid to set as owner of the files */
77 gid_t pm_gid; /* gid to set as owner of the files */
78 mode_t pm_mask; /* mask to and with file protection bits
80 mode_t pm_dirmask; /* mask to and with file protection bits
82 struct vnode *pm_devvp; /* vnode for character device mounted */
83 struct cdev *pm_dev; /* character device mounted */
84 struct bpb50 pm_bpb; /* BIOS parameter blk for this fs */
85 u_long pm_BlkPerSec; /* How many DEV_BSIZE blocks fit inside a physical sector */
86 u_long pm_FATsecs; /* actual number of FAT sectors */
87 u_long pm_fatblk; /* block # of first FAT */
88 u_long pm_rootdirblk; /* block # (cluster # for FAT32) of root directory number */
89 u_long pm_rootdirsize; /* size in blocks (not clusters) */
90 u_long pm_firstcluster; /* block number of first cluster */
91 u_long pm_maxcluster; /* maximum cluster number */
92 u_long pm_freeclustercount; /* number of free clusters */
93 u_long pm_cnshift; /* shift file offset right this amount to get a cluster number */
94 u_long pm_crbomask; /* and a file offset with this mask to get cluster rel offset */
95 u_long pm_bnshift; /* shift file offset right this amount to get a block number */
96 u_long pm_bpcluster; /* bytes per cluster */
97 u_long pm_fmod; /* ~0 if fs is modified, this can rollover to 0 */
98 u_long pm_fatblocksize; /* size of FAT blocks in bytes */
99 u_long pm_fatblocksec; /* size of FAT blocks in sectors */
100 u_long pm_fatsize; /* size of FAT in bytes */
101 uint32_t pm_fatmask; /* mask to use for FAT numbers */
102 u_long pm_fsinfo; /* fsinfo block number */
103 u_long pm_nxtfree; /* next place to search for a free cluster */
104 u_int pm_fatmult; /* these 2 values are used in FAT */
105 u_int pm_fatdiv; /* offset computation */
106 u_int pm_curfat; /* current FAT for FAT32 (0 otherwise) */
107 u_int *pm_inusemap; /* ptr to bitmap of in-use clusters */
108 uint64_t pm_flags; /* see below */
109 void *pm_u2w; /* Local->Unicode iconv handle */
110 void *pm_w2u; /* Unicode->Local iconv handle */
111 void *pm_u2d; /* Unicode->DOS iconv handle */
112 void *pm_d2u; /* DOS->Local iconv handle */
113 struct lock pm_fatlock; /* lockmgr protecting allocations */
117 * A 64-bit file number and the 32-bit file number to which it is mapped,
118 * in a red-black tree node.
120 struct msdosfs_fileno {
121 RB_ENTRY(msdosfs_fileno) mf_tree;
122 uint32_t mf_fileno32;
123 uint64_t mf_fileno64;
126 /* Byte offset in FAT on filesystem pmp, cluster cn */
127 #define FATOFS(pmp, cn) ((cn) * (pmp)->pm_fatmult / (pmp)->pm_fatdiv)
130 #define VFSTOMSDOSFS(mp) ((struct msdosfsmount *)mp->mnt_data)
132 /* Number of bits in one pm_inusemap item: */
133 #define N_INUSEBITS (8 * sizeof(u_int))
136 * Shorthand for fields in the bpb contained in the msdosfsmount structure.
138 #define pm_BytesPerSec pm_bpb.bpbBytesPerSec
139 #define pm_ResSectors pm_bpb.bpbResSectors
140 #define pm_FATs pm_bpb.bpbFATs
141 #define pm_RootDirEnts pm_bpb.bpbRootDirEnts
142 #define pm_Sectors pm_bpb.bpbSectors
143 #define pm_Media pm_bpb.bpbMedia
144 #define pm_SecPerTrack pm_bpb.bpbSecPerTrack
145 #define pm_Heads pm_bpb.bpbHeads
146 #define pm_HiddenSects pm_bpb.bpbHiddenSecs
147 #define pm_HugeSectors pm_bpb.bpbHugeSectors
150 * Convert pointer to buffer -> pointer to direntry
152 #define bptoep(pmp, bp, dirofs) \
153 ((struct direntry *)(((bp)->b_data) \
154 + ((dirofs) & (pmp)->pm_crbomask)))
157 * Convert block number to cluster number
159 #define de_bn2cn(pmp, bn) \
160 ((bn) >> ((pmp)->pm_cnshift - (pmp)->pm_bnshift))
163 * Convert cluster number to block number
165 #define de_cn2bn(pmp, cn) \
166 ((cn) << ((pmp)->pm_cnshift - (pmp)->pm_bnshift))
169 * Convert file offset to cluster number
171 #define de_cluster(pmp, off) \
172 ((off) >> (pmp)->pm_cnshift)
175 * Clusters required to hold size bytes
177 #define de_clcount(pmp, size) \
178 (((size) + (pmp)->pm_bpcluster - 1) >> (pmp)->pm_cnshift)
181 * Convert file offset to block number
183 #define de_blk(pmp, off) \
184 (de_cn2bn(pmp, de_cluster((pmp), (off))))
187 * Convert cluster number to file offset
189 #define de_cn2off(pmp, cn) \
190 ((cn) << (pmp)->pm_cnshift)
193 * Convert block number to file offset
195 #define de_bn2off(pmp, bn) \
196 ((bn) << (pmp)->pm_bnshift)
198 * Map a cluster number into a filesystem relative block number.
200 #define cntobn(pmp, cn) \
201 (de_cn2bn((pmp), (cn)-CLUST_FIRST) + (pmp)->pm_firstcluster)
204 * Calculate block number for directory entry in root dir, offset dirofs
206 #define roottobn(pmp, dirofs) \
207 (de_blk((pmp), (dirofs)) + (pmp)->pm_rootdirblk)
210 * Calculate block number for directory entry at cluster dirclu, offset
213 #define detobn(pmp, dirclu, dirofs) \
214 ((dirclu) == MSDOSFSROOT \
215 ? roottobn((pmp), (dirofs)) \
216 : cntobn((pmp), (dirclu)))
218 #define MSDOSFS_LOCK_MP(pmp) \
219 lockmgr(&(pmp)->pm_fatlock, LK_EXCLUSIVE, NULL)
220 #define MSDOSFS_UNLOCK_MP(pmp) \
221 lockmgr(&(pmp)->pm_fatlock, LK_RELEASE, NULL)
222 #define MSDOSFS_ASSERT_MP_LOCKED(pmp) \
223 lockmgr_assert(&(pmp)->pm_fatlock, KA_XLOCKED)
228 * Arguments to mount MSDOS filesystems.
230 struct msdosfs_args {
231 char *fspec; /* blocks special holding the fs to mount */
232 struct oexport_args export; /* network export information */
233 uid_t uid; /* uid that owns msdosfs files */
234 gid_t gid; /* gid that owns msdosfs files */
235 mode_t mask; /* file mask to be applied for msdosfs perms */
236 int flags; /* see below */
237 int unused1; /* unused, was version number */
238 uint16_t unused2[128]; /* no longer used, was Local->Unicode table */
239 char *cs_win; /* Windows(Unicode) Charset */
240 char *cs_dos; /* DOS Charset */
241 char *cs_local; /* Local Charset */
242 mode_t dirmask; /* dir mask to be applied for msdosfs perms */
246 * Msdosfs mount options:
248 #define MSDOSFSMNT_SHORTNAME 1 /* Force old DOS short names only */
249 #define MSDOSFSMNT_LONGNAME 2 /* Force Win'95 long names */
250 #define MSDOSFSMNT_NOWIN95 4 /* Completely ignore Win95 entries */
251 #define MSDOSFSMNT_KICONV 0x10 /* Use libiconv to convert chars */
252 /* All flags above: */
253 #define MSDOSFSMNT_MNTOPT \
254 (MSDOSFSMNT_SHORTNAME|MSDOSFSMNT_LONGNAME|MSDOSFSMNT_NOWIN95 \
256 #define MSDOSFSMNT_RONLY 0x80000000 /* mounted read-only */
257 #define MSDOSFSMNT_WAITONFAT 0x40000000 /* mounted synchronous */
258 #define MSDOSFS_FATMIRROR 0x20000000 /* FAT is mirrored */
259 #define MSDOSFS_FSIMOD 0x01000000
261 #endif /* !_MSDOSFS_MSDOSFSMOUNT_H_ */