root/sys/vfs/msdosfs/msdosfsmount.h
/* $FreeBSD$ */
/*      $NetBSD: msdosfsmount.h,v 1.17 1997/11/17 15:37:07 ws Exp $     */

/*-
 * SPDX-License-Identifier: BSD-4-Clause
 *
 * Copyright (C) 1994, 1995, 1997 Wolfgang Solfrank.
 * Copyright (C) 1994, 1995, 1997 TooLs GmbH.
 * All rights reserved.
 * Original code by Paul Popelka (paulp@uts.amdahl.com) (see below).
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by TooLs GmbH.
 * 4. The name of TooLs GmbH may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/*-
 * Written by Paul Popelka (paulp@uts.amdahl.com)
 *
 * You can do anything you want with this software, just don't say you wrote
 * it, and don't remove this notice.
 *
 * This software is provided "as is".
 *
 * The author supplies this software to be publicly redistributed on the
 * understanding that the author is not responsible for the correct
 * functioning of this software in any circumstances and is not liable for
 * any damages caused by this software.
 *
 * October 1992
 */

#ifndef _MSDOSFS_MSDOSFSMOUNT_H_
#define _MSDOSFS_MSDOSFSMOUNT_H_

#ifdef _KERNEL
#include "opt_msdosfs.h"
#ifdef MALLOC_DECLARE
MALLOC_DECLARE(M_MSDOSFSMNT);
#endif
#endif
#include <sys/iconv.h>
#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) || defined(MAKEFS)

#define msdosfs_iconv msdos_iconv

/*
 * Layout of the mount control block for a MSDOSFS filesystem.
 */
struct msdosfsmount {
        struct mount *pm_mountp;/* vfs mount struct for this fs */
        uid_t pm_uid;           /* uid to set as owner of the files */
        gid_t pm_gid;           /* gid to set as owner of the files */
        mode_t pm_mask;         /* mask to and with file protection bits
                                   for files */
        mode_t pm_dirmask;      /* mask to and with file protection bits
                                   for directories */
        struct vnode *pm_devvp; /* vnode for character device mounted */
#ifndef MAKEFS
        cdev_t pm_dev;          /* character device mounted */
#endif /* MAKEFS */
        struct bpb50 pm_bpb;    /* BIOS parameter blk for this fs */
        u_long pm_BlkPerSec;    /* How many DEV_BSIZE blocks fit inside a physical sector */
        u_long pm_FATsecs;      /* actual number of FAT sectors */
        u_long pm_fatblk;       /* block # of first FAT */
        u_long pm_rootdirblk;   /* block # (cluster # for FAT32) of root directory number */
        u_long pm_rootdirsize;  /* size in blocks (not clusters) */
        u_long pm_firstcluster; /* block number of first cluster */
        u_long pm_maxcluster;   /* maximum cluster number */
        u_long pm_freeclustercount;     /* number of free clusters */
        u_long pm_cnshift;      /* shift file offset right this amount to get a cluster number */
        u_long pm_crbomask;     /* and a file offset with this mask to get cluster rel offset */
        u_long pm_bnshift;      /* shift file offset right this amount to get a block number */
        u_long pm_bpcluster;    /* bytes per cluster */
        u_long pm_fmod;         /* ~0 if fs is modified, this can rollover to 0 */
        u_long pm_fatblocksize; /* size of FAT blocks in bytes */
        u_long pm_fatblocksec;  /* size of FAT blocks in sectors */
        uint32_t pm_fatmask;    /* mask to use for FAT numbers */
        u_long pm_fsinfo;       /* fsinfo block number */
        u_long pm_nxtfree;      /* next place to search for a free cluster */
        u_int pm_fatmult;       /* these 2 values are used in FAT */
        u_int pm_fatdiv;        /*      offset computation */
        u_int pm_curfat;        /* current FAT for FAT32 (0 otherwise) */
        u_int *pm_inusemap;     /* ptr to bitmap of in-use clusters */
        u_int pm_flags;         /* see below */
#ifndef MAKEFS
        struct netexport pm_export;     /* export information */
#endif /* MAKEFS */
        void *pm_u2w;   /* Local->Unicode iconv handle */
        void *pm_w2u;   /* Unicode->Local iconv handle */
        void *pm_u2d;   /* Unicode->DOS iconv handle */
        void *pm_d2u;   /* DOS->Local iconv handle */
};
/* Byte offset in FAT on filesystem pmp, cluster cn */
#define FATOFS(pmp, cn) ((cn) * (pmp)->pm_fatmult / (pmp)->pm_fatdiv)

#define VFSTOMSDOSFS(mp)        ((struct msdosfsmount *)mp->mnt_data)

/* Number of bits in one pm_inusemap item: */
#define N_INUSEBITS     (8 * sizeof(u_int))

/*
 * Shorthand for fields in the bpb contained in the msdosfsmount structure.
 */
#define pm_BytesPerSec  pm_bpb.bpbBytesPerSec
#define pm_ResSectors   pm_bpb.bpbResSectors
#define pm_FATs         pm_bpb.bpbFATs
#define pm_RootDirEnts  pm_bpb.bpbRootDirEnts
#define pm_Sectors      pm_bpb.bpbSectors
#define pm_Media        pm_bpb.bpbMedia
#define pm_SecPerTrack  pm_bpb.bpbSecPerTrack
#define pm_Heads        pm_bpb.bpbHeads
#define pm_HiddenSects  pm_bpb.bpbHiddenSecs
#define pm_HugeSectors  pm_bpb.bpbHugeSectors

/*
 * Convert pointer to buffer -> pointer to direntry
 */
#define bptoep(pmp, bp, dirofs) \
        ((struct direntry *)(((bp)->b_data)     \
         + ((dirofs) & (pmp)->pm_crbomask)))

/*
 * Convert block number to cluster number
 */
#define de_bn2cn(pmp, bn) \
        ((bn) >> ((pmp)->pm_cnshift - (pmp)->pm_bnshift))

/*
 * Convert cluster number to block number
 */
#define de_cn2bn(pmp, cn) \
        ((cn) << ((pmp)->pm_cnshift - (pmp)->pm_bnshift))

/*
 * Convert file 32 bit offset to cluster number
 */
#define de_cluster(pmp, off) \
        ((off) >> (pmp)->pm_cnshift)

/*
 * Clusters required to hold size bytes
 */
#define de_clcount(pmp, size) \
        (((size) + (pmp)->pm_bpcluster - 1) >> (pmp)->pm_cnshift)

/*
 * Convert file 32 bit offset to block number
 */
#define de_blk(pmp, off) \
        (de_cn2bn(pmp, de_cluster((pmp), (off))))

/*
 * Convert a logical cluster number to file offset.
 */
#define de_cn2off(pmp, cn) \
        ((cn) << (pmp)->pm_cnshift)

/*
 * Convert a device block number to a file offset.
 */
#define de_bn2off(pmp, bn) \
        ((bn) << (pmp)->pm_bnshift)

/*
 * Convert a device block number to a 64 bit offset, used for getblk(),
 * bread(), etc.  These are DragonFly specific macros.
 */
#define de_bn2doff(pmp, bn) \
        ((off_t)(bn) << (pmp)->pm_bnshift)

#define de_cn2doff(pmp, cn) \
        ((off_t)(cn) << (pmp)->pm_cnshift)

/*
 * Map a cluster number into a filesystem relative block number.
 */
#define cntobn(pmp, cn) \
        (de_cn2bn((pmp), (cn)-CLUST_FIRST) + (pmp)->pm_firstcluster)

/*
 * Calculate block number for directory entry in root dir, offset dirofs
 */
#define roottobn(pmp, dirofs) \
        (de_blk((pmp), (dirofs)) + (pmp)->pm_rootdirblk)

/*
 * Calculate block number for directory entry at cluster dirclu, offset
 * dirofs
 */
#define detobn(pmp, dirclu, dirofs) \
        ((dirclu) == MSDOSFSROOT \
         ? roottobn((pmp), (dirofs)) \
         : cntobn((pmp), (dirclu)))

#define MSDOSFS_LOCK_MP(pmp)
#define MSDOSFS_UNLOCK_MP(pmp)
#define MSDOSFS_ASSERT_MP_LOCKED(pmp)

#endif /* _KERNEL || _KERNEL_STRUCTURES || MAKEFS */

#ifndef MAKEFS
/*
 *  Arguments to mount MSDOS filesystems.
 */
struct msdosfs_args {
        char    *fspec;         /* blocks special holding the fs to mount */
        struct  export_args export;     /* network export information */
        uid_t   uid;            /* uid that owns msdosfs files */
        gid_t   gid;            /* gid that owns msdosfs files */
        mode_t  mask;           /* file mask to be applied for msdosfs perms */
        int     flags;          /* see below */
        char cs_local[ICONV_CSNMAXLEN];
        char cs_dos[ICONV_CSNMAXLEN];
        mode_t  dirmask;        /* dir  mask to be applied for msdosfs perms */
};
#endif /* MAKEFS */

/*
 * Msdosfs mount options:
 */
#define MSDOSFSMNT_SHORTNAME    1       /* Force old DOS short names only */
#define MSDOSFSMNT_LONGNAME     2       /* Force Win'95 long names */
#define MSDOSFSMNT_NOWIN95      4       /* Completely ignore Win95 entries */
#define MSDOSFSMNT_KICONV       0x10    /* Use libiconv to convert chars */
/* All flags above: */
#define MSDOSFSMNT_MNTOPT \
        (MSDOSFSMNT_SHORTNAME|MSDOSFSMNT_LONGNAME|MSDOSFSMNT_NOWIN95 \
         |MSDOSFSMNT_KICONV)
#define MSDOSFSMNT_RONLY        0x80000000      /* mounted read-only    */
#define MSDOSFSMNT_WAITONFAT    0x40000000      /* mounted synchronous  */
#define MSDOSFS_FATMIRROR       0x20000000      /* FAT is mirrored */
#define MSDOSFS_FSIMOD          0x01000000

#define MSDOSFS_ARGSMAGIC       0xe4eff300

#ifdef MSDOSFS_DEBUG
#define mprintf(fmt, ...)       kprintf(fmt, ## __VA_ARGS__)
#else
#define mprintf(fmt, ...)
#endif

#define ASSERT_VOP_ELOCKED(vp, str)     KASSERT(vn_islocked(vp), (str))
#define ASSERT_VOP_LOCKED(vp, str)      KASSERT(vn_islocked(vp), (str))

#define DOINGASYNC(vp)  (((vp)->v_mount->mnt_kern_flag & MNT_ASYNC) != 0)

#endif /* !_MSDOSFS_MSDOSFSMOUNT_H_ */