Home | History | Annotate | Line # | Download | only in ufs
      1 /*	$NetBSD: ufsmount.h,v 1.44 2022/11/17 06:40:40 chs Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1982, 1986, 1989, 1993
      5  *	The Regents of the University of California.  All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  * 3. Neither the name of the University nor the names of its contributors
     16  *    may be used to endorse or promote products derived from this software
     17  *    without specific prior written permission.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     29  * SUCH DAMAGE.
     30  *
     31  *	@(#)ufsmount.h	8.6 (Berkeley) 3/30/95
     32  */
     33 
     34 #ifndef _UFS_UFS_UFSMOUNT_H_
     35 #define _UFS_UFS_UFSMOUNT_H_
     36 
     37 #include <sys/mount.h> /* struct export_args30 */
     38 
     39 /*
     40  * Arguments to mount UFS-based filesystems
     41  */
     42 struct ufs_args {
     43 	char	*fspec;			/* block special device to mount */
     44 };
     45 
     46 /*
     47  * Arguments to mount MFS
     48  */
     49 struct mfs_args {
     50 	char	*fspec;			/* name to export for statfs */
     51 	struct	export_args30 _pad1; /* compat with old userland tools */
     52 	void *	base;			/* base of file system in memory */
     53 	u_long	size;			/* size of file system */
     54 };
     55 
     56 #ifdef _KERNEL
     57 
     58 #if defined(_KERNEL_OPT)
     59 #include "opt_ffs.h"
     60 #endif
     61 
     62 #include <sys/mutex.h>
     63 
     64 #include <ufs/ufs/extattr.h>
     65 #include <ufs/ufs/quota.h>
     66 
     67 struct buf;
     68 struct inode;
     69 struct nameidata;
     70 struct timeval;
     71 struct uio;
     72 struct vnode;
     73 
     74 /* This structure describes the UFS specific mount structure data. */
     75 struct ufsmount {
     76 	struct	mount *um_mountp;		/* filesystem vfs structure */
     77 	dev_t	um_dev;				/* device mounted */
     78 	struct	vnode *um_devvp;		/* block device mounted vnode */
     79 	u_long	um_fstype;
     80 	u_int32_t um_flags;			/* UFS-specific flags - see below */
     81 	union {					/* pointer to superblock */
     82 		struct	fs *fs;			/* FFS */
     83 		struct	lfs *lfs;		/* LFS */
     84 		struct  m_ext2fs *e2fs;		/* EXT2FS */
     85 		struct  chfs_mount *chfs;	/* CHFS */
     86 	} ufsmount_u;
     87 #define	um_fs	ufsmount_u.fs
     88 #define	um_lfs	ufsmount_u.lfs
     89 #define um_e2fs	ufsmount_u.e2fs
     90 #define um_e2fsb ufsmount_u.e2fs->s_es
     91 #define um_chfs	ufsmount_u.chfs
     92 
     93 	/* Extended attribute information. */
     94 	struct ufs_extattr_per_mount um_extattr;
     95 
     96 	struct	vnode *um_quotas[MAXQUOTAS];	/* pointer to quota files */
     97 	kauth_cred_t   um_cred[MAXQUOTAS];	/* quota file access cred */
     98 	u_long	um_nindir;			/* indirect ptrs per block */
     99 	u_long	um_lognindir;			/* log2 of um_nindir */
    100 	u_long	um_bptrtodb;			/* indir ptr to disk block */
    101 	u_long	um_seqinc;			/* inc between seq blocks */
    102 	kmutex_t um_lock;			/* lock on global data */
    103 	union {
    104 	    struct um_q1 {
    105 		time_t	q1_btime[MAXQUOTAS];	/* block quota time limit */
    106 		time_t	q1_itime[MAXQUOTAS];	/* inode quota time limit */
    107 		char	q1_qflags[MAXQUOTAS];	/* quota specific flags */
    108 	    } um_q1;
    109 	    struct um_q2 {
    110 		uint64_t q2_bsize;		/* block size of quota file */
    111 		uint64_t q2_bmask;		/* mask for above */
    112 	    } um_q2;
    113 	} um_q;
    114 #define umq1_btime  um_q.um_q1.q1_btime
    115 #define umq1_itime  um_q.um_q1.q1_itime
    116 #define umq1_qflags um_q.um_q1.q1_qflags
    117 #define umq2_bsize  um_q.um_q2.q2_bsize
    118 #define umq2_bmask  um_q.um_q2.q2_bmask
    119 
    120 	void	*um_oldfscompat;		/* save 4.2 rotbl */
    121 	int	um_maxsymlinklen;
    122 	int	um_dirblksiz;
    123 	u_int64_t um_maxfilesize;
    124 	void	*um_snapinfo;			/* snapshot private data */
    125 
    126 	const struct ufs_ops *um_ops;
    127 
    128 	void *um_discarddata;
    129 };
    130 
    131 struct ufs_ops {
    132 	void (*uo_itimes)(struct inode *ip, const struct timespec *,
    133 	    const struct timespec *, const struct timespec *);
    134 	int (*uo_update)(struct vnode *, const struct timespec *,
    135 	    const struct timespec *, int);
    136 	int (*uo_truncate)(struct vnode *, off_t, int, kauth_cred_t);
    137 	int (*uo_balloc)(struct vnode *, off_t, int, kauth_cred_t, int,
    138 	    struct buf **);
    139         void (*uo_snapgone)(struct vnode *);
    140 	int (*uo_bufrd)(struct vnode *, struct uio *, int, kauth_cred_t);
    141 	int (*uo_bufwr)(struct vnode *, struct uio *, int, kauth_cred_t);
    142 };
    143 
    144 #define	UFS_OPS(vp)	(VFSTOUFS((vp)->v_mount)->um_ops)
    145 
    146 #define	UFS_ITIMES(vp, acc, mod, cre) \
    147 	(*UFS_OPS(vp)->uo_itimes)(VTOI(vp), (acc), (mod), (cre))
    148 #define	UFS_UPDATE(vp, acc, mod, flags) \
    149 	(*UFS_OPS(vp)->uo_update)((vp), (acc), (mod), (flags))
    150 #define	UFS_TRUNCATE(vp, off, flags, cr) \
    151 	(*UFS_OPS(vp)->uo_truncate)((vp), (off), (flags), (cr))
    152 #define	UFS_BALLOC(vp, off, size, cr, flags, bpp) \
    153 	(*UFS_OPS(vp)->uo_balloc)((vp), (off), (size), (cr), (flags), (bpp))
    154 #define	UFS_SNAPGONE(vp) \
    155 	(*UFS_OPS(vp)->uo_snapgone)((vp))
    156 #define	UFS_BUFRD(vp, uio, ioflag, cred) \
    157 	(*UFS_OPS(vp)->uo_bufrd)((vp), (uio), (ioflag), (cred))
    158 #define	UFS_BUFWR(vp, uio, ioflag, cred) \
    159 	(*UFS_OPS(vp)->uo_bufwr)((vp), (uio), (ioflag), (cred))
    160 
    161 /* UFS-specific flags */
    162 #define UFS_NEEDSWAP	0x01	/* filesystem metadata need byte-swapping */
    163 #define UFS_ISAPPLEUFS	0x02	/* filesystem is Apple UFS */
    164 #define UFS_QUOTA	0x04	/* filesystem has QUOTA (v1) */
    165 #define UFS_QUOTA2	0x08	/* filesystem has QUOTA2 */
    166 #define UFS_EA		0x10	/* UFS2 with extattrs */
    167 
    168 /*
    169  * Filesystem types
    170  */
    171 #define UFS1  1
    172 #define UFS2  2
    173 
    174 
    175 /*
    176  * Flags describing the state of quotas.
    177  */
    178 #define	QTF_OPENING	0x01			/* Q_QUOTAON in progress */
    179 #define	QTF_CLOSING	0x02			/* Q_QUOTAOFF in progress */
    180 
    181 /* Convert mount ptr to ufsmount ptr. */
    182 #define VFSTOUFS(mp)	((struct ufsmount *)((mp)->mnt_data))
    183 
    184 #ifdef APPLE_UFS
    185 #define UFS_MPISAPPLEUFS(ump)	((ump)->um_flags & UFS_ISAPPLEUFS)
    186 #else
    187 #define UFS_MPISAPPLEUFS(ump)	(0)
    188 #endif
    189 
    190 /*
    191  * Macros to access file system parameters in the ufsmount structure.
    192  * Used by ufs_bmap.
    193  */
    194 #define MNINDIR(ump)			((ump)->um_nindir)
    195 #define	blkptrtodb(ump, b)		((b) << (ump)->um_bptrtodb)
    196 
    197 /*
    198  * Predicate for byte-swapping support.
    199  */
    200 #define	FSFMT(vp)	(((vp)->v_mount->mnt_iflag & IMNT_DTYPE) == 0)
    201 
    202 #endif /* _KERNEL */
    203 
    204 #endif /* !_UFS_UFS_UFSMOUNT_H_ */
    205