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