sys/ufs/ffs/ffs_extern.h

   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 int     ffs_blkatoff(struct vnode *, off_t, char **, struct buf **);
  65 void    ffs_blkfree(struct ufsmount *, struct fs *, struct vnode *,
  66             ufs2_daddr_t, long, ino_t, enum vtype, struct workhead *, u_long);
  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 *, u_long);
  70 u_long  ffs_blkrelease_start(struct ufsmount *, struct vnode *, ino_t);
  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, 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_load_inode(struct buf *, struct inode *, struct fs *, ino_t);
  86 void    ffs_oldfscompat_write(struct fs *, struct ufsmount *);
  87 int     ffs_own_mount(const struct mount *mp);
  88 int     ffs_reallocblks(struct vop_reallocblks_args *);
  89 int     ffs_realloccg(struct inode *, ufs2_daddr_t, ufs2_daddr_t,
  90             ufs2_daddr_t, int, int, int, struct ucred *, struct buf **);
  91 int     ffs_reload(struct mount *, struct thread *, int);
  92 int     ffs_sbget(void *, struct fs **, off_t, struct malloc_type *,
  93             int (*)(void *, off_t, void **, int));
  94 int     ffs_sbput(void *, struct fs *, off_t, int (*)(void *, off_t, void *,
  95             int));
  96 int     ffs_sbupdate(struct ufsmount *, int, int);
  97 void    ffs_setblock(struct fs *, u_char *, ufs1_daddr_t);
  98 int     ffs_snapblkfree(struct fs *, struct vnode *, ufs2_daddr_t, long, ino_t,
  99             enum vtype, struct workhead *);
 100 void    ffs_snapremove(struct vnode *vp);
 101 int     ffs_snapshot(struct mount *mp, char *snapfile);
 102 void    ffs_snapshot_mount(struct mount *mp);
 103 void    ffs_snapshot_unmount(struct mount *mp);
 104 void    ffs_susp_initialize(void);
 105 void    ffs_susp_uninitialize(void);
 106 void    ffs_sync_snap(struct mount *, int);
 107 int     ffs_syncvnode(struct vnode *vp, int waitfor, int flags);
 108 int     ffs_truncate(struct vnode *, off_t, int, struct ucred *);
 109 int     ffs_update(struct vnode *, int);
 110 int     ffs_valloc(struct vnode *, int, struct ucred *, struct vnode **);
 111 int     ffs_vfree(struct vnode *, ino_t, int);
 112 vfs_vget_t ffs_vget;
 113 int     ffs_vgetf(struct mount *, ino_t, int, struct vnode **, int);
 114 void    process_deferred_inactive(struct mount *mp);
 115
 116 /*
 117  * Flags to ffs_vgetf
 118  */
 119 #define FFSV_FORCEINSMQ 0x0001
 120
 121 /*
 122  * Flags to ffs_reload
 123  */
 124 #define FFSR_FORCE      0x0001
 125 #define FFSR_UNSUSPEND  0x0002
 126
 127 /*
 128  * Definitions for TRIM interface
 129  *
 130  * Special keys and recommended hash table size
 131  */
 132 #define NOTRIM_KEY      1       /* never written, so don't call trim for it */
 133 #define SINGLETON_KEY   2       /* only block being freed, so trim it now */
 134 #define FIRST_VALID_KEY 3       /* first valid key describing a block range */
 135 #define MAXTRIMIO       1024    /* maximum expected outstanding trim requests */
 136
 137 extern struct vop_vector ffs_vnodeops1;
 138 extern struct vop_vector ffs_fifoops1;
 139 extern struct vop_vector ffs_vnodeops2;
 140 extern struct vop_vector ffs_fifoops2;
 141
 142 /*
 143  * Soft update function prototypes.
 144  */
 145
 146 int     softdep_check_suspend(struct mount *, struct vnode *,
 147           int, int, int, int);
 148 void    softdep_get_depcounts(struct mount *, int *, int *);
 149 void    softdep_initialize(void);
 150 void    softdep_uninitialize(void);
 151 int     softdep_mount(struct vnode *, struct mount *, struct fs *,
 152             struct ucred *);
 153 void    softdep_unmount(struct mount *);
 154 int     softdep_move_dependencies(struct buf *, struct buf *);
 155 int     softdep_flushworklist(struct mount *, int *, struct thread *);
 156 int     softdep_flushfiles(struct mount *, int, struct thread *);
 157 void    softdep_update_inodeblock(struct inode *, struct buf *, int);
 158 void    softdep_load_inodeblock(struct inode *);
 159 void    softdep_freefile(struct vnode *, ino_t, int);
 160 int     softdep_request_cleanup(struct fs *, struct vnode *,
 161             struct ucred *, int);
 162 void    softdep_setup_freeblocks(struct inode *, off_t, int);
 163 void    softdep_setup_inomapdep(struct buf *, struct inode *, ino_t, int);
 164 void    softdep_setup_blkmapdep(struct buf *, struct mount *, ufs2_daddr_t,
 165             int, int);
 166 void    softdep_setup_allocdirect(struct inode *, ufs_lbn_t, ufs2_daddr_t,
 167             ufs2_daddr_t, long, long, struct buf *);
 168 void    softdep_setup_allocext(struct inode *, ufs_lbn_t, ufs2_daddr_t,
 169             ufs2_daddr_t, long, long, struct buf *);
 170 void    softdep_setup_allocindir_meta(struct buf *, struct inode *,
 171             struct buf *, int, ufs2_daddr_t);
 172 void    softdep_setup_allocindir_page(struct inode *, ufs_lbn_t,
 173             struct buf *, int, ufs2_daddr_t, ufs2_daddr_t, struct buf *);
 174 void    softdep_setup_blkfree(struct mount *, struct buf *, ufs2_daddr_t, int,
 175             struct workhead *);
 176 void    softdep_setup_inofree(struct mount *, struct buf *, ino_t,
 177             struct workhead *);
 178 void    softdep_setup_sbupdate(struct ufsmount *, struct fs *, struct buf *);
 179 void    softdep_fsync_mountdev(struct vnode *);
 180 int     softdep_sync_metadata(struct vnode *);
 181 int     softdep_sync_buf(struct vnode *, struct buf *, int);
 182 int     softdep_fsync(struct vnode *);
 183 int     softdep_prealloc(struct vnode *, int);
 184 int     softdep_journal_lookup(struct mount *, struct vnode **);
 185 void    softdep_journal_freeblocks(struct inode *, struct ucred *, off_t, int);
 186 void    softdep_journal_fsync(struct inode *);
 187 void    softdep_buf_append(struct buf *, struct workhead *);
 188 void    softdep_inode_append(struct inode *, struct ucred *, struct workhead *);
 189 void    softdep_freework(struct workhead *);
 190
 191
 192 /*
 193  * Things to request flushing in softdep_request_cleanup()
 194  */
 195 #define FLUSH_INODES            1
 196 #define FLUSH_INODES_WAIT       2
 197 #define FLUSH_BLOCKS            3
 198 #define FLUSH_BLOCKS_WAIT       4
 199 /*
 200  * Flag to ffs_syncvnode() to request flushing of data only,
 201  * but skip the ffs_update() on the inode itself. Used to avoid
 202  * deadlock when flushing snapshot inodes while holding snaplk.
 203  */
 204 #define NO_INO_UPDT             0x00000001
 205 /*
 206  * Request data sync only from ffs_syncvnode(), not touching even more
 207  * metadata than NO_INO_UPDT.
 208  */
 209 #define DATA_ONLY               0x00000002
 210
 211 int     ffs_rdonly(struct inode *);
 212
 213 TAILQ_HEAD(snaphead, inode);
 214
 215 struct snapdata {
 216         LIST_ENTRY(snapdata) sn_link;
 217         struct snaphead sn_head;
 218         daddr_t sn_listsize;
 219         daddr_t *sn_blklist;
 220         struct lock sn_lock;
 221 };
 222
 223 #endif /* _KERNEL */
 224
 225 #endif /* !_UFS_FFS_EXTERN_H */