nfsnode.h revision 1.1.1.1.12.2 1 /* $NetBSD: nfsnode.h,v 1.1.1.1.12.2 2017/02/05 13:40:55 skrll Exp $ */
2 /*-
3 * Copyright (c) 1989, 1993
4 * The Regents of the University of California. All rights reserved.
5 *
6 * This code is derived from software contributed to Berkeley by
7 * Rick Macklem at The University of Guelph.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 * FreeBSD: head/sys/fs/nfsclient/nfsnode.h 303715 2016-08-03 15:58:20Z kib
34 * $NetBSD: nfsnode.h,v 1.1.1.1.12.2 2017/02/05 13:40:55 skrll Exp $
35 */
36
37 #ifndef _NFSCLIENT_NFSNODE_H_
38 #define _NFSCLIENT_NFSNODE_H_
39
40 /*
41 * Silly rename structure that hangs off the nfsnode until the name
42 * can be removed by nfs_inactive()
43 */
44 struct sillyrename {
45 struct ucred *s_cred;
46 struct vnode *s_dvp;
47 long s_namlen;
48 char s_name[32];
49 };
50
51 /*
52 * This structure is used to save the logical directory offset to
53 * NFS cookie mappings.
54 * The mappings are stored in a list headed
55 * by n_cookies, as required.
56 * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
57 * stored in increasing logical offset byte order.
58 */
59 #define NFSNUMCOOKIES 31
60
61 struct nfsdmap {
62 LIST_ENTRY(nfsdmap) ndm_list;
63 int ndm_eocookie;
64 union {
65 nfsuint64 ndmu3_cookies[NFSNUMCOOKIES];
66 uint64_t ndmu4_cookies[NFSNUMCOOKIES];
67 } ndm_un1;
68 };
69
70 #define ndm_cookies ndm_un1.ndmu3_cookies
71 #define ndm4_cookies ndm_un1.ndmu4_cookies
72
73 struct nfs_accesscache {
74 u_int32_t mode; /* ACCESS mode cache */
75 uid_t uid; /* credentials having mode */
76 time_t stamp; /* mode cache timestamp */
77 };
78
79 /*
80 * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
81 * is purely coincidental.
82 * There is a unique nfsnode allocated for each active file,
83 * each current directory, each mounted-on file, text file, and the root.
84 * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
85 * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
86 * type definitions), file handles of > 32 bytes should probably be split out
87 * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by
88 * changing the definition in nfsproto.h of NFS_SMALLFH.)
89 * NB: Hopefully the current order of the fields is such that everything will
90 * be well aligned and, therefore, tightly packed.
91 */
92 struct nfsnode {
93 kmutex_t n_mtx; /* Protects all of these members */
94 u_quad_t n_size; /* Current size of file */
95 u_quad_t n_brev; /* Modify rev when cached */
96 u_quad_t n_lrev; /* Modify rev for lease */
97 struct nfsvattr n_vattr; /* Vnode attribute cache */
98 time_t n_attrstamp; /* Attr. cache timestamp */
99 struct nfs_accesscache n_accesscache[NFS_ACCESSCACHESIZE];
100 struct timespec n_mtime; /* Prev modify time. */
101 struct nfsfh *n_fhp; /* NFS File Handle */
102 struct vnode *n_vnode; /* associated vnode */
103 struct vnode *n_dvp; /* parent vnode */
104 struct lockf *n_lockf; /* Locking record of file */
105 int n_error; /* Save write error value */
106 union {
107 struct timespec nf_atim; /* Special file times */
108 nfsuint64 nd_cookieverf; /* Cookie verifier (dir only) */
109 u_char nd4_cookieverf[NFSX_VERF];
110 } n_un1;
111 union {
112 struct timespec nf_mtim;
113 off_t nd_direof; /* Dir. EOF offset cache */
114 } n_un2;
115 union {
116 struct sillyrename *nf_silly; /* Ptr to silly rename struct */
117 LIST_HEAD(, nfsdmap) nd_cook; /* cookies */
118 } n_un3;
119 short n_fhsize; /* size in bytes, of fh */
120 u_int32_t n_flag; /* Flag for locking.. */
121 int n_directio_opens;
122 int n_directio_asyncwr;
123 u_int64_t n_change; /* old Change attribute */
124 struct nfsv4node *n_v4; /* extra V4 stuff */
125 struct ucred *n_writecred; /* Cred. for putpages */
126 };
127
128 #define n_atim n_un1.nf_atim
129 #define n_mtim n_un2.nf_mtim
130 #define n_sillyrename n_un3.nf_silly
131 #define n_cookieverf n_un1.nd_cookieverf
132 #define n4_cookieverf n_un1.nd4_cookieverf
133 #define n_direofoffset n_un2.nd_direof
134 #define n_cookies n_un3.nd_cook
135
136 /*
137 * Flags for n_flag
138 */
139 #define NDIRCOOKIELK 0x00000001 /* Lock to serialize access to directory cookies */
140 #define NFSYNCWAIT 0x00000002 /* fsync waiting for all directio async
141 writes to drain */
142 #define NMODIFIED 0x00000004 /* Might have a modified buffer in bio */
143 #define NWRITEERR 0x00000008 /* Flag write errors so close will know */
144 #define NCREATED 0x00000010 /* Opened by nfs_create() */
145 #define NTRUNCATE 0x00000020 /* Opened by nfs_setattr() */
146 #define NSIZECHANGED 0x00000040 /* File size has changed: need cache inval */
147 #define NNONCACHE 0x00000080 /* Node marked as noncacheable */
148 #define NACC 0x00000100 /* Special file accessed */
149 #define NUPD 0x00000200 /* Special file updated */
150 #define NCHG 0x00000400 /* Special file times changed */
151 #define NDELEGMOD 0x00000800 /* Modified delegation */
152 #define NDELEGRECALL 0x00001000 /* Recall in progress */
153 #define NREMOVEINPROG 0x00002000 /* Remove in progress */
154 #define NREMOVEWANT 0x00004000 /* Want notification that remove is done */
155 #define NLOCK 0x00008000 /* Sleep lock the node */
156 #define NLOCKWANT 0x00010000 /* Want the sleep lock */
157 #define NNOLAYOUT 0x00020000 /* Can't get a layout for this file */
158 #define NWRITEOPENED 0x00040000 /* Has been opened for writing */
159 #define NHASBEENLOCKED 0x00080000 /* Has been file locked. */
160
161 /*
162 * Convert between nfsnode pointers and vnode pointers
163 */
164 #define VTONFS(vp) ((struct nfsnode *)(vp)->v_data)
165 #define NFSTOV(np) ((struct vnode *)(np)->n_vnode)
166
167 #define NFS_TIMESPEC_COMPARE(T1, T2) (((T1)->tv_sec != (T2)->tv_sec) || ((T1)->tv_nsec != (T2)->tv_nsec))
168
169 #if defined(_KERNEL)
170
171 /*
172 * Prototypes for NFS vnode operations
173 */
174 int ncl_getpages(struct vop_getpages_args *);
175 int ncl_putpages(struct vop_putpages_args *);
176 int ncl_write(struct vop_write_args *);
177 int ncl_inactive(struct vop_inactive_args *);
178 int ncl_reclaim(struct vop_reclaim_args *);
179
180 /* other stuff */
181 int ncl_removeit(struct sillyrename *, struct vnode *);
182 int ncl_nget(struct mount *, u_int8_t *, int, struct nfsnode **, int);
183 nfsuint64 *ncl_getcookie(struct nfsnode *, off_t, int);
184 void ncl_invaldir(struct vnode *);
185 int ncl_upgrade_vnlock(struct vnode *);
186 void ncl_downgrade_vnlock(struct vnode *, int);
187 void ncl_dircookie_lock(struct nfsnode *);
188 void ncl_dircookie_unlock(struct nfsnode *);
189
190 #endif /* _KERNEL */
191
192 #endif /* _NFSCLIENT_NFSNODE_H_ */
193