sys/vfs/msdosfs/msdosfsmount.h

   1 /* $FreeBSD: src/sys/msdosfs/msdosfsmount.h,v 1.20.2.2 2000/10/27 09:45:07 bde Exp $ */
   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 #ifdef MALLOC_DECLARE
  57 MALLOC_DECLARE(M_MSDOSFSMNT);
  58 #endif
  59
  60 /*
  61  * Layout of the mount control block for a msdos file system.
  62  */
  63 struct msdosfsmount {
  64         struct mount *pm_mountp;/* vfs mount struct for this fs */
  65         dev_t pm_dev;           /* block special device mounted */
  66         uid_t pm_uid;           /* uid to set as owner of the files */
  67         gid_t pm_gid;           /* gid to set as owner of the files */
  68         mode_t pm_mask;         /* mask to and with file protection bits */
  69         struct vnode *pm_devvp; /* vnode for block device mntd */
  70         struct bpb50 pm_bpb;    /* BIOS parameter blk for this fs */
  71         u_long pm_BlkPerSec;    /* How many DEV_BSIZE blocks fit inside a physical sector */
  72         u_long pm_FATsecs;      /* actual number of fat sectors */
  73         u_long pm_fatblk;       /* block # of first FAT */
  74         u_long pm_rootdirblk;   /* block # (cluster # for FAT32) of root directory number */
  75         u_long pm_rootdirsize;  /* size in blocks (not clusters) */
  76         u_long pm_firstcluster; /* block number of first cluster */
  77         u_long pm_maxcluster;   /* maximum cluster number */
  78         u_long pm_freeclustercount;     /* number of free clusters */
  79         u_long pm_cnshift;      /* shift file offset right this amount to get a cluster number */
  80         u_long pm_crbomask;     /* and a file offset with this mask to get cluster rel offset */
  81         u_long pm_bnshift;      /* shift file offset right this amount to get a block number */
  82         u_long pm_bpcluster;    /* bytes per cluster */
  83         u_long pm_fmod;         /* ~0 if fs is modified, this can rollover to 0 */
  84         u_long pm_fatblocksize; /* size of fat blocks in bytes */
  85         u_long pm_fatblocksec;  /* size of fat blocks in sectors */
  86         u_long pm_fatsize;      /* size of fat in bytes */
  87         u_int32_t pm_fatmask;   /* mask to use for fat numbers */
  88         u_long pm_fsinfo;       /* fsinfo block number */
  89         u_long pm_nxtfree;      /* next free cluster in fsinfo block */
  90         u_int pm_fatmult;       /* these 2 values are used in fat */
  91         u_int pm_fatdiv;        /*      offset computation */
  92         u_int pm_curfat;        /* current fat for FAT32 (0 otherwise) */
  93         u_int *pm_inusemap;     /* ptr to bitmap of in-use clusters */
  94         u_int pm_flags;         /* see below */
  95         struct netexport pm_export;     /* export information */
  96         u_int16_t pm_u2w[128];  /* Local->Unicode table */
  97         u_int8_t  pm_ul[128];   /* Local upper->lower table */
  98         u_int8_t  pm_lu[128];   /* Local lower->upper table */
  99         u_int8_t  pm_d2u[128];  /* DOS->local table */
 100         u_int8_t  pm_u2d[128];  /* Local->DOS table */
 101 };
 102 /* Byte offset in FAT on filesystem pmp, cluster cn */
 103 #define FATOFS(pmp, cn) ((cn) * (pmp)->pm_fatmult / (pmp)->pm_fatdiv)
 104
 105
 106 #define VFSTOMSDOSFS(mp)        ((struct msdosfsmount *)mp->mnt_data)
 107
 108 /* Number of bits in one pm_inusemap item: */
 109 #define N_INUSEBITS     (8 * sizeof(u_int))
 110
 111 /*
 112  * Shorthand for fields in the bpb contained in the msdosfsmount structure.
 113  */
 114 #define pm_BytesPerSec  pm_bpb.bpbBytesPerSec
 115 #define pm_ResSectors   pm_bpb.bpbResSectors
 116 #define pm_FATs         pm_bpb.bpbFATs
 117 #define pm_RootDirEnts  pm_bpb.bpbRootDirEnts
 118 #define pm_Sectors      pm_bpb.bpbSectors
 119 #define pm_Media        pm_bpb.bpbMedia
 120 #define pm_SecPerTrack  pm_bpb.bpbSecPerTrack
 121 #define pm_Heads        pm_bpb.bpbHeads
 122 #define pm_HiddenSects  pm_bpb.bpbHiddenSecs
 123 #define pm_HugeSectors  pm_bpb.bpbHugeSectors
 124
 125 /*
 126  * Convert pointer to buffer -> pointer to direntry
 127  */
 128 #define bptoep(pmp, bp, dirofs) \
 129         ((struct direntry *)(((bp)->b_data)     \
 130          + ((dirofs) & (pmp)->pm_crbomask)))
 131
 132 /*
 133  * Convert block number to cluster number
 134  */
 135 #define de_bn2cn(pmp, bn) \
 136         ((bn) >> ((pmp)->pm_cnshift - (pmp)->pm_bnshift))
 137
 138 /*
 139  * Convert cluster number to block number
 140  */
 141 #define de_cn2bn(pmp, cn) \
 142         ((cn) << ((pmp)->pm_cnshift - (pmp)->pm_bnshift))
 143
 144 /*
 145  * Convert file offset to cluster number
 146  */
 147 #define de_cluster(pmp, off) \
 148         ((off) >> (pmp)->pm_cnshift)
 149
 150 /*
 151  * Clusters required to hold size bytes
 152  */
 153 #define de_clcount(pmp, size) \
 154         (((size) + (pmp)->pm_bpcluster - 1) >> (pmp)->pm_cnshift)
 155
 156 /*
 157  * Convert file offset to block number
 158  */
 159 #define de_blk(pmp, off) \
 160         (de_cn2bn(pmp, de_cluster((pmp), (off))))
 161
 162 /*
 163  * Convert cluster number to file offset
 164  */
 165 #define de_cn2off(pmp, cn) \
 166         ((cn) << (pmp)->pm_cnshift)
 167
 168 /*
 169  * Convert block number to file offset
 170  */
 171 #define de_bn2off(pmp, bn) \
 172         ((bn) << (pmp)->pm_bnshift)
 173 /*
 174  * Map a cluster number into a filesystem relative block number.
 175  */
 176 #define cntobn(pmp, cn) \
 177         (de_cn2bn((pmp), (cn)-CLUST_FIRST) + (pmp)->pm_firstcluster)
 178
 179 /*
 180  * Calculate block number for directory entry in root dir, offset dirofs
 181  */
 182 #define roottobn(pmp, dirofs) \
 183         (de_blk((pmp), (dirofs)) + (pmp)->pm_rootdirblk)
 184
 185 /*
 186  * Calculate block number for directory entry at cluster dirclu, offset
 187  * dirofs
 188  */
 189 #define detobn(pmp, dirclu, dirofs) \
 190         ((dirclu) == MSDOSFSROOT \
 191          ? roottobn((pmp), (dirofs)) \
 192          : cntobn((pmp), (dirclu)))
 193
 194 /*
 195  * Calculate fsinfo block size
 196  */
 197 #define fsi_size(pmp) \
 198         (1024 << ((pmp)->pm_BlkPerSec >> 2))
 199
 200 int msdosfs_init __P((struct vfsconf *vfsp));
 201 int msdosfs_uninit __P((struct vfsconf *vfsp));
 202 int msdosfs_mountroot __P((void));
 203
 204 #endif /* _KERNEL */
 205
 206 /*
 207  *  Arguments to mount MSDOS filesystems.
 208  */
 209 struct msdosfs_args {
 210         char    *fspec;         /* blocks special holding the fs to mount */
 211         struct  export_args export;     /* network export information */
 212         uid_t   uid;            /* uid that owns msdosfs files */
 213         gid_t   gid;            /* gid that owns msdosfs files */
 214         mode_t  mask;           /* mask to be applied for msdosfs perms */
 215         int     flags;          /* see below */
 216         int magic;              /* version number */
 217         u_int16_t u2w[128];     /* Local->Unicode table */
 218         u_int8_t  ul[128];      /* Local upper->lower table */
 219         u_int8_t  lu[128];      /* Local lower->upper table */
 220         u_int8_t  d2u[128];     /* DOS->local table */
 221         u_int8_t  u2d[128];     /* Local->DOS table */
 222 };
 223
 224 /*
 225  * Msdosfs mount options:
 226  */
 227 #define MSDOSFSMNT_SHORTNAME    1       /* Force old DOS short names only */
 228 #define MSDOSFSMNT_LONGNAME     2       /* Force Win'95 long names */
 229 #define MSDOSFSMNT_NOWIN95      4       /* Completely ignore Win95 entries */
 230 #ifndef __FreeBSD__
 231 #define MSDOSFSMNT_GEMDOSFS     8       /* This is a gemdos-flavour */
 232 #endif
 233 #define MSDOSFSMNT_U2WTABLE     0x10    /* Local->Unicode and local<->DOS   */
 234                                         /* tables loaded                    */
 235 #define MSDOSFSMNT_ULTABLE      0x20    /* Local upper<->lower table loaded */
 236 /* All flags above: */
 237 #define MSDOSFSMNT_MNTOPT \
 238         (MSDOSFSMNT_SHORTNAME|MSDOSFSMNT_LONGNAME|MSDOSFSMNT_NOWIN95 \
 239          /*|MSDOSFSMNT_GEMDOSFS*/|MSDOSFSMNT_U2WTABLE|MSDOSFSMNT_ULTABLE)
 240 #define MSDOSFSMNT_RONLY        0x80000000      /* mounted read-only    */
 241 #define MSDOSFSMNT_WAITONFAT    0x40000000      /* mounted synchronous  */
 242 #define MSDOSFS_FATMIRROR       0x20000000      /* FAT is mirrored */
 243
 244 #define MSDOSFS_ARGSMAGIC       0xe4eff300
 245
 246 #endif /* !_MSDOSFS_MSDOSFSMOUNT_H_ */