1 /* $NetBSD: dosfs.c,v 1.19 2013/10/20 17:15:42 christos Exp $ */
4 * Copyright (c) 1996, 1998 Robert Nordier
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS
18 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
23 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
27 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 * Readonly filesystem for Microsoft FAT12/FAT16/FAT32 filesystems,
36 * XXX DOES NOT SUPPORT:
38 * LIBSA_FS_SINGLECOMPONENT
41 #include <sys/param.h>
43 #include <fs/msdosfs/bpb.h>
44 #include <fs/msdosfs/direntry.h>
47 #include <lib/libkern/libkern.h>
56 #define SECSIZ 512 /* sector size */
57 #define SSHIFT 9 /* SECSIZ shift */
58 #define DEPSEC 16 /* directory entries per sector */
59 #define DSHIFT 4 /* DEPSEC shift */
60 #define LOCLUS 2 /* lowest cluster number */
63 struct direntry de
; /* standard directory entry */
64 struct winentry xde
; /* extended directory entry */
68 struct open_file
*fd
; /* file descriptor */
69 u_char
*buf
; /* buffer */
70 u_int bufsec
; /* buffered sector */
71 u_int links
; /* active links to structure */
72 u_int spc
; /* sectors per cluster */
73 u_int bsize
; /* cluster size in bytes */
74 u_int bshift
; /* cluster conversion shift */
75 u_int dirents
; /* root directory entries */
76 u_int spf
; /* sectors per fat */
77 u_int rdcl
; /* root directory start cluster */
78 u_int lsnfat
; /* start of fat */
79 u_int lsndir
; /* start of root dir */
80 u_int lsndta
; /* start of data area */
81 u_int fatsz
; /* FAT entry size */
82 u_int xclus
; /* maximum cluster number */
86 DOS_FS
*fs
; /* associated filesystem */
87 struct direntry de
; /* directory entry */
88 u_int offset
; /* current offset */
89 u_int c
; /* last cluster read */
92 /* Initial portion of DOS boot sector */
94 u_char jmp
[3]; /* usually 80x86 'jmp' opcode */
95 u_char oem
[8]; /* OEM name and version */
96 struct byte_bpb710 bpb
; /* BPB */
99 /* Supply missing "." and ".." root directory entries */
100 static const char *const dotstr
[2] = {".", ".."};
101 static const struct direntry dot
[2] = {
102 {". ", " ", ATTR_DIRECTORY
,
103 0, 0, {0, 0}, {0, 0}, {0, 0}, {0, 0},
104 {0, 0}, {0x21, 0}, {0, 0}, {0, 0, 0, 0}},
106 {".. ", " ", ATTR_DIRECTORY
,
107 0, 0, {0, 0}, {0, 0}, {0, 0}, {0, 0},
108 {0, 0}, {0x21, 0}, {0, 0}, {0, 0, 0, 0}}
111 /* The usual conversion macros to avoid multiplication and division */
112 #define bytsec(n) ((n) >> SSHIFT)
113 #define secbyt(s) ((s) << SSHIFT)
114 #define entsec(e) ((e) >> DSHIFT)
115 #define bytblk(fs, n) ((n) >> (fs)->bshift)
116 #define blkbyt(fs, b) ((b) << (fs)->bshift)
117 #define secblk(fs, s) ((s) >> ((fs)->bshift - SSHIFT))
118 #define blksec(fs, b) ((b) << ((fs)->bshift - SSHIFT))
120 /* Convert cluster number to offset within filesystem */
121 #define blkoff(fs, b) (secbyt((fs)->lsndta) + blkbyt(fs, (b) - LOCLUS))
123 /* Convert cluster number to logical sector number */
124 #define blklsn(fs, b) ((fs)->lsndta + blksec(fs, (b) - LOCLUS))
126 /* Convert cluster number to offset within FAT */
127 #define fatoff(sz, c) ((sz) == 12 ? (c) + ((c) >> 1) : \
128 (sz) == 16 ? (c) << 1 : \
131 /* Does cluster number reference a valid data cluster? */
132 #define okclus(fs, c) ((c) >= LOCLUS && (c) <= (fs)->xclus)
134 /* Get start cluster from directory entry */
135 #define stclus(sz, de) ((sz) != 32 ? (u_int)getushort((de)->deStartCluster) : \
136 ((u_int)getushort((de)->deHighClust) << 16) | \
137 (u_int)getushort((de)->deStartCluster))
139 static int dosunmount(DOS_FS
*);
140 static int parsebs(DOS_FS
*, DOS_BS
*);
141 static int namede(DOS_FS
*, const char *, const struct direntry
**);
142 static int lookup(DOS_FS
*, u_int
, const char *, const struct direntry
**);
143 static void cp_xdnm(u_char
*, struct winentry
*);
144 static void cp_sfn(u_char
*, struct direntry
*);
145 static off_t
fsize(DOS_FS
*, struct direntry
*);
146 static int fatcnt(DOS_FS
*, u_int
);
147 static int fatget(DOS_FS
*, u_int
*);
148 static int fatend(u_int
, u_int
);
149 static int ioread(DOS_FS
*, u_int
, void *, u_int
);
150 static int iobuf(DOS_FS
*, u_int
);
151 static int ioget(struct open_file
*, u_int
, void *, u_int
);
153 #define strcasecmp(s1, s2) dos_strcasecmp(s1, s2)
155 strcasecmp(const char *s1
, const char *s2
)
158 #define TO_UPPER(c) ((c) >= 'a' && (c) <= 'z' ? (c) - ('a' - 'A') : (c))
162 if (TO_UPPER(c1
) != TO_UPPER(c2
))
171 * Mount DOS filesystem
174 dos_mount(DOS_FS
*fs
, struct open_file
*fd
)
178 (void)memset(fs
, 0, sizeof(DOS_FS
));
180 if ((err
= !(fs
->buf
= alloc(SECSIZ
)) ? errno
: 0) ||
181 (err
= ioget(fs
->fd
, 0, fs
->buf
, 1)) ||
182 (err
= parsebs(fs
, (DOS_BS
*)fs
->buf
))) {
183 (void) dosunmount(fs
);
189 #ifndef LIBSA_NO_FS_CLOSE
191 * Unmount mounted filesystem
194 dos_unmount(DOS_FS
*fs
)
200 if ((err
= dosunmount(fs
)))
207 * Common code shared by dos_mount() and dos_unmount()
210 dosunmount(DOS_FS
*fs
)
213 dealloc(fs
->buf
, SECSIZ
);
214 dealloc(fs
, sizeof(DOS_FS
));
222 dosfs_open(const char *path
, struct open_file
*fd
)
224 const struct direntry
*de
;
230 /* Allocate mount structure, associate with open */
231 fs
= alloc(sizeof(DOS_FS
));
233 if ((err
= dos_mount(fs
, fd
)))
236 if ((err
= namede(fs
, path
, &de
)))
239 clus
= stclus(fs
->fatsz
, de
);
240 size
= getulong(de
->deFileSize
);
242 if ((!(de
->deAttributes
& ATTR_DIRECTORY
) && (!clus
!= !size
)) ||
243 ((de
->deAttributes
& ATTR_DIRECTORY
) && size
) ||
244 (clus
&& !okclus(fs
, clus
))) {
249 f
= alloc(sizeof(DOS_FILE
));
251 /* due to __internal_memset_ causing all sorts of register spillage
252 (and being completely unoptimized for zeroing small amounts of
253 memory), if we hand-initialize the remaining members of f to zero,
254 the code size drops 68 bytes. This makes no sense, admittedly. */
258 (void)memset(f
, 0, sizeof(DOS_FILE
));
263 fd
->f_fsdata
= (void *)f
;
274 dosfs_read(struct open_file
*fd
, void *vbuf
, size_t nbyte
, size_t *resid
)
277 u_int8_t
*buf
= vbuf
;
278 u_int nb
, off
, clus
, c
, cnt
, n
;
279 DOS_FILE
*f
= (DOS_FILE
*)fd
->f_fsdata
;
283 if ((size
= fsize(f
->fs
, &f
->de
)) == -1)
285 if (nb
> (n
= size
- f
->offset
))
288 if ((clus
= stclus(f
->fs
->fatsz
, &f
->de
)))
289 off
&= f
->fs
->bsize
- 1;
296 n
= bytblk(f
->fs
, f
->offset
);
301 if ((err
= fatget(f
->fs
, &c
)))
303 if (!okclus(f
->fs
, c
)) {
308 if (!clus
|| (n
= f
->fs
->bsize
- off
) > cnt
)
310 if ((err
= ioread(f
->fs
, (c
? blkoff(f
->fs
, c
) :
311 secbyt(f
->fs
->lsndir
)) + off
,
322 *resid
= nbyte
- nb
+ cnt
;
326 #ifndef LIBSA_NO_FS_WRITE
331 dosfs_write(struct open_file
*fd
, void *start
, size_t size
, size_t *resid
)
336 #endif /* !LIBSA_NO_FS_WRITE */
338 #ifndef LIBSA_NO_FS_SEEK
340 * Reposition within file
343 dosfs_seek(struct open_file
*fd
, off_t offset
, int whence
)
347 DOS_FILE
*f
= (DOS_FILE
*)fd
->f_fsdata
;
349 size
= getulong(f
->de
.deFileSize
);
364 if (off
< 0 || off
> size
)
366 f
->offset
= (u_int
) off
;
370 #endif /* !LIBSA_NO_FS_SEEK */
372 #ifndef LIBSA_NO_FS_CLOSE
377 dosfs_close(struct open_file
*fd
)
379 DOS_FILE
*f
= (DOS_FILE
*)fd
->f_fsdata
;
383 dealloc(f
, sizeof(DOS_FILE
));
387 #endif /* !LIBSA_NO_FS_CLOSE */
390 * Return some stat information on a file.
393 dosfs_stat(struct open_file
*fd
, struct stat
*sb
)
395 DOS_FILE
*f
= (DOS_FILE
*)fd
->f_fsdata
;
397 /* only important stuff */
398 sb
->st_mode
= (f
->de
.deAttributes
& ATTR_DIRECTORY
) ?
399 (S_IFDIR
| 0555) : (S_IFREG
| 0444);
403 if ((sb
->st_size
= fsize(f
->fs
, &f
->de
)) == -1)
408 #if defined(LIBSA_ENABLE_LS_OP)
410 dosfs_ls(struct open_file
*f
, const char *pattern
,
411 void (*funcp
)(char* arg
), char* path
)
413 printf("Currently ls command is unsupported by dosfs\n");
419 * Parse DOS boot sector
422 parsebs(DOS_FS
*fs
, DOS_BS
*bs
)
426 if ((bs
->jmp
[0] != 0x69 &&
427 bs
->jmp
[0] != 0xe9 &&
428 (bs
->jmp
[0] != 0xeb || bs
->jmp
[2] != 0x90)) ||
429 bs
->bpb
.bpbMedia
< 0xf0)
431 if (getushort(bs
->bpb
.bpbBytesPerSec
) != SECSIZ
)
433 if (!(fs
->spc
= bs
->bpb
.bpbSecPerClust
) || fs
->spc
& (fs
->spc
- 1))
435 fs
->bsize
= secbyt(fs
->spc
);
436 fs
->bshift
= ffs(fs
->bsize
) - 1;
437 if ((fs
->spf
= getushort(bs
->bpb
.bpbFATsecs
))) {
438 if (bs
->bpb
.bpbFATs
!= 2)
440 if (!(fs
->dirents
= getushort(bs
->bpb
.bpbRootDirEnts
)))
443 if (!(fs
->spf
= getulong(bs
->bpb
.bpbBigFATsecs
)))
445 if (!bs
->bpb
.bpbFATs
|| bs
->bpb
.bpbFATs
> 16)
447 if ((fs
->rdcl
= getulong(bs
->bpb
.bpbRootClust
)) < LOCLUS
)
450 if (!(fs
->lsnfat
= getushort(bs
->bpb
.bpbResSectors
)))
452 fs
->lsndir
= fs
->lsnfat
+ fs
->spf
* bs
->bpb
.bpbFATs
;
453 fs
->lsndta
= fs
->lsndir
+ entsec(fs
->dirents
);
454 if (!(sc
= getushort(bs
->bpb
.bpbSectors
)) &&
455 !(sc
= getulong(bs
->bpb
.bpbHugeSectors
)))
459 if ((fs
->xclus
= secblk(fs
, sc
- fs
->lsndta
) + 1) < LOCLUS
)
461 fs
->fatsz
= fs
->dirents
? fs
->xclus
< 0xff6 ? 12 : 16 : 32;
462 sc
= (secbyt(fs
->spf
) << 1) / (fs
->fatsz
>> 2) - 1;
469 * Return directory entry from path
472 namede(DOS_FS
*fs
, const char *path
, const struct direntry
**dep
)
475 const struct direntry
*de
;
485 if (!(s
= strchr(path
, '/')))
487 if ((n
= s
- path
) > 255)
489 memcpy(name
, path
, n
);
492 if (!(de
->deAttributes
& ATTR_DIRECTORY
))
494 if ((err
= lookup(fs
, stclus(fs
->fatsz
, de
), name
, &de
)))
504 * Lookup path segment
507 lookup(DOS_FS
*fs
, u_int clus
, const char *name
, const struct direntry
**dep
)
509 static DOS_DIR
*dir
= NULL
;
512 u_int nsec
, lsec
, xdn
, chk
, sec
, ent
, x
;
516 for (ent
= 0; ent
< 2; ent
++)
517 if (!strcasecmp(name
, dotstr
[ent
])) {
523 dir
= alloc(sizeof(DOS_DIR
) * DEPSEC
);
528 if (!clus
&& fs
->fatsz
== 32)
530 nsec
= !clus
? entsec(fs
->dirents
) : fs
->spc
;
536 else if (okclus(fs
, clus
))
537 lsec
= blklsn(fs
, clus
);
542 for (sec
= 0; sec
< nsec
; sec
++) {
543 if ((err
= ioget(fs
->fd
, lsec
+ sec
, dir
, 1)))
545 for (ent
= 0; ent
< DEPSEC
; ent
++) {
546 if (!*dir
[ent
].de
.deName
) {
550 if (*dir
[ent
].de
.deName
!= 0xe5) {
551 if (dir
[ent
].de
.deAttributes
==
553 x
= dir
[ent
].xde
.weCnt
;
556 dir
[ent
].xde
.weChksum
==
559 chk
= dir
[ent
].xde
.weChksum
;
562 if (x
>= 1 && x
<= 20) {
563 cp_xdnm(lfn
, &dir
[ent
].xde
);
568 } else if (!(dir
[ent
].de
.deAttributes
&
570 if ((ok
= xdn
== 1)) {
573 x
= ((((x
& 1) << 7) | (x
>> 1)) +
574 msdos_dirchar(&dir
[ent
].de
,i
)) & 0xff;
576 !strcasecmp(name
, (const char *)lfn
);
579 cp_sfn(sfn
, &dir
[ent
].de
);
580 ok
= !strcasecmp(name
, (const char *)sfn
);
593 if ((err
= fatget(fs
, &clus
)))
595 if (fatend(fs
->fatsz
, clus
))
600 dealloc(dir
, sizeof(DOS_DIR
) * DEPSEC
);
607 * Copy name from extended directory entry
610 cp_xdnm(u_char
*lfn
, struct winentry
*xde
)
612 static const struct {
616 { offsetof(struct winentry
, wePart1
),
617 sizeof(xde
->wePart1
) / 2 },
618 { offsetof(struct winentry
, wePart2
),
619 sizeof(xde
->wePart2
) / 2 },
620 { offsetof(struct winentry
, wePart3
),
621 sizeof(xde
->wePart3
) / 2 }
626 lfn
+= 13 * ((xde
->weCnt
& WIN_CNT
) - 1);
627 for (n
= 0; n
< 3; n
++)
628 for (p
= (u_char
*)xde
+ ix
[n
].off
, x
= ix
[n
].dim
; x
;
630 if ((c
= getushort(p
)) && (c
< 32 || c
> 127))
635 if (xde
->weCnt
& WIN_LAST
)
640 * Copy short filename
643 cp_sfn(u_char
*sfn
, struct direntry
*de
)
649 if (*de
->deName
!= ' ') {
650 for (j
= 7; de
->deName
[j
] == ' '; j
--);
651 for (i
= 0; i
<= j
; i
++)
652 *p
++ = de
->deName
[i
];
653 if (*de
->deExtension
!= ' ') {
655 for (j
= 2; de
->deExtension
[j
] == ' '; j
--);
656 for (i
= 0; i
<= j
; i
++)
657 *p
++ = de
->deExtension
[i
];
666 * Return size of file in bytes
669 fsize(DOS_FS
*fs
, struct direntry
*de
)
675 if (!(size
= getulong(de
->deFileSize
)) &&
676 de
->deAttributes
& ATTR_DIRECTORY
) {
677 if (!(c
= getushort(de
->deStartCluster
))) {
678 size
= fs
->dirents
* sizeof(struct direntry
);
680 if ((n
= fatcnt(fs
, c
)) == -1)
682 size
= blkbyt(fs
, n
);
689 * Count number of clusters in chain
692 fatcnt(DOS_FS
*fs
, u_int c
)
696 for (n
= 0; okclus(fs
, c
); n
++)
699 return fatend(fs
->fatsz
, c
) ? n
: -1;
703 * Get next cluster in cluster chain
706 fatget(DOS_FS
*fs
, u_int
*c
)
712 err
= ioread(fs
, secbyt(fs
->lsnfat
) + fatoff(fs
->fatsz
, *c
), buf
,
713 fs
->fatsz
!= 32 ? 2 : 4);
716 x
= fs
->fatsz
!= 32 ? getushort(buf
) : getulong(buf
);
717 *c
= fs
->fatsz
== 12 ? *c
& 1 ? x
>> 4 : x
& 0xfff : x
;
722 * Is cluster an end-of-chain marker?
725 fatend(u_int sz
, u_int c
)
727 return c
> (sz
== 12 ? 0xff7U
: sz
== 16 ? 0xfff7U
: 0xffffff7);
731 * Offset-based I/O primitive
734 ioread(DOS_FS
*fs
, u_int offset
, void *buf
, u_int nbyte
)
741 if ((off
= offset
& (SECSIZ
- 1))) {
743 if ((err
= iobuf(fs
, bytsec(offset
))))
746 if ((n
= SECSIZ
- off
) > nbyte
)
748 memcpy(s
, fs
->buf
+ off
, n
);
752 n
= nbyte
& (SECSIZ
- 1);
754 if ((err
= ioget(fs
->fd
, bytsec(offset
), s
, bytsec(nbyte
))))
760 if ((err
= iobuf(fs
, bytsec(offset
))))
762 memcpy(s
, fs
->buf
, n
);
768 * Buffered sector-based I/O primitive
771 iobuf(DOS_FS
*fs
, u_int lsec
)
775 if (fs
->bufsec
!= lsec
) {
776 if ((err
= ioget(fs
->fd
, lsec
, fs
->buf
, 1)))
784 * Sector-based I/O primitive
787 ioget(struct open_file
*fd
, u_int lsec
, void *buf
, u_int nsec
)
792 #ifndef LIBSA_NO_TWIDDLE
795 err
= DEV_STRATEGY(fd
->f_dev
)(fd
->f_devdata
, F_READ
, lsec
,
796 secbyt(nsec
), buf
, &rsize
);