xref: /freebsd/sys/ufs/ffs/ffs_extern.h (revision 7ef62cebc2f965b0f640263e179276928885e33d)
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_uint8(vtype), struct workhead *,
66 	    uint64_t);
67 ufs2_daddr_t ffs_blkpref_ufs1(struct inode *, ufs_lbn_t, int, ufs1_daddr_t *);
68 ufs2_daddr_t ffs_blkpref_ufs2(struct inode *, ufs_lbn_t, int, ufs2_daddr_t *);
69 void	ffs_blkrelease_finish(struct ufsmount *, uint64_t);
70 uint64_t ffs_blkrelease_start(struct ufsmount *, struct vnode *, ino_t);
71 uint32_t ffs_calc_sbhash(struct fs *);
72 int	ffs_checkfreefile(struct fs *, struct vnode *, ino_t);
73 void	ffs_clrblock(struct fs *, uint8_t *, ufs1_daddr_t);
74 void	ffs_clusteracct(struct fs *, struct cg *, ufs1_daddr_t, int);
75 void	ffs_bdflush(struct bufobj *, struct buf *);
76 int	ffs_copyonwrite(struct vnode *, struct buf *);
77 int	ffs_flushfiles(struct mount *, int, struct thread *);
78 void	ffs_fragacct(struct fs *, int, int32_t [], int);
79 int	ffs_freefile(struct ufsmount *, struct fs *, struct vnode *, ino_t,
80 	    int, struct workhead *);
81 void	ffs_fserr(struct fs *, ino_t, char *);
82 int	ffs_getcg(struct fs *, struct vnode *, uint64_t, int, struct buf **,
83 	    struct cg **);
84 int	ffs_inotovp(struct mount *, ino_t, uint64_t, int, struct vnode **,
85 	    int);
86 int	ffs_isblock(struct fs *, uint8_t *, ufs1_daddr_t);
87 int	ffs_isfreeblock(struct fs *, uint8_t *, ufs1_daddr_t);
88 void	ffs_oldfscompat_write(struct fs *, struct ufsmount *);
89 int	ffs_own_mount(const struct mount *mp);
90 int	ffs_sbsearch(void *, struct fs **, int, struct malloc_type *,
91 	    int (*)(void *, off_t, void **, int));
92 int	ffs_reallocblks(struct vop_reallocblks_args *);
93 int	ffs_realloccg(struct inode *, ufs2_daddr_t, ufs2_daddr_t,
94 	    ufs2_daddr_t, int, int, int, struct ucred *, struct buf **);
95 int	ffs_reload(struct mount *, int);
96 int	ffs_sbget(void *, struct fs **, off_t, int, struct malloc_type *,
97 	    int (*)(void *, off_t, void **, int));
98 int	ffs_sbput(void *, struct fs *, off_t, int (*)(void *, off_t, void *,
99 	    int));
100 int	ffs_sbupdate(struct ufsmount *, int, int);
101 void	ffs_setblock(struct fs *, uint8_t *, ufs1_daddr_t);
102 int	ffs_snapblkfree(struct fs *, struct vnode *, ufs2_daddr_t, long, ino_t,
103 	    __enum_uint8(vtype), struct workhead *);
104 void	ffs_snapremove(struct vnode *vp);
105 int	ffs_snapshot(struct mount *mp, char *snapfile);
106 void	ffs_snapshot_mount(struct mount *mp);
107 void	ffs_snapshot_unmount(struct mount *mp);
108 void	ffs_susp_initialize(void);
109 void	ffs_susp_uninitialize(void);
110 void	ffs_sync_snap(struct mount *, int);
111 int	ffs_syncvnode(struct vnode *vp, int waitfor, int flags);
112 int	ffs_truncate(struct vnode *, off_t, int, struct ucred *);
113 int	ffs_update(struct vnode *, int);
114 void	ffs_update_dinode_ckhash(struct fs *, struct ufs2_dinode *);
115 int	ffs_verify_dinode_ckhash(struct fs *, struct ufs2_dinode *);
116 int	ffs_valloc(struct vnode *, int, struct ucred *, struct vnode **);
117 int	ffs_vfree(struct vnode *, ino_t, int);
118 vfs_vget_t ffs_vget;
119 int	ffs_vgetf(struct mount *, ino_t, int, struct vnode **, int);
120 void	process_deferred_inactive(struct mount *mp);
121 int	ffs_fsfail_cleanup(struct ufsmount *, int);
122 int	ffs_fsfail_cleanup_locked(struct ufsmount *, int);
123 int	ffs_breadz(struct ufsmount *, struct vnode *, daddr_t, daddr_t, int,
124 	    daddr_t *, int *, int, struct ucred *, int, void (*)(struct buf *),
125 	    struct buf **);
126 
127 /*
128  * Flags to ffs_vgetf
129  */
130 #define	FFSV_FORCEINSMQ		0x0001	/* Force insertion into mount list */
131 #define	FFSV_REPLACE		0x0002	/* Replace existing vnode */
132 #define	FFSV_REPLACE_DOOMED	0x0004	/* Replace existing vnode if it is
133 					   doomed */
134 #define	FFSV_FORCEINODEDEP	0x0008	/* Force allocation of inodedep, ignore
135 					   MNT_SOFTDEP */
136 #define	FFSV_NEWINODE		0x0010	/* Newly allocated inode */
137 
138 /*
139  * Flags to ffs_reload
140  */
141 #define	FFSR_FORCE	0x0001
142 #define	FFSR_UNSUSPEND	0x0002
143 
144 /*
145  * Definitions for TRIM interface
146  *
147  * Special keys and recommended hash table size
148  */
149 #define	NOTRIM_KEY	1	/* never written, so don't call trim for it */
150 #define	SINGLETON_KEY	2	/* only block being freed, so trim it now */
151 #define	FIRST_VALID_KEY	3	/* first valid key describing a block range */
152 #define	MAXTRIMIO	1024	/* maximum expected outstanding trim requests */
153 
154 extern struct vop_vector ffs_vnodeops1;
155 extern struct vop_vector ffs_fifoops1;
156 extern struct vop_vector ffs_vnodeops2;
157 extern struct vop_vector ffs_fifoops2;
158 
159 /*
160  * Soft update function prototypes.
161  */
162 
163 int	softdep_check_suspend(struct mount *, struct vnode *,
164 	  int, int, int, int);
165 void	softdep_get_depcounts(struct mount *, int *, int *);
166 void	softdep_initialize(void);
167 void	softdep_uninitialize(void);
168 int	softdep_mount(struct vnode *, struct mount *, struct fs *,
169 	    struct ucred *);
170 void	softdep_unmount(struct mount *);
171 void	softdep_handle_error(struct buf *);
172 int	softdep_move_dependencies(struct buf *, struct buf *);
173 int	softdep_flushworklist(struct mount *, int *, struct thread *);
174 int	softdep_flushfiles(struct mount *, int, struct thread *);
175 void	softdep_update_inodeblock(struct inode *, struct buf *, int);
176 void	softdep_load_inodeblock(struct inode *);
177 void	softdep_freefile(struct vnode *, ino_t, int);
178 int	softdep_request_cleanup(struct fs *, struct vnode *,
179 	    struct ucred *, int);
180 int	softdep_prerename(struct vnode *, struct vnode *, struct vnode *,
181 	    struct vnode *);
182 int	softdep_prelink(struct vnode *, struct vnode *,
183 	    struct componentname *);
184 void	softdep_setup_freeblocks(struct inode *, off_t, int);
185 void	softdep_setup_inomapdep(struct buf *, struct inode *, ino_t, int);
186 void	softdep_setup_blkmapdep(struct buf *, struct mount *, ufs2_daddr_t,
187 	    int, int);
188 void	softdep_setup_allocdirect(struct inode *, ufs_lbn_t, ufs2_daddr_t,
189 	    ufs2_daddr_t, long, long, struct buf *);
190 void	softdep_setup_allocext(struct inode *, ufs_lbn_t, ufs2_daddr_t,
191 	    ufs2_daddr_t, long, long, struct buf *);
192 void	softdep_setup_allocindir_meta(struct buf *, struct inode *,
193 	    struct buf *, int, ufs2_daddr_t);
194 void	softdep_setup_allocindir_page(struct inode *, ufs_lbn_t,
195 	    struct buf *, int, ufs2_daddr_t, ufs2_daddr_t, struct buf *);
196 void	softdep_setup_blkfree(struct mount *, struct buf *, ufs2_daddr_t, int,
197 	    struct workhead *, bool);
198 void	softdep_setup_inofree(struct mount *, struct buf *, ino_t,
199 	    struct workhead *, bool);
200 void	softdep_setup_sbupdate(struct ufsmount *, struct fs *, struct buf *);
201 void	softdep_fsync_mountdev(struct vnode *);
202 int	softdep_sync_metadata(struct vnode *);
203 int	softdep_sync_buf(struct vnode *, struct buf *, int);
204 int     softdep_fsync(struct vnode *);
205 int	softdep_prealloc(struct vnode *, int);
206 int	softdep_journal_lookup(struct mount *, struct vnode **);
207 void	softdep_journal_freeblocks(struct inode *, struct ucred *, off_t, int);
208 void	softdep_journal_fsync(struct inode *);
209 void	softdep_buf_append(struct buf *, struct workhead *);
210 void	softdep_inode_append(struct inode *, struct ucred *, struct workhead *);
211 void	softdep_freework(struct workhead *);
212 
213 /*
214  * Things to request flushing in softdep_request_cleanup()
215  */
216 #define	FLUSH_INODES		1
217 #define	FLUSH_INODES_WAIT	2
218 #define	FLUSH_BLOCKS		3
219 #define	FLUSH_BLOCKS_WAIT	4
220 /*
221  * Flag to ffs_syncvnode() to request flushing of data only,
222  * but skip the ffs_update() on the inode itself. Used to avoid
223  * deadlock when flushing snapshot inodes while holding snaplk.
224  */
225 #define	NO_INO_UPDT		0x00000001
226 /*
227  * Request data sync only from ffs_syncvnode(), not touching even more
228  * metadata than NO_INO_UPDT.
229  */
230 #define	DATA_ONLY		0x00000002
231 
232 int	ffs_rdonly(struct inode *);
233 
234 TAILQ_HEAD(snaphead, inode);
235 
236 struct snapdata {
237 	LIST_ENTRY(snapdata) sn_link;
238 	struct snaphead sn_head;
239 	daddr_t sn_listsize;
240 	daddr_t *sn_blklist;
241 	struct lock sn_lock;
242 };
243 
244 #endif /* _KERNEL */
245 
246 #endif /* !_UFS_FFS_EXTERN_H */
247