msdosfsmount.h revision 30354
1/*	$Id: msdosfsmount.h,v 1.11 1997/03/03 17:36:11 bde Exp $ */
2/*	$NetBSD: msdosfsmount.h,v 1.7 1994/08/21 18:44:17 ws Exp $	*/
3
4/*-
5 * Copyright (C) 1994 Wolfgang Solfrank.
6 * Copyright (C) 1994 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
57MALLOC_DECLARE(M_MSDOSFSMNT);
58#endif
59
60/*
61 * Layout of the mount control block for a msdos file system.
62 */
63struct 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_mounter;	/* uid of the user who mounted the FS */
67	uid_t pm_uid;		/* uid to set as owner of the files */
68	gid_t pm_gid;		/* gid to set as owner of the files */
69	mode_t pm_mask;		/* mask to and with file protection bits */
70	struct vnode *pm_devvp;	/* vnode for block device mntd */
71	struct bpb50 pm_bpb;	/* BIOS parameter blk for this fs */
72	u_long pm_fatblk;	/* block # of first FAT */
73	u_long pm_rootdirblk;	/* block # of root directory */
74	u_long pm_rootdirsize;	/* size in blocks (not clusters) */
75	u_long pm_firstcluster;	/* block number of first cluster */
76	u_long pm_nmbrofclusters;	/* # of clusters in filesystem */
77	u_long pm_maxcluster;	/* maximum cluster number */
78	u_long pm_freeclustercount;	/* number of free clusters */
79	u_long pm_bnshift;	/* shift file offset right this amount to get a block number */
80	u_long pm_brbomask;	/* and a file offset with this mask to get block rel offset */
81	u_long pm_cnshift;	/* shift file offset right this amount to get a cluster number */
82	u_long pm_crbomask;	/* and a file offset with this mask to get cluster rel offset */
83	u_long pm_bpcluster;	/* bytes per cluster */
84	u_long pm_depclust;	/* directory entries per cluster */
85	u_long pm_fmod;		/* ~0 if fs is modified, this can rollover to 0	*/
86	u_long pm_fatblocksize;	/* size of fat blocks in bytes */
87	u_long pm_fatblocksec;	/* size of fat blocks in sectors */
88	u_long pm_fatsize;	/* size of fat in bytes */
89	u_int *pm_inusemap;	/* ptr to bitmap of in-use clusters */
90	char pm_ronly;		/* read only if non-zero */
91	char pm_waitonfat;	/* wait for writes of the fat to complete, when 0 use bdwrite, else use bwrite */
92	struct netexport pm_export;	/* export information */
93};
94
95/* Number of bits in one pm_inusemap item: */
96#define	N_INUSEBITS	(8 * sizeof(u_int))
97
98/*
99 * How to compute pm_cnshift and pm_crbomask.
100 *
101 * pm_crbomask = (pm_SectPerClust * pm_BytesPerSect) - 1
102 * if (bytesperclust == * 0)
103 * 	return EBADBLKSZ;
104 * bit = 1;
105 * for (i = 0; i < 32; i++) {
106 *	if (bit & bytesperclust) {
107 *		if (bit ^ bytesperclust)
108 *			return EBADBLKSZ;
109 *		pm_cnshift = * i;
110 *		break;
111 *	}
112 *	bit <<= 1;
113 * }
114 */
115
116/*
117 * Shorthand for fields in the bpb contained in the msdosfsmount structure.
118 */
119#define	pm_BytesPerSec	pm_bpb.bpbBytesPerSec
120#define	pm_SectPerClust	pm_bpb.bpbSecPerClust
121#define	pm_ResSectors	pm_bpb.bpbResSectors
122#define	pm_FATs		pm_bpb.bpbFATs
123#define	pm_RootDirEnts	pm_bpb.bpbRootDirEnts
124#define	pm_Sectors	pm_bpb.bpbSectors
125#define	pm_Media	pm_bpb.bpbMedia
126#define	pm_FATsecs	pm_bpb.bpbFATsecs
127#define	pm_SecPerTrack	pm_bpb.bpbSecPerTrack
128#define	pm_Heads	pm_bpb.bpbHeads
129#define	pm_HiddenSects	pm_bpb.bpbHiddenSecs
130#define	pm_HugeSectors	pm_bpb.bpbHugeSectors
131
132/*
133 * Map a cluster number into a filesystem relative block number.
134 */
135#define	cntobn(pmp, cn) \
136	((((cn)-CLUST_FIRST) * (pmp)->pm_SectPerClust) + (pmp)->pm_firstcluster)
137
138/*
139 * Map a filesystem relative block number back into a cluster number.
140 */
141#define	bntocn(pmp, bn) \
142	((((bn) - pmp->pm_firstcluster)/ (pmp)->pm_SectPerClust) + CLUST_FIRST)
143
144/*
145 * Calculate block number for directory entry in root dir, offset dirofs
146 */
147#define	roottobn(pmp, dirofs) \
148	(((dirofs) / (pmp)->pm_depclust) * (pmp)->pm_SectPerClust \
149	+ (pmp)->pm_rootdirblk)
150
151/*
152 * Calculate block number for directory entry at cluster dirclu, offset
153 * dirofs
154 */
155#define	detobn(pmp, dirclu, dirofs) \
156	((dirclu) == MSDOSFSROOT \
157	 ? roottobn((pmp), (dirofs)) \
158	 : cntobn((pmp), (dirclu)))
159
160/*
161 * Convert pointer to buffer -> pointer to direntry
162 */
163#define	bptoep(pmp, bp, dirofs) \
164	((struct direntry *)((bp)->b_data)	\
165	 + (dirofs) % (pmp)->pm_depclust)
166
167
168/*
169 * Convert filesize to block number
170 */
171#define de_blk(pmp, off) \
172	((off) >> (pmp)->pm_cnshift)
173
174/*
175 * Clusters required to hold size bytes
176 */
177#define	de_clcount(pmp, size) \
178	(((size) + (pmp)->pm_bpcluster - 1) >> (pmp)->pm_cnshift)
179
180int msdosfs_init __P((struct vfsconf *vfsp));
181
182#endif /* KERNEL */
183
184/*
185 *  Arguments to mount MSDOS filesystems.
186 */
187struct msdosfs_args {
188	char	*fspec;		/* blocks special holding the fs to mount */
189	struct	export_args export;	/* network export information */
190	uid_t	uid;		/* uid that owns msdosfs files */
191	gid_t	gid;		/* gid that owns msdosfs files */
192	mode_t	mask;		/* mask to be applied for msdosfs perms */
193};
194
195#endif /* !_MSDOSFS_MSDOSFSMOUNT_H_ */
196