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