1 /* $FreeBSD: releng/6.0/sys/fs/msdosfs/msdosfsmount.h 143667 2005-03-15 20:57:25Z phk $ */
2 /* $NetBSD: msdosfsmount.h,v 1.17 1997/11/17 15:37:07 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 #ifndef _MSDOSFS_MSDOSFSMOUNT_H_
52 #define _MSDOSFS_MSDOSFSMOUNT_H_
53
54 #ifdef _KERNEL
55
56 #include <sys/tree.h>
57
58 #ifdef MALLOC_DECLARE
59 MALLOC_DECLARE(M_MSDOSFSMNT);
60 #endif
61
62 struct msdosfs_fileno;
63
64 /*
65 * Layout of the mount control block for a msdos filesystem.
66 */
67 struct msdosfsmount {
68 struct mount *pm_mountp;/* vfs mount struct for this fs */
69 struct g_consumer *pm_cp;
70 struct bufobj *pm_bo;
71 uid_t pm_uid; /* uid to set as owner of the files */
72 gid_t pm_gid; /* gid to set as owner of the files */
73 mode_t pm_mask; /* mask to and with file protection bits
74 for files */
75 mode_t pm_dirmask; /* mask to and with file protection bits
76 for directories */
77 struct vnode *pm_devvp; /* vnode for block device mntd */
78 struct bpb50 pm_bpb; /* BIOS parameter blk for this fs */
79 u_long pm_BlkPerSec; /* How many DEV_BSIZE blocks fit inside a physical sector */
80 u_long pm_FATsecs; /* actual number of fat sectors */
81 u_long pm_fatblk; /* block # of first FAT */
82 u_long pm_rootdirblk; /* block # (cluster # for FAT32) of root directory number */
83 u_long pm_rootdirsize; /* size in blocks (not clusters) */
84 u_long pm_firstcluster; /* block number of first cluster */
85 u_long pm_maxcluster; /* maximum cluster number */
86 u_long pm_freeclustercount; /* number of free clusters */
87 u_long pm_cnshift; /* shift file offset right this amount to get a cluster number */
88 u_long pm_crbomask; /* and a file offset with this mask to get cluster rel offset */
89 u_long pm_bnshift; /* shift file offset right this amount to get a block number */
90 u_long pm_bpcluster; /* bytes per cluster */
91 u_long pm_fmod; /* ~0 if fs is modified, this can rollover to 0 */
92 u_long pm_fatblocksize; /* size of fat blocks in bytes */
93 u_long pm_fatblocksec; /* size of fat blocks in sectors */
94 u_long pm_fatsize; /* size of fat in bytes */
95 u_int32_t pm_fatmask; /* mask to use for fat numbers */
96 u_long pm_fsinfo; /* fsinfo block number */
97 u_long pm_nxtfree; /* next free cluster in fsinfo block */
98 u_int pm_fatmult; /* these 2 values are used in fat */
99 u_int pm_fatdiv; /* offset computation */
100 u_int pm_curfat; /* current fat for FAT32 (0 otherwise) */
101 u_int *pm_inusemap; /* ptr to bitmap of in-use clusters */
102 u_int pm_flags; /* see below */
103 void *pm_u2w; /* Local->Unicode iconv handle */
104 void *pm_w2u; /* Unicode->Local iconv handle */
105 void *pm_u2d; /* Unicode->DOS iconv handle */
106 void *pm_d2u; /* DOS->Local iconv handle */
107 u_int32_t pm_nfileno; /* next 32-bit fileno */
108 RB_HEAD(msdosfs_filenotree, msdosfs_fileno) pm_filenos; /* 64<->32-bit fileno mapping */
109 };
110
111 /*
112 * A 64-bit file number and the 32-bit file number to which it is mapped,
113 * in a red-black tree node.
114 */
115 struct msdosfs_fileno {
116 RB_ENTRY(msdosfs_fileno) mf_tree;
117 uint32_t mf_fileno32;
118 uint64_t mf_fileno64;
119 };
120
121 /* Byte offset in FAT on filesystem pmp, cluster cn */
122 #define FATOFS(pmp, cn) ((cn) * (pmp)->pm_fatmult / (pmp)->pm_fatdiv)
123
124
125 #define VFSTOMSDOSFS(mp) ((struct msdosfsmount *)mp->mnt_data)
126
127 /* Number of bits in one pm_inusemap item: */
128 #define N_INUSEBITS (8 * sizeof(u_int))
129
130 /*
131 * Shorthand for fields in the bpb contained in the msdosfsmount structure.
132 */
133 #define pm_BytesPerSec pm_bpb.bpbBytesPerSec
134 #define pm_ResSectors pm_bpb.bpbResSectors
135 #define pm_FATs pm_bpb.bpbFATs
136 #define pm_RootDirEnts pm_bpb.bpbRootDirEnts
137 #define pm_Sectors pm_bpb.bpbSectors
138 #define pm_Media pm_bpb.bpbMedia
139 #define pm_SecPerTrack pm_bpb.bpbSecPerTrack
140 #define pm_Heads pm_bpb.bpbHeads
141 #define pm_HiddenSects pm_bpb.bpbHiddenSecs
142 #define pm_HugeSectors pm_bpb.bpbHugeSectors
143
144 /*
145 * Convert pointer to buffer -> pointer to direntry
146 */
147 #define bptoep(pmp, bp, dirofs) \
148 ((struct direntry *)(((bp)->b_data) \
149 + ((dirofs) & (pmp)->pm_crbomask)))
150
151 /*
152 * Convert block number to cluster number
153 */
154 #define de_bn2cn(pmp, bn) \
155 ((bn) >> ((pmp)->pm_cnshift - (pmp)->pm_bnshift))
156
157 /*
158 * Convert cluster number to block number
159 */
160 #define de_cn2bn(pmp, cn) \
161 ((cn) << ((pmp)->pm_cnshift - (pmp)->pm_bnshift))
162
163 /*
164 * Convert file offset to cluster number
165 */
166 #define de_cluster(pmp, off) \
167 ((off) >> (pmp)->pm_cnshift)
168
169 /*
170 * Clusters required to hold size bytes
171 */
172 #define de_clcount(pmp, size) \
173 (((size) + (pmp)->pm_bpcluster - 1) >> (pmp)->pm_cnshift)
174
175 /*
176 * Convert file offset to block number
177 */
178 #define de_blk(pmp, off) \
179 (de_cn2bn(pmp, de_cluster((pmp), (off))))
180
181 /*
182 * Convert cluster number to file offset
183 */
184 #define de_cn2off(pmp, cn) \
185 ((cn) << (pmp)->pm_cnshift)
186
187 /*
188 * Convert block number to file offset
189 */
190 #define de_bn2off(pmp, bn) \
191 ((bn) << (pmp)->pm_bnshift)
192 /*
193 * Map a cluster number into a filesystem relative block number.
194 */
195 #define cntobn(pmp, cn) \
196 (de_cn2bn((pmp), (cn)-CLUST_FIRST) + (pmp)->pm_firstcluster)
197
198 /*
199 * Calculate block number for directory entry in root dir, offset dirofs
200 */
201 #define roottobn(pmp, dirofs) \
202 (de_blk((pmp), (dirofs)) + (pmp)->pm_rootdirblk)
203
204 /*
205 * Calculate block number for directory entry at cluster dirclu, offset
206 * dirofs
207 */
208 #define detobn(pmp, dirclu, dirofs) \
209 ((dirclu) == MSDOSFSROOT \
210 ? roottobn((pmp), (dirofs)) \
211 : cntobn((pmp), (dirclu)))
212
213 /*
214 * Calculate fsinfo block size
215 */
216 #define fsi_size(pmp) \
217 (1024 << ((pmp)->pm_BlkPerSec >> 2))
218
219 void msdosfs_fileno_init(struct mount *);
220 void msdosfs_fileno_free(struct mount *);
221 uint32_t msdosfs_fileno_map(struct mount *, uint64_t);
222
223 #endif /* _KERNEL */
224
225 /*
226 * Arguments to mount MSDOS filesystems.
227 */
228 struct msdosfs_args {
229 char *fspec; /* blocks special holding the fs to mount */
230 struct export_args export; /* network export information */
231 uid_t uid; /* uid that owns msdosfs files */
232 gid_t gid; /* gid that owns msdosfs files */
233 mode_t mask; /* file mask to be applied for msdosfs perms */
234 int flags; /* see below */
235 int magic; /* version number */
236 u_int16_t u2w[128]; /* Local->Unicode table */
237 char *cs_win; /* Windows(Unicode) Charset */
238 char *cs_dos; /* DOS Charset */
239 char *cs_local; /* Local Charset */
240 mode_t dirmask; /* dir mask to be applied for msdosfs perms */
241 };
242
243 /*
244 * Msdosfs mount options:
245 */
246 #define MSDOSFSMNT_SHORTNAME 1 /* Force old DOS short names only */
247 #define MSDOSFSMNT_LONGNAME 2 /* Force Win'95 long names */
248 #define MSDOSFSMNT_NOWIN95 4 /* Completely ignore Win95 entries */
249 #define MSDOSFSMNT_KICONV 0x10 /* Use libiconv to convert chars */
250 /* All flags above: */
251 #define MSDOSFSMNT_MNTOPT \
252 (MSDOSFSMNT_SHORTNAME|MSDOSFSMNT_LONGNAME|MSDOSFSMNT_NOWIN95 \
253 |MSDOSFSMNT_KICONV)
254 #define MSDOSFSMNT_RONLY 0x80000000 /* mounted read-only */
255 #define MSDOSFSMNT_WAITONFAT 0x40000000 /* mounted synchronous */
256 #define MSDOSFS_FATMIRROR 0x20000000 /* FAT is mirrored */
257 #define MSDOSFS_LARGEFS 0x10000000 /* perform fileno mapping */
258
259 #define MSDOSFS_ARGSMAGIC 0xe4eff300
260
261 #endif /* !_MSDOSFS_MSDOSFSMOUNT_H_ */
Cache object: a7a3b18ac20add58b11030c0dad10a47
|