2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1991, 1993, 1994
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
32 #ifndef _UFS_FFS_EXTERN_H
33 #define _UFS_FFS_EXTERN_H
36 #error "No user-serving parts inside"
51 struct vop_fsync_args;
52 struct vop_reallocblks_args;
55 int ffs_alloc(struct inode *, ufs2_daddr_t, ufs2_daddr_t, int, int,
56 struct ucred *, ufs2_daddr_t *);
57 int 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);
59 int 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);
61 void ffs_blkfree(struct ufsmount *, struct fs *, struct vnode *,
62 ufs2_daddr_t, long, ino_t, __enum_uint8(vtype), struct workhead *,
64 ufs2_daddr_t ffs_blkpref_ufs1(struct inode *, ufs_lbn_t, int, ufs1_daddr_t *);
65 ufs2_daddr_t ffs_blkpref_ufs2(struct inode *, ufs_lbn_t, int, ufs2_daddr_t *);
66 void ffs_blkrelease_finish(struct ufsmount *, uint64_t);
67 uint64_t ffs_blkrelease_start(struct ufsmount *, struct vnode *, ino_t);
68 uint32_t ffs_calc_sbhash(struct fs *);
69 int ffs_checkfreefile(struct fs *, struct vnode *, ino_t);
70 void ffs_clrblock(struct fs *, uint8_t *, ufs1_daddr_t);
71 void ffs_clusteracct(struct fs *, struct cg *, ufs1_daddr_t, int);
72 void ffs_bdflush(struct bufobj *, struct buf *);
73 int ffs_copyonwrite(struct vnode *, struct buf *);
74 int ffs_flushfiles(struct mount *, int, struct thread *);
75 void ffs_fragacct(struct fs *, int, int32_t [], int);
76 int ffs_freefile(struct ufsmount *, struct fs *, struct vnode *, ino_t,
77 int, struct workhead *);
78 void ffs_fserr(struct fs *, ino_t, char *);
79 int ffs_getcg(struct fs *, struct vnode *, uint64_t, int, struct buf **,
81 int ffs_inotovp(struct mount *, ino_t, uint64_t, int, struct vnode **,
83 int ffs_isblock(struct fs *, uint8_t *, ufs1_daddr_t);
84 int ffs_isfreeblock(struct fs *, uint8_t *, ufs1_daddr_t);
85 void ffs_oldfscompat_write(struct fs *, struct ufsmount *);
86 int ffs_own_mount(const struct mount *mp);
87 int ffs_sbsearch(void *, struct fs **, int, struct malloc_type *,
88 int (*)(void *, off_t, void **, int));
89 int ffs_reallocblks(struct vop_reallocblks_args *);
90 int ffs_realloccg(struct inode *, ufs2_daddr_t, ufs2_daddr_t,
91 ufs2_daddr_t, int, int, int, struct ucred *, struct buf **);
92 int ffs_reload(struct mount *, int);
93 int ffs_sbget(void *, struct fs **, off_t, int, struct malloc_type *,
94 int (*)(void *, off_t, void **, int));
95 int ffs_sbput(void *, struct fs *, off_t, int (*)(void *, off_t, void *,
97 int ffs_sbupdate(struct ufsmount *, int, int);
98 void ffs_setblock(struct fs *, uint8_t *, ufs1_daddr_t);
99 int ffs_snapblkfree(struct fs *, struct vnode *, ufs2_daddr_t, long, ino_t,
100 __enum_uint8(vtype), struct workhead *);
101 void ffs_snapremove(struct vnode *vp);
102 int ffs_snapshot(struct mount *mp, char *snapfile);
103 void ffs_snapshot_mount(struct mount *mp);
104 void ffs_snapshot_unmount(struct mount *mp);
105 void ffs_susp_initialize(void);
106 void ffs_susp_uninitialize(void);
107 void ffs_sync_snap(struct mount *, int);
108 int ffs_syncvnode(struct vnode *vp, int waitfor, int flags);
109 int ffs_truncate(struct vnode *, off_t, int, struct ucred *);
110 int ffs_update(struct vnode *, int);
111 void ffs_update_dinode_ckhash(struct fs *, struct ufs2_dinode *);
112 int ffs_verify_dinode_ckhash(struct fs *, struct ufs2_dinode *);
113 int ffs_valloc(struct vnode *, int, struct ucred *, struct vnode **);
114 int ffs_vfree(struct vnode *, ino_t, int);
116 int ffs_vgetf(struct mount *, ino_t, int, struct vnode **, int);
117 void process_deferred_inactive(struct mount *mp);
118 int ffs_fsfail_cleanup(struct ufsmount *, int);
119 int ffs_fsfail_cleanup_locked(struct ufsmount *, int);
120 int ffs_breadz(struct ufsmount *, struct vnode *, daddr_t, daddr_t, int,
121 daddr_t *, int *, int, struct ucred *, int, void (*)(struct buf *),
127 #define FFSV_FORCEINSMQ 0x0001 /* Force insertion into mount list */
128 #define FFSV_REPLACE 0x0002 /* Replace existing vnode */
129 #define FFSV_REPLACE_DOOMED 0x0004 /* Replace existing vnode if it is
131 #define FFSV_FORCEINODEDEP 0x0008 /* Force allocation of inodedep, ignore
133 #define FFSV_NEWINODE 0x0010 /* Newly allocated inode */
136 * Flags to ffs_reload
138 #define FFSR_FORCE 0x0001
139 #define FFSR_UNSUSPEND 0x0002
142 * Definitions for TRIM interface
144 * Special keys and recommended hash table size
146 #define NOTRIM_KEY 1 /* never written, so don't call trim for it */
147 #define SINGLETON_KEY 2 /* only block being freed, so trim it now */
148 #define FIRST_VALID_KEY 3 /* first valid key describing a block range */
149 #define MAXTRIMIO 1024 /* maximum expected outstanding trim requests */
151 extern struct vop_vector ffs_vnodeops1;
152 extern struct vop_vector ffs_fifoops1;
153 extern struct vop_vector ffs_vnodeops2;
154 extern struct vop_vector ffs_fifoops2;
157 * Soft update function prototypes.
160 int softdep_check_suspend(struct mount *, struct vnode *,
162 void softdep_get_depcounts(struct mount *, int *, int *);
163 void softdep_initialize(void);
164 void softdep_uninitialize(void);
165 int softdep_mount(struct vnode *, struct mount *, struct fs *,
167 void softdep_unmount(struct mount *);
168 void softdep_handle_error(struct buf *);
169 int softdep_move_dependencies(struct buf *, struct buf *);
170 int softdep_flushworklist(struct mount *, int *, struct thread *);
171 int softdep_flushfiles(struct mount *, int, struct thread *);
172 void softdep_update_inodeblock(struct inode *, struct buf *, int);
173 void softdep_load_inodeblock(struct inode *);
174 void softdep_freefile(struct vnode *, ino_t, int);
175 int softdep_request_cleanup(struct fs *, struct vnode *,
176 struct ucred *, int);
177 int softdep_prerename(struct vnode *, struct vnode *, struct vnode *,
179 int softdep_prelink(struct vnode *, struct vnode *,
180 struct componentname *);
181 void softdep_setup_freeblocks(struct inode *, off_t, int);
182 void softdep_setup_inomapdep(struct buf *, struct inode *, ino_t, int);
183 void softdep_setup_blkmapdep(struct buf *, struct mount *, ufs2_daddr_t,
185 void softdep_setup_allocdirect(struct inode *, ufs_lbn_t, ufs2_daddr_t,
186 ufs2_daddr_t, long, long, struct buf *);
187 void softdep_setup_allocext(struct inode *, ufs_lbn_t, ufs2_daddr_t,
188 ufs2_daddr_t, long, long, struct buf *);
189 void softdep_setup_allocindir_meta(struct buf *, struct inode *,
190 struct buf *, int, ufs2_daddr_t);
191 void softdep_setup_allocindir_page(struct inode *, ufs_lbn_t,
192 struct buf *, int, ufs2_daddr_t, ufs2_daddr_t, struct buf *);
193 void softdep_setup_blkfree(struct mount *, struct buf *, ufs2_daddr_t, int,
194 struct workhead *, bool);
195 void softdep_setup_inofree(struct mount *, struct buf *, ino_t,
196 struct workhead *, bool);
197 void softdep_setup_sbupdate(struct ufsmount *, struct fs *, struct buf *);
198 void softdep_fsync_mountdev(struct vnode *);
199 int softdep_sync_metadata(struct vnode *);
200 int softdep_sync_buf(struct vnode *, struct buf *, int);
201 int softdep_fsync(struct vnode *);
202 int softdep_prealloc(struct vnode *, int);
203 int softdep_journal_lookup(struct mount *, struct vnode **);
204 void softdep_journal_freeblocks(struct inode *, struct ucred *, off_t, int);
205 void softdep_journal_fsync(struct inode *);
206 void softdep_buf_append(struct buf *, struct workhead *);
207 void softdep_inode_append(struct inode *, struct ucred *, struct workhead *);
208 void softdep_freework(struct workhead *);
211 * Things to request flushing in softdep_request_cleanup()
213 #define FLUSH_INODES 1
214 #define FLUSH_INODES_WAIT 2
215 #define FLUSH_BLOCKS 3
216 #define FLUSH_BLOCKS_WAIT 4
218 * Flag to ffs_syncvnode() to request flushing of data only,
219 * but skip the ffs_update() on the inode itself. Used to avoid
220 * deadlock when flushing snapshot inodes while holding snaplk.
222 #define NO_INO_UPDT 0x00000001
224 * Request data sync only from ffs_syncvnode(), not touching even more
225 * metadata than NO_INO_UPDT.
227 #define DATA_ONLY 0x00000002
229 int ffs_rdonly(struct inode *);
231 TAILQ_HEAD(snaphead, inode);
234 LIST_ENTRY(snapdata) sn_link;
235 struct snaphead sn_head;
243 #endif /* !_UFS_FFS_EXTERN_H */