xref: /openbsd/sys/nfs/nfsnode.h (revision 78b63d65)
1 /*	$OpenBSD: nfsnode.h,v 1.12 2001/11/27 05:27:12 art Exp $	*/
2 /*	$NetBSD: nfsnode.h,v 1.16 1996/02/18 11:54:04 fvdl Exp $	*/
3 
4 /*
5  * Copyright (c) 1989, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * This code is derived from software contributed to Berkeley by
9  * Rick Macklem at The University of Guelph.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by the University of
22  *	California, Berkeley and its contributors.
23  * 4. Neither the name of the University nor the names of its contributors
24  *    may be used to endorse or promote products derived from this software
25  *    without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37  * SUCH DAMAGE.
38  *
39  *	@(#)nfsnode.h	8.9 (Berkeley) 5/14/95
40  */
41 
42 
43 #ifndef _NFS_NFSNODE_H_
44 #define _NFS_NFSNODE_H_
45 
46 #ifndef _NFS_NFS_H_
47 #include <nfs/nfs.h>
48 #endif
49 
50 /*
51  * Silly rename structure that hangs off the nfsnode until the name
52  * can be removed by nfs_inactive()
53  */
54 struct sillyrename {
55 	struct	ucred *s_cred;
56 	struct	vnode *s_dvp;
57 	long	s_namlen;
58 	char	s_name[20];
59 };
60 
61 /*
62  * This structure is used to save the logical directory offset to
63  * NFS cookie mappings.
64  * The mappings are stored in a list headed
65  * by n_cookies, as required.
66  * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
67  * stored in increasing logical offset byte order.
68  */
69 #define NFSNUMCOOKIES		31
70 
71 struct nfsdmap {
72 	LIST_ENTRY(nfsdmap)	ndm_list;
73 	int			ndm_eocookie;
74 	nfsuint64		ndm_cookies[NFSNUMCOOKIES];
75 };
76 
77 /*
78  * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
79  * is purely coincidental.
80  * There is a unique nfsnode allocated for each active file,
81  * each current directory, each mounted-on file, text file, and the root.
82  * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
83  * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
84  * type definitions), file handles of > 32 bytes should probably be split out
85  * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by
86  * changing the definition in sys/mount.h of NFS_SMALLFH.)
87  * NB: Hopefully the current order of the fields is such that everything will
88  *     be well aligned and, therefore, tightly packed.
89  */
90 struct nfsnode {
91 	LIST_ENTRY(nfsnode)	n_hash;		/* Hash chain */
92 	CIRCLEQ_ENTRY(nfsnode)	n_timer;	/* Nqnfs timer chain */
93 	u_quad_t		n_size;		/* Current size of file */
94 	u_quad_t		n_brev;		/* Modify rev when cached */
95 	u_quad_t		n_lrev;		/* Modify rev for lease */
96 	struct vattr		n_vattr;	/* Vnode attribute cache */
97 	time_t			n_attrstamp;	/* Attr. cache timestamp */
98 	time_t			n_mtime;	/* Prev modify time. */
99 	time_t			n_ctime;	/* Prev create time. */
100 	time_t			n_expiry;	/* Lease expiry time */
101 	nfsfh_t			*n_fhp;		/* NFS File Handle */
102 	struct vnode		*n_vnode;	/* associated vnode */
103 	struct lockf		*n_lockf;	/* Locking record of file */
104 	int			n_error;	/* Save write error value */
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 timespec	nf_mtim;
111 		off_t		nd_direof;	/* Dir. EOF offset cache */
112 	} n_un2;
113 	union {
114 		struct sillyrename *nf_silly;	/* Ptr to silly rename struct */
115 		LIST_HEAD(, nfsdmap) nd_cook;	/* cookies */
116 	} n_un3;
117 	short			n_fhsize;	/* size in bytes, of fh */
118 	short			n_flag;		/* Flag for locking.. */
119 	nfsfh_t			n_fh;		/* Small File Handle */
120 	struct ucred		*n_rcred;
121 	struct ucred		*n_wcred;
122 	off_t			n_pushedlo;     /* 1st blk in commited range */
123 	off_t			n_pushedhi;     /* Last block in range */
124 	off_t			n_pushlo;       /* 1st block in commit range */
125 	off_t			n_pushhi;       /* Last block in range */
126 	struct lock		n_commitlock;   /* Serialize commits XXX */
127 	int			n_commitflags;
128 };
129 
130 /*
131  * Values for n_commitflags
132  */
133 #define NFS_COMMIT_PUSH_VALID		0x0001	/* push range valid */
134 #define NFS_COMMIT_PUSHED_VALID		0x0002	/* pushed range valid */
135 
136 #define n_atim		n_un1.nf_atim
137 #define n_mtim		n_un2.nf_mtim
138 #define n_sillyrename	n_un3.nf_silly
139 #define n_cookieverf	n_un1.nd_cookieverf
140 #define n_direofoffset	n_un2.nd_direof
141 #define n_cookies	n_un3.nd_cook
142 
143 /*
144  * Flags for n_flag
145  */
146 #define	NFLUSHWANT	0x0001	/* Want wakeup from a flush in prog. */
147 #define	NFLUSHINPROG	0x0002	/* Avoid multiple calls to vinvalbuf() */
148 #define	NMODIFIED	0x0004	/* Might have a modified buffer in bio */
149 #define	NWRITEERR	0x0008	/* Flag write errors so close will know */
150 #define	NACC		0x0100	/* Special file accessed */
151 #define	NUPD		0x0200	/* Special file updated */
152 #define	NCHG		0x0400	/* Special file times changed */
153 
154 /*
155  * Convert between nfsnode pointers and vnode pointers
156  */
157 #define VTONFS(vp)	((struct nfsnode *)(vp)->v_data)
158 #define NFSTOV(np)	((np)->n_vnode)
159 
160 /*
161  * Queue head for nfsiod's
162  */
163 TAILQ_HEAD(, buf) nfs_bufq;
164 
165 #ifdef _KERNEL
166 /*
167  * Prototypes for NFS vnode operations
168  */
169 int	nfs_lookup __P((void *));
170 int	nfs_create __P((void *));
171 int	nfs_mknod __P((void *));
172 int	nfs_open __P((void *));
173 int	nfs_close __P((void *));
174 int	nfsspec_close __P((void *));
175 int	nfsfifo_close __P((void *));
176 int	nfs_access __P((void *));
177 int	nfsspec_access __P((void *));
178 int	nfs_getattr __P((void *));
179 int	nfs_setattr __P((void *));
180 int	nfs_read __P((void *));
181 int	nfs_write __P((void *));
182 #define	nfs_lease_check ((int (*) __P((void *)))nullop)
183 #define nqnfs_vop_lease_check	lease_check
184 int	nfsspec_read __P((void *));
185 int	nfsspec_write __P((void *));
186 int	nfsfifo_read __P((void *));
187 int	nfsfifo_write __P((void *));
188 #define nfs_ioctl ((int (*) __P((void *)))enoioctl)
189 #define nfs_select ((int (*) __P((void *)))seltrue)
190 #define nfs_revoke vop_generic_revoke
191 int	nfs_fsync __P((void *));
192 int	nfs_remove __P((void *));
193 int	nfs_link __P((void *));
194 int	nfs_rename __P((void *));
195 int	nfs_mkdir __P((void *));
196 int	nfs_rmdir __P((void *));
197 int	nfs_symlink __P((void *));
198 int	nfs_readdir __P((void *));
199 int	nfs_readlink __P((void *));
200 int	nfs_inactive __P((void *));
201 int	nfs_reclaim __P((void *));
202 #define nfs_lock ((int (*) __P((void *)))vop_generic_lock)
203 #define nfs_unlock ((int (*) __P((void *)))vop_generic_unlock)
204 #define nfs_islocked ((int (*) __P((void *)))vop_generic_islocked)
205 int	nfs_bmap __P((void *));
206 int	nfs_strategy __P((void *));
207 int	nfs_print __P((void *));
208 int	nfs_pathconf __P((void *));
209 int	nfs_advlock __P((void *));
210 int	nfs_bwrite __P((void *));
211 int	nfs_vget __P((struct mount *, ino_t, struct vnode **));
212 #define nfs_reallocblks \
213 	((int (*) __P((void *)))eopnotsupp)
214 int	nfs_getpages __P((void *));
215 int	nfs_putpages __P((void *));
216 
217 /* other stuff */
218 int	nfs_removeit __P((struct sillyrename *));
219 int	nfs_nget __P((struct mount *,nfsfh_t *,int,struct nfsnode **));
220 int	nfs_lookitup __P((struct vnode *,char *,int,struct ucred *,struct proc *,struct nfsnode **));
221 int	nfs_sillyrename __P((struct vnode *,struct vnode *,struct componentname *));
222 
223 extern int (**nfsv2_vnodeop_p) __P((void *));
224 
225 #endif /* _KERNEL */
226 
227 #endif
228