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 /* 66 * Layout of the mount control block for a MSDOSFS filesystem. 67 */ 68 struct msdosfsmount { 69 struct mount *pm_mountp;/* vfs mount struct for this fs */ 70 uid_t pm_uid; /* uid to set as owner of the files */ 71 gid_t pm_gid; /* gid to set as owner of the files */ 72 mode_t pm_mask; /* mask to and with file protection bits 73 for files */ 74 mode_t pm_dirmask; /* mask to and with file protection bits 75 for directories */ 76 struct vnode *pm_devvp; /* vnode for character device mounted */ 77 cdev_t pm_dev; /* character device mounted */ 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 uint32_t pm_fatmask; /* mask to use for FAT numbers */ 95 u_long pm_fsinfo; /* fsinfo block number */ 96 u_long pm_nxtfree; /* next place to search for a free cluster */ 97 u_int pm_fatmult; /* these 2 values are used in FAT */ 98 u_int pm_fatdiv; /* offset computation */ 99 u_int pm_curfat; /* current FAT for FAT32 (0 otherwise) */ 100 u_int *pm_inusemap; /* ptr to bitmap of in-use clusters */ 101 u_int pm_flags; /* see below */ 102 struct netexport pm_export; /* export information */ 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 }; 108 /* Byte offset in FAT on filesystem pmp, cluster cn */ 109 #define FATOFS(pmp, cn) ((cn) * (pmp)->pm_fatmult / (pmp)->pm_fatdiv) 110 111 112 #define VFSTOMSDOSFS(mp) ((struct msdosfsmount *)mp->mnt_data) 113 114 /* Number of bits in one pm_inusemap item: */ 115 #define N_INUSEBITS (8 * sizeof(u_int)) 116 117 /* 118 * Shorthand for fields in the bpb contained in the msdosfsmount structure. 119 */ 120 #define pm_BytesPerSec pm_bpb.bpbBytesPerSec 121 #define pm_ResSectors pm_bpb.bpbResSectors 122 #define pm_FATs pm_bpb.bpbFATs 123 #define pm_RootDirEnts pm_bpb.bpbRootDirEnts 124 #define pm_Sectors pm_bpb.bpbSectors 125 #define pm_Media pm_bpb.bpbMedia 126 #define pm_SecPerTrack pm_bpb.bpbSecPerTrack 127 #define pm_Heads pm_bpb.bpbHeads 128 #define pm_HiddenSects pm_bpb.bpbHiddenSecs 129 #define pm_HugeSectors pm_bpb.bpbHugeSectors 130 131 /* 132 * Convert pointer to buffer -> pointer to direntry 133 */ 134 #define bptoep(pmp, bp, dirofs) \ 135 ((struct direntry *)(((bp)->b_data) \ 136 + ((dirofs) & (pmp)->pm_crbomask))) 137 138 /* 139 * Convert block number to cluster number 140 */ 141 #define de_bn2cn(pmp, bn) \ 142 ((bn) >> ((pmp)->pm_cnshift - (pmp)->pm_bnshift)) 143 144 /* 145 * Convert cluster number to block number 146 */ 147 #define de_cn2bn(pmp, cn) \ 148 ((cn) << ((pmp)->pm_cnshift - (pmp)->pm_bnshift)) 149 150 /* 151 * Convert file 32 bit offset to cluster number 152 */ 153 #define de_cluster(pmp, off) \ 154 ((off) >> (pmp)->pm_cnshift) 155 156 /* 157 * Clusters required to hold size bytes 158 */ 159 #define de_clcount(pmp, size) \ 160 (((size) + (pmp)->pm_bpcluster - 1) >> (pmp)->pm_cnshift) 161 162 /* 163 * Convert file 32 bit offset to block number 164 */ 165 #define de_blk(pmp, off) \ 166 (de_cn2bn(pmp, de_cluster((pmp), (off)))) 167 168 /* 169 * Convert a logical cluster number to file offset. This typically 170 * represents a logical cluster number relative to a file, not relative 171 * to the device. 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. 185 */ 186 #define de_bntodoff(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 #define de_off2bn(pmp, off) \ 193 ((daddr_t)((off) >> (pmp)->pm_bnshift)) 194 195 #define de_off2cn(pmp, off) \ 196 ((daddr_t)((off) >> (pmp)->pm_cnshift)) 197 198 /* 199 * Map an on-disk cluster number into a device relative block number or 200 * a device relative offset. This is different from a logical cluster 201 * number. The cluster numbers stored on-disk are not relative to block 0 202 * on the disk. 203 */ 204 #define xcntodoff(pmp, cn) \ 205 de_bntodoff(pmp, xcntobn(pmp, cn)) 206 207 #define xcntobn(pmp, cn) \ 208 (de_cn2bn((pmp), (cn)-CLUST_FIRST) + (pmp)->pm_firstcluster) 209 210 /* 211 * Calculate block number for directory entry in root dir, offset dirofs 212 */ 213 #define roottobn(pmp, dirofs) \ 214 (de_blk((pmp), (dirofs)) + (pmp)->pm_rootdirblk) 215 216 /* 217 * Calculate block number for directory entry at cluster dirclu, offset 218 * dirofs 219 */ 220 #define detobn(pmp, dirclu, dirofs) \ 221 ((dirclu) == MSDOSFSROOT \ 222 ? roottobn((pmp), (dirofs)) \ 223 : xcntobn((pmp), (dirclu))) 224 225 /* 226 * Calculate fsinfo block size 227 */ 228 #define fsi_size(pmp) \ 229 (1024 << ((pmp)->pm_BlkPerSec >> 2)) 230 231 #endif /* _KERNEL || _KERNEL_STRUCTURES */ 232 233 #ifdef _KERNEL 234 235 int msdosfs_init(struct vfsconf *vfsp); 236 int msdosfs_uninit(struct vfsconf *vfsp); 237 int msdosfs_mountroot(void); 238 239 #endif 240 241 /* 242 * Arguments to mount MSDOS filesystems. 243 */ 244 struct msdosfs_args { 245 char *fspec; /* blocks special holding the fs to mount */ 246 struct export_args export; /* network export information */ 247 uid_t uid; /* uid that owns msdosfs files */ 248 gid_t gid; /* gid that owns msdosfs files */ 249 mode_t mask; /* file mask to be applied for msdosfs perms */ 250 mode_t dirmask; /* dir mask to be applied for msdosfs perms */ 251 int flags; /* see below */ 252 int magic; /* version number */ 253 char cs_local[ICONV_CSNMAXLEN]; 254 char cs_dos[ICONV_CSNMAXLEN]; 255 }; 256 257 /* 258 * Msdosfs mount options: 259 */ 260 #define MSDOSFSMNT_SHORTNAME 1 /* Force old DOS short names only */ 261 #define MSDOSFSMNT_LONGNAME 2 /* Force Win'95 long names */ 262 #define MSDOSFSMNT_NOWIN95 4 /* Completely ignore Win95 entries */ 263 #define MSDOSFSMNT_KICONV 0x10 /* Use libiconv to convert chars */ 264 /* All flags above: */ 265 #define MSDOSFSMNT_MNTOPT \ 266 (MSDOSFSMNT_SHORTNAME|MSDOSFSMNT_LONGNAME|MSDOSFSMNT_NOWIN95 \ 267 |MSDOSFSMNT_KICONV) 268 #define MSDOSFSMNT_RONLY 0x80000000 /* mounted read-only */ 269 #define MSDOSFSMNT_WAITONFAT 0x40000000 /* mounted synchronous */ 270 #define MSDOSFS_FATMIRROR 0x20000000 /* FAT is mirrored */ 271 272 #define MSDOSFS_ARGSMAGIC 0xe4eff300 273 274 #ifdef MSDOSFS_DEBUG 275 #define mprintf(fmt, ...) kprintf(fmt, ## __VA_ARGS__) 276 #else 277 #define mprintf(fmt, ...) 278 #endif 279 280 #endif /* !_MSDOSFS_MSDOSFSMOUNT_H_ */ 281