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
35 #ifndef _NFSCLIENT_NFSNODE_H_
36 #define _NFSCLIENT_NFSNODE_H_
39 * Silly rename structure that hangs off the nfsnode until the name
40 * can be removed by nfs_inactive()
50 * This structure is used to save the logical directory offset to
51 * NFS cookie mappings.
52 * The mappings are stored in a list headed
53 * by n_cookies, as required.
54 * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
55 * stored in increasing logical offset byte order.
57 #define NFSNUMCOOKIES 31
60 LIST_ENTRY(nfsdmap) ndm_list;
63 nfsuint64 ndmu3_cookies[NFSNUMCOOKIES];
64 uint64_t ndmu4_cookies[NFSNUMCOOKIES];
68 #define ndm_cookies ndm_un1.ndmu3_cookies
69 #define ndm4_cookies ndm_un1.ndmu4_cookies
71 #define n_ac_ts_tid n_ac_ts.nfs_ac_ts_tid
72 #define n_ac_ts_pid n_ac_ts.nfs_ac_ts_pid
73 #define n_ac_ts_syscalls n_ac_ts.nfs_ac_ts_syscalls
75 struct nfs_attrcache_timestamp {
76 lwpid_t nfs_ac_ts_tid;
78 unsigned long nfs_ac_ts_syscalls;
81 struct nfs_accesscache {
82 u_int32_t mode; /* ACCESS mode cache */
83 uid_t uid; /* credentials having mode */
84 time_t stamp; /* mode cache timestamp */
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.
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 nfsvattr n_vattr; /* Vnode attribute cache */
106 time_t n_attrstamp; /* Attr. cache timestamp */
107 struct nfs_accesscache n_accesscache[NFS_ACCESSCACHESIZE];
108 struct timespec n_mtime; /* Prev modify time. */
109 time_t n_ctime; /* Prev create time. */
110 time_t n_dmtime; /* Prev dir modify time. */
111 int n_dmtime_ticks; /* Tick of -ve cache entry */
112 time_t n_expiry; /* Lease expiry time */
113 struct nfsfh *n_fhp; /* NFS File Handle */
114 struct vnode *n_vnode; /* associated vnode */
115 struct vnode *n_dvp; /* parent vnode */
116 struct lockf *n_lockf; /* Locking record of file */
117 int n_error; /* Save write error value */
119 struct timespec nf_atim; /* Special file times */
120 nfsuint64 nd_cookieverf; /* Cookie verifier (dir only) */
121 u_char nd4_cookieverf[NFSX_VERF];
124 struct timespec nf_mtim;
125 off_t nd_direof; /* Dir. EOF offset cache */
128 struct sillyrename *nf_silly; /* Ptr to silly rename struct */
129 LIST_HEAD(, nfsdmap) nd_cook; /* cookies */
131 short n_fhsize; /* size in bytes, of fh */
132 u_int32_t n_flag; /* Flag for locking.. */
133 int n_directio_opens;
134 int n_directio_asyncwr;
135 struct nfs_attrcache_timestamp n_ac_ts;
136 u_int64_t n_change; /* old Change attribute */
137 struct nfsv4node *n_v4; /* extra V4 stuff */
140 #define n_atim n_un1.nf_atim
141 #define n_mtim n_un2.nf_mtim
142 #define n_sillyrename n_un3.nf_silly
143 #define n_cookieverf n_un1.nd_cookieverf
144 #define n4_cookieverf n_un1.nd4_cookieverf
145 #define n_direofoffset n_un2.nd_direof
146 #define n_cookies n_un3.nd_cook
151 #define NDIRCOOKIELK 0x00000001 /* Lock to serialize access to directory cookies */
152 #define NFSYNCWAIT 0x00000002 /* fsync waiting for all directio async
154 #define NMODIFIED 0x00000004 /* Might have a modified buffer in bio */
155 #define NWRITEERR 0x00000008 /* Flag write errors so close will know */
156 #define NCREATED 0x00000010 /* Opened by nfs_create() */
157 #define NTRUNCATE 0x00000020 /* Opened by nfs_setattr() */
158 #define NSIZECHANGED 0x00000040 /* File size has changed: need cache inval */
159 #define NNONCACHE 0x00000080 /* Node marked as noncacheable */
160 #define NACC 0x00000100 /* Special file accessed */
161 #define NUPD 0x00000200 /* Special file updated */
162 #define NCHG 0x00000400 /* Special file times changed */
163 #define NDELEGMOD 0x00000800 /* Modified delegation */
164 #define NDELEGRECALL 0x00001000 /* Recall in progress */
165 #define NREMOVEINPROG 0x00002000 /* Remove in progress */
166 #define NREMOVEWANT 0x00004000 /* Want notification that remove is done */
167 #define NLOCK 0x00008000 /* Sleep lock the node */
168 #define NLOCKWANT 0x00010000 /* Want the sleep lock */
171 * Convert between nfsnode pointers and vnode pointers
173 #define VTONFS(vp) ((struct nfsnode *)(vp)->v_data)
174 #define NFSTOV(np) ((struct vnode *)(np)->n_vnode)
176 #define NFS_TIMESPEC_COMPARE(T1, T2) (((T1)->tv_sec != (T2)->tv_sec) || ((T1)->tv_nsec != (T2)->tv_nsec))
181 * Prototypes for NFS vnode operations
183 int ncl_getpages(struct vop_getpages_args *);
184 int ncl_putpages(struct vop_putpages_args *);
185 int ncl_write(struct vop_write_args *);
186 int ncl_inactive(struct vop_inactive_args *);
187 int ncl_reclaim(struct vop_reclaim_args *);
190 int ncl_removeit(struct sillyrename *, struct vnode *);
191 int ncl_nget(struct mount *, u_int8_t *, int, struct nfsnode **);
192 nfsuint64 *ncl_getcookie(struct nfsnode *, off_t, int);
193 void ncl_invaldir(struct vnode *);
194 int ncl_upgrade_vnlock(struct vnode *);
195 void ncl_downgrade_vnlock(struct vnode *, int);
196 void ncl_printf(const char *, ...);
197 void ncl_dircookie_lock(struct nfsnode *);
198 void ncl_dircookie_unlock(struct nfsnode *);
202 #endif /* _NFSCLIENT_NFSNODE_H_ */