sys/vfs/nfs/nfsnode.h

   1 /*
   2  * Copyright (c) 1989, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * Rick Macklem at The University of Guelph.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by the University of
  19  *      California, Berkeley and its contributors.
  20  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)nfsnode.h   8.9 (Berkeley) 5/14/95
  37  * $FreeBSD: /repoman/r/ncvs/src/sys/nfsclient/nfsnode.h,v 1.43 2004/04/14 23:23:55 peadar Exp $
  38  * $DragonFly: src/sys/vfs/nfs/nfsnode.h,v 1.9 2004/05/03 16:06:26 joerg Exp $
  39  */
  40
  41
  42 #ifndef _NFS_NFSNODE_H_
  43 #define _NFS_NFSNODE_H_
  44
  45 #if !defined(_NFS_NFS_H_) && !defined(_KERNEL)
  46 #include "nfs.h"
  47 #endif
  48
  49 #include <sys/lockf.h>
  50
  51 /*
  52  * Silly rename structure that hangs off the nfsnode until the name
  53  * can be removed by nfs_inactive()
  54  */
  55 struct sillyrename {
  56         struct  ucred *s_cred;
  57         struct  vnode *s_dvp;
  58         long    s_namlen;
  59         char    s_name[20];
  60 };
  61
  62 /*
  63  * This structure is used to save the logical directory offset to
  64  * NFS cookie mappings.
  65  * The mappings are stored in a list headed
  66  * by n_cookies, as required.
  67  * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
  68  * stored in increasing logical offset byte order.
  69  */
  70 #define NFSNUMCOOKIES           31
  71
  72 struct nfsdmap {
  73         LIST_ENTRY(nfsdmap)     ndm_list;
  74         int                     ndm_eocookie;
  75         nfsuint64               ndm_cookies[NFSNUMCOOKIES];
  76 };
  77
  78 /*
  79  * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
  80  * is purely coincidental.  There is a unique nfsnode allocated for
  81  * each active file, each current directory, each mounted-on file,
  82  * text file, and the root.
  83  *
  84  * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
  85  *
  86  * File handles are accessed via n_fhp, which will point to n_fh if the
  87  * file handle is small enough (<= NFS_SMALLFH).  Otherwise the file handle
  88  * will be allocated.
  89  *
  90  * DragonFly does not pass ucreds to read and write operations, since such
  91  * operations are not possible unless the ucred has already been validated.
  92  * Validating ucreds are stored in nfsnode to pass on to NFS read/write RPCs.
  93  */
  94 struct nfsnode {
  95         struct lock             n_lock;
  96         LIST_ENTRY(nfsnode)     n_hash;         /* Hash chain */
  97         CIRCLEQ_ENTRY(nfsnode)  n_timer;        /* Nqnfs timer chain */
  98         u_quad_t                n_size;         /* Current size of file */
  99         u_quad_t                n_brev;         /* Modify rev when cached */
 100         u_quad_t                n_lrev;         /* Modify rev for lease */
 101         struct vattr            n_vattr;        /* Vnode attribute cache */
 102         time_t                  n_attrstamp;    /* Attr. cache timestamp */
 103         u_int32_t               n_mode;         /* ACCESS mode cache */
 104         uid_t                   n_modeuid;      /* credentials having mode */
 105         time_t                  n_modestamp;    /* mode cache timestamp */
 106         time_t                  n_mtime;        /* Prev modify time. */
 107         time_t                  n_ctime;        /* Prev create time. */
 108         time_t                  n_expiry;       /* Lease expiry time */
 109         nfsfh_t                 *n_fhp;         /* NFS File Handle */
 110         struct ucred            *n_rucred;
 111         struct ucred            *n_wucred;
 112         struct vnode            *n_vnode;       /* associated vnode */
 113         struct lockf            n_lockf;        /* Locking record of file */
 114         int                     n_error;        /* Save write error value */
 115         union {
 116                 struct timespec nf_atim;        /* Special file times */
 117                 nfsuint64       nd_cookieverf;  /* Cookie verifier (dir only) */
 118         } n_un1;
 119         union {
 120                 struct timespec nf_mtim;
 121                 off_t           nd_direof;      /* Dir. EOF offset cache */
 122         } n_un2;
 123         union {
 124                 struct sillyrename *nf_silly;   /* Ptr to silly rename struct */
 125                 LIST_HEAD(, nfsdmap) nd_cook;   /* cookies */
 126         } n_un3;
 127         short                   n_fhsize;       /* size in bytes, of fh */
 128         short                   n_flag;         /* Flag for locking.. */
 129         nfsfh_t                 n_fh;           /* Small File Handle */
 130         struct lock             n_rslock;
 131 };
 132
 133 #define n_atim          n_un1.nf_atim
 134 #define n_mtim          n_un2.nf_mtim
 135 #define n_sillyrename   n_un3.nf_silly
 136 #define n_cookieverf    n_un1.nd_cookieverf
 137 #define n_direofoffset  n_un2.nd_direof
 138 #define n_cookies       n_un3.nd_cook
 139
 140 /*
 141  * Flags for n_flag
 142  */
 143 #define NFLUSHWANT      0x0001  /* Want wakeup from a flush in prog. */
 144 #define NFLUSHINPROG    0x0002  /* Avoid multiple calls to vinvalbuf() */
 145 #define NMODIFIED       0x0004  /* Might have a modified buffer in bio */
 146 #define NWRITEERR       0x0008  /* Flag write errors so close will know */
 147 #define NQNFSNONCACHE   0x0020  /* Non-cachable lease */
 148 #define NQNFSWRITE      0x0040  /* Write lease */
 149 #define NQNFSEVICTED    0x0080  /* Has been evicted */
 150 #define NACC            0x0100  /* Special file accessed */
 151 #define NUPD            0x0200  /* Special file updated */
 152 #define NCHG            0x0400  /* Special file times changed */
 153 #define NLOCKED         0x0800  /* node is locked */
 154 #define NWANTED         0x0100  /* someone wants to lock */
 155 #define NSIZECHANGED    0x2000  /* File size has changed: need cache inval */
 156
 157 /*
 158  * Convert between nfsnode pointers and vnode pointers
 159  */
 160 #define VTONFS(vp)      ((struct nfsnode *)(vp)->v_data)
 161 #define NFSTOV(np)      ((struct vnode *)(np)->n_vnode)
 162
 163 /*
 164  * Queue head for nfsiod's
 165  */
 166 extern TAILQ_HEAD(nfs_bufq, buf) nfs_bufq;
 167 extern struct thread *nfs_iodwant[NFS_MAXASYNCDAEMON];
 168 extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON];
 169
 170 #if defined(_KERNEL)
 171
 172 /*
 173  *      nfs_rslock -    Attempt to obtain lock on nfsnode
 174  *
 175  *      Attempt to obtain a lock on the passed nfsnode, returning ENOLCK
 176  *      if the lock could not be obtained due to our having to sleep.  This
 177  *      function is generally used to lock around code that modifies an
 178  *      NFS file's size.  In order to avoid deadlocks the lock
 179  *      should not be obtained while other locks are being held.
 180  */
 181
 182 static __inline
 183 int
 184 nfs_rslock(struct nfsnode *np, struct thread *td)
 185 {
 186         return(lockmgr(&np->n_rslock, LK_EXCLUSIVE | LK_CANRECURSE |
 187                 LK_SLEEPFAIL, NULL, td));
 188 }
 189
 190 static __inline
 191 void
 192 nfs_rsunlock(struct nfsnode *np, struct thread *td)
 193 {
 194         (void)lockmgr(&np->n_rslock, LK_RELEASE, NULL, td);
 195 }
 196
 197 static __inline
 198 struct ucred *
 199 nfs_vpcred(struct vnode *vp, int ndflag)
 200 {
 201         struct nfsnode *np = VTONFS(vp);
 202
 203         if (np && (ndflag & ND_WRITE) && np->n_wucred)
 204                 return(np->n_wucred);
 205         if (np && (ndflag & ND_READ) && np->n_rucred)
 206                 return(np->n_rucred);
 207         return(VFSTONFS((vp)->v_mount)->nm_cred);
 208 }
 209
 210 extern  vop_t   **fifo_nfsv2nodeop_p;
 211 extern  vop_t   **nfsv2_vnodeop_p;
 212 extern  vop_t   **spec_nfsv2nodeop_p;
 213
 214 /*
 215  * Prototypes for NFS vnode operations
 216  */
 217 int     nfs_getpages (struct vop_getpages_args *);
 218 int     nfs_putpages (struct vop_putpages_args *);
 219 int     nfs_write (struct vop_write_args *);
 220 int     nqnfs_vop_lease_check (struct vop_lease_args *);
 221 int     nfs_inactive (struct vop_inactive_args *);
 222 int     nfs_reclaim (struct vop_reclaim_args *);
 223
 224 /* other stuff */
 225 int     nfs_removeit (struct sillyrename *);
 226 int     nfs_nget (struct mount *,nfsfh_t *,int,struct nfsnode **);
 227 nfsuint64 *nfs_getcookie (struct nfsnode *, off_t, int);
 228 void    nfs_invaldir (struct vnode *);
 229
 230 #define nqnfs_lease_updatetime  nfs_lease_updatetime
 231
 232 #endif /* _KERNEL */
 233
 234 #endif