1 /* $FreeBSD$ */ 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/types.h> 57 #include <sys/lock.h> 58 #include <sys/lockmgr.h> 59 #include <sys/tree.h> 60 61 #ifdef MALLOC_DECLARE 62 MALLOC_DECLARE(M_MSDOSFSMNT); 63 #endif 64 65 struct msdosfs_fileno; 66 67 /* 68 * Layout of the mount control block for a MSDOSFS filesystem. 69 */ 70 struct msdosfsmount { 71 struct mount *pm_mountp;/* vfs mount struct for this fs */ 72 struct g_consumer *pm_cp; 73 struct bufobj *pm_bo; 74 uid_t pm_uid; /* uid to set as owner of the files */ 75 gid_t pm_gid; /* gid to set as owner of the files */ 76 mode_t pm_mask; /* mask to and with file protection bits 77 for files */ 78 mode_t pm_dirmask; /* mask to and with file protection bits 79 for directories */ 80 struct vnode *pm_devvp; /* vnode for character device mounted */ 81 struct cdev *pm_dev; /* character device mounted */ 82 struct bpb50 pm_bpb; /* BIOS parameter blk for this fs */ 83 u_long pm_BlkPerSec; /* How many DEV_BSIZE blocks fit inside a physical sector */ 84 u_long pm_FATsecs; /* actual number of FAT sectors */ 85 u_long pm_fatblk; /* block # of first FAT */ 86 u_long pm_rootdirblk; /* block # (cluster # for FAT32) of root directory number */ 87 u_long pm_rootdirsize; /* size in blocks (not clusters) */ 88 u_long pm_firstcluster; /* block number of first cluster */ 89 u_long pm_maxcluster; /* maximum cluster number */ 90 u_long pm_freeclustercount; /* number of free clusters */ 91 u_long pm_cnshift; /* shift file offset right this amount to get a cluster number */ 92 u_long pm_crbomask; /* and a file offset with this mask to get cluster rel offset */ 93 u_long pm_bnshift; /* shift file offset right this amount to get a block number */ 94 u_long pm_bpcluster; /* bytes per cluster */ 95 u_long pm_fmod; /* ~0 if fs is modified, this can rollover to 0 */ 96 u_long pm_fatblocksize; /* size of FAT blocks in bytes */ 97 u_long pm_fatblocksec; /* size of FAT blocks in sectors */ 98 u_long pm_fatsize; /* size of FAT in bytes */ 99 uint32_t pm_fatmask; /* mask to use for FAT numbers */ 100 u_long pm_fsinfo; /* fsinfo block number */ 101 u_long pm_nxtfree; /* next place to search for a free cluster */ 102 u_int pm_fatmult; /* these 2 values are used in FAT */ 103 u_int pm_fatdiv; /* offset computation */ 104 u_int pm_curfat; /* current FAT for FAT32 (0 otherwise) */ 105 u_int *pm_inusemap; /* ptr to bitmap of in-use clusters */ 106 uint64_t pm_flags; /* see below */ 107 void *pm_u2w; /* Local->Unicode iconv handle */ 108 void *pm_w2u; /* Unicode->Local iconv handle */ 109 void *pm_u2d; /* Unicode->DOS iconv handle */ 110 void *pm_d2u; /* DOS->Local iconv handle */ 111 struct lock pm_fatlock; /* lockmgr protecting allocations */ 112 }; 113 114 /* 115 * A 64-bit file number and the 32-bit file number to which it is mapped, 116 * in a red-black tree node. 117 */ 118 struct msdosfs_fileno { 119 RB_ENTRY(msdosfs_fileno) mf_tree; 120 uint32_t mf_fileno32; 121 uint64_t mf_fileno64; 122 }; 123 124 /* Byte offset in FAT on filesystem pmp, cluster cn */ 125 #define FATOFS(pmp, cn) ((cn) * (pmp)->pm_fatmult / (pmp)->pm_fatdiv) 126 127 128 #define VFSTOMSDOSFS(mp) ((struct msdosfsmount *)mp->mnt_data) 129 130 /* Number of bits in one pm_inusemap item: */ 131 #define N_INUSEBITS (8 * sizeof(u_int)) 132 133 /* 134 * Shorthand for fields in the bpb contained in the msdosfsmount structure. 135 */ 136 #define pm_BytesPerSec pm_bpb.bpbBytesPerSec 137 #define pm_ResSectors pm_bpb.bpbResSectors 138 #define pm_FATs pm_bpb.bpbFATs 139 #define pm_RootDirEnts pm_bpb.bpbRootDirEnts 140 #define pm_Sectors pm_bpb.bpbSectors 141 #define pm_Media pm_bpb.bpbMedia 142 #define pm_SecPerTrack pm_bpb.bpbSecPerTrack 143 #define pm_Heads pm_bpb.bpbHeads 144 #define pm_HiddenSects pm_bpb.bpbHiddenSecs 145 #define pm_HugeSectors pm_bpb.bpbHugeSectors 146 147 /* 148 * Convert pointer to buffer -> pointer to direntry 149 */ 150 #define bptoep(pmp, bp, dirofs) \ 151 ((struct direntry *)(((bp)->b_data) \ 152 + ((dirofs) & (pmp)->pm_crbomask))) 153 154 /* 155 * Convert block number to cluster number 156 */ 157 #define de_bn2cn(pmp, bn) \ 158 ((bn) >> ((pmp)->pm_cnshift - (pmp)->pm_bnshift)) 159 160 /* 161 * Convert cluster number to block number 162 */ 163 #define de_cn2bn(pmp, cn) \ 164 ((cn) << ((pmp)->pm_cnshift - (pmp)->pm_bnshift)) 165 166 /* 167 * Convert file offset to cluster number 168 */ 169 #define de_cluster(pmp, off) \ 170 ((off) >> (pmp)->pm_cnshift) 171 172 /* 173 * Clusters required to hold size bytes 174 */ 175 #define de_clcount(pmp, size) \ 176 (((size) + (pmp)->pm_bpcluster - 1) >> (pmp)->pm_cnshift) 177 178 /* 179 * Convert file offset to block number 180 */ 181 #define de_blk(pmp, off) \ 182 (de_cn2bn(pmp, de_cluster((pmp), (off)))) 183 184 /* 185 * Convert cluster number to file offset 186 */ 187 #define de_cn2off(pmp, cn) \ 188 ((cn) << (pmp)->pm_cnshift) 189 190 /* 191 * Convert block number to file offset 192 */ 193 #define de_bn2off(pmp, bn) \ 194 ((bn) << (pmp)->pm_bnshift) 195 /* 196 * Map a cluster number into a filesystem relative block number. 197 */ 198 #define cntobn(pmp, cn) \ 199 (de_cn2bn((pmp), (cn)-CLUST_FIRST) + (pmp)->pm_firstcluster) 200 201 /* 202 * Calculate block number for directory entry in root dir, offset dirofs 203 */ 204 #define roottobn(pmp, dirofs) \ 205 (de_blk((pmp), (dirofs)) + (pmp)->pm_rootdirblk) 206 207 /* 208 * Calculate block number for directory entry at cluster dirclu, offset 209 * dirofs 210 */ 211 #define detobn(pmp, dirclu, dirofs) \ 212 ((dirclu) == MSDOSFSROOT \ 213 ? roottobn((pmp), (dirofs)) \ 214 : cntobn((pmp), (dirclu))) 215 216 #define MSDOSFS_LOCK_MP(pmp) \ 217 lockmgr(&(pmp)->pm_fatlock, LK_EXCLUSIVE, NULL) 218 #define MSDOSFS_UNLOCK_MP(pmp) \ 219 lockmgr(&(pmp)->pm_fatlock, LK_RELEASE, NULL) 220 #define MSDOSFS_ASSERT_MP_LOCKED(pmp) \ 221 lockmgr_assert(&(pmp)->pm_fatlock, KA_XLOCKED) 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 oexport_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 unused1; /* unused, was version number */ 236 uint16_t unused2[128]; /* no longer used, was 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_FSIMOD 0x01000000 258 259 #endif /* !_MSDOSFS_MSDOSFSMOUNT_H_ */ 260