1 /* $FreeBSD: src/sys/msdosfs/msdosfs_denode.c,v 1.47.2.3 2002/08/22 16:20:15 trhodes Exp $ */
2 /* $DragonFly: src/sys/vfs/msdosfs/msdosfs_denode.c,v 1.34 2007/08/08 00:12:51 swildner Exp $ */
3 /* $NetBSD: msdosfs_denode.c,v 1.28 1998/02/10 14:10:00 mrg Exp $ */
6 * Copyright (C) 1994, 1995, 1997 Wolfgang Solfrank.
7 * Copyright (C) 1994, 1995, 1997 TooLs GmbH.
9 * Original code by Paul Popelka (paulp@uts.amdahl.com) (see below).
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by TooLs GmbH.
22 * 4. The name of TooLs GmbH may not be used to endorse or promote products
23 * derived from this software without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
26 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
27 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
28 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
30 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
31 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
32 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
33 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
34 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 * Written by Paul Popelka (paulp@uts.amdahl.com)
39 * You can do anything you want with this software, just don't say you wrote
40 * it, and don't remove this notice.
42 * This software is provided "as is".
44 * The author supplies this software to be publicly redistributed on the
45 * understanding that the author is not responsible for the correct
46 * functioning of this software in any circumstances and is not liable for
47 * any damages caused by this software.
52 #include <sys/param.h>
53 #include <sys/systm.h>
54 #include <sys/kernel.h>
55 #include <sys/mount.h>
56 #include <sys/malloc.h>
59 #include <sys/vnode.h>
62 #include <vm/vm_extern.h>
65 #include "msdosfsmount.h"
70 static int msdosfs_hashins (struct denode
*dep
);
71 static void msdosfs_hashrem (struct denode
*dep
);
73 static MALLOC_DEFINE(M_MSDOSFSNODE
, "MSDOSFS node", "MSDOSFS vnode private part");
75 static struct denode
**dehashtbl
;
76 static u_long dehash
; /* size of hash table - 1 */
77 #define DEHASH(dev, dcl, doff) (dehashtbl[(minor(dev) + (dcl) + (doff) / \
78 sizeof(struct direntry)) & dehash])
79 static struct lwkt_token dehash_token
;
85 #define SETHIGH(q, h) { \
88 tmp.val[_QUAD_HIGHWORD] = (h); \
91 #define SETLOW(q, l) { \
94 tmp.val[_QUAD_LOWWORD] = (l); \
98 static struct denode
*
99 msdosfs_hashget (cdev_t dev
, u_long dirclust
, u_long diroff
);
103 msdosfs_init(struct vfsconf
*vfsp
)
106 while (dehash
< desiredvnodes
)
108 dehashtbl
= kmalloc(sizeof(void *) * dehash
, M_MSDOSFSMNT
,
111 lwkt_token_init(&dehash_token
);
116 msdosfs_uninit(struct vfsconf
*vfsp
)
120 kfree(dehashtbl
, M_MSDOSFSMNT
);
124 static struct denode
*
125 msdosfs_hashget(cdev_t dev
, u_long dirclust
, u_long diroff
)
131 lwkt_gettoken(&ilock
, &dehash_token
);
133 for (dep
= DEHASH(dev
, dirclust
, diroff
); dep
; dep
= dep
->de_next
) {
134 if (dirclust
!= dep
->de_dirclust
135 || diroff
!= dep
->de_diroffset
136 || dev
!= dep
->de_dev
137 || dep
->de_refcnt
== 0) {
141 if (vget(vp
, LK_EXCLUSIVE
))
145 * We must check to see if the inode has been ripped
146 * out from under us after blocking.
148 for (dep
= DEHASH(dev
, dirclust
, diroff
); dep
; dep
= dep
->de_next
) {
149 if (dirclust
== dep
->de_dirclust
150 && diroff
== dep
->de_diroffset
151 && dev
== dep
->de_dev
152 && dep
->de_refcnt
!= 0) {
156 if (dep
== NULL
|| DETOV(dep
) != vp
) {
160 lwkt_reltoken(&ilock
);
163 lwkt_reltoken(&ilock
);
169 msdosfs_hashins(struct denode
*dep
)
171 struct denode
**depp
, *deq
;
174 lwkt_gettoken(&ilock
, &dehash_token
);
175 depp
= &DEHASH(dep
->de_dev
, dep
->de_dirclust
, dep
->de_diroffset
);
176 while ((deq
= *depp
) != NULL
) {
177 if (deq
->de_dev
== dep
->de_dev
&&
178 deq
->de_dirclust
== dep
->de_dirclust
&&
179 deq
->de_diroffset
== dep
->de_diroffset
) {
180 lwkt_reltoken(&ilock
);
186 depp
= &deq
->de_next
;
190 lwkt_reltoken(&ilock
);
196 msdosfs_hashrem(struct denode
*dep
)
198 struct denode
**depp
, *deq
;
201 lwkt_gettoken(&ilock
, &dehash_token
);
202 depp
= &DEHASH(dep
->de_dev
, dep
->de_dirclust
, dep
->de_diroffset
);
203 while ((deq
= *depp
) != NULL
) {
206 depp
= &deq
->de_next
;
208 KKASSERT(dep
== deq
);
209 *depp
= dep
->de_next
;
211 lwkt_reltoken(&ilock
);
215 msdosfs_reinsert(struct denode
*ip
, u_long new_dirclust
, u_long new_diroffset
)
219 lwkt_gettoken(&ilock
, &dehash_token
);
221 ip
->de_dirclust
= new_dirclust
;
222 ip
->de_diroffset
= new_diroffset
;
224 lwkt_reltoken(&ilock
);
228 * If deget() succeeds it returns with the gotten denode locked().
230 * pmp - address of msdosfsmount structure of the filesystem containing
231 * the denode of interest. The pm_dev field and the address of
232 * the msdosfsmount structure are used.
233 * dirclust - which cluster bp contains, if dirclust is 0 (root directory)
234 * diroffset is relative to the beginning of the root directory,
235 * otherwise it is cluster relative.
236 * diroffset - offset past begin of cluster of denode we want
237 * depp - returns the address of the gotten denode.
240 deget(struct msdosfsmount
*pmp
, /* so we know the maj/min number */
241 u_long dirclust
, /* cluster this dir entry came from */
242 u_long diroffset
, /* index of entry within the cluster */
243 struct denode
**depp
) /* returns the addr of the gotten denode */
246 cdev_t dev
= pmp
->pm_dev
;
247 struct mount
*mntp
= pmp
->pm_mountp
;
248 struct direntry
*direntptr
;
255 kprintf("deget(pmp %p, dirclust %lu, diroffset %lx, depp %p)\n",
256 pmp
, dirclust
, diroffset
, depp
);
260 * On FAT32 filesystems, root is a (more or less) normal
263 if (FAT32(pmp
) && dirclust
== MSDOSFSROOT
)
264 dirclust
= pmp
->pm_rootdirblk
;
268 * See if the denode is in the denode cache. Use the location of
269 * the directory entry to compute the hash value. For subdir use
270 * address of "." entry. For root dir (if not FAT32) use cluster
271 * MSDOSFSROOT, offset MSDOSFSROOT_OFS
273 * NOTE: The check for de_refcnt > 0 below insures the denode being
274 * examined does not represent an unlinked but still open file.
275 * These files are not to be accessible even when the directory
276 * entry that represented the file happens to be reused while the
277 * deleted file is still open.
279 ldep
= msdosfs_hashget(dev
, dirclust
, diroffset
);
286 * Do the MALLOC before the getnewvnode since doing so afterward
287 * might cause a bogus v_data pointer to get dereferenced
288 * elsewhere if MALLOC should block.
290 MALLOC(ldep
, struct denode
*, sizeof(struct denode
), M_MSDOSFSNODE
, M_WAITOK
);
293 * Directory entry was not in cache, have to create a vnode and
294 * copy it from the passed disk buffer.
297 /* getnewvnode() does a vref() on the vnode */
298 error
= getnewvnode(VT_MSDOSFS
, mntp
, &nvp
, VLKTIMEOUT
, 0);
301 FREE(ldep
, M_MSDOSFSNODE
);
305 bzero((caddr_t
)ldep
, sizeof *ldep
);
306 ldep
->de_vnode
= nvp
;
310 ldep
->de_dirclust
= dirclust
;
311 ldep
->de_diroffset
= diroffset
;
312 fc_purge(ldep
, 0); /* init the fat cache for this denode */
315 * Insert the denode into the hash queue. If a collision occurs
316 * throw away the vnode and try again.
318 error
= msdosfs_hashins(ldep
);
319 if (error
== EBUSY
) {
322 kfree(ldep
, M_MSDOSFSNODE
);
327 kfree(ldep
, M_MSDOSFSNODE
);
334 * Copy the directory entry into the denode area of the vnode.
336 if ((dirclust
== MSDOSFSROOT
337 || (FAT32(pmp
) && dirclust
== pmp
->pm_rootdirblk
))
338 && diroffset
== MSDOSFSROOT_OFS
) {
340 * Directory entry for the root directory. There isn't one,
341 * so we manufacture one. We should probably rummage
342 * through the root directory and find a label entry (if it
343 * exists), and then use the time and date from that entry
344 * as the time and date for the root denode.
346 nvp
->v_flag
|= VROOT
; /* should be further down XXX */
348 ldep
->de_Attributes
= ATTR_DIRECTORY
;
349 ldep
->de_LowerCase
= 0;
351 ldep
->de_StartCluster
= pmp
->pm_rootdirblk
;
352 /* de_FileSize will be filled in further down */
354 ldep
->de_StartCluster
= MSDOSFSROOT
;
355 ldep
->de_FileSize
= pmp
->pm_rootdirsize
* DEV_BSIZE
;
358 * fill in time and date so that dos2unixtime() doesn't
359 * spit up when called from msdosfs_getattr() with root
363 ldep
->de_CTime
= 0x0000; /* 00:00:00 */
364 ldep
->de_CDate
= (0 << DD_YEAR_SHIFT
) | (1 << DD_MONTH_SHIFT
)
365 | (1 << DD_DAY_SHIFT
);
367 ldep
->de_ADate
= ldep
->de_CDate
;
368 ldep
->de_MTime
= ldep
->de_CTime
;
369 ldep
->de_MDate
= ldep
->de_CDate
;
370 /* leave the other fields as garbage */
372 error
= readep(pmp
, dirclust
, diroffset
, &bp
, &direntptr
);
375 * The denode does not contain anything useful, so
376 * it would be wrong to leave it on its hash chain.
377 * Arrange for vput() to just forget about it.
379 ldep
->de_Name
[0] = SLOT_DELETED
;
386 DE_INTERNALIZE(ldep
, direntptr
);
391 * Fill in a few fields of the vnode and finish filling in the
392 * denode. Then return the address of the found denode.
394 if (ldep
->de_Attributes
& ATTR_DIRECTORY
) {
396 * Since DOS directory entries that describe directories
397 * have 0 in the filesize field, we take this opportunity
398 * to find out the length of the directory and plug it into
399 * the denode structure.
404 * XXX Sometimes, these arrives that . entry have cluster
405 * number 0, when it shouldn't. Use real cluster number
406 * instead of what is written in directory entry.
408 if ((diroffset
== 0) && (ldep
->de_StartCluster
!= dirclust
)) {
409 kprintf("deget(): . entry at clust %ld != %ld\n",
410 dirclust
, ldep
->de_StartCluster
);
411 ldep
->de_StartCluster
= dirclust
;
415 if (ldep
->de_StartCluster
!= MSDOSFSROOT
) {
416 error
= pcbmap(ldep
, 0xffff, NULL
, &size
, NULL
);
417 if (error
== E2BIG
) {
418 ldep
->de_FileSize
= de_cn2off(pmp
, size
);
421 kprintf("deget(): pcbmap returned %d\n", error
);
427 SETHIGH(ldep
->de_modrev
, tv
.tv_sec
);
428 SETLOW(ldep
->de_modrev
, tv
.tv_usec
* 4294);
429 ldep
->de_devvp
= pmp
->pm_devvp
;
430 vref(ldep
->de_devvp
);
431 vinitvmio(nvp
, ldep
->de_FileSize
);
433 * Leave nvp locked and refd so the returned inode is effectively
441 deupdat(struct denode
*dep
, int waitfor
)
445 struct direntry
*dirp
;
448 if (DETOV(dep
)->v_mount
->mnt_flag
& MNT_RDONLY
)
451 DETIMES(dep
, &ts
, &ts
, &ts
);
452 if ((dep
->de_flag
& DE_MODIFIED
) == 0)
454 dep
->de_flag
&= ~DE_MODIFIED
;
455 if (dep
->de_Attributes
& ATTR_DIRECTORY
)
457 if (dep
->de_refcnt
<= 0)
459 error
= readde(dep
, &bp
, &dirp
);
462 DE_EXTERNALIZE(dirp
, dep
);
472 * Truncate the file described by dep to the length specified by length.
475 detrunc(struct denode
*dep
, u_long length
, int flags
)
483 int isadir
= dep
->de_Attributes
& ATTR_DIRECTORY
;
485 struct msdosfsmount
*pmp
= dep
->de_pmp
;
488 kprintf("detrunc(): file %s, length %lu, flags %x\n", dep
->de_Name
, length
, flags
);
492 * Disallow attempts to truncate the root directory since it is of
493 * fixed size. That's just the way dos filesystems are. We use
494 * the VROOT bit in the vnode because checking for the directory
495 * bit and a startcluster of 0 in the denode is not adequate to
496 * recognize the root directory at this point in a file or
499 if ((DETOV(dep
)->v_flag
& VROOT
) && !FAT32(pmp
)) {
500 kprintf("detrunc(): can't truncate root directory, clust %ld, offset %ld\n",
501 dep
->de_dirclust
, dep
->de_diroffset
);
506 if (dep
->de_FileSize
< length
) {
507 vnode_pager_setsize(DETOV(dep
), length
);
508 return deextend(dep
, length
);
512 * If the desired length is 0 then remember the starting cluster of
513 * the file and set the StartCluster field in the directory entry
514 * to 0. If the desired length is not zero, then get the number of
515 * the last cluster in the shortened file. Then get the number of
516 * the first cluster in the part of the file that is to be freed.
517 * Then set the next cluster pointer in the last cluster of the
518 * file to CLUST_EOFE.
521 chaintofree
= dep
->de_StartCluster
;
522 dep
->de_StartCluster
= 0;
525 error
= pcbmap(dep
, de_clcount(pmp
, length
) - 1,
526 NULL
, &eofentry
, NULL
);
529 kprintf("detrunc(): pcbmap fails %d\n", error
);
535 fc_purge(dep
, de_clcount(pmp
, length
));
538 * If the new length is not a multiple of the cluster size then we
539 * must zero the tail end of the new last cluster in case it
540 * becomes part of the file again because of a seek.
542 if ((boff
= length
& pmp
->pm_crbomask
) != 0) {
544 bn
= xcntobn(pmp
, eofentry
);
545 error
= bread(pmp
->pm_devvp
, de_bntodoff(pmp
, bn
), pmp
->pm_bpcluster
, &bp
);
547 cn
= de_cluster(pmp
, length
);
548 error
= bread(DETOV(dep
), de_cn2doff(pmp
, cn
), pmp
->pm_bpcluster
, &bp
);
553 kprintf("detrunc(): bread fails %d\n", error
);
558 * is this the right place for it?
560 bzero(bp
->b_data
+ boff
, pmp
->pm_bpcluster
- boff
);
568 * Write out the updated directory entry. Even if the update fails
569 * we free the trailing clusters.
571 dep
->de_FileSize
= length
;
573 dep
->de_flag
|= DE_UPDATE
|DE_MODIFIED
;
574 allerror
= vtruncbuf(DETOV(dep
), length
, pmp
->pm_bpcluster
);
577 kprintf("detrunc(): vtruncbuf error %d\n", allerror
);
579 error
= deupdat(dep
, 1);
580 if (error
&& (allerror
== 0))
583 kprintf("detrunc(): allerror %d, eofentry %lu\n",
588 * If we need to break the cluster chain for the file then do it
591 if (eofentry
!= ~0) {
592 error
= fatentry(FAT_GET_AND_SET
, pmp
, eofentry
,
593 &chaintofree
, CLUST_EOFE
);
596 kprintf("detrunc(): fatentry errors %d\n", error
);
600 fc_setcache(dep
, FC_LASTFC
, de_cluster(pmp
, length
- 1),
605 * Now free the clusters removed from the file because of the
608 if (chaintofree
!= 0 && !MSDOSFSEOF(pmp
, chaintofree
))
609 freeclusterchain(pmp
, chaintofree
);
615 * Extend the file described by dep to length specified by length.
618 deextend(struct denode
*dep
, u_long length
)
620 struct msdosfsmount
*pmp
= dep
->de_pmp
;
625 * The root of a DOS filesystem cannot be extended.
627 if ((DETOV(dep
)->v_flag
& VROOT
) && !FAT32(pmp
))
631 * Directories cannot be extended.
633 if (dep
->de_Attributes
& ATTR_DIRECTORY
)
636 if (length
<= dep
->de_FileSize
)
637 panic("deextend: file too large");
640 * Compute the number of clusters to allocate.
642 count
= de_clcount(pmp
, length
) - de_clcount(pmp
, dep
->de_FileSize
);
644 if (count
> pmp
->pm_freeclustercount
)
646 error
= extendfile(dep
, count
, NULL
, NULL
, DE_CLEAR
);
648 /* truncate the added clusters away again */
649 detrunc(dep
, dep
->de_FileSize
, 0);
653 dep
->de_FileSize
= length
;
654 dep
->de_flag
|= DE_UPDATE
|DE_MODIFIED
;
655 return (deupdat(dep
, 1));
659 * msdosfs_reclaim(struct vnode *a_vp)
662 msdosfs_reclaim(struct vop_reclaim_args
*ap
)
664 struct vnode
*vp
= ap
->a_vp
;
665 struct denode
*dep
= VTODE(vp
);
668 kprintf("msdosfs_reclaim(): dep %p, file %s, refcnt %ld\n",
669 dep
, dep
? (char *)dep
->de_Name
: "?", dep
? dep
->de_refcnt
: -1);
672 if (prtactive
&& vp
->v_sysref
.refcnt
> 1)
673 vprint("msdosfs_reclaim(): pushing active", vp
);
675 * Remove the denode from its hash chain.
679 msdosfs_hashrem(dep
);
681 vrele(dep
->de_devvp
);
684 kfree(dep
, M_MSDOSFSNODE
);
690 * msdosfs_inactive(struct vnode *a_vp)
693 msdosfs_inactive(struct vop_inactive_args
*ap
)
695 struct vnode
*vp
= ap
->a_vp
;
696 struct denode
*dep
= VTODE(vp
);
700 kprintf("msdosfs_inactive(): dep %p, de_Name[0] %x\n",
701 dep
, (dep
? dep
->de_Name
[0] : 0));
704 if (prtactive
&& vp
->v_sysref
.refcnt
> 1)
705 vprint("msdosfs_inactive(): pushing active", vp
);
708 * Ignore denodes related to stale file handles.
710 if (dep
== NULL
|| dep
->de_Name
[0] == SLOT_DELETED
)
714 * If the file has been deleted and it is on a read/write
715 * filesystem, then truncate the file, and mark the directory slot
716 * as empty. (This may not be necessary for the dos filesystem.)
719 kprintf("msdosfs_inactive(): dep %p, refcnt %ld, mntflag %x, MNT_RDONLY %x\n",
720 dep
, dep
->de_refcnt
, vp
->v_mount
->mnt_flag
, MNT_RDONLY
);
722 if (dep
->de_refcnt
<= 0 && (vp
->v_mount
->mnt_flag
& MNT_RDONLY
) == 0) {
723 error
= detrunc(dep
, (u_long
) 0, 0);
724 dep
->de_flag
|= DE_UPDATE
;
725 dep
->de_Name
[0] = SLOT_DELETED
;
731 * If we are done with the denode, reclaim it
732 * so that it can be reused immediately.
735 kprintf("msdosfs_inactive(): v_sysrefs %d, de_Name[0] %x\n",
736 vp
->v_sysref
.refcnt
, (dep
? dep
->de_Name
[0] : 0));
738 if (dep
== NULL
|| dep
->de_Name
[0] == SLOT_DELETED
)