sys/fs/msdosfs/denode.h

   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
  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         3       /* 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 #define FC_NEXTTOLASTFC 2       /* entry for a close to the last cluster in
 124                                  * the file */
 125
 126 #define FCE_EMPTY       0xffffffff      /* doesn't represent an actual cluster # */
 127
 128 /*
 129  * Set a slot in the fat cache.
 130  */
 131 #define fc_setcache(dep, slot, frcn, fsrcn) \
 132         (dep)->de_fc[(slot)].fc_frcn = (frcn); \
 133         (dep)->de_fc[(slot)].fc_fsrcn = (fsrcn);
 134
 135 #define fc_last_to_nexttolast(dep) do {          \
 136         (dep)->de_fc[FC_NEXTTOLASTFC].fc_frcn =  \
 137         (dep)->de_fc[FC_LASTFC].fc_frcn;         \
 138         (dep)->de_fc[FC_NEXTTOLASTFC].fc_fsrcn = \
 139         (dep)->de_fc[FC_LASTFC].fc_fsrcn;        \
 140 } while (0)
 141
 142 /*
 143  * This is the in memory variant of a dos directory entry.  It is usually
 144  * contained within a vnode.
 145  */
 146 struct denode {
 147         struct vnode *de_vnode; /* addr of vnode we are part of */
 148         u_long de_flag;         /* flag bits */
 149         struct cdev *de_dev;    /* device where direntry lives */
 150         u_long de_dirclust;     /* cluster of the directory file containing this entry */
 151         u_long de_diroffset;    /* offset of this entry in the directory cluster */
 152         u_long de_fndoffset;    /* offset of found dir entry */
 153         int de_fndcnt;          /* number of slots before de_fndoffset */
 154         long de_refcnt;         /* reference count */
 155         struct msdosfsmount *de_pmp;    /* addr of our mount struct */
 156         u_char de_Name[12];     /* name, from DOS directory entry */
 157         u_char de_Attributes;   /* attributes, from directory entry */
 158         u_char de_LowerCase;    /* NT VFAT lower case flags */
 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         u_int64_t de_inode;     /* Inode number (really byte offset of direntry) */
 170 };
 171
 172 /*
 173  * Values for the de_flag field of the denode.
 174  */
 175 #define DE_UPDATE       0x0004  /* Modification time update request */
 176 #define DE_CREATE       0x0008  /* Creation time update */
 177 #define DE_ACCESS       0x0010  /* Access time update */
 178 #define DE_MODIFIED     0x0020  /* Denode has been modified */
 179 #define DE_RENAME       0x0040  /* Denode is in the process of being renamed */
 180
 181
 182 /*
 183  * Transfer directory entries between internal and external form.
 184  * dep is a struct denode * (internal form),
 185  * dp is a struct direntry * (external form).
 186  */
 187 #define DE_INTERNALIZE32(dep, dp)                       \
 188          ((dep)->de_StartCluster |= getushort((dp)->deHighClust) << 16)
 189 #define DE_INTERNALIZE(dep, dp)                         \
 190         (bcopy((dp)->deName, (dep)->de_Name, 11),       \
 191          (dep)->de_Attributes = (dp)->deAttributes,     \
 192          (dep)->de_LowerCase = (dp)->deLowerCase,       \
 193          (dep)->de_CHun = (dp)->deCHundredth,           \
 194          (dep)->de_CTime = getushort((dp)->deCTime),    \
 195          (dep)->de_CDate = getushort((dp)->deCDate),    \
 196          (dep)->de_ADate = getushort((dp)->deADate),    \
 197          (dep)->de_MTime = getushort((dp)->deMTime),    \
 198          (dep)->de_MDate = getushort((dp)->deMDate),    \
 199          (dep)->de_StartCluster = getushort((dp)->deStartCluster), \
 200          (dep)->de_FileSize = getulong((dp)->deFileSize), \
 201          (FAT32((dep)->de_pmp) ? DE_INTERNALIZE32((dep), (dp)) : 0))
 202
 203 #define DE_EXTERNALIZE(dp, dep)                         \
 204         (bcopy((dep)->de_Name, (dp)->deName, 11),       \
 205          (dp)->deAttributes = (dep)->de_Attributes,     \
 206          (dp)->deLowerCase = (dep)->de_LowerCase,       \
 207          (dp)->deCHundredth = (dep)->de_CHun,           \
 208          putushort((dp)->deCTime, (dep)->de_CTime),     \
 209          putushort((dp)->deCDate, (dep)->de_CDate),     \
 210          putushort((dp)->deADate, (dep)->de_ADate),     \
 211          putushort((dp)->deMTime, (dep)->de_MTime),     \
 212          putushort((dp)->deMDate, (dep)->de_MDate),     \
 213          putushort((dp)->deStartCluster, (dep)->de_StartCluster), \
 214          putulong((dp)->deFileSize,                     \
 215              ((dep)->de_Attributes & ATTR_DIRECTORY) ? 0 : (dep)->de_FileSize), \
 216          putushort((dp)->deHighClust, (dep)->de_StartCluster >> 16))
 217
 218 #define de_forw         de_chain[0]
 219 #define de_back         de_chain[1]
 220
 221 #ifdef _KERNEL
 222
 223 #define VTODE(vp)       ((struct denode *)(vp)->v_data)
 224 #define DETOV(de)       ((de)->de_vnode)
 225
 226 #define DETIMES(dep, acc, mod, cre) do {                                \
 227         if ((dep)->de_flag & DE_UPDATE) {                               \
 228                 (dep)->de_flag |= DE_MODIFIED;                          \
 229                 timespec2fattime((mod), 0, &(dep)->de_MDate,            \
 230                     &(dep)->de_MTime, NULL);                            \
 231                 (dep)->de_Attributes |= ATTR_ARCHIVE;                   \
 232         }                                                               \
 233         if ((dep)->de_pmp->pm_flags & MSDOSFSMNT_NOWIN95) {             \
 234                 (dep)->de_flag &= ~(DE_UPDATE | DE_CREATE | DE_ACCESS); \
 235                 break;                                                  \
 236         }                                                               \
 237         if ((dep)->de_flag & DE_ACCESS) {                               \
 238                 u_int16_t adate;                                        \
 239                                                                         \
 240                 timespec2fattime((acc), 0, &adate, NULL, NULL);         \
 241                 if (adate != (dep)->de_ADate) {                         \
 242                         (dep)->de_flag |= DE_MODIFIED;                  \
 243                         (dep)->de_ADate = adate;                        \
 244                 }                                                       \
 245         }                                                               \
 246         if ((dep)->de_flag & DE_CREATE) {                               \
 247                 timespec2fattime((cre), 0, &(dep)->de_CDate,            \
 248                     &(dep)->de_CTime, &(dep)->de_CHun);                 \
 249                 (dep)->de_flag |= DE_MODIFIED;                          \
 250         }                                                               \
 251         (dep)->de_flag &= ~(DE_UPDATE | DE_CREATE | DE_ACCESS);         \
 252 } while (0)
 253
 254 /*
 255  * This overlays the fid structure (see mount.h)
 256  */
 257 struct defid {
 258         u_short defid_len;      /* length of structure */
 259         u_short defid_pad;      /* force long alignment */
 260
 261         u_int32_t defid_dirclust; /* cluster this dir entry came from */
 262         u_int32_t defid_dirofs; /* offset of entry within the cluster */
 263 #if 0
 264         u_int32_t defid_gen;    /* generation number */
 265 #endif
 266 };
 267
 268 extern struct vop_vector msdosfs_vnodeops;
 269
 270 int msdosfs_lookup(struct vop_cachedlookup_args *);
 271 int msdosfs_inactive(struct vop_inactive_args *);
 272 int msdosfs_reclaim(struct vop_reclaim_args *);
 273
 274 /*
 275  * Internal service routine prototypes.
 276  */
 277 int deget(struct msdosfsmount *, u_long, u_long, struct denode **);
 278 int uniqdosname(struct denode *, struct componentname *, u_char *);
 279 int findwin95(struct denode *);
 280
 281 int readep(struct msdosfsmount *pmp, u_long dirclu, u_long dirofs,  struct buf **bpp, struct direntry **epp);
 282 int readde(struct denode *dep, struct buf **bpp, struct direntry **epp);
 283 int deextend(struct denode *dep, u_long length, struct ucred *cred);
 284 int fillinusemap(struct msdosfsmount *pmp);
 285 void reinsert(struct denode *dep);
 286 int dosdirempty(struct denode *dep);
 287 int createde(struct denode *dep, struct denode *ddep, struct denode **depp, struct componentname *cnp);
 288 int deupdat(struct denode *dep, int waitfor);
 289 int removede(struct denode *pdep, struct denode *dep);
 290 int detrunc(struct denode *dep, u_long length, int flags, struct ucred *cred, struct thread *td);
 291 int doscheckpath( struct denode *source, struct denode *target);
 292 #endif  /* _KERNEL */