xref: /freebsd/sys/fs/ext2fs/ext2_extern.h (revision a4128aad8503277614f2d214011ef60a19447b83)
1 /*-
2  *  modified for EXT2FS support in Lites 1.1
3  *
4  *  Aug 1995, Godmar Back (gback@cs.utah.edu)
5  *  University of Utah, Department of Computer Science
6  */
7 /*-
8  * SPDX-License-Identifier: BSD-3-Clause
9  *
10  * Copyright (c) 1991, 1993, 1994
11  *	The Regents of the University of California.  All rights reserved.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  */
37 
38 #ifndef _FS_EXT2FS_EXT2_EXTERN_H_
39 #define	_FS_EXT2FS_EXT2_EXTERN_H_
40 
41 struct ext2fs_dinode;
42 struct ext2fs_direct_2;
43 struct ext2fs_direct_tail;
44 struct ext2fs_searchslot;
45 struct indir;
46 struct inode;
47 struct mount;
48 struct vfsconf;
49 struct vnode;
50 
51 int	ext2_add_entry(struct vnode *, struct ext2fs_direct_2 *);
52 int	ext2_alloc(struct inode *, daddr_t, e4fs_daddr_t, int,
53 	    struct ucred *, e4fs_daddr_t *);
54 e4fs_daddr_t ext2_alloc_meta(struct inode *ip);
55 int	ext2_balloc(struct inode *,
56 	    e2fs_lbn_t, int, struct ucred *, struct buf **, int);
57 int	ext2_blkatoff(struct vnode *, off_t, char **, struct buf **);
58 void	ext2_blkfree(struct inode *,  e4fs_daddr_t, long);
59 e4fs_daddr_t	ext2_blkpref(struct inode *, e2fs_lbn_t, int, e2fs_daddr_t *,
60 	    e2fs_daddr_t);
61 int	ext2_bmap(struct vop_bmap_args *);
62 int	ext2_bmaparray(struct vnode *, daddr_t, daddr_t *, int *, int *);
63 int	ext4_bmapext(struct vnode *, int32_t, int64_t *, int *, int *);
64 int	ext2_bmap_seekdata(struct vnode *, off_t *);
65 void	ext2_clusteracct(struct m_ext2fs *, char *, int, e4fs_daddr_t, int);
66 void	ext2_dirbad(struct inode *ip, doff_t offset, char *how);
67 int	ext2_ei2i(struct ext2fs_dinode *, struct inode *);
68 int	ext2_getlbns(struct vnode *, daddr_t, struct indir *, int *);
69 int	ext2_i2ei(struct inode *, struct ext2fs_dinode *);
70 void	ext2_itimes(struct vnode *vp);
71 int	ext2_reallocblks(struct vop_reallocblks_args *);
72 int	ext2_reclaim(struct vop_reclaim_args *);
73 int	ext2_truncate(struct vnode *, off_t, int, struct ucred *, struct thread *);
74 int	ext2_update(struct vnode *, int);
75 int	ext2_valloc(struct vnode *, int, struct ucred *, struct vnode **);
76 int	ext2_vfree(struct vnode *, ino_t, int);
77 int	ext2_vinit(struct mount *, struct vop_vector *, struct vnode **vpp);
78 int	ext2_lookup(struct vop_cachedlookup_args *);
79 int	ext2_readdir(struct vop_readdir_args *);
80 #ifdef EXT2FS_PRINT_EXTENTS
81 void	ext2_print_inode(struct inode *);
82 #endif
83 int	ext2_direnter(struct inode *,
84 		struct vnode *, struct componentname *);
85 int	ext2_dirremove(struct vnode *, struct componentname *);
86 int	ext2_dirrewrite(struct inode *,
87 		struct inode *, struct componentname *);
88 int	ext2_dirempty(struct inode *, ino_t, struct ucred *);
89 int	ext2_checkpath(struct inode *, struct inode *, struct ucred *);
90 int	ext2_cg_has_sb(struct m_ext2fs *fs, int cg);
91 uint64_t	ext2_cg_number_gdb(struct m_ext2fs *fs, int cg);
92 int	ext2_inactive(struct vop_inactive_args *);
93 int	ext2_htree_add_entry(struct vnode *, struct ext2fs_direct_2 *,
94 	    struct componentname *);
95 int	ext2_htree_create_index(struct vnode *, struct componentname *,
96 	    struct ext2fs_direct_2 *);
97 int	ext2_htree_has_idx(struct inode *);
98 int	ext2_htree_hash(const char *, int, uint32_t *, int, uint32_t *,
99 	    uint32_t *);
100 int	ext2_htree_lookup(struct inode *, const char *, int, struct buf **,
101 	    int *, doff_t *, doff_t *, doff_t *, struct ext2fs_searchslot *);
102 int	ext2_search_dirblock(struct inode *, void *, int *, const char *, int,
103 	    int *, doff_t *, doff_t *, doff_t *, struct ext2fs_searchslot *);
104 uint32_t	e2fs_gd_get_ndirs(struct ext2_gd *gd);
105 uint64_t	e2fs_gd_get_b_bitmap(struct ext2_gd *);
106 uint64_t	e2fs_gd_get_i_bitmap(struct ext2_gd *);
107 uint64_t	e2fs_gd_get_i_tables(struct ext2_gd *);
108 void	ext2_sb_csum_set_seed(struct m_ext2fs *);
109 int	ext2_sb_csum_verify(struct m_ext2fs *);
110 void	ext2_sb_csum_set(struct m_ext2fs *);
111 int	ext2_extattr_blk_csum_verify(struct inode *, struct buf *);
112 void	ext2_extattr_blk_csum_set(struct inode *, struct buf *);
113 int	ext2_dir_blk_csum_verify(struct inode *, struct buf *);
114 struct ext2fs_direct_tail	*ext2_dirent_get_tail(struct inode *ip,
115     struct ext2fs_direct_2 *ep);
116 void	ext2_dirent_csum_set(struct inode *, struct ext2fs_direct_2 *);
117 int	ext2_dirent_csum_verify(struct inode *ip, struct ext2fs_direct_2 *ep);
118 void	ext2_dx_csum_set(struct inode *, struct ext2fs_direct_2 *);
119 int	ext2_dx_csum_verify(struct inode *ip, struct ext2fs_direct_2 *ep);
120 int	ext2_extent_blk_csum_verify(struct inode *, void *);
121 void	ext2_extent_blk_csum_set(struct inode *, void *);
122 void	ext2_init_dirent_tail(struct ext2fs_direct_tail *);
123 int	ext2_is_dirent_tail(struct inode *, struct ext2fs_direct_2 *);
124 int	ext2_gd_i_bitmap_csum_verify(struct m_ext2fs *, int, struct buf *);
125 void	ext2_gd_i_bitmap_csum_set(struct m_ext2fs *, int, struct buf *);
126 int	ext2_gd_b_bitmap_csum_verify(struct m_ext2fs *, int, struct buf *);
127 void	ext2_gd_b_bitmap_csum_set(struct m_ext2fs *, int, struct buf *);
128 int	ext2_ei_csum_verify(struct inode *, struct ext2fs_dinode *);
129 void	ext2_ei_csum_set(struct inode *, struct ext2fs_dinode *);
130 int	ext2_gd_csum_verify(struct m_ext2fs *, struct cdev *);
131 void	ext2_gd_csum_set(struct m_ext2fs *);
132 
133 /* Flags to low-level allocation routines.
134  * The low 16-bits are reserved for IO_ flags from vnode.h.
135  *
136  * The BA_CLRBUF flag specifies that the existing content of the block
137  * will not be completely overwritten by the caller, so buffers for new
138  * blocks must be cleared and buffers for existing blocks must be read.
139  * When BA_CLRBUF is not set the buffer will be completely overwritten
140  * and there is no reason to clear them or to spend I/O fetching existing
141  * data. The BA_CLRBUF flag is handled in the ext2_balloc() functions.
142  */
143 #define	BA_CLRBUF	0x00010000	/* Clear invalid areas of buffer. */
144 #define	BA_SEQMASK	0x7F000000	/* Bits holding seq heuristic. */
145 #define	BA_SEQSHIFT	24
146 #define	BA_SEQMAX	0x7F
147 
148 extern struct vop_vector ext2_vnodeops;
149 extern struct vop_vector ext2_fifoops;
150 
151 #endif	/* !_FS_EXT2FS_EXT2_EXTERN_H_ */
152