nfsnode.h revision 1.48 1 /* $NetBSD: nfsnode.h,v 1.48 2004/08/24 20:09:44 yamt Exp $ */
2
3 /*
4 * Copyright (c) 1989, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * Rick Macklem at The University of Guelph.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 * @(#)nfsnode.h 8.9 (Berkeley) 5/14/95
35 */
36
37
38 #ifndef _NFS_NFSNODE_H_
39 #define _NFS_NFSNODE_H_
40
41 #ifndef _NFS_NFS_H_
42 #include <nfs/nfs.h>
43 #endif
44 #include <miscfs/genfs/genfs.h>
45 #include <miscfs/genfs/genfs_node.h>
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 * Definitions for the directory cache. Because directory cookies
60 * are an opaque 64 bit entity, we need to provide some sort of
61 * mapping between cookies and logical blocknumbers. Also,
62 * we should store the cookies from the server somewhere,
63 * to be able to satisfy VOP_READDIR requests for cookies.
64 * We can't store the cookies in the dirent structure, as some
65 * other systems.
66 *
67 * Each offset is hashed into a per-nfsnode hashtable. An entry
68 * found therein contains information about the (faked up)
69 * logical blocknumber, and also a pointer to a buffer where
70 * the cookies are stored.
71 */
72
73 extern u_long nfsdirhashmask;
74
75 LIST_HEAD(nfsdirhashhead, nfsdircache);
76 TAILQ_HEAD(nfsdirchainhead, nfsdircache);
77
78 struct nfsdircache {
79 off_t dc_cookie; /* Own offset (key) */
80 off_t dc_blkcookie; /* Offset of block we're in */
81 LIST_ENTRY(nfsdircache) dc_hash; /* Hash chain */
82 TAILQ_ENTRY(nfsdircache) dc_chain; /* Least recently entered chn */
83 u_int32_t dc_cookie32; /* Key for 64<->32 xlate case */
84 daddr_t dc_blkno; /* Number of block we're in */
85 int dc_entry; /* Entry number within block */
86 };
87
88
89 /*
90 * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
91 * is purely coincidental.
92 * There is a unique nfsnode allocated for each active file,
93 * each current directory, each mounted-on file, text file, and the root.
94 * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
95 */
96
97 struct nfsnode_spec {
98 struct timespec nspec_mtim; /* local mtime */
99 struct timespec nspec_atim; /* local atime */
100 };
101
102 struct nfsnode_reg {
103 off_t nreg_pushedlo; /* 1st blk in commited range */
104 off_t nreg_pushedhi; /* Last block in range */
105 off_t nreg_pushlo; /* 1st block in commit range */
106 off_t nreg_pushhi; /* Last block in range */
107 struct lock nreg_commitlock; /* Serialize commits XXX */
108 int nreg_commitflags;
109 int nreg_error; /* Save write error value */
110 };
111
112 struct nfsnode_dir {
113 off_t ndir_direof; /* EOF offset cache */
114 nfsuint64 ndir_cookieverf; /* Cookie verifier */
115 daddr_t ndir_dblkno; /* faked dir blkno */
116 struct nfsdirhashhead *ndir_dircache; /* offset -> cache hash heads */
117 struct nfsdirchainhead ndir_dirchain; /* Chain of dir cookies */
118 struct timespec ndir_nctime; /* Last neg cache entry */
119 unsigned ndir_dircachesize; /* Size of dir cookie cache */
120 };
121
122 struct nfsnode {
123 struct genfs_node n_gnode;
124 u_quad_t n_size; /* Current size of file */
125
126 union {
127 struct nfsnode_spec nu_spec;
128 struct nfsnode_reg nu_reg;
129 struct nfsnode_dir nu_dir;
130 } n_un1;
131
132 #define n_mtim n_un1.nu_spec.nspec_mtim
133 #define n_atim n_un1.nu_spec.nspec_atim
134
135 #define n_pushedlo n_un1.nu_reg.nreg_pushedlo
136 #define n_pushedhi n_un1.nu_reg.nreg_pushedhi
137 #define n_pushlo n_un1.nu_reg.nreg_pushlo
138 #define n_pushhi n_un1.nu_reg.nreg_pushhi
139 #define n_commitlock n_un1.nu_reg.nreg_commitlock
140 #define n_commitflags n_un1.nu_reg.nreg_commitflags
141 #define n_error n_un1.nu_reg.nreg_error
142
143 #define n_direofoffset n_un1.nu_dir.ndir_direof
144 #define n_cookieverf n_un1.nu_dir.ndir_cookieverf
145 #define n_dblkno n_un1.nu_dir.ndir_dblkno
146 #define n_dircache n_un1.nu_dir.ndir_dircache
147 #define n_dirchain n_un1.nu_dir.ndir_dirchain
148 #define n_nctime n_un1.nu_dir.ndir_nctime
149 #define n_dircachesize n_un1.nu_dir.ndir_dircachesize
150
151 union {
152 struct sillyrename *nf_silly; /* !VDIR: silly rename struct */
153 unsigned *ndir_dirgens; /* 32<->64bit xlate gen. no. */
154 } n_un2;
155
156 #define n_sillyrename n_un2.nf_silly
157 #define n_dirgens n_un2.ndir_dirgens
158
159 LIST_ENTRY(nfsnode) n_hash; /* Hash chain */
160 nfsfh_t *n_fhp; /* NFS File Handle */
161 struct vattr *n_vattr; /* Vnode attribute cache */
162 struct vnode *n_vnode; /* associated vnode */
163 struct lockf *n_lockf; /* Locking record of file */
164 time_t n_attrstamp; /* Attr. cache timestamp */
165 struct timespec n_mtime; /* Prev modify time. */
166 time_t n_ctime; /* Prev create time. */
167 short n_fhsize; /* size in bytes, of fh */
168 short n_flag; /* Flag for locking.. */
169 nfsfh_t n_fh; /* Small File Handle */
170 time_t n_accstamp; /* Access cache timestamp */
171 uid_t n_accuid; /* Last access requester */
172 int n_accmode; /* Mode last requested */
173 int n_accerror; /* Error last returned */
174 struct ucred *n_rcred;
175 struct ucred *n_wcred;
176
177 /* members below are only used by NQNFS */
178 CIRCLEQ_ENTRY(nfsnode) n_timer; /* Nqnfs timer chain */
179 u_quad_t n_brev; /* Modify rev when cached */
180 u_quad_t n_lrev; /* Modify rev for lease */
181 time_t n_expiry; /* Lease expiry time */
182 };
183 LIST_HEAD(nfsnodehashhead, nfsnode);
184
185 /*
186 * Values for n_commitflags
187 */
188 #define NFS_COMMIT_PUSH_VALID 0x0001 /* push range valid */
189 #define NFS_COMMIT_PUSHED_VALID 0x0002 /* pushed range valid */
190
191 /*
192 * Flags for n_flag
193 */
194 #define NFLUSHWANT 0x0001 /* Want wakeup from a flush in prog. */
195 #define NFLUSHINPROG 0x0002 /* Avoid multiple calls to vinvalbuf() */
196 #define NMODIFIED 0x0004 /* Might have a modified buffer in bio */
197 #define NWRITEERR 0x0008 /* Flag write errors so close will know */
198 #define NQNFSNONCACHE 0x0020 /* Non-cachable lease */
199 #define NQNFSWRITE 0x0040 /* Write lease */
200 #define NQNFSEVICTED 0x0080 /* Has been evicted */
201 #define NACC 0x0100 /* Special file accessed */
202 #define NUPD 0x0200 /* Special file updated */
203 #define NCHG 0x0400 /* Special file times changed */
204 #define NTRUNCDELAYED 0x1000 /* Should be truncated later */
205 #define NREMOVED 0x2000 /* Has been removed */
206 #define NUSEOPENCRED 0x4000 /* Try open cred first rather than owner's */
207
208 /*
209 * Convert between nfsnode pointers and vnode pointers
210 */
211 #define VTONFS(vp) ((struct nfsnode *)(vp)->v_data)
212 #define NFSTOV(np) ((np)->n_vnode)
213
214 /*
215 * Per-nfsiod datas
216 */
217 struct nfs_iod {
218 struct simplelock nid_slock;
219 struct proc *nid_proc;
220 struct proc *nid_want;
221 struct nfsmount *nid_mount;
222 };
223 extern struct nfs_iod nfs_asyncdaemon[NFS_MAXASYNCDAEMON];
224
225 #ifdef _KERNEL
226 /*
227 * Prototypes for NFS vnode operations
228 */
229 int nfs_lookup __P((void *));
230 int nfs_create __P((void *));
231 int nfs_mknod __P((void *));
232 int nfs_open __P((void *));
233 int nfs_close __P((void *));
234 int nfsspec_close __P((void *));
235 int nfsfifo_close __P((void *));
236 int nfs_access __P((void *));
237 int nfsspec_access __P((void *));
238 int nfs_getattr __P((void *));
239 int nfs_setattr __P((void *));
240 int nfs_read __P((void *));
241 int nfs_write __P((void *));
242 #define nfs_lease_check genfs_nullop
243 int nfsspec_read __P((void *));
244 int nfsspec_write __P((void *));
245 int nfsfifo_read __P((void *));
246 int nfsfifo_write __P((void *));
247 #define nfs_ioctl genfs_enoioctl
248 #define nfs_poll genfs_poll
249 #define nfs_revoke genfs_revoke
250 #define nfs_mmap genfs_mmap
251 int nfs_fsync __P((void *));
252 #define nfs_seek genfs_seek
253 int nfs_remove __P((void *));
254 int nfs_link __P((void *));
255 int nfs_rename __P((void *));
256 int nfs_mkdir __P((void *));
257 int nfs_rmdir __P((void *));
258 int nfs_symlink __P((void *));
259 int nfs_readdir __P((void *));
260 int nfs_readlink __P((void *));
261 #define nfs_abortop genfs_abortop
262 int nfs_inactive __P((void *));
263 int nfs_reclaim __P((void *));
264 #define nfs_lock genfs_lock
265 int nfs_unlock __P((void *));
266 #define nfs_islocked genfs_islocked
267 int nfs_bmap __P((void *));
268 int nfs_strategy __P((void *));
269 int nfs_print __P((void *));
270 int nfs_pathconf __P((void *));
271 int nfs_advlock __P((void *));
272 #define nfs_blkatoff genfs_eopnotsupp
273 int nfs_bwrite __P((void *));
274 #define nfs_valloc genfs_eopnotsupp
275 #define nfs_reallocblks genfs_eopnotsupp
276 #define nfs_vfree genfs_nullop
277 int nfs_truncate __P((void *));
278 int nfs_getpages __P((void *));
279 int nfs_putpages __P((void *));
280 int nfs_gop_write(struct vnode *, struct vm_page **, int, int);
281 int nfs_kqfilter __P((void *));
282
283 extern int (**nfsv2_vnodeop_p) __P((void *));
284
285 #define NFS_INVALIDATE_ATTRCACHE(np) (np)->n_attrstamp = 0
286
287 #endif /* _KERNEL */
288
289 #endif
290