2 * Copyright (c) 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
6 * Rick Macklem at The University of Guelph.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
32 * @(#)nfsnode.h 8.9 (Berkeley) 5/14/95
36 #ifndef _NFSCLIENT_NFSNODE_H_
37 #define _NFSCLIENT_NFSNODE_H_
39 #include <sys/_task.h>
40 #if !defined(_NFSCLIENT_NFS_H_) && !defined(_KERNEL)
45 * Silly rename structure that hangs off the nfsnode until the name
46 * can be removed by nfs_inactive()
52 int (*s_removeit)(struct sillyrename *sp);
58 * This structure is used to save the logical directory offset to
59 * NFS cookie mappings.
60 * The mappings are stored in a list headed
61 * by n_cookies, as required.
62 * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
63 * stored in increasing logical offset byte order.
65 #define NFSNUMCOOKIES 31
68 LIST_ENTRY(nfsdmap) ndm_list;
71 nfsuint64 ndmu3_cookies[NFSNUMCOOKIES];
72 uint64_t ndmu4_cookies[NFSNUMCOOKIES];
76 #define ndm_cookies ndm_un1.ndmu3_cookies
77 #define ndm4_cookies ndm_un1.ndmu4_cookies
79 struct nfs_attrcache_timestamp {
80 lwpid_t nfs_ac_ts_tid;
82 unsigned long nfs_ac_ts_syscalls;
85 struct nfs_accesscache {
86 u_int32_t mode; /* ACCESS mode cache */
87 uid_t uid; /* credentials having mode */
88 time_t stamp; /* mode cache timestamp */
92 * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
93 * is purely coincidental.
94 * There is a unique nfsnode allocated for each active file,
95 * each current directory, each mounted-on file, text file, and the root.
96 * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
97 * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
98 * type definitions), file handles of > 32 bytes should probably be split out
99 * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by
100 * changing the definition in nfsproto.h of NFS_SMALLFH.)
101 * NB: Hopefully the current order of the fields is such that everything will
102 * be well aligned and, therefore, tightly packed.
105 struct mtx n_mtx; /* Protects all of these members */
106 u_quad_t n_size; /* Current size of file */
107 u_quad_t n_brev; /* Modify rev when cached */
108 u_quad_t n_lrev; /* Modify rev for lease */
109 struct vattr n_vattr; /* Vnode attribute cache */
110 time_t n_attrstamp; /* Attr. cache timestamp */
111 struct nfs_accesscache n_accesscache[NFS_ACCESSCACHESIZE];
112 struct timespec n_mtime; /* Prev modify time. */
117 nfsfh_t *n_fhp; /* NFS File Handle */
118 struct vnode *n_vnode; /* associated vnode */
119 struct vnode *n_dvp; /* parent vnode */
120 int n_error; /* Save write error value */
122 struct timespec nf_atim; /* Special file times */
123 nfsuint64 nd_cookieverf; /* Cookie verifier (dir only) */
124 u_char nd4_cookieverf[NFSX_V4VERF];
127 struct timespec nf_mtim;
128 off_t nd_direof; /* Dir. EOF offset cache */
131 struct sillyrename *nf_silly; /* Ptr to silly rename struct */
132 LIST_HEAD(, nfsdmap) nd_cook; /* cookies */
134 short n_fhsize; /* size in bytes, of fh */
135 short n_flag; /* Flag for locking.. */
136 nfsfh_t n_fh; /* Small File Handle */
137 u_char *n_name; /* leaf name, for v4 OPEN op */
139 int n_directio_opens;
140 int n_directio_asyncwr;
141 struct nfs_attrcache_timestamp n_unused;
142 struct timespec n_unused4;
143 struct timespec n_unused5;
144 struct ucred *n_writecred; /* Cred. for putpages */
147 #define n_atim n_un1.nf_atim
148 #define n_mtim n_un2.nf_mtim
149 #define n_sillyrename n_un3.nf_silly
150 #define n_cookieverf n_un1.nd_cookieverf
151 #define n4_cookieverf n_un1.nd4_cookieverf
152 #define n_direofoffset n_un2.nd_direof
153 #define n_cookies n_un3.nd_cook
158 #define NFSYNCWAIT 0x0002 /* fsync waiting for all directio async writes
160 #define NMODIFIED 0x0004 /* Might have a modified buffer in bio */
161 #define NWRITEERR 0x0008 /* Flag write errors so close will know */
162 /* 0x20, 0x40, 0x80 free */
163 #define NACC 0x0100 /* Special file accessed */
164 #define NUPD 0x0200 /* Special file updated */
165 #define NCHG 0x0400 /* Special file times changed */
166 #define NCREATED 0x0800 /* Opened by nfs_create() */
167 #define NTRUNCATE 0x1000 /* Opened by nfs_setattr() */
168 #define NSIZECHANGED 0x2000 /* File size has changed: need cache inval */
169 #define NNONCACHE 0x4000 /* Node marked as noncacheable */
170 #define NDIRCOOKIELK 0x8000 /* Lock to serialize access to directory cookies */
173 * Convert between nfsnode pointers and vnode pointers
175 #define VTONFS(vp) ((struct nfsnode *)(vp)->v_data)
176 #define NFSTOV(np) ((struct vnode *)(np)->n_vnode)
178 #define NFS_TIMESPEC_COMPARE(T1, T2) (((T1)->tv_sec != (T2)->tv_sec) || ((T1)->tv_nsec != (T2)->tv_nsec))
181 * NFS iod threads can be in one of these two states once spawned.
182 * NFSIOD_NOT_AVAILABLE - Cannot be assigned an I/O operation at this time.
183 * NFSIOD_AVAILABLE - Available to be assigned an I/O operation.
186 NFSIOD_NOT_AVAILABLE = 0,
187 NFSIOD_AVAILABLE = 1,
191 * Queue head for nfsiod's
193 extern TAILQ_HEAD(nfs_bufq, buf) nfs_bufq;
194 extern enum nfsiod_state nfs_iodwant[NFS_MAXASYNCDAEMON];
195 extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON];
199 extern struct vop_vector nfs_fifoops;
200 extern struct vop_vector nfs_vnodeops;
201 extern struct buf_ops buf_ops_nfs;
204 * Prototypes for NFS vnode operations
206 int nfs_getpages(struct vop_getpages_args *);
207 int nfs_putpages(struct vop_putpages_args *);
208 int nfs_write(struct vop_write_args *);
209 int nfs_inactive(struct vop_inactive_args *);
210 int nfs_reclaim(struct vop_reclaim_args *);
213 int nfs_removeit(struct sillyrename *);
214 int nfs_nget(struct mount *, nfsfh_t *, int, struct nfsnode **, int flags);
215 nfsuint64 *nfs_getcookie(struct nfsnode *, off_t, int);
216 void nfs_invaldir(struct vnode *);
217 int nfs_upgrade_vnlock(struct vnode *vp);
218 void nfs_downgrade_vnlock(struct vnode *vp, int old_lock);
219 void nfs_printf(const char *fmt, ...);
221 void nfs_dircookie_lock(struct nfsnode *np);
222 void nfs_dircookie_unlock(struct nfsnode *np);