bsd/nfs/nfsnode.h

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