bsd/nfs/nfsnode.h

   1 /*
   2  * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  26 /*
  27  * Copyright (c) 1989, 1993
  28  *      The Regents of the University of California.  All rights reserved.
  29  *
  30  * This code is derived from software contributed to Berkeley by
  31  * Rick Macklem at The University of Guelph.
  32  *
  33  * Redistribution and use in source and binary forms, with or without
  34  * modification, are permitted provided that the following conditions
  35  * are met:
  36  * 1. Redistributions of source code must retain the above copyright
  37  *    notice, this list of conditions and the following disclaimer.
  38  * 2. Redistributions in binary form must reproduce the above copyright
  39  *    notice, this list of conditions and the following disclaimer in the
  40  *    documentation and/or other materials provided with the distribution.
  41  * 3. All advertising materials mentioning features or use of this software
  42  *    must display the following acknowledgement:
  43  *      This product includes software developed by the University of
  44  *      California, Berkeley and its contributors.
  45  * 4. Neither the name of the University nor the names of its contributors
  46  *    may be used to endorse or promote products derived from this software
  47  *    without specific prior written permission.
  48  *
  49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  59  * SUCH DAMAGE.
  60  *
  61  *      @(#)nfsnode.h   8.9 (Berkeley) 5/14/95
  62  * FreeBSD-Id: nfsnode.h,v 1.24 1997/10/28 14:06:25 bde Exp $
  63  */
  64
  65
  66 #ifndef _NFS_NFSNODE_H_
  67 #define _NFS_NFSNODE_H_
  68
  69 #include <sys/appleapiopts.h>
  70
  71 #ifdef __APPLE_API_PRIVATE
  72 #ifndef _NFS_NFS_H_
  73 #include <nfs/nfs.h>
  74 #endif
  75 #include <sys/lock.h>
  76
  77
  78 /*
  79  * Silly rename structure that hangs off the nfsnode until the name
  80  * can be removed by nfs_inactive()
  81  */
  82 struct sillyrename {
  83         struct  ucred *s_cred;
  84         struct  vnode *s_dvp;
  85         long    s_namlen;
  86         char    s_name[20];
  87 };
  88
  89 /*
  90  * This structure is used to save the logical directory offset to
  91  * NFS cookie mappings.
  92  * The mappings are stored in a list headed
  93  * by n_cookies, as required.
  94  * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
  95  * stored in increasing logical offset byte order.
  96  */
  97 #define NFSNUMCOOKIES           31
  98
  99 struct nfsdmap {
 100         LIST_ENTRY(nfsdmap)     ndm_list;
 101         int                     ndm_eocookie;
 102         nfsuint64               ndm_cookies[NFSNUMCOOKIES];
 103 };
 104
 105 /*
 106  * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
 107  * is purely coincidental.
 108  * There is a unique nfsnode allocated for each active file,
 109  * each current directory, each mounted-on file, text file, and the root.
 110  * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
 111  * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
 112  * type definitions), file handles of > 32 bytes should probably be split out
 113  * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by
 114  * changing the definition in sys/mount.h of NFS_SMALLFH.)
 115  * NB: Hopefully the current order of the fields is such that everything will
 116  *     be well aligned and, therefore, tightly packed.
 117  */
 118 struct nfsnode {
 119         struct lock__bsd__      n_lock; /* the vnode lock */
 120         LIST_ENTRY(nfsnode)     n_hash;         /* Hash chain */
 121         CIRCLEQ_ENTRY(nfsnode)  n_timer;        /* Nqnfs timer chain */
 122         u_quad_t                n_size;         /* Current size of file */
 123         u_quad_t                n_brev;         /* Modify rev when cached */
 124         u_quad_t                n_lrev;         /* Modify rev for lease */
 125         struct vattr            n_vattr;        /* Vnode attribute cache */
 126         time_t                  n_attrstamp;    /* Attr. cache timestamp */
 127         u_int32_t               n_mode;         /* ACCESS mode cache */
 128         uid_t                   n_modeuid;      /* credentials having mode */
 129         time_t                  n_modestamp;    /* mode cache timestamp */
 130         time_t                  n_mtime;        /* Prev modify time. */
 131         time_t                  n_ctime;        /* Prev create time. */
 132         time_t                  n_expiry;       /* Lease expiry time */
 133         nfsfh_t                 *n_fhp;         /* NFS File Handle */
 134         struct vnode            *n_vnode;       /* associated vnode */
 135         struct lockf            *n_lockf;       /* Locking record of file */
 136         int                     n_error;        /* Save write error value */
 137         union {
 138                 struct timespec nf_atim;        /* Special file times */
 139                 nfsuint64       nd_cookieverf;  /* Cookie verifier (dir only) */
 140         } n_un1;
 141         union {
 142                 struct timespec nf_mtim;
 143                 off_t           nd_direof;      /* Dir. EOF offset cache */
 144         } n_un2;
 145         union {
 146                 struct sillyrename *nf_silly;   /* Ptr to silly rename struct */
 147                 LIST_HEAD(, nfsdmap) nd_cook;   /* cookies */
 148         } n_un3;
 149         short                   n_fhsize;       /* size in bytes, of fh */
 150         short                   n_flag;         /* Flag for locking.. */
 151         nfsfh_t                 n_fh;           /* Small File Handle */
 152         u_int64_t               n_xid;          /* last xid to loadattr */
 153 };
 154
 155 #define n_atim          n_un1.nf_atim
 156 #define n_mtim          n_un2.nf_mtim
 157 #define n_sillyrename   n_un3.nf_silly
 158 #define n_cookieverf    n_un1.nd_cookieverf
 159 #define n_direofoffset  n_un2.nd_direof
 160 #define n_cookies       n_un3.nd_cook
 161
 162 /*
 163  * Flags for n_flag
 164  */
 165 #define NFLUSHWANT      0x0001  /* Want wakeup from a flush in prog. */
 166 #define NFLUSHINPROG    0x0002  /* Avoid multiple calls to vinvalbuf() */
 167 #define NMODIFIED       0x0004  /* Might have a modified buffer in bio */
 168 #define NWRITEERR       0x0008  /* Flag write errors so close will know */
 169 #define NQNFSNONCACHE   0x0020  /* Non-cachable lease */
 170 #define NQNFSWRITE      0x0040  /* Write lease */
 171 #define NQNFSEVICTED    0x0080  /* Has been evicted */
 172 #define NACC            0x0100  /* Special file accessed */
 173 #define NUPD            0x0200  /* Special file updated */
 174 #define NCHG            0x0400  /* Special file times changed */
 175 #define NLOCKED         0x0800  /* node is locked */
 176 #define NWANTED         0x0100  /* someone wants to lock */
 177
 178 /*
 179  * Convert between nfsnode pointers and vnode pointers
 180  */
 181 #define VTONFS(vp)      ((struct nfsnode *)(vp)->v_data)
 182 #define NFSTOV(np)      ((struct vnode *)(np)->n_vnode)
 183
 184 /*
 185  * Queue head for nfsiod's
 186  */
 187 extern TAILQ_HEAD(nfs_bufq, buf) nfs_bufq;
 188 extern struct proc *nfs_iodwant[NFS_MAXASYNCDAEMON];
 189 extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON];
 190
 191 #if defined(KERNEL)
 192
 193 typedef int     vop_t __P((void *));
 194 extern  vop_t   **fifo_nfsv2nodeop_p;
 195 extern  vop_t   **nfsv2_vnodeop_p;
 196 extern  vop_t   **spec_nfsv2nodeop_p;
 197
 198 /*
 199  * Prototypes for NFS vnode operations
 200  */
 201 int     nfs_write __P((struct vop_write_args *));
 202 #define nfs_lease_check ((int (*) __P((struct  vop_lease_args *)))nullop)
 203 #define nqnfs_vop_lease_check   lease_check
 204 int     nqnfs_vop_lease_check __P((struct vop_lease_args *));
 205 #define nfs_revoke vop_revoke
 206 #define nfs_seek ((int (*) __P((struct  vop_seek_args *)))nullop)
 207 int     nfs_abortop __P((struct vop_abortop_args *));
 208 int     nfs_inactive __P((struct vop_inactive_args *));
 209 int     nfs_reclaim __P((struct vop_reclaim_args *));
 210 int nfs_lock __P((struct vop_lock_args *));
 211 int nfs_unlock __P((struct vop_unlock_args *));
 212 int nfs_islocked __P((struct vop_islocked_args *));
 213
 214 #define nfs_reallocblks \
 215         ((int (*) __P((struct  vop_reallocblks_args *)))eopnotsupp)
 216
 217 /* other stuff */
 218 int     nfs_removeit __P((struct sillyrename *));
 219 int     nfs_nget __P((struct mount *,nfsfh_t *,int,struct nfsnode **));
 220 nfsuint64 *nfs_getcookie __P((struct nfsnode *, off_t, int));
 221 void nfs_invaldir __P((struct vnode *));
 222
 223 #define nqnfs_lease_updatetime  lease_updatetime
 224
 225 #endif /* KERNEL */
 226
 227 #endif /* __APPLE_API_PRIVATE */
 228 #endif /* _NFS_NFSNODE_H_ */