2 /* $NetBSD: msdosfs_denode.c,v 1.28 1998/02/10 14:10:00 mrg Exp $ */
5 * Copyright (C) 1994, 1995, 1997 Wolfgang Solfrank.
6 * Copyright (C) 1994, 1995, 1997 TooLs GmbH.
8 * Original code by Paul Popelka (paulp@uts.amdahl.com) (see below).
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by TooLs GmbH.
21 * 4. The name of TooLs GmbH may not be used to endorse or promote products
22 * derived from this software without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
25 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
26 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
29 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
30 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
31 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
32 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
33 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 * Written by Paul Popelka (paulp@uts.amdahl.com)
38 * You can do anything you want with this software, just don't say you wrote
39 * it, and don't remove this notice.
41 * This software is provided "as is".
43 * The author supplies this software to be publicly redistributed on the
44 * understanding that the author is not responsible for the correct
45 * functioning of this software in any circumstances and is not liable for
46 * any damages caused by this software.
51 #include <sys/param.h>
52 #include <sys/systm.h>
53 #include <sys/kernel.h>
54 #include <sys/mount.h>
55 #include <sys/malloc.h>
58 #include <sys/clock.h>
59 #include <sys/vnode.h>
60 #include <sys/mutex.h>
63 #include <vm/vm_extern.h>
65 #include <fs/msdosfs/bpb.h>
66 #include <fs/msdosfs/msdosfsmount.h>
67 #include <fs/msdosfs/direntry.h>
68 #include <fs/msdosfs/denode.h>
69 #include <fs/msdosfs/fat.h>
71 static MALLOC_DEFINE(M_MSDOSFSNODE, "msdosfs_node", "MSDOSFS vnode private part");
74 de_vncmpf(struct vnode *vp, void *arg)
81 return (de->de_inode != *a);
85 * If deget() succeeds it returns with the gotten denode locked().
87 * pmp - address of msdosfsmount structure of the filesystem containing
88 * the denode of interest. The address of
89 * the msdosfsmount structure are used.
90 * dirclust - which cluster bp contains, if dirclust is 0 (root directory)
91 * diroffset is relative to the beginning of the root directory,
92 * otherwise it is cluster relative.
93 * diroffset - offset past begin of cluster of denode we want
94 * depp - returns the address of the gotten denode.
97 deget(pmp, dirclust, diroffset, depp)
98 struct msdosfsmount *pmp; /* so we know the maj/min number */
99 u_long dirclust; /* cluster this dir entry came from */
100 u_long diroffset; /* index of entry within the cluster */
101 struct denode **depp; /* returns the addr of the gotten denode */
105 struct mount *mntp = pmp->pm_mountp;
106 struct direntry *direntptr;
108 struct vnode *nvp, *xvp;
113 printf("deget(pmp %p, dirclust %lu, diroffset %lx, depp %p)\n",
114 pmp, dirclust, diroffset, depp);
118 * On FAT32 filesystems, root is a (more or less) normal
121 if (FAT32(pmp) && dirclust == MSDOSFSROOT)
122 dirclust = pmp->pm_rootdirblk;
125 * See if the denode is in the denode cache. Use the location of
126 * the directory entry to compute the hash value. For subdir use
127 * address of "." entry. For root dir (if not FAT32) use cluster
128 * MSDOSFSROOT, offset MSDOSFSROOT_OFS
130 * NOTE: The check for de_refcnt > 0 below insures the denode being
131 * examined does not represent an unlinked but still open file.
132 * These files are not to be accessible even when the directory
133 * entry that represented the file happens to be reused while the
134 * deleted file is still open.
136 inode = (uint64_t)pmp->pm_bpcluster * dirclust + diroffset;
138 error = vfs_hash_get(mntp, inode, LK_EXCLUSIVE, curthread, &nvp,
144 KASSERT((*depp)->de_dirclust == dirclust, ("wrong dirclust"));
145 KASSERT((*depp)->de_diroffset == diroffset, ("wrong diroffset"));
150 * Do the MALLOC before the getnewvnode since doing so afterward
151 * might cause a bogus v_data pointer to get dereferenced
152 * elsewhere if MALLOC should block.
154 MALLOC(ldep, struct denode *, sizeof(struct denode), M_MSDOSFSNODE, M_WAITOK);
157 * Directory entry was not in cache, have to create a vnode and
158 * copy it from the passed disk buffer.
160 /* getnewvnode() does a VREF() on the vnode */
161 error = getnewvnode("msdosfs", mntp, &msdosfs_vnodeops, &nvp);
164 FREE(ldep, M_MSDOSFSNODE);
167 bzero((caddr_t)ldep, sizeof *ldep);
169 ldep->de_vnode = nvp;
171 ldep->de_dirclust = dirclust;
172 ldep->de_diroffset = diroffset;
173 ldep->de_inode = inode;
174 fc_purge(ldep, 0); /* init the fat cache for this denode */
177 lockmgr(nvp->v_vnlock, LK_EXCLUSIVE, NULL, td);
178 error = insmntque(nvp, mntp);
180 FREE(ldep, M_MSDOSFSNODE);
184 error = vfs_hash_insert(nvp, inode, LK_EXCLUSIVE, td, &xvp,
191 /* XXX: Not sure this is right */
193 ldep->de_vnode = nvp;
199 * Copy the directory entry into the denode area of the vnode.
201 if ((dirclust == MSDOSFSROOT
202 || (FAT32(pmp) && dirclust == pmp->pm_rootdirblk))
203 && diroffset == MSDOSFSROOT_OFS) {
205 * Directory entry for the root directory. There isn't one,
206 * so we manufacture one. We should probably rummage
207 * through the root directory and find a label entry (if it
208 * exists), and then use the time and date from that entry
209 * as the time and date for the root denode.
211 nvp->v_vflag |= VV_ROOT; /* should be further down XXX */
213 ldep->de_Attributes = ATTR_DIRECTORY;
214 ldep->de_LowerCase = 0;
216 ldep->de_StartCluster = pmp->pm_rootdirblk;
217 /* de_FileSize will be filled in further down */
219 ldep->de_StartCluster = MSDOSFSROOT;
220 ldep->de_FileSize = pmp->pm_rootdirsize * DEV_BSIZE;
223 * fill in time and date so that fattime2timespec() doesn't
224 * spit up when called from msdosfs_getattr() with root
228 ldep->de_CTime = 0x0000; /* 00:00:00 */
229 ldep->de_CDate = (0 << DD_YEAR_SHIFT) | (1 << DD_MONTH_SHIFT)
230 | (1 << DD_DAY_SHIFT);
232 ldep->de_ADate = ldep->de_CDate;
233 ldep->de_MTime = ldep->de_CTime;
234 ldep->de_MDate = ldep->de_CDate;
235 /* leave the other fields as garbage */
237 error = readep(pmp, dirclust, diroffset, &bp, &direntptr);
240 * The denode does not contain anything useful, so
241 * it would be wrong to leave it on its hash chain.
242 * Arrange for vput() to just forget about it.
244 ldep->de_Name[0] = SLOT_DELETED;
250 DE_INTERNALIZE(ldep, direntptr);
255 * Fill in a few fields of the vnode and finish filling in the
256 * denode. Then return the address of the found denode.
258 if (ldep->de_Attributes & ATTR_DIRECTORY) {
260 * Since DOS directory entries that describe directories
261 * have 0 in the filesize field, we take this opportunity
262 * to find out the length of the directory and plug it into
263 * the denode structure.
268 * XXX Sometimes, these arrives that . entry have cluster
269 * number 0, when it shouldn't. Use real cluster number
270 * instead of what is written in directory entry.
272 if ((diroffset == 0) && (ldep->de_StartCluster != dirclust)) {
273 printf("deget(): . entry at clust %ld != %ld\n",
274 dirclust, ldep->de_StartCluster);
275 ldep->de_StartCluster = dirclust;
279 if (ldep->de_StartCluster != MSDOSFSROOT) {
280 error = pcbmap(ldep, 0xffff, 0, &size, 0);
281 if (error == E2BIG) {
282 ldep->de_FileSize = de_cn2off(pmp, size);
285 printf("deget(): pcbmap returned %d\n", error);
289 ldep->de_modrev = init_va_filerev();
295 deupdat(dep, waitfor)
301 struct direntry *dirp;
304 if (DETOV(dep)->v_mount->mnt_flag & MNT_RDONLY)
307 DETIMES(dep, &ts, &ts, &ts);
308 if ((dep->de_flag & DE_MODIFIED) == 0)
310 dep->de_flag &= ~DE_MODIFIED;
311 if (dep->de_Attributes & ATTR_DIRECTORY)
313 if (dep->de_refcnt <= 0)
315 error = readde(dep, &bp, &dirp);
318 DE_EXTERNALIZE(dirp, dep);
328 * Truncate the file described by dep to the length specified by length.
331 detrunc(dep, length, flags, cred, td)
344 int isadir = dep->de_Attributes & ATTR_DIRECTORY;
346 struct msdosfsmount *pmp = dep->de_pmp;
349 printf("detrunc(): file %s, length %lu, flags %x\n", dep->de_Name, length, flags);
353 * Disallow attempts to truncate the root directory since it is of
354 * fixed size. That's just the way dos filesystems are. We use
355 * the VROOT bit in the vnode because checking for the directory
356 * bit and a startcluster of 0 in the denode is not adequate to
357 * recognize the root directory at this point in a file or
360 if ((DETOV(dep)->v_vflag & VV_ROOT) && !FAT32(pmp)) {
361 printf("detrunc(): can't truncate root directory, clust %ld, offset %ld\n",
362 dep->de_dirclust, dep->de_diroffset);
367 if (dep->de_FileSize < length) {
368 vnode_pager_setsize(DETOV(dep), length);
369 return deextend(dep, length, cred);
373 * If the desired length is 0 then remember the starting cluster of
374 * the file and set the StartCluster field in the directory entry
375 * to 0. If the desired length is not zero, then get the number of
376 * the last cluster in the shortened file. Then get the number of
377 * the first cluster in the part of the file that is to be freed.
378 * Then set the next cluster pointer in the last cluster of the
379 * file to CLUST_EOFE.
382 chaintofree = dep->de_StartCluster;
383 dep->de_StartCluster = 0;
386 error = pcbmap(dep, de_clcount(pmp, length) - 1, 0,
390 printf("detrunc(): pcbmap fails %d\n", error);
396 fc_purge(dep, de_clcount(pmp, length));
399 * If the new length is not a multiple of the cluster size then we
400 * must zero the tail end of the new last cluster in case it
401 * becomes part of the file again because of a seek.
403 if ((boff = length & pmp->pm_crbomask) != 0) {
405 bn = cntobn(pmp, eofentry);
406 error = bread(pmp->pm_devvp, bn, pmp->pm_bpcluster,
411 printf("detrunc(): bread fails %d\n", error);
415 bzero(bp->b_data + boff, pmp->pm_bpcluster - boff);
424 * Write out the updated directory entry. Even if the update fails
425 * we free the trailing clusters.
427 dep->de_FileSize = length;
429 dep->de_flag |= DE_UPDATE|DE_MODIFIED;
430 allerror = vtruncbuf(DETOV(dep), cred, td, length, pmp->pm_bpcluster);
433 printf("detrunc(): vtruncbuf error %d\n", allerror);
435 error = deupdat(dep, 1);
436 if (error && (allerror == 0))
439 printf("detrunc(): allerror %d, eofentry %lu\n",
444 * If we need to break the cluster chain for the file then do it
447 if (eofentry != ~0) {
448 error = fatentry(FAT_GET_AND_SET, pmp, eofentry,
449 &chaintofree, CLUST_EOFE);
452 printf("detrunc(): fatentry errors %d\n", error);
456 fc_setcache(dep, FC_LASTFC, de_cluster(pmp, length - 1),
461 * Now free the clusters removed from the file because of the
464 if (chaintofree != 0 && !MSDOSFSEOF(pmp, chaintofree))
465 freeclusterchain(pmp, chaintofree);
471 * Extend the file described by dep to length specified by length.
474 deextend(dep, length, cred)
479 struct msdosfsmount *pmp = dep->de_pmp;
484 * The root of a DOS filesystem cannot be extended.
486 if ((DETOV(dep)->v_vflag & VV_ROOT) && !FAT32(pmp))
490 * Directories cannot be extended.
492 if (dep->de_Attributes & ATTR_DIRECTORY)
495 if (length <= dep->de_FileSize)
496 panic("deextend: file too large");
499 * Compute the number of clusters to allocate.
501 count = de_clcount(pmp, length) - de_clcount(pmp, dep->de_FileSize);
503 if (count > pmp->pm_freeclustercount)
505 error = extendfile(dep, count, NULL, NULL, DE_CLEAR);
507 /* truncate the added clusters away again */
508 (void) detrunc(dep, dep->de_FileSize, 0, cred, NULL);
512 dep->de_FileSize = length;
513 dep->de_flag |= DE_UPDATE|DE_MODIFIED;
514 return (deupdat(dep, 1));
518 * Move a denode to its correct hash queue after the file it represents has
519 * been moved to a new directory.
528 * Fix up the denode cache. If the denode is for a directory,
529 * there is nothing to do since the hash is based on the starting
530 * cluster of the directory file and that hasn't changed. If for a
531 * file the hash is based on the location of the directory entry,
532 * so we must remove it from the cache and re-enter it with the
533 * hash based on the new location of the directory entry.
536 if (dep->de_Attributes & ATTR_DIRECTORY)
540 dep->de_inode = (uint64_t)dep->de_pmp->pm_bpcluster * dep->de_dirclust +
542 vfs_hash_rehash(vp, dep->de_inode);
547 struct vop_reclaim_args /* {
551 struct vnode *vp = ap->a_vp;
552 struct denode *dep = VTODE(vp);
555 printf("msdosfs_reclaim(): dep %p, file %s, refcnt %ld\n",
556 dep, dep->de_Name, dep->de_refcnt);
559 if (prtactive && vrefcnt(vp) != 0)
560 vprint("msdosfs_reclaim(): pushing active", vp);
562 * Destroy the vm object and flush associated pages.
564 vnode_destroy_vobject(vp);
566 * Remove the denode from its hash chain.
570 * Purge old data structures associated with the denode.
575 FREE(dep, M_MSDOSFSNODE);
583 struct vop_inactive_args /* {
588 struct vnode *vp = ap->a_vp;
589 struct denode *dep = VTODE(vp);
590 struct thread *td = ap->a_td;
594 printf("msdosfs_inactive(): dep %p, de_Name[0] %x\n", dep, dep->de_Name[0]);
597 if (prtactive && vrefcnt(vp) != 0)
598 vprint("msdosfs_inactive(): pushing active", vp);
601 * Ignore denodes related to stale file handles.
603 if (dep->de_Name[0] == SLOT_DELETED)
607 * If the file has been deleted and it is on a read/write
608 * filesystem, then truncate the file, and mark the directory slot
609 * as empty. (This may not be necessary for the dos filesystem.)
612 printf("msdosfs_inactive(): dep %p, refcnt %ld, mntflag %x, MNT_RDONLY %x\n",
613 dep, dep->de_refcnt, vp->v_mount->mnt_flag, MNT_RDONLY);
615 if (dep->de_refcnt <= 0 && (vp->v_mount->mnt_flag & MNT_RDONLY) == 0) {
616 error = detrunc(dep, (u_long) 0, 0, NOCRED, td);
617 dep->de_flag |= DE_UPDATE;
618 dep->de_Name[0] = SLOT_DELETED;
624 * If we are done with the denode, reclaim it
625 * so that it can be reused immediately.
628 printf("msdosfs_inactive(): v_usecount %d, de_Name[0] %x\n",
629 vrefcnt(vp), dep->de_Name[0]);
631 if (dep->de_Name[0] == SLOT_DELETED)