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 * $FreeBSD$
33 */
34
35 #ifndef _NFSCLIENT_NFSNODE_H_
36 #define _NFSCLIENT_NFSNODE_H_
37
38 #include <sys/_task.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 task s_task;
46 struct ucred *s_cred;
47 struct vnode *s_dvp;
48 long s_namlen;
49 char s_name[32];
50 };
51
52 /*
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.
59 */
60 #define NFSNUMCOOKIES 31
61
62 struct nfsdmap {
63 LIST_ENTRY(nfsdmap) ndm_list;
64 int ndm_eocookie;
65 union {
66 nfsuint64 ndmu3_cookies[NFSNUMCOOKIES];
67 uint64_t ndmu4_cookies[NFSNUMCOOKIES];
68 } ndm_un1;
69 };
70
71 #define ndm_cookies ndm_un1.ndmu3_cookies
72 #define ndm4_cookies ndm_un1.ndmu4_cookies
73
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 */
78 };
79
80 /*
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.
92 */
93 struct nfsnode {
94 struct mtx n_mtx; /* Protects all of these members */
95 u_quad_t n_size; /* Current size of file */
96 u_quad_t n_brev; /* Modify rev when cached */
97 u_quad_t n_lrev; /* Modify rev for lease */
98 struct nfsvattr n_vattr; /* Vnode attribute cache */
99 time_t n_attrstamp; /* Attr. cache timestamp */
100 struct nfs_accesscache n_accesscache[NFS_ACCESSCACHESIZE];
101 struct timespec n_mtime; /* Prev modify time. */
102 struct timespec n_unused0;
103 struct timespec n_unused1;
104 int n_unused2;
105 struct nfsfh *n_fhp; /* NFS File Handle */
106 struct vnode *n_vnode; /* associated vnode */
107 struct vnode *n_dvp; /* parent vnode */
108 struct lockf *n_lockf; /* Locking record of file */
109 int n_error; /* Save write error value */
110 union {
111 struct timespec nf_atim; /* Special file times */
112 nfsuint64 nd_cookieverf; /* Cookie verifier (dir only) */
113 u_char nd4_cookieverf[NFSX_VERF];
114 } n_un1;
115 union {
116 struct timespec nf_mtim;
117 off_t nd_direof; /* Dir. EOF offset cache */
118 } n_un2;
119 union {
120 struct sillyrename *nf_silly; /* Ptr to silly rename struct */
121 LIST_HEAD(, nfsdmap) nd_cook; /* cookies */
122 } n_un3;
123 short n_fhsize; /* size in bytes, of fh */
124 u_int32_t n_flag; /* Flag for locking.. */
125 int n_directio_opens;
126 int n_directio_asyncwr;
127 u_int64_t n_change; /* old Change attribute */
128 struct nfsv4node *n_v4; /* extra V4 stuff */
129 struct ucred *n_writecred; /* Cred. for putpages */
130 };
131
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
139
140 /*
141 * Flags for n_flag
142 */
143 #define NDIRCOOKIELK 0x00000001 /* Lock to serialize access to directory cookies */
144 #define NFSYNCWAIT 0x00000002 /* fsync waiting for all directio async
145 writes to drain */
146 #define NMODIFIED 0x00000004 /* Might have a modified buffer in bio */
147 #define NWRITEERR 0x00000008 /* Flag write errors so close will know */
148 #define NCREATED 0x00000010 /* Opened by nfs_create() */
149 #define NTRUNCATE 0x00000020 /* Opened by nfs_setattr() */
150 #define NSIZECHANGED 0x00000040 /* File size has changed: need cache inval */
151 #define NNONCACHE 0x00000080 /* Node marked as noncacheable */
152 #define NACC 0x00000100 /* Special file accessed */
153 #define NUPD 0x00000200 /* Special file updated */
154 #define NCHG 0x00000400 /* Special file times changed */
155 #define NDELEGMOD 0x00000800 /* Modified delegation */
156 #define NDELEGRECALL 0x00001000 /* Recall in progress */
157 #define NREMOVEINPROG 0x00002000 /* Remove in progress */
158 #define NREMOVEWANT 0x00004000 /* Want notification that remove is done */
159 #define NLOCK 0x00008000 /* Sleep lock the node */
160 #define NLOCKWANT 0x00010000 /* Want the sleep lock */
161 #define NHASBEENLOCKED 0x00080000 /* Has been file locked. */
162
163 /*
164 * Convert between nfsnode pointers and vnode pointers
165 */
166 #define VTONFS(vp) ((struct nfsnode *)(vp)->v_data)
167 #define NFSTOV(np) ((struct vnode *)(np)->n_vnode)
168
169 #define NFS_TIMESPEC_COMPARE(T1, T2) (((T1)->tv_sec != (T2)->tv_sec) || ((T1)->tv_nsec != (T2)->tv_nsec))
170
171 #if defined(_KERNEL)
172
173 /*
174 * Prototypes for NFS vnode operations
175 */
176 int ncl_getpages(struct vop_getpages_args *);
177 int ncl_putpages(struct vop_putpages_args *);
178 int ncl_write(struct vop_write_args *);
179 int ncl_inactive(struct vop_inactive_args *);
180 int ncl_reclaim(struct vop_reclaim_args *);
181
182 /* other stuff */
183 int ncl_removeit(struct sillyrename *, struct vnode *);
184 int ncl_nget(struct mount *, u_int8_t *, int, struct nfsnode **, int);
185 nfsuint64 *ncl_getcookie(struct nfsnode *, off_t, int);
186 void ncl_invaldir(struct vnode *);
187 int ncl_upgrade_vnlock(struct vnode *);
188 void ncl_downgrade_vnlock(struct vnode *, int);
189 void ncl_printf(const char *, ...);
190 void ncl_dircookie_lock(struct nfsnode *);
191 void ncl_dircookie_unlock(struct nfsnode *);
192
193 #endif /* _KERNEL */
194
195 #endif /* _NFSCLIENT_NFSNODE_H_ */
Cache object: 0d2cbf46b864c39a0491a8aff6050d5b
|