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