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 struct nfs_accesscache { 78 u_int32_t mode; /* ACCESS mode cache */ 79 uid_t uid; /* credentials having mode */ 80 time_t stamp; /* mode cache timestamp */ 81 }; 82 83 /* 84 * The nfsnode is the nfs equivalent to ufs's inode. Any similarity 85 * is purely coincidental. 86 * There is a unique nfsnode allocated for each active file, 87 * each current directory, each mounted-on file, text file, and the root. 88 * An nfsnode is 'named' by its file handle. (nget/nfs_node.c) 89 * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite 90 * type definitions), file handles of > 32 bytes should probably be split out 91 * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by 92 * changing the definition in nfsproto.h of NFS_SMALLFH.) 93 * NB: Hopefully the current order of the fields is such that everything will 94 * be well aligned and, therefore, tightly packed. 95 */ 96 struct nfsnode { 97 struct mtx n_mtx; /* Protects all of these members */ 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 struct nfs_accesscache n_accesscache[NFS_ACCESSCACHESIZE]; 104 struct timespec n_mtime; /* Prev modify time. */ 105 time_t n_ctime; /* Prev create time. */ 106 time_t n_dmtime; /* Prev dir modify time. */ 107 int n_dmtime_ticks; /* Tick of -ve cache entry */ 108 time_t n_expiry; /* Lease expiry time */ 109 nfsfh_t *n_fhp; /* NFS File Handle */ 110 struct vnode *n_vnode; /* associated vnode */ 111 struct vnode *n_dvp; /* parent vnode */ 112 int n_error; /* Save write error value */ 113 union { 114 struct timespec nf_atim; /* Special file times */ 115 nfsuint64 nd_cookieverf; /* Cookie verifier (dir only) */ 116 u_char nd4_cookieverf[NFSX_V4VERF]; 117 } n_un1; 118 union { 119 struct timespec nf_mtim; 120 off_t nd_direof; /* Dir. EOF offset cache */ 121 } n_un2; 122 union { 123 struct sillyrename *nf_silly; /* Ptr to silly rename struct */ 124 LIST_HEAD(, nfsdmap) nd_cook; /* cookies */ 125 } n_un3; 126 short n_fhsize; /* size in bytes, of fh */ 127 short n_flag; /* Flag for locking.. */ 128 nfsfh_t n_fh; /* Small File Handle */ 129 u_char *n_name; /* leaf name, for v4 OPEN op */ 130 uint32_t n_namelen; 131 int n_directio_opens; 132 int n_directio_asyncwr; 133 }; 134 135 #define n_atim n_un1.nf_atim 136 #define n_mtim n_un2.nf_mtim 137 #define n_sillyrename n_un3.nf_silly 138 #define n_cookieverf n_un1.nd_cookieverf 139 #define n4_cookieverf n_un1.nd4_cookieverf 140 #define n_direofoffset n_un2.nd_direof 141 #define n_cookies n_un3.nd_cook 142 143 /* 144 * Flags for n_flag 145 */ 146 #define NFSYNCWAIT 0x0002 /* fsync waiting for all directio async writes 147 to drain */ 148 #define NMODIFIED 0x0004 /* Might have a modified buffer in bio */ 149 #define NWRITEERR 0x0008 /* Flag write errors so close will know */ 150 /* 0x20, 0x40, 0x80 free */ 151 #define NACC 0x0100 /* Special file accessed */ 152 #define NUPD 0x0200 /* Special file updated */ 153 #define NCHG 0x0400 /* Special file times changed */ 154 #define NCREATED 0x0800 /* Opened by nfs_create() */ 155 #define NTRUNCATE 0x1000 /* Opened by nfs_setattr() */ 156 #define NSIZECHANGED 0x2000 /* File size has changed: need cache inval */ 157 #define NNONCACHE 0x4000 /* Node marked as noncacheable */ 158 #define NDIRCOOKIELK 0x8000 /* Lock to serialize access to directory cookies */ 159 160 /* 161 * Convert between nfsnode pointers and vnode pointers 162 */ 163 #define VTONFS(vp) ((struct nfsnode *)(vp)->v_data) 164 #define NFSTOV(np) ((struct vnode *)(np)->n_vnode) 165 166 #define NFS_TIMESPEC_COMPARE(T1, T2) (((T1)->tv_sec != (T2)->tv_sec) || ((T1)->tv_nsec != (T2)->tv_nsec)) 167 168 /* 169 * NFS iod threads can be in one of these three states once spawned. 170 * NFSIOD_NOT_AVAILABLE - Cannot be assigned an I/O operation at this time. 171 * NFSIOD_AVAILABLE - Available to be assigned an I/O operation. 172 * NFSIOD_CREATED_FOR_NFS_ASYNCIO - Newly created for nfs_asyncio() and 173 * will be used by the thread that called nfs_asyncio(). 174 */ 175 enum nfsiod_state { 176 NFSIOD_NOT_AVAILABLE = 0, 177 NFSIOD_AVAILABLE = 1, 178 NFSIOD_CREATED_FOR_NFS_ASYNCIO = 2, 179 }; 180 181 /* 182 * Queue head for nfsiod's 183 */ 184 extern TAILQ_HEAD(nfs_bufq, buf) nfs_bufq; 185 extern enum nfsiod_state nfs_iodwant[NFS_MAXASYNCDAEMON]; 186 extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON]; 187 188 #if defined(_KERNEL) 189 190 extern struct vop_vector nfs_fifoops; 191 extern struct vop_vector nfs_vnodeops; 192 extern struct buf_ops buf_ops_nfs; 193 194 extern vop_advlock_t *nfs_advlock_p; 195 extern vop_reclaim_t *nfs_reclaim_p; 196 197 /* 198 * Prototypes for NFS vnode operations 199 */ 200 int nfs_getpages(struct vop_getpages_args *); 201 int nfs_putpages(struct vop_putpages_args *); 202 int nfs_write(struct vop_write_args *); 203 int nfs_inactive(struct vop_inactive_args *); 204 int nfs_reclaim(struct vop_reclaim_args *); 205 206 /* other stuff */ 207 int nfs_removeit(struct sillyrename *); 208 int nfs_nget(struct mount *, nfsfh_t *, int, struct nfsnode **, int flags); 209 nfsuint64 *nfs_getcookie(struct nfsnode *, off_t, int); 210 void nfs_invaldir(struct vnode *); 211 int nfs_upgrade_vnlock(struct vnode *vp); 212 void nfs_downgrade_vnlock(struct vnode *vp, int old_lock); 213 void nfs_printf(const char *fmt, ...); 214 215 void nfs_dircookie_lock(struct nfsnode *np); 216 void nfs_dircookie_unlock(struct nfsnode *np); 217 218 #endif /* _KERNEL */ 219 220 #endif 221