9708ba9f29
This is a re-apply r356249 with changes to make GCC happy. This utility was initially written for FAT12/16, which were inherently small. When FAT32 support was added, the old data structure and algorithms remain used with minimal changes. With growing size of FAT32 media, the current data structure that requires 4 32-bit variables per each FAT32 table entry would consume up to 4 GiB of RAM, which can be too big for systems with limited RAM available. Address this by taking a different approach of validating the FAT. The FAT is essentially a set of linked lists of chains that was referenced by directory entries, and the checker needs to make sure that the linked chains of clusters do not have cross-linked chains, and every chain were referenced by one and only one directory entry. Instead of keeping track of the chain's 'head' cluster number, the size of the chain, the used status of the chain and the "next" pointer which is content of the FAT table, we create accessors for the FAT table data for the "next" pointer, and keep only one bit to indicate if the current cluster is a 'head' node of a cluster chain, in a bitmap. We further overhaul the FAT checker to find out the possible head nodes by excluding ones that are not (in other words, nodes that have some other nodes claiming them as the next node) instead of marking the head nodes for each node on the chain. This approach greatly reduced the complexiety of computation from O(N^2) worst case, to an O(N) scan for worst case. The file (cluster chain) length is not useful for the FAT checker, so don't bother to calculate them in the FAT checker and instead leave the task to the directory structure check, at which point we would have non-crossed cluster chains, and we are guaranteed that each cluster will be visited for at most one time. When checking the directory structures, we use the head node indicator to as the visited (used) flag: every cluster chain can only be referenced by one directory entry, so we clear them when calculating the length of the chain, and we can immediately tell if there are anomalies in the directory entry. As a result, the required RAM size is now 1 bit per each entry of the FAT table, plus memory needed to hold the FAT table in memory, instead of 16 bytes (=128 bits) per each entry. For FAT12 and FAT16, we will load the whole FAT table into memory as they are smaller than 128KiB, and for FAT32, we first attempt to mmap() it into memory, and when that fails, we would fall back to a simple LRU cache of 4 MiB of RAM. sbin/fsck_msdosfs/boot.c: - Added additional sanity checks for valid FAT32/FAT16/FAT12 cluster number. - FAT32: check if root directory starts with a valid cluster number, moved from dir.c. There is no point to proceed if the filesystem is already damaged beyond repair. sbin/fsck_msdosfs/check.c: - Combine phase 1 and phase 2, now that the readfat() is able to detect cross chains. sbin/fsck_msdosfs/dir.c: - Refactor code to use FAT accessor instead of accessing the internal representation of FAT table. - Make use of the cluster chain head bitmap. - Clarify and simplify directory entry check, remove unnecessary checks that are would be done at a later time (for example, whether the directory's second cluster is a valid one, which is examined more throughly in a later checkchain() and does not prevent us from proceeding further). sbin/fsck_msdosfs/dosfs.h: - Remove internal representation of FAT table, which is replaced by the head bitmap that is opaque to other code. - Added a special CLUST_DEAD cluster type to indicate errors. sbin/fsck_msdosfs/ext.h: - Added a flag that overrides mmap(2) setting. The corresponding command line option, -M is intentionally undocumented as we do not expect users to need it. - Added accessors for FAT table and convert existing interface to use it. sbin/fsck_msdosfs/fat.c: - Added head bitmap to represent whether a cluster is a head cluster. - Converted FAT internal representation to accessors. - Implemented a LRU cache for FAT32 when mmap(2) should not or can not be used. - _readfat: Attempt a mmap(2) and fall back to regular read for non-FAT32 file systems; use the LRU cache for FAT32 and prepopulate the cache with the first 4MiB of the entries. - readfat: Added support of head bitmap and use the population scan to detect bogus chains. - clusterdiff: removed, FATs are copied from the checked copy via writefat()/copyfat(). - checkchain: calculates the length of a cluster chain and make sure that it ends with a valid EOF marker. - clearchain: follow and clear a chain and maintain the free cluster count. - checklost: convert to use head bitmap. At the end of all other scans, the remaining 'head' nodes are leaders of lost cluster chains. sbin/fsck_msdosfs/fat.c: - Added a new -M option which is intentionally undocumented, to disable the use of mmap(). Reviewed by: kevlo MFC after: 1 month Relnotes: yes Differential Revision: https://reviews.freebsd.org/D22965
365 lines
11 KiB
C
365 lines
11 KiB
C
/*-
|
|
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
|
|
*
|
|
* Copyright (C) 1995, 1997 Wolfgang Solfrank
|
|
* Copyright (c) 1995 Martin Husemann
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
|
|
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
|
|
#include <sys/cdefs.h>
|
|
#ifndef lint
|
|
__RCSID("$NetBSD: boot.c,v 1.11 2006/06/05 16:51:18 christos Exp ");
|
|
static const char rcsid[] =
|
|
"$FreeBSD$";
|
|
#endif /* not lint */
|
|
|
|
#include <sys/param.h>
|
|
|
|
#include <stdint.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
#include <stdio.h>
|
|
#include <unistd.h>
|
|
|
|
#include "ext.h"
|
|
#include "fsutil.h"
|
|
|
|
int
|
|
readboot(int dosfs, struct bootblock *boot)
|
|
{
|
|
u_char block[DOSBOOTBLOCKSIZE];
|
|
u_char fsinfo[2 * DOSBOOTBLOCKSIZE];
|
|
int ret = FSOK;
|
|
|
|
if ((size_t)read(dosfs, block, sizeof block) != sizeof block) {
|
|
perr("could not read boot block");
|
|
return FSFATAL;
|
|
}
|
|
|
|
if (block[510] != 0x55 || block[511] != 0xaa) {
|
|
pfatal("Invalid signature in boot block: %02x%02x",
|
|
block[511], block[510]);
|
|
return FSFATAL;
|
|
}
|
|
|
|
memset(boot, 0, sizeof *boot);
|
|
boot->ValidFat = -1;
|
|
|
|
/* Decode BIOS Parameter Block */
|
|
|
|
/* Bytes per sector: can only be 512, 1024, 2048 and 4096. */
|
|
boot->bpbBytesPerSec = block[11] + (block[12] << 8);
|
|
if (boot->bpbBytesPerSec < DOSBOOTBLOCKSIZE_REAL ||
|
|
boot->bpbBytesPerSec > DOSBOOTBLOCKSIZE ||
|
|
!powerof2(boot->bpbBytesPerSec)) {
|
|
pfatal("Invalid sector size: %u", boot->bpbBytesPerSec);
|
|
return FSFATAL;
|
|
}
|
|
|
|
/* Sectors per cluster: can only be: 1, 2, 4, 8, 16, 32, 64, 128. */
|
|
boot->bpbSecPerClust = block[13];
|
|
if (boot->bpbSecPerClust == 0 || !powerof2(boot->bpbSecPerClust)) {
|
|
pfatal("Invalid cluster size: %u", boot->bpbSecPerClust);
|
|
return FSFATAL;
|
|
}
|
|
|
|
/* Reserved sectors: must be non-zero */
|
|
boot->bpbResSectors = block[14] + (block[15] << 8);
|
|
if (boot->bpbResSectors < 1) {
|
|
pfatal("Invalid reserved sectors: %u",
|
|
boot->bpbResSectors);
|
|
return FSFATAL;
|
|
}
|
|
|
|
/* Number of FATs */
|
|
boot->bpbFATs = block[16];
|
|
if (boot->bpbFATs == 0) {
|
|
pfatal("Invalid number of FATs: %u", boot->bpbFATs);
|
|
return FSFATAL;
|
|
}
|
|
|
|
/* Root directory entries for FAT12 and FAT16 */
|
|
boot->bpbRootDirEnts = block[17] + (block[18] << 8);
|
|
if (!boot->bpbRootDirEnts) {
|
|
/* bpbRootDirEnts = 0 suggests that we are FAT32 */
|
|
boot->flags |= FAT32;
|
|
}
|
|
|
|
/* Total sectors (16 bits) */
|
|
boot->bpbSectors = block[19] + (block[20] << 8);
|
|
if (boot->bpbSectors != 0 && (boot->flags & FAT32)) {
|
|
pfatal("Invalid 16-bit total sector count on FAT32: %u",
|
|
boot->bpbSectors);
|
|
return FSFATAL;
|
|
}
|
|
|
|
/* Media type: ignored */
|
|
boot->bpbMedia = block[21];
|
|
|
|
/* FAT12/FAT16: 16-bit count of sectors per FAT */
|
|
boot->bpbFATsmall = block[22] + (block[23] << 8);
|
|
if (boot->bpbFATsmall != 0 && (boot->flags & FAT32)) {
|
|
pfatal("Invalid 16-bit FAT sector count on FAT32: %u",
|
|
boot->bpbFATsmall);
|
|
return FSFATAL;
|
|
}
|
|
|
|
/* Legacy CHS geometry numbers: ignored */
|
|
boot->SecPerTrack = block[24] + (block[25] << 8);
|
|
boot->bpbHeads = block[26] + (block[27] << 8);
|
|
|
|
/* Hidden sectors: ignored */
|
|
boot->bpbHiddenSecs = block[28] + (block[29] << 8) +
|
|
(block[30] << 16) + (block[31] << 24);
|
|
|
|
/* Total sectors (32 bits) */
|
|
boot->bpbHugeSectors = block[32] + (block[33] << 8) +
|
|
(block[34] << 16) + (block[35] << 24);
|
|
if (boot->bpbHugeSectors == 0) {
|
|
if (boot->flags & FAT32) {
|
|
pfatal("FAT32 with sector count of zero");
|
|
return FSFATAL;
|
|
} else if (boot->bpbSectors == 0) {
|
|
pfatal("FAT with sector count of zero");
|
|
return FSFATAL;
|
|
}
|
|
boot->NumSectors = boot->bpbSectors;
|
|
} else {
|
|
if (boot->bpbSectors != 0) {
|
|
pfatal("Invalid FAT sector count");
|
|
return FSFATAL;
|
|
}
|
|
boot->NumSectors = boot->bpbHugeSectors;
|
|
}
|
|
|
|
if (boot->flags & FAT32) {
|
|
/* If the OEM Name field is EXFAT, it's not FAT32, so bail */
|
|
if (!memcmp(&block[3], "EXFAT ", 8)) {
|
|
pfatal("exFAT filesystem is not supported.");
|
|
return FSFATAL;
|
|
}
|
|
|
|
/* 32-bit count of sectors per FAT */
|
|
boot->FATsecs = block[36] + (block[37] << 8)
|
|
+ (block[38] << 16) + (block[39] << 24);
|
|
|
|
if (block[40] & 0x80)
|
|
boot->ValidFat = block[40] & 0x0f;
|
|
|
|
/* FAT32 version, bail out if not 0.0 */
|
|
if (block[42] || block[43]) {
|
|
pfatal("Unknown file system version: %x.%x",
|
|
block[43], block[42]);
|
|
return FSFATAL;
|
|
}
|
|
|
|
/*
|
|
* Cluster number of the first cluster of root directory.
|
|
*
|
|
* Should be 2 but do not require it.
|
|
*/
|
|
boot->bpbRootClust = block[44] + (block[45] << 8)
|
|
+ (block[46] << 16) + (block[47] << 24);
|
|
|
|
/* Sector number of the FSInfo structure, usually 1 */
|
|
boot->bpbFSInfo = block[48] + (block[49] << 8);
|
|
|
|
/* Sector number of the backup boot block, ignored */
|
|
boot->bpbBackup = block[50] + (block[51] << 8);
|
|
|
|
/* Check basic parameters */
|
|
if (boot->bpbFSInfo == 0) {
|
|
/*
|
|
* Either the BIOS Parameter Block has been corrupted,
|
|
* or this is not a FAT32 filesystem, most likely an
|
|
* exFAT filesystem.
|
|
*/
|
|
pfatal("Invalid FAT32 Extended BIOS Parameter Block");
|
|
return FSFATAL;
|
|
}
|
|
|
|
/* Read in and verify the FSInfo block */
|
|
if (lseek(dosfs, boot->bpbFSInfo * boot->bpbBytesPerSec,
|
|
SEEK_SET) != boot->bpbFSInfo * boot->bpbBytesPerSec
|
|
|| read(dosfs, fsinfo, sizeof fsinfo) != sizeof fsinfo) {
|
|
perr("could not read fsinfo block");
|
|
return FSFATAL;
|
|
}
|
|
if (memcmp(fsinfo, "RRaA", 4)
|
|
|| memcmp(fsinfo + 0x1e4, "rrAa", 4)
|
|
|| fsinfo[0x1fc]
|
|
|| fsinfo[0x1fd]
|
|
|| fsinfo[0x1fe] != 0x55
|
|
|| fsinfo[0x1ff] != 0xaa
|
|
|| fsinfo[0x3fc]
|
|
|| fsinfo[0x3fd]
|
|
|| fsinfo[0x3fe] != 0x55
|
|
|| fsinfo[0x3ff] != 0xaa) {
|
|
pwarn("Invalid signature in fsinfo block\n");
|
|
if (ask(0, "Fix")) {
|
|
memcpy(fsinfo, "RRaA", 4);
|
|
memcpy(fsinfo + 0x1e4, "rrAa", 4);
|
|
fsinfo[0x1fc] = fsinfo[0x1fd] = 0;
|
|
fsinfo[0x1fe] = 0x55;
|
|
fsinfo[0x1ff] = 0xaa;
|
|
fsinfo[0x3fc] = fsinfo[0x3fd] = 0;
|
|
fsinfo[0x3fe] = 0x55;
|
|
fsinfo[0x3ff] = 0xaa;
|
|
if (lseek(dosfs, boot->bpbFSInfo *
|
|
boot->bpbBytesPerSec, SEEK_SET)
|
|
!= boot->bpbFSInfo * boot->bpbBytesPerSec
|
|
|| write(dosfs, fsinfo, sizeof fsinfo)
|
|
!= sizeof fsinfo) {
|
|
perr("Unable to write bpbFSInfo");
|
|
return FSFATAL;
|
|
}
|
|
ret = FSBOOTMOD;
|
|
} else
|
|
boot->bpbFSInfo = 0;
|
|
} else {
|
|
/* We appear to have a valid FSInfo block, decode */
|
|
boot->FSFree = fsinfo[0x1e8] + (fsinfo[0x1e9] << 8)
|
|
+ (fsinfo[0x1ea] << 16)
|
|
+ (fsinfo[0x1eb] << 24);
|
|
boot->FSNext = fsinfo[0x1ec] + (fsinfo[0x1ed] << 8)
|
|
+ (fsinfo[0x1ee] << 16)
|
|
+ (fsinfo[0x1ef] << 24);
|
|
}
|
|
} else {
|
|
/* !FAT32: FAT12/FAT16 */
|
|
boot->FATsecs = boot->bpbFATsmall;
|
|
}
|
|
|
|
if (boot->FATsecs > UINT32_MAX / boot->bpbFATs) {
|
|
pfatal("Invalid FATs(%u) with FATsecs(%zu)",
|
|
boot->bpbFATs, (size_t)boot->FATsecs);
|
|
return FSFATAL;
|
|
}
|
|
|
|
boot->FirstCluster = (boot->bpbRootDirEnts * 32 +
|
|
boot->bpbBytesPerSec - 1) / boot->bpbBytesPerSec +
|
|
boot->bpbResSectors + boot->bpbFATs * boot->FATsecs;
|
|
|
|
if (boot->FirstCluster + boot->bpbSecPerClust > boot->NumSectors) {
|
|
pfatal("Cluster offset too large (%u clusters)\n",
|
|
boot->FirstCluster);
|
|
return FSFATAL;
|
|
}
|
|
|
|
boot->NumClusters = (boot->NumSectors - boot->FirstCluster) / boot->bpbSecPerClust +
|
|
CLUST_FIRST;
|
|
|
|
if (boot->flags & FAT32) {
|
|
if (boot->NumClusters > (CLUST_RSRVD & CLUST32_MASK)) {
|
|
pfatal("Filesystem too big (%u clusters) for FAT32 partition",
|
|
boot->NumClusters);
|
|
return FSFATAL;
|
|
}
|
|
if (boot->NumClusters < (CLUST_RSRVD & CLUST16_MASK)) {
|
|
pfatal("Filesystem too small (%u clusters) for FAT32 partition",
|
|
boot->NumClusters);
|
|
return FSFATAL;
|
|
}
|
|
boot->ClustMask = CLUST32_MASK;
|
|
|
|
if (boot->bpbRootClust < CLUST_FIRST ||
|
|
boot->bpbRootClust >= boot->NumClusters) {
|
|
pfatal("Root directory starts with cluster out of range(%u)",
|
|
boot->bpbRootClust);
|
|
return FSFATAL;
|
|
}
|
|
} else if (boot->NumClusters < (CLUST_RSRVD&CLUST12_MASK)) {
|
|
boot->ClustMask = CLUST12_MASK;
|
|
} else if (boot->NumClusters < (CLUST_RSRVD&CLUST16_MASK)) {
|
|
boot->ClustMask = CLUST16_MASK;
|
|
} else {
|
|
pfatal("Filesystem too big (%u clusters) for non-FAT32 partition",
|
|
boot->NumClusters);
|
|
return FSFATAL;
|
|
}
|
|
|
|
switch (boot->ClustMask) {
|
|
case CLUST32_MASK:
|
|
boot->NumFatEntries = (boot->FATsecs * boot->bpbBytesPerSec) / 4;
|
|
break;
|
|
case CLUST16_MASK:
|
|
boot->NumFatEntries = (boot->FATsecs * boot->bpbBytesPerSec) / 2;
|
|
break;
|
|
default:
|
|
boot->NumFatEntries = (boot->FATsecs * boot->bpbBytesPerSec * 2) / 3;
|
|
break;
|
|
}
|
|
|
|
if (boot->NumFatEntries < boot->NumClusters - CLUST_FIRST) {
|
|
pfatal("FAT size too small, %u entries won't fit into %u sectors\n",
|
|
boot->NumClusters, boot->FATsecs);
|
|
return FSFATAL;
|
|
}
|
|
boot->ClusterSize = boot->bpbBytesPerSec * boot->bpbSecPerClust;
|
|
|
|
boot->NumFiles = 1;
|
|
boot->NumFree = 0;
|
|
|
|
return ret;
|
|
}
|
|
|
|
int
|
|
writefsinfo(int dosfs, struct bootblock *boot)
|
|
{
|
|
u_char fsinfo[2 * DOSBOOTBLOCKSIZE];
|
|
|
|
if (lseek(dosfs, boot->bpbFSInfo * boot->bpbBytesPerSec, SEEK_SET)
|
|
!= boot->bpbFSInfo * boot->bpbBytesPerSec
|
|
|| read(dosfs, fsinfo, sizeof fsinfo) != sizeof fsinfo) {
|
|
perr("could not read fsinfo block");
|
|
return FSFATAL;
|
|
}
|
|
fsinfo[0x1e8] = (u_char)boot->FSFree;
|
|
fsinfo[0x1e9] = (u_char)(boot->FSFree >> 8);
|
|
fsinfo[0x1ea] = (u_char)(boot->FSFree >> 16);
|
|
fsinfo[0x1eb] = (u_char)(boot->FSFree >> 24);
|
|
fsinfo[0x1ec] = (u_char)boot->FSNext;
|
|
fsinfo[0x1ed] = (u_char)(boot->FSNext >> 8);
|
|
fsinfo[0x1ee] = (u_char)(boot->FSNext >> 16);
|
|
fsinfo[0x1ef] = (u_char)(boot->FSNext >> 24);
|
|
if (lseek(dosfs, boot->bpbFSInfo * boot->bpbBytesPerSec, SEEK_SET)
|
|
!= boot->bpbFSInfo * boot->bpbBytesPerSec
|
|
|| write(dosfs, fsinfo, sizeof fsinfo)
|
|
!= sizeof fsinfo) {
|
|
perr("Unable to write bpbFSInfo");
|
|
return FSFATAL;
|
|
}
|
|
/*
|
|
* Technically, we should return FSBOOTMOD here.
|
|
*
|
|
* However, since Win95 OSR2 (the first M$ OS that has
|
|
* support for FAT32) doesn't maintain the FSINFO block
|
|
* correctly, it has to be fixed pretty often.
|
|
*
|
|
* Therefor, we handle the FSINFO block only informally,
|
|
* fixing it if necessary, but otherwise ignoring the
|
|
* fact that it was incorrect.
|
|
*/
|
|
return 0;
|
|
}
|