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 * 4. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 * @(#)nfsnode.h 8.9 (Berkeley) 5/14/95
33 * $FreeBSD: src/sys/nfsclient/nfsnode.h,v 1.63 2008/06/26 10:21:54 dfr Exp $
34 */
35
36 #ifndef _NFSCLIENT_NFSNODE_H_
37 #define _NFSCLIENT_NFSNODE_H_
38
39 #if !defined(_NFSCLIENT_NFS_H_) && !defined(_KERNEL)
40 #include <nfs/nfs.h>
41 #endif
42
43 /*
44 * Silly rename structure that hangs off the nfsnode until the name
45 * can be removed by nfs_inactive()
46 */
47 struct sillyrename {
48 struct ucred *s_cred;
49 struct vnode *s_dvp;
50 int (*s_removeit)(struct sillyrename *sp);
51 long s_namlen;
52 char s_name[32];
53 };
54
55 /*
56 * This structure is used to save the logical directory offset to
57 * NFS cookie mappings.
58 * The mappings are stored in a list headed
59 * by n_cookies, as required.
60 * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
61 * stored in increasing logical offset byte order.
62 */
63 #define NFSNUMCOOKIES 31
64
65 struct nfsdmap {
66 LIST_ENTRY(nfsdmap) ndm_list;
67 int ndm_eocookie;
68 union {
69 nfsuint64 ndmu3_cookies[NFSNUMCOOKIES];
70 uint64_t ndmu4_cookies[NFSNUMCOOKIES];
71 } ndm_un1;
72 };
73
74 #define ndm_cookies ndm_un1.ndmu3_cookies
75 #define ndm4_cookies ndm_un1.ndmu4_cookies
76
77 #define n_ac_ts_tid n_ac_ts.nfs_ac_ts_tid
78 #define n_ac_ts_pid n_ac_ts.nfs_ac_ts_pid
79 #define n_ac_ts_syscalls n_ac_ts.nfs_ac_ts_syscalls
80
81 struct nfs_attrcache_timestamp {
82 lwpid_t nfs_ac_ts_tid;
83 pid_t nfs_ac_ts_pid;
84 unsigned long nfs_ac_ts_syscalls;
85 };
86
87 /*
88 * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
89 * is purely coincidental.
90 * There is a unique nfsnode allocated for each active file,
91 * each current directory, each mounted-on file, text file, and the root.
92 * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
93 * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
94 * type definitions), file handles of > 32 bytes should probably be split out
95 * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by
96 * changing the definition in nfsproto.h of NFS_SMALLFH.)
97 * NB: Hopefully the current order of the fields is such that everything will
98 * be well aligned and, therefore, tightly packed.
99 */
100 struct nfsnode {
101 struct mtx n_mtx; /* Protects all of these members */
102 u_quad_t n_size; /* Current size of file */
103 u_quad_t n_brev; /* Modify rev when cached */
104 u_quad_t n_lrev; /* Modify rev for lease */
105 struct vattr n_vattr; /* Vnode attribute cache */
106 time_t n_attrstamp; /* Attr. cache timestamp */
107 u_int32_t n_mode; /* ACCESS mode cache */
108 uid_t n_modeuid; /* credentials having mode */
109 time_t n_modestamp; /* mode cache timestamp */
110 struct timespec n_mtime; /* Prev modify time. */
111 time_t n_ctime; /* Prev create time. */
112 time_t n_expiry; /* Lease expiry time */
113 nfsfh_t *n_fhp; /* NFS File Handle */
114 struct vnode *n_vnode; /* associated vnode */
115 struct vnode *n_dvp; /* parent vnode */
116 int n_error; /* Save write error value */
117 union {
118 struct timespec nf_atim; /* Special file times */
119 nfsuint64 nd_cookieverf; /* Cookie verifier (dir only) */
120 u_char nd4_cookieverf[NFSX_V4VERF];
121 } n_un1;
122 union {
123 struct timespec nf_mtim;
124 off_t nd_direof; /* Dir. EOF offset cache */
125 } n_un2;
126 union {
127 struct sillyrename *nf_silly; /* Ptr to silly rename struct */
128 LIST_HEAD(, nfsdmap) nd_cook; /* cookies */
129 } n_un3;
130 short n_fhsize; /* size in bytes, of fh */
131 short n_flag; /* Flag for locking.. */
132 nfsfh_t n_fh; /* Small File Handle */
133 struct nfs4_fctx n_rfc;
134 struct nfs4_fctx n_wfc;
135 u_char *n_name; /* leaf name, for v4 OPEN op */
136 uint32_t n_namelen;
137 int n_directio_opens;
138 int n_directio_asyncwr;
139 struct nfs_attrcache_timestamp n_ac_ts;
140 };
141
142 #define n_atim n_un1.nf_atim
143 #define n_mtim n_un2.nf_mtim
144 #define n_sillyrename n_un3.nf_silly
145 #define n_cookieverf n_un1.nd_cookieverf
146 #define n4_cookieverf n_un1.nd4_cookieverf
147 #define n_direofoffset n_un2.nd_direof
148 #define n_cookies n_un3.nd_cook
149
150 /*
151 * Flags for n_flag
152 */
153 #define NFSYNCWAIT 0x0002 /* fsync waiting for all directio async writes
154 to drain */
155 #define NMODIFIED 0x0004 /* Might have a modified buffer in bio */
156 #define NWRITEERR 0x0008 /* Flag write errors so close will know */
157 /* 0x20, 0x40, 0x80 free */
158 #define NACC 0x0100 /* Special file accessed */
159 #define NUPD 0x0200 /* Special file updated */
160 #define NCHG 0x0400 /* Special file times changed */
161 #define NCREATED 0x0800 /* Opened by nfs_create() */
162 #define NTRUNCATE 0x1000 /* Opened by nfs_setattr() */
163 #define NSIZECHANGED 0x2000 /* File size has changed: need cache inval */
164 #define NNONCACHE 0x4000 /* Node marked as noncacheable */
165 #define NDIRCOOKIELK 0x8000 /* Lock to serialize access to directory cookies */
166
167 /*
168 * Convert between nfsnode pointers and vnode pointers
169 */
170 #define VTONFS(vp) ((struct nfsnode *)(vp)->v_data)
171 #define NFSTOV(np) ((struct vnode *)(np)->n_vnode)
172
173 #define NFS_TIMESPEC_COMPARE(T1, T2) (((T1)->tv_sec != (T2)->tv_sec) || ((T1)->tv_nsec != (T2)->tv_nsec))
174
175 /*
176 * Queue head for nfsiod's
177 */
178 extern TAILQ_HEAD(nfs_bufq, buf) nfs_bufq;
179 extern struct proc *nfs_iodwant[NFS_MAXASYNCDAEMON];
180 extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON];
181
182 #if defined(_KERNEL)
183
184 extern struct vop_vector nfs_fifoops;
185 extern struct vop_vector nfs_vnodeops;
186 extern struct vop_vector nfs4_vnodeops;
187 extern struct buf_ops buf_ops_nfs;
188 extern struct buf_ops buf_ops_nfs4;
189
190 extern vop_advlock_t *nfs_advlock_p;
191 extern vop_reclaim_t *nfs_reclaim_p;
192
193 /*
194 * Prototypes for NFS vnode operations
195 */
196 int nfs_getpages(struct vop_getpages_args *);
197 int nfs_putpages(struct vop_putpages_args *);
198 int nfs_write(struct vop_write_args *);
199 int nfs_inactive(struct vop_inactive_args *);
200 int nfs_reclaim(struct vop_reclaim_args *);
201
202 /* other stuff */
203 int nfs_removeit(struct sillyrename *);
204 int nfs4_removeit(struct sillyrename *);
205 int nfs_nget(struct mount *, nfsfh_t *, int, struct nfsnode **, int flags);
206 nfsuint64 *nfs_getcookie(struct nfsnode *, off_t, int);
207 uint64_t *nfs4_getcookie(struct nfsnode *, off_t, int);
208 void nfs_invaldir(struct vnode *);
209 void nfs4_invaldir(struct vnode *);
210 int nfs_upgrade_vnlock(struct vnode *vp);
211 void nfs_downgrade_vnlock(struct vnode *vp, int old_lock);
212 void nfs_printf(const char *fmt, ...);
213
214 void nfs_dircookie_lock(struct nfsnode *np);
215 void nfs_dircookie_unlock(struct nfsnode *np);
216
217 #endif /* _KERNEL */
218
219 #endif
220
|