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