2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (C) 1995, 1996, 1997 Wolfgang Solfrank
5 * Copyright (c) 1995 Martin Husemann
6 * Some structure declaration borrowed from Paul Popelka
7 * (paulp@uts.amdahl.com), see /sys/msdosfs/ for reference.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 #include <sys/param.h>
42 #define SLOT_EMPTY 0x00 /* slot has never been used */
43 #define SLOT_E5 0x05 /* the real value is 0xe5 */
44 #define SLOT_DELETED 0xe5 /* file in this slot deleted */
46 #define ATTR_NORMAL 0x00 /* normal file */
47 #define ATTR_READONLY 0x01 /* file is readonly */
48 #define ATTR_HIDDEN 0x02 /* file is hidden */
49 #define ATTR_SYSTEM 0x04 /* file is a system file */
50 #define ATTR_VOLUME 0x08 /* entry is a volume label */
51 #define ATTR_DIRECTORY 0x10 /* entry is a directory name */
52 #define ATTR_ARCHIVE 0x20 /* file is new or modified */
54 #define ATTR_WIN95 0x0f /* long name record */
57 * This is the format of the contents of the deTime field in the direntry
59 * We don't use bitfields because we don't know how compilers for
60 * arbitrary machines will lay them out.
62 #define DT_2SECONDS_MASK 0x1F /* seconds divided by 2 */
63 #define DT_2SECONDS_SHIFT 0
64 #define DT_MINUTES_MASK 0x7E0 /* minutes */
65 #define DT_MINUTES_SHIFT 5
66 #define DT_HOURS_MASK 0xF800 /* hours */
67 #define DT_HOURS_SHIFT 11
70 * This is the format of the contents of the deDate field in the direntry
73 #define DD_DAY_MASK 0x1F /* day of month */
74 #define DD_DAY_SHIFT 0
75 #define DD_MONTH_MASK 0x1E0 /* month */
76 #define DD_MONTH_SHIFT 5
77 #define DD_YEAR_MASK 0xFE00 /* year - 1980 */
78 #define DD_YEAR_SHIFT 9
82 static struct dosDirEntry *newDosDirEntry(void);
83 static void freeDosDirEntry(struct dosDirEntry *);
84 static struct dirTodoNode *newDirTodo(void);
85 static void freeDirTodo(struct dirTodoNode *);
86 static char *fullpath(struct dosDirEntry *);
87 static u_char calcShortSum(u_char *);
88 static int delete(int, struct bootblock *, struct fatEntry *, cl_t, int,
90 static int removede(int, struct bootblock *, struct fatEntry *, u_char *,
91 u_char *, cl_t, cl_t, cl_t, char *, int);
92 static int checksize(struct bootblock *, struct fatEntry *, u_char *,
93 struct dosDirEntry *);
94 static int readDosDirSection(int, struct bootblock *, struct fatEntry *,
95 struct dosDirEntry *);
98 * Manage free dosDirEntry structures.
100 static struct dosDirEntry *freede;
102 static struct dosDirEntry *
105 struct dosDirEntry *de;
107 if (!(de = freede)) {
108 if (!(de = malloc(sizeof(*de))))
116 freeDosDirEntry(struct dosDirEntry *de)
123 * The same for dirTodoNode structures.
125 static struct dirTodoNode *freedt;
127 static struct dirTodoNode *
130 struct dirTodoNode *dt;
132 if (!(dt = freedt)) {
133 if (!(dt = malloc(sizeof(*dt))))
141 freeDirTodo(struct dirTodoNode *dt)
148 * The stack of unread directories
150 struct dirTodoNode *pendingDirectories = NULL;
153 * Return the full pathname for a directory entry.
156 fullpath(struct dosDirEntry *dir)
158 static char namebuf[MAXPATHLEN + 1];
162 cp = namebuf + sizeof namebuf;
166 np = dir->lname[0] ? dir->lname : dir->name;
168 if (cp <= namebuf + 1 + nl) {
184 * Calculate a checksum over an 8.3 alias name
187 calcShortSum(u_char *p)
192 for (i = 0; i < 11; i++) {
193 sum = (sum << 7)|(sum >> 1); /* rotate right */
201 * Global variables temporarily used during a directory scan
203 static char longName[DOSLONGNAMELEN] = "";
204 static u_char *buffer = NULL;
205 static u_char *delbuf = NULL;
207 struct dosDirEntry *rootDir;
208 static struct dosDirEntry *lostDir;
211 * Init internal state for a new directory scan.
214 resetDosDirSection(struct bootblock *boot, struct fatEntry *fat)
220 b1 = boot->bpbRootDirEnts * 32;
221 b2 = boot->bpbSecPerClust * boot->bpbBytesPerSec;
223 if (!(buffer = malloc(b1 > b2 ? b1 : b2))
224 || !(delbuf = malloc(b2))
225 || !(rootDir = newDosDirEntry())) {
226 perror("No space for directory");
229 memset(rootDir, 0, sizeof *rootDir);
230 if (boot->flags & FAT32) {
231 if (boot->bpbRootClust < CLUST_FIRST || boot->bpbRootClust >= boot->NumClusters) {
232 pfatal("Root directory starts with cluster out of range(%u)",
236 cl = fat[boot->bpbRootClust].next;
238 || (cl >= CLUST_RSRVD && cl< CLUST_EOFS)
239 || fat[boot->bpbRootClust].head != boot->bpbRootClust) {
240 if (cl == CLUST_FREE)
241 pwarn("Root directory starts with free cluster\n");
242 else if (cl >= CLUST_RSRVD)
243 pwarn("Root directory starts with cluster marked %s\n",
246 pfatal("Root directory doesn't start a cluster chain");
250 fat[boot->bpbRootClust].next = CLUST_FREE;
256 fat[boot->bpbRootClust].flags |= FAT_USED;
257 rootDir->head = boot->bpbRootClust;
264 * Cleanup after a directory scan
267 finishDosDirSection(void)
269 struct dirTodoNode *p, *np;
270 struct dosDirEntry *d, *nd;
272 for (p = pendingDirectories; p; p = np) {
276 pendingDirectories = NULL;
277 for (d = rootDir; d; d = nd) {
278 if ((nd = d->child) != NULL) {
286 rootDir = lostDir = NULL;
294 * Delete directory entries between startcl, startoff and endcl, endoff.
297 delete(int f, struct bootblock *boot, struct fatEntry *fat, cl_t startcl,
298 int startoff, cl_t endcl, int endoff, int notlast)
302 int clsz = boot->bpbSecPerClust * boot->bpbBytesPerSec;
304 s = delbuf + startoff;
306 while (startcl >= CLUST_FIRST && startcl < boot->NumClusters) {
307 if (startcl == endcl) {
312 off = startcl * boot->bpbSecPerClust + boot->ClusterOffset;
313 off *= boot->bpbBytesPerSec;
314 if (lseek(f, off, SEEK_SET) != off
315 || read(f, delbuf, clsz) != clsz) {
316 perror("Unable to read directory");
323 if (lseek(f, off, SEEK_SET) != off
324 || write(f, delbuf, clsz) != clsz) {
325 perror("Unable to write directory");
328 if (startcl == endcl)
330 startcl = fat[startcl].next;
337 removede(int f, struct bootblock *boot, struct fatEntry *fat, u_char *start,
338 u_char *end, cl_t startcl, cl_t endcl, cl_t curcl, char *path,
343 pwarn("Invalid long filename entry for %s\n", path);
346 pwarn("Invalid long filename entry at end of directory %s\n", path);
349 pwarn("Invalid long filename entry for volume label\n");
352 if (ask(0, "Remove")) {
353 if (startcl != curcl) {
354 if (delete(f, boot, fat,
355 startcl, start - buffer,
357 endcl == curcl) == FSFATAL)
362 for (; start < end; start += 32)
363 *start = SLOT_DELETED;
370 * Check an in-memory file entry
373 checksize(struct bootblock *boot, struct fatEntry *fat, u_char *p,
374 struct dosDirEntry *dir)
377 * Check size on ordinary files
379 int32_t physicalSize;
381 if (dir->head == CLUST_FREE)
384 if (dir->head < CLUST_FIRST || dir->head >= boot->NumClusters)
386 physicalSize = fat[dir->head].length * boot->ClusterSize;
388 if (physicalSize < dir->size) {
389 pwarn("size of %s is %u, should at most be %u\n",
390 fullpath(dir), dir->size, physicalSize);
391 if (ask(1, "Truncate")) {
392 dir->size = physicalSize;
393 p[28] = (u_char)physicalSize;
394 p[29] = (u_char)(physicalSize >> 8);
395 p[30] = (u_char)(physicalSize >> 16);
396 p[31] = (u_char)(physicalSize >> 24);
400 } else if (physicalSize - dir->size >= boot->ClusterSize) {
401 pwarn("%s has too many clusters allocated\n",
403 if (ask(1, "Drop superfluous clusters")) {
407 for (cl = dir->head; (sz += boot->ClusterSize) < dir->size;)
409 clearchain(boot, fat, fat[cl].next);
410 fat[cl].next = CLUST_EOF;
419 * Read a directory and
420 * - resolve long name records
421 * - enter file and directory records into the parent's list
422 * - push directories onto the todo-stack
425 readDosDirSection(int f, struct bootblock *boot, struct fatEntry *fat,
426 struct dosDirEntry *dir)
428 struct dosDirEntry dirent, *d;
429 u_char *p, *vallfn, *invlfn, *empty;
432 cl_t cl, valcl = ~0, invcl = ~0, empcl = ~0;
437 #define THISMOD 0x8000 /* Only used within this routine */
440 if (dir->parent && (cl < CLUST_FIRST || cl >= boot->NumClusters)) {
442 * Already handled somewhere else.
447 vallfn = invlfn = empty = NULL;
449 if (!(boot->flags & FAT32) && !dir->parent) {
450 last = boot->bpbRootDirEnts * 32;
451 off = boot->bpbResSectors + boot->bpbFATs * boot->FATsecs;
453 last = boot->bpbSecPerClust * boot->bpbBytesPerSec;
454 off = cl * boot->bpbSecPerClust + boot->ClusterOffset;
457 off *= boot->bpbBytesPerSec;
458 if (lseek(f, off, SEEK_SET) != off
459 || read(f, buffer, last) != last) {
460 perror("Unable to read directory");
465 * Check `.' and `..' entries here? XXX
467 for (p = buffer, i = 0; i < last; i++, p += 32) {
468 if (dir->fsckflags & DIREMPWARN) {
473 if (*p == SLOT_EMPTY || *p == SLOT_DELETED) {
474 if (*p == SLOT_EMPTY) {
475 dir->fsckflags |= DIREMPTY;
482 if (dir->fsckflags & DIREMPTY) {
483 if (!(dir->fsckflags & DIREMPWARN)) {
484 pwarn("%s has entries after end of directory\n",
486 if (ask(1, "Extend")) {
489 dir->fsckflags &= ~DIREMPTY;
490 if (delete(f, boot, fat,
491 empcl, empty - buffer,
492 cl, p - buffer, 1) == FSFATAL)
494 q = empcl == cl ? empty : buffer;
495 for (; q < p; q += 32)
497 mod |= THISMOD|FSDIRMOD;
498 } else if (ask(0, "Truncate"))
499 dir->fsckflags |= DIREMPWARN;
501 if (dir->fsckflags & DIREMPWARN) {
503 mod |= THISMOD|FSDIRMOD;
505 } else if (dir->fsckflags & DIREMPTY)
510 if (p[11] == ATTR_WIN95) {
512 if (shortSum != -1) {
518 memset(longName, 0, sizeof longName);
522 } else if (shortSum != p[13]
523 || lidx != (*p & LRNOMASK)) {
534 lidx = *p & LRNOMASK;
536 pwarn("invalid long name\n");
544 t = longName + --lidx * 13;
545 for (k = 1; k < 11 && t < longName + sizeof(longName); k += 2) {
546 if (!p[k] && !p[k + 1])
550 * Warn about those unusable chars in msdosfs here? XXX
556 for (k = 14; k < 26 && t < longName + sizeof(longName); k += 2) {
557 if (!p[k] && !p[k + 1])
564 for (k = 28; k < 32 && t < longName + sizeof(longName); k += 2) {
565 if (!p[k] && !p[k + 1])
571 if (t >= longName + sizeof(longName)) {
572 pwarn("long filename too long\n");
579 if (p[26] | (p[27] << 8)) {
580 pwarn("long filename record cluster start != 0\n");
587 continue; /* long records don't carry further
592 * This is a standard msdosfs directory entry.
594 memset(&dirent, 0, sizeof dirent);
597 * it's a short name record, but we need to know
598 * more, so get the flags first.
600 dirent.flags = p[11];
603 * Translate from 850 to ISO here XXX
605 for (j = 0; j < 8; j++)
606 dirent.name[j] = p[j];
607 dirent.name[8] = '\0';
608 for (k = 7; k >= 0 && dirent.name[k] == ' '; k--)
609 dirent.name[k] = '\0';
610 if (dirent.name[k] != '\0')
612 if (dirent.name[0] == SLOT_E5)
613 dirent.name[0] = 0xe5;
615 if (dirent.flags & ATTR_VOLUME) {
616 if (vallfn || invlfn) {
617 mod |= removede(f, boot, fat,
618 invlfn ? invlfn : vallfn, p,
619 invlfn ? invcl : valcl, -1, 0,
628 dirent.name[k++] = '.';
629 for (j = 0; j < 3; j++)
630 dirent.name[k++] = p[j+8];
631 dirent.name[k] = '\0';
632 for (k--; k >= 0 && dirent.name[k] == ' '; k--)
633 dirent.name[k] = '\0';
635 if (vallfn && shortSum != calcShortSum(p)) {
642 dirent.head = p[26] | (p[27] << 8);
643 if (boot->ClustMask == CLUST32_MASK)
644 dirent.head |= (p[20] << 16) | (p[21] << 24);
645 dirent.size = p[28] | (p[29] << 8) | (p[30] << 16) | (p[31] << 24);
647 strcpy(dirent.lname, longName);
653 dirent.next = dir->child;
656 mod |= k = removede(f, boot, fat,
657 invlfn, vallfn ? vallfn : p,
658 invcl, vallfn ? valcl : cl, cl,
659 fullpath(&dirent), 0);
663 ? (valcl == cl && vallfn != buffer)
669 vallfn = NULL; /* not used any longer */
672 if (dirent.size == 0 && !(dirent.flags & ATTR_DIRECTORY)) {
673 if (dirent.head != 0) {
674 pwarn("%s has clusters, but size 0\n",
676 if (ask(1, "Drop allocated clusters")) {
678 if (boot->ClustMask == CLUST32_MASK)
680 clearchain(boot, fat, dirent.head);
682 mod |= THISMOD|FSDIRMOD|FSFATMOD;
686 } else if (dirent.head == 0
687 && !strcmp(dirent.name, "..")
688 && dir->parent /* XXX */
689 && !dir->parent->parent) {
691 * Do nothing, the parent is the root
693 } else if (dirent.head < CLUST_FIRST
694 || dirent.head >= boot->NumClusters
695 || fat[dirent.head].next == CLUST_FREE
696 || (fat[dirent.head].next >= CLUST_RSRVD
697 && fat[dirent.head].next < CLUST_EOFS)
698 || fat[dirent.head].head != dirent.head) {
699 if (dirent.head == 0)
700 pwarn("%s has no clusters\n",
702 else if (dirent.head < CLUST_FIRST
703 || dirent.head >= boot->NumClusters)
704 pwarn("%s starts with cluster out of range(%u)\n",
707 else if (fat[dirent.head].next == CLUST_FREE)
708 pwarn("%s starts with free cluster\n",
710 else if (fat[dirent.head].next >= CLUST_RSRVD)
711 pwarn("%s starts with cluster marked %s\n",
713 rsrvdcltype(fat[dirent.head].next));
715 pwarn("%s doesn't start a cluster chain\n",
717 if (dirent.flags & ATTR_DIRECTORY) {
718 if (ask(0, "Remove")) {
720 mod |= THISMOD|FSDIRMOD;
725 if (ask(1, "Truncate")) {
726 p[28] = p[29] = p[30] = p[31] = 0;
728 if (boot->ClustMask == CLUST32_MASK)
731 mod |= THISMOD|FSDIRMOD;
737 if (dirent.head >= CLUST_FIRST && dirent.head < boot->NumClusters)
738 fat[dirent.head].flags |= FAT_USED;
740 if (dirent.flags & ATTR_DIRECTORY) {
742 * gather more info for directories
744 struct dirTodoNode *n;
747 pwarn("Directory %s has size != 0\n",
749 if (ask(1, "Correct")) {
750 p[28] = p[29] = p[30] = p[31] = 0;
752 mod |= THISMOD|FSDIRMOD;
757 * handle `.' and `..' specially
759 if (strcmp(dirent.name, ".") == 0) {
760 if (dirent.head != dir->head) {
761 pwarn("`.' entry in %s has incorrect start cluster\n",
763 if (ask(1, "Correct")) {
764 dirent.head = dir->head;
765 p[26] = (u_char)dirent.head;
766 p[27] = (u_char)(dirent.head >> 8);
767 if (boot->ClustMask == CLUST32_MASK) {
768 p[20] = (u_char)(dirent.head >> 16);
769 p[21] = (u_char)(dirent.head >> 24);
771 mod |= THISMOD|FSDIRMOD;
777 if (strcmp(dirent.name, "..") == 0) {
778 if (dir->parent) { /* XXX */
779 if (!dir->parent->parent) {
781 pwarn("`..' entry in %s has non-zero start cluster\n",
783 if (ask(1, "Correct")) {
786 if (boot->ClustMask == CLUST32_MASK)
788 mod |= THISMOD|FSDIRMOD;
792 } else if (dirent.head != dir->parent->head) {
793 pwarn("`..' entry in %s has incorrect start cluster\n",
795 if (ask(1, "Correct")) {
796 dirent.head = dir->parent->head;
797 p[26] = (u_char)dirent.head;
798 p[27] = (u_char)(dirent.head >> 8);
799 if (boot->ClustMask == CLUST32_MASK) {
800 p[20] = (u_char)(dirent.head >> 16);
801 p[21] = (u_char)(dirent.head >> 24);
803 mod |= THISMOD|FSDIRMOD;
811 /* create directory tree node */
812 if (!(d = newDosDirEntry())) {
813 perror("No space for directory");
816 memcpy(d, &dirent, sizeof(struct dosDirEntry));
817 /* link it into the tree */
820 /* Enter this directory into the todo list */
821 if (!(n = newDirTodo())) {
822 perror("No space for todo list");
825 n->next = pendingDirectories;
827 pendingDirectories = n;
829 mod |= k = checksize(boot, fat, p, &dirent);
837 if (lseek(f, off, SEEK_SET) != off
838 || write(f, buffer, last) != last) {
839 perror("Unable to write directory");
844 } while ((cl = fat[cl].next) >= CLUST_FIRST && cl < boot->NumClusters);
845 if (invlfn || vallfn)
846 mod |= removede(f, boot, fat,
847 invlfn ? invlfn : vallfn, p,
848 invlfn ? invcl : valcl, -1, 0,
850 return mod & ~THISMOD;
854 handleDirTree(int dosfs, struct bootblock *boot, struct fatEntry *fat)
858 mod = readDosDirSection(dosfs, boot, fat, rootDir);
863 * process the directory todo list
865 while (pendingDirectories) {
866 struct dosDirEntry *dir = pendingDirectories->dir;
867 struct dirTodoNode *n = pendingDirectories->next;
870 * remove TODO entry now, the list might change during
873 freeDirTodo(pendingDirectories);
874 pendingDirectories = n;
877 * handle subdirectory
879 mod |= readDosDirSection(dosfs, boot, fat, dir);
888 * Try to reconnect a FAT chain into dir
890 static u_char *lfbuf;
895 reconnect(int dosfs, struct bootblock *boot, struct fatEntry *fat, cl_t head)
897 struct dosDirEntry d;
900 if (!ask(1, "Reconnect"))
904 for (lostDir = rootDir->child; lostDir; lostDir = lostDir->next) {
905 if (!strcmp(lostDir->name, LOSTDIR))
908 if (!lostDir) { /* Create LOSTDIR? XXX */
909 pwarn("No %s directory\n", LOSTDIR);
914 lfbuf = malloc(boot->ClusterSize);
916 perror("No space for buffer");
924 for (; p < lfbuf + boot->ClusterSize; p += 32)
926 || *p == SLOT_DELETED)
928 if (p && p < lfbuf + boot->ClusterSize)
930 lfcl = p ? fat[lfcl].next : lostDir->head;
931 if (lfcl < CLUST_FIRST || lfcl >= boot->NumClusters) {
932 /* Extend LOSTDIR? XXX */
933 pwarn("No space in %s\n", LOSTDIR);
936 lfoff = lfcl * boot->ClusterSize
937 + boot->ClusterOffset * boot->bpbBytesPerSec;
938 if (lseek(dosfs, lfoff, SEEK_SET) != lfoff
939 || read(dosfs, lfbuf, boot->ClusterSize) != boot->ClusterSize) {
940 perror("could not read LOST.DIR");
947 /* Ensure uniqueness of entry here! XXX */
948 memset(&d, 0, sizeof d);
949 snprintf(d.name, sizeof(d.name), "%u", head);
952 d.size = fat[head].length * boot->ClusterSize;
956 memcpy(p, d.name, strlen(d.name));
957 p[26] = (u_char)d.head;
958 p[27] = (u_char)(d.head >> 8);
959 if (boot->ClustMask == CLUST32_MASK) {
960 p[20] = (u_char)(d.head >> 16);
961 p[21] = (u_char)(d.head >> 24);
963 p[28] = (u_char)d.size;
964 p[29] = (u_char)(d.size >> 8);
965 p[30] = (u_char)(d.size >> 16);
966 p[31] = (u_char)(d.size >> 24);
967 fat[head].flags |= FAT_USED;
968 if (lseek(dosfs, lfoff, SEEK_SET) != lfoff
969 || write(dosfs, lfbuf, boot->ClusterSize) != boot->ClusterSize) {
970 perror("could not write LOST.DIR");