2 * Copyright (c) 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
6 * Rick Macklem at The University of Guelph.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
32 * @(#)nfsnode.h 8.9 (Berkeley) 5/14/95
36 #ifndef _NFSCLIENT_NFSNODE_H_
37 #define _NFSCLIENT_NFSNODE_H_
39 #if !defined(_NFSCLIENT_NFS_H_) && !defined(_KERNEL)
44 * Silly rename structure that hangs off the nfsnode until the name
45 * can be removed by nfs_inactive()
50 int (*s_removeit)(struct sillyrename *sp);
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.
63 #define NFSNUMCOOKIES 31
66 LIST_ENTRY(nfsdmap) ndm_list;
69 nfsuint64 ndmu3_cookies[NFSNUMCOOKIES];
70 uint64_t ndmu4_cookies[NFSNUMCOOKIES];
74 #define ndm_cookies ndm_un1.ndmu3_cookies
75 #define ndm4_cookies ndm_un1.ndmu4_cookies
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 nfsproto.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.
91 struct mtx n_mtx; /* Protects all of these members */
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 u_int32_t n_mode; /* ACCESS mode cache */
98 uid_t n_modeuid; /* credentials having mode */
99 time_t n_modestamp; /* mode cache timestamp */
100 struct timespec n_mtime; /* Prev modify time. */
101 time_t n_ctime; /* Prev create time. */
102 time_t n_expiry; /* Lease expiry time */
103 nfsfh_t *n_fhp; /* NFS File Handle */
104 struct vnode *n_vnode; /* associated vnode */
105 struct vnode *n_dvp; /* parent vnode */
106 struct lockf *n_lockf; /* Locking record of file */
107 int n_error; /* Save write error value */
109 struct timespec nf_atim; /* Special file times */
110 nfsuint64 nd_cookieverf; /* Cookie verifier (dir only) */
111 u_char nd4_cookieverf[NFSX_V4VERF];
114 struct timespec nf_mtim;
115 off_t nd_direof; /* Dir. EOF offset cache */
118 struct sillyrename *nf_silly; /* Ptr to silly rename struct */
119 LIST_HEAD(, nfsdmap) nd_cook; /* cookies */
121 short n_fhsize; /* size in bytes, of fh */
122 short n_flag; /* Flag for locking.. */
123 nfsfh_t n_fh; /* Small File Handle */
124 struct nfs4_fctx n_rfc;
125 struct nfs4_fctx n_wfc;
126 u_char *n_name; /* leaf name, for v4 OPEN op */
128 int n_directio_opens;
129 int n_directio_asyncwr;
132 #define n_atim n_un1.nf_atim
133 #define n_mtim n_un2.nf_mtim
134 #define n_sillyrename n_un3.nf_silly
135 #define n_cookieverf n_un1.nd_cookieverf
136 #define n4_cookieverf n_un1.nd4_cookieverf
137 #define n_direofoffset n_un2.nd_direof
138 #define n_cookies n_un3.nd_cook
143 #define NFSYNCWAIT 0x0002 /* fsync waiting for all directio async writes
145 #define NMODIFIED 0x0004 /* Might have a modified buffer in bio */
146 #define NWRITEERR 0x0008 /* Flag write errors so close will know */
147 /* 0x20, 0x40, 0x80 free */
148 #define NACC 0x0100 /* Special file accessed */
149 #define NUPD 0x0200 /* Special file updated */
150 #define NCHG 0x0400 /* Special file times changed */
151 #define NCREATED 0x0800 /* Opened by nfs_create() */
152 #define NTRUNCATE 0x1000 /* Opened by nfs_setattr() */
153 #define NSIZECHANGED 0x2000 /* File size has changed: need cache inval */
154 #define NNONCACHE 0x4000 /* Node marked as noncacheable */
155 #define NDIRCOOKIELK 0x8000 /* Lock to serialize access to directory cookies */
158 * Convert between nfsnode pointers and vnode pointers
160 #define VTONFS(vp) ((struct nfsnode *)(vp)->v_data)
161 #define NFSTOV(np) ((struct vnode *)(np)->n_vnode)
163 #define NFS_TIMESPEC_COMPARE(T1, T2) (((T1)->tv_sec != (T2)->tv_sec) || ((T1)->tv_nsec != (T2)->tv_nsec))
166 * Queue head for nfsiod's
168 extern TAILQ_HEAD(nfs_bufq, buf) nfs_bufq;
169 extern struct proc *nfs_iodwant[NFS_MAXASYNCDAEMON];
170 extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON];
174 extern struct vop_vector nfs_fifoops;
175 extern struct vop_vector nfs_vnodeops;
176 extern struct vop_vector nfs4_vnodeops;
177 extern struct buf_ops buf_ops_nfs;
178 extern struct buf_ops buf_ops_nfs4;
181 * Prototypes for NFS vnode operations
183 int nfs_getpages(struct vop_getpages_args *);
184 int nfs_putpages(struct vop_putpages_args *);
185 int nfs_write(struct vop_write_args *);
186 int nfs_inactive(struct vop_inactive_args *);
187 int nfs_reclaim(struct vop_reclaim_args *);
190 int nfs_removeit(struct sillyrename *);
191 int nfs4_removeit(struct sillyrename *);
192 int nfs_nget(struct mount *, nfsfh_t *, int, struct nfsnode **, int flags);
193 nfsuint64 *nfs_getcookie(struct nfsnode *, off_t, int);
194 uint64_t *nfs4_getcookie(struct nfsnode *, off_t, int);
195 void nfs_invaldir(struct vnode *);
196 void nfs4_invaldir(struct vnode *);
197 int nfs_upgrade_vnlock(struct vnode *vp, struct thread *td);
198 void nfs_downgrade_vnlock(struct vnode *vp, struct thread *td, int old_lock);
199 void nfs_printf(const char *fmt, ...);
201 void nfs_dircookie_lock(struct nfsnode *np);
202 void nfs_dircookie_unlock(struct nfsnode *np);