xref: /netbsd-src/sys/nfs/nfsnode.h (revision da5f4674a3fc214be3572d358b66af40ab9401e7)
1 /*	 $NetBSD: nfsnode.h,v 1.42 2003/08/07 16:33:56 agc 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 struct nfsnode {
97 	struct genfs_node	n_gnode;
98 	u_quad_t		n_size;		/* Current size of file */
99 	u_quad_t		n_brev;		/* Modify rev when cached */
100 	u_quad_t		n_lrev;		/* Modify rev for lease */
101 	union {
102 		struct timespec	nf_mtim;
103 		off_t		nd_direof;	/* Dir. EOF offset cache */
104 	} n_un2;
105 	union {
106 		struct timespec	nf_atim;	/* Special file times */
107 		nfsuint64	nd_cookieverf;	/* Cookie verifier (dir only) */
108 	} n_un1;
109 	union {
110 		struct sillyrename *nf_silly;	/* Ptr to silly rename struct */
111 		struct nfsdirhashhead *nd_dircache;
112 	} n_un3;
113 	LIST_ENTRY(nfsnode)	n_hash;		/* Hash chain */
114 	CIRCLEQ_ENTRY(nfsnode)	n_timer;	/* Nqnfs timer chain */
115 	struct nfsdirchainhead	n_dirchain;	/* Chain of dir cookies */
116 	nfsfh_t			*n_fhp;		/* NFS File Handle */
117 	struct vattr		*n_vattr;	/* Vnode attribute cache */
118 	struct vnode		*n_vnode;	/* associated vnode */
119 	struct lockf		*n_lockf;	/* Locking record of file */
120 	unsigned		*n_dirgens;	/* 32<->64bit xlate gen. no. */
121 	time_t			n_attrstamp;	/* Attr. cache timestamp */
122 	time_t			n_mtime;	/* Prev modify time. */
123 	time_t			n_ctime;	/* Prev create time. */
124 	time_t			n_nctime;	/* Last neg cache entry (dir) */
125 	time_t			n_expiry;	/* Lease expiry time */
126 	daddr_t			n_dblkno;	/* To keep faked dir blkno */
127 	unsigned		n_dircachesize;	/* Size of dir cookie cache */
128 	int			n_error;	/* Save write error value */
129 	short			n_fhsize;	/* size in bytes, of fh */
130 	short			n_flag;		/* Flag for locking.. */
131 	nfsfh_t			n_fh;		/* Small File Handle */
132 	time_t			n_accstamp;	/* Access cache timestamp */
133 	uid_t			n_accuid;	/* Last access requester */
134 	int			n_accmode;	/* Mode last requested */
135 	int			n_accerror;	/* Error last returned */
136 	off_t			n_pushedlo;	/* 1st blk in commited range */
137 	off_t			n_pushedhi;	/* Last block in range */
138 	off_t			n_pushlo;	/* 1st block in commit range */
139 	off_t			n_pushhi;	/* Last block in range */
140 	struct lock		n_commitlock;	/* Serialize commits XXX */
141 	int			n_commitflags;
142 	struct ucred		*n_rcred;
143 	struct ucred		*n_wcred;
144 };
145 LIST_HEAD(nfsnodehashhead, nfsnode);
146 
147 /*
148  * Values for n_commitflags
149  */
150 #define NFS_COMMIT_PUSH_VALID	0x0001		/* push range valid */
151 #define NFS_COMMIT_PUSHED_VALID	0x0002		/* pushed range valid */
152 
153 #define n_atim		n_un1.nf_atim
154 #define n_mtim		n_un2.nf_mtim
155 #define n_sillyrename	n_un3.nf_silly
156 #define n_cookieverf	n_un1.nd_cookieverf
157 #define n_direofoffset	n_un2.nd_direof
158 #define n_dircache	n_un3.nd_dircache
159 
160 /*
161  * Flags for n_flag
162  */
163 #define	NFLUSHWANT	0x0001	/* Want wakeup from a flush in prog. */
164 #define	NFLUSHINPROG	0x0002	/* Avoid multiple calls to vinvalbuf() */
165 #define	NMODIFIED	0x0004	/* Might have a modified buffer in bio */
166 #define	NWRITEERR	0x0008	/* Flag write errors so close will know */
167 #define	NQNFSNONCACHE	0x0020	/* Non-cachable lease */
168 #define	NQNFSWRITE	0x0040	/* Write lease */
169 #define	NQNFSEVICTED	0x0080	/* Has been evicted */
170 #define	NACC		0x0100	/* Special file accessed */
171 #define	NUPD		0x0200	/* Special file updated */
172 #define	NCHG		0x0400	/* Special file times changed */
173 #define	NTRUNCDELAYED	0x1000	/* Should be truncated later */
174 #define	NREMOVED	0x2000	/* Has been removed */
175 
176 /*
177  * Convert between nfsnode pointers and vnode pointers
178  */
179 #define VTONFS(vp)	((struct nfsnode *)(vp)->v_data)
180 #define NFSTOV(np)	((np)->n_vnode)
181 
182 /*
183  * Per-nfsiod datas
184  */
185 struct nfs_iod {
186 	struct simplelock nid_slock;
187 	struct proc *nid_proc;
188 	struct proc *nid_want;
189 	struct nfsmount *nid_mount;
190 };
191 extern struct nfs_iod nfs_asyncdaemon[NFS_MAXASYNCDAEMON];
192 
193 #ifdef _KERNEL
194 /*
195  * Prototypes for NFS vnode operations
196  */
197 int	nfs_lookup	__P((void *));
198 int	nfs_create	__P((void *));
199 int	nfs_mknod	__P((void *));
200 int	nfs_open	__P((void *));
201 int	nfs_close	__P((void *));
202 int	nfsspec_close	__P((void *));
203 int	nfsfifo_close	__P((void *));
204 int	nfs_access	__P((void *));
205 int	nfsspec_access	__P((void *));
206 int	nfs_getattr	__P((void *));
207 int	nfs_setattr	__P((void *));
208 int	nfs_read	__P((void *));
209 int	nfs_write	__P((void *));
210 #define	nfs_lease_check	genfs_nullop
211 int	nfsspec_read	__P((void *));
212 int	nfsspec_write	__P((void *));
213 int	nfsfifo_read	__P((void *));
214 int	nfsfifo_write	__P((void *));
215 #define	nfs_ioctl	genfs_enoioctl
216 #define	nfs_poll	genfs_poll
217 #define nfs_revoke	genfs_revoke
218 #define	nfs_mmap	genfs_mmap
219 int	nfs_fsync	__P((void *));
220 #define nfs_seek	genfs_seek
221 int	nfs_remove	__P((void *));
222 int	nfs_link	__P((void *));
223 int	nfs_rename	__P((void *));
224 int	nfs_mkdir	__P((void *));
225 int	nfs_rmdir	__P((void *));
226 int	nfs_symlink	__P((void *));
227 int	nfs_readdir	__P((void *));
228 int	nfs_readlink	__P((void *));
229 #define	nfs_abortop	genfs_abortop
230 int	nfs_inactive	__P((void *));
231 int	nfs_reclaim	__P((void *));
232 #define nfs_lock	genfs_lock
233 int nfs_unlock	__P((void *));
234 #define nfs_islocked	genfs_islocked
235 int	nfs_bmap	__P((void *));
236 int	nfs_strategy	__P((void *));
237 int	nfs_print	__P((void *));
238 int	nfs_pathconf	__P((void *));
239 int	nfs_advlock	__P((void *));
240 #define	nfs_blkatoff	genfs_eopnotsupp
241 int	nfs_bwrite	__P((void *));
242 #define	nfs_valloc	genfs_eopnotsupp
243 #define nfs_reallocblks	genfs_eopnotsupp
244 #define	nfs_vfree	genfs_nullop
245 int	nfs_truncate	__P((void *));
246 int	nfs_update	__P((void *));
247 int	nfs_getpages	__P((void *));
248 int	nfs_putpages	__P((void *));
249 int	nfs_gop_write(struct vnode *, struct vm_page **, int, int);
250 int	nfs_kqfilter	__P((void *));
251 
252 extern int (**nfsv2_vnodeop_p) __P((void *));
253 
254 #endif /* _KERNEL */
255 
256 #endif
257