1 /* $FreeBSD$ */ 2 /* $NetBSD: denode.h,v 1.25 1997/11/17 15:36:28 ws Exp $ */ 3 4 /*- 5 * Copyright (C) 1994, 1995, 1997 Wolfgang Solfrank. 6 * Copyright (C) 1994, 1995, 1997 TooLs GmbH. 7 * All rights reserved. 8 * Original code by Paul Popelka (paulp@uts.amdahl.com) (see below). 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 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. 23 * 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. 34 */ 35 /*- 36 * Written by Paul Popelka (paulp@uts.amdahl.com) 37 * 38 * You can do anything you want with this software, just don't say you wrote 39 * it, and don't remove this notice. 40 * 41 * This software is provided "as is". 42 * 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. 47 * 48 * October 1992 49 */ 50 #ifndef _FS_MSDOSFS_DENODE_H_ 51 #define _FS_MSDOSFS_DENODE_H_ 52 53 /* 54 * This is the pc filesystem specific portion of the vnode structure. 55 * 56 * To describe a file uniquely the de_dirclust, de_diroffset, and 57 * de_StartCluster fields are used. 58 * 59 * de_dirclust contains the cluster number of the directory cluster 60 * containing the entry for a file or directory. 61 * de_diroffset is the index into the cluster for the entry describing 62 * a file or directory. 63 * de_StartCluster is the number of the first cluster of the file or directory. 64 * 65 * Now to describe the quirks of the pc filesystem. 66 * - Clusters 0 and 1 are reserved. 67 * - The first allocatable cluster is 2. 68 * - The root directory is of fixed size and all blocks that make it up 69 * are contiguous. 70 * - Cluster 0 refers to the root directory when it is found in the 71 * startcluster field of a directory entry that points to another directory. 72 * - Cluster 0 implies a 0 length file when found in the start cluster field 73 * of a directory entry that points to a file. 74 * - You can't use the cluster number 0 to derive the address of the root 75 * directory. 76 * - Multiple directory entries can point to a directory. The entry in the 77 * parent directory points to a child directory. Any directories in the 78 * child directory contain a ".." entry that points back to the parent. 79 * The child directory itself contains a "." entry that points to itself. 80 * - The root directory does not contain a "." or ".." entry. 81 * - Directory entries for directories are never changed once they are created 82 * (except when removed). The size stays 0, and the last modification time 83 * is never changed. This is because so many directory entries can point to 84 * the physical clusters that make up a directory. It would lead to an 85 * update nightmare. 86 * - The length field in a directory entry pointing to a directory contains 0 87 * (always). The only way to find the end of a directory is to follow the 88 * cluster chain until the "last cluster" marker is found. 89 * 90 * My extensions to make this house of cards work. These apply only to the in 91 * memory copy of the directory entry. 92 * - A reference count for each denode will be kept since dos doesn't keep such 93 * things. 94 */ 95 96 /* 97 * Internal pseudo-offset for (nonexistent) directory entry for the root 98 * dir in the root dir 99 */ 100 #define MSDOSFSROOT_OFS 0x1fffffff 101 102 /* 103 * The FAT cache structure. fc_fsrcn is the filesystem relative cluster 104 * number that corresponds to the file relative cluster number in this 105 * structure (fc_frcn). 106 */ 107 struct fatcache { 108 u_long fc_frcn; /* file relative cluster number */ 109 u_long fc_fsrcn; /* filesystem relative cluster number */ 110 }; 111 112 /* 113 * The FAT entry cache as it stands helps make extending files a "quick" 114 * operation by avoiding having to scan the FAT to discover the last 115 * cluster of the file. The cache also helps sequential reads by 116 * remembering the last cluster read from the file. This also prevents us 117 * from having to rescan the FAT to find the next cluster to read. This 118 * cache is probably pretty worthless if a file is opened by multiple 119 * processes. 120 */ 121 #define FC_SIZE 3 /* number of entries in the cache */ 122 #define FC_LASTMAP 0 /* entry the last call to pcbmap() resolved 123 * to */ 124 #define FC_LASTFC 1 /* entry for the last cluster in the file */ 125 #define FC_NEXTTOLASTFC 2 /* entry for a close to the last cluster in 126 * the file */ 127 128 #define FCE_EMPTY 0xffffffff /* doesn't represent an actual cluster # */ 129 130 /* 131 * Set a slot in the FAT cache. 132 */ 133 #define fc_setcache(dep, slot, frcn, fsrcn) \ 134 (dep)->de_fc[(slot)].fc_frcn = (frcn); \ 135 (dep)->de_fc[(slot)].fc_fsrcn = (fsrcn); 136 137 /* 138 * This is the in memory variant of a dos directory entry. It is usually 139 * contained within a vnode. 140 */ 141 struct denode { 142 struct vnode *de_vnode; /* addr of vnode we are part of */ 143 u_long de_flag; /* flag bits */ 144 u_long de_dirclust; /* cluster of the directory file containing this entry */ 145 u_long de_diroffset; /* offset of this entry in the directory cluster */ 146 u_long de_fndoffset; /* offset of found dir entry */ 147 int de_fndcnt; /* number of slots before de_fndoffset */ 148 long de_refcnt; /* reference count */ 149 struct msdosfsmount *de_pmp; /* addr of our mount struct */ 150 u_char de_Name[12]; /* name, from DOS directory entry */ 151 u_char de_Attributes; /* attributes, from directory entry */ 152 u_char de_LowerCase; /* NT VFAT lower case flags */ 153 u_char de_CHun; /* Hundredth of second of CTime*/ 154 u_short de_CTime; /* creation time */ 155 u_short de_CDate; /* creation date */ 156 u_short de_ADate; /* access date */ 157 u_short de_MTime; /* modification time */ 158 u_short de_MDate; /* modification date */ 159 u_long de_StartCluster; /* starting cluster of file */ 160 u_long de_FileSize; /* size of file in bytes */ 161 struct fatcache de_fc[FC_SIZE]; /* FAT cache */ 162 u_quad_t de_modrev; /* Revision level for lease. */ 163 uint64_t de_inode; /* Inode number (really byte offset of direntry) */ 164 }; 165 166 /* 167 * Values for the de_flag field of the denode. 168 */ 169 #define DE_UPDATE 0x0004 /* Modification time update request */ 170 #define DE_CREATE 0x0008 /* Creation time update */ 171 #define DE_ACCESS 0x0010 /* Access time update */ 172 #define DE_MODIFIED 0x0020 /* Denode has been modified */ 173 #define DE_RENAME 0x0040 /* Denode is in the process of being renamed */ 174 175 176 /* 177 * Transfer directory entries between internal and external form. 178 * dep is a struct denode * (internal form), 179 * dp is a struct direntry * (external form). 180 */ 181 #define DE_INTERNALIZE32(dep, dp) \ 182 ((dep)->de_StartCluster |= getushort((dp)->deHighClust) << 16) 183 #define DE_INTERNALIZE(dep, dp) \ 184 (memcpy((dep)->de_Name, (dp)->deName, 11), \ 185 (dep)->de_Attributes = (dp)->deAttributes, \ 186 (dep)->de_LowerCase = (dp)->deLowerCase, \ 187 (dep)->de_CHun = (dp)->deCHundredth, \ 188 (dep)->de_CTime = getushort((dp)->deCTime), \ 189 (dep)->de_CDate = getushort((dp)->deCDate), \ 190 (dep)->de_ADate = getushort((dp)->deADate), \ 191 (dep)->de_MTime = getushort((dp)->deMTime), \ 192 (dep)->de_MDate = getushort((dp)->deMDate), \ 193 (dep)->de_StartCluster = getushort((dp)->deStartCluster), \ 194 (dep)->de_FileSize = getulong((dp)->deFileSize), \ 195 (FAT32((dep)->de_pmp) ? DE_INTERNALIZE32((dep), (dp)) : 0)) 196 197 #define DE_EXTERNALIZE(dp, dep) \ 198 (memcpy((dp)->deName, (dep)->de_Name, 11), \ 199 (dp)->deAttributes = (dep)->de_Attributes, \ 200 (dp)->deLowerCase = (dep)->de_LowerCase, \ 201 (dp)->deCHundredth = (dep)->de_CHun, \ 202 putushort((dp)->deCTime, (dep)->de_CTime), \ 203 putushort((dp)->deCDate, (dep)->de_CDate), \ 204 putushort((dp)->deADate, (dep)->de_ADate), \ 205 putushort((dp)->deMTime, (dep)->de_MTime), \ 206 putushort((dp)->deMDate, (dep)->de_MDate), \ 207 putushort((dp)->deStartCluster, (dep)->de_StartCluster), \ 208 putulong((dp)->deFileSize, \ 209 ((dep)->de_Attributes & ATTR_DIRECTORY) ? 0 : (dep)->de_FileSize), \ 210 putushort((dp)->deHighClust, (dep)->de_StartCluster >> 16)) 211 212 #if defined(_KERNEL) || defined(MAKEFS) 213 214 #define VTODE(vp) ((struct denode *)(vp)->v_data) 215 #define DETOV(de) ((de)->de_vnode) 216 217 #define DETIMES(dep, acc, mod, cre) do { \ 218 if ((dep)->de_flag & DE_UPDATE) { \ 219 (dep)->de_flag |= DE_MODIFIED; \ 220 timespec2fattime((mod), 0, &(dep)->de_MDate, \ 221 &(dep)->de_MTime, NULL); \ 222 (dep)->de_Attributes |= ATTR_ARCHIVE; \ 223 } \ 224 if ((dep)->de_pmp->pm_flags & MSDOSFSMNT_NOWIN95) { \ 225 (dep)->de_flag &= ~(DE_UPDATE | DE_CREATE | DE_ACCESS); \ 226 break; \ 227 } \ 228 if ((dep)->de_flag & DE_ACCESS) { \ 229 uint16_t adate; \ 230 \ 231 timespec2fattime((acc), 0, &adate, NULL, NULL); \ 232 if (adate != (dep)->de_ADate) { \ 233 (dep)->de_flag |= DE_MODIFIED; \ 234 (dep)->de_ADate = adate; \ 235 } \ 236 } \ 237 if ((dep)->de_flag & DE_CREATE) { \ 238 timespec2fattime((cre), 0, &(dep)->de_CDate, \ 239 &(dep)->de_CTime, &(dep)->de_CHun); \ 240 (dep)->de_flag |= DE_MODIFIED; \ 241 } \ 242 (dep)->de_flag &= ~(DE_UPDATE | DE_CREATE | DE_ACCESS); \ 243 } while (0) 244 245 /* 246 * This overlays the fid structure (see mount.h) 247 */ 248 struct defid { 249 u_short defid_len; /* length of structure */ 250 u_short defid_pad; /* force long alignment */ 251 252 uint32_t defid_dirclust; /* cluster this dir entry came from */ 253 uint32_t defid_dirofs; /* offset of entry within the cluster */ 254 #if 0 255 uint32_t defid_gen; /* generation number */ 256 #endif 257 }; 258 259 extern struct vop_vector msdosfs_vnodeops; 260 261 int msdosfs_lookup(struct vop_cachedlookup_args *); 262 int msdosfs_inactive(struct vop_inactive_args *); 263 int msdosfs_reclaim(struct vop_reclaim_args *); 264 265 /* 266 * Internal service routine prototypes. 267 */ 268 int deget(struct msdosfsmount *, u_long, u_long, struct denode **); 269 int uniqdosname(struct denode *, struct componentname *, u_char *); 270 271 int readep(struct msdosfsmount *pmp, u_long dirclu, u_long dirofs, struct buf **bpp, struct direntry **epp); 272 int readde(struct denode *dep, struct buf **bpp, struct direntry **epp); 273 int deextend(struct denode *dep, u_long length, struct ucred *cred); 274 int fillinusemap(struct msdosfsmount *pmp); 275 void reinsert(struct denode *dep); 276 int dosdirempty(struct denode *dep); 277 int createde(struct denode *dep, struct denode *ddep, struct denode **depp, struct componentname *cnp); 278 int deupdat(struct denode *dep, int waitfor); 279 int removede(struct denode *pdep, struct denode *dep); 280 int detrunc(struct denode *dep, u_long length, int flags, struct ucred *cred); 281 int doscheckpath( struct denode *source, struct denode *target); 282 #endif /* _KERNEL || MAKEFS */ 283 #endif /* !_FS_MSDOSFS_DENODE_H_ */ 284 285