sys/fs/msdosfs/msdosfs_fat.c

   1 /* $FreeBSD$ */
   2 /*      $NetBSD: msdosfs_fat.c,v 1.28 1997/11/17 15:36:49 ws Exp $      */
   3
   4 /*-
   5  * Copyright (C) 1994, 1995, 1997 Wolfgang Solfrank.
   6  * Copyright (C) 1994, 1995, 1997 TooLs GmbH.
   7  * All rights reserved.
   8  * Original code by Paul Popelka (paulp@uts.amdahl.com) (see below).
   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  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by TooLs GmbH.
  21  * 4. The name of TooLs GmbH may not be used to endorse or promote products
  22  *    derived from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
  25  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  26  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  27  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  29  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  30  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  31  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  32  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  33  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  */
  35 /*-
  36  * Written by Paul Popelka (paulp@uts.amdahl.com)
  37  *
  38  * You can do anything you want with this software, just don't say you wrote
  39  * it, and don't remove this notice.
  40  *
  41  * This software is provided "as is".
  42  *
  43  * The author supplies this software to be publicly redistributed on the
  44  * understanding that the author is not responsible for the correct
  45  * functioning of this software in any circumstances and is not liable for
  46  * any damages caused by this software.
  47  *
  48  * October 1992
  49  */
  50
  51 #include <sys/param.h>
  52 #include <sys/systm.h>
  53 #include <sys/buf.h>
  54 #include <sys/mount.h>
  55 #include <sys/vnode.h>
  56
  57 #include <fs/msdosfs/bpb.h>
  58 #include <fs/msdosfs/direntry.h>
  59 #include <fs/msdosfs/denode.h>
  60 #include <fs/msdosfs/fat.h>
  61 #include <fs/msdosfs/msdosfsmount.h>
  62
  63 static int      chainalloc(struct msdosfsmount *pmp, u_long start,
  64                     u_long count, u_long fillwith, u_long *retcluster,
  65                     u_long *got);
  66 static int      chainlength(struct msdosfsmount *pmp, u_long start,
  67                     u_long count);
  68 static void     fatblock(struct msdosfsmount *pmp, u_long ofs, u_long *bnp,
  69                     u_long *sizep, u_long *bop);
  70 static int      fatchain(struct msdosfsmount *pmp, u_long start, u_long count,
  71                     u_long fillwith);
  72 static void     fc_lookup(struct denode *dep, u_long findcn, u_long *frcnp,
  73                     u_long *fsrcnp);
  74 static void     updatefats(struct msdosfsmount *pmp, struct buf *bp,
  75                     u_long fatbn);
  76 static __inline void
  77                 usemap_alloc(struct msdosfsmount *pmp, u_long cn);
  78 static __inline void
  79                 usemap_free(struct msdosfsmount *pmp, u_long cn);
  80 static int      clusteralloc1(struct msdosfsmount *pmp, u_long start,
  81                     u_long count, u_long fillwith, u_long *retcluster,
  82                     u_long *got);
  83
  84 static void
  85 fatblock(pmp, ofs, bnp, sizep, bop)
  86         struct msdosfsmount *pmp;
  87         u_long ofs;
  88         u_long *bnp;
  89         u_long *sizep;
  90         u_long *bop;
  91 {
  92         u_long bn, size;
  93
  94         bn = ofs / pmp->pm_fatblocksize * pmp->pm_fatblocksec;
  95         size = min(pmp->pm_fatblocksec, pmp->pm_FATsecs - bn)
  96             * DEV_BSIZE;
  97         bn += pmp->pm_fatblk + pmp->pm_curfat * pmp->pm_FATsecs;
  98
  99         if (bnp)
 100                 *bnp = bn;
 101         if (sizep)
 102                 *sizep = size;
 103         if (bop)
 104                 *bop = ofs % pmp->pm_fatblocksize;
 105 }
 106
 107 /*
 108  * Map the logical cluster number of a file into a physical disk sector
 109  * that is filesystem relative.
 110  *
 111  * dep    - address of denode representing the file of interest
 112  * findcn - file relative cluster whose filesystem relative cluster number
 113  *          and/or block number are/is to be found
 114  * bnp    - address of where to place the filesystem relative block number.
 115  *          If this pointer is null then don't return this quantity.
 116  * cnp    - address of where to place the filesystem relative cluster number.
 117  *          If this pointer is null then don't return this quantity.
 118  *
 119  * NOTE: Either bnp or cnp must be non-null.
 120  * This function has one side effect.  If the requested file relative cluster
 121  * is beyond the end of file, then the actual number of clusters in the file
 122  * is returned in *cnp.  This is useful for determining how long a directory is.
 123  *  If cnp is null, nothing is returned.
 124  */
 125 int
 126 pcbmap(dep, findcn, bnp, cnp, sp)
 127         struct denode *dep;
 128         u_long findcn;          /* file relative cluster to get          */
 129         daddr_t *bnp;           /* returned filesys relative blk number  */
 130         u_long *cnp;            /* returned cluster number               */
 131         int *sp;                /* returned block size                   */
 132 {
 133         int error;
 134         u_long i;
 135         u_long cn;
 136         u_long prevcn = 0; /* XXX: prevcn could be used unititialized */
 137         u_long byteoffset;
 138         u_long bn;
 139         u_long bo;
 140         struct buf *bp = NULL;
 141         u_long bp_bn = -1;
 142         struct msdosfsmount *pmp = dep->de_pmp;
 143         u_long bsize;
 144
 145         KASSERT(bnp != NULL || cnp != NULL || sp != NULL,
 146             ("pcbmap: extra call"));
 147         ASSERT_VOP_ELOCKED(DETOV(dep), "pcbmap");
 148
 149         cn = dep->de_StartCluster;
 150         /*
 151          * The "file" that makes up the root directory is contiguous,
 152          * permanently allocated, of fixed size, and is not made up of
 153          * clusters.  If the cluster number is beyond the end of the root
 154          * directory, then return the number of clusters in the file.
 155          */
 156         if (cn == MSDOSFSROOT) {
 157                 if (dep->de_Attributes & ATTR_DIRECTORY) {
 158                         if (de_cn2off(pmp, findcn) >= dep->de_FileSize) {
 159                                 if (cnp)
 160                                         *cnp = de_bn2cn(pmp, pmp->pm_rootdirsize);
 161                                 return (E2BIG);
 162                         }
 163                         if (bnp)
 164                                 *bnp = pmp->pm_rootdirblk + de_cn2bn(pmp, findcn);
 165                         if (cnp)
 166                                 *cnp = MSDOSFSROOT;
 167                         if (sp)
 168                                 *sp = min(pmp->pm_bpcluster,
 169                                     dep->de_FileSize - de_cn2off(pmp, findcn));
 170                         return (0);
 171                 } else {                /* just an empty file */
 172                         if (cnp)
 173                                 *cnp = 0;
 174                         return (E2BIG);
 175                 }
 176         }
 177
 178         /*
 179          * All other files do I/O in cluster sized blocks
 180          */
 181         if (sp)
 182                 *sp = pmp->pm_bpcluster;
 183
 184         /*
 185          * Rummage around in the fat cache, maybe we can avoid tromping
 186          * thru every fat entry for the file. And, keep track of how far
 187          * off the cache was from where we wanted to be.
 188          */
 189         i = 0;
 190         fc_lookup(dep, findcn, &i, &cn);
 191
 192         /*
 193          * Handle all other files or directories the normal way.
 194          */
 195         for (; i < findcn; i++) {
 196                 /*
 197                  * Stop with all reserved clusters, not just with EOF.
 198                  */
 199                 if ((cn | ~pmp->pm_fatmask) >= CLUST_RSRVD)
 200                         goto hiteof;
 201                 byteoffset = FATOFS(pmp, cn);
 202                 fatblock(pmp, byteoffset, &bn, &bsize, &bo);
 203                 if (bn != bp_bn) {
 204                         if (bp)
 205                                 brelse(bp);
 206                         error = bread(pmp->pm_devvp, bn, bsize, NOCRED, &bp);
 207                         if (error) {
 208                                 brelse(bp);
 209                                 return (error);
 210                         }
 211                         bp_bn = bn;
 212                 }
 213                 prevcn = cn;
 214                 if (bo >= bsize) {
 215                         if (bp)
 216                                 brelse(bp);
 217                         return (EIO);
 218                 }
 219                 if (FAT32(pmp))
 220                         cn = getulong(&bp->b_data[bo]);
 221                 else
 222                         cn = getushort(&bp->b_data[bo]);
 223                 if (FAT12(pmp) && (prevcn & 1))
 224                         cn >>= 4;
 225                 cn &= pmp->pm_fatmask;
 226
 227                 /*
 228                  * Force the special cluster numbers
 229                  * to be the same for all cluster sizes
 230                  * to let the rest of msdosfs handle
 231                  * all cases the same.
 232                  */
 233                 if ((cn | ~pmp->pm_fatmask) >= CLUST_RSRVD)
 234                         cn |= ~pmp->pm_fatmask;
 235         }
 236
 237         if (!MSDOSFSEOF(pmp, cn)) {
 238                 if (bp)
 239                         brelse(bp);
 240                 if (bnp)
 241                         *bnp = cntobn(pmp, cn);
 242                 if (cnp)
 243                         *cnp = cn;
 244                 fc_setcache(dep, FC_LASTMAP, i, cn);
 245                 return (0);
 246         }
 247
 248 hiteof:;
 249         if (cnp)
 250                 *cnp = i;
 251         if (bp)
 252                 brelse(bp);
 253         /* update last file cluster entry in the fat cache */
 254         fc_setcache(dep, FC_LASTFC, i - 1, prevcn);
 255         return (E2BIG);
 256 }
 257
 258 /*
 259  * Find the closest entry in the fat cache to the cluster we are looking
 260  * for.
 261  */
 262 static void
 263 fc_lookup(dep, findcn, frcnp, fsrcnp)
 264         struct denode *dep;
 265         u_long findcn;
 266         u_long *frcnp;
 267         u_long *fsrcnp;
 268 {
 269         int i;
 270         u_long cn;
 271         struct fatcache *closest = 0;
 272
 273         ASSERT_VOP_LOCKED(DETOV(dep), "fc_lookup");
 274
 275         for (i = 0; i < FC_SIZE; i++) {
 276                 cn = dep->de_fc[i].fc_frcn;
 277                 if (cn != FCE_EMPTY && cn <= findcn) {
 278                         if (closest == 0 || cn > closest->fc_frcn)
 279                                 closest = &dep->de_fc[i];
 280                 }
 281         }
 282         if (closest) {
 283                 *frcnp = closest->fc_frcn;
 284                 *fsrcnp = closest->fc_fsrcn;
 285         }
 286 }
 287
 288 /*
 289  * Purge the fat cache in denode dep of all entries relating to file
 290  * relative cluster frcn and beyond.
 291  */
 292 void
 293 fc_purge(dep, frcn)
 294         struct denode *dep;
 295         u_int frcn;
 296 {
 297         int i;
 298         struct fatcache *fcp;
 299
 300         ASSERT_VOP_ELOCKED(DETOV(dep), "fc_purge");
 301
 302         fcp = dep->de_fc;
 303         for (i = 0; i < FC_SIZE; i++, fcp++) {
 304                 if (fcp->fc_frcn >= frcn)
 305                         fcp->fc_frcn = FCE_EMPTY;
 306         }
 307 }
 308
 309 /*
 310  * Update the fat.
 311  * If mirroring the fat, update all copies, with the first copy as last.
 312  * Else update only the current fat (ignoring the others).
 313  *
 314  * pmp   - msdosfsmount structure for filesystem to update
 315  * bp    - addr of modified fat block
 316  * fatbn - block number relative to begin of filesystem of the modified fat block.
 317  */
 318 static void
 319 updatefats(pmp, bp, fatbn)
 320         struct msdosfsmount *pmp;
 321         struct buf *bp;
 322         u_long fatbn;
 323 {
 324         struct buf *bpn;
 325         int cleanfat, i;
 326
 327 #ifdef MSDOSFS_DEBUG
 328         printf("updatefats(pmp %p, bp %p, fatbn %lu)\n", pmp, bp, fatbn);
 329 #endif
 330
 331         /*
 332          * If we have an FSInfo block, update it.
 333          */
 334         if (pmp->pm_fsinfo) {
 335                 if (bread(pmp->pm_devvp, pmp->pm_fsinfo, pmp->pm_BytesPerSec,
 336                     NOCRED, &bpn) != 0) {
 337                         /*
 338                          * Ignore the error, but turn off FSInfo update for the future.
 339                          */
 340                         pmp->pm_fsinfo = 0;
 341                         brelse(bpn);
 342                 } else {
 343                         struct fsinfo *fp = (struct fsinfo *)bpn->b_data;
 344
 345                         putulong(fp->fsinfree, pmp->pm_freeclustercount);
 346                         putulong(fp->fsinxtfree, pmp->pm_nxtfree);
 347                         if (pmp->pm_flags & MSDOSFSMNT_WAITONFAT)
 348                                 bwrite(bpn);
 349                         else
 350                                 bdwrite(bpn);
 351                 }
 352         }
 353
 354         if (pmp->pm_flags & MSDOSFS_FATMIRROR) {
 355                 /*
 356                  * Now copy the block(s) of the modified fat to the other copies of
 357                  * the fat and write them out.  This is faster than reading in the
 358                  * other fats and then writing them back out.  This could tie up
 359                  * the fat for quite a while. Preventing others from accessing it.
 360                  * To prevent us from going after the fat quite so much we use
 361                  * delayed writes, unless they specfied "synchronous" when the
 362                  * filesystem was mounted.  If synch is asked for then use
 363                  * bwrite()'s and really slow things down.
 364                  */
 365                 if (fatbn != pmp->pm_fatblk || FAT12(pmp))
 366                         cleanfat = 0;
 367                 else if (FAT16(pmp))
 368                         cleanfat = 16;
 369                 else
 370                         cleanfat = 32;
 371                 for (i = 1; i < pmp->pm_FATs; i++) {
 372                         fatbn += pmp->pm_FATsecs;
 373                         /* getblk() never fails */
 374                         bpn = getblk(pmp->pm_devvp, fatbn, bp->b_bcount,
 375                             0, 0, 0);
 376                         bcopy(bp->b_data, bpn->b_data, bp->b_bcount);
 377                         /* Force the clean bit on in the other copies. */
 378                         if (cleanfat == 16)
 379                                 ((u_int8_t *)bpn->b_data)[3] |= 0x80;
 380                         else if (cleanfat == 32)
 381                                 ((u_int8_t *)bpn->b_data)[7] |= 0x08;
 382                         if (pmp->pm_mountp->mnt_flag & MNT_SYNCHRONOUS)
 383                                 bwrite(bpn);
 384                         else
 385                                 bdwrite(bpn);
 386                 }
 387         }
 388
 389         /*
 390          * Write out the first (or current) fat last.
 391          */
 392         if (pmp->pm_mountp->mnt_flag & MNT_SYNCHRONOUS)
 393                 bwrite(bp);
 394         else
 395                 bdwrite(bp);
 396         /*
 397          * Maybe update fsinfo sector here?
 398          */
 399 }
 400
 401 /*
 402  * Updating entries in 12 bit fats is a pain in the butt.
 403  *
 404  * The following picture shows where nibbles go when moving from a 12 bit
 405  * cluster number into the appropriate bytes in the FAT.
 406  *
 407  *      byte m        byte m+1      byte m+2
 408  *      +----+----+   +----+----+   +----+----+
 409  *      |  0    1 |   |  2    3 |   |  4    5 |   FAT bytes
 410  *      +----+----+   +----+----+   +----+----+
 411  *
 412  *      +----+----+----+   +----+----+----+
 413  *      |  3    0    1 |   |  4    5    2 |
 414  *      +----+----+----+   +----+----+----+
 415  *      cluster n          cluster n+1
 416  *
 417  * Where n is even. m = n + (n >> 2)
 418  *
 419  */
 420 static __inline void
 421 usemap_alloc(pmp, cn)
 422         struct msdosfsmount *pmp;
 423         u_long cn;
 424 {
 425
 426         MSDOSFS_ASSERT_MP_LOCKED(pmp);
 427
 428         KASSERT((pmp->pm_inusemap[cn / N_INUSEBITS] & (1 << (cn % N_INUSEBITS)))
 429             == 0, ("Allocating used sector %ld %ld %x", cn, cn % N_INUSEBITS,
 430                 (unsigned)pmp->pm_inusemap[cn / N_INUSEBITS]));
 431         pmp->pm_inusemap[cn / N_INUSEBITS] |= 1 << (cn % N_INUSEBITS);
 432         KASSERT(pmp->pm_freeclustercount > 0, ("usemap_alloc: too little"));
 433         pmp->pm_freeclustercount--;
 434 }
 435
 436 static __inline void
 437 usemap_free(pmp, cn)
 438         struct msdosfsmount *pmp;
 439         u_long cn;
 440 {
 441
 442         MSDOSFS_ASSERT_MP_LOCKED(pmp);
 443         pmp->pm_freeclustercount++;
 444         KASSERT((pmp->pm_inusemap[cn / N_INUSEBITS] & (1 << (cn % N_INUSEBITS)))
 445             != 0, ("Freeing unused sector %ld %ld %x", cn, cn % N_INUSEBITS,
 446                 (unsigned)pmp->pm_inusemap[cn / N_INUSEBITS]));
 447         pmp->pm_inusemap[cn / N_INUSEBITS] &= ~(1 << (cn % N_INUSEBITS));
 448 }
 449
 450 int
 451 clusterfree(pmp, cluster, oldcnp)
 452         struct msdosfsmount *pmp;
 453         u_long cluster;
 454         u_long *oldcnp;
 455 {
 456         int error;
 457         u_long oldcn;
 458
 459         error = fatentry(FAT_GET_AND_SET, pmp, cluster, &oldcn, MSDOSFSFREE);
 460         if (error)
 461                 return (error);
 462         /*
 463          * If the cluster was successfully marked free, then update
 464          * the count of free clusters, and turn off the "allocated"
 465          * bit in the "in use" cluster bit map.
 466          */
 467         MSDOSFS_LOCK_MP(pmp);
 468         usemap_free(pmp, cluster);
 469         MSDOSFS_UNLOCK_MP(pmp);
 470         if (oldcnp)
 471                 *oldcnp = oldcn;
 472         return (0);
 473 }
 474
 475 /*
 476  * Get or Set or 'Get and Set' the cluster'th entry in the fat.
 477  *
 478  * function     - whether to get or set a fat entry
 479  * pmp          - address of the msdosfsmount structure for the filesystem
 480  *                whose fat is to be manipulated.
 481  * cn           - which cluster is of interest
 482  * oldcontents  - address of a word that is to receive the contents of the
 483  *                cluster'th entry if this is a get function
 484  * newcontents  - the new value to be written into the cluster'th element of
 485  *                the fat if this is a set function.
 486  *
 487  * This function can also be used to free a cluster by setting the fat entry
 488  * for a cluster to 0.
 489  *
 490  * All copies of the fat are updated if this is a set function. NOTE: If
 491  * fatentry() marks a cluster as free it does not update the inusemap in
 492  * the msdosfsmount structure. This is left to the caller.
 493  */
 494 int
 495 fatentry(function, pmp, cn, oldcontents, newcontents)
 496         int function;
 497         struct msdosfsmount *pmp;
 498         u_long cn;
 499         u_long *oldcontents;
 500         u_long newcontents;
 501 {
 502         int error;
 503         u_long readcn;
 504         u_long bn, bo, bsize, byteoffset;
 505         struct buf *bp;
 506
 507 #ifdef  MSDOSFS_DEBUG
 508         printf("fatentry(func %d, pmp %p, clust %lu, oldcon %p, newcon %lx)\n",
 509             function, pmp, cn, oldcontents, newcontents);
 510 #endif
 511
 512 #ifdef DIAGNOSTIC
 513         /*
 514          * Be sure they asked us to do something.
 515          */
 516         if ((function & (FAT_SET | FAT_GET)) == 0) {
 517 #ifdef MSDOSFS_DEBUG
 518                 printf("fatentry(): function code doesn't specify get or set\n");
 519 #endif
 520                 return (EINVAL);
 521         }
 522
 523         /*
 524          * If they asked us to return a cluster number but didn't tell us
 525          * where to put it, give them an error.
 526          */
 527         if ((function & FAT_GET) && oldcontents == NULL) {
 528 #ifdef MSDOSFS_DEBUG
 529                 printf("fatentry(): get function with no place to put result\n");
 530 #endif
 531                 return (EINVAL);
 532         }
 533 #endif
 534
 535         /*
 536          * Be sure the requested cluster is in the filesystem.
 537          */
 538         if (cn < CLUST_FIRST || cn > pmp->pm_maxcluster)
 539                 return (EINVAL);
 540
 541         byteoffset = FATOFS(pmp, cn);
 542         fatblock(pmp, byteoffset, &bn, &bsize, &bo);
 543         error = bread(pmp->pm_devvp, bn, bsize, NOCRED, &bp);
 544         if (error) {
 545                 brelse(bp);
 546                 return (error);
 547         }
 548
 549         if (function & FAT_GET) {
 550                 if (FAT32(pmp))
 551                         readcn = getulong(&bp->b_data[bo]);
 552                 else
 553                         readcn = getushort(&bp->b_data[bo]);
 554                 if (FAT12(pmp) & (cn & 1))
 555                         readcn >>= 4;
 556                 readcn &= pmp->pm_fatmask;
 557                 /* map reserved fat entries to same values for all fats */
 558                 if ((readcn | ~pmp->pm_fatmask) >= CLUST_RSRVD)
 559                         readcn |= ~pmp->pm_fatmask;
 560                 *oldcontents = readcn;
 561         }
 562         if (function & FAT_SET) {
 563                 switch (pmp->pm_fatmask) {
 564                 case FAT12_MASK:
 565                         readcn = getushort(&bp->b_data[bo]);
 566                         if (cn & 1) {
 567                                 readcn &= 0x000f;
 568                                 readcn |= newcontents << 4;
 569                         } else {
 570                                 readcn &= 0xf000;
 571                                 readcn |= newcontents & 0xfff;
 572                         }
 573                         putushort(&bp->b_data[bo], readcn);
 574                         break;
 575                 case FAT16_MASK:
 576                         putushort(&bp->b_data[bo], newcontents);
 577                         break;
 578                 case FAT32_MASK:
 579                         /*
 580                          * According to spec we have to retain the
 581                          * high order bits of the fat entry.
 582                          */
 583                         readcn = getulong(&bp->b_data[bo]);
 584                         readcn &= ~FAT32_MASK;
 585                         readcn |= newcontents & FAT32_MASK;
 586                         putulong(&bp->b_data[bo], readcn);
 587                         break;
 588                 }
 589                 updatefats(pmp, bp, bn);
 590                 bp = NULL;
 591                 pmp->pm_fmod = 1;
 592         }
 593         if (bp)
 594                 brelse(bp);
 595         return (0);
 596 }
 597
 598 /*
 599  * Update a contiguous cluster chain
 600  *
 601  * pmp      - mount point
 602  * start    - first cluster of chain
 603  * count    - number of clusters in chain
 604  * fillwith - what to write into fat entry of last cluster
 605  */
 606 static int
 607 fatchain(pmp, start, count, fillwith)
 608         struct msdosfsmount *pmp;
 609         u_long start;
 610         u_long count;
 611         u_long fillwith;
 612 {
 613         int error;
 614         u_long bn, bo, bsize, byteoffset, readcn, newc;
 615         struct buf *bp;
 616
 617 #ifdef MSDOSFS_DEBUG
 618         printf("fatchain(pmp %p, start %lu, count %lu, fillwith %lx)\n",
 619             pmp, start, count, fillwith);
 620 #endif
 621         /*
 622          * Be sure the clusters are in the filesystem.
 623          */
 624         if (start < CLUST_FIRST || start + count - 1 > pmp->pm_maxcluster)
 625                 return (EINVAL);
 626
 627         while (count > 0) {
 628                 byteoffset = FATOFS(pmp, start);
 629                 fatblock(pmp, byteoffset, &bn, &bsize, &bo);
 630                 error = bread(pmp->pm_devvp, bn, bsize, NOCRED, &bp);
 631                 if (error) {
 632                         brelse(bp);
 633                         return (error);
 634                 }
 635                 while (count > 0) {
 636                         start++;
 637                         newc = --count > 0 ? start : fillwith;
 638                         switch (pmp->pm_fatmask) {
 639                         case FAT12_MASK:
 640                                 readcn = getushort(&bp->b_data[bo]);
 641                                 if (start & 1) {
 642                                         readcn &= 0xf000;
 643                                         readcn |= newc & 0xfff;
 644                                 } else {
 645                                         readcn &= 0x000f;
 646                                         readcn |= newc << 4;
 647                                 }
 648                                 putushort(&bp->b_data[bo], readcn);
 649                                 bo++;
 650                                 if (!(start & 1))
 651                                         bo++;
 652                                 break;
 653                         case FAT16_MASK:
 654                                 putushort(&bp->b_data[bo], newc);
 655                                 bo += 2;
 656                                 break;
 657                         case FAT32_MASK:
 658                                 readcn = getulong(&bp->b_data[bo]);
 659                                 readcn &= ~pmp->pm_fatmask;
 660                                 readcn |= newc & pmp->pm_fatmask;
 661                                 putulong(&bp->b_data[bo], readcn);
 662                                 bo += 4;
 663                                 break;
 664                         }
 665                         if (bo >= bsize)
 666                                 break;
 667                 }
 668                 updatefats(pmp, bp, bn);
 669         }
 670         pmp->pm_fmod = 1;
 671         return (0);
 672 }
 673
 674 /*
 675  * Check the length of a free cluster chain starting at start.
 676  *
 677  * pmp   - mount point
 678  * start - start of chain
 679  * count - maximum interesting length
 680  */
 681 static int
 682 chainlength(pmp, start, count)
 683         struct msdosfsmount *pmp;
 684         u_long start;
 685         u_long count;
 686 {
 687         u_long idx, max_idx;
 688         u_int map;
 689         u_long len;
 690
 691         MSDOSFS_ASSERT_MP_LOCKED(pmp);
 692
 693         max_idx = pmp->pm_maxcluster / N_INUSEBITS;
 694         idx = start / N_INUSEBITS;
 695         start %= N_INUSEBITS;
 696         map = pmp->pm_inusemap[idx];
 697         map &= ~((1 << start) - 1);
 698         if (map) {
 699                 len = ffs(map) - 1 - start;
 700                 return (len > count ? count : len);
 701         }
 702         len = N_INUSEBITS - start;
 703         if (len >= count)
 704                 return (count);
 705         while (++idx <= max_idx) {
 706                 if (len >= count)
 707                         break;
 708                 map = pmp->pm_inusemap[idx];
 709                 if (map) {
 710                         len += ffs(map) - 1;
 711                         break;
 712                 }
 713                 len += N_INUSEBITS;
 714         }
 715         return (len > count ? count : len);
 716 }
 717
 718 /*
 719  * Allocate contigous free clusters.
 720  *
 721  * pmp        - mount point.
 722  * start      - start of cluster chain.
 723  * count      - number of clusters to allocate.
 724  * fillwith   - put this value into the fat entry for the
 725  *              last allocated cluster.
 726  * retcluster - put the first allocated cluster's number here.
 727  * got        - how many clusters were actually allocated.
 728  */
 729 static int
 730 chainalloc(pmp, start, count, fillwith, retcluster, got)
 731         struct msdosfsmount *pmp;
 732         u_long start;
 733         u_long count;
 734         u_long fillwith;
 735         u_long *retcluster;
 736         u_long *got;
 737 {
 738         int error;
 739         u_long cl, n;
 740
 741         MSDOSFS_ASSERT_MP_LOCKED(pmp);
 742
 743         for (cl = start, n = count; n-- > 0;)
 744                 usemap_alloc(pmp, cl++);
 745
 746         error = fatchain(pmp, start, count, fillwith);
 747         if (error != 0)
 748                 return (error);
 749 #ifdef MSDOSFS_DEBUG
 750         printf("clusteralloc(): allocated cluster chain at %lu (%lu clusters)\n",
 751             start, count);
 752 #endif
 753         if (retcluster)
 754                 *retcluster = start;
 755         if (got)
 756                 *got = count;
 757         pmp->pm_nxtfree = start + count;
 758         if (pmp->pm_nxtfree > pmp->pm_maxcluster)
 759                 pmp->pm_nxtfree = CLUST_FIRST;
 760         return (0);
 761 }
 762
 763 /*
 764  * Allocate contiguous free clusters.
 765  *
 766  * pmp        - mount point.
 767  * start      - preferred start of cluster chain.
 768  * count      - number of clusters requested.
 769  * fillwith   - put this value into the fat entry for the
 770  *              last allocated cluster.
 771  * retcluster - put the first allocated cluster's number here.
 772  * got        - how many clusters were actually allocated.
 773  */
 774 int
 775 clusteralloc(struct msdosfsmount *pmp, u_long start, u_long count,
 776     u_long fillwith, u_long *retcluster, u_long *got)
 777 {
 778         int error;
 779
 780         MSDOSFS_LOCK_MP(pmp);
 781         error = clusteralloc1(pmp, start, count, fillwith, retcluster, got);
 782         MSDOSFS_UNLOCK_MP(pmp);
 783         return (error);
 784 }
 785
 786 static int
 787 clusteralloc1(struct msdosfsmount *pmp, u_long start, u_long count,
 788     u_long fillwith, u_long *retcluster, u_long *got)
 789 {
 790         u_long idx;
 791         u_long len, newst, foundl, cn, l;
 792         u_long foundcn = 0; /* XXX: foundcn could be used unititialized */
 793         u_int map;
 794
 795         MSDOSFS_ASSERT_MP_LOCKED(pmp);
 796
 797 #ifdef MSDOSFS_DEBUG
 798         printf("clusteralloc(): find %lu clusters\n", count);
 799 #endif
 800         if (start) {
 801                 if ((len = chainlength(pmp, start, count)) >= count)
 802                         return (chainalloc(pmp, start, count, fillwith, retcluster, got));
 803         } else
 804                 len = 0;
 805
 806         newst = pmp->pm_nxtfree;
 807         foundl = 0;
 808
 809         for (cn = newst; cn <= pmp->pm_maxcluster;) {
 810                 idx = cn / N_INUSEBITS;
 811                 map = pmp->pm_inusemap[idx];
 812                 map |= (1 << (cn % N_INUSEBITS)) - 1;
 813                 if (map != (u_int)-1) {
 814                         cn = idx * N_INUSEBITS + ffs(map^(u_int)-1) - 1;
 815                         if ((l = chainlength(pmp, cn, count)) >= count)
 816                                 return (chainalloc(pmp, cn, count, fillwith, retcluster, got));
 817                         if (l > foundl) {
 818                                 foundcn = cn;
 819                                 foundl = l;
 820                         }
 821                         cn += l + 1;
 822                         continue;
 823                 }
 824                 cn += N_INUSEBITS - cn % N_INUSEBITS;
 825         }
 826         for (cn = 0; cn < newst;) {
 827                 idx = cn / N_INUSEBITS;
 828                 map = pmp->pm_inusemap[idx];
 829                 map |= (1 << (cn % N_INUSEBITS)) - 1;
 830                 if (map != (u_int)-1) {
 831                         cn = idx * N_INUSEBITS + ffs(map^(u_int)-1) - 1;
 832                         if ((l = chainlength(pmp, cn, count)) >= count)
 833                                 return (chainalloc(pmp, cn, count, fillwith, retcluster, got));
 834                         if (l > foundl) {
 835                                 foundcn = cn;
 836                                 foundl = l;
 837                         }
 838                         cn += l + 1;
 839                         continue;
 840                 }
 841                 cn += N_INUSEBITS - cn % N_INUSEBITS;
 842         }
 843
 844         if (!foundl)
 845                 return (ENOSPC);
 846
 847         if (len)
 848                 return (chainalloc(pmp, start, len, fillwith, retcluster, got));
 849         else
 850                 return (chainalloc(pmp, foundcn, foundl, fillwith, retcluster, got));
 851 }
 852
 853
 854 /*
 855  * Free a chain of clusters.
 856  *
 857  * pmp          - address of the msdosfs mount structure for the filesystem
 858  *                containing the cluster chain to be freed.
 859  * startcluster - number of the 1st cluster in the chain of clusters to be
 860  *                freed.
 861  */
 862 int
 863 freeclusterchain(pmp, cluster)
 864         struct msdosfsmount *pmp;
 865         u_long cluster;
 866 {
 867         int error;
 868         struct buf *bp = NULL;
 869         u_long bn, bo, bsize, byteoffset;
 870         u_long readcn, lbn = -1;
 871
 872         MSDOSFS_LOCK_MP(pmp);
 873         while (cluster >= CLUST_FIRST && cluster <= pmp->pm_maxcluster) {
 874                 byteoffset = FATOFS(pmp, cluster);
 875                 fatblock(pmp, byteoffset, &bn, &bsize, &bo);
 876                 if (lbn != bn) {
 877                         if (bp)
 878                                 updatefats(pmp, bp, lbn);
 879                         error = bread(pmp->pm_devvp, bn, bsize, NOCRED, &bp);
 880                         if (error) {
 881                                 brelse(bp);
 882                                 MSDOSFS_UNLOCK_MP(pmp);
 883                                 return (error);
 884                         }
 885                         lbn = bn;
 886                 }
 887                 usemap_free(pmp, cluster);
 888                 switch (pmp->pm_fatmask) {
 889                 case FAT12_MASK:
 890                         readcn = getushort(&bp->b_data[bo]);
 891                         if (cluster & 1) {
 892                                 cluster = readcn >> 4;
 893                                 readcn &= 0x000f;
 894                                 readcn |= MSDOSFSFREE << 4;
 895                         } else {
 896                                 cluster = readcn;
 897                                 readcn &= 0xf000;
 898                                 readcn |= MSDOSFSFREE & 0xfff;
 899                         }
 900                         putushort(&bp->b_data[bo], readcn);
 901                         break;
 902                 case FAT16_MASK:
 903                         cluster = getushort(&bp->b_data[bo]);
 904                         putushort(&bp->b_data[bo], MSDOSFSFREE);
 905                         break;
 906                 case FAT32_MASK:
 907                         cluster = getulong(&bp->b_data[bo]);
 908                         putulong(&bp->b_data[bo],
 909                                  (MSDOSFSFREE & FAT32_MASK) | (cluster & ~FAT32_MASK));
 910                         break;
 911                 }
 912                 cluster &= pmp->pm_fatmask;
 913                 if ((cluster | ~pmp->pm_fatmask) >= CLUST_RSRVD)
 914                         cluster |= pmp->pm_fatmask;
 915         }
 916         if (bp)
 917                 updatefats(pmp, bp, bn);
 918         MSDOSFS_UNLOCK_MP(pmp);
 919         return (0);
 920 }
 921
 922 /*
 923  * Read in fat blocks looking for free clusters. For every free cluster
 924  * found turn off its corresponding bit in the pm_inusemap.
 925  */
 926 int
 927 fillinusemap(pmp)
 928         struct msdosfsmount *pmp;
 929 {
 930         struct buf *bp = NULL;
 931         u_long cn, readcn;
 932         int error;
 933         u_long bn, bo, bsize, byteoffset;
 934
 935         MSDOSFS_ASSERT_MP_LOCKED(pmp);
 936
 937         /*
 938          * Mark all clusters in use, we mark the free ones in the fat scan
 939          * loop further down.
 940          */
 941         for (cn = 0; cn < (pmp->pm_maxcluster + N_INUSEBITS) / N_INUSEBITS; cn++)
 942                 pmp->pm_inusemap[cn] = (u_int)-1;
 943
 944         /*
 945          * Figure how many free clusters are in the filesystem by ripping
 946          * through the fat counting the number of entries whose content is
 947          * zero.  These represent free clusters.
 948          */
 949         pmp->pm_freeclustercount = 0;
 950         for (cn = CLUST_FIRST; cn <= pmp->pm_maxcluster; cn++) {
 951                 byteoffset = FATOFS(pmp, cn);
 952                 bo = byteoffset % pmp->pm_fatblocksize;
 953                 if (!bo || !bp) {
 954                         /* Read new FAT block */
 955                         if (bp)
 956                                 brelse(bp);
 957                         fatblock(pmp, byteoffset, &bn, &bsize, NULL);
 958                         error = bread(pmp->pm_devvp, bn, bsize, NOCRED, &bp);
 959                         if (error) {
 960                                 brelse(bp);
 961                                 return (error);
 962                         }
 963                 }
 964                 if (FAT32(pmp))
 965                         readcn = getulong(&bp->b_data[bo]);
 966                 else
 967                         readcn = getushort(&bp->b_data[bo]);
 968                 if (FAT12(pmp) && (cn & 1))
 969                         readcn >>= 4;
 970                 readcn &= pmp->pm_fatmask;
 971
 972                 if (readcn == 0)
 973                         usemap_free(pmp, cn);
 974         }
 975         if (bp != NULL)
 976                 brelse(bp);
 977         return (0);
 978 }
 979
 980 /*
 981  * Allocate a new cluster and chain it onto the end of the file.
 982  *
 983  * dep   - the file to extend
 984  * count - number of clusters to allocate
 985  * bpp   - where to return the address of the buf header for the first new
 986  *         file block
 987  * ncp   - where to put cluster number of the first newly allocated cluster
 988  *         If this pointer is 0, do not return the cluster number.
 989  * flags - see fat.h
 990  *
 991  * NOTE: This function is not responsible for turning on the DE_UPDATE bit of
 992  * the de_flag field of the denode and it does not change the de_FileSize
 993  * field.  This is left for the caller to do.
 994  */
 995 int
 996 extendfile(dep, count, bpp, ncp, flags)
 997         struct denode *dep;
 998         u_long count;
 999         struct buf **bpp;
1000         u_long *ncp;
1001         int flags;
1002 {
1003         int error;
1004         u_long frcn;
1005         u_long cn, got;
1006         struct msdosfsmount *pmp = dep->de_pmp;
1007         struct buf *bp;
1008         daddr_t blkno;
1009
1010         /*
1011          * Don't try to extend the root directory
1012          */
1013         if (dep->de_StartCluster == MSDOSFSROOT
1014             && (dep->de_Attributes & ATTR_DIRECTORY)) {
1015 #ifdef MSDOSFS_DEBUG
1016                 printf("extendfile(): attempt to extend root directory\n");
1017 #endif
1018                 return (ENOSPC);
1019         }
1020
1021         /*
1022          * If the "file's last cluster" cache entry is empty, and the file
1023          * is not empty, then fill the cache entry by calling pcbmap().
1024          */
1025         if (dep->de_fc[FC_LASTFC].fc_frcn == FCE_EMPTY &&
1026             dep->de_StartCluster != 0) {
1027                 error = pcbmap(dep, 0xffff, 0, &cn, 0);
1028                 /* we expect it to return E2BIG */
1029                 if (error != E2BIG)
1030                         return (error);
1031         }
1032
1033         dep->de_fc[FC_NEXTTOLASTFC].fc_frcn =
1034             dep->de_fc[FC_LASTFC].fc_frcn;
1035         dep->de_fc[FC_NEXTTOLASTFC].fc_fsrcn =
1036             dep->de_fc[FC_LASTFC].fc_fsrcn;
1037         while (count > 0) {
1038                 /*
1039                  * Allocate a new cluster chain and cat onto the end of the
1040                  * file.  * If the file is empty we make de_StartCluster point
1041                  * to the new block.  Note that de_StartCluster being 0 is
1042                  * sufficient to be sure the file is empty since we exclude
1043                  * attempts to extend the root directory above, and the root
1044                  * dir is the only file with a startcluster of 0 that has
1045                  * blocks allocated (sort of).
1046                  */
1047                 if (dep->de_StartCluster == 0)
1048                         cn = 0;
1049                 else
1050                         cn = dep->de_fc[FC_LASTFC].fc_fsrcn + 1;
1051                 error = clusteralloc(pmp, cn, count, CLUST_EOFE, &cn, &got);
1052                 if (error)
1053                         return (error);
1054
1055                 count -= got;
1056
1057                 /*
1058                  * Give them the filesystem relative cluster number if they want
1059                  * it.
1060                  */
1061                 if (ncp) {
1062                         *ncp = cn;
1063                         ncp = NULL;
1064                 }
1065
1066                 if (dep->de_StartCluster == 0) {
1067                         dep->de_StartCluster = cn;
1068                         frcn = 0;
1069                 } else {
1070                         error = fatentry(FAT_SET, pmp,
1071                                          dep->de_fc[FC_LASTFC].fc_fsrcn,
1072                                          0, cn);
1073                         if (error) {
1074                                 clusterfree(pmp, cn, NULL);
1075                                 return (error);
1076                         }
1077                         frcn = dep->de_fc[FC_LASTFC].fc_frcn + 1;
1078                 }
1079
1080                 /*
1081                  * Update the "last cluster of the file" entry in the denode's fat
1082                  * cache.
1083                  */
1084                 fc_setcache(dep, FC_LASTFC, frcn + got - 1, cn + got - 1);
1085
1086                 if (flags & DE_CLEAR) {
1087                         while (got-- > 0) {
1088                                 /*
1089                                  * Get the buf header for the new block of the file.
1090                                  */
1091                                 if (dep->de_Attributes & ATTR_DIRECTORY)
1092                                         bp = getblk(pmp->pm_devvp,
1093                                             cntobn(pmp, cn++),
1094                                             pmp->pm_bpcluster, 0, 0, 0);
1095                                 else {
1096                                         bp = getblk(DETOV(dep),
1097                                             frcn++,
1098                                             pmp->pm_bpcluster, 0, 0, 0);
1099                                         /*
1100                                          * Do the bmap now, as in msdosfs_write
1101                                          */
1102                                         if (pcbmap(dep,
1103                                             bp->b_lblkno,
1104                                             &blkno, 0, 0))
1105                                                 bp->b_blkno = -1;
1106                                         if (bp->b_blkno == -1)
1107                                                 panic("extendfile: pcbmap");
1108                                         else
1109                                                 bp->b_blkno = blkno;
1110                                 }
1111                                 vfs_bio_clrbuf(bp);
1112                                 if (bpp) {
1113                                         *bpp = bp;
1114                                         bpp = NULL;
1115                                 } else
1116                                         bdwrite(bp);
1117                         }
1118                 }
1119         }
1120
1121         return (0);
1122 }
1123
1124 /*-
1125  * Routine to mark a FAT16 or FAT32 volume as "clean" or "dirty" by
1126  * manipulating the upper bit of the FAT entry for cluster 1.  Note that
1127  * this bit is not defined for FAT12 volumes, which are always assumed to
1128  * be clean.
1129  *
1130  * The fatentry() routine only works on cluster numbers that a file could
1131  * occupy, so it won't manipulate the entry for cluster 1.  So we have to do
1132  * it here.  The code was stolen from fatentry() and tailored for cluster 1.
1133  *
1134  * Inputs:
1135  *      pmp     The MS-DOS volume to mark
1136  *      dirty   Non-zero if the volume should be marked dirty; zero if it
1137  *              should be marked clean
1138  *
1139  * Result:
1140  *      0       Success
1141  *      EROFS   Volume is read-only
1142  *      ?       (other errors from called routines)
1143  */
1144 int
1145 markvoldirty(struct msdosfsmount *pmp, int dirty)
1146 {
1147         struct buf *bp;
1148         u_long bn, bo, bsize, byteoffset, fatval;
1149         int error;
1150
1151         /*
1152          * FAT12 does not support a "clean" bit, so don't do anything for
1153          * FAT12.
1154          */
1155         if (FAT12(pmp))
1156                 return (0);
1157
1158         /* Can't change the bit on a read-only filesystem. */
1159         if (pmp->pm_flags & MSDOSFSMNT_RONLY)
1160                 return (EROFS);
1161
1162         /*
1163          * Fetch the block containing the FAT entry.  It is given by the
1164          * pseudo-cluster 1.
1165          */
1166         byteoffset = FATOFS(pmp, 1);
1167         fatblock(pmp, byteoffset, &bn, &bsize, &bo);
1168         error = bread(pmp->pm_devvp, bn, bsize, NOCRED, &bp);
1169         if (error) {
1170                 brelse(bp);
1171                 return (error);
1172         }
1173
1174         /*
1175          * Get the current value of the FAT entry and set/clear the relevant
1176          * bit.  Dirty means clear the "clean" bit; clean means set the
1177          * "clean" bit.
1178          */
1179         if (FAT32(pmp)) {
1180                 /* FAT32 uses bit 27. */
1181                 fatval = getulong(&bp->b_data[bo]);
1182                 if (dirty)
1183                         fatval &= 0xF7FFFFFF;
1184                 else
1185                         fatval |= 0x08000000;
1186                 putulong(&bp->b_data[bo], fatval);
1187         } else {
1188                 /* Must be FAT16; use bit 15. */
1189                 fatval = getushort(&bp->b_data[bo]);
1190                 if (dirty)
1191                         fatval &= 0x7FFF;
1192                 else
1193                         fatval |= 0x8000;
1194                 putushort(&bp->b_data[bo], fatval);
1195         }
1196
1197         /* Write out the modified FAT block synchronously. */
1198         return (bwrite(bp));
1199 }