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