sys/nfsclient/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  * 4. Neither the name of the University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  *      @(#)nfsnode.h   8.9 (Berkeley) 5/14/95
  33  * $FreeBSD$
  34  */
  35
  36 #ifndef _NFSCLIENT_NFSNODE_H_
  37 #define _NFSCLIENT_NFSNODE_H_
  38
  39 #if !defined(_NFSCLIENT_NFS_H_) && !defined(_KERNEL)
  40 #include <nfs/nfs.h>
  41 #endif
  42
  43 /*
  44  * Silly rename structure that hangs off the nfsnode until the name
  45  * can be removed by nfs_inactive()
  46  */
  47 struct sillyrename {
  48         struct  ucred *s_cred;
  49         struct  vnode *s_dvp;
  50         int     (*s_removeit)(struct sillyrename *sp);
  51         long    s_namlen;
  52         char    s_name[32];
  53 };
  54
  55 /*
  56  * This structure is used to save the logical directory offset to
  57  * NFS cookie mappings.
  58  * The mappings are stored in a list headed
  59  * by n_cookies, as required.
  60  * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
  61  * stored in increasing logical offset byte order.
  62  */
  63 #define NFSNUMCOOKIES           31
  64
  65 struct nfsdmap {
  66         LIST_ENTRY(nfsdmap)     ndm_list;
  67         int                     ndm_eocookie;
  68         union {
  69                 nfsuint64       ndmu3_cookies[NFSNUMCOOKIES];
  70                 uint64_t        ndmu4_cookies[NFSNUMCOOKIES];
  71         } ndm_un1;
  72 };
  73
  74 #define ndm_cookies     ndm_un1.ndmu3_cookies
  75 #define ndm4_cookies    ndm_un1.ndmu4_cookies
  76
  77 #define n_ac_ts_tid             n_ac_ts.nfs_ac_ts_tid
  78 #define n_ac_ts_pid             n_ac_ts.nfs_ac_ts_pid
  79 #define n_ac_ts_syscalls        n_ac_ts.nfs_ac_ts_syscalls
  80
  81 struct nfs_attrcache_timestamp {
  82         lwpid_t         nfs_ac_ts_tid;
  83         pid_t           nfs_ac_ts_pid;
  84         unsigned long   nfs_ac_ts_syscalls;
  85 };
  86
  87 struct nfs_accesscache {
  88         u_int32_t               mode;           /* ACCESS mode cache */
  89         uid_t                   uid;            /* credentials having mode */
  90         time_t                  stamp;          /* mode cache timestamp */
  91 };
  92
  93 /*
  94  * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
  95  * is purely coincidental.
  96  * There is a unique nfsnode allocated for each active file,
  97  * each current directory, each mounted-on file, text file, and the root.
  98  * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
  99  * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
 100  * type definitions), file handles of > 32 bytes should probably be split out
 101  * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by
 102  * changing the definition in nfsproto.h of NFS_SMALLFH.)
 103  * NB: Hopefully the current order of the fields is such that everything will
 104  *     be well aligned and, therefore, tightly packed.
 105  */
 106 struct nfsnode {
 107         struct mtx              n_mtx;          /* Protects all of these members */
 108         u_quad_t                n_size;         /* Current size of file */
 109         u_quad_t                n_brev;         /* Modify rev when cached */
 110         u_quad_t                n_lrev;         /* Modify rev for lease */
 111         struct vattr            n_vattr;        /* Vnode attribute cache */
 112         time_t                  n_attrstamp;    /* Attr. cache timestamp */
 113         struct nfs_accesscache  n_accesscache[NFS_ACCESSCACHESIZE];
 114         struct timespec         n_mtime;        /* Prev modify time. */
 115         time_t                  n_ctime;        /* Prev create time. */
 116         time_t                  n_dmtime;       /* Prev dir modify time. */
 117         int                     n_dmtime_ticks; /* Tick of -ve cache entry */
 118         time_t                  n_expiry;       /* Lease expiry time */
 119         nfsfh_t                 *n_fhp;         /* NFS File Handle */
 120         struct vnode            *n_vnode;       /* associated vnode */
 121         struct vnode            *n_dvp;         /* parent vnode */
 122         int                     n_error;        /* Save write error value */
 123         union {
 124                 struct timespec nf_atim;        /* Special file times */
 125                 nfsuint64       nd_cookieverf;  /* Cookie verifier (dir only) */
 126                 u_char          nd4_cookieverf[NFSX_V4VERF];
 127         } n_un1;
 128         union {
 129                 struct timespec nf_mtim;
 130                 off_t           nd_direof;      /* Dir. EOF offset cache */
 131         } n_un2;
 132         union {
 133                 struct sillyrename *nf_silly;   /* Ptr to silly rename struct */
 134                 LIST_HEAD(, nfsdmap) nd_cook;   /* cookies */
 135         } n_un3;
 136         short                   n_fhsize;       /* size in bytes, of fh */
 137         short                   n_flag;         /* Flag for locking.. */
 138         nfsfh_t                 n_fh;           /* Small File Handle */
 139         u_char                  *n_name;        /* leaf name, for v4 OPEN op */
 140         uint32_t                n_namelen;
 141         int                     n_directio_opens;
 142         int                     n_directio_asyncwr;
 143         struct nfs_attrcache_timestamp n_ac_ts;
 144 };
 145
 146 #define n_atim          n_un1.nf_atim
 147 #define n_mtim          n_un2.nf_mtim
 148 #define n_sillyrename   n_un3.nf_silly
 149 #define n_cookieverf    n_un1.nd_cookieverf
 150 #define n4_cookieverf   n_un1.nd4_cookieverf
 151 #define n_direofoffset  n_un2.nd_direof
 152 #define n_cookies       n_un3.nd_cook
 153
 154 /*
 155  * Flags for n_flag
 156  */
 157 #define NFSYNCWAIT      0x0002  /* fsync waiting for all directio async writes
 158                                   to drain */
 159 #define NMODIFIED       0x0004  /* Might have a modified buffer in bio */
 160 #define NWRITEERR       0x0008  /* Flag write errors so close will know */
 161 /* 0x20, 0x40, 0x80 free */
 162 #define NACC            0x0100  /* Special file accessed */
 163 #define NUPD            0x0200  /* Special file updated */
 164 #define NCHG            0x0400  /* Special file times changed */
 165 #define NCREATED        0x0800  /* Opened by nfs_create() */
 166 #define NTRUNCATE       0x1000  /* Opened by nfs_setattr() */
 167 #define NSIZECHANGED    0x2000  /* File size has changed: need cache inval */
 168 #define NNONCACHE       0x4000  /* Node marked as noncacheable */
 169 #define NDIRCOOKIELK    0x8000  /* Lock to serialize access to directory cookies */
 170
 171 /*
 172  * Convert between nfsnode pointers and vnode pointers
 173  */
 174 #define VTONFS(vp)      ((struct nfsnode *)(vp)->v_data)
 175 #define NFSTOV(np)      ((struct vnode *)(np)->n_vnode)
 176
 177 #define NFS_TIMESPEC_COMPARE(T1, T2)    (((T1)->tv_sec != (T2)->tv_sec) || ((T1)->tv_nsec != (T2)->tv_nsec))
 178
 179 /*
 180  * NFS iod threads can be in one of these three states once spawned.
 181  * NFSIOD_NOT_AVAILABLE - Cannot be assigned an I/O operation at this time.
 182  * NFSIOD_AVAILABLE - Available to be assigned an I/O operation.
 183  * NFSIOD_CREATED_FOR_NFS_ASYNCIO - Newly created for nfs_asyncio() and
 184  *      will be used by the thread that called nfs_asyncio().
 185  */
 186 enum nfsiod_state {
 187         NFSIOD_NOT_AVAILABLE = 0,
 188         NFSIOD_AVAILABLE = 1,
 189         NFSIOD_CREATED_FOR_NFS_ASYNCIO = 2,
 190 };
 191
 192 /*
 193  * Queue head for nfsiod's
 194  */
 195 extern TAILQ_HEAD(nfs_bufq, buf) nfs_bufq;
 196 extern enum nfsiod_state nfs_iodwant[NFS_MAXASYNCDAEMON];
 197 extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON];
 198
 199 #if defined(_KERNEL)
 200
 201 extern  struct vop_vector       nfs_fifoops;
 202 extern  struct vop_vector       nfs_vnodeops;
 203 extern struct buf_ops buf_ops_nfs;
 204
 205 extern vop_advlock_t *nfs_advlock_p;
 206 extern vop_reclaim_t *nfs_reclaim_p;
 207
 208 /*
 209  * Prototypes for NFS vnode operations
 210  */
 211 int     nfs_getpages(struct vop_getpages_args *);
 212 int     nfs_putpages(struct vop_putpages_args *);
 213 int     nfs_write(struct vop_write_args *);
 214 int     nfs_inactive(struct vop_inactive_args *);
 215 int     nfs_reclaim(struct vop_reclaim_args *);
 216
 217 /* other stuff */
 218 int     nfs_removeit(struct sillyrename *);
 219 int     nfs_nget(struct mount *, nfsfh_t *, int, struct nfsnode **, int flags);
 220 nfsuint64 *nfs_getcookie(struct nfsnode *, off_t, int);
 221 void    nfs_invaldir(struct vnode *);
 222 int     nfs_upgrade_vnlock(struct vnode *vp);
 223 void    nfs_downgrade_vnlock(struct vnode *vp, int old_lock);
 224 void    nfs_printf(const char *fmt, ...);
 225
 226 void nfs_dircookie_lock(struct nfsnode *np);
 227 void nfs_dircookie_unlock(struct nfsnode *np);
 228
 229 #endif /* _KERNEL */
 230
 231 #endif