nfsnode.h revision 1.20 1 /* $NetBSD: nfsnode.h,v 1.20 1997/04/11 21:52:07 kleink 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. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the University of
21 * California, Berkeley and its contributors.
22 * 4. Neither the name of the University nor the names of its contributors
23 * may be used to endorse or promote products derived from this software
24 * without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * SUCH DAMAGE.
37 *
38 * @(#)nfsnode.h 8.9 (Berkeley) 5/14/95
39 */
40
41
42 #ifndef _NFS_NFSNODE_H_
43 #define _NFS_NFSNODE_H_
44
45 #ifndef _NFS_NFS_H_
46 #include <nfs/nfs.h>
47 #endif
48
49 /*
50 * Silly rename structure that hangs off the nfsnode until the name
51 * can be removed by nfs_inactive()
52 */
53 struct sillyrename {
54 struct ucred *s_cred;
55 struct vnode *s_dvp;
56 long s_namlen;
57 char s_name[20];
58 };
59
60 /*
61 * This structure is used to save the logical directory offset to
62 * NFS cookie mappings.
63 * The mappings are stored in a list headed
64 * by n_cookies, as required.
65 * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
66 * stored in increasing logical offset byte order.
67 */
68 #define NFSNUMCOOKIES 31
69
70 struct nfsdmap {
71 LIST_ENTRY(nfsdmap) ndm_list;
72 int ndm_eocookie;
73 nfsuint64 ndm_cookies[NFSNUMCOOKIES];
74 };
75
76 /*
77 * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
78 * is purely coincidental.
79 * There is a unique nfsnode allocated for each active file,
80 * each current directory, each mounted-on file, text file, and the root.
81 * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
82 * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
83 * type definitions), file handles of > 32 bytes should probably be split out
84 * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by
85 * changing the definition in sys/mount.h of NFS_SMALLFH.)
86 * NB: Hopefully the current order of the fields is such that everything will
87 * be well aligned and, therefore, tightly packed.
88 */
89 struct nfsnode {
90 LIST_ENTRY(nfsnode) n_hash; /* Hash chain */
91 CIRCLEQ_ENTRY(nfsnode) n_timer; /* Nqnfs timer chain */
92 u_quad_t n_size; /* Current size of file */
93 u_quad_t n_brev; /* Modify rev when cached */
94 u_quad_t n_lrev; /* Modify rev for lease */
95 struct vattr n_vattr; /* Vnode attribute cache */
96 time_t n_attrstamp; /* Attr. cache timestamp */
97 time_t n_mtime; /* Prev modify time. */
98 time_t n_ctime; /* Prev create time. */
99 time_t n_expiry; /* Lease expiry time */
100 nfsfh_t *n_fhp; /* NFS File Handle */
101 struct vnode *n_vnode; /* associated vnode */
102 struct lockf *n_lockf; /* Locking record of file */
103 int n_error; /* Save write error value */
104 union {
105 struct timespec nf_atim; /* Special file times */
106 nfsuint64 nd_cookieverf; /* Cookie verifier (dir only) */
107 } n_un1;
108 union {
109 struct timespec nf_mtim;
110 off_t nd_direof; /* Dir. EOF offset cache */
111 } n_un2;
112 union {
113 struct sillyrename *nf_silly; /* Ptr to silly rename struct */
114 LIST_HEAD(, nfsdmap) nd_cook; /* cookies */
115 } n_un3;
116 short n_fhsize; /* size in bytes, of fh */
117 short n_flag; /* Flag for locking.. */
118 nfsfh_t n_fh; /* Small File Handle */
119 };
120
121 #define n_atim n_un1.nf_atim
122 #define n_mtim n_un2.nf_mtim
123 #define n_sillyrename n_un3.nf_silly
124 #define n_cookieverf n_un1.nd_cookieverf
125 #define n_direofoffset n_un2.nd_direof
126 #define n_cookies n_un3.nd_cook
127
128 /*
129 * Flags for n_flag
130 */
131 #define NFLUSHWANT 0x0001 /* Want wakeup from a flush in prog. */
132 #define NFLUSHINPROG 0x0002 /* Avoid multiple calls to vinvalbuf() */
133 #define NMODIFIED 0x0004 /* Might have a modified buffer in bio */
134 #define NWRITEERR 0x0008 /* Flag write errors so close will know */
135 #define NQNFSNONCACHE 0x0020 /* Non-cachable lease */
136 #define NQNFSWRITE 0x0040 /* Write lease */
137 #define NQNFSEVICTED 0x0080 /* Has been evicted */
138 #define NACC 0x0100 /* Special file accessed */
139 #define NUPD 0x0200 /* Special file updated */
140 #define NCHG 0x0400 /* Special file times changed */
141
142 /*
143 * Convert between nfsnode pointers and vnode pointers
144 */
145 #define VTONFS(vp) ((struct nfsnode *)(vp)->v_data)
146 #define NFSTOV(np) ((struct vnode *)(np)->n_vnode)
147
148 /*
149 * Queue head for nfsiod's
150 */
151 extern struct proc *nfs_iodwant[NFS_MAXASYNCDAEMON];
152 extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON];
153
154 #ifdef _KERNEL
155 /*
156 * Prototypes for NFS vnode operations
157 */
158 int nfs_lookup __P((void *));
159 int nfs_create __P((void *));
160 int nfs_mknod __P((void *));
161 int nfs_open __P((void *));
162 int nfs_close __P((void *));
163 int nfsspec_close __P((void *));
164 int nfsfifo_close __P((void *));
165 int nfs_access __P((void *));
166 int nfsspec_access __P((void *));
167 int nfs_getattr __P((void *));
168 int nfs_setattr __P((void *));
169 int nfs_read __P((void *));
170 int nfs_write __P((void *));
171 #define nfs_lease_check genfs_nullop
172 #define nqnfs_vop_lease_check lease_check
173 int nfsspec_read __P((void *));
174 int nfsspec_write __P((void *));
175 int nfsfifo_read __P((void *));
176 int nfsfifo_write __P((void *));
177 #define nfs_ioctl ((int (*) __P((void *)))enoioctl)
178 #define nfs_poll genfs_poll
179 #ifdef Lite2_integrated
180 #define nfs_revoke vop_revoke
181 #endif
182 int nfs_mmap __P((void *));
183 int nfs_fsync __P((void *));
184 #define nfs_seek genfs_seek
185 int nfs_remove __P((void *));
186 int nfs_link __P((void *));
187 int nfs_rename __P((void *));
188 int nfs_mkdir __P((void *));
189 int nfs_rmdir __P((void *));
190 int nfs_symlink __P((void *));
191 int nfs_readdir __P((void *));
192 int nfs_readlink __P((void *));
193 #define nfs_abortop genfs_abortop
194 int nfs_inactive __P((void *));
195 int nfs_reclaim __P((void *));
196 #ifdef Lite2_integrated
197 #define nfs_lock ((int (*) __P((void *)))vop_nolock)
198 #define nfs_unlock ((int (*) __P((void *)))vop_nounlock)
199 #define nfs_islocked ((int (*) __P((void *)))vop_noislocked)
200 #else
201 int nfs_lock __P((void *));
202 int nfs_unlock __P((void *));
203 int nfs_islocked __P((void *));
204 #endif /* Lite2_integrated */
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 #define nfs_blkatoff genfs_eopnotsupp
211 int nfs_bwrite __P((void *));
212 int nfs_vget __P((struct mount *, ino_t, struct vnode **));
213 #define nfs_valloc genfs_eopnotsupp
214 #define nfs_reallocblks genfs_eopnotsupp
215 #define nfs_vfree genfs_nullop
216 int nfs_truncate __P((void *));
217 int nfs_update __P((void *));
218
219 extern int (**nfsv2_vnodeop_p) __P((void *));
220
221 #endif /* _KERNEL */
222
223 #endif
224