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 /* $DragonFly: src/sys/vfs/msdosfs/msdosfsmount.h,v 1.9 2007/08/08 00:23:40 swildner Exp $ */
   3 /*      $NetBSD: msdosfsmount.h,v 1.17 1997/11/17 15:37:07 ws Exp $     */
   4
   5 /*-
   6  * Copyright (C) 1994, 1995, 1997 Wolfgang Solfrank.
   7  * Copyright (C) 1994, 1995, 1997 TooLs GmbH.
   8  * All rights reserved.
   9  * Original code by Paul Popelka (paulp@uts.amdahl.com) (see below).
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *      This product includes software developed by TooLs GmbH.
  22  * 4. The name of TooLs GmbH may not be used to endorse or promote products
  23  *    derived from this software without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
  26  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  27  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  28  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  30  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  31  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  32  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  33  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  34  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35  */
  36 /*
  37  * Written by Paul Popelka (paulp@uts.amdahl.com)
  38  *
  39  * You can do anything you want with this software, just don't say you wrote
  40  * it, and don't remove this notice.
  41  *
  42  * This software is provided "as is".
  43  *
  44  * The author supplies this software to be publicly redistributed on the
  45  * understanding that the author is not responsible for the correct
  46  * functioning of this software in any circumstances and is not liable for
  47  * any damages caused by this software.
  48  *
  49  * October 1992
  50  */
  51
  52 #ifndef _MSDOSFS_MSDOSFSMOUNT_H_
  53 #define _MSDOSFS_MSDOSFSMOUNT_H_
  54
  55 #ifdef _KERNEL
  56 #include "opt_msdosfs.h"
  57 #ifdef MALLOC_DECLARE
  58 MALLOC_DECLARE(M_MSDOSFSMNT);
  59 #endif
  60 #endif
  61 #include <sys/iconv.h>
  62 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
  63 /*
  64  * Layout of the mount control block for a msdos file system.
  65  */
  66 struct msdosfsmount {
  67         struct mount *pm_mountp;/* vfs mount struct for this fs */
  68         cdev_t pm_dev;          /* block special device mounted */
  69         uid_t pm_uid;           /* uid to set as owner of the files */
  70         gid_t pm_gid;           /* gid to set as owner of the files */
  71         mode_t pm_mask;         /* mask to and with file protection bits */
  72         struct vnode *pm_devvp; /* vnode for block device mntd */
  73         struct bpb50 pm_bpb;    /* BIOS parameter blk for this fs */
  74         u_long pm_BlkPerSec;    /* How many DEV_BSIZE blocks fit inside a physical sector */
  75         u_long pm_FATsecs;      /* actual number of fat sectors */
  76         u_long pm_fatblk;       /* block # of first FAT */
  77         u_long pm_rootdirblk;   /* block # (cluster # for FAT32) of root directory number */
  78         u_long pm_rootdirsize;  /* size in blocks (not clusters) */
  79         u_long pm_firstcluster; /* block number of first cluster */
  80         u_long pm_maxcluster;   /* maximum cluster number */
  81         u_long pm_freeclustercount;     /* number of free clusters */
  82         u_long pm_cnshift;      /* shift file offset right this amount to get a cluster number */
  83         u_long pm_crbomask;     /* and a file offset with this mask to get cluster rel offset */
  84         u_long pm_bnshift;      /* shift file offset right this amount to get a block number */
  85         u_long pm_bpcluster;    /* bytes per cluster */
  86         u_long pm_fmod;         /* ~0 if fs is modified, this can rollover to 0 */
  87         u_long pm_fatblocksize; /* size of fat blocks in bytes */
  88         u_long pm_fatblocksec;  /* size of fat blocks in sectors */
  89         u_long pm_fatsize;      /* size of fat in bytes */
  90         u_int32_t pm_fatmask;   /* mask to use for fat numbers */
  91         u_long pm_fsinfo;       /* fsinfo block number */
  92         u_long pm_nxtfree;      /* next free cluster in fsinfo block */
  93         u_int pm_fatmult;       /* these 2 values are used in fat */
  94         u_int pm_fatdiv;        /*      offset computation */
  95         u_int pm_curfat;        /* current fat for FAT32 (0 otherwise) */
  96         u_int *pm_inusemap;     /* ptr to bitmap of in-use clusters */
  97         u_int pm_flags;         /* see below */
  98         struct netexport pm_export;     /* export information */
  99         void *pm_u2w;  /* Local->Unicode handle */
 100         void *pm_w2u;  /* Unicode->Local handle */
 101         void *pm_d2u;  /* DOS->local handle */
 102         void *pm_u2d;  /* Local->DOS handle */
 103 };
 104 /* Byte offset in FAT on filesystem pmp, cluster cn */
 105 #define FATOFS(pmp, cn) ((cn) * (pmp)->pm_fatmult / (pmp)->pm_fatdiv)
 106
 107
 108 #define VFSTOMSDOSFS(mp)        ((struct msdosfsmount *)mp->mnt_data)
 109
 110 /* Number of bits in one pm_inusemap item: */
 111 #define N_INUSEBITS     (8 * sizeof(u_int))
 112
 113 /*
 114  * Shorthand for fields in the bpb contained in the msdosfsmount structure.
 115  */
 116 #define pm_BytesPerSec  pm_bpb.bpbBytesPerSec
 117 #define pm_ResSectors   pm_bpb.bpbResSectors
 118 #define pm_FATs         pm_bpb.bpbFATs
 119 #define pm_RootDirEnts  pm_bpb.bpbRootDirEnts
 120 #define pm_Sectors      pm_bpb.bpbSectors
 121 #define pm_Media        pm_bpb.bpbMedia
 122 #define pm_SecPerTrack  pm_bpb.bpbSecPerTrack
 123 #define pm_Heads        pm_bpb.bpbHeads
 124 #define pm_HiddenSects  pm_bpb.bpbHiddenSecs
 125 #define pm_HugeSectors  pm_bpb.bpbHugeSectors
 126
 127 /*
 128  * Convert pointer to buffer -> pointer to direntry
 129  */
 130 #define bptoep(pmp, bp, dirofs) \
 131         ((struct direntry *)(((bp)->b_data)     \
 132          + ((dirofs) & (pmp)->pm_crbomask)))
 133
 134 /*
 135  * Convert block number to cluster number
 136  */
 137 #define de_bn2cn(pmp, bn) \
 138         ((bn) >> ((pmp)->pm_cnshift - (pmp)->pm_bnshift))
 139
 140 /*
 141  * Convert cluster number to block number
 142  */
 143 #define de_cn2bn(pmp, cn) \
 144         ((cn) << ((pmp)->pm_cnshift - (pmp)->pm_bnshift))
 145
 146 /*
 147  * Convert file 32 bit offset to cluster number
 148  */
 149 #define de_cluster(pmp, off) \
 150         ((off) >> (pmp)->pm_cnshift)
 151
 152 /*
 153  * Clusters required to hold size bytes
 154  */
 155 #define de_clcount(pmp, size) \
 156         (((size) + (pmp)->pm_bpcluster - 1) >> (pmp)->pm_cnshift)
 157
 158 /*
 159  * Convert file 32 bit offset to block number
 160  */
 161 #define de_blk(pmp, off) \
 162         (de_cn2bn(pmp, de_cluster((pmp), (off))))
 163
 164 /*
 165  * Convert a logical cluster number to file offset.  This typically
 166  * represents a logical cluster number relative to a file, not relative
 167  * to the device.
 168  */
 169 #define de_cn2off(pmp, cn) \
 170         ((cn) << (pmp)->pm_cnshift)
 171
 172 /*
 173  * Convert a device block number to a file offset.
 174  */
 175 #define de_bn2off(pmp, bn) \
 176         ((bn) << (pmp)->pm_bnshift)
 177
 178 /*
 179  * Convert a device block number to a 64 bit offset, used for getblk(),
 180  * bread(), etc.
 181  */
 182 #define de_bntodoff(pmp, bn) \
 183         ((off_t)(bn) << (pmp)->pm_bnshift)
 184
 185 #define de_cn2doff(pmp, cn) \
 186         ((off_t)(cn) << (pmp)->pm_cnshift)
 187
 188 #define de_off2bn(pmp, off) \
 189         ((daddr_t)((off) >> (pmp)->pm_bnshift))
 190
 191 #define de_off2cn(pmp, off) \
 192         ((daddr_t)((off) >> (pmp)->pm_cnshift))
 193
 194 /*
 195  * Map an on-disk cluster number into a device relative block number or
 196  * a device relative offset.   This is different from a logical cluster
 197  * number.  The cluster numbers stored on-disk are not relative to block 0
 198  * on the disk.
 199  */
 200 #define xcntodoff(pmp, cn) \
 201         de_bntodoff(pmp, xcntobn(pmp, cn))
 202
 203 #define xcntobn(pmp, cn) \
 204         (de_cn2bn((pmp), (cn)-CLUST_FIRST) + (pmp)->pm_firstcluster)
 205
 206
 207 /*
 208  * Calculate block number for directory entry in root dir, offset dirofs
 209  */
 210 #define roottobn(pmp, dirofs) \
 211         (de_blk((pmp), (dirofs)) + (pmp)->pm_rootdirblk)
 212
 213 /*
 214  * Calculate block number for directory entry at cluster dirclu, offset
 215  * dirofs
 216  */
 217 #define detobn(pmp, dirclu, dirofs) \
 218         ((dirclu) == MSDOSFSROOT \
 219          ? roottobn((pmp), (dirofs)) \
 220          : xcntobn((pmp), (dirclu)))
 221
 222 /*
 223  * Calculate fsinfo block size
 224  */
 225 #define fsi_size(pmp) \
 226         (1024 << ((pmp)->pm_BlkPerSec >> 2))
 227
 228 #endif /* _KERNEL || _KERNEL_STRUCTURES */
 229
 230 #ifdef _KERNEL
 231
 232 int msdosfs_init(struct vfsconf *vfsp);
 233 int msdosfs_uninit(struct vfsconf *vfsp);
 234 int msdosfs_mountroot(void);
 235
 236 #endif
 237
 238 /*
 239  *  Arguments to mount MSDOS filesystems.
 240  */
 241 struct msdosfs_args {
 242         char    *fspec;         /* blocks special holding the fs to mount */
 243         struct  export_args export;     /* network export information */
 244         uid_t   uid;            /* uid that owns msdosfs files */
 245         gid_t   gid;            /* gid that owns msdosfs files */
 246         mode_t  mask;           /* mask to be applied for msdosfs perms */
 247         int     flags;          /* see below */
 248         int magic;              /* version number */
 249         char cs_local[ICONV_CSNMAXLEN];
 250         char cs_dos[ICONV_CSNMAXLEN];
 251 };
 252
 253 /*
 254  * Msdosfs mount options:
 255  */
 256 #define MSDOSFSMNT_SHORTNAME    1       /* Force old DOS short names only */
 257 #define MSDOSFSMNT_LONGNAME     2       /* Force Win'95 long names */
 258 #define MSDOSFSMNT_NOWIN95      4       /* Completely ignore Win95 entries */
 259 #define MSDOSFSMNT_KICONV     0x10    /* Local->Unicode and local<->DOS   */
 260                                         /* tables loaded                    */
 261 /* All flags above: */
 262 #define MSDOSFSMNT_MNTOPT \
 263         (MSDOSFSMNT_SHORTNAME|MSDOSFSMNT_LONGNAME|MSDOSFSMNT_NOWIN95 \
 264          /*|MSDOSFSMNT_GEMDOSFS*/|MSDOSFSMNT_KICONV)
 265 #define MSDOSFSMNT_RONLY        0x80000000      /* mounted read-only    */
 266 #define MSDOSFSMNT_WAITONFAT    0x40000000      /* mounted synchronous  */
 267 #define MSDOSFS_FATMIRROR       0x20000000      /* FAT is mirrored */
 268
 269 #define MSDOSFS_ARGSMAGIC       0xe4eff300
 270
 271 #ifdef MSDOSFS_DEBUG
 272 #define mprintf(fmt, ...)       kprintf(fmt, ## __VA_ARGS__)
 273 #else
 274 #define mprintf(fmt, ...)
 275 #endif
 276
 277 #endif /* !_MSDOSFS_MSDOSFSMOUNT_H_ */