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$ 38 */ 39 40 #ifndef _NFSCLIENT_NFSNODE_H_ 41 #define _NFSCLIENT_NFSNODE_H_ 42 43 #if !defined(_NFSCLIENT_NFS_H_) && !defined(_KERNEL) 44 #include <nfs/nfs.h> 45 #endif 46 47 /* 48 * Silly rename structure that hangs off the nfsnode until the name 49 * can be removed by nfs_inactive() 50 */ 51 struct sillyrename { 52 struct ucred *s_cred; 53 struct vnode *s_dvp; 54 int (*s_removeit)(struct sillyrename *sp); 55 long s_namlen; 56 char s_name[20]; 57 }; 58 59 /* 60 * This structure is used to save the logical directory offset to 61 * NFS cookie mappings. 62 * The mappings are stored in a list headed 63 * by n_cookies, as required. 64 * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information 65 * stored in increasing logical offset byte order. 66 */ 67 #define NFSNUMCOOKIES 31 68 69 struct nfsdmap { 70 LIST_ENTRY(nfsdmap) ndm_list; 71 int ndm_eocookie; 72 union { 73 nfsuint64 ndmu3_cookies[NFSNUMCOOKIES]; 74 uint64_t ndmu4_cookies[NFSNUMCOOKIES]; 75 } ndm_un1; 76 }; 77 78 #define ndm_cookies ndm_un1.ndmu3_cookies 79 #define ndm4_cookies ndm_un1.ndmu4_cookies 80 81 /* 82 * The nfsnode is the nfs equivalent to ufs's inode. Any similarity 83 * is purely coincidental. 84 * There is a unique nfsnode allocated for each active file, 85 * each current directory, each mounted-on file, text file, and the root. 86 * An nfsnode is 'named' by its file handle. (nget/nfs_node.c) 87 * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite 88 * type definitions), file handles of > 32 bytes should probably be split out 89 * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by 90 * changing the definition in nfsproto.h of NFS_SMALLFH.) 91 * NB: Hopefully the current order of the fields is such that everything will 92 * be well aligned and, therefore, tightly packed. 93 */ 94 struct nfsnode { 95 LIST_ENTRY(nfsnode) n_hash; /* Hash chain */ 96 u_quad_t n_size; /* Current size of file */ 97 u_quad_t n_brev; /* Modify rev when cached */ 98 u_quad_t n_lrev; /* Modify rev for lease */ 99 struct vattr n_vattr; /* Vnode attribute cache */ 100 time_t n_attrstamp; /* Attr. cache timestamp */ 101 u_int32_t n_mode; /* ACCESS mode cache */ 102 uid_t n_modeuid; /* credentials having mode */ 103 time_t n_modestamp; /* mode cache timestamp */ 104 time_t n_mtime; /* Prev modify time. */ 105 time_t n_ctime; /* Prev create time. */ 106 time_t n_expiry; /* Lease expiry time */ 107 nfsfh_t *n_fhp; /* NFS File Handle */ 108 struct vnode *n_vnode; /* associated vnode */ 109 struct vnode *n_dvp; /* parent vnode */ 110 struct lockf *n_lockf; /* Locking record of file */ 111 int n_error; /* Save write error value */ 112 union { 113 struct timespec nf_atim; /* Special file times */ 114 nfsuint64 nd_cookieverf; /* Cookie verifier (dir only) */ 115 u_char nd4_cookieverf[NFSX_V4VERF]; 116 } n_un1; 117 union { 118 struct timespec nf_mtim; 119 off_t nd_direof; /* Dir. EOF offset cache */ 120 } n_un2; 121 union { 122 struct sillyrename *nf_silly; /* Ptr to silly rename struct */ 123 LIST_HEAD(, nfsdmap) nd_cook; /* cookies */ 124 } n_un3; 125 short n_fhsize; /* size in bytes, of fh */ 126 short n_flag; /* Flag for locking.. */ 127 nfsfh_t n_fh; /* Small File Handle */ 128 struct lock n_rslock; 129 struct nfs4_fctx n_rfc; 130 struct nfs4_fctx n_wfc; 131 /* 132 * The last component name is needed for the NFSv4 OPEN 133 * operation. 134 */ 135 u_char *n_name; 136 uint32_t n_namelen; 137 }; 138 139 #define n_atim n_un1.nf_atim 140 #define n_mtim n_un2.nf_mtim 141 #define n_sillyrename n_un3.nf_silly 142 #define n_cookieverf n_un1.nd_cookieverf 143 #define n4_cookieverf n_un1.nd4_cookieverf 144 #define n_direofoffset n_un2.nd_direof 145 #define n_cookies n_un3.nd_cook 146 147 /* 148 * Flags for n_flag 149 */ 150 #define NFLUSHWANT 0x0001 /* Want wakeup from a flush in prog. */ 151 #define NFLUSHINPROG 0x0002 /* Avoid multiple calls to vinvalbuf() */ 152 #define NMODIFIED 0x0004 /* Might have a modified buffer in bio */ 153 #define NWRITEERR 0x0008 /* Flag write errors so close will know */ 154 /* 0x20, 0x40, 0x80 free */ 155 #define NACC 0x0100 /* Special file accessed */ 156 #define NUPD 0x0200 /* Special file updated */ 157 #define NCHG 0x0400 /* Special file times changed */ 158 #define NCREATED 0x0800 /* Opened by nfs_create() */ 159 #define NTRUNCATE 0x1000 /* Opened by nfs_setattr() */ 160 161 /* 162 * Convert between nfsnode pointers and vnode pointers 163 */ 164 #define VTONFS(vp) ((struct nfsnode *)(vp)->v_data) 165 #define NFSTOV(np) ((struct vnode *)(np)->n_vnode) 166 167 /* 168 * Queue head for nfsiod's 169 */ 170 extern TAILQ_HEAD(nfs_bufq, buf) nfs_bufq; 171 extern struct proc *nfs_iodwant[NFS_MAXASYNCDAEMON]; 172 extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON]; 173 174 #if defined(_KERNEL) 175 176 /* 177 * nfs_rslock - Attempt to obtain lock on nfsnode 178 * 179 * Attempt to obtain a lock on the passed nfsnode, returning ENOLCK 180 * if the lock could not be obtained due to our having to sleep. This 181 * function is generally used to lock around code that modifies an 182 * NFS file's size. In order to avoid deadlocks the lock 183 * should not be obtained while other locks are being held. 184 */ 185 186 static __inline int 187 nfs_rslock(struct nfsnode *np, struct thread *td) 188 { 189 190 return(lockmgr(&np->n_rslock, 191 LK_EXCLUSIVE | LK_CANRECURSE | LK_SLEEPFAIL, NULL, td)); 192 } 193 194 static __inline void 195 nfs_rsunlock(struct nfsnode *np, struct thread *td) 196 { 197 198 (void)lockmgr(&np->n_rslock, LK_RELEASE, NULL, td); 199 } 200 201 extern vop_t **fifo_nfsnodeop_p; 202 extern vop_t **nfs_vnodeop_p; 203 extern vop_t **spec_nfsnodeop_p; 204 205 extern vop_t **fifo_nfs4nodeop_p; 206 extern vop_t **nfs4_vnodeop_p; 207 extern vop_t **spec_nfs4nodeop_p; 208 209 /* 210 * Prototypes for NFS vnode operations 211 */ 212 int nfs_getpages(struct vop_getpages_args *); 213 int nfs_putpages(struct vop_putpages_args *); 214 int nfs_write(struct vop_write_args *); 215 int nfs_inactive(struct vop_inactive_args *); 216 int nfs_reclaim(struct vop_reclaim_args *); 217 218 /* other stuff */ 219 int nfs_removeit(struct sillyrename *); 220 int nfs4_removeit(struct sillyrename *); 221 int nfs_nget(struct mount *, nfsfh_t *, int, struct nfsnode **); 222 nfsuint64 *nfs_getcookie(struct nfsnode *, off_t, int); 223 uint64_t *nfs4_getcookie(struct nfsnode *, off_t, int); 224 void nfs_invaldir(struct vnode *); 225 void nfs4_invaldir(struct vnode *); 226 227 #endif /* _KERNEL */ 228 229 #endif 230