2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1989, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Rick Macklem at The University of Guelph.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 #ifndef _NFSCLIENT_NFSNODE_H_
36 #define _NFSCLIENT_NFSNODE_H_
38 #include <sys/_task.h>
41 * Silly rename structure that hangs off the nfsnode until the name
42 * can be removed by nfs_inactive()
53 * This structure is used to save the logical directory offset to
54 * NFS cookie mappings.
55 * The mappings are stored in a list headed
56 * by n_cookies, as required.
57 * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
58 * stored in increasing logical offset byte order.
60 #define NFSNUMCOOKIES 31
63 LIST_ENTRY(nfsdmap) ndm_list;
66 nfsuint64 ndmu3_cookies[NFSNUMCOOKIES];
67 uint64_t ndmu4_cookies[NFSNUMCOOKIES];
71 #define ndm_cookies ndm_un1.ndmu3_cookies
72 #define ndm4_cookies ndm_un1.ndmu4_cookies
74 struct nfs_accesscache {
75 u_int32_t mode; /* ACCESS mode cache */
76 uid_t uid; /* credentials having mode */
77 time_t stamp; /* mode cache timestamp */
81 * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
82 * is purely coincidental.
83 * There is a unique nfsnode allocated for each active file,
84 * each current directory, each mounted-on file, text file, and the root.
85 * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
86 * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
87 * type definitions), file handles of > 32 bytes should probably be split out
88 * into a separate malloc()'d data structure. (Reduce the size of nfsfh_t by
89 * changing the definition in nfsproto.h of NFS_SMALLFH.)
90 * NB: Hopefully the current order of the fields is such that everything will
91 * be well aligned and, therefore, tightly packed.
94 struct mtx n_mtx; /* Protects all of these members */
95 struct lock n_excl; /* Exclusive helper for shared
97 u_quad_t n_size; /* Current size of file */
98 u_quad_t n_brev; /* Modify rev when cached */
99 u_quad_t n_lrev; /* Modify rev for lease */
100 struct nfsvattr n_vattr; /* Vnode attribute cache */
101 time_t n_attrstamp; /* Attr. cache timestamp */
102 struct nfs_accesscache n_accesscache[NFS_ACCESSCACHESIZE];
103 struct timespec n_mtime; /* Prev modify time. */
104 struct nfsfh *n_fhp; /* NFS File Handle */
105 struct vnode *n_vnode; /* associated vnode */
106 struct vnode *n_dvp; /* parent vnode */
107 struct lockf *n_lockf; /* Locking record of file */
108 int n_error; /* Save write error value */
110 struct timespec nf_atim; /* Special file times */
111 nfsuint64 nd_cookieverf; /* Cookie verifier (dir only) */
112 u_char nd4_cookieverf[NFSX_VERF];
115 struct timespec nf_mtim;
116 off_t nd_direof; /* Dir. EOF offset cache */
119 struct sillyrename *nf_silly; /* Ptr to silly rename struct */
120 LIST_HEAD(, nfsdmap) nd_cook; /* cookies */
122 short n_fhsize; /* size in bytes, of fh */
123 u_int32_t n_flag; /* Flag for locking.. */
124 int n_directio_opens;
125 int n_directio_asyncwr;
126 u_int64_t n_change; /* old Change attribute */
127 struct nfsv4node *n_v4; /* extra V4 stuff */
128 struct ucred *n_writecred; /* Cred. for putpages */
129 struct nfsclopen *n_openstateid; /* Cached open stateid */
130 struct timespec n_localmodtime; /* Last local modify */
133 #define n_atim n_un1.nf_atim
134 #define n_mtim n_un2.nf_mtim
135 #define n_sillyrename n_un3.nf_silly
136 #define n_cookieverf n_un1.nd_cookieverf
137 #define n4_cookieverf n_un1.nd4_cookieverf
138 #define n_direofoffset n_un2.nd_direof
139 #define n_cookies n_un3.nd_cook
144 #define NDIRCOOKIELK 0x00000001 /* Lock to serialize access to directory cookies */
145 #define NFSYNCWAIT 0x00000002 /* fsync waiting for all directio async
147 #define NMODIFIED 0x00000004 /* Might have a modified buffer in bio */
148 #define NWRITEERR 0x00000008 /* Flag write errors so close will know */
149 #define NCREATED 0x00000010 /* Opened by nfs_create() */
150 #define NTRUNCATE 0x00000020 /* Opened by nfs_setattr() */
151 #define NSIZECHANGED 0x00000040 /* File size has changed: need cache inval */
152 #define NNONCACHE 0x00000080 /* Node marked as noncacheable */
153 #define NACC 0x00000100 /* Special file accessed */
154 #define NUPD 0x00000200 /* Special file updated */
155 #define NCHG 0x00000400 /* Special file times changed */
156 #define NDELEGMOD 0x00000800 /* Modified delegation */
157 #define NDELEGRECALL 0x00001000 /* Recall in progress */
158 #define NREMOVEINPROG 0x00002000 /* Remove in progress */
159 #define NREMOVEWANT 0x00004000 /* Want notification that remove is done */
160 #define NLOCK 0x00008000 /* Sleep lock the node */
161 #define NLOCKWANT 0x00010000 /* Want the sleep lock */
162 #define NNOLAYOUT 0x00020000 /* Can't get a layout for this file */
163 #define NWRITEOPENED 0x00040000 /* Has been opened for writing */
164 #define NHASBEENLOCKED 0x00080000 /* Has been file locked. */
165 #define NDSCOMMIT 0x00100000 /* Commit is done via the DS. */
166 #define NVNSETSZSKIP 0x00200000 /* Skipped vnode_pager_setsize() */
167 #define NMIGHTBELOCKED 0x00400000 /* Might be file locked. */
170 * Convert between nfsnode pointers and vnode pointers
172 #define VTONFS(vp) ((struct nfsnode *)(vp)->v_data)
173 #define NFSTOV(np) ((struct vnode *)(np)->n_vnode)
175 #define NFS_TIMESPEC_COMPARE(T1, T2) (((T1)->tv_sec != (T2)->tv_sec) || ((T1)->tv_nsec != (T2)->tv_nsec))
180 * Prototypes for NFS vnode operations
182 int ncl_getpages(struct vop_getpages_args *);
183 int ncl_putpages(struct vop_putpages_args *);
184 int ncl_write(struct vop_write_args *);
185 int ncl_inactive(struct vop_inactive_args *);
186 int ncl_reclaim(struct vop_reclaim_args *);
189 int ncl_removeit(struct sillyrename *, struct vnode *);
190 int ncl_nget(struct mount *, u_int8_t *, int, struct nfsnode **, int);
191 nfsuint64 *ncl_getcookie(struct nfsnode *, off_t, int);
192 void ncl_invaldir(struct vnode *);
193 bool ncl_excl_start(struct vnode *);
194 void ncl_excl_finish(struct vnode *, bool old_lock);
195 void ncl_dircookie_lock(struct nfsnode *);
196 void ncl_dircookie_unlock(struct nfsnode *);
200 #endif /* _NFSCLIENT_NFSNODE_H_ */