1 /* $FreeBSD$ */ 2 /* $NetBSD: msdosfsmount.h,v 1.17 1997/11/17 15:37:07 ws Exp $ */ 3 4 /*- 5 * SPDX-License-Identifier: BSD-4-Clause 6 * 7 * Copyright (C) 1994, 1995, 1997 Wolfgang Solfrank. 8 * Copyright (C) 1994, 1995, 1997 TooLs GmbH. 9 * All rights reserved. 10 * Original code by Paul Popelka (paulp@uts.amdahl.com) (see below). 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 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. 25 * 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. 36 */ 37 /*- 38 * Written by Paul Popelka (paulp@uts.amdahl.com) 39 * 40 * You can do anything you want with this software, just don't say you wrote 41 * it, and don't remove this notice. 42 * 43 * This software is provided "as is". 44 * 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. 49 * 50 * October 1992 51 */ 52 53 #ifndef _MSDOSFS_MSDOSFSMOUNT_H_ 54 #define _MSDOSFS_MSDOSFSMOUNT_H_ 55 56 #ifdef _KERNEL 57 #include "opt_msdosfs.h" 58 #ifdef MALLOC_DECLARE 59 MALLOC_DECLARE(M_MSDOSFSMNT); 60 #endif 61 #endif 62 #include <sys/iconv.h> 63 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 64 65 #define msdosfs_iconv msdos_iconv 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 uid_t pm_uid; /* uid to set as owner of the files */ 73 gid_t pm_gid; /* gid to set as owner of the files */ 74 mode_t pm_mask; /* mask to and with file protection bits 75 for files */ 76 mode_t pm_dirmask; /* mask to and with file protection bits 77 for directories */ 78 struct vnode *pm_devvp; /* vnode for character device mounted */ 79 cdev_t pm_dev; /* character device mounted */ 80 struct bpb50 pm_bpb; /* BIOS parameter blk for this fs */ 81 u_long pm_BlkPerSec; /* How many DEV_BSIZE blocks fit inside a physical sector */ 82 u_long pm_FATsecs; /* actual number of FAT sectors */ 83 u_long pm_fatblk; /* block # of first FAT */ 84 u_long pm_rootdirblk; /* block # (cluster # for FAT32) of root directory number */ 85 u_long pm_rootdirsize; /* size in blocks (not clusters) */ 86 u_long pm_firstcluster; /* block number of first cluster */ 87 u_long pm_maxcluster; /* maximum cluster number */ 88 u_long pm_freeclustercount; /* number of free clusters */ 89 u_long pm_cnshift; /* shift file offset right this amount to get a cluster number */ 90 u_long pm_crbomask; /* and a file offset with this mask to get cluster rel offset */ 91 u_long pm_bnshift; /* shift file offset right this amount to get a block number */ 92 u_long pm_bpcluster; /* bytes per cluster */ 93 u_long pm_fmod; /* ~0 if fs is modified, this can rollover to 0 */ 94 u_long pm_fatblocksize; /* size of FAT blocks in bytes */ 95 u_long pm_fatblocksec; /* size of FAT blocks in sectors */ 96 uint32_t pm_fatmask; /* mask to use for FAT numbers */ 97 u_long pm_fsinfo; /* fsinfo block number */ 98 u_long pm_nxtfree; /* next place to search for a free cluster */ 99 u_int pm_fatmult; /* these 2 values are used in FAT */ 100 u_int pm_fatdiv; /* offset computation */ 101 u_int pm_curfat; /* current FAT for FAT32 (0 otherwise) */ 102 u_int *pm_inusemap; /* ptr to bitmap of in-use clusters */ 103 u_int pm_flags; /* see below */ 104 struct netexport pm_export; /* export information */ 105 void *pm_u2w; /* Local->Unicode iconv handle */ 106 void *pm_w2u; /* Unicode->Local iconv handle */ 107 void *pm_u2d; /* Unicode->DOS iconv handle */ 108 void *pm_d2u; /* DOS->Local iconv handle */ 109 }; 110 /* Byte offset in FAT on filesystem pmp, cluster cn */ 111 #define FATOFS(pmp, cn) ((cn) * (pmp)->pm_fatmult / (pmp)->pm_fatdiv) 112 113 114 #define VFSTOMSDOSFS(mp) ((struct msdosfsmount *)mp->mnt_data) 115 116 /* Number of bits in one pm_inusemap item: */ 117 #define N_INUSEBITS (8 * sizeof(u_int)) 118 119 /* 120 * Shorthand for fields in the bpb contained in the msdosfsmount structure. 121 */ 122 #define pm_BytesPerSec pm_bpb.bpbBytesPerSec 123 #define pm_ResSectors pm_bpb.bpbResSectors 124 #define pm_FATs pm_bpb.bpbFATs 125 #define pm_RootDirEnts pm_bpb.bpbRootDirEnts 126 #define pm_Sectors pm_bpb.bpbSectors 127 #define pm_Media pm_bpb.bpbMedia 128 #define pm_SecPerTrack pm_bpb.bpbSecPerTrack 129 #define pm_Heads pm_bpb.bpbHeads 130 #define pm_HiddenSects pm_bpb.bpbHiddenSecs 131 #define pm_HugeSectors pm_bpb.bpbHugeSectors 132 133 /* 134 * Convert pointer to buffer -> pointer to direntry 135 */ 136 #define bptoep(pmp, bp, dirofs) \ 137 ((struct direntry *)(((bp)->b_data) \ 138 + ((dirofs) & (pmp)->pm_crbomask))) 139 140 /* 141 * Convert block number to cluster number 142 */ 143 #define de_bn2cn(pmp, bn) \ 144 ((bn) >> ((pmp)->pm_cnshift - (pmp)->pm_bnshift)) 145 146 /* 147 * Convert cluster number to block number 148 */ 149 #define de_cn2bn(pmp, cn) \ 150 ((cn) << ((pmp)->pm_cnshift - (pmp)->pm_bnshift)) 151 152 /* 153 * Convert file 32 bit offset to cluster number 154 */ 155 #define de_cluster(pmp, off) \ 156 ((off) >> (pmp)->pm_cnshift) 157 158 /* 159 * Clusters required to hold size bytes 160 */ 161 #define de_clcount(pmp, size) \ 162 (((size) + (pmp)->pm_bpcluster - 1) >> (pmp)->pm_cnshift) 163 164 /* 165 * Convert file 32 bit offset to block number 166 */ 167 #define de_blk(pmp, off) \ 168 (de_cn2bn(pmp, de_cluster((pmp), (off)))) 169 170 /* 171 * Convert a logical cluster number to file offset. 172 */ 173 #define de_cn2off(pmp, cn) \ 174 ((cn) << (pmp)->pm_cnshift) 175 176 /* 177 * Convert a device block number to a file offset. 178 */ 179 #define de_bn2off(pmp, bn) \ 180 ((bn) << (pmp)->pm_bnshift) 181 182 /* 183 * Convert a device block number to a 64 bit offset, used for getblk(), 184 * bread(), etc. These are DragonFly specific macros. 185 */ 186 #define de_bn2doff(pmp, bn) \ 187 ((off_t)(bn) << (pmp)->pm_bnshift) 188 189 #define de_cn2doff(pmp, cn) \ 190 ((off_t)(cn) << (pmp)->pm_cnshift) 191 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 #define MSDOSFS_LOCK_MP(pmp) 214 #define MSDOSFS_UNLOCK_MP(pmp) 215 #define MSDOSFS_ASSERT_MP_LOCKED(pmp) 216 217 #endif /* _KERNEL || _KERNEL_STRUCTURES */ 218 219 /* 220 * Arguments to mount MSDOS filesystems. 221 */ 222 struct msdosfs_args { 223 char *fspec; /* blocks special holding the fs to mount */ 224 struct export_args export; /* network export information */ 225 uid_t uid; /* uid that owns msdosfs files */ 226 gid_t gid; /* gid that owns msdosfs files */ 227 mode_t mask; /* file mask to be applied for msdosfs perms */ 228 int flags; /* see below */ 229 char cs_local[ICONV_CSNMAXLEN]; 230 char cs_dos[ICONV_CSNMAXLEN]; 231 mode_t dirmask; /* dir mask to be applied for msdosfs perms */ 232 }; 233 234 /* 235 * Msdosfs mount options: 236 */ 237 #define MSDOSFSMNT_SHORTNAME 1 /* Force old DOS short names only */ 238 #define MSDOSFSMNT_LONGNAME 2 /* Force Win'95 long names */ 239 #define MSDOSFSMNT_NOWIN95 4 /* Completely ignore Win95 entries */ 240 #define MSDOSFSMNT_KICONV 0x10 /* Use libiconv to convert chars */ 241 /* All flags above: */ 242 #define MSDOSFSMNT_MNTOPT \ 243 (MSDOSFSMNT_SHORTNAME|MSDOSFSMNT_LONGNAME|MSDOSFSMNT_NOWIN95 \ 244 |MSDOSFSMNT_KICONV) 245 #define MSDOSFSMNT_RONLY 0x80000000 /* mounted read-only */ 246 #define MSDOSFSMNT_WAITONFAT 0x40000000 /* mounted synchronous */ 247 #define MSDOSFS_FATMIRROR 0x20000000 /* FAT is mirrored */ 248 #define MSDOSFS_FSIMOD 0x01000000 249 250 #define MSDOSFS_ARGSMAGIC 0xe4eff300 251 252 #ifdef MSDOSFS_DEBUG 253 #define mprintf(fmt, ...) kprintf(fmt, ## __VA_ARGS__) 254 #else 255 #define mprintf(fmt, ...) 256 #endif 257 258 #define ASSERT_VOP_ELOCKED(vp, str) KASSERT(vn_islocked(vp), (str)) 259 #define ASSERT_VOP_LOCKED(vp, str) KASSERT(vn_islocked(vp), (str)) 260 261 #define DOINGASYNC(vp) (((vp)->v_mount->mnt_kern_flag & MNT_ASYNC) != 0) 262 263 #endif /* !_MSDOSFS_MSDOSFSMOUNT_H_ */ 264