xref: /freebsd/sys/ufs/ffs/ffs_extern.h (revision 3cbb4cc200f8a0ad7ed08233425ea54524a21f1c)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1991, 1993, 1994
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  *	@(#)ffs_extern.h	8.6 (Berkeley) 3/30/95
32  * $FreeBSD$
33  */
34 
35 #ifndef _UFS_FFS_EXTERN_H
36 #define	_UFS_FFS_EXTERN_H
37 
38 #ifndef _KERNEL
39 #error "No user-serving parts inside"
40 #else
41 
42 struct buf;
43 struct cg;
44 struct fid;
45 struct fs;
46 struct inode;
47 struct malloc_type;
48 struct mount;
49 struct thread;
50 struct sockaddr;
51 struct statfs;
52 struct ucred;
53 struct vnode;
54 struct vop_fsync_args;
55 struct vop_reallocblks_args;
56 struct workhead;
57 
58 int	ffs_alloc(struct inode *, ufs2_daddr_t, ufs2_daddr_t, int, int,
59 	    struct ucred *, ufs2_daddr_t *);
60 int	ffs_balloc_ufs1(struct vnode *a_vp, off_t a_startoffset, int a_size,
61             struct ucred *a_cred, int a_flags, struct buf **a_bpp);
62 int	ffs_balloc_ufs2(struct vnode *a_vp, off_t a_startoffset, int a_size,
63             struct ucred *a_cred, int a_flags, struct buf **a_bpp);
64 void	ffs_blkfree(struct ufsmount *, struct fs *, struct vnode *,
65 	    ufs2_daddr_t, long, ino_t, enum vtype, struct workhead *, u_long);
66 ufs2_daddr_t ffs_blkpref_ufs1(struct inode *, ufs_lbn_t, int, ufs1_daddr_t *);
67 ufs2_daddr_t ffs_blkpref_ufs2(struct inode *, ufs_lbn_t, int, ufs2_daddr_t *);
68 void	ffs_blkrelease_finish(struct ufsmount *, u_long);
69 u_long	ffs_blkrelease_start(struct ufsmount *, struct vnode *, ino_t);
70 uint32_t ffs_calc_sbhash(struct fs *);
71 int	ffs_checkfreefile(struct fs *, struct vnode *, ino_t);
72 void	ffs_clrblock(struct fs *, u_char *, ufs1_daddr_t);
73 void	ffs_clusteracct(struct fs *, struct cg *, ufs1_daddr_t, int);
74 void	ffs_bdflush(struct bufobj *, struct buf *);
75 int	ffs_copyonwrite(struct vnode *, struct buf *);
76 int	ffs_flushfiles(struct mount *, int, struct thread *);
77 void	ffs_fragacct(struct fs *, int, int32_t [], int);
78 int	ffs_freefile(struct ufsmount *, struct fs *, struct vnode *, ino_t,
79 	    int, struct workhead *);
80 void	ffs_fserr(struct fs *, ino_t, char *);
81 int	ffs_getcg(struct fs *, struct vnode *, u_int, int, struct buf **,
82 	    struct cg **);
83 int	ffs_isblock(struct fs *, u_char *, ufs1_daddr_t);
84 int	ffs_isfreeblock(struct fs *, u_char *, ufs1_daddr_t);
85 void	ffs_oldfscompat_write(struct fs *, struct ufsmount *);
86 int	ffs_own_mount(const struct mount *mp);
87 int	ffs_reallocblks(struct vop_reallocblks_args *);
88 int	ffs_realloccg(struct inode *, ufs2_daddr_t, ufs2_daddr_t,
89 	    ufs2_daddr_t, int, int, int, struct ucred *, struct buf **);
90 int	ffs_reload(struct mount *, struct thread *, int);
91 int	ffs_sbget(void *, struct fs **, off_t, struct malloc_type *,
92 	    int (*)(void *, off_t, void **, int));
93 int	ffs_sbput(void *, struct fs *, off_t, int (*)(void *, off_t, void *,
94 	    int));
95 int	ffs_sbupdate(struct ufsmount *, int, int);
96 void	ffs_setblock(struct fs *, u_char *, ufs1_daddr_t);
97 int	ffs_snapblkfree(struct fs *, struct vnode *, ufs2_daddr_t, long, ino_t,
98 	    enum vtype, struct workhead *);
99 void	ffs_snapremove(struct vnode *vp);
100 int	ffs_snapshot(struct mount *mp, char *snapfile);
101 void	ffs_snapshot_mount(struct mount *mp);
102 void	ffs_snapshot_unmount(struct mount *mp);
103 void	ffs_susp_initialize(void);
104 void	ffs_susp_uninitialize(void);
105 void	ffs_sync_snap(struct mount *, int);
106 int	ffs_syncvnode(struct vnode *vp, int waitfor, int flags);
107 int	ffs_truncate(struct vnode *, off_t, int, struct ucred *);
108 int	ffs_update(struct vnode *, int);
109 void	ffs_update_dinode_ckhash(struct fs *, struct ufs2_dinode *);
110 int	ffs_verify_dinode_ckhash(struct fs *, struct ufs2_dinode *);
111 int	ffs_valloc(struct vnode *, int, struct ucred *, struct vnode **);
112 int	ffs_vfree(struct vnode *, ino_t, int);
113 vfs_vget_t ffs_vget;
114 int	ffs_vgetf(struct mount *, ino_t, int, struct vnode **, int);
115 void	process_deferred_inactive(struct mount *mp);
116 int	ffs_fsfail_cleanup(struct ufsmount *, int);
117 int	ffs_fsfail_cleanup_locked(struct ufsmount *, int);
118 int	ffs_breadz(struct ufsmount *, struct vnode *, daddr_t, daddr_t, int,
119 	    daddr_t *, int *, int, struct ucred *, int, void (*)(struct buf *),
120 	    struct buf **);
121 
122 /*
123  * Flags to ffs_vgetf
124  */
125 #define	FFSV_FORCEINSMQ	0x0001
126 #define	FFSV_REPLACE	0x0002
127 
128 /*
129  * Flags to ffs_reload
130  */
131 #define	FFSR_FORCE	0x0001
132 #define	FFSR_UNSUSPEND	0x0002
133 
134 /*
135  * Request standard superblock location in ffs_sbget
136  */
137 #define	STDSB			-1	/* Fail if check-hash is bad */
138 #define	STDSB_NOHASHFAIL	-2	/* Ignore check-hash failure */
139 
140 /*
141  * Definitions for TRIM interface
142  *
143  * Special keys and recommended hash table size
144  */
145 #define	NOTRIM_KEY	1	/* never written, so don't call trim for it */
146 #define	SINGLETON_KEY	2	/* only block being freed, so trim it now */
147 #define	FIRST_VALID_KEY	3	/* first valid key describing a block range */
148 #define	MAXTRIMIO	1024	/* maximum expected outstanding trim requests */
149 
150 extern struct vop_vector ffs_vnodeops1;
151 extern struct vop_vector ffs_fifoops1;
152 extern struct vop_vector ffs_vnodeops2;
153 extern struct vop_vector ffs_fifoops2;
154 
155 /*
156  * Soft update function prototypes.
157  */
158 
159 int	softdep_check_suspend(struct mount *, struct vnode *,
160 	  int, int, int, int);
161 void	softdep_get_depcounts(struct mount *, int *, int *);
162 void	softdep_initialize(void);
163 void	softdep_uninitialize(void);
164 int	softdep_mount(struct vnode *, struct mount *, struct fs *,
165 	    struct ucred *);
166 void	softdep_unmount(struct mount *);
167 void	softdep_handle_error(struct buf *);
168 int	softdep_move_dependencies(struct buf *, struct buf *);
169 int	softdep_flushworklist(struct mount *, int *, struct thread *);
170 int	softdep_flushfiles(struct mount *, int, struct thread *);
171 void	softdep_update_inodeblock(struct inode *, struct buf *, int);
172 void	softdep_load_inodeblock(struct inode *);
173 void	softdep_freefile(struct vnode *, ino_t, int);
174 int	softdep_request_cleanup(struct fs *, struct vnode *,
175 	    struct ucred *, int);
176 int	softdep_prerename(struct vnode *, struct vnode *, struct vnode *,
177 	    struct vnode *);
178 int	softdep_prelink(struct vnode *, struct vnode *, int);
179 void	softdep_setup_freeblocks(struct inode *, off_t, int);
180 void	softdep_setup_inomapdep(struct buf *, struct inode *, ino_t, int);
181 void	softdep_setup_blkmapdep(struct buf *, struct mount *, ufs2_daddr_t,
182 	    int, int);
183 void	softdep_setup_allocdirect(struct inode *, ufs_lbn_t, ufs2_daddr_t,
184 	    ufs2_daddr_t, long, long, struct buf *);
185 void	softdep_setup_allocext(struct inode *, ufs_lbn_t, ufs2_daddr_t,
186 	    ufs2_daddr_t, long, long, struct buf *);
187 void	softdep_setup_allocindir_meta(struct buf *, struct inode *,
188 	    struct buf *, int, ufs2_daddr_t);
189 void	softdep_setup_allocindir_page(struct inode *, ufs_lbn_t,
190 	    struct buf *, int, ufs2_daddr_t, ufs2_daddr_t, struct buf *);
191 void	softdep_setup_blkfree(struct mount *, struct buf *, ufs2_daddr_t, int,
192 	    struct workhead *);
193 void	softdep_setup_inofree(struct mount *, struct buf *, ino_t,
194 	    struct workhead *);
195 void	softdep_setup_sbupdate(struct ufsmount *, struct fs *, struct buf *);
196 void	softdep_fsync_mountdev(struct vnode *);
197 int	softdep_sync_metadata(struct vnode *);
198 int	softdep_sync_buf(struct vnode *, struct buf *, int);
199 int     softdep_fsync(struct vnode *);
200 int	softdep_prealloc(struct vnode *, int);
201 int	softdep_journal_lookup(struct mount *, struct vnode **);
202 void	softdep_journal_freeblocks(struct inode *, struct ucred *, off_t, int);
203 void	softdep_journal_fsync(struct inode *);
204 void	softdep_buf_append(struct buf *, struct workhead *);
205 void	softdep_inode_append(struct inode *, struct ucred *, struct workhead *);
206 void	softdep_freework(struct workhead *);
207 
208 /*
209  * Things to request flushing in softdep_request_cleanup()
210  */
211 #define	FLUSH_INODES		1
212 #define	FLUSH_INODES_WAIT	2
213 #define	FLUSH_BLOCKS		3
214 #define	FLUSH_BLOCKS_WAIT	4
215 /*
216  * Flag to ffs_syncvnode() to request flushing of data only,
217  * but skip the ffs_update() on the inode itself. Used to avoid
218  * deadlock when flushing snapshot inodes while holding snaplk.
219  */
220 #define	NO_INO_UPDT		0x00000001
221 /*
222  * Request data sync only from ffs_syncvnode(), not touching even more
223  * metadata than NO_INO_UPDT.
224  */
225 #define	DATA_ONLY		0x00000002
226 
227 int	ffs_rdonly(struct inode *);
228 
229 TAILQ_HEAD(snaphead, inode);
230 
231 struct snapdata {
232 	LIST_ENTRY(snapdata) sn_link;
233 	struct snaphead sn_head;
234 	daddr_t sn_listsize;
235 	daddr_t *sn_blklist;
236 	struct lock sn_lock;
237 };
238 
239 #endif /* _KERNEL */
240 
241 #endif /* !_UFS_FFS_EXTERN_H */
242