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