FreeBSD/Linux Kernel Cross Reference
sys/msdosfs/denode.h
1 /* $FreeBSD: src/sys/msdosfs/denode.h,v 1.9.2.3 1999/09/05 08:17:15 peter Exp $ */
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
51 /*
52 * This is the pc filesystem specific portion of the vnode structure.
53 *
54 * To describe a file uniquely the de_dirclust, de_diroffset, and
55 * de_StartCluster fields are used.
56 *
57 * de_dirclust contains the cluster number of the directory cluster
58 * containing the entry for a file or directory.
59 * de_diroffset is the index into the cluster for the entry describing
60 * a file or directory.
61 * de_StartCluster is the number of the first cluster of the file or directory.
62 *
63 * Now to describe the quirks of the pc filesystem.
64 * - Clusters 0 and 1 are reserved.
65 * - The first allocatable cluster is 2.
66 * - The root directory is of fixed size and all blocks that make it up
67 * are contiguous.
68 * - Cluster 0 refers to the root directory when it is found in the
69 * startcluster field of a directory entry that points to another directory.
70 * - Cluster 0 implies a 0 length file when found in the start cluster field
71 * of a directory entry that points to a file.
72 * - You can't use the cluster number 0 to derive the address of the root
73 * directory.
74 * - Multiple directory entries can point to a directory. The entry in the
75 * parent directory points to a child directory. Any directories in the
76 * child directory contain a ".." entry that points back to the parent.
77 * The child directory itself contains a "." entry that points to itself.
78 * - The root directory does not contain a "." or ".." entry.
79 * - Directory entries for directories are never changed once they are created
80 * (except when removed). The size stays 0, and the last modification time
81 * is never changed. This is because so many directory entries can point to
82 * the physical clusters that make up a directory. It would lead to an
83 * update nightmare.
84 * - The length field in a directory entry pointing to a directory contains 0
85 * (always). The only way to find the end of a directory is to follow the
86 * cluster chain until the "last cluster" marker is found.
87 *
88 * My extensions to make this house of cards work. These apply only to the in
89 * memory copy of the directory entry.
90 * - A reference count for each denode will be kept since dos doesn't keep such
91 * things.
92 */
93
94 /*
95 * Internal pseudo-offset for (nonexistent) directory entry for the root
96 * dir in the root dir
97 */
98 #define MSDOSFSROOT_OFS 0x1fffffff
99
100 /*
101 * The fat cache structure. fc_fsrcn is the filesystem relative cluster
102 * number that corresponds to the file relative cluster number in this
103 * structure (fc_frcn).
104 */
105 struct fatcache {
106 u_long fc_frcn; /* file relative cluster number */
107 u_long fc_fsrcn; /* filesystem relative cluster number */
108 };
109
110 /*
111 * The fat entry cache as it stands helps make extending files a "quick"
112 * operation by avoiding having to scan the fat to discover the last
113 * cluster of the file. The cache also helps sequential reads by
114 * remembering the last cluster read from the file. This also prevents us
115 * from having to rescan the fat to find the next cluster to read. This
116 * cache is probably pretty worthless if a file is opened by multiple
117 * processes.
118 */
119 #define FC_SIZE 2 /* number of entries in the cache */
120 #define FC_LASTMAP 0 /* entry the last call to pcbmap() resolved
121 * to */
122 #define FC_LASTFC 1 /* entry for the last cluster in the file */
123
124 #define FCE_EMPTY 0xffffffff /* doesn't represent an actual cluster # */
125
126 /*
127 * Set a slot in the fat cache.
128 */
129 #define fc_setcache(dep, slot, frcn, fsrcn) \
130 (dep)->de_fc[slot].fc_frcn = frcn; \
131 (dep)->de_fc[slot].fc_fsrcn = fsrcn;
132
133 /*
134 * This is the in memory variant of a dos directory entry. It is usually
135 * contained within a vnode.
136 */
137 struct denode {
138 #ifdef __FreeBSD_version
139 struct lock de_lock; /* denode lock >Keep this first< */
140 #endif
141 struct denode *de_next; /* Hash chain forward */
142 struct denode **de_prev; /* Hash chain back */
143 struct vnode *de_vnode; /* addr of vnode we are part of */
144 struct vnode *de_devvp; /* vnode of blk dev we live on */
145 u_long de_flag; /* flag bits */
146 dev_t de_dev; /* device where direntry lives */
147 u_long de_dirclust; /* cluster of the directory file containing this entry */
148 u_long de_diroffset; /* offset of this entry in the directory cluster */
149 u_long de_fndoffset; /* offset of found dir entry */
150 int de_fndcnt; /* number of slots before de_fndoffset */
151 long de_refcnt; /* reference count */
152 struct msdosfsmount *de_pmp; /* addr of our mount struct */
153 #ifndef __FreeBSD_version
154 pid_t de_lockholder; /* current lock holder */
155 pid_t de_lockwaiter; /* lock wanter */
156 #endif
157 u_char de_Name[12]; /* name, from DOS directory entry */
158 u_char de_Attributes; /* attributes, from directory entry */
159 u_char de_CHun; /* Hundredth of second of CTime*/
160 u_short de_CTime; /* creation time */
161 u_short de_CDate; /* creation date */
162 u_short de_ADate; /* access date */
163 u_short de_MTime; /* modification time */
164 u_short de_MDate; /* modification date */
165 u_long de_StartCluster; /* starting cluster of file */
166 u_long de_FileSize; /* size of file in bytes */
167 struct fatcache de_fc[FC_SIZE]; /* fat cache */
168 u_quad_t de_modrev; /* Revision level for lease. */
169 #ifndef __FreeBSD_version
170 int de_lockcount; /* Process lock count (recursion) */
171 #endif
172 };
173
174 /*
175 * Values for the de_flag field of the denode.
176 */
177 #ifndef __FreeBSD_version
178 #define DE_LOCKED 0x0001 /* directory entry is locked */
179 #define DE_WANTED 0x0002 /* someone wants this de */
180 #define DE_RECURSE 0x0400 /* Recursion expected */
181 #endif
182 #define DE_UPDATE 0x0004 /* Modification time update request */
183 #define DE_CREATE 0x0008 /* Creation time update */
184 #define DE_ACCESS 0x0010 /* Access time update */
185 #define DE_MODIFIED 0x0020 /* Denode has been modified */
186 #define DE_RENAME 0x0040 /* Denode is in the process of being renamed */
187
188
189 /*
190 * Transfer directory entries between internal and external form.
191 * dep is a struct denode * (internal form),
192 * dp is a struct direntry * (external form).
193 */
194 #define DE_INTERNALIZE32(dep, dp) \
195 ((dep)->de_StartCluster |= getushort((dp)->deHighClust) << 16)
196 #define DE_INTERNALIZE(dep, dp) \
197 (bcopy((dp)->deName, (dep)->de_Name, 11), \
198 (dep)->de_Attributes = (dp)->deAttributes, \
199 (dep)->de_CHun = (dp)->deCHundredth, \
200 (dep)->de_CTime = getushort((dp)->deCTime), \
201 (dep)->de_CDate = getushort((dp)->deCDate), \
202 (dep)->de_ADate = getushort((dp)->deADate), \
203 (dep)->de_MTime = getushort((dp)->deMTime), \
204 (dep)->de_MDate = getushort((dp)->deMDate), \
205 (dep)->de_StartCluster = getushort((dp)->deStartCluster), \
206 (dep)->de_FileSize = getulong((dp)->deFileSize), \
207 (FAT32((dep)->de_pmp) ? DE_INTERNALIZE32((dep), (dp)) : 0))
208
209 #define DE_EXTERNALIZE32(dp, dep) \
210 putushort((dp)->deHighClust, (dep)->de_StartCluster >> 16)
211 #define DE_EXTERNALIZE(dp, dep) \
212 (bcopy((dep)->de_Name, (dp)->deName, 11), \
213 bzero((dp)->deReserved, 10), \
214 (dp)->deAttributes = (dep)->de_Attributes, \
215 (dp)->deCHundredth = (dep)->de_CHun, \
216 putushort((dp)->deCTime, (dep)->de_CTime), \
217 putushort((dp)->deCDate, (dep)->de_CDate), \
218 putushort((dp)->deADate, (dep)->de_ADate), \
219 putushort((dp)->deMTime, (dep)->de_MTime), \
220 putushort((dp)->deMDate, (dep)->de_MDate), \
221 putushort((dp)->deStartCluster, (dep)->de_StartCluster), \
222 putulong((dp)->deFileSize, \
223 ((dep)->de_Attributes & ATTR_DIRECTORY) ? 0 : (dep)->de_FileSize), \
224 (FAT32((dep)->de_pmp) ? DE_EXTERNALIZE32((dp), (dep)) : 0))
225
226 #define de_forw de_chain[0]
227 #define de_back de_chain[1]
228
229 #ifdef KERNEL
230
231 #define VTODE(vp) ((struct denode *)(vp)->v_data)
232 #define DETOV(de) ((de)->de_vnode)
233
234 #define DETIMES(dep, acc, mod, cre) \
235 if ((dep)->de_flag & (DE_UPDATE | DE_CREATE | DE_ACCESS)) { \
236 (dep)->de_flag |= DE_MODIFIED; \
237 if ((dep)->de_flag & DE_UPDATE) { \
238 unix2dostime((mod), &(dep)->de_MDate, &(dep)->de_MTime, NULL); \
239 (dep)->de_Attributes |= ATTR_ARCHIVE; \
240 } \
241 if (!((dep)->de_pmp->pm_flags & MSDOSFSMNT_NOWIN95)) { \
242 if ((dep)->de_flag & DE_ACCESS) \
243 unix2dostime((acc), &(dep)->de_ADate, NULL, NULL); \
244 if ((dep)->de_flag & DE_CREATE) \
245 unix2dostime((cre), &(dep)->de_CDate, &(dep)->de_CTime, &(dep)->de_CHun); \
246 } \
247 (dep)->de_flag &= ~(DE_UPDATE | DE_CREATE | DE_ACCESS); \
248 }
249
250 /*
251 * This overlays the fid structure (see mount.h)
252 */
253 struct defid {
254 u_short defid_len; /* length of structure */
255 u_short defid_pad; /* force long alignment */
256
257 u_long defid_dirclust; /* cluster this dir entry came from */
258 u_long defid_dirofs; /* offset of entry within the cluster */
259 #if 0
260 u_long defid_gen; /* generation number */
261 #endif
262 };
263
264 extern vop_t **msdosfs_vnodeop_p;
265
266 #ifndef __FreeBSD_version
267 #define vop_cachedlookup_args vop_lookup_args
268 #define vrecycle(a, b, c) vgone(a)
269 #define vn_lock(a, b, c) VOP_LOCK(a)
270 #endif
271 int msdosfs_lookup __P((struct vop_cachedlookup_args *));
272 int msdosfs_inactive __P((struct vop_inactive_args *));
273 int msdosfs_reclaim __P((struct vop_reclaim_args *));
274
275 /*
276 * Internal service routine prototypes.
277 */
278 int deget __P((struct msdosfsmount *, u_long, u_long, struct denode **));
279 int uniqdosname __P((struct denode *, struct componentname *, u_char *));
280 int findwin95 __P((struct denode *));
281
282 int readep __P((struct msdosfsmount *pmp, u_long dirclu, u_long dirofs, struct buf **bpp, struct direntry **epp));
283 int readde __P((struct denode *dep, struct buf **bpp, struct direntry **epp));
284 int deextend __P((struct denode *dep, u_long length, struct ucred *cred));
285 int fillinusemap __P((struct msdosfsmount *pmp));
286 void reinsert __P((struct denode *dep));
287 int dosdirempty __P((struct denode *dep));
288 int createde __P((struct denode *dep, struct denode *ddep, struct denode **depp, struct componentname *cnp));
289 int deupdat __P((struct denode *dep, int waitfor));
290 int removede __P((struct denode *pdep, struct denode *dep));
291 int detrunc __P((struct denode *dep, u_long length, int flags, struct ucred *cred, struct proc *p));
292 int doscheckpath __P(( struct denode *source, struct denode *target));
293 #endif /* KERNEL */
Cache object: e281e4a1b00716c6a6e40b44446451f2
|