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