1279377Simp/*- 2279377Simp * Copyright (c) 1989, 1993 3279377Simp * The Regents of the University of California. All rights reserved. 4279377Simp * 5279377Simp * This code is derived from software contributed to Berkeley by 6279377Simp * Rick Macklem at The University of Guelph. 7279377Simp * 8279377Simp * Redistribution and use in source and binary forms, with or without 9279377Simp * modification, are permitted provided that the following conditions 10279377Simp * are met: 11279377Simp * 1. Redistributions of source code must retain the above copyright 12279377Simp * notice, this list of conditions and the following disclaimer. 13279377Simp * 2. Redistributions in binary form must reproduce the above copyright 14279377Simp * notice, this list of conditions and the following disclaimer in the 15279377Simp * documentation and/or other materials provided with the distribution. 16279377Simp * 4. Neither the name of the University nor the names of its contributors 17279377Simp * may be used to endorse or promote products derived from this software 18279377Simp * without specific prior written permission. 19279377Simp * 20279377Simp * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21279377Simp * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22279377Simp * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23279377Simp * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24279377Simp * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25279377Simp * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26279377Simp * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27279377Simp * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28279377Simp * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29279377Simp * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30279377Simp * SUCH DAMAGE. 31279377Simp * 32279377Simp * @(#)nfsnode.h 8.9 (Berkeley) 5/14/95 33279377Simp * $FreeBSD$ 34279377Simp */ 35279377Simp 36279377Simp#ifndef _NFSCLIENT_NFSNODE_H_ 37279377Simp#define _NFSCLIENT_NFSNODE_H_ 38279377Simp 39279377Simp#include <sys/_task.h> 40279377Simp#if !defined(_NFSCLIENT_NFS_H_) && !defined(_KERNEL) 41279377Simp#include <nfs/nfs.h> 42279377Simp#endif 43279377Simp 44279377Simp/* 45279377Simp * Silly rename structure that hangs off the nfsnode until the name 46279377Simp * can be removed by nfs_inactive() 47279377Simp */ 48279377Simpstruct sillyrename { 49279377Simp struct task s_task; 50279377Simp struct ucred *s_cred; 51279377Simp struct vnode *s_dvp; 52279377Simp int (*s_removeit)(struct sillyrename *sp); 53279377Simp long s_namlen; 54279377Simp char s_name[32]; 55279377Simp}; 56279377Simp 57279377Simp/* 58279377Simp * This structure is used to save the logical directory offset to 59279377Simp * NFS cookie mappings. 60279377Simp * The mappings are stored in a list headed 61279377Simp * by n_cookies, as required. 62279377Simp * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information 63279377Simp * stored in increasing logical offset byte order. 64279377Simp */ 65279377Simp#define NFSNUMCOOKIES 31 66279377Simp 67279377Simpstruct nfsdmap { 68279377Simp LIST_ENTRY(nfsdmap) ndm_list; 69279377Simp int ndm_eocookie; 70279377Simp union { 71279377Simp nfsuint64 ndmu3_cookies[NFSNUMCOOKIES]; 72279377Simp uint64_t ndmu4_cookies[NFSNUMCOOKIES]; 73279377Simp } ndm_un1; 74279377Simp}; 75279377Simp 76#define ndm_cookies ndm_un1.ndmu3_cookies 77#define ndm4_cookies ndm_un1.ndmu4_cookies 78 79struct nfs_accesscache { 80 u_int32_t mode; /* ACCESS mode cache */ 81 uid_t uid; /* credentials having mode */ 82 time_t stamp; /* mode cache timestamp */ 83}; 84 85/* 86 * The nfsnode is the nfs equivalent to ufs's inode. Any similarity 87 * is purely coincidental. 88 * There is a unique nfsnode allocated for each active file, 89 * each current directory, each mounted-on file, text file, and the root. 90 * An nfsnode is 'named' by its file handle. (nget/nfs_node.c) 91 * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite 92 * type definitions), file handles of > 32 bytes should probably be split out 93 * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by 94 * changing the definition in nfsproto.h of NFS_SMALLFH.) 95 * NB: Hopefully the current order of the fields is such that everything will 96 * be well aligned and, therefore, tightly packed. 97 */ 98struct nfsnode { 99 struct mtx n_mtx; /* Protects all of these members */ 100 u_quad_t n_size; /* Current size of file */ 101 u_quad_t n_brev; /* Modify rev when cached */ 102 u_quad_t n_lrev; /* Modify rev for lease */ 103 struct vattr n_vattr; /* Vnode attribute cache */ 104 time_t n_attrstamp; /* Attr. cache timestamp */ 105 struct nfs_accesscache n_accesscache[NFS_ACCESSCACHESIZE]; 106 struct timespec n_mtime; /* Prev modify time. */ 107 struct timespec n_unused0; 108 struct timespec n_unused1; 109 int n_unused2; 110 nfsfh_t *n_fhp; /* NFS File Handle */ 111 struct vnode *n_vnode; /* associated vnode */ 112 struct vnode *n_dvp; /* parent vnode */ 113 int n_error; /* Save write error value */ 114 union { 115 struct timespec nf_atim; /* Special file times */ 116 nfsuint64 nd_cookieverf; /* Cookie verifier (dir only) */ 117 u_char nd4_cookieverf[NFSX_V4VERF]; 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 u_char *n_name; /* leaf name, for v4 OPEN op */ 131 uint32_t n_namelen; 132 int n_directio_opens; 133 int n_directio_asyncwr; 134 struct ucred *n_writecred; /* Cred. for putpages */ 135}; 136 137#define n_atim n_un1.nf_atim 138#define n_mtim n_un2.nf_mtim 139#define n_sillyrename n_un3.nf_silly 140#define n_cookieverf n_un1.nd_cookieverf 141#define n4_cookieverf n_un1.nd4_cookieverf 142#define n_direofoffset n_un2.nd_direof 143#define n_cookies n_un3.nd_cook 144 145/* 146 * Flags for n_flag 147 */ 148#define NFSYNCWAIT 0x0002 /* fsync waiting for all directio async writes 149 to drain */ 150#define NMODIFIED 0x0004 /* Might have a modified buffer in bio */ 151#define NWRITEERR 0x0008 /* Flag write errors so close will know */ 152/* 0x20, 0x40, 0x80 free */ 153#define NACC 0x0100 /* Special file accessed */ 154#define NUPD 0x0200 /* Special file updated */ 155#define NCHG 0x0400 /* Special file times changed */ 156#define NCREATED 0x0800 /* Opened by nfs_create() */ 157#define NTRUNCATE 0x1000 /* Opened by nfs_setattr() */ 158#define NSIZECHANGED 0x2000 /* File size has changed: need cache inval */ 159#define NNONCACHE 0x4000 /* Node marked as noncacheable */ 160#define NDIRCOOKIELK 0x8000 /* Lock to serialize access to directory cookies */ 161 162/* 163 * Convert between nfsnode pointers and vnode pointers 164 */ 165#define VTONFS(vp) ((struct nfsnode *)(vp)->v_data) 166#define NFSTOV(np) ((struct vnode *)(np)->n_vnode) 167 168#define NFS_TIMESPEC_COMPARE(T1, T2) (((T1)->tv_sec != (T2)->tv_sec) || ((T1)->tv_nsec != (T2)->tv_nsec)) 169 170/* 171 * NFS iod threads can be in one of these two states once spawned. 172 * NFSIOD_NOT_AVAILABLE - Cannot be assigned an I/O operation at this time. 173 * NFSIOD_AVAILABLE - Available to be assigned an I/O operation. 174 */ 175enum nfsiod_state { 176 NFSIOD_NOT_AVAILABLE = 0, 177 NFSIOD_AVAILABLE = 1, 178}; 179 180/* 181 * Queue head for nfsiod's 182 */ 183extern TAILQ_HEAD(nfs_bufq, buf) nfs_bufq; 184extern enum nfsiod_state nfs_iodwant[NFS_MAXASYNCDAEMON]; 185extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON]; 186 187#if defined(_KERNEL) 188 189extern struct vop_vector nfs_fifoops; 190extern struct vop_vector nfs_vnodeops; 191extern struct buf_ops buf_ops_nfs; 192 193/* 194 * Prototypes for NFS vnode operations 195 */ 196int nfs_getpages(struct vop_getpages_args *); 197int nfs_putpages(struct vop_putpages_args *); 198int nfs_write(struct vop_write_args *); 199int nfs_inactive(struct vop_inactive_args *); 200int nfs_reclaim(struct vop_reclaim_args *); 201 202/* other stuff */ 203int nfs_removeit(struct sillyrename *); 204int nfs_nget(struct mount *, nfsfh_t *, int, struct nfsnode **, int flags); 205nfsuint64 *nfs_getcookie(struct nfsnode *, off_t, int); 206void nfs_invaldir(struct vnode *); 207int nfs_upgrade_vnlock(struct vnode *vp); 208void nfs_downgrade_vnlock(struct vnode *vp, int old_lock); 209void nfs_printf(const char *fmt, ...); 210 211void nfs_dircookie_lock(struct nfsnode *np); 212void nfs_dircookie_unlock(struct nfsnode *np); 213 214#endif /* _KERNEL */ 215 216#endif 217