Home | History | Annotate | Line # | Download | only in msdosfs
msdosfsmount.h revision 1.13
      1 /*	$NetBSD: msdosfsmount.h,v 1.13 2007/03/04 06:03:00 christos Exp $	*/
      2 
      3 /*-
      4  * Copyright (C) 1994, 1995, 1997 Wolfgang Solfrank.
      5  * Copyright (C) 1994, 1995, 1997 TooLs GmbH.
      6  * All rights reserved.
      7  * Original code by Paul Popelka (paulp (at) uts.amdahl.com) (see below).
      8  *
      9  * Redistribution and use in source and binary forms, with or without
     10  * modification, are permitted provided that the following conditions
     11  * are met:
     12  * 1. Redistributions of source code must retain the above copyright
     13  *    notice, this list of conditions and the following disclaimer.
     14  * 2. Redistributions in binary form must reproduce the above copyright
     15  *    notice, this list of conditions and the following disclaimer in the
     16  *    documentation and/or other materials provided with the distribution.
     17  * 3. All advertising materials mentioning features or use of this software
     18  *    must display the following acknowledgement:
     19  *	This product includes software developed by TooLs GmbH.
     20  * 4. The name of TooLs GmbH may not be used to endorse or promote products
     21  *    derived from this software without specific prior written permission.
     22  *
     23  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
     24  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     25  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     26  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     27  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     28  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
     29  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
     30  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
     31  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
     32  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     33  */
     34 /*
     35  * Written by Paul Popelka (paulp (at) uts.amdahl.com)
     36  *
     37  * You can do anything you want with this software, just don't say you wrote
     38  * it, and don't remove this notice.
     39  *
     40  * This software is provided "as is".
     41  *
     42  * The author supplies this software to be publicly redistributed on the
     43  * understanding that the author is not responsible for the correct
     44  * functioning of this software in any circumstances and is not liable for
     45  * any damages caused by this software.
     46  *
     47  * October 1992
     48  */
     49 
     50 #ifndef _MSDOSFS_MSDOSFSMOUNT_H_
     51 #define _MSDOSFS_MSDOSFSMOUNT_H_
     52 
     53 /*
     54  *  Arguments to mount MSDOS filesystems.
     55  */
     56 struct msdosfs_args {
     57 	char	*fspec;		/* blocks special holding the fs to mount */
     58 	struct	export_args30 _pad1; /* compat with old userland tools */
     59 	uid_t	uid;		/* uid that owns msdosfs files */
     60 	gid_t	gid;		/* gid that owns msdosfs files */
     61 	mode_t  mask;		/* mask to be applied for msdosfs perms */
     62 	int	flags;		/* see below */
     63 
     64 	/* Following items added after versioning support */
     65 	int	version;	/* version of the struct */
     66 #define MSDOSFSMNT_VERSION	3
     67 	mode_t  dirmask;	/* v2: mask to be applied for msdosfs perms */
     68 	int	gmtoff;		/* v3: offset from UTC in seconds */
     69 };
     70 
     71 /*
     72  * Msdosfs mount options:
     73  */
     74 #define	MSDOSFSMNT_SHORTNAME	1	/* Force old DOS short names only */
     75 #define	MSDOSFSMNT_LONGNAME	2	/* Force Win'95 long names */
     76 #define	MSDOSFSMNT_NOWIN95	4	/* Completely ignore Win95 entries */
     77 #define	MSDOSFSMNT_GEMDOSFS	8	/* This is a gemdos-flavour */
     78 #define MSDOSFSMNT_VERSIONED	16	/* Struct is versioned */
     79 
     80 /* All flags above: */
     81 #define	MSDOSFSMNT_MNTOPT \
     82 	(MSDOSFSMNT_SHORTNAME|MSDOSFSMNT_LONGNAME|MSDOSFSMNT_NOWIN95 \
     83 	 |MSDOSFSMNT_GEMDOSFS|MSDOSFSMNT_VERSIONED)
     84 
     85 #define	MSDOSFSMNT_RONLY	0x80000000	/* mounted read-only	*/
     86 #define	MSDOSFSMNT_WAITONFAT	0x40000000	/* mounted synchronous	*/
     87 #define	MSDOSFS_FATMIRROR	0x20000000	/* FAT is mirrored */
     88 
     89 #define MSDOSFSMNT_BITS "\177\20" \
     90     "b\00shortname\0b\01longname\0b\02nowin95\0b\03gemdosfs\0b\04mntversioned\0" \
     91     "b\037ronly\0b\036waitonfat\0b\035fatmirror\0"
     92 
     93 #ifdef _KERNEL
     94 #include <sys/mallocvar.h>
     95 MALLOC_DECLARE(M_MSDOSFSMNT);
     96 
     97 /*
     98  * Layout of the mount control block for a msdos file system.
     99  */
    100 struct msdosfsmount {
    101 	struct mount *pm_mountp;/* vfs mount struct for this fs */
    102 	dev_t pm_dev;		/* block special device mounted */
    103 	uid_t pm_uid;		/* uid to set as owner of the files */
    104 	gid_t pm_gid;		/* gid to set as owner of the files */
    105 	mode_t pm_mask;		/* mask to and with file protection bits
    106 				   for files */
    107 	mode_t pm_dirmask;	/* mask to and with file protection bits
    108 				   for directories */
    109 	int pm_gmtoff;		/* offset from UTC in seconds */
    110 	struct vnode *pm_devvp;	/* vnode for block device mntd */
    111 	struct bpb50 pm_bpb;	/* BIOS parameter blk for this fs */
    112 	u_long pm_FATsecs;	/* actual number of fat sectors */
    113 	u_long pm_fatblk;	/* sector # of first FAT */
    114 	u_long pm_rootdirblk;	/* sector # (cluster # for FAT32) of root directory number */
    115 	u_long pm_rootdirsize;	/* size in sectors (not clusters) */
    116 	u_long pm_firstcluster;	/* sector number of first cluster */
    117 	u_long pm_nmbrofclusters;	/* # of clusters in filesystem */
    118 	u_long pm_maxcluster;	/* maximum cluster number */
    119 	u_long pm_freeclustercount;	/* number of free clusters */
    120 	u_long pm_cnshift;	/* shift file offset right this amount to get a cluster number */
    121 	u_long pm_crbomask;	/* and a file offset with this mask to get cluster rel offset */
    122 	u_long pm_bnshift;	/* shift file offset right this amount to get a sector number */
    123 	u_long pm_bpcluster;	/* bytes per cluster */
    124 	u_long pm_fmod;		/* ~0 if fs is modified, this can rollover to 0	*/
    125 	u_long pm_fatblocksize;	/* size of fat blocks in bytes */
    126 	u_long pm_fatblocksec;	/* size of fat blocks in sectors */
    127 	u_long pm_fatsize;	/* size of fat in bytes */
    128 	u_long pm_fatmask;	/* mask to use for fat numbers */
    129 	u_long pm_fsinfo;	/* fsinfo block number */
    130 	u_long pm_nxtfree;	/* next free cluster in fsinfo block */
    131 	u_int pm_fatmult;	/* these 2 values are used in fat */
    132 	u_int pm_fatdiv;	/*	offset computation */
    133 	u_int pm_curfat;	/* current fat for FAT32 (0 otherwise) */
    134 	u_int *pm_inusemap;	/* ptr to bitmap of in-use clusters */
    135 	u_int pm_flags;		/* see below */
    136 };
    137 /* Byte offset in FAT on filesystem pmp, cluster cn */
    138 #define	FATOFS(pmp, cn)	((cn) * (pmp)->pm_fatmult / (pmp)->pm_fatdiv)
    139 
    140 #define	VFSTOMSDOSFS(mp)	((struct msdosfsmount *)mp->mnt_data)
    141 
    142 /* Number of bits in one pm_inusemap item: */
    143 #define	N_INUSEBITS	(8 * sizeof(u_int))
    144 
    145 /*
    146  * Shorthand for fields in the bpb contained in the msdosfsmount structure.
    147  */
    148 #define	pm_BytesPerSec	pm_bpb.bpbBytesPerSec
    149 #define	pm_ResSectors	pm_bpb.bpbResSectors
    150 #define	pm_FATs		pm_bpb.bpbFATs
    151 #define	pm_RootDirEnts	pm_bpb.bpbRootDirEnts
    152 #define	pm_Sectors	pm_bpb.bpbSectors
    153 #define	pm_Media	pm_bpb.bpbMedia
    154 #define	pm_SecPerTrack	pm_bpb.bpbSecPerTrack
    155 #define	pm_Heads	pm_bpb.bpbHeads
    156 #define	pm_HiddenSects	pm_bpb.bpbHiddenSecs
    157 #define	pm_HugeSectors	pm_bpb.bpbHugeSectors
    158 
    159 /*
    160  * Convert pointer to buffer -> pointer to direntry
    161  */
    162 #define	bptoep(pmp, bp, dirofs) \
    163 	((struct direntry *)(((char *)(bp)->b_data)	\
    164 	 + ((dirofs) & (pmp)->pm_crbomask)))
    165 
    166 /*
    167  * Convert sector number to cluster number
    168  */
    169 #define	de_bn2cn(pmp, bn) \
    170 	((bn) >> ((pmp)->pm_cnshift - (pmp)->pm_bnshift))
    171 
    172 /*
    173  * Convert cluster number to sector number
    174  */
    175 #define	de_cn2bn(pmp, cn) \
    176 	((cn) << ((pmp)->pm_cnshift - (pmp)->pm_bnshift))
    177 
    178 /*
    179  * Convert sector number to kernel block number
    180  */
    181 #define de_bn2kb(pmp, bn) \
    182 	((bn) << ((pmp)->pm_bnshift - DEV_BSHIFT))
    183 
    184 /*
    185  * Convert kernel block number to sector number
    186  */
    187 #define de_kb2bn(pmp, kb) \
    188 	((kb) >> ((pmp)->pm_bnshift - DEV_BSHIFT))
    189 
    190 /*
    191  * Convert file offset to cluster number
    192  */
    193 #define de_cluster(pmp, off) \
    194 	((off) >> (pmp)->pm_cnshift)
    195 
    196 /*
    197  * Clusters required to hold size bytes
    198  */
    199 #define	de_clcount(pmp, size) \
    200 	(((size) + (pmp)->pm_bpcluster - 1) >> (pmp)->pm_cnshift)
    201 
    202 /*
    203  * Convert file offset to sector number
    204  */
    205 #define de_blk(pmp, off) \
    206 	(de_cn2bn(pmp, de_cluster((pmp), (off))))
    207 
    208 /*
    209  * Convert cluster number to file offset
    210  */
    211 #define	de_cn2off(pmp, cn) \
    212 	((cn) << (pmp)->pm_cnshift)
    213 
    214 /*
    215  * Convert sector number to file offset
    216  */
    217 #define	de_bn2off(pmp, bn) \
    218 	((bn) << (pmp)->pm_bnshift)
    219 /*
    220  * Map a cluster number into a filesystem relative sector number.
    221  */
    222 #define	cntobn(pmp, cn) \
    223 	(de_cn2bn((pmp), (cn)-CLUST_FIRST) + (pmp)->pm_firstcluster)
    224 
    225 /*
    226  * Calculate sector number for directory entry in root dir, offset dirofs
    227  */
    228 #define	roottobn(pmp, dirofs) \
    229 	(de_blk((pmp), (dirofs)) + (pmp)->pm_rootdirblk)
    230 
    231 /*
    232  * Calculate sector number for directory entry at cluster dirclu, offset
    233  * dirofs
    234  */
    235 #define	detobn(pmp, dirclu, dirofs) \
    236 	((dirclu) == MSDOSFSROOT \
    237 	 ? roottobn((pmp), (dirofs)) \
    238 	 : cntobn((pmp), (dirclu)))
    239 
    240 /*
    241  * Prototypes for MSDOSFS virtual filesystem operations
    242  */
    243 void msdosfs_init(void);
    244 void msdosfs_reinit(void);
    245 void msdosfs_done(void);
    246 
    247 #ifdef SYSCTL_SETUP_PROTO
    248 SYSCTL_SETUP_PROTO(sysctl_vfs_msdosfs_setup);
    249 #endif /* SYSCTL_SETUP_PROTO */
    250 #endif /* _KERNEL */
    251 #endif /* _MSDOSFS_MSDOSFSMOUNT_H_ */
    252