nfsnode.h revision 1.68 1 /* $NetBSD: nfsnode.h,v 1.68 2008/10/22 11:36:06 matt 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 #include <sys/condvar.h>
42 #include <sys/mutex.h>
43 #include <sys/rb.h>
44
45 #ifndef _NFS_NFS_H_
46 #include <nfs/nfs.h>
47 #endif
48 #include <miscfs/genfs/genfs.h>
49 #include <miscfs/genfs/genfs_node.h>
50
51 /*
52 * Silly rename structure that hangs off the nfsnode until the name
53 * can be removed by nfs_inactive()
54 */
55 struct sillyrename {
56 kauth_cred_t s_cred;
57 struct vnode *s_dvp;
58 long s_namlen;
59 char s_name[20];
60 };
61
62 /*
63 * Definitions for the directory cache. Because directory cookies
64 * are an opaque 64 bit entity, we need to provide some sort of
65 * mapping between cookies and logical blocknumbers. Also,
66 * we should store the cookies from the server somewhere,
67 * to be able to satisfy VOP_READDIR requests for cookies.
68 * We can't store the cookies in the dirent structure, as some
69 * other systems.
70 *
71 * Each offset is hashed into a per-nfsnode hashtable. An entry
72 * found therein contains information about the (faked up)
73 * logical blocknumber, and also a pointer to a buffer where
74 * the cookies are stored.
75 */
76
77
78 LIST_HEAD(nfsdirhashhead, nfsdircache);
79 TAILQ_HEAD(nfsdirchainhead, nfsdircache);
80
81 struct nfsdircache {
82 off_t dc_cookie; /* Own offset (key) */
83 off_t dc_blkcookie; /* Offset of block we're in */
84 LIST_ENTRY(nfsdircache) dc_hash; /* Hash chain */
85 TAILQ_ENTRY(nfsdircache) dc_chain; /* Least recently entered chn */
86 u_int32_t dc_cookie32; /* Key for 64<->32 xlate case */
87 int dc_entry; /* Entry number within block */
88 int dc_refcnt; /* Reference count */
89 int dc_flags; /* NFSDC_ flags */
90 };
91
92 #define NFSDC_INVALID 1
93
94 /*
95 * NFSDC_BLKNO: get buffer cache index
96 */
97 #define NFSDC_BLKNO(ndp) ((daddr_t)(ndp)->dc_blkcookie)
98
99 /*
100 * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
101 * is purely coincidental.
102 * There is a unique nfsnode allocated for each active file,
103 * each current directory, each mounted-on file, text file, and the root.
104 * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
105 */
106
107 struct nfsnode_spec {
108 struct timespec nspec_mtim; /* local mtime */
109 struct timespec nspec_atim; /* local atime */
110 };
111
112 struct nfsnode_reg {
113 off_t nreg_pushedlo; /* 1st blk in commited range */
114 off_t nreg_pushedhi; /* Last block in range */
115 off_t nreg_pushlo; /* 1st block in commit range */
116 off_t nreg_pushhi; /* Last block in range */
117 kmutex_t nreg_commitlock; /* Serialize commits XXX */
118 int nreg_commitflags;
119 int nreg_error; /* Save write error value */
120 };
121
122 struct nfsnode_dir {
123 off_t ndir_direof; /* EOF offset cache */
124 nfsuint64 ndir_cookieverf; /* Cookie verifier */
125 struct nfsdirhashhead *ndir_dircache; /* offset -> cache hash heads */
126 struct nfsdirchainhead ndir_dirchain; /* Chain of dir cookies */
127 struct timespec ndir_nctime; /* Last name cache entry */
128 unsigned ndir_dircachesize; /* Size of dir cookie cache */
129 };
130
131 struct nfsnode {
132 struct genfs_node n_gnode;
133 u_quad_t n_size; /* Current size of file */
134
135 union {
136 struct nfsnode_spec nu_spec;
137 struct nfsnode_reg nu_reg;
138 struct nfsnode_dir nu_dir;
139 } n_un1;
140
141 #define n_mtim n_un1.nu_spec.nspec_mtim
142 #define n_atim n_un1.nu_spec.nspec_atim
143
144 #define n_pushedlo n_un1.nu_reg.nreg_pushedlo
145 #define n_pushedhi n_un1.nu_reg.nreg_pushedhi
146 #define n_pushlo n_un1.nu_reg.nreg_pushlo
147 #define n_pushhi n_un1.nu_reg.nreg_pushhi
148 #define n_commitlock n_un1.nu_reg.nreg_commitlock
149 #define n_commitflags n_un1.nu_reg.nreg_commitflags
150 #define n_error n_un1.nu_reg.nreg_error
151
152 #define n_direofoffset n_un1.nu_dir.ndir_direof
153 #define n_cookieverf n_un1.nu_dir.ndir_cookieverf
154 #define n_dircache n_un1.nu_dir.ndir_dircache
155 #define n_dirchain n_un1.nu_dir.ndir_dirchain
156 #define n_nctime n_un1.nu_dir.ndir_nctime
157 #define n_dircachesize n_un1.nu_dir.ndir_dircachesize
158
159 union {
160 struct sillyrename *nf_silly; /* !VDIR: silly rename struct */
161 unsigned *ndir_dirgens; /* 32<->64bit xlate gen. no. */
162 } n_un2;
163
164 #define n_sillyrename n_un2.nf_silly
165 #define n_dirgens n_un2.ndir_dirgens
166
167 struct rb_node n_rbnode; /* red/black node */
168 nfsfh_t *n_fhp; /* NFS File Handle */
169 struct vattr *n_vattr; /* Vnode attribute cache */
170 struct vnode *n_vnode; /* associated vnode */
171 struct lockf *n_lockf; /* Locking record of file */
172 time_t n_attrstamp; /* Attr. cache timestamp */
173 struct timespec n_mtime; /* Prev modify time. */
174 time_t n_ctime; /* Prev create time. */
175 short n_fhsize; /* size in bytes, of fh */
176 short n_flag; /* Flag for locking.. */
177 nfsfh_t n_fh; /* Small File Handle */
178 time_t n_accstamp; /* Access cache timestamp */
179 uid_t n_accuid; /* Last access requester */
180 int n_accmode; /* Mode last requested */
181 int n_accerror; /* Error last returned */
182 kauth_cred_t n_rcred;
183 kauth_cred_t n_wcred;
184 };
185
186 /*
187 * Values for n_commitflags
188 */
189 #define NFS_COMMIT_PUSH_VALID 0x0001 /* push range valid */
190 #define NFS_COMMIT_PUSHED_VALID 0x0002 /* pushed range valid */
191
192 /*
193 * Flags for n_flag
194 */
195 #define NFLUSHWANT 0x0001 /* Want wakeup from a flush in prog. */
196 #define NFLUSHINPROG 0x0002 /* Avoid multiple calls to vinvalbuf() */
197 #define NMODIFIED 0x0004 /* Might have a modified buffer in bio */
198 #define NWRITEERR 0x0008 /* Flag write errors so close will know */
199 #define NACC 0x0100 /* Special file accessed */
200 #define NUPD 0x0200 /* Special file updated */
201 #define NCHG 0x0400 /* Special file times changed */
202 #define NTRUNCDELAYED 0x1000 /* Should be truncated later;
203 implies stale cache */
204 #define NREMOVED 0x2000 /* Has been removed */
205 #define NUSEOPENCRED 0x4000 /* Try open cred first rather than owner's */
206 #define NEOFVALID 0x8000 /* dir: n_direofoffset is valid */
207
208 #define NFS_EOFVALID(ndp) ((ndp)->n_flag & NEOFVALID)
209
210 /*
211 * Convert between nfsnode pointers and vnode pointers
212 */
213 #define VTONFS(vp) ((struct nfsnode *)(vp)->v_data)
214 #define NFSTOV(np) ((np)->n_vnode)
215
216 #ifdef _KERNEL
217
218 /*
219 * Per-nfsiod datas
220 */
221 struct nfs_iod {
222 kmutex_t nid_lock;
223 kcondvar_t nid_cv;
224 LIST_ENTRY(nfs_iod) nid_idle;
225 struct nfsmount *nid_mount;
226 bool nid_exiting;
227
228 LIST_ENTRY(nfs_iod) nid_all;
229 };
230
231 LIST_HEAD(nfs_iodlist, nfs_iod);
232 extern kmutex_t nfs_iodlist_lock;
233 extern struct nfs_iodlist nfs_iodlist_idle;
234 extern struct nfs_iodlist nfs_iodlist_all;
235 extern u_long nfsdirhashmask;
236
237 /*
238 * Prototypes for NFS vnode operations
239 */
240 int nfs_lookup __P((void *));
241 int nfs_create __P((void *));
242 int nfs_mknod __P((void *));
243 int nfs_open __P((void *));
244 int nfs_close __P((void *));
245 int nfsspec_close __P((void *));
246 int nfsfifo_close __P((void *));
247 int nfs_access __P((void *));
248 int nfsspec_access __P((void *));
249 int nfs_getattr __P((void *));
250 int nfs_setattr __P((void *));
251 int nfs_read __P((void *));
252 int nfs_write __P((void *));
253 int nfsspec_read __P((void *));
254 int nfsspec_write __P((void *));
255 int nfsfifo_read __P((void *));
256 int nfsfifo_write __P((void *));
257 #define nfs_ioctl genfs_enoioctl
258 #define nfs_poll genfs_poll
259 #define nfs_revoke genfs_revoke
260 #define nfs_mmap genfs_mmap
261 int nfs_fsync __P((void *));
262 #define nfs_seek genfs_seek
263 int nfs_remove __P((void *));
264 int nfs_link __P((void *));
265 int nfs_rename __P((void *));
266 int nfs_mkdir __P((void *));
267 int nfs_rmdir __P((void *));
268 int nfs_symlink __P((void *));
269 int nfs_readdir __P((void *));
270 int nfs_readlink __P((void *));
271 #define nfs_abortop genfs_abortop
272 int nfs_inactive __P((void *));
273 int nfs_reclaim __P((void *));
274 #define nfs_lock genfs_lock
275 int nfs_unlock __P((void *));
276 #define nfs_islocked genfs_islocked
277 int nfs_bmap __P((void *));
278 int nfs_strategy __P((void *));
279 int nfs_print __P((void *));
280 int nfs_pathconf __P((void *));
281 int nfs_advlock __P((void *));
282 int nfs_getpages __P((void *));
283 int nfs_putpages __P((void *));
284 int nfs_gop_write(struct vnode *, struct vm_page **, int, int);
285 int nfs_kqfilter __P((void *));
286
287 extern int (**nfsv2_vnodeop_p) __P((void *));
288
289 #define NFS_INVALIDATE_ATTRCACHE(np) (np)->n_attrstamp = 0
290
291 #endif /* _KERNEL */
292
293 #endif
294