ufsmount.h revision 297786
1/*-
2 * Copyright (c) 1982, 1986, 1989, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 4. Neither the name of the University nor the names of its contributors
14 *    may be used to endorse or promote products derived from this software
15 *    without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 *	@(#)ufsmount.h	8.6 (Berkeley) 3/30/95
30 * $FreeBSD: stable/10/sys/ufs/ufs/ufsmount.h 297786 2016-04-10 16:27:46Z kib $
31 */
32
33#ifndef _UFS_UFS_UFSMOUNT_H_
34#define	_UFS_UFS_UFSMOUNT_H_
35
36#include <sys/buf.h>	/* XXX For struct workhead. */
37
38/*
39 * Arguments to mount UFS-based filesystems
40 */
41struct ufs_args {
42	char	*fspec;			/* block special device to mount */
43	struct	oexport_args export;	/* network export information */
44};
45
46#ifdef _KERNEL
47
48#ifdef MALLOC_DECLARE
49MALLOC_DECLARE(M_UFSMNT);
50#endif
51
52struct buf;
53struct inode;
54struct nameidata;
55struct timeval;
56struct ucred;
57struct uio;
58struct vnode;
59struct ufs_extattr_per_mount;
60struct jblocks;
61struct inodedep;
62
63TAILQ_HEAD(inodedeplst, inodedep);
64LIST_HEAD(bmsafemaphd, bmsafemap);
65
66/* This structure describes the UFS specific mount structure data. */
67struct ufsmount {
68	struct	mount *um_mountp;		/* filesystem vfs structure */
69	struct	cdev *um_dev;			/* device mounted */
70	struct	g_consumer *um_cp;
71	struct	bufobj *um_bo;			/* Buffer cache object */
72	struct	vnode *um_devvp;		/* block device mounted vnode */
73	u_long	um_fstype;			/* type of filesystem */
74	struct	fs *um_fs;			/* pointer to superblock */
75	struct	ufs_extattr_per_mount um_extattr;	/* extended attrs */
76	u_long	um_nindir;			/* indirect ptrs per block */
77	u_long	um_bptrtodb;			/* indir ptr to disk block */
78	u_long	um_seqinc;			/* inc between seq blocks */
79	struct	mtx um_lock;			/* Protects ufsmount & fs */
80	pid_t	um_fsckpid;			/* PID permitted fsck sysctls */
81	struct	mount_softdeps *um_softdep;	/* softdep mgmt structure */
82	struct	vnode *um_quotas[MAXQUOTAS];	/* pointer to quota files */
83	struct	ucred *um_cred[MAXQUOTAS];	/* quota file access cred */
84	time_t	um_btime[MAXQUOTAS];		/* block quota time limit */
85	time_t	um_itime[MAXQUOTAS];		/* inode quota time limit */
86	char	um_qflags[MAXQUOTAS];		/* quota specific flags */
87	int64_t	um_savedmaxfilesize;		/* XXX - limit maxfilesize */
88	int	um_candelete;			/* devvp supports TRIM */
89	int	um_writesuspended;		/* suspension in progress */
90	int	(*um_balloc)(struct vnode *, off_t, int, struct ucred *,
91		    int, struct buf **);
92	int	(*um_blkatoff)(struct vnode *, off_t, char **, struct buf **);
93	int	(*um_truncate)(struct vnode *, off_t, int, struct ucred *);
94	int	(*um_update)(struct vnode *, int);
95	int	(*um_valloc)(struct vnode *, int, struct ucred *,
96		    struct vnode **);
97	int	(*um_vfree)(struct vnode *, ino_t, int);
98	void	(*um_ifree)(struct ufsmount *, struct inode *);
99	int	(*um_rdonly)(struct inode *);
100	void	(*um_snapgone)(struct inode *);
101};
102
103#define	UFS_BALLOC(aa, bb, cc, dd, ee, ff) VFSTOUFS((aa)->v_mount)->um_balloc(aa, bb, cc, dd, ee, ff)
104#define	UFS_BLKATOFF(aa, bb, cc, dd) VFSTOUFS((aa)->v_mount)->um_blkatoff(aa, bb, cc, dd)
105#define	UFS_TRUNCATE(aa, bb, cc, dd) VFSTOUFS((aa)->v_mount)->um_truncate(aa, bb, cc, dd)
106#define	UFS_UPDATE(aa, bb) VFSTOUFS((aa)->v_mount)->um_update(aa, bb)
107#define	UFS_VALLOC(aa, bb, cc, dd) VFSTOUFS((aa)->v_mount)->um_valloc(aa, bb, cc, dd)
108#define	UFS_VFREE(aa, bb, cc) VFSTOUFS((aa)->v_mount)->um_vfree(aa, bb, cc)
109#define	UFS_IFREE(aa, bb) ((aa)->um_ifree(aa, bb))
110#define	UFS_RDONLY(aa) ((aa)->i_ump->um_rdonly(aa))
111#define	UFS_SNAPGONE(aa) ((aa)->i_ump->um_snapgone(aa))
112
113#define	UFS_LOCK(aa)	mtx_lock(&(aa)->um_lock)
114#define	UFS_UNLOCK(aa)	mtx_unlock(&(aa)->um_lock)
115#define	UFS_MTX(aa)	(&(aa)->um_lock)
116
117/*
118 * Filesystem types
119 */
120#define	UFS1	1
121#define	UFS2	2
122
123/*
124 * Flags describing the state of quotas.
125 */
126#define	QTF_OPENING	0x01			/* Q_QUOTAON in progress */
127#define	QTF_CLOSING	0x02			/* Q_QUOTAOFF in progress */
128#define	QTF_64BIT	0x04			/* 64-bit quota file */
129
130/* Convert mount ptr to ufsmount ptr. */
131#define	VFSTOUFS(mp)	((struct ufsmount *)((mp)->mnt_data))
132#define	UFSTOVFS(ump)	(ump)->um_mountp
133
134/*
135 * Macros to access filesystem parameters in the ufsmount structure.
136 * Used by ufs_bmap.
137 */
138#define	MNINDIR(ump)			((ump)->um_nindir)
139#define	blkptrtodb(ump, b)		((b) << (ump)->um_bptrtodb)
140#define	is_sequential(ump, a, b)	((b) == (a) + ump->um_seqinc)
141#endif /* _KERNEL */
142
143#endif
144