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