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