sys/ufs/ufs/ufs_bmap.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1989, 1991, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  * (c) UNIX System Laboratories, Inc.
   7  * All or some portions of this file are derived from material licensed
   8  * to the University of California by American Telephone and Telegraph
   9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  10  * the permission of UNIX System Laboratories, Inc.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)ufs_bmap.c  8.7 (Berkeley) 3/21/95
  37  */
  38
  39 #include <sys/cdefs.h>
  40 __FBSDID("$FreeBSD$");
  41
  42 #include <sys/param.h>
  43 #include <sys/systm.h>
  44 #include <sys/bio.h>
  45 #include <sys/buf.h>
  46 #include <sys/proc.h>
  47 #include <sys/vnode.h>
  48 #include <sys/mount.h>
  49 #include <sys/racct.h>
  50 #include <sys/resourcevar.h>
  51 #include <sys/stat.h>
  52
  53 #include <ufs/ufs/extattr.h>
  54 #include <ufs/ufs/quota.h>
  55 #include <ufs/ufs/inode.h>
  56 #include <ufs/ufs/ufsmount.h>
  57 #include <ufs/ufs/ufs_extern.h>
  58
  59 static ufs_lbn_t lbn_count(struct ufsmount *, int);
  60 static int readindir(struct vnode *, ufs_lbn_t, ufs2_daddr_t, struct buf **);
  61
  62 /*
  63  * Bmap converts the logical block number of a file to its physical block
  64  * number on the disk. The conversion is done by using the logical block
  65  * number to index into the array of block pointers described by the dinode.
  66  */
  67 int
  68 ufs_bmap(ap)
  69         struct vop_bmap_args /* {
  70                 struct vnode *a_vp;
  71                 daddr_t a_bn;
  72                 struct bufobj **a_bop;
  73                 daddr_t *a_bnp;
  74                 int *a_runp;
  75                 int *a_runb;
  76         } */ *ap;
  77 {
  78         ufs2_daddr_t blkno;
  79         int error;
  80
  81         /*
  82          * Check for underlying vnode requests and ensure that logical
  83          * to physical mapping is requested.
  84          */
  85         if (ap->a_bop != NULL)
  86                 *ap->a_bop = &VFSTOUFS(ap->a_vp->v_mount)->um_devvp->v_bufobj;
  87         if (ap->a_bnp == NULL)
  88                 return (0);
  89
  90         error = ufs_bmaparray(ap->a_vp, ap->a_bn, &blkno, NULL,
  91             ap->a_runp, ap->a_runb);
  92         *ap->a_bnp = blkno;
  93         return (error);
  94 }
  95
  96 static int
  97 readindir(vp, lbn, daddr, bpp)
  98         struct vnode *vp;
  99         ufs_lbn_t lbn;
 100         ufs2_daddr_t daddr;
 101         struct buf **bpp;
 102 {
 103         struct buf *bp;
 104         struct mount *mp;
 105         struct ufsmount *ump;
 106         int error;
 107
 108         mp = vp->v_mount;
 109         ump = VFSTOUFS(mp);
 110
 111         bp = getblk(vp, lbn, mp->mnt_stat.f_iosize, 0, 0, 0);
 112         if ((bp->b_flags & B_CACHE) == 0) {
 113                 KASSERT(daddr != 0,
 114                     ("readindir: indirect block not in cache"));
 115
 116                 bp->b_blkno = blkptrtodb(ump, daddr);
 117                 bp->b_iocmd = BIO_READ;
 118                 bp->b_flags &= ~B_INVAL;
 119                 bp->b_ioflags &= ~BIO_ERROR;
 120                 vfs_busy_pages(bp, 0);
 121                 bp->b_iooffset = dbtob(bp->b_blkno);
 122                 bstrategy(bp);
 123 #ifdef RACCT
 124                 if (racct_enable) {
 125                         PROC_LOCK(curproc);
 126                         racct_add_buf(curproc, bp, 0);
 127                         PROC_UNLOCK(curproc);
 128                 }
 129 #endif
 130                 curthread->td_ru.ru_inblock++;
 131                 error = bufwait(bp);
 132                 if (error != 0) {
 133                         brelse(bp);
 134                         return (error);
 135                 }
 136         }
 137         *bpp = bp;
 138         return (0);
 139 }
 140
 141 /*
 142  * Indirect blocks are now on the vnode for the file.  They are given negative
 143  * logical block numbers.  Indirect blocks are addressed by the negative
 144  * address of the first data block to which they point.  Double indirect blocks
 145  * are addressed by one less than the address of the first indirect block to
 146  * which they point.  Triple indirect blocks are addressed by one less than
 147  * the address of the first double indirect block to which they point.
 148  *
 149  * ufs_bmaparray does the bmap conversion, and if requested returns the
 150  * array of logical blocks which must be traversed to get to a block.
 151  * Each entry contains the offset into that block that gets you to the
 152  * next block and the disk address of the block (if it is assigned).
 153  */
 154
 155 int
 156 ufs_bmaparray(vp, bn, bnp, nbp, runp, runb)
 157         struct vnode *vp;
 158         ufs2_daddr_t bn;
 159         ufs2_daddr_t *bnp;
 160         struct buf *nbp;
 161         int *runp;
 162         int *runb;
 163 {
 164         struct inode *ip;
 165         struct buf *bp;
 166         struct ufsmount *ump;
 167         struct mount *mp;
 168         struct indir a[UFS_NIADDR+1], *ap;
 169         ufs2_daddr_t daddr;
 170         ufs_lbn_t metalbn;
 171         int error, num, maxrun = 0;
 172         int *nump;
 173
 174         ap = NULL;
 175         ip = VTOI(vp);
 176         mp = vp->v_mount;
 177         ump = VFSTOUFS(mp);
 178
 179         if (runp) {
 180                 maxrun = mp->mnt_iosize_max / mp->mnt_stat.f_iosize - 1;
 181                 *runp = 0;
 182         }
 183
 184         if (runb) {
 185                 *runb = 0;
 186         }
 187
 188         ap = a;
 189         nump = &num;
 190         error = ufs_getlbns(vp, bn, ap, nump);
 191         if (error)
 192                 return (error);
 193
 194         num = *nump;
 195         if (num == 0) {
 196                 if (bn >= 0 && bn < UFS_NDADDR) {
 197                         *bnp = blkptrtodb(ump, DIP(ip, i_db[bn]));
 198                 } else if (bn < 0 && bn >= -UFS_NXADDR) {
 199                         *bnp = blkptrtodb(ump, ip->i_din2->di_extb[-1 - bn]);
 200                         if (*bnp == 0)
 201                                 *bnp = -1;
 202                         if (nbp == NULL) {
 203                                 /* indirect block not found */
 204                                 return (EINVAL);
 205                         }
 206                         nbp->b_xflags |= BX_ALTDATA;
 207                         return (0);
 208                 } else {
 209                         /* blkno out of range */
 210                         return (EINVAL);
 211                 }
 212                 /*
 213                  * Since this is FFS independent code, we are out of
 214                  * scope for the definitions of BLK_NOCOPY and
 215                  * BLK_SNAP, but we do know that they will fall in
 216                  * the range 1..um_seqinc, so we use that test and
 217                  * return a request for a zeroed out buffer if attempts
 218                  * are made to read a BLK_NOCOPY or BLK_SNAP block.
 219                  */
 220                 if ((ip->i_flags & SF_SNAPSHOT) && DIP(ip, i_db[bn]) > 0 &&
 221                     DIP(ip, i_db[bn]) < ump->um_seqinc) {
 222                         *bnp = -1;
 223                 } else if (*bnp == 0) {
 224                         if (ip->i_flags & SF_SNAPSHOT)
 225                                 *bnp = blkptrtodb(ump, bn * ump->um_seqinc);
 226                         else
 227                                 *bnp = -1;
 228                 } else if (runp) {
 229                         ufs2_daddr_t bnb = bn;
 230                         for (++bn; bn < UFS_NDADDR && *runp < maxrun &&
 231                             is_sequential(ump, DIP(ip, i_db[bn - 1]),
 232                             DIP(ip, i_db[bn]));
 233                             ++bn, ++*runp);
 234                         bn = bnb;
 235                         if (runb && (bn > 0)) {
 236                                 for (--bn; (bn >= 0) && (*runb < maxrun) &&
 237                                         is_sequential(ump, DIP(ip, i_db[bn]),
 238                                                 DIP(ip, i_db[bn+1]));
 239                                                 --bn, ++*runb);
 240                         }
 241                 }
 242                 return (0);
 243         }
 244
 245         /* Get disk address out of indirect block array */
 246         daddr = DIP(ip, i_ib[ap->in_off]);
 247
 248         for (bp = NULL, ++ap; --num; ++ap) {
 249                 /*
 250                  * Exit the loop if there is no disk address assigned yet and
 251                  * the indirect block isn't in the cache, or if we were
 252                  * looking for an indirect block and we've found it.
 253                  */
 254
 255                 metalbn = ap->in_lbn;
 256                 if ((daddr == 0 && !incore(&vp->v_bufobj, metalbn)) || metalbn == bn)
 257                         break;
 258                 /*
 259                  * If we get here, we've either got the block in the cache
 260                  * or we have a disk address for it, go fetch it.
 261                  */
 262                 if (bp)
 263                         bqrelse(bp);
 264                 error = readindir(vp, metalbn, daddr, &bp);
 265                 if (error != 0)
 266                         return (error);
 267
 268                 if (I_IS_UFS1(ip))
 269                         daddr = ((ufs1_daddr_t *)bp->b_data)[ap->in_off];
 270                 else
 271                         daddr = ((ufs2_daddr_t *)bp->b_data)[ap->in_off];
 272                 if ((error = UFS_CHECK_BLKNO(mp, ip->i_number, daddr,
 273                      mp->mnt_stat.f_iosize)) != 0) {
 274                         bqrelse(bp);
 275                         return (error);
 276                 }
 277                 if (I_IS_UFS1(ip)) {
 278                         if (num == 1 && daddr && runp) {
 279                                 for (bn = ap->in_off + 1;
 280                                     bn < MNINDIR(ump) && *runp < maxrun &&
 281                                     is_sequential(ump,
 282                                     ((ufs1_daddr_t *)bp->b_data)[bn - 1],
 283                                     ((ufs1_daddr_t *)bp->b_data)[bn]);
 284                                     ++bn, ++*runp);
 285                                 bn = ap->in_off;
 286                                 if (runb && bn) {
 287                                         for (--bn; bn >= 0 && *runb < maxrun &&
 288                                             is_sequential(ump,
 289                                             ((ufs1_daddr_t *)bp->b_data)[bn],
 290                                             ((ufs1_daddr_t *)bp->b_data)[bn+1]);
 291                                             --bn, ++*runb);
 292                                 }
 293                         }
 294                         continue;
 295                 }
 296                 if (num == 1 && daddr && runp) {
 297                         for (bn = ap->in_off + 1;
 298                             bn < MNINDIR(ump) && *runp < maxrun &&
 299                             is_sequential(ump,
 300                             ((ufs2_daddr_t *)bp->b_data)[bn - 1],
 301                             ((ufs2_daddr_t *)bp->b_data)[bn]);
 302                             ++bn, ++*runp);
 303                         bn = ap->in_off;
 304                         if (runb && bn) {
 305                                 for (--bn; bn >= 0 && *runb < maxrun &&
 306                                     is_sequential(ump,
 307                                     ((ufs2_daddr_t *)bp->b_data)[bn],
 308                                     ((ufs2_daddr_t *)bp->b_data)[bn + 1]);
 309                                     --bn, ++*runb);
 310                         }
 311                 }
 312         }
 313         if (bp)
 314                 bqrelse(bp);
 315
 316         /*
 317          * Since this is FFS independent code, we are out of scope for the
 318          * definitions of BLK_NOCOPY and BLK_SNAP, but we do know that they
 319          * will fall in the range 1..um_seqinc, so we use that test and
 320          * return a request for a zeroed out buffer if attempts are made
 321          * to read a BLK_NOCOPY or BLK_SNAP block.
 322          */
 323         if ((ip->i_flags & SF_SNAPSHOT) && daddr > 0 && daddr < ump->um_seqinc){
 324                 *bnp = -1;
 325                 return (0);
 326         }
 327         *bnp = blkptrtodb(ump, daddr);
 328         if (*bnp == 0) {
 329                 if (ip->i_flags & SF_SNAPSHOT)
 330                         *bnp = blkptrtodb(ump, bn * ump->um_seqinc);
 331                 else
 332                         *bnp = -1;
 333         }
 334         return (0);
 335 }
 336
 337 static ufs_lbn_t
 338 lbn_count(ump, level)
 339         struct ufsmount *ump;
 340         int level;
 341 {
 342         ufs_lbn_t blockcnt;
 343
 344         for (blockcnt = 1; level > 0; level--)
 345                 blockcnt *= MNINDIR(ump);
 346         return (blockcnt);
 347 }
 348
 349 int
 350 ufs_bmap_seekdata(vp, offp)
 351         struct vnode *vp;
 352         off_t *offp;
 353 {
 354         struct buf *bp;
 355         struct indir a[UFS_NIADDR + 1], *ap;
 356         struct inode *ip;
 357         struct mount *mp;
 358         struct ufsmount *ump;
 359         ufs2_daddr_t bn, daddr, nextbn;
 360         uint64_t bsize;
 361         off_t numblks;
 362         int error, num, num1, off;
 363
 364         bp = NULL;
 365         error = 0;
 366         ip = VTOI(vp);
 367         mp = vp->v_mount;
 368         ump = VFSTOUFS(mp);
 369
 370         if (vp->v_type != VREG || (ip->i_flags & SF_SNAPSHOT) != 0)
 371                 return (EINVAL);
 372         if (*offp < 0 || *offp >= ip->i_size)
 373                 return (ENXIO);
 374
 375         bsize = mp->mnt_stat.f_iosize;
 376         for (bn = *offp / bsize, numblks = howmany(ip->i_size, bsize);
 377             bn < numblks; bn = nextbn) {
 378                 if (bn < UFS_NDADDR) {
 379                         daddr = DIP(ip, i_db[bn]);
 380                         if (daddr != 0)
 381                                 break;
 382                         nextbn = bn + 1;
 383                         continue;
 384                 }
 385
 386                 ap = a;
 387                 error = ufs_getlbns(vp, bn, ap, &num);
 388                 if (error != 0)
 389                         break;
 390                 MPASS(num >= 2);
 391                 daddr = DIP(ip, i_ib[ap->in_off]);
 392                 ap++, num--;
 393                 for (nextbn = UFS_NDADDR, num1 = num - 1; num1 > 0; num1--)
 394                         nextbn += lbn_count(ump, num1);
 395                 if (daddr == 0) {
 396                         nextbn += lbn_count(ump, num);
 397                         continue;
 398                 }
 399
 400                 for (; daddr != 0 && num > 0; ap++, num--) {
 401                         if (bp != NULL)
 402                                 bqrelse(bp);
 403                         error = readindir(vp, ap->in_lbn, daddr, &bp);
 404                         if (error != 0)
 405                                 return (error);
 406
 407                         /*
 408                          * Scan the indirect block until we find a non-zero
 409                          * pointer.
 410                          */
 411                         off = ap->in_off;
 412                         do {
 413                                 daddr = I_IS_UFS1(ip) ?
 414                                     ((ufs1_daddr_t *)bp->b_data)[off] :
 415                                     ((ufs2_daddr_t *)bp->b_data)[off];
 416                         } while (daddr == 0 && ++off < MNINDIR(ump));
 417                         nextbn += off * lbn_count(ump, num - 1);
 418
 419                         /*
 420                          * We need to recompute the LBNs of indirect
 421                          * blocks, so restart with the updated block offset.
 422                          */
 423                         if (off != ap->in_off)
 424                                 break;
 425                 }
 426                 if (num == 0) {
 427                         /*
 428                          * We found a data block.
 429                          */
 430                         bn = nextbn;
 431                         break;
 432                 }
 433         }
 434         if (bp != NULL)
 435                 bqrelse(bp);
 436         if (bn >= numblks)
 437                 error = ENXIO;
 438         if (error == 0 && *offp < bn * bsize)
 439                 *offp = bn * bsize;
 440         return (error);
 441 }
 442
 443 /*
 444  * Create an array of logical block number/offset pairs which represent the
 445  * path of indirect blocks required to access a data block.  The first "pair"
 446  * contains the logical block number of the appropriate single, double or
 447  * triple indirect block and the offset into the inode indirect block array.
 448  * Note, the logical block number of the inode single/double/triple indirect
 449  * block appears twice in the array, once with the offset into the i_ib and
 450  * once with the offset into the page itself.
 451  */
 452 int
 453 ufs_getlbns(vp, bn, ap, nump)
 454         struct vnode *vp;
 455         ufs2_daddr_t bn;
 456         struct indir *ap;
 457         int *nump;
 458 {
 459         ufs2_daddr_t blockcnt;
 460         ufs_lbn_t metalbn, realbn;
 461         struct ufsmount *ump;
 462         int i, numlevels, off;
 463
 464         ump = VFSTOUFS(vp->v_mount);
 465         if (nump)
 466                 *nump = 0;
 467         numlevels = 0;
 468         realbn = bn;
 469         if (bn < 0)
 470                 bn = -bn;
 471
 472         /* The first UFS_NDADDR blocks are direct blocks. */
 473         if (bn < UFS_NDADDR)
 474                 return (0);
 475
 476         /*
 477          * Determine the number of levels of indirection.  After this loop
 478          * is done, blockcnt indicates the number of data blocks possible
 479          * at the previous level of indirection, and UFS_NIADDR - i is the
 480          * number of levels of indirection needed to locate the requested block.
 481          */
 482         for (blockcnt = 1, i = UFS_NIADDR, bn -= UFS_NDADDR; ;
 483             i--, bn -= blockcnt) {
 484                 if (i == 0)
 485                         return (EFBIG);
 486                 blockcnt *= MNINDIR(ump);
 487                 if (bn < blockcnt)
 488                         break;
 489         }
 490
 491         /* Calculate the address of the first meta-block. */
 492         if (realbn >= 0)
 493                 metalbn = -(realbn - bn + UFS_NIADDR - i);
 494         else
 495                 metalbn = -(-realbn - bn + UFS_NIADDR - i);
 496
 497         /*
 498          * At each iteration, off is the offset into the bap array which is
 499          * an array of disk addresses at the current level of indirection.
 500          * The logical block number and the offset in that block are stored
 501          * into the argument array.
 502          */
 503         ap->in_lbn = metalbn;
 504         ap->in_off = off = UFS_NIADDR - i;
 505         ap++;
 506         for (++numlevels; i <= UFS_NIADDR; i++) {
 507                 /* If searching for a meta-data block, quit when found. */
 508                 if (metalbn == realbn)
 509                         break;
 510
 511                 blockcnt /= MNINDIR(ump);
 512                 off = (bn / blockcnt) % MNINDIR(ump);
 513
 514                 ++numlevels;
 515                 ap->in_lbn = metalbn;
 516                 ap->in_off = off;
 517                 ++ap;
 518
 519                 metalbn -= -1 + off * blockcnt;
 520         }
 521         if (nump)
 522                 *nump = numlevels;
 523         return (0);
 524 }