xref: /freebsd/sys/fs/ext2fs/ext2_bmap.c (revision acc1a9ef8333c798c210fa94be6af4d5fe2dd794)
1 /*-
2  * Copyright (c) 1989, 1991, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  * (c) UNIX System Laboratories, Inc.
5  * All or some portions of this file are derived from material licensed
6  * to the University of California by American Telephone and Telegraph
7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8  * the permission of UNIX System Laboratories, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 4. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	@(#)ufs_bmap.c	8.7 (Berkeley) 3/21/95
35  * $FreeBSD$
36  */
37 
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/bio.h>
41 #include <sys/buf.h>
42 #include <sys/proc.h>
43 #include <sys/vnode.h>
44 #include <sys/mount.h>
45 #include <sys/resourcevar.h>
46 #include <sys/stat.h>
47 
48 #include <fs/ext2fs/inode.h>
49 #include <fs/ext2fs/fs.h>
50 #include <fs/ext2fs/ext2fs.h>
51 #include <fs/ext2fs/ext2_dinode.h>
52 #include <fs/ext2fs/ext2_extern.h>
53 #include <fs/ext2fs/ext2_mount.h>
54 
55 static int ext4_bmapext(struct vnode *, int32_t, int64_t *, int *, int *);
56 
57 /*
58  * Bmap converts the logical block number of a file to its physical block
59  * number on the disk. The conversion is done by using the logical block
60  * number to index into the array of block pointers described by the dinode.
61  */
62 int
63 ext2_bmap(struct vop_bmap_args *ap)
64 {
65 	daddr_t blkno;
66 	int error;
67 
68 	/*
69 	 * Check for underlying vnode requests and ensure that logical
70 	 * to physical mapping is requested.
71 	 */
72 	if (ap->a_bop != NULL)
73 		*ap->a_bop = &VTOI(ap->a_vp)->i_devvp->v_bufobj;
74 	if (ap->a_bnp == NULL)
75 		return (0);
76 
77 	if (VTOI(ap->a_vp)->i_flag & IN_E4EXTENTS)
78 		error = ext4_bmapext(ap->a_vp, ap->a_bn, &blkno,
79 		    ap->a_runp, ap->a_runb);
80 	else
81 		error = ext2_bmaparray(ap->a_vp, ap->a_bn, &blkno,
82 		    ap->a_runp, ap->a_runb);
83 	*ap->a_bnp = blkno;
84 	return (error);
85 }
86 
87 /*
88  * This function converts the logical block number of a file to
89  * its physical block number on the disk within ext4 extents.
90  */
91 static int
92 ext4_bmapext(struct vnode *vp, int32_t bn, int64_t *bnp, int *runp, int *runb)
93 {
94 	struct inode *ip;
95 	struct m_ext2fs *fs;
96 	struct ext4_extent *ep;
97 	struct ext4_extent_path path = { .ep_bp = NULL };
98 	daddr_t lbn;
99 	int ret = 0;
100 
101 	ip = VTOI(vp);
102 	fs = ip->i_e2fs;
103 	lbn = bn;
104 
105 	if (runp != NULL)
106 		*runp = 0;
107 
108 	if (runb != NULL)
109 		*runb = 0;
110 
111 	ext4_ext_find_extent(fs, ip, lbn, &path);
112 	if (path.ep_is_sparse) {
113 		*bnp = -1;
114 		if (runp != NULL)
115 			*runp = path.ep_sparse_ext.e_len -
116 			    (lbn - path.ep_sparse_ext.e_blk) - 1;
117 		if (runb != NULL)
118 			*runb = lbn - path.ep_sparse_ext.e_blk;
119 	} else {
120 		ep = path.ep_ext;
121 		if (ep == NULL)
122 			ret = EIO;
123 		else {
124 			*bnp = fsbtodb(fs, lbn - ep->e_blk +
125 			    (ep->e_start_lo | (daddr_t)ep->e_start_hi << 32));
126 
127 			if (*bnp == 0)
128 				*bnp = -1;
129 
130 			if (runp != NULL)
131 				*runp = ep->e_len - (lbn - ep->e_blk) - 1;
132 			if (runb != NULL)
133 				*runb = lbn - ep->e_blk;
134 		}
135 	}
136 
137 	if (path.ep_bp != NULL) {
138 		brelse(path.ep_bp);
139 		path.ep_bp = NULL;
140 	}
141 
142 	return (ret);
143 }
144 
145 /*
146  * Indirect blocks are now on the vnode for the file.  They are given negative
147  * logical block numbers.  Indirect blocks are addressed by the negative
148  * address of the first data block to which they point.  Double indirect blocks
149  * are addressed by one less than the address of the first indirect block to
150  * which they point.  Triple indirect blocks are addressed by one less than
151  * the address of the first double indirect block to which they point.
152  *
153  * ext2_bmaparray does the bmap conversion, and if requested returns the
154  * array of logical blocks which must be traversed to get to a block.
155  * Each entry contains the offset into that block that gets you to the
156  * next block and the disk address of the block (if it is assigned).
157  */
158 
159 int
160 ext2_bmaparray(struct vnode *vp, daddr_t bn, daddr_t *bnp, int *runp, int *runb)
161 {
162 	struct inode *ip;
163 	struct buf *bp;
164 	struct ext2mount *ump;
165 	struct mount *mp;
166 	struct indir a[NIADDR+1], *ap;
167 	daddr_t daddr;
168 	e2fs_lbn_t metalbn;
169 	int error, num, maxrun = 0, bsize;
170 	int *nump;
171 
172 	ap = NULL;
173 	ip = VTOI(vp);
174 	mp = vp->v_mount;
175 	ump = VFSTOEXT2(mp);
176 
177 	bsize = EXT2_BLOCK_SIZE(ump->um_e2fs);
178 
179 	if (runp) {
180 		maxrun = mp->mnt_iosize_max / bsize - 1;
181 		*runp = 0;
182 	}
183 
184 	if (runb) {
185 		*runb = 0;
186 	}
187 
188 
189 	ap = a;
190 	nump = &num;
191 	error = ext2_getlbns(vp, bn, ap, nump);
192 	if (error)
193 		return (error);
194 
195 	num = *nump;
196 	if (num == 0) {
197 		*bnp = blkptrtodb(ump, ip->i_db[bn]);
198 		if (*bnp == 0) {
199 			*bnp = -1;
200 		} else if (runp) {
201 			daddr_t bnb = bn;
202 			for (++bn; bn < NDADDR && *runp < maxrun &&
203 			    is_sequential(ump, ip->i_db[bn - 1], ip->i_db[bn]);
204 			    ++bn, ++*runp);
205 			bn = bnb;
206 			if (runb && (bn > 0)) {
207 				for (--bn; (bn >= 0) && (*runb < maxrun) &&
208 					is_sequential(ump, ip->i_db[bn],
209 						ip->i_db[bn + 1]);
210 						--bn, ++*runb);
211 			}
212 		}
213 		return (0);
214 	}
215 
216 
217 	/* Get disk address out of indirect block array */
218 	daddr = ip->i_ib[ap->in_off];
219 
220 	for (bp = NULL, ++ap; --num; ++ap) {
221 		/*
222 		 * Exit the loop if there is no disk address assigned yet and
223 		 * the indirect block isn't in the cache, or if we were
224 		 * looking for an indirect block and we've found it.
225 		 */
226 
227 		metalbn = ap->in_lbn;
228 		if ((daddr == 0 && !incore(&vp->v_bufobj, metalbn)) || metalbn == bn)
229 			break;
230 		/*
231 		 * If we get here, we've either got the block in the cache
232 		 * or we have a disk address for it, go fetch it.
233 		 */
234 		if (bp)
235 			bqrelse(bp);
236 
237 		bp = getblk(vp, metalbn, bsize, 0, 0, 0);
238 		if ((bp->b_flags & B_CACHE) == 0) {
239 #ifdef INVARIANTS
240 			if (!daddr)
241 				panic("ext2_bmaparray: indirect block not in cache");
242 #endif
243 			bp->b_blkno = blkptrtodb(ump, daddr);
244 			bp->b_iocmd = BIO_READ;
245 			bp->b_flags &= ~B_INVAL;
246 			bp->b_ioflags &= ~BIO_ERROR;
247 			vfs_busy_pages(bp, 0);
248 			bp->b_iooffset = dbtob(bp->b_blkno);
249 			bstrategy(bp);
250 			curthread->td_ru.ru_inblock++;
251 			error = bufwait(bp);
252 			if (error) {
253 				brelse(bp);
254 				return (error);
255 			}
256 		}
257 
258 		daddr = ((e2fs_daddr_t *)bp->b_data)[ap->in_off];
259 		if (num == 1 && daddr && runp) {
260 			for (bn = ap->in_off + 1;
261 			    bn < MNINDIR(ump) && *runp < maxrun &&
262 			    is_sequential(ump,
263 			    ((e2fs_daddr_t *)bp->b_data)[bn - 1],
264 			    ((e2fs_daddr_t *)bp->b_data)[bn]);
265 			    ++bn, ++*runp);
266 			bn = ap->in_off;
267 			if (runb && bn) {
268 				for (--bn; bn >= 0 && *runb < maxrun &&
269 					is_sequential(ump,
270 					((e2fs_daddr_t *)bp->b_data)[bn],
271 					((e2fs_daddr_t *)bp->b_data)[bn + 1]);
272 					--bn, ++*runb);
273 			}
274 		}
275 	}
276 	if (bp)
277 		bqrelse(bp);
278 
279 	/*
280 	 * Since this is FFS independent code, we are out of scope for the
281 	 * definitions of BLK_NOCOPY and BLK_SNAP, but we do know that they
282 	 * will fall in the range 1..um_seqinc, so we use that test and
283 	 * return a request for a zeroed out buffer if attempts are made
284 	 * to read a BLK_NOCOPY or BLK_SNAP block.
285 	 */
286 	if ((ip->i_flags & SF_SNAPSHOT) && daddr > 0 && daddr < ump->um_seqinc){
287 		*bnp = -1;
288 		return (0);
289 	}
290 	*bnp = blkptrtodb(ump, daddr);
291 	if (*bnp == 0) {
292 		*bnp = -1;
293 	}
294 	return (0);
295 }
296 
297 /*
298  * Create an array of logical block number/offset pairs which represent the
299  * path of indirect blocks required to access a data block.  The first "pair"
300  * contains the logical block number of the appropriate single, double or
301  * triple indirect block and the offset into the inode indirect block array.
302  * Note, the logical block number of the inode single/double/triple indirect
303  * block appears twice in the array, once with the offset into the i_ib and
304  * once with the offset into the page itself.
305  */
306 int
307 ext2_getlbns(struct vnode *vp, daddr_t bn, struct indir *ap, int *nump)
308 {
309 	long blockcnt;
310 	e2fs_lbn_t metalbn, realbn;
311 	struct ext2mount *ump;
312 	int i, numlevels, off;
313 	int64_t qblockcnt;
314 
315 	ump = VFSTOEXT2(vp->v_mount);
316 	if (nump)
317 		*nump = 0;
318 	numlevels = 0;
319 	realbn = bn;
320 	if ((long)bn < 0)
321 		bn = -(long)bn;
322 
323 	/* The first NDADDR blocks are direct blocks. */
324 	if (bn < NDADDR)
325 		return (0);
326 
327 	/*
328 	 * Determine the number of levels of indirection.  After this loop
329 	 * is done, blockcnt indicates the number of data blocks possible
330 	 * at the previous level of indirection, and NIADDR - i is the number
331 	 * of levels of indirection needed to locate the requested block.
332 	 */
333 	for (blockcnt = 1, i = NIADDR, bn -= NDADDR;; i--, bn -= blockcnt) {
334 		if (i == 0)
335 			return (EFBIG);
336 		/*
337 		 * Use int64_t's here to avoid overflow for triple indirect
338 		 * blocks when longs have 32 bits and the block size is more
339 		 * than 4K.
340 		 */
341 		qblockcnt = (int64_t)blockcnt * MNINDIR(ump);
342 		if (bn < qblockcnt)
343 			break;
344 		blockcnt = qblockcnt;
345 	}
346 
347 	/* Calculate the address of the first meta-block. */
348 	if (realbn >= 0)
349 		metalbn = -(realbn - bn + NIADDR - i);
350 	else
351 		metalbn = -(-realbn - bn + NIADDR - i);
352 
353 	/*
354 	 * At each iteration, off is the offset into the bap array which is
355 	 * an array of disk addresses at the current level of indirection.
356 	 * The logical block number and the offset in that block are stored
357 	 * into the argument array.
358 	 */
359 	ap->in_lbn = metalbn;
360 	ap->in_off = off = NIADDR - i;
361 	ap++;
362 	for (++numlevels; i <= NIADDR; i++) {
363 		/* If searching for a meta-data block, quit when found. */
364 		if (metalbn == realbn)
365 			break;
366 
367 		off = (bn / blockcnt) % MNINDIR(ump);
368 
369 		++numlevels;
370 		ap->in_lbn = metalbn;
371 		ap->in_off = off;
372 		++ap;
373 
374 		metalbn -= -1 + off * blockcnt;
375 		blockcnt /= MNINDIR(ump);
376 	}
377 	if (nump)
378 		*nump = numlevels;
379 	return (0);
380 }
381